hedgewars: project_files/frontlib/util/inihelper.h@5143861c83bd (annotated)

7175 038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	1	/**
7224 5143861c83bd Cleanup, refactoring and generally more development in the frontlib Medo <smaxein@googlemail.com> parents: 7179 diff changeset	2	* Convenience interface for ini reading/writing.
5143861c83bd Cleanup, refactoring and generally more development in the frontlib Medo <smaxein@googlemail.com> parents: 7179 diff changeset	3	*
5143861c83bd Cleanup, refactoring and generally more development in the frontlib Medo <smaxein@googlemail.com> parents: 7179 diff changeset	4	* We currently use iniparser in the background, but using its interface directly is a bit verbose.
5143861c83bd Cleanup, refactoring and generally more development in the frontlib Medo <smaxein@googlemail.com> parents: 7179 diff changeset	5	* This module is supposed to 1. make ini reading and writing a bit more convenient, and 2. hide
5143861c83bd Cleanup, refactoring and generally more development in the frontlib Medo <smaxein@googlemail.com> parents: 7179 diff changeset	6	* the iniparser dependency so it can at need be easily replaced.
7175 038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	7	*/
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	8
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	9	#ifndef INIHELPER_H_
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	10	#define INIHELPER_H_
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	11
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	12	#include "../iniparser/iniparser.h"
7179 f84805e6df03 Implemented game launching API for the frontlib. Medo <smaxein@googlemail.com> parents: 7177 diff changeset	13
7175 038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	14	#include <stdbool.h>
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	15
7224 5143861c83bd Cleanup, refactoring and generally more development in the frontlib Medo <smaxein@googlemail.com> parents: 7179 diff changeset	16	struct _flib_ini;
5143861c83bd Cleanup, refactoring and generally more development in the frontlib Medo <smaxein@googlemail.com> parents: 7179 diff changeset	17	typedef struct _flib_inihelper flib_ini;
5143861c83bd Cleanup, refactoring and generally more development in the frontlib Medo <smaxein@googlemail.com> parents: 7179 diff changeset	18
7175 038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	19	/**
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	20	* Returned buffer must be free()d
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	21	*/
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	22	char inihelper_urlencode(const char inbuf);
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	23
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	24	/**
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	25	* Returned buffer must be free()d
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	26	*/
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	27	char inihelper_urldecode(const char inbuf);
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	28
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	29	/**
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	30	* Create a key in the format "sectionName:keyName"
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	31	* Returned buffer must be free()d
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	32	*/
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	33	char inihelper_createDictKey(const char sectionName, const char *keyName);
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	34
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	35	/**
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	36	* Returns an internal buffer, don't modify or free
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	37	* Sets error to true if something goes wrong, leaves it unchanged otherwise.
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	38	*/
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	39	char inihelper_getstring(dictionary inifile, bool error, const char sectionName, const char *keyName);
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	40
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	41	/**
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	42	* Returned buffer must be free()d
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	43	* Sets error to true if something goes wrong, leaves it unchanged otherwise.
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	44	*/
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	45	char inihelper_getstringdup(dictionary inifile, bool error, const char sectionName, const char *keyName);
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	46
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	47	/**
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	48	* Sets error to true if something goes wrong, leaves it unchanged otherwise.
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	49	*/
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	50	int inihelper_getint(dictionary inifile, bool error, const char sectionName, const char keyName);
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	51
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	52	/**
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	53	* Sets error to true if something goes wrong, leaves it unchanged otherwise.
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	54	*/
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	55	bool inihelper_getbool(dictionary inifile, bool error, const char sectionName, const char keyName);
038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	56
7224 5143861c83bd Cleanup, refactoring and generally more development in the frontlib Medo <smaxein@googlemail.com> parents: 7179 diff changeset	57	/**
5143861c83bd Cleanup, refactoring and generally more development in the frontlib Medo <smaxein@googlemail.com> parents: 7179 diff changeset	58	* Returns a nonzero value on error.
5143861c83bd Cleanup, refactoring and generally more development in the frontlib Medo <smaxein@googlemail.com> parents: 7179 diff changeset	59	*/
7175 038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	60	int inihelper_setstr(dictionary dict, const char sectionName, const char keyName, const char value);
7224 5143861c83bd Cleanup, refactoring and generally more development in the frontlib Medo <smaxein@googlemail.com> parents: 7179 diff changeset	61
5143861c83bd Cleanup, refactoring and generally more development in the frontlib Medo <smaxein@googlemail.com> parents: 7179 diff changeset	62	/**
5143861c83bd Cleanup, refactoring and generally more development in the frontlib Medo <smaxein@googlemail.com> parents: 7179 diff changeset	63	* Returns a nonzero value on error.
5143861c83bd Cleanup, refactoring and generally more development in the frontlib Medo <smaxein@googlemail.com> parents: 7179 diff changeset	64	*/
7175 038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	65	int inihelper_setint(dictionary dict, const char sectionName, const char *keyName, int value);
7224 5143861c83bd Cleanup, refactoring and generally more development in the frontlib Medo <smaxein@googlemail.com> parents: 7179 diff changeset	66
5143861c83bd Cleanup, refactoring and generally more development in the frontlib Medo <smaxein@googlemail.com> parents: 7179 diff changeset	67	/**
5143861c83bd Cleanup, refactoring and generally more development in the frontlib Medo <smaxein@googlemail.com> parents: 7179 diff changeset	68	* Set an ini setting to "true" or "false".
5143861c83bd Cleanup, refactoring and generally more development in the frontlib Medo <smaxein@googlemail.com> parents: 7179 diff changeset	69	* Returns a nonzero value on error.
5143861c83bd Cleanup, refactoring and generally more development in the frontlib Medo <smaxein@googlemail.com> parents: 7179 diff changeset	70	*/
7175 038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	71	int inihelper_setbool(dictionary dict, const char sectionName, const char *keyName, bool value);
7224 5143861c83bd Cleanup, refactoring and generally more development in the frontlib Medo <smaxein@googlemail.com> parents: 7179 diff changeset	72
7175 038e3415100a Added ini reading/writing for game schemes to the frontend lib Medo <smaxein@googlemail.com> parents: diff changeset	73	#endif /* INIHELPER_H_ */

author	Medo <smaxein@googlemail.com>
	Tue, 12 Jun 2012 11:25:05 +0200
changeset 7224	5143861c83bd
parent 7179	f84805e6df03
child 7227	1c859f572d72
permissions	-rw-r--r--