2. 程式人生 > >C++學習：一個通用ini配置檔案操作類

C++學習：一個通用ini配置檔案操作類

阿新 • • 發佈：2019-01-02

在windows平臺下，簡單的程式可以通過ini檔案實現簡單的配置，簡單適用。在win32 sdk還提供了相應的api來讀取修改ini檔案。ini配置檔案格式為：

[section]

key=string

...

讀取與修改string的api為ReadPrivateProfilesString和WritePrivateProfilesString。不過美中不足的是，win32 api並沒有提供刪除section或key的功能，也不支援linux平臺。因此我們得自己來實現。

對於ini配置檔案，格式比較簡單，也就是字串分析，為了簡單，只要分析行字串即可。但分析時需要關注的功能點：忽略大小寫功能，section和key前後的無用的空格功能，註釋功能。讀寫刪除字串、整型等。因此類的設計如下：

class IniFile
{
public:
    explicit IniFile(const string &fileName);
    ~IniFile(void);
    bool ReadFile(void);
    string ReadString( const string §ion, const string &key, const string &value );
    int    ReadInt( const string §ion, const string &key, int value );
    bool WriteString( const string §ion, const string &key, const string &value );
    bool WriteInt( const string §ion, const string &key, int value );
    bool RemoveSection( const string §ion );
    bool RemoveKey( const string §ion, const string &key );
    bool WriteFile(void);
private:
    static string Trim( const string &str );
    static string LTrim( const string &str );
    static string RTrim( const string &str );
private:
    string m_fileName;
    vector<string> m_vctLine;
    bool m_modifyFlag;
};

IniFile類的設計，對外提供的介面基本都是C＋＋的基本型別。首先我們來看構造和解構函式。

IniFile::IniFile(const string &fileName)
    :m_fileName(fileName),
     m_modifyFlag(false)
{
	ReadFile();
}

IniFile::~IniFile(void)
{
	WriteFile();
}

bool IniFile::ReadFile( void )
{
	ifstream in(m_fileName.c_str());
	if( false == in.is_open() )
        	return false;
    
	string line;
	while( getline(in,line) )
	{
		m_vctLine.push_back(line);
	}
        m_modifyFlag = false;
	return true;
}

bool IniFile::WriteFile( void )
{
	//check if is need to save
    	if( false == m_modifyFlag )
    	{
        	return true;
    	}
    	ofstream out(m_fileName.c_str());
    	for( size_t i = 0; i < m_vctLine.size(); ++i )
    	{
		out<<m_vctLine[i]<<endl;
    	}
    	m_modifyFlag = false;
    	return true;
}

ReadFile和WriteFile函式用來讀配置檔案和儲存配置檔案。也比較簡單。配置檔案儲存到記憶體，就是設計字串陣列。IniFile類主要的函式是ReadString和WriteString，下面主要講述這兩個函式實現。ReadString函式，引數就是section、key、value，這裡的value是預設值（參考win api介面設計）。先比較section，然後再是key和value。分析section的關鍵是“［］”，key＝value格式也比較好分析，分析到section就終止key的分析，再回過頭來分析下一個section。這裡的分析，也可以用遞迴，這樣遇到下個section就不要回退一步。一起先看一下函式程式碼：

string IniFile::ReadString( const string §ion, const string &key, const string &defval )
{
	for( size_t i = 0;i < m_vctLine.size(); ++i )
	{
		string section_line = LTrim(m_vctLine[i]);
		size_t sec_begin_pos = section_line.find('[');
		if( sec_begin_pos == string::npos || sec_begin_pos != 0 )
		{
			continue;
		}
		size_t sec_end_pos = section_line.find( ']', sec_begin_pos );
		if( sec_end_pos == string::npos )
		{
			continue;
		}

		if( ci_string(section.c_str()) != Trim(section_line.substr(sec_begin_pos+1, sec_end_pos-sec_begin_pos-1) ).c_str() )
		{
			continue;
		}

		//find key
		for( ++i; i < m_vctLine.size(); ++i )
		{
			string key_line = LTrim(m_vctLine[i]);
			size_t sec_pos = key_line.find('[');
			if( sec_pos != string::npos && sec_pos == 0 )
			{
				--i;  //reback a step,find again
				break;//the line is section line
			}

			if( key_line.find('#') != string::npos )
			{
				continue;//this is comment line
			}
			size_t equal_pos = key_line.find( '=' );
			if( equal_pos == string::npos )
			{
				continue;
			}
			if( ci_string(key.c_str()) != RTrim(key_line.substr( 0, equal_pos ) ).c_str() )
			{
				continue;
			}

			size_t comment_pos = key_line.find( "#", equal_pos + 1 );
			if( comment_pos != string::npos )
			{
				return Trim(key_line.substr( equal_pos + 1, comment_pos - equal_pos - 1 ));
			}

			return Trim(key_line.substr( equal_pos + 1 ));
		}
	}

	return defval;
}
ReadString函式中，key＝value後面還可能有註釋，這裡註釋是以"#"開頭，其他形式註釋暫時不支援。另外讀寫字串，還要區分有引號和無引號兩種形式（程式碼中未體現，各位讀者自己增加程式碼）。再來看看WriteString函式，WriteString函式和ReadString差不多，只是一個讀一個寫，如果找不到，就要新建key＝value，或者新建section和key＝value。具體程式碼如下： 
bool IniFile::WriteString( const string §ion, const string &key, const string &value )
{
	for( size_t i = 0;i < m_vctLine.size(); ++i )
	{
		string section_line = LTrim(m_vctLine[i]);
		size_t sec_begin_pos = section_line.find('[');
		if( sec_begin_pos == string::npos || sec_begin_pos != 0 )
		{
			continue;
		}
		size_t sec_end_pos = section_line.find( ']', sec_begin_pos );
		if( sec_end_pos == string::npos )
		{
			continue;
		}
		if( ci_string(section.c_str()) != RTrim(section_line.substr(sec_begin_pos+1, sec_end_pos-sec_begin_pos-1)).c_str() )
		{
			continue;
		}

		//find key
		for( ++i; i < m_vctLine.size(); ++i )
		{
			string key_line = LTrim(m_vctLine[i]);
			size_t sec_pos = key_line.find('[');
			if( sec_pos != string::npos && sec_pos == 0 )
			{
				--i;  //reback a step,find again
				break;//the line is section line
			}

			if( key_line.find('#') != string::npos )
			{
				continue;//this is comment line
			}
			size_t equal_pos = key_line.find( '=' );
			if( equal_pos == string::npos )
			{
				continue;
			}
			if( ci_string(key.c_str()) != RTrim(key_line.substr( 0, equal_pos )).c_str() )
			{
				continue;
			}

			size_t comment_pos = key_line.find( "#", equal_pos + 1 );
			string new_line = key_line.substr( 0, equal_pos + 1 ) + value;
			if( comment_pos != string::npos )
			{
				new_line += key_line.substr( comment_pos );
			}
			key_line = new_line;
            		m_modifyFlag = true;
			return true;
		}

		//add a new key
		m_vctLine.insert( m_vctLine.begin() + i, key + "=" + value ); 
		m_modifyFlag = true;
        	return true;
	}

	//add a new section and a new key
    	m_vctLine.insert( m_vctLine.end(), "" );
	m_vctLine.insert( m_vctLine.end(), "[" + section + "]" );
	m_vctLine.insert( m_vctLine.end(), key + "=" + value );
	m_modifyFlag = true;
    	return true;
}
RemoveSection函式，就是刪除一個section，包括下面所有的key，程式碼如下： 
bool IniFile::RemoveSection( const string §ion )
{
	for( size_t i = 0;i < m_vctLine.size(); ++i )
	{
		string section_line = LTrim(m_vctLine[i]);
		size_t sec_begin_pos = section_line.find('[');
		if( sec_begin_pos == string::npos || sec_begin_pos != 0 )
		{
			continue;
		}
		size_t sec_end_pos = section_line.find( ']', sec_begin_pos );
		if( sec_end_pos == string::npos )
		{
			continue;
		}
		if( ci_string(section.c_str()) != RTrim(section_line.substr(sec_begin_pos+1, sec_end_pos-sec_begin_pos-1)).c_str() )
		{
			continue;
		}

		//
		size_t del_begin = i;
		for( ++i ; i < m_vctLine.size(); ++i )
		{
			string next_section = LTrim(m_vctLine[i]);
			size_t next_pos = next_section.find('[');
			if( next_pos == string::npos || next_pos != 0 )
			{
				continue;
			}

			break;
		}
		m_vctLine.erase( m_vctLine.begin() + del_begin, m_vctLine.begin()+i );
		return true;
	}
	return false;
}
RemoveKey函式就是刪除一個key，這個也比較容易看。 
bool IniFile::RemoveKey( const string §ion, const string &key )
{
	for( size_t i = 0;i < m_vctLine.size(); ++i )
	{
		string §ion_line = m_vctLine[i];
		size_t sec_begin_pos = section_line.find('[');
		if( sec_begin_pos == string::npos || sec_begin_pos != 0 )
		{
			continue;
		}
		size_t sec_end_pos = section_line.find( ']', sec_begin_pos );
		if( sec_end_pos == string::npos )
		{
			continue;
		}
		if( ci_string(section.c_str()) != Trim(section_line.substr(sec_begin_pos+1, sec_end_pos-sec_begin_pos-1)).c_str() )
		{
			continue;
		}

		//find key
		for( ++i ; i < m_vctLine.size(); ++i )
		{
			string key_line = m_vctLine[i];
			key_line = Trim(key_line);
			if( key_line.find('#') == 0 )
			{
				continue;
			}

			size_t key_pos = key_line.find('=');
			if( key_pos == string::npos )
			{
				continue;
			}

			if( ci_string(key.c_str()) == Trim(key_line.substr(0, key_pos)).c_str() )
			{
				m_vctLine.erase( m_vctLine.begin() + i );
				return true;
			}
		}
	}
	return false;
}

ReadInt和WriteInt就更簡單了，就通過ReadString和WriteString來實現了。直接貼上程式碼。 
int IniFile::ReadInt( const string §ion, const string &key, int value )
{
	string str = ReadString( section, key, "" );
	if( "" == str )
	{
		return value;
	}

	istringstream in( str.c_str() );
	int ret = 0;
	in>>ret;
	return ret;
}


bool IniFile::WriteInt( const string §ion, const string &key, int value )
{
	ostringstream out;
	out<<value;
	return WriteString( section, key, out.str() );
}

其他幾個輔助刪除前向空格和後向空格的函式，也一併貼出來。

string IniFile::LTrim( const string &str )
{
	size_t pos = 0;
	while( pos != str.size() )
	{
		if( ' ' == str[pos] )
		{
			++pos;
		}
		else
		{
			break;
		}
	}
	
	return str.substr(pos);
}

string IniFile::RTrim( const string &str )
{
	size_t pos = str.size() - 1;
	while( pos >= 0 )
	{
		if(' ' == str[pos])
		{
			--pos;
		}
		else
		{
			break;
		}
	}
	
	return str.substr( 0, pos + 1 );
}

string IniFile::Trim(const string &str)
{
	return LTrim( RTrim(str) );
}
不區分大小寫的string型別，實現如下： 
/************************************************************************/
/* 字串的迭代器定義                                                         */
/************************************************************************/
struct ci_char_traits : public char_traits<char>
{
	static bool eq(char c1, char c2)
	{ 
		return toupper(c1) == toupper(c2); 
	}
	static bool ne(char c1, char c2)
	{ 
		return toupper(c1) != toupper(c2); 
	}
	static bool lt(char c1, char c2)
	{ 
		return toupper(c1) < toupper(c2); 
	}
	static bool compare(const char* s1, const char* s2, size_t n)
	{ 
#ifdef WIN32
		return memicmp(s1,s2,n) != 0;  //實現不區分大小寫的串比較
#else
		//linux不支援memicmp，自定義版本
		char *tmps1 = new char[n];
		char *tmps2 = new char[n];
		for( size_t i = 0; i < n; ++i )
		{
			tmps1[i] = toupper(s1[i]);
			tmps2[i] = toupper(s2[i]);
		}
		return memcmp(tmps1, tmps2, n) != 0;
#endif
	}
	static const char* find(const char*s, int n, char a) 
	{
		while (n-- > 0  &&  toupper(*s) != toupper(a) ) 
			++s;
		return s;
	}
};
使用程式碼如下： 
int _tmain(int argc, _TCHAR* argv[])
{
	IniFile ini("./test.ini");
	ini.WriteString("system", "ip", "127.0.0.1");
	cout<<ini.ReadString("system", "ip", "0.0.0.0")<<endl;
	cout<<ini.ReadInt("system", "port", 5060 )<<endl;

	return 0;
}
大功告成，各位讀者自己拷貝下程式碼試試。




相關推薦

C++學習：一個通用ini配置檔案操作類

在windows平臺下，簡單的程式可以通過ini檔案實現簡單的配置，簡單適用。在win32 sdk還提供了相應的api來讀取修改ini檔案。ini配置檔案格式為： [section] key=string ... 讀取與修改string的api為ReadPrivatePro

C# winform 建立,修改,刪除 ini配置檔案

using System; using System.Collections.Generic; using System.Text; using System.Runtime.InteropServices; namespace EmailCustomer {     cl

C/C++ 關於如何讀寫ini配置檔案 （小結）

讀取 讀取字元   DWORD GetPrivateProfileString(   LPCTSTR lpAppName,        // INI檔案中的一個欄位名[節名]可以有很多個節名   LPCTSTR lpKeyName,        // lpAppName 下的一個鍵名，也就是裡面具體

配置檔案操作類(.AppConfig)

class SetConfig     {         //獲取AppConfig         public static string GetAppConfig(string strKey)         {             foreach (strin

C# 基礎（十三）C# XML配置檔案、ini配置檔案的建立、讀寫：動態修改IP

一、簡介 傳統的配置檔案ini已有被xml檔案逐步代替的趨勢，這裡主要討論XML配置檔案。 二、ini網址 https://www.cnblogs.com/cncc/p/3415694.html（重點） https://www.cnblogs.com/xmy-007/p/640022

C++讀寫ini配置檔案GetPrivateProfileString WritePrivateProfileStr

分享一下我老師大神的人工智慧教程！零基礎，通俗易懂！http://blog.csdn.net/jiangjunshow 也歡迎大家轉載本篇文章。分享知識，造福人民，實現我們中華民族偉大復興！        

SpringBoot-08：SpringBoot採用json的方式實現前後臺通用的配置檔案

package com.xy.config; import com.alibaba.fastjson.JSON; import com.xy.model.TheServerURL; import org.springframework.context.annotation.Bean; impo

C#讀取ini配置檔案注意的問題

C＃和Win32 API函式 C＃並不像C＋＋，擁有屬於自己的類庫。C＃使用的類庫是.Net框架為所有.Net程式開發提供的一個共有的類庫――.Net FrameWork SDK。雖然.Net FrameWork SDK內容十分龐大，功能也非常強大，但還不能面面俱到，至少它

C#類庫：ini檔案操作類

C#類庫 ——ini檔案操作類 1.類庫介紹     在開發應用軟體時，ini檔案常用於軟體的相關配置，以下為ini檔案的相關結構及示例；ini檔案具有節（section）和鍵（key）兩個層級，節用”[]”包含，然後下一行為對應鍵名以及鍵值，

C++針對ini配置檔案讀寫大全

ini檔案(Initialization file)，這種型別的檔案中通常存放的是一個程式的初始化資訊。ini檔案由若干個節(Section)組成，每個Section由若干鍵(Key)組成，每個Key可以賦相應的值。讀寫ini檔案實際上就是讀寫某個的Section中相應的K

C# 讀寫.ini配置檔案

`class Ini { // 宣告INI檔案的寫操作函式 WritePrivateProfileString() [System.Runtime.InteropServices.DllImport("kernel32")] private static extern

C# 學習： 讀取檔案流，儲存到位元組中

最近在做檔案資料讀取的測試，C#的檔案讀取，儲存到位元組中，之前對這塊不熟悉，Mark： Stream expectedSteam = new FileStream(path, FileMode.O

C# 操作INI配置檔案

重構YH是遇到這個一樣問題，就是YH前臺頁面的按鈕要求實現客戶自定義，客戶可以跟隨自己的喜好安排每個按鈕的功能，所以，在每一次客戶登陸是就需要初始化客戶自定義排版，這裡就需要用到初始化檔案——INI。 　.ini 檔案是Initialization File的縮寫，即初始化

大資料學習35：一個scala 操控 HDFS 檔案目錄的小例子

一個scala 操控 HDFS 檔案目錄的小例子： 包含了對檔案路徑的檢視是否存在、刪除、建立、重新命名、移動。 僅作記錄。 工具類：HDFSUtil package Sparktest i

C++對ini配置檔案與xml配置檔案的讀寫

1、ini檔案的讀寫        在遊戲與軟體開發過程中，我們經常會使用ini的配置檔案，為遊戲或軟體配置相關的引數，因此就有必要對ini檔案進行讀寫操作。        下面介紹C++在讀寫ini檔案中，常用到的幾個函式：        1） 讀.ini檔案： DWOR

SpringBoot 2.X課程學習 | 第五篇：yml語法讓配置檔案更加簡潔易讀

簡介       YAML 是一種簡潔的非標記語言(YAML Ain’t Markup Lang

C# 讀取Ini配置文件類

ces readv 文件的 new color api top 不出 esp 配置文件 為fileName.ini 的文件 第一行必須為空，不然讀不出值[section1] key=value key2=value ......... [section2] key

通用vim配置檔案

配置檔案 1.建立/home/user/.vimrc檔案。 2.配置vim常用特性，及外掛等。 3."在配置檔案中表示註釋。 .vimrc檔案內容： syntax on set nocompatible           &

C# WINFORM程式配置檔案操作方法

C# WINFORM程式配置檔案操作方法 在寫winform程式的時候，我們經常會把配置檔案寫在Settings.settings中， 但是，在這裡我們發現，儲存後，在程式中對這個配置進行修改並不能生效 程式級別的配置呢，我常用儲存在app.config中的appSettings節點中

SpringBoot學習_yaml介紹和yaml配置檔案值獲取

文章目錄 yaml簡介 yaml語法 基本語法 值的寫法 yml配置檔案的值獲取 獲取方法一:用@ConfigurationProperties獲取 yml程式碼提示