src/include/settings.h

#ifndef SETTINGS_H
#define SETTINGS_H

/*
 *  Copyright (C) 2006-2007  Anders Gavare.  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *
 *  1. Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *  2. Redistributions in binary form must reproduce the above copyright  
 *     notice, this list of conditions and the following disclaimer in the 
 *     documentation and/or other materials provided with the distribution.
 *  3. The name of the author may not be used to endorse or promote products
 *     derived from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 *  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE   
 *  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 *  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 *  OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 *  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 *  OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 *  SUCH DAMAGE.
 *
 *
 *  $Id: settings.h,v 1.9 2006/12/30 13:31:01 debug Exp $
 */

#include <inttypes.h>

#define GLOBAL_SETTINGS_NAME    "settings"

struct settings;

/*  Storage types:  */
#define SETTINGS_TYPE_SUBSETTINGS       1
#define SETTINGS_TYPE_STRING            2
#define SETTINGS_TYPE_INT               3
#define SETTINGS_TYPE_INT8              4
#define SETTINGS_TYPE_INT16             5
#define SETTINGS_TYPE_INT32             6
#define SETTINGS_TYPE_INT64             7
#define SETTINGS_TYPE_UINT              8
#define SETTINGS_TYPE_UINT8             9
#define SETTINGS_TYPE_UINT16            10
#define SETTINGS_TYPE_UINT32            11
#define SETTINGS_TYPE_UINT64            12

/*  Presentation formats:  */
#define SETTINGS_FORMAT_DECIMAL         1       /*  -123  */
#define SETTINGS_FORMAT_HEX8            2       /*  0x12  */
#define SETTINGS_FORMAT_HEX16           3       /*  0x1234  */
#define SETTINGS_FORMAT_HEX32           4       /*  0x80000000  */
#define SETTINGS_FORMAT_HEX64           5       /*  0xffffffff80000000  */
#define SETTINGS_FORMAT_BOOL            6       /*  true, false  */
#define SETTINGS_FORMAT_YESNO           7       /*  yes, no  */
#define SETTINGS_FORMAT_STRING          8       /*  %s  */


/*
 *  settings.c:
 */

struct settings *settings_new(void);
void settings_destroy(struct settings *settings);

void settings_debugdump(struct settings *settings, const char *prefix,
        int recurse);

void settings_add(struct settings *settings, const char *name, int writable,
        int type, int format, void *ptr);
void settings_remove(struct settings *settings, const char *name);
void settings_remove_all(struct settings *settings);

int settings_access(struct settings *settings, const char *fullname,
        int writeflag, uint64_t *valuep);

/*  Result codes from settings_access:  */
#define SETTINGS_OK                     1
#define SETTINGS_NAME_NOT_FOUND         2
#define SETTINGS_READONLY               3


#endif  /*  SETTINGS_H  */
1	dpavlin	24	#ifndef SETTINGS_H
2			#define SETTINGS_H
3
4			/*
5	dpavlin	34	* Copyright (C) 2006-2007 Anders Gavare. All rights reserved.
6	dpavlin	24	*
7			* Redistribution and use in source and binary forms, with or without
8			* modification, are permitted provided that the following conditions are met:
9			*
10			* 1. Redistributions of source code must retain the above copyright
11			* notice, this list of conditions and the following disclaimer.
12			* 2. Redistributions in binary form must reproduce the above copyright
13			* notice, this list of conditions and the following disclaimer in the
14			* documentation and/or other materials provided with the distribution.
15			* 3. The name of the author may not be used to endorse or promote products
16			* derived from this software without specific prior written permission.
17			*
18			* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19			* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20			* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21			* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22			* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23			* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24			* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25			* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26			* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27			* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28			* SUCH DAMAGE.
29			*
30			*
31	dpavlin	34	* $Id: settings.h,v 1.9 2006/12/30 13:31:01 debug Exp $
32	dpavlin	24	*/
33
34			#include <inttypes.h>
35
36			#define GLOBAL_SETTINGS_NAME "settings"
37
38			struct settings;
39
40			/* Storage types: */
41			#define SETTINGS_TYPE_SUBSETTINGS 1
42	dpavlin	32	#define SETTINGS_TYPE_STRING 2
43			#define SETTINGS_TYPE_INT 3
44			#define SETTINGS_TYPE_INT8 4
45			#define SETTINGS_TYPE_INT16 5
46			#define SETTINGS_TYPE_INT32 6
47			#define SETTINGS_TYPE_INT64 7
48			#define SETTINGS_TYPE_UINT 8
49			#define SETTINGS_TYPE_UINT8 9
50			#define SETTINGS_TYPE_UINT16 10
51			#define SETTINGS_TYPE_UINT32 11
52			#define SETTINGS_TYPE_UINT64 12
53	dpavlin	24
54			/* Presentation formats: */
55			#define SETTINGS_FORMAT_DECIMAL 1 /* -123 */
56	dpavlin	32	#define SETTINGS_FORMAT_HEX8 2 /* 0x12 */
57			#define SETTINGS_FORMAT_HEX16 3 /* 0x1234 */
58			#define SETTINGS_FORMAT_HEX32 4 /* 0x80000000 */
59			#define SETTINGS_FORMAT_HEX64 5 /* 0xffffffff80000000 */
60			#define SETTINGS_FORMAT_BOOL 6 /* true, false */
61			#define SETTINGS_FORMAT_YESNO 7 /* yes, no */
62			#define SETTINGS_FORMAT_STRING 8 /* %s */
63	dpavlin	24
64	dpavlin	32
65			/*
66			* settings.c:
67			*/
68
69	dpavlin	24	struct settings *settings_new(void);
70			void settings_destroy(struct settings *settings);
71	dpavlin	32
72	dpavlin	24	void settings_debugdump(struct settings settings, const char prefix,
73			int recurse);
74	dpavlin	32
75	dpavlin	24	void settings_add(struct settings settings, const char name, int writable,
76			int type, int format, void *ptr);
77	dpavlin	32	void settings_remove(struct settings settings, const char name);
78			void settings_remove_all(struct settings *settings);
79	dpavlin	24
80	dpavlin	32	int settings_access(struct settings settings, const char fullname,
81			int writeflag, uint64_t *valuep);
82
83			/* Result codes from settings_access: */
84			#define SETTINGS_OK 1
85			#define SETTINGS_NAME_NOT_FOUND 2
86			#define SETTINGS_READONLY 3
87
88
89	dpavlin	24	#endif /* SETTINGS_H */