C语言配置文件解析库——iniparser

C语言配置文件解析库——iniparser
1.
1.1前言：在对项目的优化时，发现Linux下没有专门的供给C语言使用的配置文件函数，于是搜索到了iniparser库，可以像那些面向对象语言一样，使用ini文件进行参数配置。

1.2 介绍
iniparser是针对INI文件的解析器。ini文件则是一些系统或者软件的配置文件。iniparser库有
四种下载方式：
1.2.1官方网站
1.2.2.我的github 添加链接描述
1.2.3.我的网盘 添加链接描述
1.2.4.source code tree 添加链接描述

2. 基本语法

2.1 Iniparser库的API可以对ini文件（配置文件）进行解析、设置、删除等操作。
ini文件的最基本组成单元就是key或者叫property，每个key都有一个名称(name)和对应的值(value)：
name = value

2.2 在section声明下的keys都会和该section关联起来。一个section的作用域会在下一个section声明的地方结束，如果没有下一个section的声明，那么该section的结束地方就是该文件末尾。section是不可以嵌套的。

2.3 定位一个key是用section:key来表示的，所以不同section下的key的名称是可以相同的。

2.4 iniparser库处理名称的时候，会统一换成小写，所以section和property的名称命名是大小写无关的。

3. API
   3.1 iniparser.h：
   int iniparser_getnsec(dictionary * d); // 获取dictionary对象的section个数

   char * iniparser_getsecname(dictionary * d, int n); // 获取dictionary对象的第n个section的名字

   void iniparser_dump_ini(dictionary * d, FILE * f); // 保存dictionary对象到file

   void iniparser_dumpsection_ini(dictionary * d, char * s, FILE * f); // 保存dictionary对象一个section到file

   void iniparser_dump(dictionary * d, FILE * f); // 保存dictionary对象到file

   int iniparser_getsecnkeys(dictionary * d, char * s); // 获取dictionary对象某个section下的key个数

   char ** iniparser_getseckeys(dictionary * d, char * s); // 获取dictionary对象某个section下所有的key

   char * iniparser_getstring(dictionary * d, const char * key, char * def); //返回dictionary对象的section:key对应的字串值

   int iniparser_getint(dictionary * d, const char * key, int notfound); //返回idictionary对象的section:key对应的整形值

   double iniparser_getdouble(dictionary * d, const char * key, double notfound); //返回dictionary对象的section:key对应的双浮点值

   int iniparser_getboolean(dictionary * d, const char * key, int notfound); //返回dictionary对象的section:key对应的布尔值

   int iniparser_set(dictionary * ini, const char * entry, const char * val); //设置dictionary对象的某个section:key的值

   void iniparser_unset(dictionary * ini, const char * entry); //删除dictionary对象中某个section:key

   int iniparser_find_entry(dictionary * ini, const char * entry) ; //判断dictionary对象中是否存在某个section:key

   dictionary * iniparser_load(const char * ininame); //解析dictionary对象并返回(分配内存)dictionary对象

   void iniparser_freedict(dictionary * d); //释放dictionary对象(内存)

   unsigned dictionary_hash(const char * key); //计算关键词的hash值

   dictionary * dictionary_new(int size); //创建dictionary对象

   void dictionary_del(dictionary * vd); //删除dictionary对象

   char * dictionary_get(dictionary * d, const char * key, char * def); //获取dictionary对象的key值

   int dictionary_set(dictionary * vd, const char * key, const char * val); //设置dictionary对象的key值

   void dictionary_unset(dictionary * d, const char * key); //删除dictionary对象的key值

   void dictionary_dump(dictionary * d, FILE * out); //保存dictionary对象

4. 获取库和头文件
   首先解压你下载的库文件：
   tar -zxvf iniparser-3.1.tar.gz
   编译：cd iniparser-3.1/
   make

   可以看到src目录下生成了六个文件，其中dictionary.h里面声明了一些直接解析ini file的API，iniparser.h里面声明了一些提供用户操作的API。iniparser.h里面的API是对dictionary.h里面API的再次封装，以提供用户友好性。然后拷贝src下的头文件dictionary.h和iniparser.h以及压缩包目录下的静态库libiniparser.a和动态库libiniparser.so.0到目标文件系统的对应目录下。（只使用静态库libiniparser.a即可）

5. 编写ini文件

[school]
name = ben
age = 12
sex = boy

[tcp]
;for tcp communication
port = 8000;
ip = 127.0.0.1;
family = AF_INET;

[serial port]
;for serial port communication
speed = 9600;

6. 测试程序
   6.1 头文件

#ifndef __FILECFG_
#define __FILECFG_

#define CFG_NAME "./cfg.ini"

// 指针数组元素个数
#define SCHOOL_NUM 20
#define TCP_NUM  20
#define SERIAL_NUM 20

// 读取一个key中元素的总个数
#define SCHOOL_PARA_NUM  3
#define TCP_PARA_NUM   3
#define SERIAL_PARA_NUM  1

int file_cfg();

#endif

6.2 主程序

#include <stdio.h>

#include "dictionary.h"
#include "iniparser.h"

#include "filecfg.h"

static char *school_key[SCHOOL_NUM] = {"name","age","sex"};
static char *tcp_key[TCP_NUM] = {"port","ip","family"};
static char *serial_key[SERIAL_NUM] = {"speed"};

int main()
{
 dictionary *cfg;
 int i;
 char key[40];
 char *p=NULL;

 char debug[100];

 cfg = iniparser_load(CFG_NAME); // 解析dictionary对象并返回(分配内存)dictionary对象
 if(cfg == NULL)
 {
     sprintf(debug,"iniparser_load %s failed",CFG_NAME);
     //debug_log(__FILE__,__FUNCTION__,__LINE__, debug);
     return -1;
 }
 
 // 第一组
 for(i = 0; i < SCHOOL_PARA_NUM; i++)
 {
     memset(key, 0, 40);
     sprintf(key, "school:%s",school_key[i]);
     p = iniparser_getstring(cfg,key,NULL);  //  返回dictionary对象的section:key对应的字符串值
  
     printf("school_key:%s\n", p);
 }
 
 // 第二组
 for (i = 0; i<TCP_PARA_NUM; i++)
 {
     memset(key, 0, 40);
     sprintf(key, "tcp:%s", tcp_key[i]);
     p = iniparser_getstring(cfg, key, NULL);
     printf("tcp_key:%s\n", p);  
 }

 // 第三组 
 for (i=0; i<SERIAL_PARA_NUM; i++)
 {
     memset(key, 0, 40);
     sprintf(key, "serial port:%s", serial_key[i]);
     p = iniparser_getstring(cfg, key, NULL);
     printf("serial_key:%s\n", p); 
 }
 printf("%s:\n",iniparser_getsecname(cfg,0)); //get section name
 printf("%s:\n",iniparser_getsecname(cfg,1)); //get section name
 printf("%s:\n",iniparser_getsecname(cfg,2)); //get section name

 iniparser_freedict(cfg);
 if(cfg != NULL)
 {
  cfg = NULL;
 }
 return 0;
}

7. 结果

school_key:ben
school_key:12
school_key:boy
tcp_key:8000
tcp_key:127.0.0.1
tcp_key:AF_INET
serial_key:9600
school:
tcp:
serial port:

8. 总结
   这个库对配置文件的管理还是很方便的，常用的功能基本都包含了