Rename "subsystems" directory to "base"
[oonf.git] / include / oonf / libconfig / cfg_io.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_IO_H_
47 #define CFG_IO_H_
48
49 /* forward declaration */
50 struct cfg_io;
51
52 #include <oonf/libcommon/autobuf.h>
53 #include <oonf/libcommon/avl.h>
54 #include <oonf/oonf.h>
55
56 #include <oonf/libconfig/cfg.h>
57
58 /**
59  *  Represents a single IO-Handler
60  */
61 struct cfg_io {
62   /*! node for global tree in cfg_io.c */
63   struct avl_node node;
64
65   /*! name of io handler */
66   const char *name;
67
68   /*! true if this is the default handler */
69   bool def;
70
71   /**
72    * callback to load a configuration
73    * @param param user parameter for configuration loader
74    * @param log buffer for text output of the loader
75    * @return configuration database, NULL if an error happened
76    */
77   struct cfg_db *(*load)(const char *param, struct autobuf *log);
78
79   /**
80    * callback to save a configuration
81    * @param param user parameter for configuration storage
82    * @param src configuration database to save
83    * @param log buffer for text output while storing the data
84    * @return -1 if an error happened, 0 otherwise
85    */
86   int (*save)(const char *param, struct cfg_db *src, struct autobuf *log);
87 };
88
89 /**
90  * Macro to iterate over all IO handlers of a configuration instance
91  * This macro should be used similar to a for() or while() construct
92  * @param instance configuration instance
93  * @param io reference of io handler variable,
94  *   will be used as the iterator variable
95  * @param safeit helper reference of of io handler variable
96  */
97 #define CFG_FOR_ALL_IO(instance, io, safeit) avl_for_each_element_safe(&(instance)->io_tree, io, node, safeit)
98
99 EXPORT void cfg_io_add(struct cfg_instance *, struct cfg_io *);
100 EXPORT void cfg_io_remove(struct cfg_instance *, struct cfg_io *);
101
102 EXPORT struct cfg_db *cfg_io_load(struct cfg_instance *instance, const char *url, struct autobuf *log);
103 EXPORT int cfg_io_save(struct cfg_instance *instance, const char *url, struct cfg_db *src, struct autobuf *log);
104
105 #endif /* CFG_IO_H_ */