Homepage Demos Overview Downloads Tutorials Reference
Credits

HelpControl.cc

Go to the documentation of this file.
00001 #include "HelpControl.h"
00002 
00003 //#define HelpControl_HTML_
00004 
00005 ControlBase * HelpControl::activate(MotionManager::MC_ID disp_id, Socket * gui) {
00006   char * fmt="  * ";
00007   if(config->main.use_VT100) {
00008     fmt="\33[1m  * \33[0m";
00009     sout->printf("%s","\33[1m* Global commands\33[0m: type these anytime, interpreted directly by Controller\n");
00010   } else
00011     sout->printf("%s","* Global commands: type these anytime, interpreted directly by Controller\n");
00012   sout->printf("%s%s",fmt,"'!refresh' - redisplays the current control (handy on first connecting, or\n     when other output has scrolled it off the screen)\n");
00013   sout->printf("%s%s",fmt,"'!reset' - return to the root control\n");
00014   sout->printf("%s%s",fmt,"'!next' - calls doNextItem() of the current control\n");
00015   sout->printf("%s%s",fmt,"'!prev' - calls doPrevItem() of the current control\n");
00016   sout->printf("%s%s",fmt,"'!select' - calls doSelect() of the current control\n");
00017   sout->printf("%s%s",fmt,"'!cancel' - calls doCancel() of the current control\n");
00018   sout->printf("%s%s",fmt,"'!msg text' - broadcasts text as a TextMsgEvent\n");
00019   sout->printf("%s%s",fmt,"'!hilight [n1 [n2 [...]]]' - hilights zero, one, or more items in the menu\n");
00020   sout->printf("%s%s",fmt,"'!input text' - calls takeInput(text) on the currently hilighted control(s)\n");
00021   sout->printf("%s%s",fmt,"any text not beginning with ! - sent to takeInput() of the current control\n");
00022   report(root,"",maxDepth);
00023   return NullControl::activate(disp_id,gui);
00024 }
00025 
00026 //! displays the menu items of @a r and their descriptions, recursing on submenus
00027 /*! @a prefix is what should be displayed before each menu item (like a bullet point)
00028  *  this is itself prefixed by 2 spaces for each level of recursion.  Word wrapping
00029  *  is performed to maintain the clean indenting */
00030 void HelpControl::report(ControlBase* r, const std::string& prefix, unsigned int depth_remain) {
00031   if(r==NULL || depth_remain==0)
00032     return;
00033   const std::vector<ControlBase*>& slots=r->getSlots();
00034   const std::string pre="  "+prefix;
00035   unsigned int numlen=1;
00036   if(slots.size()>1)
00037     numlen=(int)(log(slots.size()-1)/log(10))+1;
00038 #ifdef HelpControl_HTML_
00039   sout->printf("<ol>\n");
00040 #endif
00041   for(unsigned int i=0; i<slots.size(); i++) {
00042     if(slots[i]==NULL)
00043       continue;
00044     char * fmt;
00045     std::string nm=slots[i]->getName();
00046     std::string desc=slots[i]->getDescription();
00047     unsigned int len=term_width-(prefix.size()+nm.size()+4+numlen);
00048     if((int)len<0)
00049       len=0;
00050     if(len>desc.size())
00051       len=desc.size();
00052     else
00053       while(len>0 && !isspace(desc[len-1])) len--;
00054 #ifdef HelpControl_HTML_
00055     fmt="%s<li><!--%*d--><code><b>%s</b>: %s";
00056 #else
00057     if(config->main.use_VT100)
00058       fmt="\33[1m%s%*d. %s\33[0m: %s\n";
00059     else
00060       fmt="%s%*d. %s: %s\n";
00061 #endif
00062     sout->printf(fmt,prefix.c_str(),numlen,i,nm.c_str(),desc.substr(0,len).c_str());
00063     while(len<desc.size() && isspace(desc[len])) len++;
00064     desc=desc.substr(len);
00065     while(desc.size()>0) {
00066       len=term_width-prefix.size();
00067       if((int)len<0)
00068         len=0;
00069       if(len>desc.size())
00070         len=desc.size();
00071       else {
00072         while(len>0 && !isspace(desc[len-1])) len--;
00073         if(len==0)
00074           len=term_width-prefix.size();
00075         if(len>desc.size())
00076           len=desc.size();
00077       }
00078 #ifdef HelpControl_HTML_
00079       sout->printf("\n%s",desc.substr(0,len).c_str());
00080 #else
00081       sout->printf("%s%s\n",std::string(prefix.size(),' ').c_str(),desc.substr(0,len).c_str());
00082 #endif
00083       while(len<desc.size() && isspace(desc[len])) len++;
00084       desc=desc.substr(len);
00085     }
00086 #ifdef HelpControl_HTML_
00087     sout->printf("</code></li>\n");
00088 #endif
00089     report(slots[i],pre,depth_remain-1);
00090   }
00091 #ifdef HelpControl_HTML_
00092   sout->printf("</ol>\n");
00093 #endif
00094 }
00095 
00096 /*! @file
00097  * @brief Implements HelpControl, which recurses through the menu system and outputs the name and description of each item
00098  * @author ejt (Creator)
00099  *
00100  * $Author: ejt $
00101  * $Name: tekkotsu-2_2 $
00102  * $Revision: 1.7 $
00103  * $State: Exp $
00104  * $Date: 2004/07/14 00:50:26 $
00105  */
00106 

Tekkotsu v2.2
Generated Tue Oct 19 14:19:14 2004 by Doxygen 1.3.9.1