X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=senf%2FUtils%2FConsole%2FConfig.hh;fp=senf%2FUtils%2FConsole%2FConfig.hh;h=412c61aaa51c8d4a5e714334aac144a5e847e02f;hb=601d1f509f5bb24df167a4dd5a20da67a0af9af8;hp=0000000000000000000000000000000000000000;hpb=164fe477094d42463722584e527a02379ab5d985;p=senf.git diff --git a/senf/Utils/Console/Config.hh b/senf/Utils/Console/Config.hh new file mode 100644 index 0000000..412c61a --- /dev/null +++ b/senf/Utils/Console/Config.hh @@ -0,0 +1,160 @@ +// $Id$ +// +// Copyright (C) 2008 +// Fraunhofer Institute for Open Communication Systems (FOKUS) +// Competence Center NETwork research (NET), St. Augustin, GERMANY +// Stefan Bund +// +// This program is free software; you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation; either version 2 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program; if not, write to the +// Free Software Foundation, Inc., +// 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + +/** \file + \brief Config public header */ + +#ifndef HH_SENF_Scheduler_Console_Config_ +#define HH_SENF_Scheduler_Console_Config_ 1 + +// Custom includes +#include +#include +#include "Parse.hh" +#include "Executor.hh" + +//#include "Config.mpp" +#include "Config.ih" +///////////////////////////////hh.p//////////////////////////////////////// + +namespace senf { +namespace console { + + /** \brief Combine multiple configuration sources + + A ConfigBundle combines several sources and parses them together, in the order they were + added. Parse restrictions are applied uniformly to all sources. + \code + // Add three configuration sources: A system configuration file, a user configuration file + // and command line options + senf::console::ConfigBundle conf; + conf.add( senf::console::FileConfig("/etc/some.conf") ); + conf.add( senf::console::FileConfig("local.conf") ); + conf.add( senf::console::OptionsConfig(senf::Daemon::instance().argc(), + senf::Daemon::instance().argv()) ); + + conf.parse(); + \endcode + + This bundle may also be passed to other code which may use restricted parsing to parse + partial information from all configuration sources. + + \ingroup console_access + */ + class ConfigBundle + { + public: + /////////////////////////////////////////////////////////////////////////// + ///\name Structors and default members + ///@{ + + ConfigBundle(); ///< root node is set to console::root() + ConfigBundle(DirectoryNode & root); ///< Set custom root node + + ///@} + /////////////////////////////////////////////////////////////////////////// + + template + Source & add(boost::intrusive_ptr source); + ///< Add configuration source + + void parse(); ///< Parse config bundle + /**< All nodes already parsed are skipped */ + void parse(DirectoryNode & restrict); ///< Parse config bundle under \a restrict + /**< Only nodes which are children of \a restrict are + parsed. */ + + bool complete() const; ///< \c true, if all nodes have been parsed + bool parsed(GenericNode & node) const; ///< \c true. if \a node has been parsed + void reset(); ///< Reset node parse info state + /**< After a call to reset(), all information about already + parsed nodes is cleared. Calling parse() will parse the + complete config bundle again. */ + + DirectoryNode & root() const; + void chroot(DirectoryNode & node); + + protected: + + private: + void parseInternal(); + + typedef std::list Sources; + + Sources sources_; + detail::RestrictedExecutor executor_; + }; + +namespace detail { + // hrmpf ... Can't place this into Config.ih ... + + /** \brief Internal: Provide ConfigBundle facade for a single-source config. + + The BundleMixin is used to define supplementary configuration objects for one specific + configuration source. A BundleMixin is \e not a ConfigBundle since it has no public \c add() + member. + */ + class BundleMixin + { + public: + BundleMixin(); + BundleMixin(DirectoryNode & root); + + void parse(); ///< Parse config file + /**< All nodes already parsed are skipped */ + void parse(DirectoryNode & restrict); ///< Parse config file under \a restrict + /**< Only nodes which are children of \a restrict are + parsed. */ + + bool complete() const; ///< \c true, if all nodes have been parsed + bool parsed(GenericNode & node) const; ///< \c true. if \a node has been parsed + void reset(); ///< Reset node parse info state + /**< After a call to reset(), all information about already + parsed nodes is cleared. Calling parse() will parse the + complete config file again. */ + + protected: + template + Source & add(boost::intrusive_ptr source); + + private: + ConfigBundle bundle_; + }; + +}}} + +///////////////////////////////hh.e//////////////////////////////////////// +#include "Config.cci" +//#include "Config.ct" +#include "Config.cti" +#endif + + +// Local Variables: +// mode: c++ +// fill-column: 100 +// comment-column: 40 +// c-file-style: "senf" +// indent-tabs-mode: nil +// ispell-local-dictionary: "american" +// compile-command: "scons -u test" +// End: