1 /*=========================================================================
4 Module: $RCSfile: bbtkInterpreter.cxx,v $ $
6 Date: $Date: 2008/01/28 15:08:53 $
7 Version: $Revision: 1.6 $
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 bbtkDebugMessageInc("Interpreter",9,"Interpreter::SwitchToFile( \""
735 <<name<<"\")"<<std::endl);
737 std::vector<std::string> script_paths;
738 std::string libname; // full path library name
739 std::string pkgname; // e.g. <scriptname>.bbs
741 pkgname = Utilities::ExtractScriptName(name);
742 if (use_configuration_file)
745 std::cout << "look for : [" << name << "] (use_configuration_file == TRUE)" << std::endl;
746 script_paths = ConfigurationFile::GetInstance().Get_bbs_paths();
749 bool fullnameGiven = false;
750 bool foundFile = false;
751 std::string::size_type slash_position = name.find_last_of("/\\");
753 if (false) //slash_position != std::string::npos)
754 { // ------------------------------------- check user supplied location
755 fullnameGiven = true;
756 libname = Utilities::ExpandLibName(name, verbose);
758 // allow user to always forget ".bbs"
759 int l = libname.size();
762 if (libname.substr(l-4, 4) != ".bbs")
764 libname = libname + ".bbs";
769 libname = libname + ".bbs";
773 if ( Utilities::FileExists(libname))
779 else // ------------------------------------- iterate on the paths
782 std::vector<std::string>::iterator i;
783 for (i=script_paths.begin();i!=script_paths.end();++i)
787 // we *really* want '.' to be the current working directory
789 char buf[2048]; // for getcwd
790 char * currentDir = getcwd(buf, 2048);
791 std::string cwd(currentDir);
795 libname = Utilities::MakePkgnameFromPath(path, name); //pkgname);
796 // Check if library exists
797 if ( ! Utilities::FileExists(libname) )
799 // The following is *NOT* a debug time message :
800 // It's a user intended message.
801 // Please don't remove it.
803 std::cout <<" [" <<libname <<"] : doesn't exist" <<std::endl;
804 continue; // try next path
807 break; // a script was found; we stop iterating
809 } //------------------ // end for ( package_paths.begin();i!=package_paths.end() )
818 bbtkError("Path ["<<name<<"] doesn't exist");
820 bbtkError("Script ["<<libname<<"] not found");
822 bbtkError("No ["<<pkgname<<".bbs] script found");
826 bbtkMessage("Interpreter",1,pkgname<<" loaded"<<std::endl);
828 s = new std::ifstream;
829 s->open(libname.c_str());
832 bbtkError("Could not open file ["<<libname<<"]");
837 std::cout << " -->[" << libname << "] found" << std::endl;
840 mFileName.push_back(libname);
845 //=======================================================================
848 //=======================================================================
852 void Interpreter::CloseCurrentFile()
854 bbtkDebugMessage("Interpreter",9,"Interpreter::CloseCurrentFile()"
859 bbtkDebugMessage("Interpreter",9," -> no file left open"<<std::endl);
863 mFile.back()->close();
866 bbtkDebugMessage("Interpreter",9,
867 " Closing file '"<<mFileName.back()<<"'"<<std::endl);
869 mFileName.pop_back();
871 bbtkDebugMessage("Interpreter",9," Remains "
873 <<" open"<<std::endl);
874 bbtkDebugMessage("Interpreter",9,"EO Interpreter::CloseCurrentFile()"
877 //=======================================================================
879 //=======================================================================
883 void Interpreter::CloseAllFiles()
885 bbtkDebugMessage("Interpreter",9,"Interpreter::CloseAllFiles()"
888 while (mFile.size() != 0)
890 mFile.back()->close();
893 bbtkDebugMessage("Interpreter",9,
894 " Closing file '"<<mFileName.back()<<"'"<<std::endl);
895 mFileName.pop_back();
898 bbtkDebugMessage("Interpreter",9,"EO Interpreter::CloseAllFiles()"
901 //=======================================================================
905 //=======================================================================
909 void Interpreter::InterpretCommand( const std::vector<std::string>& words,
910 CommandInfoType& info )
912 bbtkDebugMessageInc("Interpreter",9,"Interpreter::InterpretCommand(...)"<<std::endl);
914 // searches the command keyword
915 CommandDictType::iterator c;
916 c = mCommandDict.find(words[0]);
917 if ( c == mCommandDict.end() ) {
918 bbtkError(words[0]<<" : unknown command");
921 // tests the number of args
922 if ( ( words.size()-1 < c->second.argmin ) ||
923 ( words.size()-1 > c->second.argmax ) )
925 HelpCommand(words[0]);
926 bbtkError(words[0]<<" : wrong number of arguments");
930 bbtkDecTab("Interpreter",9);
932 //=======================================================================
935 //=======================================================================
936 /// Displays help on all the commands
937 void Interpreter::Help(const std::vector<std::string>& words)
939 unsigned int nbarg = words.size()-1;
947 if (words[1]=="packages")
954 HelpCommand(words[1]);
956 catch (bbtk::Exception e)
960 HelpPackage(words[1]);
962 catch (bbtk::Exception f)
966 HelpBlackBox(words[1]);
968 catch (bbtk::Exception g)
972 this->mExecuter->ShowRelations(words[1],"0","9999");
974 catch (bbtk::Exception h){
975 bbtkError("\""<<words[1].c_str()
976 <<"\" is not a known command, package, black box type or black box name");
986 if ( words[1]=="packages" )
988 PrintPackages(true,true);
993 HelpPackage(words[1],true);
995 catch (bbtk::Exception f)
1001 HelpCommand(words[0]);
1002 bbtkError(words[0]<<" : syntax error");
1007 bbtkError("Should not reach here !!!");
1010 //=======================================================================
1012 //===================================================================
1013 /// Displays the Configuration
1014 void Interpreter::Config( bool verbose ) const
1016 bbtkDebugMessageInc("Core",9,"Factory::Config"<<std::endl);
1018 ConfigurationFile cf = ConfigurationFile::GetInstance();
1020 const std::string config_xml_full_path = cf.Get_config_xml_full_path();
1021 const std::string description = cf.Get_description();
1022 const std::string url = cf.Get_url();
1023 const std::string data_path = cf.Get_data_path();
1024 const std::string default_doc_tmp = cf.Get_default_doc_tmp();
1025 const std::string file_separator = cf.Get_file_separator();
1026 const std::vector<std::string>bbs_paths = cf.Get_bbs_paths();
1027 const std::vector<std::string>package_paths = cf.Get_package_paths();
1029 bbtkMessage("Help",1, "=============" << std::endl);
1030 bbtkMessage("Help",1, "Configuration" << std::endl);
1031 bbtkMessage("Help",1, "=============" << std::endl);
1032 bbtkMessage("Help",1, "bbtk_config.xml : [" << config_xml_full_path << "]" << std::endl);
1033 bbtkMessage("Help",1, "Documentation Url : [" << url << "]" << std::endl);
1034 bbtkMessage("Help",1, "Data Path : [" << data_path << "]" << std::endl);
1035 bbtkMessage("Help",1, "Default Doc_tmp : [" << default_doc_tmp << "]" << std::endl);
1036 bbtkMessage("Help",1, "File Separator : [" << file_separator << "]" << std::endl);
1038 std::vector<std::string>::const_iterator i;
1040 bbtkMessage("Help",1, "BBS Paths " << std::endl);
1041 for (i = bbs_paths.begin(); i!=bbs_paths.end(); ++i )
1043 bbtkMessage("Help",1,"--- ["<<*i<<"]"<<std::endl);
1046 bbtkMessage("Help",1, "PACKAGE Paths : " << std::endl);
1047 for (i = package_paths.begin(); i!=package_paths.end(); ++i )
1049 bbtkMessage("Help",1,"--- ["<<*i<<"]"<<std::endl);
1052 bbtkDebugDecTab("Core",9);
1055 //=======================================================================
1056 /// Displays help on all the commands
1057 void Interpreter::HelpCommands()
1059 std::cout << "Available commands :" << std::endl;
1060 CommandDictType::iterator i;
1061 for ( i = mCommandDict.begin();
1062 i != mCommandDict.end();
1064 std::cout << " " << i->first << std::endl;
1065 // std::cout << " usage : " << i->second.syntax << std::endl;
1066 // std::cout << " " << i->second.help << std::endl;
1070 //=======================================================================
1073 //=======================================================================
1074 /// Displays help on a particular commands
1075 void Interpreter::HelpCommand(const std::string& s)
1077 CommandDictType::iterator c;
1078 c = mCommandDict.find(s);
1079 if ( c == mCommandDict.end() ) {
1080 bbtkError(s<<" : Unknown command");
1082 // std::cout << " " << s << " : "<< std::endl;
1083 // CommandParamDictType::iterator i;
1084 // for ( i = c->second.begin();
1085 // i != c->second.end();
1087 std::cout << " usage : " << c->second.syntax << std::endl;
1088 std::cout << " " << c->second.help << std::endl;
1091 //=======================================================================
1094 //=======================================================================
1095 /// Fills the vector commands with the commands which
1096 /// have the first n chars of buf for prefix
1097 /// TODO : skip initial spaces in buf and also return the position of first
1098 /// non blank char in buf
1099 void Interpreter::FindCommandsWithPrefix( char* buf,
1101 std::vector<std::string>& commands )
1103 CommandDictType::const_iterator i;
1104 for (i=mCommandDict.begin(); i!=mCommandDict.end(); ++i)
1106 if ((i->first).find(buf,0,n) == 0)
1107 commands.push_back(i->first);
1110 //=======================================================================
1114 //=======================================================================
1115 #ifdef BBTK_USE_TERMIOS_BASED_PROMPT
1117 inline void PrintChar(char c) { write(STDOUT_FILENO,&c,1); }
1118 inline void BackSpace() { write(STDOUT_FILENO,"\b \b",3); }
1120 // LG : KEYBOARD CODES AS SCANNED ON MY TTY : UNIVERSAL ?
1121 // IF NOT THE USER SHOULD BE ABLE TO CONFIGURE IT
1122 // E.G. STORE THIS IN bbtk_config.xml
1123 #define BBTK_UP_ARROW_KBCODE 0x00415B1B
1124 #define BBTK_DOWN_ARROW_KBCODE 0x00425B1B
1125 #define BBTK_RIGHT_ARROW_KBCODE 0x00435B1B
1126 #define BBTK_LEFT_ARROW_KBCODE 0x00445B1B
1127 #define BBTK_BACKSPACE_KBCODE 0x00000008
1128 #define BBTK_DEL_KBCODE 0x0000007F
1129 #define BBTK_SPACE_KBCODE 0x00000020
1131 //=======================================================================
1132 void Interpreter::GetLineFromPrompt(std::string& s)
1137 int MAX_LINE_SIZE = 160;
1138 int MAX_HISTORY_SIZE = 100;
1140 char* newline = new char[MAX_LINE_SIZE];
1141 memset(newline,0,MAX_LINE_SIZE);
1142 char* histline = new char[MAX_LINE_SIZE];
1143 memset(histline,0,MAX_LINE_SIZE);
1145 char* line = newline;
1146 int hist = mHistory.size();
1153 read ( STDIN_FILENO, &c, 4) ;
1155 bbtkDebugMessage("Debug",9,"[0x"<<std::hex<<c<<"]\n");
1157 // Printable character
1158 if ( (ind<MAX_LINE_SIZE-1) &&
1159 ( c >= BBTK_SPACE_KBCODE ) &&
1160 ( c < BBTK_DEL_KBCODE ))
1168 // delete the unused line
1174 // empty lines are not stored in from history
1177 // if history too long : delete oldest command
1178 if (mHistory.size()>MAX_HISTORY_SIZE)
1180 delete mHistory.front();
1181 mHistory.pop_front();
1183 mHistory.push_back(line);
1189 else if ( (ind>0) &&
1190 ((c == BBTK_BACKSPACE_KBCODE) ||
1191 (c == BBTK_DEL_KBCODE)) )
1199 // TODO : Command completion
1200 std::vector<std::string> commands;
1201 FindCommandsWithPrefix( line,ind,commands);
1202 if (commands.size()==1)
1204 std::string com = *commands.begin();
1205 for (; ind<com.size(); ++ind)
1207 PrintChar(com[ind]);
1213 else if (commands.size()>1)
1215 std::vector<std::string>::iterator i;
1217 for (i=commands.begin();i!=commands.end();++i)
1219 write(STDOUT_FILENO,(*i).c_str(),strlen((*i).c_str()));
1222 write(STDOUT_FILENO,"\n> ",3);
1223 //for (int j=0;j<ind;++j)
1225 write(STDOUT_FILENO,line,ind);
1229 // Arrow up : back in history
1230 else if (c==BBTK_UP_ARROW_KBCODE)
1234 // erase current line
1235 while (ind--) BackSpace();
1239 strcpy(histline,mHistory[hist]);
1243 write(STDOUT_FILENO,line,ind);
1246 // Arrow down : down in history
1247 else if (c==BBTK_DOWN_ARROW_KBCODE)
1249 if (hist<mHistory.size()-1)
1251 // erase current line
1252 while (ind--) BackSpace();
1256 strcpy(histline,mHistory[hist]);
1260 write(STDOUT_FILENO,line,ind);
1262 // end of history : switch back to newline
1263 else if (hist==mHistory.size()-1)
1265 // erase current line
1266 while (ind--) BackSpace();
1273 write(STDOUT_FILENO,line,ind);
1277 else if (line[ind]!=0 && c==BBTK_RIGHT_ARROW_KBCODE)
1279 PrintChar(line[ind]);
1284 else if (ind>0 && c==BBTK_LEFT_ARROW_KBCODE)
1292 write(STDOUT_FILENO,"\n\r",2);
1300 //=======================================================================
1301 void Interpreter::GetLineFromPrompt(std::string& s)
1327 //=======================================================================
1333 //=======================================================================
1334 void Interpreter::CommandLineInterpreter()
1336 bbtkDebugMessageInc("Interpreter",9,
1337 "Interpreter::CommandLineInterpreter()"<<std::endl);
1339 #ifdef BBTK_USE_TERMIOS_BASED_PROMPT
1340 // Initialise the tty in non canonical mode with no echo
1341 // oter remembers the previous settings to restore them after
1342 struct termios ter,oter;
1345 ter.c_lflag &= ~ECHO;
1346 ter.c_lflag &= ~ICANON;
1349 tcsetattr(0,TCSANOW,&ter);
1352 mCommandLine = true;
1354 bool insideComment = false; // for multiline comment
1360 GetLineFromPrompt(line);
1361 InterpretLine(line, insideComment);
1363 catch (QuitException e)
1367 catch (bbtk::Exception e)
1371 catch (std::exception& e)
1373 std::cerr << "* ERROR :: "<<e.what()<<" (not in bbtk)"<<std::endl;
1377 std::cerr << "* UNDEFINED ERROR (not a bbtk nor a std exception)"<<std::endl;
1382 #ifdef BBTK_USE_TERMIOS_BASED_PROMPT
1383 tcsetattr(0,TCSANOW,&oter);
1386 std::cout << "Good bye !" << std::endl;
1388 bbtkDebugDecTab("Interpreter",9);
1391 //=======================================================================
1392 void Interpreter::Graph(const std::vector<std::string>& words)
1395 bool system_display = true;
1397 #ifdef _USE_WXWIDGETS_
1398 if ( WxConsole::GetInstance() != 0 ) system_display = false;
1401 if (words.size()==1)
1403 page = mExecuter->ShowGraph(".","0","0","","","",system_display);
1405 else if (words.size()==2)
1407 page = mExecuter->ShowGraph(words[1],"0","0","","","",system_display);
1409 else if (words.size()==3)
1411 page = mExecuter->ShowGraph(words[1],words[2],"0","","","",system_display);
1413 else if (words.size()==4)
1415 page = mExecuter->ShowGraph(words[1],words[2],words[3],"","","",system_display);
1417 else if (words.size()==5)
1419 page = mExecuter->ShowGraph(words[1],words[2],words[3],words[4],"","",system_display);
1421 else if (words.size()==6)
1423 page = mExecuter->ShowGraph(words[1],words[2],words[3],words[4],words[5],"",system_display);
1425 else if (words.size()==7)
1427 page = mExecuter->ShowGraph(words[1],words[2],words[3],words[4],words[5],words[6],system_display);
1430 #ifdef _USE_WXWIDGETS_
1431 if ( WxConsole::GetInstance() != 0 )
1432 WxConsole::GetInstance()->ShowHtmlPage(page);
1435 //=======================================================================