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 internal header */
26 #ifndef IH_Console_Config_
27 #define IH_Console_Config_ 1
30 #include <boost/utility.hpp>
31 #include <boost/intrusive_ptr.hpp>
32 #include "Executor.hh"
33 #include "../Utils/intrusive_refcount.hh"
35 ///////////////////////////////ih.p////////////////////////////////////////
41 /** \brief Internal: Executor wrapper implementing restricted execution
43 A RestrictedExecutor will only process commands which a re children of a given node. It does
44 \e not follow any links.
46 class RestrictedExecutor
50 typedef void result_type;
52 ///////////////////////////////////////////////////////////////////////////
53 //\/name Structors and default members
56 RestrictedExecutor(DirectoryNode & root = senf::console::root());
59 ///////////////////////////////////////////////////////////////////////////
61 void execute(std::ostream & output, ParseCommandInfo const & command);
63 /**< Output will be written to \a output.
64 Same as operator()(). */
66 void operator()(std::ostream & output, ParseCommandInfo const & command);
68 /**< Output will be written to \a output.
71 bool complete() const; ///< \c true, if all nodes have been parsed
72 bool parsed(GenericNode & node) const; ///< \c true. if \a node has been parsed
73 void reset(); ///< Reset node parse info state
74 /**< After a call to reset(), all information about already
75 parsed nodes is cleared. Calling parse() will parse the
76 complete config file again. */
78 DirectoryNode & root() const;
85 void policyCallback(DirectoryNode & dir, std::string const & item);
86 void insertParsedNode(DirectoryNode & node);
88 typedef std::vector<DirectoryNode::weak_ptr> ParsedNodes;
91 ParsedNodes parsedNodes_;
92 DirectoryNode::ptr restrict_;
94 friend class RestrictGuard;
97 /** \brief Internal: Set restricted node of a RestrictedExecutor
99 A RestrictGuard will set the node to which to restrict. It will automatically reset the node
102 class RestrictedExecutor::RestrictGuard
105 ///////////////////////////////////////////////////////////////////////////
106 //\/name Structors and default members
109 explicit RestrictGuard(RestrictedExecutor & executor);
110 RestrictGuard(RestrictedExecutor & executor, DirectoryNode & restrict);
114 ///////////////////////////////////////////////////////////////////////////
119 RestrictedExecutor & executor_;
123 /** \brief Internal: ConfigSource base class
125 All configuration sources derive from ConfigSource. A ConigSource somehow reads
126 configuration commands and passes them to a RestrictedExecutor.
129 : public senf::intrusive_refcount
132 typedef boost::intrusive_ptr<ConfigSource> ptr;
133 virtual ~ConfigSource();
135 void parse(RestrictedExecutor & executor);
140 virtual void v_parse(RestrictedExecutor & executor) = 0;
145 ///////////////////////////////ih.e////////////////////////////////////////
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"