PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // HelpCommand.h 00004 // 00005 // Copyright (C) 2003 Pascal Vincent 00006 // 00007 // Redistribution and use in source and binary forms, with or without 00008 // modification, are permitted provided that the following conditions are met: 00009 // 00010 // 1. Redistributions of source code must retain the above copyright 00011 // notice, this list of conditions and the following disclaimer. 00012 // 00013 // 2. Redistributions in binary form must reproduce the above copyright 00014 // notice, this list of conditions and the following disclaimer in the 00015 // documentation and/or other materials provided with the distribution. 00016 // 00017 // 3. The name of the authors may not be used to endorse or promote 00018 // products derived from this software without specific prior written 00019 // permission. 00020 // 00021 // THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR 00022 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 00023 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN 00024 // NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 00025 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED 00026 // TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 00027 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 00028 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 00029 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 00030 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 00031 // 00032 // This file is part of the PLearn library. For more information on the PLearn 00033 // library, go to the PLearn Web site at www.plearn.org 00034 00035 /* ******************************************************* 00036 * $Id: HelpCommand.h 9770 2008-12-10 17:12:10Z plearner $ 00037 ******************************************************* */ 00038 00040 #ifndef HelpCommand_INC 00041 #define HelpCommand_INC 00042 00043 #include "PLearnCommand.h" 00044 #include "PLearnCommandRegistry.h" 00045 00046 namespace PLearn { 00047 using namespace std; 00048 00049 class HelpCommand: public PLearnCommand 00050 { 00051 protected: 00052 00053 void helpOverview(); 00054 void helpAboutPLearnScript(const string& fname); 00055 void helpAboutPyPLearnScript(const string& fname); 00056 void helpScripts(); 00057 void helpCommands(); 00058 void helpDatasets(); 00059 void helpObject(const string& objectname=""); 00060 00061 public: 00062 HelpCommand(): 00063 PLearnCommand("help", 00064 "plearn command-line help", 00065 00066 "help <topic>\n" 00067 "Run the help command with no argument to get an overview of the system.\n" 00068 ) 00069 {} 00070 00071 virtual void run(const vector<string>& args); 00072 00073 protected: 00074 static PLearnCommandRegistry reg_; 00075 }; 00076 00077 00078 } // end of namespace PLearn 00079 00080 #endif 00081 00082 00083 /* 00084 Local Variables: 00085 mode:c++ 00086 c-basic-offset:4 00087 c-file-style:"stroustrup" 00088 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00089 indent-tabs-mode:nil 00090 fill-column:79 00091 End: 00092 */ 00093 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :