X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=kernel%2Fsrc%2FbbtkExecuter.h;h=69647a6a94752efd498a67640c2be99195147d0f;hb=b9da3baf83b7791357c78322e3280314ec782f40;hp=be6099a40643627533bc3cc4b23449b9855d4efb;hpb=a26195c366a89795288009cf7e20f11afa494970;p=bbtk.git diff --git a/kernel/src/bbtkExecuter.h b/kernel/src/bbtkExecuter.h index be6099a..69647a6 100644 --- a/kernel/src/bbtkExecuter.h +++ b/kernel/src/bbtkExecuter.h @@ -3,8 +3,8 @@ Program: bbtk Module: $RCSfile: bbtkExecuter.h,v $ $ Language: C++ - Date: $Date: 2008/01/22 15:02:00 $ - Version: $Revision: 1.1 $ + Date: $Date: 2008/03/26 08:27:19 $ + Version: $Revision: 1.11 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -23,7 +23,7 @@ * \class bbtk::Executer * \brief class Executer: level 0 of script execution */ - + #ifndef __bbtkExecuter_h__ #define __bbtkExecuter_h__ @@ -38,30 +38,26 @@ namespace bbtk { + class Interpreter; + + class /*BBTK_EXPORT*/ Executer : public VirtualExec { public: - /* - typedef enum - { - NoDialog, - TextDialog, - GraphicalDialog - } - DialogModeType; -*/ - /// Constructor Executer(); - - /// - // void SetFactory(Factory* f); - /// Destructor ~Executer(); + + /// Gets the factory used by the executer + Factory* GetFactory() { return mFactory; } + /// Gets the factory used by the executer (const) + const Factory* GetFactory() const { return mFactory; } + + /// Sets the inputs of the workspace : void SetInputs(const std::map& m) { mInputs = m; } @@ -74,12 +70,31 @@ namespace bbtk /// Sets the mode of dialog of the executer for Root inputs void SetDialogMode(DialogModeType t) { mDialogMode = t; } + + + //================================================================= + /// Loads a package + void LoadPackage(const std::string &name ); + + /// Unloads a package + void UnLoadPackage(const std::string &name ); + + /// Starts a package block + void BeginPackage (const std::string &name ); + + /// Ends a package block + void EndPackage (); + /// Starts the definition of a new ComplexBlackBox in package pack /// scriptfilename is the file from which the def is read void Define (const std::string &name, const std::string& pack, const std::string &scriptfilename); + /// Sets the file name to use for the current definition + /// (Used to set it after the Define command) + void SetCurrentFileName (const std::string &name ); + /// End the definition of a ComplexBlackBox void EndDefine (); @@ -95,9 +110,8 @@ namespace bbtk const std::string &boxto, const std::string &input); - /// Updates the box - /// would 'Execute' be more meaningfull ? - void Update (const std::string &box); + /// Executes the box + void Execute (const std::string &box); /// Defines an input of the current complex box void DefineInput (const std::string &name, @@ -110,7 +124,7 @@ namespace bbtk const std::string &box, const std::string &output, const std::string &help); - + /// sets the input of the box with the value void Set (const std::string &box, const std::string &input, @@ -123,16 +137,19 @@ namespace bbtk /// changes the workspace name void SetWorkspaceName( const std::string& n ); - ///Adds the authorName to the Box's author list + ///Adds the authorName to the Box author list void Author(const std::string &authorName); + ///Adds the Categories to the Box category list + void Category(const std::string &category); + /// The description string which explains what does the ComplexBox void Description(const std::string & d); /// prints the list off the boxes of the current box void PrintBoxes(); - /// Generate a HTML with a gif file with the actual pipeline (Graphviz-dot needed). Returns the file path + /// Generate a HTML with a gif file with the current pipeline (Graphviz-dot needed). Returns the file path std::string ShowGraph(const std::string &nameblackbox, const std::string &detailStr, const std::string &levelStr, @@ -141,15 +158,26 @@ namespace bbtk const std::string &custom_title, bool system_display = true); - /// Generate a HTML with a gif file with the actual pipeline (Graphviz-dot needed). Returns the file path + /// Generate a HTML with a gif file with the current pipeline (Graphviz-dot needed). Returns the file path std::string ShowGraphInstances(const std::string &nameblackbox, int detail, int level, bool system_display=true); + + /// Description of the actual pipeline + void ShowRelations(const std::string &nameblackbox, const std::string &detailStr, const std::string &levelStr); + + /// Resets the workspace : destroys all boxes / unloads all packages + void Reset(); + + /// Sets the level of message for kind + void SetMessageLevel(const std::string &kind, + int level); - /// Description of the actual pipeline - void ShowRelations(const std::string &nameblackbox, const std::string &detailStr, const std::string &levelStr); + /// Prints help on the messages + void HelpMessages(); + - void Reset(); + void Print(const std::string & message); - // static const std::string& GetObjectDescription() + // static const std::string& GetObjectDescription(); // { static std::string s("Executer"); return s; } protected: @@ -157,24 +185,30 @@ namespace bbtk private: /// Gets the current working black box - ComplexBlackBoxDescriptor* Current() { return mCurrent.back().box; } + ComplexBlackBoxDescriptor* Current() + { return mOpenDefinition.back().box; } /// Returns true when we are inside a define/endefine block - // bool InDefinitionBlock() { return (mCurrent.size()>1); } + // bool InDefinitionBlock() { return (mOpenDefinition.size()>1); } //================================================================== // ATTRIBUTES /// The factory used - // Factory* mFactory; - - /// The Root Package - Package* mPackage; + Factory* mFactory; - /// The root ComplexBlackBox, in which operations are done when outside a define/endefine block - /// Its name in bbi is 'workspace' - ComplexBlackBoxDescriptor* mRoot; + + /// The Root Package + /// Contains the root ComplexBlabkBox + /// In which ComplexBlackBoxes are put by default + /// Its name in bbi is 'user' + Package* mRootPackage; + /// The root ComplexBlackBox + /// in which operations are done when outside a define/endefine block + /// Its name in bbi is 'workspace' + ComplexBlackBoxDescriptor* mRootCBB; + /// Struct that stores info on user defined complex black boxes struct CBBDefinition { @@ -186,12 +220,13 @@ namespace bbtk /// The stack of current working ComplexBlackBox /// (is a stack for nested definitions) - /// only contains the root when outside a define/endefine block - std::deque mCurrent; + /// only contains the root cbb when outside a define/endefine block + std::deque mOpenDefinition; + + /// The stack of current working package + /// (is a stack for nested definitions) + std::deque mOpenPackage; - /// flag which is true when we are inside a Define/EndDefine block - // bool mDefineFlag; - /// The input values of the Root ComplexBlackBox std::map mInputs;