Console/Executor.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2008
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   6 //     Stefan Bund <g0dil@berlios.de>
   7 //
   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.
  12 //
  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.
  17 //
  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.
  22
  23 /** \file
  24     \brief Executor public header */
  25
  26 #ifndef HH_Executor_
  27 #define HH_Executor_ 1
  28
  29 // Custom includes
  30 #include <boost/utility.hpp>
  31 #include "Parse.hh"
  32 #include "../Utils/Logger/SenfLog.hh"
  33 #include "Node.hh"
  34
  35 //#include "Executor.mpp"
  36 ///////////////////////////////hh.p////////////////////////////////////////
  37
  38 namespace senf {
  39 namespace console {
  40
  41     /** \brief Execute config/console commands
  42
  43         The Executor interprets parsed config/console commands and executes them. It manages the
  44         current execution context (current directory, directory stack and so on).
  45
  46         The executor is normally called directly by the parser callback for each command.
  47
  48         Executing the built-in 'exit' command will throw Executor::ExitException. This exception
  49         (which is not derived from std::exception since it's not a real exception) must be handled
  50         by the caller.
  51
  52         All directories are managed using weak pointers. If any of the directories expires (current
  53         directory, directory stack, last directory) it will be replaced with the root
  54         directory. Directories expire when they are destructed or when they are detached from the
  55         config tree root node.
  56       */
  57     class Executor
  58         : boost::noncopyable
  59     {
  60         SENF_LOG_CLASS_AREA();
  61         SENF_LOG_DEFAULT_LEVEL( senf::log::VERBOSE );
  62     public:
  63         ///////////////////////////////////////////////////////////////////////////
  64         // Types
  65
  66         /// Thrown by built-in 'exit' command
  67         struct ExitException {};
  68
  69         ///////////////////////////////////////////////////////////////////////////
  70         //\/name Structors and default members
  71         ///\{
  72
  73         Executor();
  74
  75         ///\}
  76         ///////////////////////////////////////////////////////////////////////////
  77
  78         void execute(std::ostream & output, ParseCommandInfo const & command);
  79                                         ///< Execute command
  80                                         /**< Output will be written to \a output.
  81                                              Same as operator()(). */
  82
  83         void operator()(std::ostream & output, ParseCommandInfo const & command);
  84                                         ///< Execute command
  85                                         /**< Output will be written to \a output.
  86                                              Same as execute(). */
  87         DirectoryNode & cwd() const;    ///< Current working directory
  88
  89         bool autocd() const;            ///< Get current autocd status
  90                                         /**< if autocd is enabled, specifying a directory name as
  91                                              command will cd to that directory. Disabled by
  92                                              default (but enabled automatically by the interactive
  93                                              console). */
  94         Executor & autocd(bool v);      ///< Set autocd status
  95                                         /**< \see autocd() */
  96
  97         bool autocomplete() const;      ///< Get current autocomplete status
  98                                         /**< if autocomplete is enabled, path components which can
  99                                              be uniquely completed will be completed
 100                                              automatically. Disabled by default (but enabled
 101                                              automatically by the interactive console) void
 102                                              autocomplete(bool v). */
 103
 104         Executor & autocomplete(bool v); ///< Set autocomplete status
 105                                         /**< \see autocomplete() */
 106
 107     protected:
 108
 109     private:
 110         GenericNode & traverseNode(ParseCommandInfo::argument_value_type const & path);
 111         GenericNode & traverseCommand(ParseCommandInfo::CommandPathRange const & path);
 112         DirectoryNode & traverseDirectory(ParseCommandInfo::argument_value_type const & path);
 113
 114         struct InvalidPathException {};
 115         struct InvalidDirectoryException {};
 116         struct InvalidCommandException {};
 117
 118         DirectoryNode::weak_ptr cwd_;
 119         DirectoryNode::weak_ptr oldCwd_;
 120         typedef std::vector<DirectoryNode::weak_ptr> DirStack;
 121         DirStack dirstack_;
 122
 123         bool autocd_;
 124         bool autocomplete_;
 125     };
 126
 127
 128 }}
 129
 130 ///////////////////////////////hh.e////////////////////////////////////////
 131 #include "Executor.cci"
 132 //#include "Executor.ct"
 133 //#include "Executor.cti"
 134 #endif
 135
 136 \f
 137 // Local Variables:
 138 // mode: c++
 139 // fill-column: 100
 140 // comment-column: 40
 141 // c-file-style: "senf"
 142 // indent-tabs-mode: nil
 143 // ispell-local-dictionary: "american"
 144 // compile-command: "scons -u test"
 145 // End: