Changeset 7374 in orxonox.OLD for trunk/src/lib/shell/shell_completion.h

Timestamp:

Apr 26, 2006, 3:28:55 AM (18 years ago)

Author:

bensch

Message:

orxonox/trunk: added new Files shell_completion_plugin for the new Plugin Structure.
Also created the first namespace: OrxShell

File:

• trunk/src/lib/shell/shell_completion.h (modified) (1 diff)

trunk/src/lib/shell/shell_completion.h

@@ -16 +16 @@
 // FORWARD DECLARATION
 class BaseObject;
-class ShellInput;
-#ifndef NULL
-#define NULL 0            //!< a pointer to NULL
-#endif
+
+namespace OrxShell
+{
+  //! A class for Completing the an InputString.
+  class ShellCompletion
+  {
+    //! an enumerator for different types the Shell can complete.
+    typedef enum {
+      NullCompletion         = 0,
+      ClassCompletion        = 1,
+      ObjectCompletion       = 2,
+      FunctionCompletion     = 4,
+      AliasCompletion        = 8,
+    } CompletionType;
+
+    //! A struct for ShellElements (these are used as containers to identify an Input for what it is)
+    struct CompletionElement
+    {
+      std::string     name;     //!< the Name of the Element to be completed.
+      CompletionType  type;     //!< the type of the Element
+    };
+
+  public:
+    ShellCompletion();
+    virtual ~ShellCompletion();
 
 
-//! A class for Completing the an InputString.
-class ShellCompletion
-{
+    // Functions to produce the Complete Lists.
+    bool autoComplete(std::string& input);
+    bool classComplete(const std::string& classBegin);
+    //  long classMatch(const char* input, unsigned int* length);
+    bool objectComplete(const std::string& objectBegin, long classID);
+    //  bool objectMatch(const char* objectBegin, long classID, unsigned int* length);
+    bool functionComplete(const std::string& functionBegin, const std::string& className);
+    //  bool functionMatch(const char* functionBegin, long classID, unsigned int* length);
+    bool aliasComplete(const std::string& aliasBegin);
 
-  //! an enumerator for different types the Shell can complete.
-  typedef enum {
-    NullCompletion         = 0,
-    ClassCompletion        = 1,
-    ObjectCompletion       = 2,
-    FunctionCompletion     = 4,
-    AliasCompletion        = 8,
-  } CompletionType;
+    bool generalComplete(std::string& input,
+                         const std::string& begin, const std::string& displayAs = "%s",
+                         const std::string& addBack = "", const std::string& addFront = "");
 
-  //! A struct for ShellElements (these are used as containers to identify an Input for what it is)
-  struct CompletionElement
-  {
-    std::string     name;     //!< the Name of the Element to be completed.
-    CompletionType type;     //!< the type of the Element
+
+    bool addToCompleteList(const std::list<std::string>& inputList, const std::string& completionBegin, ShellCompletion::CompletionType type);
+    bool addToCompleteList(const std::list<BaseObject*>& inputList, const std::string& completionBegin, ShellCompletion::CompletionType type);
+    void clearCompletionList();
+
+
+    // Helpers.
+    static const std::string& ShellCompletion::typeToString(ShellCompletion::CompletionType type);
+
+  private:
+    std::vector<CompletionElement>  completionList;          //!< A list of completions, that are io.
+
+    static const std::string        typeNames[];             //!< A list of Completion-Type-Names.
   };
 
-public:
-  ShellCompletion();
-  virtual ~ShellCompletion();
-
-
-  // Functions to produce the Complete Lists.
-  bool autoComplete(std::string& input);
-  bool classComplete(const std::string& classBegin);
-  //  long classMatch(const char* input, unsigned int* length);
-  bool objectComplete(const std::string& objectBegin, long classID);
-  //  bool objectMatch(const char* objectBegin, long classID, unsigned int* length);
-  bool functionComplete(const std::string& functionBegin, const std::string& className);
-  //  bool functionMatch(const char* functionBegin, long classID, unsigned int* length);
-  bool aliasComplete(const std::string& aliasBegin);
-
-  bool generalComplete(std::string& input,
-                       const std::string& begin, const std::string& displayAs = "%s",
-                       const std::string& addBack = "", const std::string& addFront = "");
-
-
-  bool addToCompleteList(const std::list<std::string>& inputList, const std::string& completionBegin, ShellCompletion::CompletionType type);
-  bool addToCompleteList(const std::list<BaseObject*>& inputList, const std::string& completionBegin, ShellCompletion::CompletionType type);
-  void clearCompletionList();
-
-
-  // Helpers.
-  static const std::string& ShellCompletion::typeToString(ShellCompletion::CompletionType type);
-
-private:
-  std::vector<CompletionElement>  completionList;          //!< A list of completions, that are io.
-
-  static const std::string        typeNames[];             //!< A list of Completion-Type-Names.
-};
+}
 
 #endif /* _SHELL_COMPLETION_H */