PLearn 0.1
HTMLHelpCommand.h
Go to the documentation of this file.
00001 // -*- C++ -*-
00002 
00003 // HTMLHelpCommand.h
00004 //
00005 // Copyright (C) 2004-2006 Nicolas Chapados 
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: HTMLHelpCommand.h 9437 2008-09-04 18:55:05Z nouiz $ 
00037  ******************************************************* */
00038 
00039 // Authors: Nicolas Chapados
00040 
00044 #ifndef HTMLHelpCommand_INC
00045 #define HTMLHelpCommand_INC
00046 
00047 #include <iostream>
00048 
00049 #include "PLearnCommand.h"
00050 #include "PLearnCommandRegistry.h"
00051 #include <plearn/base/Object.h>
00052 #include <plearn/base/PP.h>
00053 #include <plearn/math/TVec_decl.h>
00054 
00055 
00056 namespace PLearn {
00057 using namespace std;
00058 
00059 class HTMLHelpConfig;                        
00060   
00061 class HTMLHelpCommand: public PLearnCommand
00062 {
00063     PP<HTMLHelpConfig> config;
00064   
00065 protected:
00067     virtual void helpIndex();
00068   
00070     virtual void helpCommands();
00071 
00073     virtual void helpClasses();
00074 
00076     virtual void helpOnCommand(const string& theCommand);
00077   
00079     virtual void helpOnClass(const string& theClass);
00080 
00082     virtual void copySnippet(ostream& os, const string& document);
00083 
00085     virtual string quote(string s) const;
00086 
00088     virtual TVec<string> parent_classes(string s) const;
00089 
00091     virtual string highlight_known_classes(string typestr) const;
00092 
00094     virtual string format_free_text(string text) const;
00095 
00098     virtual string make_http_hyperlinks(string text) const;
00099   
00101     virtual string generated_by() const;
00102 
00104     virtual string flagsAndLevelHeading(const string& classname) const;
00105   
00106 public:
00107     HTMLHelpCommand();
00108 
00110     virtual void run(const vector<string>& args);
00111 
00113     virtual void helpIndex(ostream& os, const HTMLHelpConfig* config);
00114 
00116     virtual void helpCommands(ostream& os, const HTMLHelpConfig* config);
00117 
00119     virtual void helpClasses(ostream& os, const HTMLHelpConfig* config);
00120 
00122     virtual void helpOnCommand(const string& theCommand, ostream& os,
00123                                const HTMLHelpConfig* config);
00124   
00126     virtual void helpOnClass(const string& theClass, ostream& os,
00127                              const HTMLHelpConfig* config);
00128 
00129 protected:
00130     static PLearnCommandRegistry reg_;
00131 };
00132 
00133 //#####  Configuration Object for HTMLHelpCommand  ############################
00134 
00135 class HTMLHelpConfig: public Object
00136 {
00137     typedef Object inherited;
00138     
00139 public:
00141     string output_dir;
00142 
00146     string html_index_document;
00147     
00150     string html_prolog_document;
00151 
00154     string html_epilog_document;
00155 
00156 
00157 protected: 
00159     // (PLEASE IMPLEMENT IN .cc)
00160     static void declareOptions(OptionList& ol);
00161 
00162 public:
00163     PLEARN_DECLARE_OBJECT(HTMLHelpConfig);
00164 };
00165 
00166   
00167 } // end of namespace PLearn
00168 
00169 #endif
00170 
00171 
00172 /*
00173   Local Variables:
00174   mode:c++
00175   c-basic-offset:4
00176   c-file-style:"stroustrup"
00177   c-file-offsets:((innamespace . 0)(inline-open . 0))
00178   indent-tabs-mode:nil
00179   fill-column:79
00180   End:
00181 */
00182 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines