PLearn 0.1
|
#include <plearn/base/Object.h>
#include "HelpSystem.h"
#include <algorithm>
#include "stringutils.h"
#include "tostring.h"
#include <plearn/misc/HTMLUtils.h>
#include <plearn/io/openFile.h>
#include <plearn/io/fileutils.h>
#include <plearn/io/openString.h>
#include <plearn/base/TypeFactory.h>
#include <plearn/base/RemoteTrampoline.h>
#include <plearn/base/RemoteDeclareMethod.h>
#include <plearn/base/RemoteMethodDoc.h>
#include <plearn/base/RemoteMethodMap.h>
#include <commands/PLearnCommands/PLearnCommandRegistry.h>
Go to the source code of this file.
Namespaces | |
namespace | PLearn |
< for swap | |
Functions | |
BEGIN_DECLARE_REMOTE_FUNCTIONS | PLearn::declareFunction ("listCommands",&HelpSystem::listCommands,(BodyDoc("Returns a list of all registered ""commands as strings."), RetDoc("vector of command names"))) |
PLearn::declareFunction ("helpCommands",&HelpSystem::helpCommands,(BodyDoc("Returns a plain text list of all ""registered commands."), RetDoc("plain text list of commands"))) | |
PLearn::declareFunction ("helpOnCommand",&HelpSystem::helpOnCommand,(BodyDoc("Will return full help for the ""command with the given name "), ArgDoc("commandname","The name of the command on which to get help"), RetDoc("help text for the command"))) | |
PLearn::declareFunction ("helpCommandsHTML",&HelpSystem::helpCommandsHTML,(BodyDoc("Returns an HTML list of all ""registered commands."), RetDoc("HTML list of commands"))) | |
PLearn::declareFunction ("helpOnCommandHTML",&HelpSystem::helpOnCommandHTML,(BodyDoc("Will return full help for the ""command with the given name, in HTML"), ArgDoc("commandname","The name of the command on which to get help"), RetDoc("help text for the command, in HTML"))) | |
PLearn::declareFunction ("listFunctions",&HelpSystem::listFunctions,(BodyDoc("Returns a list of all registered global ""functions as pairs of (funtionname, nargs)"), RetDoc("vector of function names, arity"))) | |
PLearn::declareFunction ("listFunctionPrototypes",&HelpSystem::listFunctionPrototypes,(BodyDoc("Returns a list of the prototypes ""of all registered global functions"), RetDoc("vector of function prototypes as strings"))) | |
PLearn::declareFunction ("helpFunctions",&HelpSystem::helpFunctions,(BodyDoc("Returns a list of all registered global ""functions as plain text"), RetDoc("plain text list of functions"))) | |
PLearn::declareFunction ("helpOnFunction",&HelpSystem::helpOnFunction,(BodyDoc("Will return full help on all registered ""global functions with the given name "), ArgDoc("functionname","The name of the function on which to get help"), ArgDoc("arity","The number of params"), RetDoc("help text for the function"))) | |
PLearn::declareFunction ("helpFunctionsHTML",&HelpSystem::helpFunctionsHTML,(BodyDoc("Returns a list of all registered global ""functions as an HTML page."), RetDoc("HTML list of functions"))) | |
PLearn::declareFunction ("helpOnFunctionHTML",&HelpSystem::helpOnFunctionHTML,(BodyDoc("Will return full HTML help on all registered ""global functions with the given name "), ArgDoc("functionname","The name of the function on which to get help"), ArgDoc("arity","The number of params"), RetDoc("HTML help text for the function"))) | |
PLearn::declareFunction ("listClasses",&HelpSystem::listClasses,(BodyDoc("Returns a list of all registered Object classes"), RetDoc("vector of class names"))) | |
PLearn::declareFunction ("getClassTree",&HelpSystem::getClassTree,(BodyDoc("Returns a map, mapping all registered ""Object classnames to their parentclassname"), RetDoc("map of class names to class names"))) | |
PLearn::declareFunction ("helpClasses",&HelpSystem::helpClasses,(BodyDoc("Returns a plain text list of all registered Object classes"), RetDoc("plain text list of class names"))) | |
PLearn::declareFunction ("helpOnClass",&HelpSystem::helpOnClass,(BodyDoc("Will return full help for ""the class with the given name"), ArgDoc("classname","The name of the class on which to get help"), RetDoc("help text for the class"))) | |
PLearn::declareFunction ("precisOnClass",&HelpSystem::precisOnClass,(BodyDoc("Will return short class descr. and list of build options"), ArgDoc("classname","The name of the class on which to get help"), RetDoc("pair of classname and list of options"))) | |
PLearn::declareFunction ("helpClassesHTML",&HelpSystem::helpClassesHTML,(BodyDoc("Returns a list of all registered Object ""classes as an HTML page."), RetDoc("HTML list of class names"))) | |
PLearn::declareFunction ("helpOnClassHTML",&HelpSystem::helpOnClassHTML,(BodyDoc("Will return full HTML help for ""the class with the given name"), ArgDoc("classname","The name of the class on which to get help"), RetDoc("HTML help text for the class"))) | |
PLearn::declareFunction ("listClassParents",&HelpSystem::listClassParents,(BodyDoc("List of parent classes."), ArgDoc("classname","The name of the class on which to get parents"), RetDoc("vector of parent class names"))) | |
PLearn::declareFunction ("helpClassParents",&HelpSystem::helpClassParents,(BodyDoc("Text list of parent classes."), ArgDoc("classname","The name of the class on which to get parents"), RetDoc("text list of parent class names"))) | |
PLearn::declareFunction ("helpClassParentsHTML",&HelpSystem::helpClassParentsHTML,(BodyDoc("HTML list of parent classes."), ArgDoc("classname","The name of the class on which to get parents"), RetDoc("HTML list of parent class names"))) | |
PLearn::declareFunction ("listDerivedClasses",&HelpSystem::listDerivedClasses,(BodyDoc("List of derived classes."), ArgDoc("classname","The name of the class on which to get children"), RetDoc("List of derived class names"))) | |
PLearn::declareFunction ("helpDerivedClasses",&HelpSystem::helpDerivedClasses,(BodyDoc("Text list of derived classes."), ArgDoc("classname","The name of the class on which to get children"), RetDoc("Text list of derived class names"))) | |
PLearn::declareFunction ("helpDerivedClassesHTML",&HelpSystem::helpDerivedClassesHTML,(BodyDoc("HTML list of derived classes."), ArgDoc("classname","The name of the class on which to get children"), RetDoc("HTML list of derived class names"))) | |
PLearn::declareFunction ("listClassOptions",&HelpSystem::listClassOptions,(BodyDoc("Returns a list of all options ""for the given class."), ArgDoc("classname","The name of the class ""on which to get option help"), RetDoc("vector of option names"))) | |
PLearn::declareFunction ("listBuildOptions",&HelpSystem::listBuildOptions,(BodyDoc("Returns a list of build options ""for the given class."), ArgDoc("classname","The name of the class ""on which to get option help"), RetDoc("vector of option names"))) | |
PLearn::declareFunction ("helpOnOption",&HelpSystem::helpOnOption,(BodyDoc("Will return full help for the option with ""the given name within the given class"), ArgDoc("classname","The name of the class ""on which to get option help"), ArgDoc("optionname","The name of the option on which to get help"), RetDoc("help text for the option"))) | |
PLearn::declareFunction ("helpClassOptionsHTML",&HelpSystem::helpClassOptionsHTML,(BodyDoc("Returns a list of all options ""for the given class as an HTML page."), ArgDoc("classname","The name of the class ""on which to get option help"), RetDoc("HTML list of option names"))) | |
PLearn::declareFunction ("helpOnOptionHTML",&HelpSystem::helpOnOptionHTML,(BodyDoc("Will return full HTML help for the option ""with the given name within the given class"), ArgDoc("classname","The name of the class ""on which to get option help"), ArgDoc("optionname","The name of the option on which to get help"), RetDoc("HTML help text for the option"))) | |
PLearn::declareFunction ("listMethods",&HelpSystem::listMethods,(BodyDoc("Returns a list of all registered methods ""for the given class as pairs of (methodname, nargs)"), ArgDoc("classname","The name of the class whose methods you want to list."), RetDoc("vector of method names"))) | |
PLearn::declareFunction ("listMethodPrototypes",&HelpSystem::listMethodPrototypes,(BodyDoc("Returns a list of the prototypes of ""all registered methods for the given class"), ArgDoc("classname","The name of the class ""whose method prototypes you want to list."), RetDoc("vector of prototypes as strings"))) | |
PLearn::declareFunction ("helpMethods",&HelpSystem::helpMethods,(BodyDoc("Returns a list of all registered methods ""for the given class as text."), ArgDoc("classname","The name of the class whose methods you want to list."), RetDoc("Text list of method names"))) | |
PLearn::declareFunction ("helpOnMethod",&HelpSystem::helpOnMethod,(BodyDoc("Will return full help on all registered ""methods of the class with the given name"), ArgDoc("classname","The name of the class"), ArgDoc("methodname","The name of the method"), ArgDoc("arity","The number of params"), RetDoc("help text"))) | |
PLearn::declareFunction ("helpMethodsHTML",&HelpSystem::helpMethodsHTML,(BodyDoc("Returns a list of all registered methods ""for the given class as an HTML page."), ArgDoc("classname","The name of the class whose methods you want to list."), RetDoc("HTML list of method names"))) | |
PLearn::declareFunction ("helpOnMethodHTML",&HelpSystem::helpOnMethodHTML,(BodyDoc("Will return full help on all registered ""methods of the class with the given name"), ArgDoc("classname","The name of the class"), ArgDoc("methodname","The name of the method"), ArgDoc("arity","The number of params"), RetDoc("help text in HTML"))) | |
PLearn::declareFunction ("helpIndexHTML",&HelpSystem::helpIndexHTML,(BodyDoc("Returns the global help index in HTML."), RetDoc("HTML global help index"))) | |
PLearn::declareFunction ("setResourcesPathHTML",&HelpSystem::setResourcesPathHTML,(BodyDoc("Sets the help resource path ""for HTML resources."), ArgDoc("path","HTML help resource path"))) | |
PLearn::declareFunction ("getResourcesPathHTML",&HelpSystem::getResourcesPathHTML,(BodyDoc("Gets the help resource path ""for HTML resources."), RetDoc("path of HTML resources"))) |