4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
6 // Stefan Bund <g0dil@berlios.de>
8 // This program is free software; you can redistribute it and/or modify
9 // it under the terms of the GNU General Public License as published by
10 // the Free Software Foundation; either version 2 of the License, or
11 // (at your option) any later version.
13 // This program is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 // GNU General Public License for more details.
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the
20 // Free Software Foundation, Inc.,
21 // 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
24 \brief Config public header */
26 #ifndef HH_SENF_Scheduler_Console_Config_
27 #define HH_SENF_Scheduler_Console_Config_ 1
30 #include <boost/utility.hpp>
33 #include "Executor.hh"
35 //#include "Config.mpp"
37 ///////////////////////////////hh.p////////////////////////////////////////
42 /** \brief Combine multiple configuration sources
44 A ConfigBundle combines several sources and parses them together, in the order they were
45 added. Parse restrictions are applied uniformly to all sources.
47 // Add three configuration sources: A system configuration file, a user configuration file
48 // and command line options
49 senf::console::ConfigBundle conf;
50 conf.add( senf::console::FileConfig("/etc/some.conf") );
51 conf.add( senf::console::FileConfig("local.conf") );
52 conf.add( senf::console::OptionsConfig(senf::Daemon::instance().argc(),
53 senf::Daemon::instance().argv()) );
58 This bundle may also be passed to other code which may use restricted parsing to parse
59 partial information from all configuration sources.
61 \ingroup console_access
66 ///////////////////////////////////////////////////////////////////////////
67 ///\name Structors and default members
71 ConfigBundle(DirectoryNode & root); ///< Set custom root node
74 ///////////////////////////////////////////////////////////////////////////
76 template <class Source>
77 Source & add(boost::intrusive_ptr<Source> source);
78 ///< Add configuration source
80 void parse(); ///< Parse config file
81 /**< All nodes already parsed are skipped */
82 void parse(DirectoryNode & restrict); ///< Parse config file under \a restrict
83 /**< Only nodes which are children of \a restrict are
86 bool complete() const; ///< \c true, if all nodes have been parsed
87 bool parsed(GenericNode & node) const; ///< \c true. if \a node has been parsed
88 void reset(); ///< Reset node parse info state
89 /**< After a call to reset(), all information about already
90 parsed nodes is cleared. Calling parse() will parse the
91 complete config file again. */
98 typedef std::list<detail::ConfigSource::ptr> Sources;
101 detail::RestrictedExecutor executor_;
105 // hrmpf ... Can't place this into Config.ih ...
107 /** \brief Internal: Provide ConfigBundle facade for a single-source config.
109 The BundleMixin is used to define supplementary configuration objects for one specific
110 configuration source. A BundleMixin is \e not a ConfigBundle since it has no public \c add()
117 BundleMixin(DirectoryNode & root);
119 void parse(); ///< Parse config file
120 /**< All nodes already parsed are skipped */
121 void parse(DirectoryNode & restrict); ///< Parse config file under \a restrict
122 /**< Only nodes which are children of \a restrict are
125 bool complete() const; ///< \c true, if all nodes have been parsed
126 bool parsed(GenericNode & node) const; ///< \c true. if \a node has been parsed
127 void reset(); ///< Reset node parse info state
128 /**< After a call to reset(), all information about already
129 parsed nodes is cleared. Calling parse() will parse the
130 complete config file again. */
133 template <class Source>
134 Source & add(boost::intrusive_ptr<Source> source);
137 ConfigBundle bundle_;
142 ///////////////////////////////hh.e////////////////////////////////////////
143 #include "Config.cci"
144 //#include "Config.ct"
145 #include "Config.cti"
152 // comment-column: 40
153 // c-file-style: "senf"
154 // indent-tabs-mode: nil
155 // ispell-local-dictionary: "american"
156 // compile-command: "scons -u test"