Changeset 5164 in orxonox.OLD for trunk/src/lib/shell

Timestamp:

Sep 5, 2005, 11:02:09 PM (19 years ago)

Author:

bensch

Message:

orxonox/trunk: ability to describe the presented options

Location:

trunk/src/lib/shell

Files:

• shell.cc (modified) (1 diff)
• shell_command.cc (modified) (3 diffs)
• shell_command.h (modified) (3 diffs)

trunk/src/lib/shell/shell.cc

@@ -32 +32 @@
 using namespace std;
 
-SHELL_COMMAND(clear, Shell, clear);
+SHELL_COMMAND(clear, Shell, clear)->describe("Clears the shell from unwanted lines (empties all buffers)");
 
 /**

trunk/src/lib/shell/shell_command.cc

@@ -32 +32 @@
   this->setClassID(CL_SHELL_COMMAND, "ShellCommand");
   this->setName(commandName);
+  this->description = NULL;
 
 //  this->classID = classID;
@@ -217 +218 @@
 }
 
+
+ShellCommandBase* ShellCommandBase::describe(const char* description)
+{
+  if (this == NULL)
+    return NULL;
+
+  this->description = description;
+  return this;
+}
+
+
 void ShellCommandBase::debugDyn()
 {
@@ -236 +248 @@
     PRINT(0)("Class %s registered command %s with %d parameters: ", elem->className, elem->getName(), elem->paramCount);
     for (unsigned int i = 0; i< elem->paramCount; i++)
-      printf(ShellCommandBase::paramToString(elem->parameters[i]));
+      printf("%s ", ShellCommandBase::paramToString(elem->parameters[i]));
+    if (elem->description != NULL)
+      printf("- %s", elem->description);
     printf("\n");
 

trunk/src/lib/shell/shell_command.h

@@ -23 +23 @@
 
 #define SHELL_COMMAND(command, class, function) \
-        ShellCommand<class>* shell_command_##class##_##command = ShellCommand<class>::registerCommand(#command, #class, &class::function)
+        ShellCommandBase* shell_command_##class##_##command = ShellCommand<class>::registerCommand(#command, #class, &class::function)
 
 
@@ -35 +35 @@
     static bool execute (const char* executionString);
 
+    ShellCommandBase* describe(const char* description);
+
     static const tList<ShellCommandBase>* getCommandList() { return ShellCommandBase::commandList; };
 
@@ -65 +67 @@
 //    long                             classID;             //!< The ID of the Class associated to this Command
     const char*                      className;                            //!< The Name of the Class associated to this Command
+
+    const char*                      description;
 
     // STATIC MEMBERS