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

Timestamp:

Sep 18, 2005, 1:37:58 PM (19 years ago)

Author:

bensch

Message:

orxonox/trunk: Shell now has a real nice help function

Location:

trunk/src/lib/shell

Files:

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

trunk/src/lib/shell/shell.cc

@@ -40 +40 @@
 SHELL_COMMAND(deactivate, Shell, deactivate)
     ->describe("Deactivates the Shell. (moves it into background)")
-    ->setAlias("deactivate");
-
+    ->setAlias("hide");
 
 /**

trunk/src/lib/shell/shell.h

@@ -2 +2 @@
  * @file shell.h
  * Definition of a on-screen-shell
-*/
+ *
+ * @todo check for smooth deletion process
+ */
 
 #ifndef _SHELL_H

trunk/src/lib/shell/shell_command.cc

@@ -212 +212 @@
     ShellCommandClass::commandClassList = new tList<ShellCommandClass>;
     ShellCommand<ShellCommandBase>::registerCommand("debug", "ShellCommand", &ShellCommandBase::debugDyn);
+  }
+}
+
+void ShellCommandClass::help(const char* className)
+{
+  if (className == NULL)
+    return;
+  if (likely(ShellCommandClass::commandClassList != NULL))
+  {
+    tIterator<ShellCommandClass>* itCL = ShellCommandClass::commandClassList->getIterator();
+    ShellCommandClass* elemCL = itCL->firstElement();
+    while(elemCL != NULL)
+    {
+      if (elemCL->className && !strcasecmp(className, elemCL->className))
+      {
+        PRINT(0)("Class:'%s' registered %d commands: \n", elemCL->className, elemCL->commandList->getSize());
+        tIterator<ShellCommandBase>* iterator = elemCL->commandList->getIterator();
+        const ShellCommandBase* elem = iterator->firstElement();
+        while(elem != NULL)
+        {
+          PRINT(0)("  command:'%s' : params:%d: ", elem->getName(), elem->paramCount);
+          for (unsigned int i = 0; i< elem->paramCount; i++)
+            PRINT(0)("%s ", ShellCommandBase::paramToString(elem->parameters[i]));
+          if (elem->description != NULL)
+            PRINT(0)("- %s", elem->description);
+          PRINT(0)("\n");
+          elem = iterator->nextElement();
+        }
+        delete iterator;
+
+        delete itCL;
+        return;
+      }
+      elemCL = itCL->nextElement();
+    }
+    delete itCL;
+    PRINTF(3)("Class %s not found in Command's classes\n", className);
+  }
+  else
+  {
+    PRINTF(1)("List of commandClasses does not exist");
   }
 }
@@ -413 +454 @@
           if (objectList != NULL)
           {
-            elemAL->getCommand()->executeCommand(objectList->firstElement(), executionString+inputSplits.getOffset(1));
+            if (inputSplits.getCount() > 1)
+              elemAL->getCommand()->executeCommand(objectList->firstElement(), executionString+inputSplits.getOffset(1));
+            else
+              elemAL->getCommand()->executeCommand(objectList->firstElement(), "");
             delete itAL;
             return true;
@@ -441 +485 @@
       delete itCL;
     }
-
 
     if (classID != CL_NULL && inputSplits.getCount() >= 2 && objectList != NULL)
@@ -484 +527 @@
         }
         delete itCMD;
-
-      }
-
-    }
-
-
-  }
-
+      }
+    }
+  }
 }
 

trunk/src/lib/shell/shell_command.h

@@ -2 +2 @@
  * @file shell_command.h
  * Definition of a on-screen-shell
+ * @todo simple way to supply Default Values with the macro.
 */
 
@@ -59 +60 @@
     static void unregisterAllCommands();
 
+    static void help (const char* className);
+
   private:
     ShellCommandClass(const char* className);
@@ -310 +313 @@
     {
 //      if (parameters != NULL)
-      SubString sub(parameters);
+      SubString sub(parameters, true);
 //! FUNCTOR_LIST is the List of Executive Functions
 #define FUNCTOR_LIST(x) ShellCommandExecute ## x

trunk/src/lib/shell/shell_input.cc

@@ -177 +177 @@
  * prints out some nice help about the Shell
  */
-void ShellInput::help()
-{
-  PRINT(0)("Help for the most important Shell-commands\n");
-  PRINT(0)("F1 - HELP; F2 - DEBUG; ` - open/close shell\n");
-  PRINT(0)("input order:\n");
-  PRINT(0)("ClassName [objectName] function [parameter1, [parameter2 ...]]  or\n");
-  PRINT(0)("Alias [parameter]\n");
+void ShellInput::help(const char* className, const char* functionName)
+{
+  if (strlen(className) == 0)
+  {
+    PRINT(0)("Help for the most important Shell-commands\n");
+    PRINT(0)("F1 - HELP; F2 - DEBUG; ` - open/close shell\n");
+    PRINT(0)("input order:\n");
+    PRINT(0)("ClassName [objectName] function [parameter1, [parameter2 ...]]  or\n");
+    PRINT(0)("Alias [parameter]\n");
+    PRINT(0)("- Also try 'help className'");
+  }
+  else if (strlen (className) > 0 && strlen (functionName) == 0)
+  {
+    ShellCommandClass::help(className);
+    //PRINTF(1)("%s::%s\n", className, functionName);
+  }
 }
 

trunk/src/lib/shell/shell_input.h

@@ -32 +32 @@
   void setRepeatDelay(float repeatDelay, float repeatRate);
   bool executeCommand();
-  void help();
+  void help(const char* className = "", const char* function = "");
 
   virtual void tick(float dt);