X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=kernel%2Fsrc%2FbbtkExecuter.h;h=7175c39f495267f28bec308cc6143d66996355c4;hb=099b377628af9ff7205992d1a4bea7ad263c9e04;hp=5477c917bd05754fc28a790d96623d0395b73de1;hpb=6990a8aeeaf98fc901ed193b95365b2eee2fb950;p=bbtk.git diff --git a/kernel/src/bbtkExecuter.h b/kernel/src/bbtkExecuter.h index 5477c91..7175c39 100644 --- a/kernel/src/bbtkExecuter.h +++ b/kernel/src/bbtkExecuter.h @@ -1,20 +1,33 @@ -/*========================================================================= - +/*========================================================================= Program: bbtk - Module: $RCSfile: bbtkExecuter.h,v $ $ + Module: $RCSfile: bbtkExecuter.h,v $ Language: C++ - Date: $Date: 2008/01/22 16:55:04 $ - Version: $Revision: 1.2 $ - - 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: 2008/10/17 08:18:13 $ + Version: $Revision: 1.16 $ =========================================================================*/ + +/* --------------------------------------------------------------------- + +* Copyright (c) CREATIS-LRMN (Centre de Recherche en Imagerie Medicale) +* Authors : Eduardo Davila, Laurent Guigues, Jean-Pierre Roux +* +* 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. +* ------------------------------------------------------------------------ */ + /** * \file * \brief class Executer: level 0 of script execution (header) @@ -23,7 +36,7 @@ * \class bbtk::Executer * \brief class Executer: level 0 of script execution */ - + #ifndef __bbtkExecuter_h__ #define __bbtkExecuter_h__ @@ -38,20 +51,23 @@ namespace bbtk { + class Interpreter; + + class /*BBTK_EXPORT*/ Executer : public VirtualExec { - + BBTK_OBJECT_INTERFACE(Executer); + typedef VirtualExec Superclass; public: + 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; } - /// Constructor - Executer(); - /// - // void SetFactory(Factory* f); - - /// Destructor - ~Executer(); - /// Sets the inputs of the workspace : void SetInputs(const std::map& m) { mInputs = m; } @@ -64,15 +80,40 @@ 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 ); + /// 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); @@ -85,9 +126,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, @@ -100,7 +140,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, @@ -113,16 +153,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, @@ -131,65 +174,97 @@ 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(); - /// Description of the actual pipeline - void ShowRelations(const std::string &nameblackbox, const std::string &detailStr, const std::string &levelStr); + /// Sets the level of message for kind + void SetMessageLevel(const std::string &kind, + int level); - void Reset(); + /// Prints help on the messages + void HelpMessages(); + - // static const std::string& GetObjectDescription() + 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 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 + /// The root ComplexBlackBox + /// in which operations are done when outside a define/endefine block /// Its name in bbi is 'workspace' - ComplexBlackBoxDescriptor* mRoot; + 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