Changeset 2598 in Sophya for trunk/SophyaLib/SysTools/commander.cc

Timestamp:

Aug 11, 2004, 3:10:25 PM (21 years ago)

Author:

ansari

Message:

Documentation (ajoutee ou completee) pour les classes du module SysTools - Reza 11 Aout 2004

File:

• trunk/SophyaLib/SysTools/commander.cc (modified) (13 diffs)

trunk/SophyaLib/SysTools/commander.cc

@@ -25 +25 @@
 // ------------------------------------------------------------
 /*!
+  \internal
   \class SOPHYA::CommanderBloc
   \ingroup SysTools 
-  Class for internal use by SOPHYA::Commander to handle loops
+  Class for internal use by class Commander to handle loops
 */
 class CommanderBloc {
@@ -253 +254 @@
 
 /*!
+  \internal 
   \class SOPHYA::CommanderScript
   \ingroup SysTools 
-  Class for internal use by SOPHYA::Commander to handle functions
+  Class for internal use by class Commander to handle functions
   or scripts
 */
@@ -334 +336 @@
 
 /*!
-  \class SOPHYA::Commander
+  \class Commander
   \ingroup SysTools
-  Simple command interpreter with c-shell like syntax and dynamic 
-  load capabilities. Can be used to add scripting capabilities
-  to applications
+  \brief Simple command interpreter
+
+  This Simple command interpreter with c-shell like syntax 
+  can be used to add scripting capabilities
+  to applications. 
+
+  Although the insterpreter has many limitations compared to 
+  c-shell, or Tcl , it provides some interesting possibilities:
+
+  - Extended arithmetic operations (c-like and RPN)
+  - Simple and vector variables
+  - Script definition 
+  - Dynamic Load 
+
+  \sa CmdExecutor CExpressionEvaluator RPNExpressionEvaluator
+
+  Usage example:
+  \code
+  #include "commander.h"
+  ...
+  Commander cmd;
+  char* ss[3] = {"foreach f ( AA bbb CCCC ddddd )", "echo $f" , "end"};
+  for(int k=0; k<3; k++) {
+    string line = ss[k];
+    cmd.Interpret(line);
+  }
+  \endcode
 */
 
@@ -345 +371 @@
 static Commander* cur_commander = NULL;
 /* --Methode-- */
+//! Default constructor. Initializes variable list and copies \c history.pic to \c hisold.pic
 Commander::Commander()
 {
@@ -488 +515 @@
 
 /* --Methode-- */
+//! Returns the string \c Commander as the interpreter's name.
 string Commander::Name()
 {
@@ -494 +522 @@
 
 /* --Methode-- */
+//! Add the \b grp help group with description \b desc. 
 void Commander::AddHelpGroup(string& grp, string& desc)
 {
@@ -501 +530 @@
 
 /* --Methode-- */
+/*! 
+  \brief Register a command executor associated with a given keyword.
+  \param keyw : keyword identifying the command
+  \param usage : the command help and usage information
+  \param ce : CmdExecutor pointer for this a command. The same object can be registered
+  multiple time for different commands.
+  \param grp : The help group corresponding to this command.
+*/
 void Commander::RegisterCommand(string& keyw, string& usage, CmdExecutor * ce, string& grp)
 {
@@ -517 +554 @@
 
 /* --Methode-- */
+/*! 
+  \brief Register a help text.
+  \param keyw : help keyword
+  \param usage : help text
+  \param grp : help group
+*/
 void Commander::RegisterHelp(string& keyw, string& usage, string& grp)
 {
@@ -548 +591 @@
 
 /* --Methode-- */
+/*!
+  \brief  Dynamic loader for modules
+
+  A module is a shared library extending the application functionalities.
+  Typically, a module adds new commands to the interpreter. Once loaded,
+  the module is activated (initialized) by calling a function with the 
+  name \b modulename_init . This function should be declared extern C
+  to avoid C++ name mangling. A cleanup function \b modulename_end
+  is called by the Commander destructor.
+
+  \param fnameso : Shared library name containing the module functions
+  and classes.
+  \param name : Module name. This string is used to form module 
+  initializer and cleanup function name \c name_init \c name_end
+*/
 void Commander::LoadModule(string& fnameso, string& name)
 {
@@ -569 +627 @@
 
 /* --Methode-- */
+//! Declare a new interpreter
 void Commander::AddInterpreter(CmdInterpreter * cl)
 {
@@ -575 +634 @@
 
 /* --Methode-- */
+//! Select an interpreter by its name. The corresponding Interpret method is then called
 void Commander::SelInterpreter(string& name)
 {
@@ -594 +654 @@
 
 /* --Methode-- */
+/*!
+  \brief Method which has to be invoked to interpret a giev command line or string.
+*/
 int Commander::Interpret(string& s)
 {
@@ -1894 +1957 @@
 
 /* --Methode-- */
+//! Produces a LaTeX file containing the registered command helps
 void Commander::HelptoLaTeX(string const & fname)
 {