HelpCommand.cc

Go to the documentation of this file.
00001 /*
00002  * IMPORTANT: READ BEFORE DOWNLOADING, COPYING, INSTALLING OR USING. By
00003  * downloading, copying, installing or using the software you agree to
00004  * this license. If you do not agree to this license, do not download,
00005  * install, copy or use the software.
00006  * 
00007  * Intel Open Source License 
00008  * 
00009  * Copyright (c) 2004 Intel Corporation. All rights reserved. 
00010  * 
00011  * Redistribution and use in source and binary forms, with or without
00012  * modification, are permitted provided that the following conditions are
00013  * met:
00014  * 
00015  *   Redistributions of source code must retain the above copyright
00016  *   notice, this list of conditions and the following disclaimer.
00017  * 
00018  *   Redistributions in binary form must reproduce the above copyright
00019  *   notice, this list of conditions and the following disclaimer in the
00020  *   documentation and/or other materials provided with the distribution.
00021  * 
00022  *   Neither the name of the Intel Corporation nor the names of its
00023  *   contributors may be used to endorse or promote products derived from
00024  *   this software without specific prior written permission.
00025  *  
00026  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00027  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00028  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
00029  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE INTEL OR
00030  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00031  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00032  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
00033  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
00034  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00035  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00036  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00037  */
00038 
00039 #include "HelpCommand.h"
00040 
00041 #include "memory/Memory.h"
00042 #include "util/StringBuffer.h"
00043 #include "util/StringUtils.h"
00044 
00045 namespace oasys {
00046 
00047 HelpCommand::HelpCommand()
00048     : TclCommand("help")
00049 {
00050     add_to_help("help <cmd>", "Print the help documentation for cmd");
00051 }
00052 
00053 int
00054 HelpCommand::exec(int argc, const char** argv, Tcl_Interp* interp)
00055 {
00056     (void)interp;
00057     
00058     const TclCommandList *cmdlist = NULL;
00059     TclCommandList::const_iterator iter;
00060     
00061     cmdlist = TclCommandInterp::instance()->commands();
00062 
00063     if (argc == 1) 
00064     {
00065         StringBuffer buf;
00066         int len = 0;
00067 
00068         buf.append("For help on a particular command, type \"help <cmd>\".\n");
00069         buf.append("The registered commands are: \n\t");
00070                    
00071         std::vector<std::string> cmd_names;
00072         for (iter = cmdlist->begin(); iter != cmdlist->end(); ++iter) {
00073             cmd_names.push_back((*iter)->name());
00074         }
00075         std::sort(cmd_names.begin(), cmd_names.end(), StringLessThan());
00076 
00077         for (std::vector<std::string>::iterator j =  cmd_names.begin();
00078              j != cmd_names.end(); ++j)
00079         {
00080             if (len > 60) {
00081                 buf.appendf("\n\t");
00082                 len = 0;
00083             }
00084 
00085             len += buf.appendf("%s ", j->c_str());
00086         }
00087         set_result(buf.c_str());
00088         return TCL_OK;
00089     } 
00090     else if (argc == 2) 
00091     {
00092         for (iter = cmdlist->begin(); iter != cmdlist->end(); iter++) {
00093             if (!strcmp((*iter)->name(), argv[1])) {
00094                 const char *help = (*iter)->help_string();
00095                 const char *binfo = "";
00096 
00097                 if (!help || (help && help[0] == '\0')) {
00098                     help = "(no help, sorry)";
00099                 }
00100 
00101                 StringBuffer buf;
00102                 if ((*iter)->hasBindings()) {
00103                     buf.appendf("%s info\n\t%s", (*iter)->name(),
00104                                 "Lists settable parameters.\n");
00105                     binfo = buf.c_str();
00106                 }
00107 
00108                 resultf("%s%s", binfo, help);
00109                 
00110                 return TCL_OK;
00111             }
00112         }
00113 
00114         resultf("no registered command '%s'", argv[1]);
00115         return TCL_ERROR;
00116         
00117     } else {
00118         wrong_num_args(argc, argv, 2, 3, 3);
00119         return TCL_ERROR;
00120     }
00121 }
00122 
00123 } // namespace oasys

Generated on Fri Dec 22 14:47:59 2006 for DTN Reference Implementation by  doxygen 1.5.1