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 ConfigFile public header */
26 #ifndef HH_ConfigFile_
27 #define HH_ConfigFile_ 1
32 //#include "ConfigFile.mpp"
33 #include "ConfigFile.ih"
34 ///////////////////////////////hh.p////////////////////////////////////////
39 /** \brief Console node tree based config file parser
41 A ConfigFile instance allows flexible parsing of a config file against the console node
42 tree. If you just want to parse a file completely, the senf::console::readConfig() function
43 will do that. ConfigFile however allows to incrementally parse only a subdirectory of the
44 complete configuration file.
46 senf::console::ConfigFile cf ("/my/config/file")
48 // Parse only statements under the directory of some object. The object 'ob'
49 // must have been registered somewhere in the node tree
52 // Parse rest of the config file
57 : public detail::BundleMixin
60 ///////////////////////////////////////////////////////////////////////////
61 ///\name Structors and default members
64 explicit ConfigFile(std::string const & filename, DirectoryNode & root = root());
65 ///< Create ConfigFile object for \a filename
66 /**< The \a filename configuration file will be parsed using
67 parse() calls. All configuration statements will be
68 interpreted relative to \a root as root node. */
71 ///////////////////////////////////////////////////////////////////////////
74 /** \brief Read configuration file
76 The configuration file \a filename will be loaded, interpreting all node's relative to \a
79 This function uses a local ConfigFile object to perform the parsing.
83 void readConfig(std::string const & filename, DirectoryNode & root = root());
85 detail::ConfigFileSource::ptr FileConfig(std::string const & filename);
89 ///////////////////////////////hh.e////////////////////////////////////////
90 #include "ConfigFile.cci"
91 //#include "ConfigFile.ct"
92 //#include "ConfigFile.cti"
100 // c-file-style: "senf"
101 // indent-tabs-mode: nil
102 // ispell-local-dictionary: "american"
103 // compile-command: "scons -u test"