X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=kernel%2Fappli%2Fbbfy%2Fbbfy.cpp;h=43f89023c53ed59c3d9f223eed78d26fe0347a03;hb=49cb3ed3b5b7e58ab54dd3b6eb4ad8adee824ef2;hp=e67bce9600757ff3c9c60d927a9cb56a9954b553;hpb=e64f1a51510b44580500fd9ec30b4c937255bf75;p=bbtk.git

diff --git a/kernel/appli/bbfy/bbfy.cpp b/kernel/appli/bbfy/bbfy.cpp
index e67bce9..43f8902 100644
--- a/kernel/appli/bbfy/bbfy.cpp
+++ b/kernel/appli/bbfy/bbfy.cpp
@@ -1,3 +1,29 @@
+/*
+# ---------------------------------------------------------------------
+#
+# 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.
+# ------------------------------------------------------------------------ */
+
 #ifdef WIN32
 #define _CRT_SECURE_NO_DEPRECATE
 #endif
@@ -20,8 +46,8 @@ public:
 //==========================================================================
 
 const std::string itkImageToImageFilterString = "ITK_ImageToImageFilter";
-const std::string vtkImageAlgorithmString = "VTK_ImageAlgorithm";
-const std::string vtkPolyDataAlgorithmString = "VTK_PolyDataAlgorithm";
+const std::string vtkImageAlgorithmString     = "VTK_ImageAlgorithm";
+const std::string vtkPolyDataAlgorithmString  = "VTK_PolyDataAlgorithm";
 
 //==========================================================================
 class bbfy
@@ -63,7 +89,7 @@ private:
   bool mIsWidget;
   std::string mParentBlackBox;
   std::string mItkParent;
-  std::string mVtkParent;
+  std::string mVtkObject;
   bool mGeneric;
   std::string mAuthor;
   std::string mDescription;
@@ -79,9 +105,9 @@ private:
   std::vector<std::string> mInclude;
   std::vector<std::string> mTypedef;
 
-  std::string mUserConstructor;
-  std::string mUserCopyConstructor;
-  std::string mUserDestructor;
+  std::string mUserSetDefaultValues;
+  std::string mUserInitializeProcessing;
+  std::string mUserFinalizeProcessing;
 
   typedef struct
   {
@@ -105,6 +131,8 @@ private:
   std::string mHName;
   std::string mCxxName;
 
+  void AlertString();
+
 };
 //==========================================================================
 
@@ -140,11 +168,22 @@ void bbfy::CreateBlackBox()
 }
 //==========================================================================
 
-
+void bbfy::AlertString()
+{
+	
+      mFile << "//===== \n";
+      mFile << "// Before editing this file, make sure it's a file of your own ";
+      mFile << "(i.e.: it wasn't generated from xml description; if so : your modifications will be lost)\n";
+      mFile << "//===== \n";
+	  
+}
 
 //==========================================================================
 void bbfy::ParseXML()
 {
+
+
+
   XMLResults* res = new XMLResults;
   XMLNode BB = XMLNode::parseFile(mFilename.c_str(),"blackbox",res);
 
@@ -196,27 +235,27 @@ void bbfy::ParseXML()
       else if (bbtype == vtkImageAlgorithmString)
 	{
 	  mType = vtkImageAlgorithm;
-	  // Looks for <vtkparent> tag
-	  if (!BB.nChildNode("vtkparent")) 
+	  // Looks for <vtkobject> tag
+	  if (!BB.nChildNode("vtkobject")) 
 	    {
 	      throw bbfyException("Error : blackbox type '"
 				  +vtkImageAlgorithmString
-				  +"' but no <vtkparent> tag found (mandatory)");
+				  +"' but no <vtkobject> tag found (mandatory)");
 	    }
-	  bbtk::GetTextOrClear(BB.getChildNode("vtkparent"),mVtkParent);
+	  bbtk::GetTextOrClear(BB.getChildNode("vtkobject"),mVtkObject);
 	  // 
 	}
     else if (bbtype == vtkPolyDataAlgorithmString )
 	{
 	  mType = vtkPolyDataAlgorithm;
-	  // Looks for <vtkparent> tag
-	  if (!BB.nChildNode("vtkparent")) 
+	  // Looks for <vtkobject> tag
+	  if (!BB.nChildNode("vtkobject")) 
 	    {
 	      throw bbfyException("Error : blackbox type '"
 				  +vtkPolyDataAlgorithmString
-				  +"' but no <vtkparent> tag found (mandatory)");
+				  +"' but no <vtkobject> tag found (mandatory)");
 	    }
-	  bbtk::GetTextOrClear(BB.getChildNode("vtkparent"),mVtkParent);
+	  bbtk::GetTextOrClear(BB.getChildNode("vtkobject"),mVtkObject);
 	  // 
 	}
      else 
@@ -276,23 +315,30 @@ void bbfy::ParseXML()
       bbtk::GetTextOrClear(BB.getChildNode("namespace"),mNamespace);
     }
 
-  // UserConstructor body
-  if (BB.nChildNode("userconstructor"))
+  // UserSetDefaultValues body
+  if (BB.nChildNode("defaultValues"))
     {
-      bbtk::GetTextOrClear(BB.getChildNode("userconstructor"),mUserConstructor);
+      bbtk::GetTextOrClear(BB.getChildNode("defaultValues"),
+			   mUserSetDefaultValues);
     }
-  // UserCopyConstructor body
-  if (BB.nChildNode("usercopyconstructor"))
+    
+  // UserInitializeProcessing body
+  if (BB.nChildNode("initializeProcessing"))
     {
-      bbtk::GetTextOrClear(BB.getChildNode("usercopyconstructor"),mUserCopyConstructor);
+      bbtk::GetTextOrClear(BB.getChildNode("initializeProcessing"),
+			   mUserInitializeProcessing);
     }
-  // UserDestructor body
-  if (BB.nChildNode("userdestructor"))
+    
+ // UserFinalizeProcessing body
+  if (BB.nChildNode("finalizeProcessing"))
     {
-      bbtk::GetTextOrClear(BB.getChildNode("userdestructor"),mUserDestructor);
+      bbtk::GetTextOrClear(BB.getChildNode("finalizeProcessing"),
+			   mUserFinalizeProcessing);
     }
- 
-    // Template parameters
+
+
+
+     // Template parameters
   //  mNbTemplateParam = BB.nChildNode("template");
 
   if ( BB.nChildNode("template") > 0)
@@ -419,14 +465,39 @@ void bbfy::ParseXML()
   // process tag given ?
    if (BB.nChildNode("process"))
      {
-       bbtk::GetTextOrClear(BB.getChildNode("process"),mProcess);
+		 bbtk::GetTextOrClear(BB.getChildNode("process"),mProcess);
      }
+     
   // CreateWidget
   // createwidget tag given ?
    if (BB.nChildNode("createwidget"))
      {
        bbtk::GetTextOrClear(BB.getChildNode("createwidget"),mCreateWidget);
      }
+
+
+
+
+
+
+
+   // OBSOLETE/UNSUPPORTED TAGS
+  // WARN IF OBSOLETE TAGS PROVIDED
+  if (BB.nChildNode("constructor"))
+    {
+      std::cout << "WARNING !!! The tag <constructor> is obsolete !!"<<std::endl;
+    }
+  if (BB.nChildNode("destructor"))
+    {
+      std::cout << "WARNING !!! The tag <destructor> is obsolete !!"<<std::endl;
+    }
+  if (BB.nChildNode("copy_constructor"))
+    {
+      std::cout << "WARNING !!! The tag <copy_constructor> is obsolete !!"<<std::endl;
+    }
+
+
+
 }
 //==========================================================================
 
@@ -469,7 +540,9 @@ void bbfy::CreateHeader()
       mess += fullname + "\"";
       throw bbfyException(mess);
     }
-  
+
+	AlertString();
+
   // If is widget 
   if (mIsWidget)
     {
@@ -483,7 +556,7 @@ void bbfy::CreateHeader()
   mFile << "#define " << included <<"\n";
 
   // Includes 
-  //  mFile << "#include \"bbtkAtomicBlackBox.h\"\n";
+  mFile << "#include \"bb" << mPackage << "_EXPORT.h\"\n";
   std::vector<std::string>::iterator i;
   for (i=mInclude.begin(); i!=mInclude.end(); ++i) 
     {
@@ -513,9 +586,8 @@ void bbfy::CreateHeader()
     }
   
   // Class declaration and parents
-  mFile << "class /*BBTK_EXPORT*/ "<<mName<<"\n";
+  mFile << "class bb"<<mPackage<<"_EXPORT "<<mName<<"\n";
   mFile << " : \n";
-  mFile << "   public "<<mParentBlackBox;
 
   /*
   if (mBB.nChildNode("inherits"))
@@ -535,55 +607,50 @@ void bbfy::CreateHeader()
 
   if (mType == itkImageToImageFilter )
     {
-      mFile << ",\n   public " << mItkParent <<"\n";
-    }
-  else if ( (mType == vtkImageAlgorithm) ||
-	    (mType == vtkPolyDataAlgorithm) )
-    {
-      mFile << ",\n   public " << mVtkParent <<"\n";
-    }
-  else 
-    {
-      mFile << "\n";
+      mFile << "   public " << mItkParent <<",\n";
     }
 
+  mFile << "   public "<<mParentBlackBox << "\n";
+
   mFile << "{\n";
 
   // Interface
-  mFile << "  BBTK_BLACK_BOX_INTERFACE("
-	<< mName << ","
-	<< mParentBlackBox << ");\n";
 
-  // typedef on itkfilter
+  // ITK 
   if (mType == itkImageToImageFilter)
     {
-      mFile << "  typedef " <<mItkParent <<" itkParent;"<<std::endl;
-      mFile << "  void bbDelete() { itkParent::UnRegister(); }"<<std::endl;
+      mFile << "  BBTK_ITK_BLACK_BOX_INTERFACE("
+	    << mName << ","
+	    << mParentBlackBox << ","
+	    << mItkParent 
+	    << ");\n";
     }
-  // typedef on itkfilter
-  if ( (mType == vtkImageAlgorithm) ||
+  // VTK
+  else if ( (mType == vtkImageAlgorithm) ||
        (mType == vtkPolyDataAlgorithm) )
     {
-      mFile << "  typedef " <<mVtkParent <<" vtkParent;"<<std::endl;
-      mFile << "  BBTK_VTK_DELETE(vtkParent);"<<std::endl;
+      mFile << "  BBTK_VTK_BLACK_BOX_INTERFACE("
+	    << mName << ","
+	    << mParentBlackBox << ","
+	    << mVtkObject
+	    << ");\n";
     }
+	
+  // Default
+  else 
+    {
+      mFile << "  BBTK_BLACK_BOX_INTERFACE("
+	    << mName << ","
+	    << mParentBlackBox << ");\n";
+    }
+
   for (i=mTypedef.begin(); i!=mTypedef.end(); ++i) 
     {
       mFile << *i <<"\n";
     }
 
-  // Declare user constructor / copy cons /destr 
-  mFile << "//=================================================================="<<std::endl;
-  mFile << "/// User callback called in the box contructor"<<std::endl;
-
-  mFile << "virtual void bbUserConstructor();"<<std::endl;
-  mFile << "/// User callback called in the box copy constructor"<<std::endl;
-  mFile << "virtual void bbUserCopyConstructor();"<<std::endl;
-  mFile << "/// User callback called in the box destructor"<<std::endl;
-  mFile << "virtual void bbUserDestructor();"<<std::endl;
-  mFile << "//=================================================================="<<std::endl; 
-
 
+	AlertString();
 
   // Inputs
   std::vector<IO>::iterator ioi;
@@ -600,7 +667,6 @@ void bbfy::CreateHeader()
       else if (ioi->special=="itk input")
 	{
 	  mFile << "  BBTK_DECLARE_ITK_INPUT(" 
-		<< "itkParent,"
 		<< ioi->name
 		<< ","
 		<< ioi->type
@@ -610,7 +676,6 @@ void bbfy::CreateHeader()
 	{
 	  if (mType == vtkImageAlgorithm) {
 	  mFile << "  BBTK_DECLARE_VTK_IMAGE_ALGORITHM_INPUT(" 
-		<< "vtkParent,"
 		<< ioi->name
 		<< ","
 		<< ioi->type
@@ -618,7 +683,6 @@ void bbfy::CreateHeader()
 	  } 
 	  else if (mType == vtkPolyDataAlgorithm) {
 	  mFile << "  BBTK_DECLARE_POLY_DATA_ALGORITHM_INPUT(" 
-		<< "vtkParent,"
 		<< ioi->name
 		<< ","
 		<< ioi->type
@@ -628,7 +692,6 @@ void bbfy::CreateHeader()
       else if (ioi->special=="itk parameter")
 	{
 	  mFile << "  BBTK_DECLARE_ITK_PARAM(" 
-		<< "itkParent,"
 		<< ioi->name
 		<< ","
 		<< ioi->type
@@ -637,7 +700,6 @@ void bbfy::CreateHeader()
       else if (ioi->special=="vtk parameter")
 	{
 	  mFile << "  BBTK_DECLARE_VTK_PARAM(" 
-		<< "vtkParent,"
 		<< ioi->name
 		<< ","
 		<< ioi->type
@@ -653,6 +715,7 @@ void bbfy::CreateHeader()
 	  throw bbfyException(mess);
 	}
     }
+
   
   // Outputs
   for (ioi=mOutput.begin(); ioi!=mOutput.end(); ++ioi) 
@@ -668,7 +731,6 @@ void bbfy::CreateHeader()
       else if (ioi->special=="itk output")
 	{
 	  mFile << "  BBTK_DECLARE_ITK_OUTPUT(" 
-		<< "itkParent,"
 		<< ioi->name
 		<< ","
 		<< ioi->type
@@ -677,7 +739,6 @@ void bbfy::CreateHeader()
       else if (ioi->special=="vtk output")
 	{
 	  mFile << "  BBTK_DECLARE_VTK_OUTPUT(" 
-		<< "vtkParent,"
 		<< ioi->name
 		<< ","
 		<< ioi->type
@@ -694,7 +755,6 @@ void bbfy::CreateHeader()
 	}
     }
   
-
   // Process
   if ((mType == STD)||(mProcess.size()))
     {
@@ -703,28 +763,27 @@ void bbfy::CreateHeader()
     }
   else if (mType == itkImageToImageFilter)
     {   
-      mFile << "  BBTK_PROCESS(itkParent::Update);\n" ;
+      mFile << "  BBTK_ITK_PROCESS();\n" ;
     }
   else if ((mType == vtkImageAlgorithm) ||
 	   (mType == vtkPolyDataAlgorithm) )
 
     {   
-      mFile << "  BBTK_PROCESS(vtkParent::Update);\n" ;
+      mFile << "  BBTK_VTK_PROCESS();\n" ;
     }
 
   // CreateWidget
   if (mIsWidget) 
     {
        mFile << "  BBTK_CREATE_WIDGET(CreateWidget);\n" ;
-       mFile << "  void CreateWidget();\n";
+       mFile << "  void CreateWidget(wxWindow*);\n";
     }
 
+	AlertString();
 
   // EO black box declaration
   mFile << "};\n\n";
 
-
-
   // BO black box description
   if (mTemplateParam.size()==0)
     {
@@ -748,7 +807,8 @@ void bbfy::CreateHeader()
     {
       throw bbfyException("template bb with more than 1 templ param not impl");
     } 
-  
+
+
   // Author
   mFile << "BBTK_AUTHOR(\""<<mAuthor<< "\");\n";
 
@@ -820,6 +880,7 @@ void bbfy::CreateHeader()
       WriteGenericITKFilterHeader();
     }
 
+	AlertString();
 
   // EO namespace
   EndNamespace();
@@ -984,7 +1045,10 @@ void bbfy::CreateCode()
       mess += "\"";
       throw bbfyException(mess);
     }
-  
+
+	AlertString();
+
+
   // Includes
   // Header of the class
   mFile << "#include \"" << mHName << "\"\n";
@@ -1031,6 +1095,7 @@ void bbfy::CreateCode()
   // Process
   if ((mType == STD)||(mProcess.size()))
     {
+	AlertString();
       mFile << "void "<<mName<<"::Process()\n{\n";
       mFile << mProcess << "\n";
       mFile << "}\n";
@@ -1038,29 +1103,45 @@ void bbfy::CreateCode()
   // CreateWidget
   if (mIsWidget)
     {
-      mFile << "void "<<mName<<"::CreateWidget()\n{\n";
+	AlertString();
+      mFile << "void "<<mName<<"::CreateWidget(wxWindow* parent)\n{\n";
       mFile << mCreateWidget << "\n";
       mFile << "}\n";
     }
-  
 
-  // User constr / copy constr / destr implementation
-  mFile <<"void "<<mName<<"::bbUserConstructor()"<<std::endl;
-  mFile << "{"<<std::endl;
-  //mFile<<"bbtkDebugMessage(\"Kernel\",9,\""<<mName<<::bbUserConstructor()"<<std::endl);"<<std::endl;
-  mFile << mUserConstructor << std::endl;
+		
+  // User Set Default Values  
+	AlertString();
+  mFile <<"void "<<mName<<"::bbUserSetDefaultValues()"<<std::endl;
+  mFile << "{"<<std::endl;  
+	if ( (mType == vtkImageAlgorithm) || (mType == vtkPolyDataAlgorithm) )
+	{
+		mFile << "   BBTK_VTK_SET_DEFAULT_VALUES();\n";
+	}
+	mFile << mUserSetDefaultValues << std::endl;
   mFile << "}" << std::endl;
 
-  mFile <<"void "<<mName<<"::bbUserCopyConstructor()"<<std::endl;
+  // User Initialize Processing
+	AlertString();
+  mFile <<"void "<<mName<<"::bbUserInitializeProcessing()"
+	<<std::endl;
   mFile << "{"<<std::endl;
-  //mFile<<"bbtkDebugMessage(\"Kernel\",9,\""<<mName<<::bbUserCopyConstructor()"<<std::endl);"<<std::endl;
-  mFile << mUserCopyConstructor << std::endl;
+	if ( (mType == vtkImageAlgorithm) || (mType == vtkPolyDataAlgorithm) )
+	{
+		mFile <<  "  BBTK_VTK_INITIALIZE_PROCESSING();\n";
+	}
+	mFile << mUserInitializeProcessing << std::endl;
   mFile << "}" << std::endl;
 
-  mFile <<"void "<<mName<<"::bbUserDestructor()"<<std::endl;
+	// User Finalize Processing
+	AlertString();
+  mFile <<"void "<<mName<<"::bbUserFinalizeProcessing()"<<std::endl;
   mFile << "{"<<std::endl;
-  //mFile<<"bbtkDebugMessage(\"Kernel\",9,\""<<mName<<::bbUserDestructor()"<<std::endl);"<<std::endl;
-  mFile << mUserDestructor << std::endl;
+	if ( (mType == vtkImageAlgorithm) || (mType == vtkPolyDataAlgorithm) )
+	{
+		mFile << "   BBTK_VTK_FINALIZE_PROCESSING();\n";
+	}
+	mFile << mUserFinalizeProcessing << std::endl;
   mFile << "}" << std::endl;