大家好，我是ZhengN。本次給大家推薦一篇關(guān)于INI文件解析器的文章：

1、簡(jiǎn)介

開(kāi)源項(xiàng)目 inih ( 1.3K star )：

• https://github.com/benhoyt/inih

inih (INI Not Invented Here 的縮寫(xiě)) 是一個(gè)簡(jiǎn)單的用 C 語(yǔ)言編寫(xiě)的 INI 文件解析器。

INI 文件一般用于保存配置信息，它的格式很簡(jiǎn)單：

[section1]
name1 = value1

[section2]
name2 = value2
name3 = value3
...

在 Linux 系統(tǒng)中也經(jīng)常能看到 INI 文件：

$ cat /etc/systemd/logind.conf
[Login] #NAutoVTs=6 #ReserveVT=6 #KillUserProcesses=no ...

代碼簡(jiǎn)介

inih 只有幾頁(yè)代碼，并且設(shè)計(jì)緊湊小巧，因此對(duì)嵌入式系統(tǒng)非常有用。

它或多或少與 Python 的INI 文件的 ConfigParser 樣式兼容，包括 RFC 822樣式的多行語(yǔ)法和 name: value 條目。

要使用它，只需給 ini_parse() 一個(gè) INI 文件，它將為每個(gè)解析的 name = value 對(duì)調(diào)用一個(gè)回調(diào)函數(shù)，通過(guò)回調(diào)函數(shù)返回 section，name 和 value 字符串。之所以采用這種方式 ( "SAX style"，SAX 是 Simple API for XML的縮寫(xiě))，是因?yàn)樗诘蛢?nèi)存嵌入式系統(tǒng)上運(yùn)行良好，而且還因?yàn)樗梢宰龅?KISS ( Keep it Simple and Stupid)。

用戶(hù)也可以:

• 調(diào)用 ini_parse_file() 直接從 FILE * 對(duì)象進(jìn)行解析;

• 調(diào)用 ini_parse_string() 從字符串中解析數(shù)據(jù);

• 調(diào)用 ini_parse_stream() 以自定義 fgets-style reader 函數(shù)去解析自定義數(shù)據(jù)流;

2、使用ini.h

2.1 測(cè)試?yán)?ini_example.c

定義數(shù)據(jù)結(jié)構(gòu)：

#include "../ini.h" typedef struct { int version; const char* name; const char* email;
} configuration;

程序主干：

int main(int argc, char* argv[]) {
    configuration config; if (ini_parse("test.ini", handler, &config) < 0) { printf("Can't load 'test.ini'\n"); return 1;
    } printf("Config loaded from 'test.ini': version=%d, name=%s, email=%s\n",
        config.version, config.name, config.email); free((void*)config.name); free((void*)config.email); return 0;
}

用戶(hù)自定義處理函數(shù)：

static int handler(void* user, const char* section, const char* name,const char* value) {
    configuration* pconfig = (configuration*)user; #define MATCH(s, n) strcmp(section, s) == 0 && strcmp(name, n) == 0 if (MATCH("protocol", "version")) {
        pconfig->version = atoi(value);
    } else if (MATCH("user", "name")) {
        pconfig->name = strdup(value);
    } else if (MATCH("user", "email")) {
        pconfig->email = strdup(value);
    } else { return 0; /* unknown section/name, error */ } return 1;
}

INI 文件：

$ cat test.ini 
; Test config file for ini_example.c and INIReaderTest.cpp

[protocol]             ; Protocol configuration
version=6              ; IPv6

[user]
name = Bob Smith       ; Spaces around '=' are stripped
email = bob@smith.com  ; And comments (like this) ignored
active = true ; Test a boolean
pi = 3.14159           ; Test a floating point number

運(yùn)行效果：

$ cd inih/examples $ gcc ../ini.c ini_example.c -o ini_example $ ./ini_example Config loaded from 'test.ini': version=6, name=Bob Smith, email=bob@smith.com

2.2 更多的編譯參數(shù)

有 3 種類(lèi)型的編譯參數(shù)可用：

• Syntax options，用于配置 INI 文件語(yǔ)法，例如指定注釋行的字符;

#define INI_START_COMMENT_PREFIXES ";#" #define INI_ALLOW_NO_VALUE 0 ...

• Parsing options，用于配置解析行為，例如解析錯(cuò)誤時(shí)是否馬上停止解析;

#define INI_STOP_ON_FIRST_ERROR 0 #define INI_HANDLER_LINENO 0 ...

• Memory options，內(nèi)存相關(guān)的配置，例如最大的行長(zhǎng)度 / 使用 heap 還是 stack 來(lái)保存行數(shù)據(jù);

#define INI_USE_STACK 1 #define INI_MAX_LINE 200 ...

3、內(nèi)部實(shí)現(xiàn)

3.1 整體把握

核心代碼就是 ini.c 和 ini.h。

分解 ini.c：

4 個(gè)公共函數(shù)：

int ini_parse_stream(ini_reader reader, void* stream, ini_handler handler, int ini_parse_file(FILE* file, ini_handler handler, void* user) int ini_parse(const char* filename, ini_handler handler, void* user) int ini_parse_string(const char* string, ini_handler handler, void* user) 

5 個(gè)私有函數(shù)：

static char* rstrip(char* s) static char* lskip(const char* s) static char* find_chars_or_comment(const char* s, const char* chars) static char* strncpy0(char* dest, const char* src, size_t size) static char* ini_reader_string(char* str, int num, void* stream) 

剩下的就是一些宏定義，沒(méi)有任何公共變量和全局私有變量，非常簡(jiǎn)潔。

3.2 核心 API 的實(shí)現(xiàn)

1) ini_parse_stream() 是關(guān)鍵函數(shù)，用于解析數(shù)據(jù)流：

int ini_parse_stream(ini_reader reader, void* stream,ini_handler handler, void* user) 

2) ini_parse_stream() 的參數(shù)：

• ini_reader reader：函數(shù)指針，提供了讀取一行文本的操作;

typedef char* (*ini_reader)(char* str, int num, void* stream);

• void* stream：待解析的文本數(shù);

• ini_handler handler：函數(shù)指針，指向用戶(hù)提供的回調(diào)函數(shù)。

typedef int (*ini_handler)(void* user, const char* section const char* name, const char* value);

• void* user：用于保存解析后的數(shù)據(jù);

3) ini_parse_stream() 實(shí)現(xiàn)思路：

• 讀取1行數(shù)據(jù)：

• 處理1行數(shù)據(jù)：

• 去掉行末尾的空格: rstrip();

• 跳過(guò)行首的空格: lskip();

• 忽略以 ;或# 開(kāi)始的注釋行：

if (strchr(INI_START_COMMENT_PREFIXES, *start))

• 判斷是否是 section:

if (*start == '[') 
        find_chars_or_comment(start + 1, "]");

• 判斷是否是鍵值對(duì)：find_chars_or_comment(start, "=:");

• 調(diào)用用戶(hù)指定的處理函數(shù)，一般是用于保存解析到的數(shù)據(jù): handler();

更多的源碼細(xì)節(jié)，請(qǐng)各位自行閱讀源碼吧~~~