Socket: Fix handle.state() on invalid handles

[senf.git] / Utils / Console / Node.hh

diff --git a/Utils/Console/Node.hh b/Utils/Console/Node.hh
index 3e796ec..bfccb7a 100644 (file)
--- a/Utils/Console/Node.hh
+++ b/Utils/Console/Node.hh
@@ -75,7 +75,7 @@
 
         // Add a new directory to the root and document it. All the mutators return the node object
         // itself so operations can be chained.
-        senf::console::DirectoryNode & mydir (
+        senf::console::DirectoryNode & mydir ( senf::console::root()
                 .mkdir("myserver")
                 .doc("My server specific directory"));
 
@@ -223,8 +223,19 @@ namespace console {
     class DirectoryNode;
     class CommandNode;
 
+    /** \brief Get console root node */
     DirectoryNode & root();
 
+    /** \brief Dump console directory structure
+
+        Recursively dumps the console directory structure starting at \a dir. By default, dumps the
+        complete tree beginning at the root node.
+        
+        In contrast to the console 'lr' command, links are dumped by showing the \e absolute path
+        to the target node.
+     */
+    void dump(std::ostream & os, DirectoryNode & dir=root());
+
     /** \brief Config/console node tree base-class
 
         GenericNode is the base class of all node objects. There are two basic node types derived
@@ -278,7 +289,8 @@ namespace console {
 
         bool active() const;            ///< \c true, if node is attached to the root() node
 
-        void help(std::ostream & output) const; /// Write help info to \a output
+        void help(std::ostream & output) const; ///< Write help info to \a output
+        std::string shorthelp() const;  ///< Get short (one-line) documentation
 
         ptr thisptr();                  ///< Get smart pointer to node
         cptr thisptr() const;           ///< Get smart pointer to node (const)
@@ -312,8 +324,12 @@ namespace console {
 #endif
         virtual void v_help(std::ostream & output) const = 0;
                                         ///< Provide help information
-                                        /**< This member must be implemented in derived classes
-                                             to provide node specific help information. */
+                                        /**< This member must be implemented in derived classes to
+                                             provide node specific help information. */
+        virtual std::string v_shorthelp() const = 0;
+                                        ///< Provide short documentation
+                                        /**< This member must be implemented in derived classes to
+                                             provide node specific documentation. */
 
     private:
         std::string name_;
@@ -359,6 +375,7 @@ namespace console {
         explicit LinkNode(GenericNode & node);
 
         virtual void v_help(std::ostream &) const;
+        virtual std::string v_shorthelp() const;
 
         GenericNode::ptr node_;
     };
@@ -556,6 +573,7 @@ namespace console {
         ///////////////////////////////////////////////////////////////////////////
 
         DirectoryNode & doc(std::string const & doc); ///< Set node documentation
+        DirectoryNode & shortdoc(std::string const & doc); ///< Set node short documentation
 
         ptr thisptr();
         cptr thisptr() const;
@@ -566,9 +584,11 @@ namespace console {
     private:
         void add(GenericNode::ptr node);
         virtual void v_help(std::ostream & output) const;
+        virtual std::string v_shorthelp() const;
 
         ChildMap children_;
         std::string doc_;
+        std::string shortdoc_;
 
         friend DirectoryNode & root();
     };
@@ -612,7 +632,7 @@ namespace console {
                                         ///< Execute the command
                                         /**< \param[in] output stream where result messages may be
                                                  written to
-                                             \param[in] arguments command arguments. This is a
+                                             \param[in] command command arguments. This is a
                                                  range of ranges of Token instances. */
 
         void execute(boost::any & rv, std::ostream & output, ParseCommandInfo const & command) 
@@ -621,7 +641,7 @@ namespace console {
                                         /**< \param[out] rv command return value
                                              \param[in] output stream where result messages may be
                                                  written to
-                                             \param[in] arguments command arguments. This is a
+                                             \param[in] command command arguments. This is a
                                                  range of ranges of Token instances. */
 
         void operator()(std::ostream & output, ParseCommandInfo const & command) const;
@@ -629,7 +649,7 @@ namespace console {
                                         /**< Same as execute()
                                              \param[in] output stream where result messages may be
                                                  written to
-                                             \param[in] arguments command arguments. This is a
+                                             \param[in] command command arguments. This is a
                                                  range of ranges of Token instances. */
         void operator()(boost::any & rv, std::ostream & output, ParseCommandInfo const & command)
             const;
@@ -647,7 +667,9 @@ namespace console {
             const = 0;
                                         ///< Called to execute the command
                                         /**< \param[out] rv return value holder
-                                             \param[in] arguments command arguments. This is a
+                                              \param[in] os stream where result messages may be
+                                                 written to
+                                             \param[in] command command arguments. This is a
                                                  range of ranges of Token instances. */
 
     private:
@@ -694,18 +716,21 @@ namespace console {
         cptr thisptr() const;
 
         SimpleCommandNode & doc(std::string const & doc);
+        SimpleCommandNode & shortdoc(std::string const & doc);
 
     protected:
         SimpleCommandNode(Function const & fn);
 
     private:
         virtual void v_help(std::ostream & output) const;
+        virtual std::string v_shorthelp() const;
         virtual void v_execute(boost::any & rv, std::ostream & os, ParseCommandInfo const & command)
             const;
 
 
         Function fn_;
         std::string doc_;
+        std::string shortdoc_;
     };
 
 #ifndef DOXYGEN