Linux下利用iniparser庫——使用C程式設計實現設定文件的讀寫

2020-08-11 16:38:16

目錄

原始碼gitHub下載地址:GitHub鏈接

inipaeser庫的使用方法

inipaeser設定文件的基本書寫格式

使用ini組態檔範例 

inipaeser.h中的基本API

dictionary.h中的基本API

C解析範例


最近,再利用樹莓派實現4Gppp撥號時,自己在寫參數解析的函數時發現有太多的參數需要輸入,如串列埠的波特率、裝置名、奇偶校驗、停止位等等......如果所有參數都需要我們一一輸入然後在一一解析實在是太麻煩了,百度發現可以使用inipaeser庫來解析出我們寫入組態檔的所有資訊,進而解決了這個棘手的問題。

  • 原始碼gitHub下載地址:GitHub鏈接

  • inipaeser庫的使用方法

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編譯目標裡。

  • inipaeser設定文件的基本書寫格式

;其中';'表示註釋,第一[xxx],其中xxx爲該設定文件的第一部分,第二個[xxx],爲其第二部分,一次類推。
[section0]     ;第一部分
name0=val0     ;定義第一個變數name0,其值爲val0,不管是什麼型別的值,都使用‘=’給其賦值
name1=val1
[section1]     ;第二部分
name0=value0
name1=value1
  • 使用ini組態檔範例 

;建立第一部分,與串列埠相關的設定
[comport] 
device_name                    = /dev/ttyUSB2
nspeed                         = 115200
nstop                          = 1 
nbits                          = 8 
nevent                         = N 


;建立第一部分,與ppp撥號相關的設定
[ppp]
ping_ipaddr                    = 4.2.2.2


;建立第一部分,與mosquitto相關的設定
[mosquitto]
host                           = a1qhZLMC
password                       = 6B16C7526688A90274603
client_id                      = 666888|securemode=3|
port                           = 1883
sub_topic                      = /sys/a1qhZLMCMvl
dev_name                       = /dev/ttyUSB3
user_name                      = Switch
keepalive                      = 60

  • inipaeser.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物件(記憶體)  
  • 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物件 
  • C解析範例

  • 組態檔
[comport]
device_name                    = /dev/ttyUSB2
nspeed                         = 115200
nstop                          = 1 
nbits                          = 8 
nevent                         = N 


[ppp]
ping_ipaddr                    = 4.2.2.2


[mosquitto]
host                           = a1qhZLMCMvl.iot-as-mqtt.cn-shanghai.aliyuncs.com
password                       = 6B16C7526688A902746032C03374C6B80998B7D5
client_id                      = 666888|securemode=3,signmethod=hmacsha1|
port                           = 1883
sub_topic                      = /sys/a1qhZLMCMvl/Switch/thing/event/property/post
dev_name                       = /dev/ttyUSB3
user_name                      = Switch&a1qhZLMCMvl
keepalive                      = 

  • 原始檔
/*********************************************************************************
 *      Copyright:  (C) 2020 ysn
 *                  All rights reserved.
 *
 *       Filename:  tets.c
 *    Description:  This file 
 *                 
 *        Version:  1.0.0(11/08/20)
 *         Author:  tianjincheng <[email protected]>
 *      ChangeLog:  1, Release initial version on "11/08/20 07:38:08"
 *                 
 ********************************************************************************/
#include <stdio.h>
#include <stdlib.h>
#include "iniparser.h"
#include "dictionary.h"
#define  INI_PATH "init_param.conf"
int iniparser_save(dictionary * d, const char *inipath);
int main(void)
{
    dictionary *ini;

    ini = iniparser_load(INI_PATH);//parser the file

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

    const char *str = iniparser_getstring(ini,"comport:device_name","null");
    printf("device_name : %s\n",str);
printf("\n%s:\n",iniparser_getsecname(ini,1));
    const char *ip = iniparser_getstring(ini,"ppp:ping_ipaddr","null");
    printf("ping_ipaddr : %s\n",ip);


    printf("\n%s:\n",iniparser_getsecname(ini,2));
    iniparser_set(ini, "mosquitto:keepalive", "60");

    iniparser_save(ini, INI_PATH);
    iniparser_freedict(ini);//free dirctionary object

    return 0;
}

int iniparser_save(dictionary * d, const char *inipath)  //自己實現的ini設定文件儲存函數
{
    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;
}
  • 執行結果