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

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

最近在做一个嵌入式设备开发项目,主要使用C语言,当碰到配置文件解析时遇到了问题,由于水平太差,自己拿链表改改写了一个,发现并不能很好地满足项目需求,于是google发现了这么个轮子,iniparser。

介绍

下载

官方网站:http://ndevilla.free.fr/iniparser
Github:https://github.com/ndevilla/iniparser

目前最新的版本已经达到了4.1,可以选择新版本下载。

两种使用方法

1.编译生成动态链接库
a.解压

tar -zxvf iniparser-3.1.tar.gz   
cd tar -zxvf iniparser 

b.编译

make  

拷贝src下的头文件dictionary.h和iniparser.h以及压缩包目录下的静态库libiniparser.a和动态库libiniparser.so.1到目标文件系统的对应目录下。

2.直接编译源码使用
复制src下的dictionary.h,iniparser.h,dictionary.h和iniparser.h到项目目录,将文件加入到项目Makefile编译目标里。

API

dictionary.h里面声明了一些直接解析ini file的API,iniparser.h里面声明了一些提供用户操作的API。iniparser.h里面的API是对dictionary.h里面API的再次封装,以提供用户友好性。

1.iniparser.h中的API

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对象(内存)  

2.dictionary.h中的API

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对象 

测试过程

配置文件

[udp]
port = 8000
ip = 127.0.0.1
family = AF_INET
mtu = 1500

[serial port]
speed = 9600
stop = 1

[can]
baud = 250000

测试代码

#include 
#include 
#include "iniparser.h"

int main(void)
{
    dictionary *ini;

    ini = iniparser_load(".conf");//parser the file

    printf("%s:\n",iniparser_getsecname(ini,0));//get section name
    int n = iniparser_getint(ini,"udp:port",-1);
    printf("port : %d\n",n);

    const char *str = iniparser_getstring(ini,"udp:ip","null");
    printf("ip : %s\n",str);

    printf("\n%s:\n",iniparser_getsecname(ini,1));
    n = iniparser_getint(ini,"serial port:speed",-1);
    printf("speed : %d\n",n);

    iniparser_set(ini, "serial port:stop", "1");
    iniparser_set(ini, "udp:mtu", "1500");
    iniparser_set(ini, "can:baud", "250000");

    n = iniparser_getint(ini,"serial port:stop",-1);
    printf("stop : %d\n",n);
    iniparser_save(ini, ".conf");

    iniparser_freedict(ini);//free dirctionary object

    return 0;
}

由于iniparser库提供的保存到文件的api封装太底层,我单独写了一个保存到文件的函数,如下:

/*-------------------------------------------------------------------------*/
/**
  @brief    Save the dictionary to ini file
  @param    d Dictionary to free
  @param    inipath Ini file path
  @return   0:OK,-1:params NULL,-2:file open error

  Save the dictionary to ini file.
 */
int iniparser_save(dictionary * d, const char *inipath)
{
    int ret = 0;
    FILE *fp = NULL;

    if (inipath == NULL || d == NULL) {
        ret = -1;
        printf("saveConfig error:%d from (filepath == NULL || head == NULL)\n",ret);
        return ret;
    }

    fp = fopen(inipath,"w");
    if (fp == NULL) {
        ret = -2;
        printf("saveConfig:open file error:%d from %s\n",ret,inipath);
        return ret;
    }

    iniparser_dump_ini(d,fp);

    fclose(fp);

    return 0;
}

运行结果

udp:
port : 8000
ip : 127.0.0.1

serial port:
speed : 9600
stop : 1

ini文件格式

[section0]
name0=value0
name1=value1
[section1]
name0=value0
name1=value1

总结

实践表明,这个轮子对配置文件增删改查还是很方便的。

反馈与建议

GITHUB:LANB0
博客:Linux小鸟的专栏、菜鸟程序员

你可能感兴趣的:(C/C++)