Program: bbtk
Module: $RCSfile: bbtkInterpreter.cxx,v $ $
Language: C++
- Date: $Date: 2008/02/04 13:51:30 $
- Version: $Revision: 1.19 $
+ Date: $Date: 2008/02/05 13:23:46 $
+ Version: $Revision: 1.25 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
*/
Interpreter::Interpreter()
:
- mCommandLine(false), verbose(false)
+ mCommandLine(false)
{
bbtk::MessageManager::RegisterMessageType("Echo","Level>0 : Prints the 'echo' commands of the user.\n\tLevel>1 : Prints the command being interpreted",1);
bbtk::MessageManager::RegisterMessageType("Interpreter","Messages of the interpreter",0);
// 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 = 1;
+ info.argmax = 0;
info.code = cConfig;
- info.syntax = "config [<verbose>|<v>]";
+ 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'|'Keywords']]";
- 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 'Keywords' is provided then the entries are either the package names or the keywords";
- mCommandDict[info.keyword] = info;
- info.keyword = "reset"; //EED
+ 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.category] = info;
+
+ 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 <category> <level>";
- info.help = "Sets the level of the category of messages <category> to <level>.\n If category='All' then sets the level for all categories. If no category nor level is passed then prints info on available categories of messages and their current level.";
- mCommandDict[info.keyword] = info;
+ 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.category] = info;
- info.keyword = "include";
+ info.category = "include";
info.argmin = 1;
info.argmax = 1;
info.code = cInclude;
info.syntax = "include <filename>";
info.help = "Includes the file <filename>";
- mCommandDict[info.keyword] = info;
+ 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);
delete mExecuter;
//delete mFactory;
- // std::cout <<"EO Interpreter::~Interpreter()"<<std::endl;
bbtkDebugDecTab("Interpreter",9);
}
//=======================================================================
/**
*
*/
- void Interpreter::InterpretFile( const std::string& filename, bool use_configuration_file, bool verbose)
+ void Interpreter::InterpretFile( const std::string& filename,
+ bool use_configuration_file)
{
bbtkDebugMessageInc("Interpreter",9,"Interpreter::InterpretFile(\""<<filename<<"\")"<<std::endl);
try
{
- SwitchToFile(filename, use_configuration_file, verbose);
+ SwitchToFile(filename, use_configuration_file);
bool insideComment = false; // for multiline comment
while (mFile.size()>0)
{
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;
mExecuter->Author(words[1]);
break;
- case cKeyword :
- mExecuter->Keyword(words[1]);
+ case cCategory :
+ mExecuter->Category(words[1]);
break;
case cIndex :
break;
case cConfig :
- if (words.size()>1) // any param for config means verbose = true
- verbose = true;
- else
- verbose = false;
- Config(verbose);
+ Config();
break;
case cReset : // EED
case cInclude :
if (mCommandLine)
{
- InterpretFile(words[1], true, verbose); // true : better pass use_config_file
+ InterpretFile(words[1], true ); // true : better pass use_config_file
}
else
{
- SwitchToFile(words[1], true, verbose); // true : better pass use_config_file
+ SwitchToFile(words[1], true ); // true : better pass use_config_file
}
break;
case cLoad:
- LoadPackage(words[1], true, verbose); // true : better pass use_config_file
+ LoadPackage(words[1], true ); // true : better pass use_config_file
break;
case cUnload:
// Replaces substrings "\\n" by a real carriage return "\n"
void SubsBackslashN ( std::string& s )
{
- // std::cout << "BEFORE=["<<s<<"]"<<std::endl;
std::string ss("\\n");
std::string::size_type pos = 0;
pos = s.find(ss,0);
char* cr = "\n";
while ( pos != std::string::npos )
{
- // std::cout << "*** find one "<<std::endl;
s.replace(pos,2,cr,1);
pos = s.find(ss, pos-1);
}
- // std::cout << "AFTER=["<<s<<"]"<<std::endl;
}
//=======================================================================
{
// Found a text token, add it to the vector.
chains.push_back(str.substr(lastPos, pos - lastPos));
- // std::cout << "text='"<<chains.back()<<"'"<<std::endl;
}
else
{
tok = str.substr(lastPos, pos - lastPos);
Utilities::SplitAroundFirstDot(tok,box,output);
chains.push_back( mExecuter->Get(box,output) );
- // std::cout << "outp='"<<chains.back()<<"'"<<std::endl;
}
// Skip delimiters. Note the "not_of"
lastPos = str.find_first_not_of(delimiters, pos);
//
is_text = !is_text;
}
- // std::cout << "nb="<<chains.size()<<std::endl;
std::vector<std::string>::iterator i;
for (i= chains.begin(); i!=chains.end(); ++i)
{
// ===================================================================================
void Interpreter::SwitchToFile( const std::string& name,
- bool use_configuration_file, bool verbose)
+ bool use_configuration_file )
{
// Note : in the following :
// name : the user supplied name
bbtkDebugMessageInc("Interpreter",9,"Interpreter::SwitchToFile( \""
<<name<<"\")"<<std::endl);
-// to be removed in final version
-// use : Config v
-//verbose = true;
std::vector<std::string> script_paths;
std::string fullPathScriptName; // full path script name
std::string pkgname; // e.g. <scriptname>.bbs
// The following is *NOT* a debug time message :
// It's a user intended message.
// Please don't remove it.
- if (verbose)
- std::cout << "look for : [" << name << "] (use_configuration_file == TRUE)" << std::endl;
+ bbtkMessage("Interpreter",1,
+ "look for : [" << name
+ << "] (use_configuration_file == TRUE)" << std::endl);
script_paths = ConfigurationFile::GetInstance().Get_bbs_paths();
}
std::string upath;
pkgname = Utilities::ExtractScriptName(name,upath);
-//std::cout <<"name [" << name << "] pkgname [" << pkgname << "] upath [" << upath << "]" << std::endl;
+
bool fullnameGiven = false;
bool foundFile = false;
nbBssFiles++;
}
if (nbBssFiles==0)
- if (verbose)
- std::cout << "WARNING : No '.bbs' file found in [" << upath << "]" << std::endl;
+ bbtkMessage("Interpreter",2,
+ "WARNING : No '.bbs' file found in ["
+ << upath << "]" << std::endl);
return;
}
}
fullDirectoryName = Utilities::MakePkgnameFromPath(path, upath, false);
-//std::cout <<"fullpath [" << fullDirectoryName << "]" <<std::endl;
-// std::cout << "== "<<fullDirectoryName<<" =="<<std::endl;
-
// Check if library exists
if ( ! Utilities::IsDirectory(fullDirectoryName) )
// The following is *NOT* a debug time message :
// It's a user intended message.
// Please don't remove it.
- if (verbose)
- std::cout <<" [" <<fullDirectoryName <<"] : doesn't exist" <<std::endl;
+ bbtkMessage("Interpreter",1," [" <<fullDirectoryName
+ <<"] : doesn't exist" <<std::endl);
continue; // try next path
}
foundFile = true;
int nbFiles = Utilities::Explore(fullDirectoryName, false, Filenames);
-// std::cout << "=================nbFiles " << nbFiles << std::endl;
+
nbBssFiles = 0;
for (std::vector<std::string>::iterator i = Filenames.begin(); i!= Filenames.end(); ++i)
{
- // std::cout << "=== "<<*i<<" =="<<std::endl;
+
if ((*i).substr((*i).size()-4, 4) != ".bbs")
continue; // ignore non .bbs files
LoadScript(*i);
nbBssFiles++;
}
if (nbBssFiles==0)
- if (verbose)
- std::cout << "WARNING : No '.bbs' file found in [" << fullDirectoryName << "]" << std::endl;
+ bbtkMessage("Interpreter",1,
+ "WARNING : No '.bbs' file found in ["
+ << fullDirectoryName << "]" << std::endl);
//break; // a directory was found; we stop iterating
// LG : No! We want all files included !
// ===========================================================check user supplied location
fullnameGiven = true;
- fullPathScriptName = Utilities::ExpandLibName(name, verbose);
+
+ fullPathScriptName = Utilities::ExpandLibName(name, false);
// allow user to always forget ".bbs"
int l = fullPathScriptName.size();
// fullPathScriptName = Utilities::MakePkgnameFromPath(path, name, true); //pkgname);
fullPathScriptName = Utilities::MakePkgnameFromPath(path, name, true);
-//std::cout << "FULL PATH = "<<fullPathScriptName<<std::endl;
+
// Check if library exists
if ( ! Utilities::FileExists(fullPathScriptName) )
// The following is *NOT* a debug time message :
// It's a user intended message.
// Please don't remove it.
- if (verbose)
- std::cout <<" [" <<fullPathScriptName <<"] : doesn't exist" <<std::endl;
+ bbtkMessage("Interpreter",2,
+ " [" <<fullPathScriptName <<"] : doesn't exist"
+ <<std::endl);
continue; // try next path
}
- if (verbose)
- std::cout <<" [" <<fullPathScriptName <<"] : found" <<std::endl;
+ bbtkMessage("Interpreter",2,
+ " [" <<fullPathScriptName
+ <<"] : found" <<std::endl);
foundFile = true;
break; // a script was found; we stop iterating
if (find(mFileName.begin(),mFileName.end(),fullPathScriptName)
!=mFileName.end())
{
- bbtkMessage("Interpreter",1,"file '"<<fullPathScriptName<<"' already open : do not open it once more to prevent recursive inclusion"<<std::endl);
+ bbtkMessage("Interpreter",1,"file '"<<fullPathScriptName
+ <<"' already open : I do not open it once more to prevent recursive inclusion"<<std::endl);
return;
}
- bbtkMessage("Interpreter",1,fullPathScriptName<<" found"<<std::endl);
-
std::ifstream* s;
s = new std::ifstream;
s->open(fullPathScriptName.c_str());
return;
}
- //if (verbose)
- std::cout << " -->[" << fullPathScriptName << "] found" << std::endl;
+ bbtkMessage("Interpreter",1," -->[" << fullPathScriptName
+ << "] found" << std::endl);
mFile.push_back(s);
mFileName.push_back(fullPathScriptName);
{
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() ) {
//===================================================================
/// Displays the Configuration
- void Interpreter::Config( bool verbose ) const
+ void Interpreter::Config() const
{
- bbtkDebugMessageInc("Core",9,"Factory::Config"<<std::endl);
+ bbtkDebugMessageInc("Kernel",9,"Factory::Config"<<std::endl);
ConfigurationFile cf = ConfigurationFile::GetInstance();
bbtkMessage("Help",1,"--- ["<<*i<<"]"<<std::endl);
}
- bbtkDebugDecTab("Core",9);
+ bbtkDebugDecTab("Kernel",9);
}
//=======================================================================
{
Factory::IndexEntryType t;
if (type=="Initials") t = Factory::Initials;
- else if (type=="Keywords") t = Factory::Keywords;
+ else if (type=="Categories") t = Factory::Categories;
else if (type=="Packages") t = Factory::Packages;
GetGlobalFactory()->CreateHtmlIndex(t,filename);