1 /*=========================================================================
4 Module: $RCSfile: bbtkInterpreter.cxx,v $ $
6 Date: $Date: 2008/01/29 13:34:59 $
7 Version: $Revision: 1.9 $
9 Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
10 l'Image). All rights reserved. See Doc/License.txt or
11 http://www.creatis.insa-lyon.fr/Public/bbtk/License.html for details.
13 This software is distributed WITHOUT ANY WARRANTY; without even
14 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 PURPOSE. See the above copyright notices for more information.
17 =========================================================================*/
20 * \brief class Interpreter :
23 #include "bbtkInterpreter.h"
24 #include "bbtkMessageManager.h"
25 #include "bbtkConfigurationFile.h"
26 #include "bbtkWxConsole.h"
27 #include "bbtkUtilities.h"
29 #ifdef CMAKE_HAVE_TERMIOS_H
31 #define BBTK_USE_TERMIOS_BASED_PROMPT
39 Interpreter* Interpreter::mGlobalInterpreter = NULL;
41 //=======================================================================
45 Interpreter::Interpreter()
47 mCommandLine(false), verbose(false)
49 bbtk::MessageManager::RegisterMessageType("Echo","Level>0 : Prints the 'echo' commands of the user.\n\tLevel>1 : Prints the command being interpreted",1);
50 bbtk::MessageManager::RegisterMessageType("Interpreter","Messages of the interpreter",0);
51 bbtkDebugMessageInc("Interpreter",9,"Interpreter::Interpreter()" <<std::endl);
53 mGlobalInterpreter = this;
55 // mFactory = new bbtk::Factory();
56 mExecuter = new bbtk::Executer();
57 //mExecuter->SetFactory(mFactory);
59 // Builds the commands dict
66 info.syntax = "new <type> <name>";
67 info.help = "Creates a new black box of type <type> with name <name>";
68 mCommandDict[info.keyword] = info;
70 info.keyword = "delete";
74 info.syntax = "delete <box>";
75 info.help = "Deletes the black box of name <box>";
76 mCommandDict[info.keyword] = info;
78 info.keyword = "connect";
82 info.syntax = "connect <box1.output> <box2.input>";
83 info.help = "Connects the ouput <output> of black box <box1> to the input <input> of black box <box2>";
84 mCommandDict[info.keyword] = info;
86 info.keyword = "print";
90 info.syntax = "print <string>";
91 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').";
92 mCommandDict[info.keyword] = info;
94 info.keyword = "exec";
98 info.syntax = "exec <box | 'freeze' | 'unfreeze' >";
99 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.";
100 mCommandDict[info.keyword] = info;
102 info.keyword = "package";
105 info.code = cPackage;
106 info.syntax = "package <name>";
107 info.help = "Begins the definition of a package.";
108 mCommandDict[info.keyword] = info;
110 info.keyword = "endpackage";
113 info.code = cEndPackage;
114 info.syntax = "endpackage";
115 info.help = "Ends the definition of a package.";
116 mCommandDict[info.keyword] = info;
118 info.keyword = "define";
122 info.syntax = "define <type> [<package>]";
123 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.";
124 mCommandDict[info.keyword] = info;
126 info.keyword = "endefine";
129 info.code = cEndDefine;
130 info.syntax = "endefine";
131 info.help = "Ends the definition of a new type of complex black box";
132 mCommandDict[info.keyword] = info;
134 info.keyword = "input";
138 info.syntax = "input <name> <box.input> <help>";
139 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";
140 mCommandDict[info.keyword] = info;
142 info.keyword = "output";
146 info.syntax = "output <name> <box.output> <help>";
147 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";
148 mCommandDict[info.keyword] = info;
150 info.keyword = "set";
154 info.syntax = "set <box.input> <value>";
155 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";
156 mCommandDict[info.keyword] = info;
158 info.keyword = "config"; // JPR
162 info.syntax = "config [<verbose>|<v>]";
163 info.help = "Prints the value of all configuration parameters";
164 mCommandDict[info.keyword] = info;
166 info.keyword = "reset"; //EED
170 info.syntax = "reset";
171 info.help = "Deletes all boxes and unloads all packages (bbi is reset to its start state)";
172 mCommandDict[info.keyword] = info;
174 info.keyword = "author";
178 info.syntax = "author <string>";
179 info.help = "Adds the string <string> to the author information of the black box being defined";
180 mCommandDict[info.keyword] = info;
182 info.keyword = "description";
185 info.code = cDescription;
186 info.syntax = "description <string>";
187 info.help = "Adds the string <string> to the descriptive information of the black box being defined";
188 mCommandDict[info.keyword] = info;
190 info.keyword = "help";
194 info.syntax = "help";
195 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>";
196 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.";
197 mCommandDict[info.keyword] = info;
199 info.keyword = "message";
202 info.code = cMessage;
203 info.syntax = "message <category> <level>";
204 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.";
205 mCommandDict[info.keyword] = info;
207 info.keyword = "include";
210 info.code = cInclude;
211 info.syntax = "include <filename>";
212 info.help = "Includes the file <filename>";
213 mCommandDict[info.keyword] = info;
215 info.keyword = "quit";
219 info.syntax = "quit";
220 info.help = "Quits the program (during script execution it stops the complete execution)";
221 mCommandDict[info.keyword] = info;
223 info.keyword = "load";
227 info.syntax = "load <packagename>";
228 info.help = "Loads the black box package <packagename>";
229 mCommandDict[info.keyword] = info;
231 info.keyword = "unload";
235 info.syntax = "unload <packagename>";
236 info.help = "Unloads the black box package <packagename>";
237 mCommandDict[info.keyword] = info;
239 info.keyword = "graph";
243 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 ]]]]]]";
244 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')";
245 mCommandDict[info.keyword] = info;
248 info.keyword = "workspace";
251 info.code = cWorkspace;
252 info.syntax = "workspace < ( freeze | unfreeze ) | ( rename <newname> ) >";
253 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.";
254 mCommandDict[info.keyword] = info;
257 bbtkDebugDecTab("Interpreter",9);
260 //=======================================================================
264 //=======================================================================
268 Interpreter::~Interpreter()
270 bbtkDebugMessageInc("Interpreter",9,"Interpreter::~Interpreter()" <<std::endl);
274 // std::cout <<"EO Interpreter::~Interpreter()"<<std::endl;
275 bbtkDebugDecTab("Interpreter",9);
277 //=======================================================================
280 //=======================================================================
284 void Interpreter::InterpretFile( const std::string& filename, bool use_configuration_file, bool verbose)
286 bbtkDebugMessageInc("Interpreter",9,"Interpreter::InterpretFile(\""<<filename<<"\")"<<std::endl);
288 bool exm = mCommandLine;
289 mCommandLine = false;
293 SwitchToFile(filename, use_configuration_file, verbose);
294 bool insideComment = false; // for multiline comment
295 while (mFile.size()>0)
297 while ((mFile.size()>0) &&
298 (!mFile.back()->eof()))
302 mFile.back()->getline(buf,500);
304 std::string str(buf);
305 int size=str.length();
306 if ( str[ size-1 ]==13 )
311 InterpretLine(str, insideComment);
313 //if (mFile.size()>0)
317 catch (QuitException e)
320 catch (bbtk::Exception e)
322 std::cerr << "* ERROR : "<<e.GetMessage()<<std::endl;
323 if (mFileName.size()) {
324 std::cerr << "* FILE : \""<<mFileName.back()<<"\""<<std::endl;
325 std::cerr << "* LINE : "<<mLine.back()<<std::endl;
328 catch (std::exception& e)
330 std::cerr << "* ERROR : "<<e.what()<<" (not in bbtk)"<<std::endl;
331 if (mFileName.size()) {
332 std::cerr << "* FILE : \""<<mFileName.back()<<"\""<<std::endl;
333 std::cerr << "* LINE : "<<mLine.back()<<std::endl;
338 std::cout << "* UNDEFINED ERROR (not a bbtk nor a std exception)"<<std::endl;
339 if (mFileName.size()) {
340 std::cout << "* FILE : \""<<mFileName.back()<<"\""<<std::endl;
341 std::cout << "* LINE : "<<mLine.back()<<std::endl;
346 bbtkDebugMessage("Interpreter",9,"EO Interpreter::InterpretFile(\""<<filename<<"\")"<<std::endl);
347 bbtkDecTab("Interpreter",9);
351 //=======================================================================
355 //=======================================================================
359 void Interpreter::InterpretLine( const std::string& line, bool &insideComment )
362 bbtkDebugMessageInc("Interpreter",9,"Interpreter::InterpretLine(\""<<line<<"\")"<<std::endl);
363 bbtkMessage("Echo",2,"\""<<line<<"\""<<std::endl);
365 std::vector<std::string> words;
366 SplitLine(line,words);
371 bbtkDebugDecTab("Interpreter",9);
375 // Single line comment : # or //
376 if ( words[0][0]=='#' || (words[0][0]=='/' && words[0][1]=='/') )
378 bbtkDebugDecTab("Interpreter",9);
379 bbtkMessage("Interpreter",9,"Comment"<<std::endl);
383 // Multi line comment ( /* ... */ ) -delimiters on different lines !-
385 if (words[0][0]=='/' && words[0][1]=='*')
387 bbtkDebugDecTab("Interpreter",9);
388 bbtkMessage("Interpreter",9,"In multiline comment"<<std::endl);
389 insideComment = true;
393 if (words[0][0]=='*' && words[0][1]=='/')
395 bbtkDebugDecTab("Interpreter",9);
396 bbtkMessage("Interpreter",9,"Out multiline comment"<<std::endl);
397 if ( !insideComment ) {
398 bbtkDebugDecTab("Interpreter",9);
399 bbtkMessage("Interpreter",9,"Comment mismatch : '*/' with no matching '/*'"<<std::endl);
401 insideComment = false;
407 bbtkDebugDecTab("Interpreter",9);
408 bbtkMessage("Interpreter",9,"Multiline Comment"<<std::endl);
413 CommandInfoType command;
414 InterpretCommand(words,command);
416 bbtkDebugMessage("Interpreter",9,
417 "Command='"<<command.keyword
418 <<"' code="<<command.code<<std::endl);
420 std::string left,right,left2,right2;
421 std::string filename;
422 switch (command.code)
425 mExecuter->Create(words[1],words[2]);
430 // mExecuter->Remove(words[1]);
434 Utilities::SplitAroundFirstDot(words[1],left,right);
435 Utilities::SplitAroundFirstDot(words[2],left2,right2);
436 mExecuter->Connect(left,right,left2,right2);
440 mExecuter->BeginPackage(words[1]);
444 mExecuter->EndPackage();
448 if (mFileName.size()>0)
450 filename = Utilities::get_file_name(mFileName.back());
454 mExecuter->Define(words[1],"",filename);
458 mExecuter->Define(words[1],words[2],filename);
463 mExecuter->EndDefine();
467 Print(words[1]); /// \todo use mExecuter
471 if (words[1]=="freeze")
472 mExecuter->SetNoExecMode(true);
473 else if (words[1]=="unfreeze")
474 mExecuter->SetNoExecMode(false);
476 mExecuter->Update(words[1]);
480 Utilities::SplitAroundFirstDot(words[2],left,right);
481 mExecuter->DefineInput(words[1],left,right,words[3]);
485 Utilities::SplitAroundFirstDot(words[2],left,right);
486 mExecuter->DefineOutput(words[1],left,right,words[3]);
490 Utilities::SplitAroundFirstDot(words[1],left,right);
491 mExecuter->Set(left,right,words[2]);
495 mExecuter->Author(words[1]);
499 mExecuter->Description(words[1]);
509 bbtk::MessageManager::PrintInfo();
513 sscanf(words[2].c_str(),"%d",&level);
514 bbtk::MessageManager::SetMessageLevel(words[1],level);
523 if (words.size()>1) // any param for config means verbose = true
531 this->mExecuter->Reset();
537 InterpretFile(words[1], true, verbose); // true : better pass use_config_file
541 SwitchToFile(words[1], true, verbose); // true : better pass use_config_file
546 LoadPackage(words[1], true, verbose); // true : better pass use_config_file
550 UnLoadPackage(words[1]);
554 throw QuitException();
558 if (words.size() == 2)
560 if (words[1]=="freeze") mExecuter->SetNoExecMode(true);
561 else if (words[1]=="unfreeze") mExecuter->SetNoExecMode(false);
565 mExecuter->SetWorkspaceName(words[2]);
570 bbtkInternalError("should not reach here !!!");
573 bbtkDecTab("Interpreter",9);
575 //=======================================================================
579 //=======================================================================
580 void SplitString ( const std::string& str, const std::string& delimiters,
581 std::vector<std::string>& tokens)
583 // Skip delimiters at beginning.
584 std::string::size_type lastPos = str.find_first_not_of(delimiters, 0);
585 // Find first delimiter.
586 std::string::size_type pos = str.find_first_of(delimiters, lastPos);
588 while (std::string::npos != pos || std::string::npos != lastPos)
590 // Found a token, add it to the vector.
591 tokens.push_back(str.substr(lastPos, pos - lastPos));
592 // Skip delimiters. Note the "not_of"
593 lastPos = str.find_first_not_of(delimiters, pos);
594 // Find next delimiter
595 pos = str.find_first_of(delimiters, lastPos);
599 //=======================================================================
603 //=======================================================================
607 void Interpreter::SplitLine ( const std::string& str, std::vector<std::string>& tokens)
609 bbtkDebugMessageInc("Interpreter",9,"Interpreter::SplitLine(\""<<str<<"\")"<<std::endl);
611 std::string delimiters = "\"";
612 std::vector<std::string> quote;
613 SplitString(str,delimiters,quote);
616 std::vector<std::string>::iterator i;
617 for (i=quote.begin(); i!=quote.end(); )
619 SplitString(*i,delimiters,tokens);
623 // bbtkDebugMessage("Interpreter",0,"\""<<*i<<"\""<<std::endl);
624 tokens.push_back(*i);
629 for (i=tokens.begin(); i!=tokens.end(); ++i)
631 bbtkDebugMessage("Interpreter",9,"["<<*i<<"] ");
633 bbtkDebugMessageCont("Interpreter",9,std::endl);
635 bbtkDebugDecTab("Interpreter",9);
637 //=======================================================================
640 //=======================================================================
641 // Replaces substrings "\\n" by a real carriage return "\n"
642 void SubsBackslashN ( std::string& s )
644 // std::cout << "BEFORE=["<<s<<"]"<<std::endl;
645 std::string ss("\\n");
646 std::string::size_type pos = 0;
649 while ( pos != std::string::npos )
651 // std::cout << "*** find one "<<std::endl;
652 s.replace(pos,2,cr,1);
653 pos = s.find(ss, pos-1);
655 // std::cout << "AFTER=["<<s<<"]"<<std::endl;
657 //=======================================================================
660 //=======================================================================
664 void Interpreter::Print( const std::string& str)
666 if (mExecuter->GetNoExecMode()) return;
668 bbtkDebugMessageInc("Interpreter",9,"Interpreter::SplitLine(\""<<str<<"\")"<<std::endl);
670 std::vector<std::string> chains;
671 std::string delimiters("$");
673 // Skip delimiters at beginning.
674 std::string::size_type lastPos = str.find_first_not_of(delimiters, 0);
676 if (lastPos>0) is_text = false;
678 // Find first delimiter.
679 std::string::size_type pos = str.find_first_of(delimiters, lastPos);
681 while (std::string::npos != pos || std::string::npos != lastPos)
685 // Found a text token, add it to the vector.
686 chains.push_back(str.substr(lastPos, pos - lastPos));
687 // std::cout << "text='"<<chains.back()<<"'"<<std::endl;
691 // is an output (between $$) : decode
692 std::string tok,box,output;
693 tok = str.substr(lastPos, pos - lastPos);
694 Utilities::SplitAroundFirstDot(tok,box,output);
695 chains.push_back( mExecuter->Get(box,output) );
696 // std::cout << "outp='"<<chains.back()<<"'"<<std::endl;
698 // Skip delimiters. Note the "not_of"
699 lastPos = str.find_first_not_of(delimiters, pos);
700 // Find next delimiter
701 pos = str.find_first_of(delimiters, lastPos);
705 // std::cout << "nb="<<chains.size()<<std::endl;
706 std::vector<std::string>::iterator i;
707 for (i= chains.begin(); i!=chains.end(); ++i)
709 // bbtkMessage("Echo",1,*i);
713 std::cout << std::endl;
714 bbtkDebugDecTab("Interpreter",9);
717 //=======================================================================
722 // ===================================================================================
724 void Interpreter::SwitchToFile( const std::string& name,
725 bool use_configuration_file, bool verbose)
727 // Note : in the following :
728 // name : the user supplied name
729 // - abreviated name e.g. scr scr.bbs
730 // - relative full name e.g. ./scr.bbs ../../scr.bbs
731 // - absolute full name e.g. /home/usrname/proj/dir/scr.bbs
732 // same for Windows, with c:, d: ...
734 // expression like directory/subdir/scrname.bbs is FORBIDDEN (*)
735 // use ./directory/subdir/scrname.bbs
737 // (*) except when using packagename/boxes/*
739 bbtkDebugMessageInc("Interpreter",9,"Interpreter::SwitchToFile( \""
740 <<name<<"\")"<<std::endl);
742 // to be remove in final version
745 std::vector<std::string> script_paths;
746 std::string fullPathScriptName; // full path script name
747 std::string pkgname; // e.g. <scriptname>.bbs
749 if (use_configuration_file)
751 // The following is *NOT* a debug time message :
752 // It's a user intended message.
753 // Please don't remove it.
755 std::cout << "look for : [" << name << "] (use_configuration_file == TRUE)" << std::endl;
756 script_paths = ConfigurationFile::GetInstance().Get_bbs_paths();
759 pkgname = Utilities::ExtractScriptName(name,upath);
761 bool fullnameGiven = false;
762 bool foundFile = false;
764 if(pkgname == "*") // =========================================== load all boxes (e.g. std/boxes/*)
767 std::vector<std::string>::iterator i;
768 std::string fullDirectoryName;
769 for (i=script_paths.begin();i!=script_paths.end();++i)
773 // we *really* want '.' to be the current working directory
775 char buf[2048]; // for getcwd
776 char * currentDir = getcwd(buf, 2048);
777 std::string cwd(currentDir);
781 fullDirectoryName = Utilities::MakePkgnameFromPath(path, upath, false);
782 //std::cout <<"fullpath [" << fullDirectoryName << "]" <<std::endl;
783 // Check if library exists
784 if ( ! Utilities::IsDirectory(fullDirectoryName) )
786 // The following is *NOT* a debug time message :
787 // It's a user intended message.
788 // Please don't remove it.
790 std::cout <<" [" <<fullDirectoryName <<"] : doesn't exist" <<std::endl;
791 continue; // try next path
795 std::cout << "recherche tous les .bbs du directory" << std::endl;
796 std::cout << "pour chacun, LoadScript" << std::endl;
798 std::vector<std::string> Filenames;
799 int nbFiles = Utilities::Explore(fullDirectoryName, false, Filenames);
800 // std::cout << "=================nbFiles " << nbFiles << std::endl;
802 for (std::vector<std::string>::iterator i = Filenames.begin(); i!=Filenames.end(); ++i)
804 if ((*i).substr((*i).size()-4, 4) != ".bbs")
805 continue; // ignore non .bbs files
811 std::cout << "WARNING : No '.bbs' file found in [" << fullDirectoryName << "]" << std::endl;
813 break; // a directory was found; we stop iterating
818 std::string::size_type slash_position = name.find_last_of("/\\");
820 // if name contains a slash (anywhere), user is assumed to have passed a relative/absolute name
821 // (not only a plain script name)
822 // we trust him, and try to explade the directory name
823 // WARNING : starting from current local directory : ./whatYouWant (./ mandatory!)
825 if (slash_position != std::string::npos)
828 // ===========================================================check user supplied location
829 fullnameGiven = true;
831 fullPathScriptName = Utilities::ExpandLibName(name, verbose);
833 // allow user to always forget ".bbs"
834 int l = fullPathScriptName.size();
839 if (fullPathScriptName.substr(l-4, 4) != ".bbs")
841 fullPathScriptName = fullPathScriptName + ".bbs";
846 fullPathScriptName = fullPathScriptName + ".bbs";
849 //if (fullPathScriptName != "") {
850 if ( Utilities::FileExists(fullPathScriptName))
858 // =============================================================== iterate on the paths
860 std::cout << "iterate"<<std::endl;
862 std::vector<std::string>::iterator i;
863 for (i=script_paths.begin();i!=script_paths.end();++i)
867 std::cout << "CUR=["<<path<<"]"<<std::endl;
868 // we *really* want '.' to be the current working directory
870 std::cout << "PATH IS CURRENT"<<std::endl;
871 char buf[2048]; // for getcwd
872 char * currentDir = getcwd(buf, 2048);
873 std::string cwd(currentDir);
877 // fullPathScriptName = Utilities::MakePkgnameFromPath(path, name, true); //pkgname);
879 fullPathScriptName = Utilities::MakePkgnameFromPath(path, pkgname, true);
880 std::cout << "FULL PATH = "<<fullPathScriptName<<std::endl;
882 // Check if library exists
883 if ( ! Utilities::FileExists(fullPathScriptName) )
885 // The following is *NOT* a debug time message :
886 // It's a user intended message.
887 // Please don't remove it.
889 std::cout <<" [" <<fullPathScriptName <<"] : doesn't exist" <<std::endl;
890 continue; // try next path
893 break; // a script was found; we stop iterating
895 } //------------------ // end for ( package_paths.begin();i!=package_paths.end() )
901 if(fullPathScriptName == "")
902 bbtkError("Path ["<<upath<<"] doesn't exist");
904 bbtkError("Script ["<<fullPathScriptName<<"] not found");
906 bbtkError("No ["<<pkgname<<".bbs] script found");
910 LoadScript(fullPathScriptName);
916 //=======================================================================
918 void Interpreter::LoadScript( std::string fullPathScriptName)
920 bbtkMessage("Interpreter",1,fullPathScriptName<<" found"<<std::endl);
923 s = new std::ifstream;
924 s->open(fullPathScriptName.c_str());
927 bbtkError("Could not open file ["<<fullPathScriptName<<"]");
932 std::cout << " -->[" << fullPathScriptName << "] found" << std::endl;
935 mFileName.push_back(fullPathScriptName);
940 //=======================================================================
944 void Interpreter::CloseCurrentFile()
946 bbtkDebugMessage("Interpreter",9,"Interpreter::CloseCurrentFile()"
951 bbtkDebugMessage("Interpreter",9," -> no file left open"<<std::endl);
955 mFile.back()->close();
958 bbtkDebugMessage("Interpreter",9,
959 " Closing file '"<<mFileName.back()<<"'"<<std::endl);
961 mFileName.pop_back();
963 bbtkDebugMessage("Interpreter",9," Remains "
965 <<" open"<<std::endl);
966 bbtkDebugMessage("Interpreter",9,"EO Interpreter::CloseCurrentFile()"
969 //=======================================================================
971 //=======================================================================
975 void Interpreter::CloseAllFiles()
977 bbtkDebugMessage("Interpreter",9,"Interpreter::CloseAllFiles()"
980 while (mFile.size() != 0)
982 mFile.back()->close();
985 bbtkDebugMessage("Interpreter",9,
986 " Closing file '"<<mFileName.back()<<"'"<<std::endl);
987 mFileName.pop_back();
990 bbtkDebugMessage("Interpreter",9,"EO Interpreter::CloseAllFiles()"
993 //=======================================================================
997 //=======================================================================
1001 void Interpreter::InterpretCommand( const std::vector<std::string>& words,
1002 CommandInfoType& info )
1004 bbtkDebugMessageInc("Interpreter",9,"Interpreter::InterpretCommand(...)"<<std::endl);
1006 // searches the command keyword
1007 CommandDictType::iterator c;
1008 c = mCommandDict.find(words[0]);
1009 if ( c == mCommandDict.end() ) {
1010 bbtkError(words[0]<<" : unknown command");
1013 // tests the number of args
1014 if ( ( words.size()-1 < c->second.argmin ) ||
1015 ( words.size()-1 > c->second.argmax ) )
1017 HelpCommand(words[0]);
1018 bbtkError(words[0]<<" : wrong number of arguments");
1022 bbtkDecTab("Interpreter",9);
1024 //=======================================================================
1027 //=======================================================================
1028 /// Displays help on all the commands
1029 void Interpreter::Help(const std::vector<std::string>& words)
1031 unsigned int nbarg = words.size()-1;
1039 if (words[1]=="packages")
1041 PrintPackages(true);
1046 HelpCommand(words[1]);
1048 catch (bbtk::Exception e)
1052 HelpPackage(words[1]);
1054 catch (bbtk::Exception f)
1058 HelpBlackBox(words[1]);
1060 catch (bbtk::Exception g)
1064 this->mExecuter->ShowRelations(words[1],"0","9999");
1066 catch (bbtk::Exception h){
1067 bbtkError("\""<<words[1].c_str()
1068 <<"\" is not a known command, package, black box type or black box name");
1076 if (words[2]=="all")
1078 if ( words[1]=="packages" )
1080 PrintPackages(true,true);
1085 HelpPackage(words[1],true);
1087 catch (bbtk::Exception f)
1093 HelpCommand(words[0]);
1094 bbtkError(words[0]<<" : syntax error");
1099 bbtkError("Should not reach here !!!");
1102 //=======================================================================
1104 //===================================================================
1105 /// Displays the Configuration
1106 void Interpreter::Config( bool verbose ) const
1108 bbtkDebugMessageInc("Core",9,"Factory::Config"<<std::endl);
1110 ConfigurationFile cf = ConfigurationFile::GetInstance();
1112 const std::string config_xml_full_path = cf.Get_config_xml_full_path();
1113 const std::string description = cf.Get_description();
1114 const std::string url = cf.Get_url();
1115 const std::string data_path = cf.Get_data_path();
1116 const std::string default_doc_tmp = cf.Get_default_doc_tmp();
1117 const std::string file_separator = cf.Get_file_separator();
1118 const std::vector<std::string>bbs_paths = cf.Get_bbs_paths();
1119 const std::vector<std::string>package_paths = cf.Get_package_paths();
1121 bbtkMessage("Help",1, "=============" << std::endl);
1122 bbtkMessage("Help",1, "Configuration" << std::endl);
1123 bbtkMessage("Help",1, "=============" << std::endl);
1124 bbtkMessage("Help",1, "bbtk_config.xml : [" << config_xml_full_path << "]" << std::endl);
1125 bbtkMessage("Help",1, "Documentation Url : [" << url << "]" << std::endl);
1126 bbtkMessage("Help",1, "Data Path : [" << data_path << "]" << std::endl);
1127 bbtkMessage("Help",1, "Default Doc_tmp : [" << default_doc_tmp << "]" << std::endl);
1128 bbtkMessage("Help",1, "File Separator : [" << file_separator << "]" << std::endl);
1130 std::vector<std::string>::const_iterator i;
1132 bbtkMessage("Help",1, "BBS Paths " << std::endl);
1133 for (i = bbs_paths.begin(); i!=bbs_paths.end(); ++i )
1135 bbtkMessage("Help",1,"--- ["<<*i<<"]"<<std::endl);
1138 bbtkMessage("Help",1, "PACKAGE Paths : " << std::endl);
1139 for (i = package_paths.begin(); i!=package_paths.end(); ++i )
1141 bbtkMessage("Help",1,"--- ["<<*i<<"]"<<std::endl);
1144 bbtkDebugDecTab("Core",9);
1147 //=======================================================================
1148 /// Displays help on all the commands
1149 void Interpreter::HelpCommands()
1151 std::cout << "Available commands :" << std::endl;
1152 CommandDictType::iterator i;
1153 for ( i = mCommandDict.begin();
1154 i != mCommandDict.end();
1156 std::cout << " " << i->first << std::endl;
1157 // std::cout << " usage : " << i->second.syntax << std::endl;
1158 // std::cout << " " << i->second.help << std::endl;
1162 //=======================================================================
1165 //=======================================================================
1166 /// Displays help on a particular commands
1167 void Interpreter::HelpCommand(const std::string& s)
1169 CommandDictType::iterator c;
1170 c = mCommandDict.find(s);
1171 if ( c == mCommandDict.end() ) {
1172 bbtkError(s<<" : Unknown command");
1174 // std::cout << " " << s << " : "<< std::endl;
1175 // CommandParamDictType::iterator i;
1176 // for ( i = c->second.begin();
1177 // i != c->second.end();
1179 std::cout << " usage : " << c->second.syntax << std::endl;
1180 std::cout << " " << c->second.help << std::endl;
1183 //=======================================================================
1186 //=======================================================================
1187 /// Fills the vector commands with the commands which
1188 /// have the first n chars of buf for prefix
1189 /// TODO : skip initial spaces in buf and also return the position of first
1190 /// non blank char in buf
1191 void Interpreter::FindCommandsWithPrefix( char* buf,
1193 std::vector<std::string>& commands )
1195 CommandDictType::const_iterator i;
1196 for (i=mCommandDict.begin(); i!=mCommandDict.end(); ++i)
1198 if ((i->first).find(buf,0,n) == 0)
1199 commands.push_back(i->first);
1202 //=======================================================================
1206 //=======================================================================
1207 #ifdef BBTK_USE_TERMIOS_BASED_PROMPT
1209 inline void PrintChar(char c) { write(STDOUT_FILENO,&c,1); }
1210 inline void BackSpace() { write(STDOUT_FILENO,"\b \b",3); }
1212 // LG : KEYBOARD CODES AS SCANNED ON MY TTY : UNIVERSAL ?
1213 // IF NOT THE USER SHOULD BE ABLE TO CONFIGURE IT
1214 // E.G. STORE THIS IN bbtk_config.xml
1215 #define BBTK_UP_ARROW_KBCODE 0x00415B1B
1216 #define BBTK_DOWN_ARROW_KBCODE 0x00425B1B
1217 #define BBTK_RIGHT_ARROW_KBCODE 0x00435B1B
1218 #define BBTK_LEFT_ARROW_KBCODE 0x00445B1B
1219 #define BBTK_BACKSPACE_KBCODE 0x00000008
1220 #define BBTK_DEL_KBCODE 0x0000007F
1221 #define BBTK_SPACE_KBCODE 0x00000020
1223 //=======================================================================
1224 void Interpreter::GetLineFromPrompt(std::string& s)
1229 int MAX_LINE_SIZE = 160;
1230 int MAX_HISTORY_SIZE = 100;
1232 char* newline = new char[MAX_LINE_SIZE];
1233 memset(newline,0,MAX_LINE_SIZE);
1234 char* histline = new char[MAX_LINE_SIZE];
1235 memset(histline,0,MAX_LINE_SIZE);
1237 char* line = newline;
1238 int hist = mHistory.size();
1245 read ( STDIN_FILENO, &c, 4) ;
1247 bbtkDebugMessage("Debug",9,"[0x"<<std::hex<<c<<"]\n");
1249 // Printable character
1250 if ( (ind<MAX_LINE_SIZE-1) &&
1251 ( c >= BBTK_SPACE_KBCODE ) &&
1252 ( c < BBTK_DEL_KBCODE ))
1260 // delete the unused line
1266 // empty lines are not stored in from history
1269 // if history too long : delete oldest command
1270 if (mHistory.size()>MAX_HISTORY_SIZE)
1272 delete mHistory.front();
1273 mHistory.pop_front();
1275 mHistory.push_back(line);
1280 else if ( (ind>0) &&
1281 ((c == BBTK_BACKSPACE_KBCODE) ||
1282 (c == BBTK_DEL_KBCODE)) )
1290 // TODO : Command completion
1291 std::vector<std::string> commands;
1292 FindCommandsWithPrefix( line,ind,commands);
1293 if (commands.size()==1)
1295 std::string com = *commands.begin();
1296 for (; ind<com.size(); ++ind)
1298 PrintChar(com[ind]);
1304 else if (commands.size()>1)
1306 std::vector<std::string>::iterator i;
1308 for (i=commands.begin();i!=commands.end();++i)
1310 write(STDOUT_FILENO,(*i).c_str(),strlen((*i).c_str()));
1313 write(STDOUT_FILENO,"\n> ",3);
1314 //for (int j=0;j<ind;++j)
1316 write(STDOUT_FILENO,line,ind);
1320 // Arrow up : back in history
1321 else if (c==BBTK_UP_ARROW_KBCODE)
1325 // erase current line
1326 while (ind--) BackSpace();
1330 strcpy(histline,mHistory[hist]);
1334 write(STDOUT_FILENO,line,ind);
1337 // Arrow down : down in history
1338 else if (c==BBTK_DOWN_ARROW_KBCODE)
1340 if (hist<mHistory.size()-1)
1342 // erase current line
1343 while (ind--) BackSpace();
1347 strcpy(histline,mHistory[hist]);
1351 write(STDOUT_FILENO,line,ind);
1353 // end of history : switch back to newline
1354 else if (hist==mHistory.size()-1)
1356 // erase current line
1357 while (ind--) BackSpace();
1364 write(STDOUT_FILENO,line,ind);
1368 else if (line[ind]!=0 && c==BBTK_RIGHT_ARROW_KBCODE)
1370 PrintChar(line[ind]);
1375 else if (ind>0 && c==BBTK_LEFT_ARROW_KBCODE)
1383 write(STDOUT_FILENO,"\n\r",2);
1391 //=======================================================================
1392 void Interpreter::GetLineFromPrompt(std::string& s)
1418 //=======================================================================
1424 //=======================================================================
1425 void Interpreter::CommandLineInterpreter()
1427 bbtkDebugMessageInc("Interpreter",9,
1428 "Interpreter::CommandLineInterpreter()"<<std::endl);
1430 #ifdef BBTK_USE_TERMIOS_BASED_PROMPT
1431 // Initialise the tty in non canonical mode with no echo
1432 // oter remembers the previous settings to restore them after
1433 struct termios ter,oter;
1436 ter.c_lflag &= ~ECHO;
1437 ter.c_lflag &= ~ICANON;
1440 tcsetattr(0,TCSANOW,&ter);
1443 mCommandLine = true;
1445 bool insideComment = false; // for multiline comment
1451 GetLineFromPrompt(line);
1452 InterpretLine(line, insideComment);
1454 catch (QuitException e)
1458 catch (bbtk::Exception e)
1462 catch (std::exception& e)
1464 std::cerr << "* ERROR :: "<<e.what()<<" (not in bbtk)"<<std::endl;
1468 std::cerr << "* UNDEFINED ERROR (not a bbtk nor a std exception)"<<std::endl;
1473 #ifdef BBTK_USE_TERMIOS_BASED_PROMPT
1474 tcsetattr(0,TCSANOW,&oter);
1477 std::cout << "Good bye !" << std::endl;
1479 bbtkDebugDecTab("Interpreter",9);
1482 //=======================================================================
1483 void Interpreter::Graph(const std::vector<std::string>& words)
1486 bool system_display = true;
1488 #ifdef _USE_WXWIDGETS_
1489 if ( WxConsole::GetInstance() != 0 ) system_display = false;
1492 if (words.size()==1)
1494 page = mExecuter->ShowGraph(".","0","0","","","",system_display);
1496 else if (words.size()==2)
1498 page = mExecuter->ShowGraph(words[1],"0","0","","","",system_display);
1500 else if (words.size()==3)
1502 page = mExecuter->ShowGraph(words[1],words[2],"0","","","",system_display);
1504 else if (words.size()==4)
1506 page = mExecuter->ShowGraph(words[1],words[2],words[3],"","","",system_display);
1508 else if (words.size()==5)
1510 page = mExecuter->ShowGraph(words[1],words[2],words[3],words[4],"","",system_display);
1512 else if (words.size()==6)
1514 page = mExecuter->ShowGraph(words[1],words[2],words[3],words[4],words[5],"",system_display);
1516 else if (words.size()==7)
1518 page = mExecuter->ShowGraph(words[1],words[2],words[3],words[4],words[5],words[6],system_display);
1521 #ifdef _USE_WXWIDGETS_
1522 if ( WxConsole::GetInstance() != 0 )
1523 WxConsole::GetInstance()->ShowHtmlPage(page);
1526 //=======================================================================