一、Iniparser概念
iniparser是针对INI文件的解析器。ini文件则是一些系统或者软件的配置文件。iniparser库的API可以对ini文件(配置文件)进行解析、设置、删除等操作。
下载:
Github:https://github.com/ndevilla/iniparser
二、基本格式
iNI文件的格式很简单,最基本的三个要素是:parameters,sections和comments。
节
[section]
参数(键=值)
name=value
注解
注解使用分号表示(;)。在分号后面的文字,直到该行结尾都全部为注解。
注意: iniparser 的一条原则是 section 和 key 大小写无关,写入的字符串全部小写化,取出的字符串也全部小写化。
例:
[mqtt_server_addr]
host =iot-06z00g18n84k1ba.mqtt.iothub.aliyuncs.com
port =1883
[user_passwd]
username =temp&hhm4nzHK9jW
passwd =e23df140ec2b3061b1da11748da06b8a9fc2cb3f300a135a564681f2b477ffc4
[client_id]
id =hhm4nzHK9jW.temp|securemode=2,signmethod=hmacsha256,timestamp=1657953844928|
[sub_topic]
topic =/sys/hhm4nzHK9jW/temp/thing/event/property/post_reply
[pub_topic]
topic =/sys/hhm4nzHK9jW/temp/thing/event/property/post
三、使用方法
主要代码在src目录下:
方法1
拷贝src下的头文件dictionary.h和iniparser.h到系统目录下,/usr/include 或 /usr/local/include.
拷贝压缩包目录下的静态库libiniparser.a和动态库libiniparser.so.1到目标文件系统的对应目录下,/usr/lib 或 lib/
方法2
直接将src下的dictionary.c,iniparser.c,dictionary.h和iniparser.h到项目目录下,在makefile里编译dictionary.c,iniparser.c,使用时调用头文件就行。
四、API详解
需要注意的是,定位一个key是用section:key来表示的,所以不同section下的key名称是可以相同的。
1、加载ini文件
(1)创建dictionary对象
dictionary * dictionary_new(int size);
(2)释放dictionary对象(内存)
void iniparser_freedict(dictionary * d);
(3)加载ini文件,将数据存于dictionary结构中。
解析dictionary对象并返回(分配内存)dictionary对象,path文件绝对路径
dictionary * iniparser_load(const char * ininame);
例:
dictionary *ini = NULL;
const char *path = "./ini_test.ini";
ini = iniparser_load(path);
2、获取
(1)获取dictionary对象的section个数
int iniparser_getnsec(dictionary * d);
(2)获取对应key的value。key以组+key的形式体现,如“client:port”。value以字符串形式返回,若未找到对应的key则返回def 的内容。
char * dictionary_get(dictionary * d, const char * key, char * def);
(3)获取dictionary对象的key值, key同样以“client:port”形式表示,若未找到则返回def
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对应的布尔值
上面三个函数都是获取dictionary对象的key值,当然也可以先用string解析出来,后强制转换为int,double,因为在写入配置文件时都是字符串。
(4)获取dictionary对象某个section下所有的key
慎用这个函数,因为第三个参数与返回值都是const char类型,搞不好就会:Segmentation fault (core dumped)
const char ** iniparser_getseckeys(const dictionary * d, const char * s, const char ** keys);
(5)获取dictionary对象的第n个section的名字
char * iniparser_getsecname(dictionary * d, int n);
3、设置与删除
修改文件后要以写或者追加权限修改文件
(1)删除dictionary对象
void dictionary_del(dictionary * vd);
(2)设置dictionary对象的某个section:key的值
int dictionary_set(dictionary * vd, const char * key, const char * val);
int iniparser_set(dictionary * ini, const char * entry, const char * val);
(3)删除dictionary对象中某个section:key
void dictionary_unset(dictionary * d, const char * key);
void iniparser_unset(dictionary * ini, const char * entry);
(4)判断dictionary对象中是否存在某个section:key,存在返回1,不存在返回0
int iniparser_find_entry(dictionary * ini, const char * entry) ;
(5)计算关键词的hash值
unsigned dictionary_hash(const char * key);
4、保存
保存的文件打开必须要有write权限
(1)保存dictionary对象到file
void iniparser_dump(dictionary * d, FILE * f); 打印整个配置文件信息(f赋值为stdout则输出到终端)
void iniparser_dump_ini(dictionary * d, FILE * f);
void iniparser_dump(dictionary * d, FILE * f);
void dictionary_dump(dictionary * d, FILE * out);
(2)保存dictionary对象到file
void iniparser_dump_ini(dictionary * d, FILE * f);
(3)保存dictionary对象一个section到file
void iniparser_dumpsection_ini(dictionary * d, char * s, FILE * f);
五、测试代码
aliyun.ini文件内容
test_ini.c
#include "dictionary.h"
#include "iniparser.h"
#include <stdio.h>
#include <string.h>
#define PATH "./aliyun.ini"
int main(int argc,char **argv)
{
dictionary *ini = NULL;
const char *client_id;
ini = iniparser_load(PATH);
if( ini ==NULL)
{
printf("inipar_load failure\n");
return -1;
}
client_id = iniparser_getstring(ini,"client_id:id",NULL);
printf("%s\n",client_id);
iniparser_freedict(ini);
return 0;
}
按照方法一
将src下的dictionary.c和iniparser.c打包成动态库libtest.so
编译运行