X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=kernel%2Fsrc%2FbbtkExecuter.h;h=63769616366a18b4004a0bb2095bc74f6d5683e5;hb=16993e9f411c62e9a73d13c40f3748bdd232ce09;hp=be6099a40643627533bc3cc4b23449b9855d4efb;hpb=a26195c366a89795288009cf7e20f11afa494970;p=bbtk.git diff --git a/kernel/src/bbtkExecuter.h b/kernel/src/bbtkExecuter.h index be6099a..6376961 100644 --- a/kernel/src/bbtkExecuter.h +++ b/kernel/src/bbtkExecuter.h @@ -1,20 +1,40 @@ +/* + # --------------------------------------------------------------------- + # + # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image + # pour la SantÈ) + # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton + # Previous Authors : Laurent Guigues, Jean-Pierre Roux + # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil + # + # This software is governed by the CeCILL-B license under French law and + # abiding by the rules of distribution of free software. You can use, + # modify and/ or redistribute the software under the terms of the CeCILL-B + # license as circulated by CEA, CNRS and INRIA at the following URL + # http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html + # or in the file LICENSE.txt. + # + # As a counterpart to the access to the source code and rights to copy, + # modify and redistribute granted by the license, users are provided only + # with a limited warranty and the software's author, the holder of the + # economic rights, and the successive licensors have only limited + # liability. + # + # The fact that you are presently reading this means that you have had + # knowledge of the CeCILL-B license and that you accept its terms. + # ------------------------------------------------------------------------ */ + + /*========================================================================= - Program: bbtk - Module: $RCSfile: bbtkExecuter.h,v $ $ + Module: $RCSfile: bbtkExecuter.h,v $ Language: C++ - Date: $Date: 2008/01/22 15:02:00 $ - Version: $Revision: 1.1 $ - - Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de - l'Image). All rights reserved. See Doc/License.txt or - http://www.creatis.insa-lyon.fr/Public/bbtk/License.html for details. - - This software is distributed WITHOUT ANY WARRANTY; without even - the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR - PURPOSE. See the above copyright notices for more information. - + Date: $Date: 2012/11/16 08:49:01 $ + Version: $Revision: 1.20 $ =========================================================================*/ + + + /** * \file * \brief class Executer: level 0 of script execution (header) @@ -23,7 +43,7 @@ * \class bbtk::Executer * \brief class Executer: level 0 of script execution */ - + #ifndef __bbtkExecuter_h__ #define __bbtkExecuter_h__ @@ -38,30 +58,23 @@ namespace bbtk { + class Interpreter; + + class /*BBTK_EXPORT*/ Executer : public VirtualExec { - + BBTK_OBJECT_INTERFACE(Executer); + typedef VirtualExec Superclass; public: - - /* - typedef enum - { - NoDialog, - TextDialog, - GraphicalDialog - } - DialogModeType; -*/ - - /// Constructor - Executer(); - - /// - // void SetFactory(Factory* f); - - /// Destructor - ~Executer(); + static Pointer New(); + + /// Gets the factory used by the executer + Factory::Pointer GetFactory() { return mFactory; } + /// Gets the factory used by the executer (const) + // const Factory::Pointer GetFactory() const { return mFactory; } + + /// Sets the inputs of the workspace : void SetInputs(const std::map& m) { mInputs = m; } @@ -74,30 +87,62 @@ namespace bbtk /// Sets the mode of dialog of the executer for Root inputs void SetDialogMode(DialogModeType t) { mDialogMode = t; } + void SetNoErrorMode(bool b) { mNoErrorMode = b; } + + bool GetNoErrorMode() const { return mNoErrorMode; } + + + //================================================================= + /// 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 ); + + //Set type of script + void SetTypeOfScript_Application(); + + + /// End the definition of a ComplexBlackBox void EndDefine (); + /// Sets the kind of the currently defined ComplexBlackBox + void Kind(const std::string& kind); + /// Creates a new black box in current complex box void Create ( const std::string& boxType, const std::string& boxName); /// Destroys a black box void Destroy (const std::string &boxName); + /// Clears the currently defined ComplexBlackBox + void Clear(); + /// Connects the output boxOutput to the input boxInput void Connect (const std::string &boxfrom, const std::string &output, 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 +155,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 +168,24 @@ 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(); + void PrintHelpListBoxes(); - /// 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,65 +194,102 @@ 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); + + /// Prints help on a black box + void PrintHelpBlackBox(const std::string &nameblackbox, const std::string &detailStr, const std::string &levelStr); + + + + - /// Description of the actual pipeline - void ShowRelations(const std::string &nameblackbox, const std::string &detailStr, const std::string &levelStr); - void Reset(); + /// Resets the workspace : destroys all boxes / unloads all packages + void Reset(); - // static const std::string& GetObjectDescription() + /// Sets the level of message for kind + void SetMessageLevel(const std::string &kind, + int level); + + /// Prints help on the messages + void HelpMessages(); + + + void Print(const std::string & message); + + // static const std::string& GetObjectDescription(); // { static std::string s("Executer"); return s; } + + ComplexBlackBoxDescriptor::Pointer GetWorkspace() + { return mRootCBB.lock(); } + Package::Pointer GetUserPackage() + { return mRootPackage.lock(); } + + /// Gets the current working black box + ComplexBlackBoxDescriptor::Pointer GetCurrentDescriptor() + { return mOpenDefinition.back().box; } + + protected: private: - /// Gets the current working black box - ComplexBlackBoxDescriptor* Current() { return mCurrent.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::Pointer 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::WeakPointer mRootPackage; + /// The root ComplexBlackBox + /// in which operations are done when outside a define/endefine block + /// Its name in bbi is 'workspace' + ComplexBlackBoxDescriptor::WeakPointer mRootCBB; + /// Struct that stores info on user defined complex black boxes struct CBBDefinition { - ComplexBlackBoxDescriptor* box; + ComplexBlackBoxDescriptor::Pointer box; std::string package; - CBBDefinition(ComplexBlackBoxDescriptor* d, const std::string& p ) + CBBDefinition(ComplexBlackBoxDescriptor::Pointer d, + const std::string& p ) : box(d), package(p) {} }; /// 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; /// no exec mode flag bool mNoExecMode; + /// Dialog mode DialogModeType mDialogMode; + + /// no error mode flag + bool mNoErrorMode; + }; } #endif