Main Page | Class Hierarchy | Class List | File List | Class Members | File Members

CommandHelp Class Reference

#include <cmt_commands.h>

Collaboration diagram for CommandHelp:

Collaboration graph
[legend]
List of all members.

Public Types

typedef cmt_map< ActionType,
cmt_string
HelpMap
typedef cmt_vector< cmt_stringHelpTexts

Static Public Member Functions

HelpMapget_help ()
HelpTextsget_help_texts ()
const cmt_stringget_help_text (ActionType key)
void show_all ()
void show (ActionType action)

Private Member Functions

 CommandHelp ()

Static Private Member Functions

CommandHelpinstance ()

Private Attributes

HelpMap m_help
HelpTexts m_help_texts

Member Typedef Documentation

typedef cmt_map<ActionType, cmt_string> CommandHelp::HelpMap
 

Definition at line 99 of file cmt_commands.h.

Referenced by CommandHelp(), and get_help().

typedef cmt_vector<cmt_string> CommandHelp::HelpTexts
 

Definition at line 100 of file cmt_commands.h.

Referenced by CommandHelp(), get_help_text(), get_help_texts(), show(), and show_all().


Constructor & Destructor Documentation

CommandHelp::CommandHelp  )  [private]
 

Definition at line 2032 of file cmt_commands.cxx.

References action_awk, action_broadcast, action_build, action_build_CMT_pacman, action_build_constituent_makefile, action_build_constituents_makefile, action_build_dependencies, action_build_library_links, action_build_make_setup, action_build_msdev, action_build_os9_makefile, action_build_prototype, action_build_readme, action_build_tag_makefile, action_build_temporary_name, action_build_triggers, action_build_vsnet, action_build_windefs, action_check_configuration, action_check_files, action_check_version, action_checkout, action_cleanup, action_config, action_create, action_create_project, action_cvsbranches, action_cvssubpackages, action_cvssubprojects, action_cvstags, action_do, action_expand_model, action_filter, action_help, action_load, action_lock, action_none, action_remove, action_remove_library_links, action_run, action_run_sequence, action_set_version, action_set_versions, action_setup, action_show, action_show_action, action_show_action_names, action_show_action_value, action_show_actions, action_show_all_tags, action_show_applied_patterns, action_show_author, action_show_branches, action_show_clients, action_show_cmtpath_patterns, action_show_constituent, action_show_constituent_names, action_show_constituents, action_show_cycles, action_show_fragment, action_show_fragments, action_show_groups, action_show_include_dirs, action_show_language, action_show_languages, action_show_macro, action_show_macro_names, action_show_macro_value, action_show_macros, action_show_manager, action_show_packages, action_show_path, action_show_pattern, action_show_pattern_names, action_show_patterns, action_show_projects, action_show_pwd, action_show_set, action_show_set_names, action_show_set_value, action_show_sets, action_show_setup, action_show_strategies, action_show_tags, action_show_use_paths, action_show_uses, action_show_version, action_show_versions, action_system, action_unlock, action_version, cmt_map< K, T >::add(), cmt_vector< cmt_string >::add(), cmt_vector< cmt_string >::clear(), HelpMap, HelpTexts, m_help, and m_help_texts.

02033 {
02034   static HelpMap& help = m_help;
02035 
02036   static HelpTexts& help_texts = m_help_texts;
02037 
02038   help_texts.clear ();
02039 
02040   help_texts.add () =  "none";
02041   help_texts.add () =  "awk";
02042   help_texts.add () =  "broadcast [-select=list] [-exclude=list] [-local] [-global] [-begin=pattern] [-depth=n] <command> : apply a command to [some of] the used packages";
02043   help_texts.add () =  "build <option>          : build actions. (Try cmt help build)";
02044   help_texts.add () =  "build constituent_makefile <constituent>  : generate constituent Makefile fragment";
02045   help_texts.add () =  "build constituents_makefile : generate constituents.make";
02046   help_texts.add () =  "build dependencies      : generate dependencies";
02047   help_texts.add () =  "build library_links     : build symbolic links towards all imported libraries";
02048   help_texts.add () =  "build make_setup        : build a compiled version of setup scripts";
02049   help_texts.add () =  "build msdev             : generate MSDEV files";
02050   help_texts.add () =  "build CMT_pacman        : generate PACMAN manifest file for CMT";
02051   help_texts.add () =  "build vsnet             : generate VS.NET files";
02052   help_texts.add () =  "build os9_makefile      : generate Makefile for OS9";
02053   help_texts.add () =  "build prototype         : generate prototype file";
02054   help_texts.add () =  "build readme            : generate README.html";
02055   help_texts.add () =  "build tag_makefile      : generate tag specific Makefile";
02056   help_texts.add () =  "build temporary_name    : generate a name for a temprary file";
02057   help_texts.add () =  "build triggers <constituent> : generate library trigger file";
02058   help_texts.add () =  "build windefs <library_name> : generate def file for Windows shared libraries";
02059   help_texts.add () =  "check <option>          : check actions. (Try cmt help check)";
02060   help_texts.add () =  "check configuration     : check configuration";
02061   help_texts.add () =  "check files <old> <new> : compare two files and overrides <old> by <new> if different";
02062   help_texts.add () =  "check version <name>    : check if a name follows a version tag syntax ";
02063   help_texts.add () =  "co | checkout           : perform a cvs checkout over a CMT package";
02064   help_texts.add () =  "cleanup [-csh|-sh|-bat] : generate a cleanup script";
02065   help_texts.add () =  "config                  : generate setup and cleanup scripts";
02066   help_texts.add () =  "create <package> <version> [<path>] : create and configure a new package";
02067   help_texts.add () =  "create_project <project> <name> [<path>] : create and configure a new project";
02068   help_texts.add () =  "cvsbranches <module>      : display the subdirectories for a module";
02069   help_texts.add () =  "cvssubpackages <module>   : display the subpackages for a module";
02070   help_texts.add () =  "cvssubprojects <module>   : display the subprojects for a module";
02071   help_texts.add () =  "cvstags <module>          : display the CVS tags for a module";
02072   help_texts.add () =  "do <action> [<param>=<value>] ... : Execute an action";
02073   help_texts.add () =  "expand model <model>    : ";
02074   help_texts.add () =  "filter <in> <out>       : filter a file against CMT macros and env. variables";
02075   help_texts.add () =  "help | -help | --help   : display this help";
02076   help_texts.add () =  "load";
02077   help_texts.add () =  "lock [<p> <v> [<path>]] : lock a package";
02078   help_texts.add () =  "remove <package> <version> [<path>] : remove a package version";
02079   help_texts.add () =  "remove library_links    : remove symbolic links towards all imported libraries";
02080   help_texts.add () =  "run '<command>'         : apply a command";
02081   help_texts.add () =  "run_sequence <sequence file> : execute a cmt equence file";
02082   help_texts.add () =  "set version <version>   : generate a version file in the current package";
02083   help_texts.add () =  "set versions            : generate version files into packages";
02084   help_texts.add () =  "setup [-csh|-sh|-bat]   : generate a setup script";
02085   help_texts.add () =  "show <option>           : query actions. (Try cmt help show)";
02086   help_texts.add () =  "show  action <name>     :  a formatted action definition";
02087   help_texts.add () =  "show  action_value <name> :  a raw action definition";
02088   help_texts.add () =  "show  action_names      :  all action names";
02089   help_texts.add () =  "show  actions           :  all action definitions";
02090   help_texts.add () =  "show  all_tags          :  all defined tags";
02091   help_texts.add () =  "show  applied_patterns  :  all patterns actually applied";
02092   help_texts.add () =  "show  author            :  package author";
02093   help_texts.add () =  "show  branches          :  added branches";
02094   help_texts.add () =  "show  clients           :  package clients";
02095   help_texts.add () =  "show  cmtpath_patterns  :  cmtpath_patterns";
02096   help_texts.add () =  "show  constituent <name>:  constituent definition";
02097   help_texts.add () =  "show  constituent_names :  constituent names";
02098   help_texts.add () =  "show  constituents      :  constituent definitions";
02099   help_texts.add () =  "show  cycles            :  cycles in the use graph";
02100   help_texts.add () =  "show  fragment <name>   :  one fragment definition";
02101   help_texts.add () =  "show  fragments         :  fragment definitions";
02102   help_texts.add () =  "show  groups            :  group definitions";
02103   help_texts.add () =  "show  include_dirs      :  ";
02104   help_texts.add () =  "show  language <name>   :  language definition";
02105   help_texts.add () =  "show  languages         :  language definitions";
02106   help_texts.add () =  "show  macro <name>      :  a formatted macro definition";
02107   help_texts.add () =  "show  macro_value <name>  :  a raw macro definition";
02108   help_texts.add () =  "show  macro_names       :  all macro names";
02109   help_texts.add () =  "show  macros            :  all macro definitions";
02110   help_texts.add () =  "show  manager           :  package manager";
02111   help_texts.add () =  "show  packages          :  packages reachable from the current context";
02112   help_texts.add () =  "show  path              :  the package search list";
02113   help_texts.add () =  "show  pattern <name>    :  the pattern definition and usages";
02114   help_texts.add () =  "show  pattern_names     :  pattern names";
02115   help_texts.add () =  "show  patterns          :  the pattern definitions";
02116   help_texts.add () =  "show  projects          :  project definitions";
02117   help_texts.add () =  "show  setup             :  setup definitions";
02118   help_texts.add () =  "show  pwd               :  filtered current directory";
02119   help_texts.add () =  "show  set <name>        :  a formatted set definition";
02120   help_texts.add () =  "show  set_names         :  set names";
02121   help_texts.add () =  "show  set_value <name>  :  a raw set definition";
02122   help_texts.add () =  "show  sets              :  set definitions";
02123   help_texts.add () =  "show  strategies        :  all strategies (build & version)";
02124   help_texts.add () =  "show  tags              :  all currently active tags";
02125   help_texts.add () =  "show  use_paths <pack>  :  all paths to the used package";
02126   help_texts.add () =  "show  uses              :  used packages";
02127   help_texts.add () =  "show  version           :  version of the current package";
02128   help_texts.add () =  "show  versions <name>   :  visible versions of the selected package";
02129   help_texts.add () =  "system                  : display the system tag";
02130   help_texts.add () =  "unlock [<p> <v> [<path>]] : unlock a package";
02131   help_texts.add () =  "version                 : version of CMT";
02132   help_texts.add () =  "";
02133 
02134   //"build <key>             : build various components :"
02135   //"show <key>              : display various infos on :"
02136 
02137   help.add (action_none, help_texts[action_none]);
02138   help.add (action_awk, help_texts[action_awk]);
02139   help.add (action_broadcast, help_texts[action_broadcast]);
02140   help.add (action_build, help_texts[action_build]);
02141   help.add (action_build_constituent_makefile, help_texts[action_build_constituent_makefile]);
02142   help.add (action_build_constituents_makefile, help_texts[action_build_constituents_makefile]);
02143   help.add (action_build_dependencies, help_texts[action_build_dependencies]);
02144   help.add (action_build_library_links, help_texts[action_build_library_links]);
02145   help.add (action_build_make_setup, help_texts[action_build_make_setup]);
02146   help.add (action_build_msdev, help_texts[action_build_msdev]);
02147   help.add (action_build_CMT_pacman, help_texts[action_build_CMT_pacman]);
02148   help.add (action_build_vsnet, help_texts[action_build_vsnet]);
02149   help.add (action_build_os9_makefile, help_texts[action_build_os9_makefile]);
02150   help.add (action_build_prototype, help_texts[action_build_prototype]);
02151   help.add (action_build_readme, help_texts[action_build_readme]);
02152   help.add (action_build_tag_makefile, help_texts[action_build_tag_makefile]);
02153   help.add (action_build_temporary_name, help_texts[action_build_temporary_name]);
02154   help.add (action_build_triggers, help_texts[action_build_triggers]);
02155   help.add (action_build_windefs, help_texts[action_build_windefs]);
02156   help.add (action_check_configuration, help_texts[action_check_configuration]);
02157   help.add (action_check_files, help_texts[action_check_files]);
02158   help.add (action_check_version, help_texts[action_check_version]);
02159   help.add (action_checkout, help_texts[action_checkout]);
02160   help.add (action_cleanup, help_texts[action_cleanup]);
02161   help.add (action_config, help_texts[action_config]);
02162   help.add (action_create, help_texts[action_create]);
02163   help.add (action_create_project, help_texts[action_create_project]);
02164   help.add (action_cvsbranches, help_texts[action_cvsbranches]);
02165   help.add (action_cvssubpackages, help_texts[action_cvssubpackages]);
02166   help.add (action_cvssubprojects, help_texts[action_cvssubprojects]);
02167   help.add (action_cvstags, help_texts[action_cvstags]);
02168   help.add (action_do, help_texts[action_do]);
02169   help.add (action_expand_model, help_texts[action_expand_model]);
02170   help.add (action_filter, help_texts[action_filter]);
02171   help.add (action_help, help_texts[action_help]);
02172   help.add (action_load, help_texts[action_load]);
02173   help.add (action_lock, help_texts[action_lock]);
02174   help.add (action_remove, help_texts[action_remove]);
02175   help.add (action_remove_library_links, help_texts[action_remove_library_links]);
02176   help.add (action_run, help_texts[action_run]);
02177   help.add (action_run_sequence, help_texts[action_run_sequence]);
02178   help.add (action_set_version, help_texts[action_set_version]);
02179   help.add (action_set_versions, help_texts[action_set_versions]);
02180   help.add (action_setup, help_texts[action_setup]);
02181   help.add (action_show, help_texts[action_show]);
02182   help.add (action_show_action, help_texts[action_show_action]);
02183   help.add (action_show_action_value, help_texts[action_show_action_value]);
02184   help.add (action_show_action_names, help_texts[action_show_action_names]);
02185   help.add (action_show_actions, help_texts[action_show_actions]);
02186   help.add (action_show_all_tags, help_texts[action_show_all_tags]);
02187   help.add (action_show_applied_patterns, help_texts[action_show_applied_patterns]);
02188   help.add (action_show_author, help_texts[action_show_author]);
02189   help.add (action_show_branches, help_texts[action_show_branches]);
02190   help.add (action_show_clients, help_texts[action_show_clients]);
02191   help.add (action_show_cmtpath_patterns, help_texts[action_show_cmtpath_patterns]);
02192   help.add (action_show_constituent, help_texts[action_show_constituent]);
02193   help.add (action_show_constituent_names, help_texts[action_show_constituent_names]);
02194   help.add (action_show_constituents, help_texts[action_show_constituents]);
02195   help.add (action_show_cycles, help_texts[action_show_cycles]);
02196   help.add (action_show_fragment, help_texts[action_show_fragment]);
02197   help.add (action_show_fragments, help_texts[action_show_fragments]);
02198   help.add (action_show_groups, help_texts[action_show_groups]);
02199   help.add (action_show_include_dirs, help_texts[action_show_include_dirs]);
02200   help.add (action_show_language, help_texts[action_show_language]);
02201   help.add (action_show_languages, help_texts[action_show_languages]);
02202   help.add (action_show_macro, help_texts[action_show_macro]);
02203   help.add (action_show_macro_value, help_texts[action_show_macro_value]);
02204   help.add (action_show_macro_names, help_texts[action_show_macro_names]);
02205   help.add (action_show_macros, help_texts[action_show_macros]);
02206   help.add (action_show_manager, help_texts[action_show_manager]);
02207   help.add (action_show_packages, help_texts[action_show_packages]);
02208   help.add (action_show_path, help_texts[action_show_path]);
02209   help.add (action_show_pattern, help_texts[action_show_pattern]);
02210   help.add (action_show_pattern_names, help_texts[action_show_pattern_names]);
02211   help.add (action_show_patterns, help_texts[action_show_patterns]);
02212   help.add (action_show_projects, help_texts[action_show_projects]);
02213   help.add (action_show_setup, help_texts[action_show_setup]);
02214   help.add (action_show_pwd, help_texts[action_show_pwd]);
02215   help.add (action_show_set, help_texts[action_show_set]);
02216   help.add (action_show_set_names, help_texts[action_show_set_names]);
02217   help.add (action_show_set_value, help_texts[action_show_set_value]);
02218   help.add (action_show_sets, help_texts[action_show_sets]);
02219   help.add (action_show_strategies, help_texts[action_show_strategies]);
02220   help.add (action_show_tags, help_texts[action_show_tags]);
02221   help.add (action_show_use_paths, help_texts[action_show_use_paths]);
02222   help.add (action_show_uses, help_texts[action_show_uses]);
02223   help.add (action_show_version, help_texts[action_show_version]);
02224   help.add (action_show_versions, help_texts[action_show_versions]);
02225   help.add (action_system, help_texts[action_system]);
02226   help.add (action_unlock, help_texts[action_unlock]);
02227   help.add (action_version, help_texts[action_version]);
02228 }


Member Function Documentation

CommandHelp::HelpMap & CommandHelp::get_help  )  [static]
 

Definition at line 1927 of file cmt_commands.cxx.

References HelpMap, instance(), and m_help.

01928 {
01929   static CommandHelp& me = instance ();
01930 
01931   return (me.m_help);
01932 }

const cmt_string & CommandHelp::get_help_text ActionType  key  )  [static]
 

Definition at line 1941 of file cmt_commands.cxx.

References get_help_texts(), and HelpTexts.

Referenced by show().

01942 {
01943   static const HelpTexts& help = get_help_texts ();
01944 
01945   const cmt_string& h = help[key];
01946   return (h);
01947 }

CommandHelp::HelpTexts & CommandHelp::get_help_texts  )  [static]
 

Definition at line 1934 of file cmt_commands.cxx.

References HelpTexts, instance(), and m_help_texts.

Referenced by get_help_text(), show(), and show_all().

01935 {
01936   static CommandHelp& me = instance ();
01937 
01938   return (me.m_help_texts);
01939 }

CommandHelp & CommandHelp::instance  )  [static, private]
 

Definition at line 2026 of file cmt_commands.cxx.

Referenced by get_help(), and get_help_texts().

02027 {
02028   static CommandHelp me;
02029   return (me);
02030 }

void CommandHelp::show ActionType  action  )  [static]
 

Definition at line 1983 of file cmt_commands.cxx.

References action_build, action_build_constituent_makefile, action_build_windefs, action_check, action_check_configuration, action_check_version, action_show, action_show_versions, get_help_text(), get_help_texts(), and HelpTexts.

Referenced by Cmt::do_help().

01984 {
01985   //cerr << "CommandHelp::show> action = " << action << endl;
01986 
01987   static HelpTexts& help_texts = get_help_texts ();
01988 
01989   if (action == action_build)
01990     {
01991       int i;
01992 
01993       for (i = action_build_constituent_makefile; i <= action_build_windefs; i++)
01994         {
01995           const cmt_string& s = help_texts[i];
01996           cerr << "#   " << s << endl;
01997         }
01998     }
01999   if (action == action_check)
02000     {
02001       int i;
02002 
02003       for (i = action_check_configuration; i <= action_check_version; i++)
02004         {
02005           const cmt_string& s = help_texts[i];
02006           cerr << "#   " << s << endl;
02007         }
02008     }
02009   else if (action == action_show)
02010     {
02011       int i;
02012 
02013       for (i = (action_show + 1); i <= action_show_versions; i++)
02014         {
02015           const cmt_string& s = help_texts[i];
02016           cerr << "#   " << s << endl;
02017         }
02018     }
02019   else
02020     {
02021       const cmt_string& s = get_help_text (action);
02022       cerr << "#" << s << endl;
02023     }
02024 }

void CommandHelp::show_all  )  [static]
 

Definition at line 1949 of file cmt_commands.cxx.

References get_help_texts(), and HelpTexts.

Referenced by Cmt::do_help().

01950 {
01951   static HelpTexts& help_texts = get_help_texts ();
01952 
01953   cerr << "#> cmt command [option...]" << endl;
01954   cerr << "# command :" << endl;
01955 
01956   int i;
01957 
01958   for (i = 0; ; i++)
01959     {
01960       const cmt_string& s = help_texts[i];
01961       if (s == "") break;
01962       cerr << "#   " << s << endl;
01963     }
01964 
01965   cerr << "# global options :" << endl;
01966 
01967   cerr << "#   -quiet                  : don't print errors" << endl;
01968   cerr << "#   -use=<p>:<v>:<path>     : set package version path" << endl;
01969   cerr << "#   -pack=<package>         : set package" << endl;
01970   cerr << "#   -version=<version>      : set version" << endl;
01971   cerr << "#   -path=<path>            : set root path" << endl;
01972   cerr << "#   -f=<requirement-file>   : set input file" << endl;
01973   cerr << "#   -e=<statement>          : add a one line statement" << endl;
01974   cerr << "#   -tag=<tag-list>         : select a new tag-set" << endl;
01975   cerr << "#   -tag_add=<tag-list>     : add specific comma-separated tag(s)" << endl;
01976   cerr << "#   -tag_remove=<tag-list>  : remove specific comma-separated tag(s)" << endl;
01977   cerr << "#   -with_version_directory : reset to default structuring style" << endl;
01978   cerr << "#   -without_version_directory : switch structuring style" << endl;
01979   cerr << "#   -cleanup                : activate install area cleanup" << endl;
01980   cerr << "#   -no_cleanup             : inhibit install area cleanup" << endl;
01981 }


Member Data Documentation

HelpMap CommandHelp::m_help [private]
 

Definition at line 113 of file cmt_commands.h.

Referenced by CommandHelp(), and get_help().

HelpTexts CommandHelp::m_help_texts [private]
 

Definition at line 114 of file cmt_commands.h.

Referenced by CommandHelp(), and get_help_texts().


The documentation for this class was generated from the following files:
Generated on Mon May 2 10:25:34 2005 for CMT by doxygen 1.3.5