From af747ef34a9a152614fcde18abcfc6e1e3ec5d0e Mon Sep 17 00:00:00 2001 From: Andrew Gregory Date: Mon, 14 Sep 2015 18:37:39 -0400 Subject: move ini parser into common Signed-off-by: Andrew Gregory Signed-off-by: Allan McRae --- src/common/ini.c | 116 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ src/common/ini.h | 30 ++++++++++++++ src/pacman/ini.c | 117 +------------------------------------------------------ src/pacman/ini.h | 31 +-------------- 4 files changed, 148 insertions(+), 146 deletions(-) create mode 100644 src/common/ini.c create mode 100644 src/common/ini.h mode change 100644 => 120000 src/pacman/ini.c mode change 100644 => 120000 src/pacman/ini.h (limited to 'src') diff --git a/src/common/ini.c b/src/common/ini.c new file mode 100644 index 00000000..fed0b187 --- /dev/null +++ b/src/common/ini.c @@ -0,0 +1,116 @@ +/* + * ini.c + * + * Copyright (c) 2013-2015 Pacman Development Team + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#include +#include +#include /* strdup */ + +#include + +#include "ini.h" +#include "util.h" + +/** + * @brief Parse a pacman-style INI config file. + * + * @param file path to the config file + * @param cb callback for key/value pairs + * @param data caller defined data to be passed to the callback + * + * @return the callback return value + * + * @note The callback will be called at the beginning of each section with an + * empty key and value and for each key/value pair. + * + * @note If the parser encounters an error the callback will be called with + * section, key, and value set to NULL and errno set by fopen, fgets, or + * strdup. + * + * @note The @a key and @a value passed to @ cb will be overwritten between + * calls. The section name will remain valid until after @a cb is called to + * begin a new section. + * + * @note Parsing will immediately stop if the callback returns non-zero. + */ +int parse_ini(const char *file, ini_parser_fn cb, void *data) +{ + char line[PATH_MAX], *section_name = NULL; + FILE *fp = NULL; + int linenum = 0; + int ret = 0; + + fp = fopen(file, "r"); + if(fp == NULL) { + return cb(file, 0, NULL, NULL, NULL, data); + } + + while(safe_fgets(line, PATH_MAX, fp)) { + char *key, *value, *ptr; + size_t line_len; + + linenum++; + + /* ignore whole line and end of line comments */ + if((ptr = strchr(line, '#'))) { + *ptr = '\0'; + } + + line_len = strtrim(line); + + if(line_len == 0) { + continue; + } + + if(line[0] == '[' && line[line_len - 1] == ']') { + char *name; + /* new config section, skip the '[' */ + name = strdup(line + 1); + name[line_len - 2] = '\0'; + + ret = cb(file, linenum, name, NULL, NULL, data); + free(section_name); + section_name = name; + + /* we're at a new section; perform any post-actions for the prior */ + if(ret) { + goto cleanup; + } + continue; + } + + /* directive */ + /* strsep modifies the 'line' string: 'key \0 value' */ + key = line; + value = line; + strsep(&value, "="); + strtrim(key); + strtrim(value); + + if((ret = cb(file, linenum, section_name, key, value, data)) != 0) { + goto cleanup; + } + } + +cleanup: + fclose(fp); + free(section_name); + return ret; +} + +/* vim: set noet: */ diff --git a/src/common/ini.h b/src/common/ini.h new file mode 100644 index 00000000..e85a505d --- /dev/null +++ b/src/common/ini.h @@ -0,0 +1,30 @@ +/* + * ini.h + * + * Copyright (c) 2013-2015 Pacman Development Team + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#ifndef _PM_INI_H +#define _PM_INI_H + +typedef int (ini_parser_fn)(const char *file, int line, const char *section, + char *key, char *value, void *data); + +int parse_ini(const char *file, ini_parser_fn cb, void *data); + +#endif /* _PM_CONF_H */ + +/* vim: set noet: */ diff --git a/src/pacman/ini.c b/src/pacman/ini.c deleted file mode 100644 index da30af1c..00000000 --- a/src/pacman/ini.c +++ /dev/null @@ -1,116 +0,0 @@ -/* - * ini.c - * - * Copyright (c) 2013-2015 Pacman Development Team - * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 2 of the License, or - * (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see . - */ - -#include -#include -#include /* strdup */ - -#include - -#include "ini.h" -#include "util-common.h" - -/** - * @brief Parse a pacman-style INI config file. - * - * @param file path to the config file - * @param cb callback for key/value pairs - * @param data caller defined data to be passed to the callback - * - * @return the callback return value - * - * @note The callback will be called at the beginning of each section with an - * empty key and value and for each key/value pair. - * - * @note If the parser encounters an error the callback will be called with - * section, key, and value set to NULL and errno set by fopen, fgets, or - * strdup. - * - * @note The @a key and @a value passed to @ cb will be overwritten between - * calls. The section name will remain valid until after @a cb is called to - * begin a new section. - * - * @note Parsing will immediately stop if the callback returns non-zero. - */ -int parse_ini(const char *file, ini_parser_fn cb, void *data) -{ - char line[PATH_MAX], *section_name = NULL; - FILE *fp = NULL; - int linenum = 0; - int ret = 0; - - fp = fopen(file, "r"); - if(fp == NULL) { - return cb(file, 0, NULL, NULL, NULL, data); - } - - while(safe_fgets(line, PATH_MAX, fp)) { - char *key, *value, *ptr; - size_t line_len; - - linenum++; - - /* ignore whole line and end of line comments */ - if((ptr = strchr(line, '#'))) { - *ptr = '\0'; - } - - line_len = strtrim(line); - - if(line_len == 0) { - continue; - } - - if(line[0] == '[' && line[line_len - 1] == ']') { - char *name; - /* new config section, skip the '[' */ - name = strdup(line + 1); - name[line_len - 2] = '\0'; - - ret = cb(file, linenum, name, NULL, NULL, data); - free(section_name); - section_name = name; - - /* we're at a new section; perform any post-actions for the prior */ - if(ret) { - goto cleanup; - } - continue; - } - - /* directive */ - /* strsep modifies the 'line' string: 'key \0 value' */ - key = line; - value = line; - strsep(&value, "="); - strtrim(key); - strtrim(value); - - if((ret = cb(file, linenum, section_name, key, value, data)) != 0) { - goto cleanup; - } - } - -cleanup: - fclose(fp); - free(section_name); - return ret; -} - -/* vim: set noet: */ diff --git a/src/pacman/ini.c b/src/pacman/ini.c new file mode 120000 index 00000000..ba0e024f --- /dev/null +++ b/src/pacman/ini.c @@ -0,0 +1 @@ +../common/ini.c \ No newline at end of file diff --git a/src/pacman/ini.h b/src/pacman/ini.h deleted file mode 100644 index e85a505d..00000000 --- a/src/pacman/ini.h +++ /dev/null @@ -1,30 +0,0 @@ -/* - * ini.h - * - * Copyright (c) 2013-2015 Pacman Development Team - * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 2 of the License, or - * (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see . - */ - -#ifndef _PM_INI_H -#define _PM_INI_H - -typedef int (ini_parser_fn)(const char *file, int line, const char *section, - char *key, char *value, void *data); - -int parse_ini(const char *file, ini_parser_fn cb, void *data); - -#endif /* _PM_CONF_H */ - -/* vim: set noet: */ diff --git a/src/pacman/ini.h b/src/pacman/ini.h new file mode 120000 index 00000000..a0640e5f --- /dev/null +++ b/src/pacman/ini.h @@ -0,0 +1 @@ +../common/ini.h \ No newline at end of file -- cgit v1.2.3-24-g4f1b