kernel/src/bbtkExecuter.h

   1 /*=========================================================================
   2   Program:   bbtk
   3   Module:    $RCSfile: bbtkExecuter.h,v $
   4   Language:  C++
   5   Date:      $Date: 2008/12/12 12:11:21 $
   6   Version:   $Revision: 1.17 $
   7 =========================================================================*/
   8
   9 /* ---------------------------------------------------------------------
  10
  11 * Copyright (c) CREATIS-LRMN (Centre de Recherche en Imagerie Medicale)
  12 * Authors : Eduardo Davila, Laurent Guigues, Jean-Pierre Roux
  13 *
  14 *  This software is governed by the CeCILL-B license under French law and
  15 *  abiding by the rules of distribution of free software. You can  use,
  16 *  modify and/ or redistribute the software under the terms of the CeCILL-B
  17 *  license as circulated by CEA, CNRS and INRIA at the following URL
  18 *  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  19 *  or in the file LICENSE.txt.
  20 *
  21 *  As a counterpart to the access to the source code and  rights to copy,
  22 *  modify and redistribute granted by the license, users are provided only
  23 *  with a limited warranty  and the software's author,  the holder of the
  24 *  economic rights,  and the successive licensors  have only  limited
  25 *  liability.
  26 *
  27 *  The fact that you are presently reading this means that you have had
  28 *  knowledge of the CeCILL-B license and that you accept its terms.
  29 * ------------------------------------------------------------------------ */
  30
  31 /**
  32  *  \file
  33  *  \brief class Executer: level 0 of script execution (header)
  34  */
  35 /**
  36  *  \class bbtk::Executer
  37  *  \brief class Executer: level 0 of script execution
  38  */
  39
  40 #ifndef __bbtkExecuter_h__
  41 #define __bbtkExecuter_h__
  42
  43 #include "bbtkVirtualExec.h"
  44
  45 #include "bbtkSystem.h"
  46 #include "bbtkComplexBlackBox.h"
  47 #include "bbtkFactory.h"
  48 #include <string>
  49 #include <deque>
  50
  51 namespace bbtk
  52 {
  53
  54   class Interpreter;
  55
  56
  57   class /*BBTK_EXPORT*/ Executer : public VirtualExec
  58   {
  59     BBTK_OBJECT_INTERFACE(Executer);
  60     typedef VirtualExec Superclass;
  61   public:
  62     static Pointer New();
  63
  64
  65     /// Gets the factory used by the executer
  66     Factory::Pointer GetFactory() { return mFactory; }
  67     /// Gets the factory used by the executer (const)
  68     //    const Factory::Pointer GetFactory() const { return mFactory; }
  69
  70
  71     /// Sets the inputs of the workspace :
  72     void SetInputs(const std::map<std::string,std::string>& m) { mInputs = m; }
  73
  74     /// Puts the executer in "no exec" mode,
  75     /// which creates but does not execute pipelines
  76     void SetNoExecMode(bool b) { mNoExecMode = b; }
  77
  78     bool GetNoExecMode() const { return mNoExecMode; }
  79
  80     /// Sets the mode of dialog of the executer for Root inputs
  81     void SetDialogMode(DialogModeType t) { mDialogMode = t; }
  82
  83     void SetNoErrorMode(bool b) { mNoErrorMode = b; }
  84
  85     bool GetNoErrorMode() const { return mNoErrorMode; }
  86
  87
  88     //=================================================================
  89     /// Loads a package
  90     void LoadPackage(const std::string &name );
  91
  92     /// Unloads a package
  93     void UnLoadPackage(const std::string &name );
  94
  95     /// Starts a package block
  96     void BeginPackage (const std::string &name );
  97
  98     /// Ends a package block
  99     void EndPackage ();
 100
 101     /// Starts the definition of a new ComplexBlackBox in package pack
 102     /// scriptfilename is the file from which the def is read
 103     void Define (const std::string &name,
 104                  const std::string& pack,
 105                  const std::string &scriptfilename);
 106
 107     /// Sets the file name to use for the current definition
 108     /// (Used to set it after the Define command)
 109     void SetCurrentFileName (const std::string &name );
 110
 111     /// End the definition of a ComplexBlackBox
 112     void EndDefine ();
 113
 114     /// Sets the kind of the currently defined ComplexBlackBox
 115     void Kind(const std::string& kind);
 116
 117     /// Creates a new black box in current complex box
 118     void Create ( const std::string& boxType, const std::string& boxName);
 119
 120     /// Destroys a black box
 121     void Destroy (const std::string &boxName);
 122
 123     /// Clears the currently defined ComplexBlackBox
 124     void Clear();
 125
 126     /// Connects the output boxOutput to the input boxInput
 127     void Connect (const std::string &boxfrom,
 128                   const std::string &output,
 129                   const std::string &boxto,
 130                   const std::string &input);
 131
 132     /// Executes the box
 133     void Execute (const std::string &box);
 134
 135     /// Defines an input of the current complex box
 136     void DefineInput (const std::string &name,
 137                       const std::string &box,
 138                       const std::string &input,
 139                       const std::string &help);
 140
 141     /// Defines an output of the current complex box
 142     void DefineOutput (const std::string &name,
 143                        const std::string &box,
 144                        const std::string &output,
 145                        const std::string &help);
 146
 147     /// sets the input of the box with the value
 148     void Set (const std::string &box,
 149               const std::string &input,
 150               const std::string &value);
 151
 152     /// gets the output of the box
 153     std::string Get (const std::string &box,
 154                      const std::string &output);
 155
 156     /// changes the workspace name
 157     void SetWorkspaceName( const std::string& n );
 158
 159     ///Adds the authorName to the Box author list
 160     void Author(const std::string &authorName);
 161
 162     ///Adds the Categories to the Box category list
 163     void Category(const std::string &category);
 164
 165     /// The description string which explains what does the ComplexBox
 166     void Description(const std::string & d);
 167
 168     /// prints the list off the boxes of the current box
 169     void PrintBoxes();
 170
 171    /// Generate a HTML with a gif file with the current pipeline (Graphviz-dot needed). Returns the file path
 172     std::string ShowGraph(const std::string &nameblackbox,
 173                           const std::string &detailStr,
 174                           const std::string &levelStr,
 175                           const std::string &output_file,
 176                           const std::string &custom_header,
 177                           const std::string &custom_title,
 178                           bool system_display = true);
 179
 180     /// Generate a HTML with a gif file with the current pipeline (Graphviz-dot needed). Returns the file path
 181     std::string ShowGraphInstances(const std::string &nameblackbox, int detail, int level, bool system_display=true);
 182
 183     /// Description of the actual pipeline
 184     void ShowRelations(const std::string &nameblackbox, const std::string &detailStr, const std::string &levelStr);
 185
 186     /// Resets the workspace : destroys all boxes / unloads all packages
 187     void Reset();
 188
 189     /// Sets the level of message for kind
 190     void SetMessageLevel(const std::string &kind,
 191                          int level);
 192
 193    /// Prints help on the messages
 194     void HelpMessages();
 195
 196
 197     void Print(const std::string & message);
 198
 199   //  static const std::string& GetObjectDescription();
 200   //  { static std::string s("Executer"); return s; }
 201
 202
 203     ComplexBlackBoxDescriptor::Pointer GetWorkspace()
 204     { return mRootCBB.lock(); }
 205     Package::Pointer GetUserPackage()
 206     { return mRootPackage.lock(); }
 207
 208     /// Gets the current working black box
 209     ComplexBlackBoxDescriptor::Pointer GetCurrentDescriptor()
 210     { return mOpenDefinition.back().box; }
 211
 212
 213   protected:
 214
 215   private:
 216
 217
 218     /// Returns true when we are inside a define/endefine block
 219     //    bool InDefinitionBlock() { return (mOpenDefinition.size()>1); }
 220
 221     //==================================================================
 222     // ATTRIBUTES
 223
 224     /// The factory used
 225     Factory::Pointer mFactory;
 226
 227
 228     /// The Root Package
 229     /// Contains the root ComplexBlabkBox
 230     /// In which ComplexBlackBoxes are put by default
 231     /// Its name in bbi is 'user'
 232     Package::WeakPointer mRootPackage;
 233
 234     /// The root ComplexBlackBox
 235     /// in which operations are done when outside a define/endefine block
 236     /// Its name in bbi is 'workspace'
 237     ComplexBlackBoxDescriptor::WeakPointer mRootCBB;
 238
 239     /// Struct that stores info on user defined complex black boxes
 240     struct CBBDefinition
 241     {
 242       ComplexBlackBoxDescriptor::Pointer box;
 243       std::string package;
 244       CBBDefinition(ComplexBlackBoxDescriptor::Pointer d,
 245                     const std::string& p )
 246         : box(d), package(p) {}
 247     };
 248
 249     /// The stack of current working ComplexBlackBox
 250     /// (is a stack for nested definitions)
 251     /// only contains the root cbb when outside a define/endefine block
 252     std::deque<CBBDefinition> mOpenDefinition;
 253
 254     /// The stack of current working package
 255     /// (is a stack for nested definitions)
 256     std::deque<Package::WeakPointer> mOpenPackage;
 257
 258     /// The input values of the Root ComplexBlackBox
 259     std::map<std::string,std::string> mInputs;
 260
 261     /// no exec mode flag
 262     bool mNoExecMode;
 263
 264
 265     /// Dialog mode
 266     DialogModeType mDialogMode;
 267
 268     /// no error mode flag
 269     bool mNoErrorMode;
 270
 271   };
 272 }
 273 #endif