/usr/include/lirc/ciniparser.h is in liblirc-dev 0.9.4c-9.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 | #ifndef _INIPARSER_H_
#define _INIPARSER_H_
/* Copyright (c) 2000-2007 by Nicolas Devillard.
* Copyright (x) 2009 by Tim Post <tinkertim@gmail.com>
* MIT License
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*/
#ifdef __cplusplus
extern "C" {
#endif
/** @addtogroup ciniparser
* @{
*/
/**
* @file ciniparser.h
* @author N. Devillard
* @date Sep 2007
* @version 3.0
* @brief Parser for ini files.
* @ingroup private_api
*/
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include "dictionary.h"
#define ciniparser_getstr(d, k) ciniparser_getstring(d, k, NULL)
#define ciniparser_setstr ciniparser_setstring
/**
* @brief Get number of sections in a dictionary
* @param d Dictionary to examine
* @return int Number of sections found in dictionary, -1 on error
*
* This function returns the number of sections found in a dictionary.
* The test to recognize sections is done on the string stored in the
* dictionary: a section name is given as "section" whereas a key is
* stored as "section:key", thus the test looks for entries that do not
* contain a colon.
*
* This clearly fails in the case a section name contains a colon, but
* this should simply be avoided.
*/
int ciniparser_getnsec(dictionary* d);
/**
* @brief Get name for section n in a dictionary.
* @param d Dictionary to examine
* @param n Section number (from 0 to nsec-1).
* @return Pointer to char string, NULL on error
*
* This function locates the n-th section in a dictionary and returns
* its name as a pointer to a string statically allocated inside the
* dictionary. Do not free or modify the returned string!
*/
const char* ciniparser_getsecname(dictionary* d, int n);
/**
* @brief Save a dictionary to a loadable ini file
* @param d Dictionary to dump
* @param f Opened file pointer to dump to
* @return void
*
* This function dumps a given dictionary into a loadable ini file.
* It is Ok to specify @c stderr or @c stdout as output files.
*/
void ciniparser_dump_ini(dictionary* d, FILE* f);
/**
* @brief Dump a dictionary to an opened file pointer.
* @param d Dictionary to dump.
* @param f Opened file pointer to dump to.
* @return void
*
* This function prints out the contents of a dictionary, one element by
* line, onto the provided file pointer. It is OK to specify @c stderr
* or @c stdout as output files. This function is meant for debugging
* purposes mostly.
*/
void ciniparser_dump(dictionary* d, FILE* f);
/**
* @brief Get the string associated to a key
* @param d Dictionary to search
* @param key Key string to look for
* @param def Default value to return if key not found.
* @return pointer to statically allocated character string
*
* This function queries a dictionary for a key. A key as read from an
* ini file is given as "section:key". If the key cannot be found,
* the pointer passed as 'def' is returned.
* The returned char pointer is pointing to a string allocated in
* the dictionary, do not free or modify it.
*/
const char* ciniparser_getstring(dictionary* d, const char* key, char* def);
/**
* @brief Get the string associated to a key, convert to an int
* @param d Dictionary to search
* @param key Key string to look for
* @param notfound Value to return in case of error
* @return integer
*
* This function queries a dictionary for a key. A key as read from an
* ini file is given as "section:key". If the key cannot be found,
* the notfound value is returned.
*
* Supported values for integers include the usual C notation
* so decimal, octal (starting with 0) and hexadecimal (starting with 0x)
* are supported. Examples:
*
* - "42" -> 42
* - "042" -> 34 (octal -> decimal)
* - "0x42" -> 66 (hexa -> decimal)
*
* Warning: the conversion may overflow in various ways. Conversion is
* totally outsourced to strtol(), see the associated man page for overflow
* handling.
*
* Credits: Thanks to A. Becker for suggesting strtol()
*/
int ciniparser_getint(dictionary* d, const char* key, int notfound);
/**
* @brief Get the string associated to a key, convert to a double
* @param d Dictionary to search
* @param key Key string to look for
* @param notfound Value to return in case of error
* @return double
*
* This function queries a dictionary for a key. A key as read from an
* ini file is given as "section:key". If the key cannot be found,
* the notfound value is returned.
*/
double ciniparser_getdouble(dictionary* d, const char* key, double notfound);
/**
* @brief Get the string associated to a key, convert to a boolean
* @param d Dictionary to search
* @param key Key string to look for
* @param notfound Value to return in case of error
* @return integer
*
* This function queries a dictionary for a key. A key as read from an
* ini file is given as "section:key". If the key cannot be found,
* the notfound value is returned.
*
* A true boolean is found if one of the following is matched:
*
* - A string starting with 'y'
* - A string starting with 'Y'
* - A string starting with 't'
* - A string starting with 'T'
* - A string starting with '1'
*
* A false boolean is found if one of the following is matched:
*
* - A string starting with 'n'
* - A string starting with 'N'
* - A string starting with 'f'
* - A string starting with 'F'
* - A string starting with '0'
*
* The notfound value returned if no boolean is identified, does not
* necessarily have to be 0 or 1.
*/
int ciniparser_getboolean(dictionary* d, const char* key, int notfound);
/**
* @brief Set an entry in a dictionary.
* @param ini Dictionary to modify.
* @param entry Entry to modify (entry name)
* @param val New value to associate to the entry.
* @return int 0 if Ok, -1 otherwise.
*
* If the given entry can be found in the dictionary, it is modified to
* contain the provided value. If it cannot be found, -1 is returned.
* It is Ok to set val to NULL.
*/
int ciniparser_setstring(dictionary* ini, char const* entry, const char* val);
/**
* @brief Delete an entry in a dictionary
* @param ini Dictionary to modify
* @param entry Entry to delete (entry name)
* @return void
*
* If the given entry can be found, it is deleted from the dictionary.
*/
void ciniparser_unset(dictionary* ini, char* entry);
/**
* @brief Finds out if a given entry exists in a dictionary
* @param ini Dictionary to search
* @param entry Name of the entry to look for
* @return integer 1 if entry exists, 0 otherwise
*
* Finds out if a given entry exists in the dictionary. Since sections
* are stored as keys with NULL associated values, this is the only way
* of querying for the presence of sections in a dictionary.
*/
int ciniparser_find_entry(dictionary* ini, const char* entry);
/**
* @brief Parse an ini file and return an allocated dictionary object
* @param ininame Name of the ini file to read.
* @return Pointer to newly allocated dictionary
*
* This is the parser for ini files. This function is called, providing
* the name of the file to be read. It returns a dictionary object that
* should not be accessed directly, but through accessor functions
* instead.
*
* The returned dictionary must be freed using ciniparser_freedict().
*/
dictionary* ciniparser_load(const char* ininame);
/**
* @brief Free all memory associated to an ini dictionary
* @param d Dictionary to free
* @return void
*
* Free all memory associated to an ini dictionary.
* It is mandatory to call this function before the dictionary object
* gets out of the current context.
*/
void ciniparser_freedict(dictionary* d);
/**
* @brief Set an item in the dictionary
* @param d Dictionary object created by ciniparser_load()
* @param entry Entry in the dictionary to manipulate
* @param val Value to assign to the entry
* @return 0 on success, -1 on error
*
* Remember that string values are converted by ciniparser_getboolean(),
* ciniparser_getdouble(), etc. It is also OK to set an entry to NULL.
*/
int ciniparser_set(dictionary* d, const char* entry, const char* val);
#ifdef __cplusplus
}
#endif
#endif
/** @}
*/
|