PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // HTMLHelpGenerator.cc 00004 // 00005 // Copyright (C) 2007 Xavier Saint-Mleux, ApSTAT Technologies inc. 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 // Authors: Xavier Saint-Mleux 00036 00040 #include "HTMLHelpGenerator.h" 00041 #include <plearn/io/openFile.h> 00042 #include <plearn/io/fileutils.h> 00043 #include <plearn/base/stringutils.h> 00044 #include <plearn/base/HelpSystem.h> 00045 00046 namespace PLearn { 00047 using namespace std; 00048 00049 PLEARN_IMPLEMENT_OBJECT( 00050 HTMLHelpGenerator, 00051 "ONE LINE USER DESCRIPTION", 00052 "MULTI LINE\nHELP FOR USERS" 00053 ); 00054 00055 HTMLHelpGenerator::HTMLHelpGenerator(const PPath& output_dir_, 00056 const PPath& resources_dir_) 00057 :output_dir(output_dir_), resources_dir(resources_dir_) 00058 {} 00059 00060 void HTMLHelpGenerator::run() 00061 { 00062 openFile(output_dir/"index.html", PStream::raw_ascii, "w") 00063 << HelpSystem::helpIndexHTML(); 00064 helpCommands(); 00065 helpFunctions(); 00066 helpClasses(); 00067 } 00068 00069 void HTMLHelpGenerator::helpCommands() 00070 { 00071 openFile(output_dir/"commands_index.html", PStream::raw_ascii, "w") 00072 << HelpSystem::helpCommandsHTML(); 00073 vector<string> commands= HelpSystem::listCommands(); 00074 for(vector<string>::iterator it= commands.begin(); 00075 it != commands.end(); ++it) 00076 openFile(output_dir/"command_"+(*it)+".html", PStream::raw_ascii, "w") 00077 << HelpSystem::helpOnCommandHTML(*it); 00078 } 00079 00080 void HTMLHelpGenerator::helpFunctions() 00081 { 00082 openFile(output_dir/"functions_index.html", PStream::raw_ascii, "w") 00083 << HelpSystem::helpFunctionsHTML(); 00084 } 00085 00086 void HTMLHelpGenerator::helpClasses() 00087 { 00088 openFile(output_dir/"classes_index.html", PStream::raw_ascii, "w") 00089 << HelpSystem::helpClassesHTML(); 00090 vector<string> commands= HelpSystem::listClasses(); 00091 for(vector<string>::iterator it= commands.begin(); 00092 it != commands.end(); ++it) 00093 openFile(output_dir/"class_"+(*it)+".html", PStream::raw_ascii, "w") 00094 << HelpSystem::helpOnClassHTML(*it); 00095 } 00096 00097 void HTMLHelpGenerator::build() 00098 { 00099 inherited::build(); 00100 build_(); 00101 } 00102 00103 void HTMLHelpGenerator::makeDeepCopyFromShallowCopy(CopiesMap& copies) 00104 { 00105 inherited::makeDeepCopyFromShallowCopy(copies); 00106 } 00107 00108 void HTMLHelpGenerator::declareOptions(OptionList& ol) 00109 { 00110 declareOption(ol, "output_dir", &HTMLHelpGenerator::output_dir, 00111 OptionBase::buildoption, 00112 "Directory where the .html files should be generated"); 00113 00114 declareOption(ol, "resources_dir", &HTMLHelpGenerator::resources_dir, 00115 OptionBase::buildoption, 00116 "Directory where the HTML help resources should be found."); 00117 00118 inherited::declareOptions(ol); 00119 } 00120 00121 void HTMLHelpGenerator::build_() 00122 { 00123 if(output_dir != "" && !pathexists(output_dir)) 00124 force_mkdir(output_dir); 00125 HelpSystem::setResourcesPathHTML(resources_dir); 00126 } 00127 00128 00129 } // end of namespace PLearn 00130 00131 00132 /* 00133 Local Variables: 00134 mode:c++ 00135 c-basic-offset:4 00136 c-file-style:"stroustrup" 00137 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00138 indent-tabs-mode:nil 00139 fill-column:79 00140 End: 00141 */ 00142 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :