Program: bbtk
Module: $RCSfile: bbtkInterpreter.cxx,v $ $
Language: C++
- Date: $Date: 2008/02/05 11:39:32 $
- Version: $Revision: 1.23 $
+ Date: $Date: 2008/02/14 10:47:51 $
+ Version: $Revision: 1.30 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
// mFactory = new bbtk::Factory();
mExecuter = new bbtk::Executer();
+ //mExecuter = new bbtk::Transcriptor("GeneratedProgram.txt");
//mExecuter->SetFactory(mFactory);
// Builds the commands dict
CommandInfoType info;
- info.keyword = "new";
+ info.category = "new";
info.argmin = 2;
info.argmax = 2;
info.code = cNew;
info.syntax = "new <type> <name>";
info.help = "Creates a new black box of type <type> with name <name>";
- mCommandDict[info.keyword] = info;
+ mCommandDict[info.category] = info;
- info.keyword = "delete";
+ info.category = "delete";
info.argmin = 1;
info.argmax = 1;
info.code = cDelete;
info.syntax = "delete <box>";
info.help = "Deletes the black box of name <box>";
- mCommandDict[info.keyword] = info;
+ mCommandDict[info.category] = info;
- info.keyword = "connect";
+ info.category = "connect";
info.argmin = 2;
info.argmax = 2;
info.code = cConnect;
info.syntax = "connect <box1.output> <box2.input>";
info.help = "Connects the ouput <output> of black box <box1> to the input <input> of black box <box2>";
- mCommandDict[info.keyword] = info;
+ mCommandDict[info.category] = info;
- info.keyword = "print";
+ info.category = "print";
info.argmin = 1;
info.argmax = 1;
info.code = cPrint;
info.syntax = "print <string>";
info.help = "Prints the string. Substitutes any token of the form '$box.output$' by the string adaptation of the output of the box (requires the right adaptor). No carriage return is issued at the end, use '\\n' to add carriage returns. The level of 'Echo' messages must be greater than 1 (see the command 'message').";
- mCommandDict[info.keyword] = info;
+ mCommandDict[info.category] = info;
- info.keyword = "exec";
+ info.category = "exec";
info.argmin = 1;
info.argmax = 2;
info.code = cExec;
info.syntax = "exec <box | 'freeze' | 'unfreeze' >";
- info.help = "Executes the black box of name <box> (and connected boxes if needed). If the special keyword 'freeze' is given then freezes any further execution command. 'unfreeze' reverts to normal execution mode.";
- mCommandDict[info.keyword] = info;
+ info.help = "Executes the black box of name <box> (and connected boxes if needed). If the special category 'freeze' is given then freezes any further execution command. 'unfreeze' reverts to normal execution mode.";
+ mCommandDict[info.category] = info;
- info.keyword = "package";
+ info.category = "package";
info.argmin = 1;
info.argmax = 1;
info.code = cPackage;
info.syntax = "package <name>";
info.help = "Begins the definition of a package.";
- mCommandDict[info.keyword] = info;
+ mCommandDict[info.category] = info;
- info.keyword = "endpackage";
+ info.category = "endpackage";
info.argmin = 0;
info.argmax = 0;
info.code = cEndPackage;
info.syntax = "endpackage";
info.help = "Ends the definition of a package.";
- mCommandDict[info.keyword] = info;
+ mCommandDict[info.category] = info;
- info.keyword = "define";
+ info.category = "define";
info.argmin = 1;
info.argmax = 2;
info.code = cDefine;
info.syntax = "define <type> [<package>]";
info.help = "Begins the definition of a new type of complex black box called <type>. If <package> if provided will create it in the given package.";
- mCommandDict[info.keyword] = info;
+ mCommandDict[info.category] = info;
- info.keyword = "endefine";
+ info.category = "endefine";
info.argmin = 0;
info.argmax = 0;
info.code = cEndDefine;
info.syntax = "endefine";
info.help = "Ends the definition of a new type of complex black box";
- mCommandDict[info.keyword] = info;
+ mCommandDict[info.category] = info;
- info.keyword = "input";
+ info.category = "input";
info.argmin = 3;
info.argmax = 3;
info.code = cInput;
info.syntax = "input <name> <box.input> <help>";
info.help = "Defines the input <name> of the current working black box as being an alias for the input <input> of the black box <box>. <help> defines the help string for the newly created input";
- mCommandDict[info.keyword] = info;
+ mCommandDict[info.category] = info;
- info.keyword = "output";
+ info.category = "output";
info.argmin = 3;
info.argmax = 3;
info.code = cOutput;
info.syntax = "output <name> <box.output> <help>";
info.help = "Defines the output <name> of the current working black box as being an alias for the output <output> of the black box <box>. <help> defines the help string for the newly created output";
- mCommandDict[info.keyword] = info;
+ mCommandDict[info.category] = info;
- info.keyword = "set";
+ info.category = "set";
info.argmin = 2;
info.argmax = 2;
info.code = cSet;
info.syntax = "set <box.input> <value>";
info.help = "Sets the value of the input <input> of the black box <box> to <value>. There must exist a string to the value type adaptor";
- mCommandDict[info.keyword] = info;
+ mCommandDict[info.category] = info;
- info.keyword = "config"; // JPR
+ info.category = "config"; // JPR
info.argmin = 0;
info.argmax = 0;
info.code = cConfig;
info.syntax = "config";
info.help = "Prints the value of all configuration parameters";
- mCommandDict[info.keyword] = info;
+ mCommandDict[info.category] = info;
- info.keyword = "index"; // LG
+ info.category = "index"; // LG
info.argmin = 0;
info.argmax = 2;
info.code = cIndex;
+
info.syntax = "index [<filename> ['Initials'(default)|'Packages'|'Categories']]";
info.help = "Creates an html index of known boxes. If filename is provided then save it to the file 'filename'. The default index entries are the initial letters of the names of the boxes. If 'Packages' or 'Categories' is provided then the entries are either the packages names or the categories";
- mCommandDict[info.keyword] = info;
+ mCommandDict[info.category] = info;
- info.keyword = "reset"; //EED
+ info.category = "reset"; //EED
info.argmin = 0;
info.argmax = 0;
info.code = cReset;
info.syntax = "reset";
info.help = "Deletes all boxes and unloads all packages (bbi is reset to its start state)";
- mCommandDict[info.keyword] = info;
+ mCommandDict[info.category] = info;
- info.keyword = "author";
+ info.category = "author";
info.argmin = 1;
info.argmax = 1;
info.code = cAuthor;
info.syntax = "author <string>";
info.help = "Adds the string <string> to the author information of the black box being defined";
- mCommandDict[info.keyword] = info;
+ mCommandDict[info.category] = info;
- info.keyword = "keyword"; //JP
+ info.category = "category"; //JP
info.argmin = 1;
info.argmax = 1;
- info.code = cKeyword;
- info.syntax = "keyword <list of items, separated by ;>";
- info.help = "Adds the string <string> to the keyword information of the black box being defined";
- mCommandDict[info.keyword] = info;
+ info.code = cCategory;
+ info.syntax = "category <list of items, separated by ;>";
+ info.help = "Adds the string <string> to the category information of the black box being defined";
+ mCommandDict[info.category] = info;
- info.keyword = "description";
+ info.category = "description";
info.argmin = 1;
info.argmax = 1;
info.code = cDescription;
info.syntax = "description <string>";
info.help = "Adds the string <string> to the descriptive information of the black box being defined";
- mCommandDict[info.keyword] = info;
+ mCommandDict[info.category] = info;
- info.keyword = "help";
+ info.category = "help";
info.argmin = 0;
info.argmax = 2;
info.code = cHelp;
info.syntax = "help";
info.syntax = "\n (1) help \n (2) help <command name> \n (3) help packages [all]\n (4) help <package name> [all]\n (5) help <black box type> \n (6) help <black box name>";
info.help = "Effect :\n (1) Lists all available commands;\n (2) Prints help on a particular command; \n (3) Lists the packages loaded and their black boxes.\n Add 'all' to list adaptors; \n (4) Prints short help on the black boxes of a package.\n Add 'all' to include adaptors; \n (5) Prints full help on a black box type; \n (6) Prints information on the inputs, outputs and connections of a black box instance.";
- mCommandDict[info.keyword] = info;
+ mCommandDict[info.category] = info;
- info.keyword = "message";
+ info.category = "message";
info.argmin = 0;
info.argmax = 2;
info.code = cMessage;
info.syntax = "message <kind> <level>";
- info.help = "Sets the level of the kind of messages <kind> to <level>.\n If kind='All' then sets the level for all kinds. If no kind nor level is passed then prints info on available kinds of messages and their current level."; mCommandDict[info.keyword] = info;
+ info.help = "Sets the level of the kind of messages <kind> to <level>.\n If kind='All' then sets the level for all kinds. If no kind nor level is passed then prints info on available kinds of messages and their current level."; mCommandDict[info.category] = info;
- info.keyword = "include";
+ info.category = "include";
info.argmin = 1;
- info.argmax = 1;
+ info.argmax = 2;
info.code = cInclude;
- info.syntax = "include <filename>";
- info.help = "Includes the file <filename>";
- mCommandDict[info.keyword] = info;
+ info.syntax = "include <filename> [source]";
+ info.help = "Includes the file <filename>.\n 'source' : If the keyword 'source' is provided then informs bbi that the included file is the source of the current box definition (Advanced; used to get the right 'Include' field in html doc of packages 'appli' scripts).";
+ mCommandDict[info.category] = info;
- info.keyword = "quit";
+ info.category = "quit";
info.argmin = 0;
info.argmax = 0;
info.code = cQuit;
info.syntax = "quit";
info.help = "Quits the program (during script execution it stops the complete execution)";
- mCommandDict[info.keyword] = info;
+ mCommandDict[info.category] = info;
- info.keyword = "load";
+ info.category = "load";
info.argmin = 1;
info.argmax = 1;
info.code = cLoad;
info.syntax = "load <packagename>";
info.help = "Loads the black box package <packagename>";
- mCommandDict[info.keyword] = info;
+ mCommandDict[info.category] = info;
- info.keyword = "unload";
+ info.category = "unload";
info.argmin = 1;
info.argmax = 1;
info.code = cUnload;
info.syntax = "unload <packagename>";
info.help = "Unloads the black box package <packagename>";
- mCommandDict[info.keyword] = info;
+ mCommandDict[info.category] = info;
- info.keyword = "graph";
+ info.category = "graph";
info.argmin = 0;
info.argmax = 6;
info.code = cGraph;
info.syntax = "graph [ BlackBoxName [ Detail 0..1 [ Level 0..99999 [ Output html file [ Custom header [ Custom title ]]]]]] \n graph [ BlackBoxNameType [ Detail 0..1 [ Level 0..99999 [ Output html file [ Custom header [ Custom title ]]]]]]";
info.help = "Shows a graphical view of a bbtk pipeline.\n- BlackBoxName : name of the box to view. Default '.' : current box.\n- BlackBoxNameType : name of the type of box to view, ex : 'workspace')";
- mCommandDict[info.keyword] = info;
+ mCommandDict[info.category] = info;
/*
- info.keyword = "workspace";
+ info.category = "workspace";
info.argmin = 1;
info.argmax = 2;
info.code = cWorkspace;
info.syntax = "workspace < ( freeze | unfreeze ) | ( rename <newname> ) >";
info.help = "Configures the workspace.\n 'freeze' allow to block execution commands while keeping definition commands active. 'unfreeze' turns back the worspace in 'normal' mode.\n 'rename' allow to set a new name to the workspace.";
- mCommandDict[info.keyword] = info;
+ mCommandDict[info.category] = info;
*/
bbtkDebugDecTab("Interpreter",9);
*
*/
void Interpreter::InterpretFile( const std::string& filename,
- bool use_configuration_file)
+ bool use_configuration_file)
{
bbtkDebugMessageInc("Interpreter",9,"Interpreter::InterpretFile(\""<<filename<<"\")"<<std::endl);
InterpretCommand(words,command);
bbtkDebugMessage("Interpreter",9,
- "Command='"<<command.keyword
+ "Command='"<<command.category
<<"' code="<<command.code<<std::endl);
int level=0;
std::string left,right,left2,right2;
case cDefine :
if (mFileName.size()>0)
{
- filename = Utilities::get_file_name(mFileName.back());
+ filename = mIncludeFileName.back(); //Utilities::get_file_name(mFileName.back());
}
if (words.size()==2)
{
mExecuter->Author(words[1]);
break;
- case cKeyword :
- mExecuter->Keyword(words[1]);
+ case cCategory :
+ mExecuter->Category(words[1]);
break;
case cIndex :
{
SwitchToFile(words[1], true ); // true : better pass use_config_file
}
+ // if 'source' was given
+ if (words.size()==3)
+ {
+ this->mExecuter->SetCurrentFileName(words[1]);
+ }
break;
case cLoad:
// It's a user intended message.
// Please don't remove it.
bbtkMessage("Interpreter",1,
- "look for : [" << name
+ "look for : [" << name
<< "] (use_configuration_file == TRUE)" << std::endl);
script_paths = ConfigurationFile::GetInstance().Get_bbs_paths();
}
{
if ((*i).substr((*i).size()-4, 4) != ".bbs")
continue; // ignore non .bbs files
- LoadScript(*i);
+ LoadScript(*i,name);
nbBssFiles++;
}
if (nbBssFiles==0)
if ((*i).substr((*i).size()-4, 4) != ".bbs")
continue; // ignore non .bbs files
- LoadScript(*i);
+ LoadScript(*i,name);
nbBssFiles++;
}
if (nbBssFiles==0)
return;
}
else
- LoadScript(fullPathScriptName);
+ LoadScript(fullPathScriptName,name);
return;
}
//=======================================================================
- void Interpreter::LoadScript( std::string fullPathScriptName)
+ void Interpreter::LoadScript( std::string fullPathScriptName,
+ std::string includeScriptName)
{
if (find(mFileName.begin(),mFileName.end(),fullPathScriptName)
!=mFileName.end())
mFile.push_back(s);
mFileName.push_back(fullPathScriptName);
+ mIncludeFileName.push_back(includeScriptName);
mLine.push_back(0);
return;
}
" Closing file '"<<mFileName.back()<<"'"<<std::endl);
mFileName.pop_back();
+ mIncludeFileName.pop_back();
mLine.pop_back();
bbtkDebugMessage("Interpreter",9," Remains "
<<mFile.size()
bbtkDebugMessage("Interpreter",9,
" Closing file '"<<mFileName.back()<<"'"<<std::endl);
mFileName.pop_back();
+ mIncludeFileName.pop_back();
mLine.pop_back();
}
bbtkDebugMessage("Interpreter",9,"EO Interpreter::CloseAllFiles()"
{
bbtkDebugMessageInc("Interpreter",9,"Interpreter::InterpretCommand(...)"<<std::endl);
- // searches the command keyword
+ // searches the command category
CommandDictType::iterator c;
c = mCommandDict.find(words[0]);
if ( c == mCommandDict.end() ) {
try
{
HelpPackage(words[1]);
+#ifdef _USE_WXWIDGETS_
+ if ( WxConsole::GetInstance() != 0 )
+ {
+ std::string url =
+ ConfigurationFile::GetInstance().Get_doc_path();
+ url += "/bbdoc/" + words[1] + "/index.html";
+ if (Utilities::FileExists(url))
+ {
+ WxConsole::GetInstance()->ShowHtmlPage(url);
+ }
+ }
+#endif
}
catch (bbtk::Exception f)
{
try
{
- HelpBlackBox(words[1]);
- }
- catch (bbtk::Exception g)
- {
- try
- {
- this->mExecuter->ShowRelations(words[1],"0","9999");
- }
- catch (bbtk::Exception h){
- bbtkError("\""<<words[1].c_str()
- <<"\" is not a known command, package, black box type or black box name");
- }
- }
+ std::string package;
+ HelpBlackBox(words[1],package);
+#ifdef _USE_WXWIDGETS_
+ if ( WxConsole::GetInstance() != 0 )
+ {
+ std::string url =
+ ConfigurationFile::GetInstance().Get_doc_path();
+ url += "/bbdoc/" + package + "/index.html";
+ if (Utilities::FileExists(url))
+ {
+ url += "#" + words[1];
+ WxConsole::GetInstance()->ShowHtmlPage(url);
+ }
+ }
+#endif
+ }
+ catch (bbtk::Exception g)
+ {
+ try
+ {
+ this->mExecuter->ShowRelations(words[1],"0","9999");
+ }
+ catch (bbtk::Exception h){
+ bbtkError("\""<<words[1].c_str()
+ <<"\" is not a known command, package, black box type or black box name");
+ }
+ }
}
- }
+ }
}
else if (nbarg==2)
{
/// Displays the Configuration
void Interpreter::Config() const
{
- bbtkDebugMessageInc("Core",9,"Factory::Config"<<std::endl);
-
- ConfigurationFile cf = ConfigurationFile::GetInstance();
-
- const std::string config_xml_full_path = cf.Get_config_xml_full_path();
- const std::string description = cf.Get_description();
- const std::string url = cf.Get_url();
- const std::string data_path = cf.Get_data_path();
- const std::string default_doc_tmp = cf.Get_default_doc_tmp();
- const std::string file_separator = cf.Get_file_separator();
- const std::vector<std::string>bbs_paths = cf.Get_bbs_paths();
- const std::vector<std::string>package_paths = cf.Get_package_paths();
-
- bbtkMessage("Help",1, "=============" << std::endl);
- bbtkMessage("Help",1, "Configuration" << std::endl);
- bbtkMessage("Help",1, "=============" << std::endl);
- bbtkMessage("Help",1, "bbtk_config.xml : [" << config_xml_full_path << "]" << std::endl);
- bbtkMessage("Help",1, "Documentation Url : [" << url << "]" << std::endl);
- bbtkMessage("Help",1, "Data Path : [" << data_path << "]" << std::endl);
- bbtkMessage("Help",1, "Default Doc_tmp : [" << default_doc_tmp << "]" << std::endl);
- bbtkMessage("Help",1, "File Separator : [" << file_separator << "]" << std::endl);
-
- std::vector<std::string>::const_iterator i;
-
- bbtkMessage("Help",1, "BBS Paths " << std::endl);
- for (i = bbs_paths.begin(); i!=bbs_paths.end(); ++i )
- {
- bbtkMessage("Help",1,"--- ["<<*i<<"]"<<std::endl);
- }
-
- bbtkMessage("Help",1, "PACKAGE Paths : " << std::endl);
- for (i = package_paths.begin(); i!=package_paths.end(); ++i )
- {
- bbtkMessage("Help",1,"--- ["<<*i<<"]"<<std::endl);
- }
-
- bbtkDebugDecTab("Core",9);
+ ConfigurationFile::GetInstance().GetHelp(1);
}
+ //===================================================================
//=======================================================================
/// Displays help on all the commands
git://git.creatis.insa-lyon.fr / bbtk.git / blobdiff