Rename "subsystems" directory to "base"
[oonf.git] / include / oonf / libconfig / cfg.h
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon version 2 (olsrd2)
4  * Copyright (c) 2004-2015, the olsr.org team - see HISTORY file
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  *   notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above copyright
14  *   notice, this list of conditions and the following disclaimer in
15  *   the documentation and/or other materials provided with the
16  *   distribution.
17  * * Neither the name of olsr.org, olsrd nor the names of its
18  *   contributors may be used to endorse or promote products derived
19  *   from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  *
34  * Visit http://www.olsr.org for more information.
35  *
36  * If you find this software useful feel free to make a donation
37  * to the project. For more information see the website or contact
38  * the copyright holders.
39  *
40  */
41
42 /**
43  * @file
44  */
45
46 #ifndef CFG_H_
47 #define CFG_H_
48
49 /* forward declaration */
50 struct cfg_instance;
51
52 #include <ctype.h>
53
54 #include <oonf/libcommon/autobuf.h>
55 #include <oonf/libcommon/avl.h>
56 #include <oonf/oonf.h>
57
58 #include <oonf/libconfig/cfg_cmd.h>
59 #include <oonf/libconfig/cfg_io.h>
60 #include <oonf/libconfig/cfg_schema.h>
61
62 /*! Separator for configuration URL */
63 #define CFG_IO_URL_SPLITTER "://"
64
65 /**
66  * Instance of a configuration handler with default io handler
67  */
68 struct cfg_instance {
69   /*! tree of io handlers and format parsers */
70   struct avl_tree io_tree;
71
72   /*! name of default io file handler */
73   const char *default_io;
74 };
75
76 EXPORT void cfg_add(struct cfg_instance *);
77 EXPORT void cfg_remove(struct cfg_instance *);
78
79 EXPORT int cfg_append_printable_line(struct autobuf *autobuf, const char *fmt, ...)
80   __attribute__((format(printf, 2, 3)));
81 EXPORT bool cfg_is_allowed_key(const char *key);
82 EXPORT const char *cfg_get_choice_array_value(size_t idx, const void *ptr);
83 EXPORT int cfg_get_choice_index(
84   const char *key, const char *(*callback)(size_t idx, const void *ptr), size_t choices_count, const void *ptr);
85
86 EXPORT int cfg_avlcmp_keys(const void *p1, const void *p2);
87
88 EXPORT void cfg_set_ifname_handler(int (*get_phy_if)(char *phy_ifname, const char *ifname));
89 EXPORT const char *cfg_get_phy_if(char *phy_if, const char *ifname);
90
91 /**
92  * Compares to keys/names of two section types/names or entry names.
93  * A NULL pointer is considered larger than any valid string.
94  * @param str1 first key
95  * @param str2 second key
96  * @return similar to strcmp()
97  */
98 static INLINE int
99 cfg_cmp_keys(const char *str1, const char *str2) {
100   return cfg_avlcmp_keys(str1, str2);
101 }
102
103 /**
104  * Checks if a string value represents a positive boolean value
105  * @param value string representation of boolean
106  * @return boolean value of the string representation
107  */
108 static INLINE bool
109 cfg_get_bool(const char *value) {
110   return cfg_get_choice_index(value, cfg_get_choice_array_value, ARRAYSIZE(CFGLIST_BOOL_TRUE), CFGLIST_BOOL_TRUE) >= 0;
111 }
112
113 /**
114  * Checks if a string value represents a boolean value
115  * @param value string value that might contain a boolean text representation
116  * @return true if string is a boolean, false otherwise
117  */
118 static INLINE bool
119 cfg_is_bool(const char *value) {
120   return cfg_get_choice_index(value, cfg_get_choice_array_value, ARRAYSIZE(CFGLIST_BOOL), CFGLIST_BOOL) >= 0;
121 }
122
123 /**
124  * Checks if a section name is valid
125  * @param name name of a configuration section
126  * @return true if name contains no space, false otherwise
127  */
128 static INLINE bool
129 cfg_is_allowed_section_name(const char *name) {
130   return strchr(name, ' ') == NULL;
131 }
132
133 #endif /* CFG_H_ */