Console: Add console logging documentation

[senf.git] / Console / Executor.hh

diff --git a/Console/Executor.hh b/Console/Executor.hh
index 7be8db3..92a2dfe 100644 (file)
--- a/Console/Executor.hh
+++ b/Console/Executor.hh
@@ -27,8 +27,10 @@
 #define HH_Executor_ 1
 
 // Custom includes
+#include <boost/utility.hpp>
 #include "Parse.hh"
 #include "../Utils/Logger/SenfLog.hh"
+#include "Node.hh"
 
 //#include "Executor.mpp"
 ///////////////////////////////hh.p////////////////////////////////////////
@@ -36,33 +38,97 @@
 namespace senf {
 namespace console {
 
-    /** \brief
+    /** \brief Execute config/console commands
+
+        The Executor interprets parsed config/console commands and executes them. It manages the
+        current execution context (current directory, directory stack and so on).
+
+        The executor is normally called directly by the parser callback for each command.
+
+        Executing the built-in 'exit' command will throw Executor::ExitException. This exception
+        (which is not derived from std::exception since it's not a real exception) must be handled
+        by the caller.
+
+        All directories are managed using weak pointers. If any of the directories expires (current
+        directory, directory stack, last directory) it will be replaced with the root
+        directory. Directories expire when they are destructed or when they are detached from the
+        config tree root node.
       */
     class Executor
+        : boost::noncopyable
     {
         SENF_LOG_CLASS_AREA();
-        SENF_LOG_DEFAULT_LEVEL( senf::log::NOTICE );
+        SENF_LOG_DEFAULT_LEVEL( senf::log::VERBOSE );
     public:
         ///////////////////////////////////////////////////////////////////////////
         // Types
 
-        typedef boost::iterator_range< ParseCommandInfo::argument_iterator> Arguments;
+        /// Thrown by built-in 'exit' command
+        struct ExitException {};        
 
         ///////////////////////////////////////////////////////////////////////////
+        //\/name Structors and default members
+        ///\{
         
-        bool operator()(ParseCommandInfo const & command, std::ostream & output);
-    
+        Executor();
+
+        ///\}
+        ///////////////////////////////////////////////////////////////////////////
+
+        void execute(std::ostream & output, ParseCommandInfo const & command);
+                                        ///< Execute command
+                                        /**< Output will be written to \a output. 
+                                             Same as operator()(). */
+
+        void operator()(std::ostream & output, ParseCommandInfo const & command);
+                                        ///< Execute command
+                                        /**< Output will be written to \a output. 
+                                             Same as execute(). */
+        DirectoryNode & cwd() const;    ///< Current working directory
+
+        bool autocd() const;            ///< Get current autocd status
+                                        /**< if autocd is enabled, specifying a directory name as
+                                             command will cd to that directory. Disabled by
+                                             default (but enabled automatically by the interactive
+                                             console). */
+        Executor & autocd(bool v);      ///< Set autocd status
+                                        /**< \see autocd() */
+
+        bool autocomplete() const;      ///< Get current autocomplete status
+                                        /**< if autocomplete is enabled, path components which can
+                                             be uniquely completed will be completed
+                                             automatically. Disabled by default (but enabled
+                                             automatically by the interactive console) void
+                                             autocomplete(bool v). */
+
+        Executor & autocomplete(bool v); ///< Set autocomplete status
+                                        /**< \see autocomplete() */
+
     protected:
 
     private:
+        GenericNode & traverseNode(ParseCommandInfo::argument_value_type const & path);
+        GenericNode & traverseCommand(ParseCommandInfo::CommandPathRange const & path); 
+        DirectoryNode & traverseDirectory(ParseCommandInfo::argument_value_type const & path);
+
+        struct InvalidPathException {};
+        struct InvalidDirectoryException {};
+        struct InvalidCommandException {};
+
+        DirectoryNode::weak_ptr cwd_;
+        DirectoryNode::weak_ptr oldCwd_;
+        typedef std::vector<DirectoryNode::weak_ptr> DirStack;
+        DirStack dirstack_;
 
+        bool autocd_;
+        bool autocomplete_;
     };
 
 
 }}
 
 ///////////////////////////////hh.e////////////////////////////////////////
-//#include "Executor.cci"
+#include "Executor.cci"
 //#include "Executor.ct"
 //#include "Executor.cti"
 #endif