Linux-C 编程 / 文本处理 / INI 文件解析器

1. 简介

开源项目 inih ( 1.3K star )：

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

inih (INI Not Invented Here 的缩写) 是一个简单的用 C 语言编写的 INI 文件解析器。

INI 文件一般用于保存配置信息，它的格式很简单：

[p1]
name1 = value1

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

在 Linux 系统中也经常能看到 INI 文件：

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

代码简介

inih 只有几页代码，并且设计紧凑小巧，因此对嵌入式系统非常有用。

它或多或少与 Python 的INI 文件的 ConfigParser 样式兼容，包括 RFC 822样式的多行语法和 name: value 条目。

要使用它，只需给 ini_parse() 一个 INI 文件，它将为每个解析的 name = value 对调用一个回调函数，通过回调函数返回 p，name 和 value 字符串。之所以采用这种方式 ( "SAX style"，SAX 是 Simple API for XML的缩写)，是因为它在低内存嵌入式系统上运行良好，而且还因为它可以做到 KISS ( Keep it Simple and Stupid)。

用户也可以:

• 调用 ini_parse_file() 直接从 FILE * 对象进行解析;

• 调用 ini_parse_string() 从字符串中解析数据;

• 调用 ini_parse_stream() 以自定义 fgets-style reader 函数去解析自定义数据流;

2. 使用 inih

2.1 测试例子 ini_example.c

定义数据结构：

#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;
}

用户自定义处理函数：

static int handler(void* user, const char* p, const char* name,const char* value)
{
    configuration* pconfig = (configuration*)user;

    #define MATCH(s, n) strcmp(p, 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 p/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

运行效果：

$ 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 更多的编译参数

有 3 种类型的编译参数可用：

• Syntax options，用于配置 INI 文件语法，例如指定注释行的字符;

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

• Parsing options，用于配置解析行为，例如解析错误时是否马上停止解析;

#define INI_STOP_ON_FIRST_ERROR 0
#define INI_HANDLER_LINENO 0
...

• Memory options，内存相关的配置，例如最大的行长度 / 使用 heap 还是 stack 来保存行数据;

#define INI_USE_STACK 1
#define INI_MAX_LINE 200
...

3. 内部实现

3.1 整体把握

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

分解 ini.c：

4 个公共函数：

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 个私有函数：

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) 

剩下的就是一些宏定义，没有任何公共变量和全局私有变量，非常简洁。

3.2 核心 API 的实现

1) ini_parse_stream() 是关键函数，用于解析数据流：

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

2) ini_parse_stream() 的参数：

• ini_reader reader：函数指针，提供了读取一行文本的操作;

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

• void* stream：待解析的文本数;

• ini_handler handler：函数指针，指向用户提供的回调函数。

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

• void* user：用于保存解析后的数据;

3) ini_parse_stream() 实现思路：

• 读取1行数据：

• 处理1行数据：

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

  • 跳过行首的空格: lskip();

  • 忽略以 ;或# 开始的注释行：

if (strchr(INI_START_COMMENT_PREFIXES, *start))

• 判断是否是 p:

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

• 判断是否是键值对：find_chars_or_comment(start, "=:");

• 调用用户指定的处理函数，一般是用于保存解析到的数据: handler();

更多的源码细节，请各位自行阅读源码吧~~~

4. 参与讨论

关于 Linux C 编程，大家曾经或者希望研究哪些优秀的开源项目？

快来一起讨论吧~

你和我各有一个苹果，如果我们交换苹果的话，我们还是只有一个苹果。但当你和我各有一个想法，我们交换想法的话，我们就都有两个想法了。

对 嵌入式系统 (Linux、RTOS、OpenWrt、Android) 和 开源软件 感兴趣，关注公众号：嵌入式Hacker。

觉得文章对你有价值，不妨点个 在看和赞。

推荐阅读：

专辑 | 每天一点C

专辑 | Linux 系统编程