X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=kernel%2Fdoc%2FbbtkPackageDevelopersGuide%2FbbtkPackageDevelopersGuide.tex;h=cc30dbd4e96cd61fc806af8cdf76c78002fc8461;hb=aa5ec2700f8e16b54e0ad2d314b16ffbc95389a2;hp=2504f8a188b670bc64e59b549379ab1559e24769;hpb=43b0c4c9408e08528c851fdf1ef3b11e6642657b;p=bbtk.git diff --git a/kernel/doc/bbtkPackageDevelopersGuide/bbtkPackageDevelopersGuide.tex b/kernel/doc/bbtkPackageDevelopersGuide/bbtkPackageDevelopersGuide.tex index 2504f8a..cc30dbd 100644 --- a/kernel/doc/bbtkPackageDevelopersGuide/bbtkPackageDevelopersGuide.tex +++ b/kernel/doc/bbtkPackageDevelopersGuide/bbtkPackageDevelopersGuide.tex @@ -1,130 +1,108 @@ + + % ========================================== \documentclass[11pt,final,a4paper]{article} \input{config.tex} - - \begin{document} -\title{The Black Box Toolkit\\Package Developers' Guide} -\date{\today} -\author{Laurent Guigues} -\maketitle -% ========================================== -\tableofcontents +\bbtkGuide[Package Developers' Guide] +\newpage % ========================================== -\listoftables -\listoffigures + % ========================================== -%\section*{Abstract} -% ========================================== -\newpage +\section{Introduction} % ========================================== + +This guide describes how to +create new \bbtk packages and black boxes. +How to use them is described in \bbtk Users' guide. + +Any black box must be included in a \bbtk package, +that is in a particular shared library that can be loaded +dynamically by \bbtkns, either in \CPP code or in \bbs scripts +with the commands \texttt{include} or \texttt{load}. +The steps to create new boxes are thus: + +\begin{enumerate} + \item \textbf{Create a new package. } + This process (see section \ref{CreatePackage}), consists of two steps: + \begin{enumerate} + \item Generation of the project structure by use of \bbCreatePackage utility that creates both the + directories tree (for sources, documentation, etc.) and configuration files (particularly \texttt{CMakelists}). See section + \ref{sec:bbCreatePackage-files}. + \item Customization of the \texttt{CMakelists}. See section \ref{RootCMakeLists}. + \end{enumerate} + \item \textbf{Describe your new box.} This is explained in section \ref{CreateBlackBox}. + You can do it either: + \begin{itemize} + \item In \xml code. You will mainly have to customize an \xml skeleton automatically generated by \bbCreateBlackBox utility. + See section \ref{sec:XML-box}. + When configuring your project with \cmakens, + the utility \bbfy will then automatically generate the corresponding \CPP code. + \item In \CPP code. You will have to write the class for + your box, mostly using \bbtk macros. See section \ref{sec:CPP-box}. + \end{itemize} + \item \textbf{Configure your project with \cmakens.} See section \ref{sec:CMake}. + \item \textbf{Compile your project.} See section \ref{sec:compile}. + \item \textbf{Plug the new package} if you use \bbStudio See section \ref{sec:plugin}. +\end{enumerate} + % ========================================== -\vspace{0.5cm}\hrule -%\section{Creating your own black boxes} -%\label{bbp} +\section{Creating a new package} +\label{CreatePackage} % ========================================== % ========================================== -\section{Steps in the creation of new black boxes} +\subsection{Creating the file tree} +\label{sec:bbCreatePackage-files} % ========================================== -Any black box must be included in a \bbtk package, -that is in a particular shared library which can be loaded -dynamically by \bbtk (hence applications which use \bbtkns, -such as the interpreter \bbi, launched by the development environment -\bbStudions). - -\begin{enumerate} -\item \textbf{Create a new package. } Before defining any black box you have to create a package, or more precisely -the files which will allow you to generate the package -(compile and link the shared library) and may be install it. - \texttt{bbStudio} does it for you. - +the source files that will allow you to generate the package +(compile and link the shared library) and maybe install it. +The \bbtk command-line application \bbCreatePackage +allows to create the basic file architecture +to start the development of a new black box package. +Type \bbCreatePackage in a console to get its usage: +\begin{verbatim} +bbCreatePackage [author] [description] +\end{verbatim} -Two cases occur : +In \bbStudio you can run this application via a graphical interface, by use of the menu \texttt{Tools $>$ Create Package}. +In both cases (using the command-line tool or \bbStudio interface), +you have to choose: + +\begin{itemize} +\item The {\bf directory} of your new package. +Two cases occur: \begin{itemize} \item The black boxes you want to create are based on -a processing code (\CPP classes or \C functions) which +a processing code (\CPP classes or \C functions), which is in an existing project handled by \cmake and you want the new package to be part of your existing project. -You will have to create your new package into the source tree of your -project. +You will have to create your new package within the source tree of your +project and add a \texttt{SUBDIRS} command in the \texttt{CMakeLists.txt} +file of the parent directory of your package. \item You do not have an already existing project (you want to create the new boxes from scratch) or you want/are imposed that the existing project remain external to the package project. You will have to create your new package in a new location and -may be include/link against existing libraries. +maybe include/link against existing libraries. \end{itemize} -\item \textbf{Describe your new box. } -You can do it either : -\begin{itemize} -\item In \CPP code. You will have to write the class for -your box, mostly using \bbtk macros. -\item In \xml code. -When configuring your project with \cmake, -the utility \bbfy will then generate the corresponding \CPP code. +\item The {\bf name} of your new package. +This name will be used to load the package in \CPP and \bbs scripts. \end{itemize} -\end{enumerate} - -% ========================================== -\section{Creating a new black box package} -% ========================================== - -Run \texttt{bbStudio}. - -You'll get something like in fig. \ref{bb-Studio} - -\begin{figure}[!ht] -\caption{\label{bb-Studio} bbStudio} -\begin{center} -\includegraphics[width=0.6\textwidth]{bbStudio.png} -\end{center} -\end{figure} - -Use the option \texttt{Create package} of the menu \texttt{Tools}. - -You will be asked to choose the directory where you want to create the package, -then you'll get something like in fig. \ref{bbCreatePackage}. - - -\begin{figure}[!ht] -\caption{\label{bbCreatePackage} Create Package} -\begin{center} -\includegraphics[width=0.6\textwidth]{bbCreatePackage.png} -\end{center} -\end{figure} - - -That will creates the directory structure and the \texttt{cmake} -files necessary to build the project. - -You must then decide the name of your new package. -This name will be used to load the package in \texttt{bbi}. -Fill up the form like in fig. \ref{bbFillUpPackageForm}. - - -\begin{figure}[!ht] -\caption{\label{bbFillUpPackageForm} Fill up the form} -\begin{center} -\includegraphics[width=0.6\textwidth]{bbFillUpPackageForm.png} -\end{center} -\end{figure} - -Edit the file \texttt{MyPackage/CMakeLists.txt} to customize your package - - -the file tree obtained is : +You must also provide the \texttt{author} list +and a \texttt{description} which will be used for your package documentation. +After running \bbCreatePackage or clicking 'Run' in \bbStudio interface +you should get a file structure like this (Linux users can verify it with the \texttt{tree} command): \begin{verbatim} ->tree myPackageFolder -myPackageFolder -`-- MyPackage + NEW_PACKAGE |-- CMakeLists.txt |-- Configure.cmake |-- PackageConfig.cmake.in @@ -149,61 +127,85 @@ myPackageFolder | `-- Doxyfile.txt.in `-- src `-- CMakeLists.txt - -9 directories, 16 files \end{verbatim} -The directory \texttt{MyPackage} is the directory of your new package, -in which you will create the files describing your black boxes. -But first, you have to customize your new package, by editing the file -\texttt{CMakeLists.txt} in the \texttt{MyPackage} directory. -This file contains : +You can then: +\begin{itemize} +\item Edit the root \texttt{CMakeLists.txt} file to customize your package build settings (see section \ref{RootCMakeLists}) + +\item Put your \CPP/\xml boxes sources in '\texttt{src}' subdirectory (see section \ref{CreateBlackBox}). + + Please use the convention: If the name of your package is \texttt{Pack} and the name of your box is \texttt{Box} then name the source files \texttt{bbPackBox.\{h;cxx;xml\}}. Note that this is automatically done when using the \bbCreateBlackBox utility. + +\item Put your script-defined boxes (complex boxes) in '\texttt{bbs/boxes}' subdirectory. + + Please use the convention: If the name of your box is '\texttt{Box}' then call the file '\texttt{bbBox.bbs}' to let others know that the script defines a complex black box type. + +\item Put your script-defined applications in '\texttt{bbs/appli}' subdirectory. + + Please use the convention: Do {\bf not} prefix '\texttt{bb}' to the files. + +\item Put your data in '\texttt{data}' subdirectory. +Any data put there will be installed and accessible in your scripts. The box +\texttt{std::PrependPackageDataPath} provides the package data path. + -\begin{file}{MyPackage/CMakeLists.txt} +\item Customize the header of your package \texttt{html} doc. To do so, you have to edit the file '\texttt{doc/bbdoc/header.html.in}' either with an \texttt{html} editor or by use of a text editor (directly editing the \texttt{html} code). You can include images or links to other \texttt{html} pages. The images and pages must be put in the folder '\texttt{doc/bbdoc}' and will be properly installed. The same way, you can link to these images or pages in your boxes descriptions without giving any path. If you create subdirs for your material then you have to install the materials yourself by editing the \texttt{CMakeLists.txt} and links must use paths relative to '\texttt{doc/bbdoc}'. + +\item Customize the main page of your \texttt{doxygen} doc. To do so, you have to edit the file '\texttt{doc/doxygen/DoxyMainPage.txt.in}'. +\end{itemize} + +\subsection{Configuring the root \texttt{CMakeLists.txt}} +\label{RootCMakeLists} + +\texttt{CMake} is a family of tools designed to build, test and package software (\url{http://www.cmake.org/}). It is used to control the software compilation process using platform- and compiler-independent configuration files. \texttt{CMake} generates native makefiles and workspaces that can be used in the compiler environment of your choice. To do this, each branch of your project directory tree contains an appropriate \texttt{CMakeLists.txt} file. These files have been filled-up, so as to minimize your effort. Normally, you only have to edit the file \texttt{CMakeLists.txt} in the package root directory, in order to configure your new package build settings. +The listing of this file is given below. Hopefully, the comments in the file are easy to understand! + +\begin{file}{CMakeLists.txt} \small \begin{verbatim} -#=========================================================================== +#========================================================================== # CMAKE SETTINGS FOR BUILDING A BBTK PACKAGE -#=========================================================================== +#========================================================================== -#=========================================================================== +#========================================================================== # THE NAME OF THE BBTK PACKAGE SET(BBTK_PACKAGE_NAME MyPackage) -#=========================================================================== +#========================================================================== -#=========================================================================== +#========================================================================== # IF IT IS A STANDALONE PROJECT UNCOMMENT NEXT LINE TO DECLARE YOUR PROJECT # PROJECT(bb${BBTK_PACKAGE_NAME}) -#=========================================================================== +#========================================================================== -#=========================================================================== +#========================================================================== # PACKAGE AUTHOR # !!! NO COMMA ALLOWED !!! SET(${BBTK_PACKAGE_NAME}_AUTHOR "myself") -#=========================================================================== +#========================================================================== -#=========================================================================== +#========================================================================== # PACKAGE DESCRIPTION -SET(${BBTK_PACKAGE_NAME}_DESCRIPTION "The kinkiest stuff you ve ever seen.") -#=========================================================================== +SET(${BBTK_PACKAGE_NAME}_DESCRIPTION "My super package does nothing yet") +#========================================================================== -#=========================================================================== +#========================================================================== # PACKAGE VERSION NUMBER SET(${BBTK_PACKAGE_NAME}_MAJOR_VERSION 1) SET(${BBTK_PACKAGE_NAME}_MINOR_VERSION 0) SET(${BBTK_PACKAGE_NAME}_BUILD_VERSION 0) -#=========================================================================== +#========================================================================== -#=========================================================================== +#========================================================================== # UNCOMMENT EACH LIBRARY NEEDED (WILL BE FOUND AND USED AUTOMATICALLY) # SET(${BBTK_PACKAGE_NAME}_USE_VTK ON) # SET(${BBTK_PACKAGE_NAME}_USE_ITK ON) # SET(${BBTK_PACKAGE_NAME}_USE_GDCM ON) # SET(${BBTK_PACKAGE_NAME}_USE_GSMIS ON) # SET(${BBTK_PACKAGE_NAME}_USE_WXWIDGETS ON) -#=========================================================================== +#========================================================================== -#=========================================================================== +#========================================================================== # LIST HERE THE OTHER bbtk PACKAGES NEEDED # (WILL BE FOUND AND USED AUTOMATICALLY) SET(${BBTK_PACKAGE_NAME}_USE_PACKAGES @@ -213,9 +215,9 @@ SET(${BBTK_PACKAGE_NAME}_USE_PACKAGES # vtk # ... ) -#=========================================================================== +#========================================================================== -#=========================================================================== +#========================================================================== # THE SOURCES OF THE PACKAGE # EITHER UNCOMMENT NEXT LINE TO COMPILE ALL .cxx OF THE src DIRECTORY : SET(${BBTK_PACKAGE_NAME}_COMPILE_ALL_CXX ON) @@ -225,9 +227,9 @@ SET(${BBTK_PACKAGE_NAME}_COMPILE_ALL_CXX ON) # E.G. TO COMPILE "toto.cxx" ADD "toto" (NO EXTENSION) # THE PATH MUST BE RELATIVE TO THE src FOLDER # ) -#=========================================================================== +#========================================================================== -#=========================================================================== +#========================================================================== # THE xml SOURCES OF THE PACKAGE # EITHER UNCOMMENT NEXT LINE TO bbfy ALL .xml OF THE src DIRECTORY : SET(${BBTK_PACKAGE_NAME}_COMPILE_ALL_XML ON) @@ -237,11 +239,11 @@ SET(${BBTK_PACKAGE_NAME}_COMPILE_ALL_XML ON) # E.G. TO bbfy "toto.xml" ADD "toto" (NO EXTENSION) # THE PATH MUST BE RELATIVE TO THE src FOLDER # ) -#=========================================================================== +#========================================================================== -#=========================================================================== +#========================================================================== # THE SCRIPT-DEFINED BOXES OF THE PACKAGE (bbs) -# EITHER UNCOMMENT NEXT LINE TO INCLUDE ALL .bbs OF THE bbs/boxes DIRECTORY : +# EITHER UNCOMMENT NEXT LINE TO INCLUDE ALL .bbs OF THE bbs/boxes DIRECTORY: SET(${BBTK_PACKAGE_NAME}_INCLUDE_ALL_BBS_BOXES ON) # ... OR LIST THE FILES TO INCLUDE MANUALLY : # SET(${BBTK_PACKAGE_NAME}_BBS_BOXES @@ -249,11 +251,11 @@ SET(${BBTK_PACKAGE_NAME}_INCLUDE_ALL_BBS_BOXES ON) # E.G. TO INCLUDE "boxes/bbtoto.bbs" ADD "boxes/bbtoto" (NO EXTENSION) # !! THE PATH MUST BE RELATIVE TO THE bbs FOLDER !! #) -#=========================================================================== +#========================================================================== -#=========================================================================== +#========================================================================== # THE SCRIPT-DEFINED APPLICATIONS OF THE PACKAGE (bbs) -# EITHER UNCOMMENT NEXT LINE TO INCLUDE ALL .bbs OF THE bbs/appli DIRECTORY : +# EITHER UNCOMMENT NEXT LINE TO INCLUDE ALL .bbs OF THE bbs/appli DIRECTORY: SET(${BBTK_PACKAGE_NAME}_INCLUDE_ALL_BBS_APPLI ON) # ... OR LIST THE FILES TO INCLUDE MANUALLY : # SET(${BBTK_PACKAGE_NAME}_BBS_APPLI @@ -261,77 +263,104 @@ SET(${BBTK_PACKAGE_NAME}_INCLUDE_ALL_BBS_APPLI ON) # E.G. TO INCLUDE "appli/testToto.bbs" ADD "appli/testToto" (NO EXTENSION) # !! THE PATH MUST BE RELATIVE TO THE bbs FOLDER !! #) -#=========================================================================== +#========================================================================== -#=========================================================================== +#========================================================================== SET(${BBTK_PACKAGE_NAME}_INCLUDE_DIRS # LIST HERE YOUR ADDITIONAL INCLUDE DIRECTORIES # EXCEPT : # - src # - bbtk dirs - # - automatically handled libraries or packages : wx, vtk... (see above) + # - automatically handled libraries or packages: wx, vtk... (see above) # - the dirs automatically set by other libraries found by FIND_PACKAGE ) -#=========================================================================== +#========================================================================== -#=========================================================================== +#========================================================================== SET(${BBTK_PACKAGE_NAME}_LIBS # LIST HERE THE ADDITIONAL LIBS TO LINK AGAINST # EXCEPT : the same libs than for INCLUDE_DIRS ) -#=========================================================================== +#========================================================================== -#=========================================================================== +#========================================================================== # IF NEEDED : UNCOMMENT NEXT LINE # AND LIST ADDITIONNAL DIRECTORIES # IN WHICH TO LOOK FOR LIBRARIES TO LINK AGAINST # LINK_DIRECTORIES() -#=========================================================================== +#========================================================================== -#=========================================================================== +#========================================================================== # SET TO TRUE TO HAVE INFORMATION ON LIBRARIES FOUND DURING CMAKE CONFIGURE SET(FIND_PACKAGE_VERBOSE TRUE) -#=========================================================================== +#========================================================================== -#=========================================================================== +#========================================================================== # END OF USER SECTION -#=========================================================================== +#========================================================================== -#=========================================================================== +#========================================================================== # Include configuration script INCLUDE(Configure.cmake) -#=========================================================================== +#========================================================================== -#=========================================================================== +#========================================================================== # EOF -#=========================================================================== +#========================================================================== \end{verbatim} \end{file} -The comments in the file should be easily understandable ! -You have to customize the lines which are enclosed -between dashed comment lines. -In these sections, you can see some of the informations you supplied in previous step: +You can see in the file some of the informations you supplied when running the \bbCreatePackage utility: \begin{itemize} - \item The \textbf{name} of your package. This will be the name used to load it in \bbi. The shared library however will be called \texttt{bb}name hence on + \item The \textbf{name} of your package. This will be the name used to load it in \bbins. The shared library however will be called \texttt{bb}name hence on \lin the object file will be called \texttt{libbb}name\texttt{.so} and on \win it will be called \texttt{bb}name\texttt{.dll}. - \item The \textbf{author(s)} of the package. Preferably provide e-mail adresses. - \item A \textbf{description} of the package, which will appear in the help of your package or in its html documentation automatically generated by \bbdoc. + \item The \textbf{author(s)} of the package. Preferably provide e-mail addresses. + \item A \textbf{description} of the package, which will appear in the help of your package or in its html documentation automatically generated by \bbtkns. \end{itemize} -In these sections, you can set : +You can additionally set: \begin{itemize} +\item The \textbf{version} of the package. -\item The \textbf{libraries used} by the package : \vtk, \itk, \gdcm, \gsmis, \wx. The mecanisms to find these libraries, their sources and to link against them are automatically handled by the \cmake files installed by \bbCreatePackage. You just have to uncomment a line to use one of these libraries. +\item The \textbf{libraries} that will be used by the package. The mechanisms to find these libraries, their sources and to link against them are automatically handled by the \cmake files installed by \bbCreatePackagens. You just have to uncomment a line to use one of these libraries: \vtkns, \itkns, \gdcmns, \gsmisns, \wxns. +\item The \textbf{core \bbtk packages} that will be used by the package as \CPP libraries +(if you need to use the black boxes of these packages in your \CPP code, +i.e. include some header and link with the library). +The mechanisms to find these libraries, +their sources and to link against them are automatically handled +by the \cmake files installed by \bbCreatePackagens. +You just have to uncomment a line to use one of these libraries. + +\item The \textbf{\CPP sources} of the package: you can list each input \CPP +file explicitly or tell \cmake to include in the project all the \CPP files +of the 'src' directory (default). To do this, you have to comment/uncomment appropriate lines in the file. Be careful with lines containing the opening and closing parentheses. + +\item The \textbf{\xml sources} of the package: you can list each input \xml +file explicitly or tell \cmake to include in the project all the \xml files +of the 'src' directory (default). Here you also have to be careful when commenting/uncommenting lines with opening and closing parentheses. + +\item The \textbf{boxes \bbs sources} of the package: you can list each +input \bbs +file explicitly or tell \cmake to include in the project \emph{all} +the \bbs files of the 'bbs/boxes' directory (default, recommended). Here you also have to be careful when commenting/uncommenting lines with opening and closing parentheses. + +\item The \textbf{appli \bbs sources} of the package: +you can list each input \bbs +file explicitly or tell \cmake to include in the project \emph{all} +the \bbs files of the 'bbs/appli' directory (default, recommended). Here you also have to be careful when commenting/uncommenting lines with opening and closing parentheses. + +\item \textbf{Additional include directories}. Set it if your package needs to include source files that are not in the package directory, typically if it depends on another library that is not one of the libraries automatically handled (\vtkns, \itkns...) and that you did not find with the +\texttt{FIND\_PACKAGE} mechanism of \cmakens. + +\item \textbf{Additional libraries} to link against. Set it if your package needs to link against another library that is not one of the libraries automatically handled (\vtkns, \itkns...) and that you did not find with the +\texttt{FIND\_PACKAGE} mechanism of \cmakens. + +\item \textbf{Additional link directories} in which to find libraries not +automatically handled and that you did not find with the +\texttt{FIND\_PACKAGE} mechanism of \cmakens. -\item A \textbf{description} of the package, which will appear in the help of your package or in its html documentation automatically generated by \bbdoc. -\item The \textbf{version} of the package. -\item The \textbf{\xml sources} of the package : you can list each input \xml file explicitly or tell \cmake to include in the project \emph{all} the \xml files of the directory. -\item The \textbf{\CPP sources} of the package : you can list each input \CPP file explicitly or tell \cmake to include in the project all the \CPP files of the directory. -\item \textbf{Additional include directories}. Set it if your package needs to include source files which are not in the package directory, typically if it depends on another library which is not one the libraries automatically handled (\vtk, \itk...). -\item \textbf{Additional libraries} to link against. Set it if your package needs to link against another library which is not one the libraries automatically handled (\vtk, \itk...). \end{itemize} Of course, this is only a framework and you can add any other \cmake commands @@ -339,73 +368,88 @@ in the file. % ========================================== \section{Creating a new box} +\label{CreateBlackBox} % ========================================== % ========================================== \subsection{Principles} % ========================================== -\subsubsection{\texttt{C++} or \texttt{XML} ?} -There are two ways to create a new black box in an existing package : +% ========================================== +\subsubsection{\texttt{C++} or \texttt{XML}?} +% ========================================== +There are two ways to create a new black box in an existing package: \begin{itemize} -\item Write an \xml description file which will be automatically -translated in \CPP by the \bbfy application (recommanded). +\item Write an \xml description file that will be automatically +translated into \CPP by the \bbfy application during build (recommended). \item Write the \CPP code of the box using \bbtk macros. \end{itemize} -\subsubsection{From which \bbtk class inherit ?} - -Apart from this choice of the description langage to use, -there is an important choice to do concerning the implementation of the box. -In \CPP, a black box is nothing but a class which has the standard -interface of all black boxes : what's its name ? inputs ? outputs ? and so on. +% ========================================== +\subsubsection{From which \bbtk class inherit?} +% ========================================== +Apart from the choice of the description language to be used, +there is an important choice to make concerning the implementation of the box. +In \CPPns, a black box is nothing but a class that has the standard +interface of all black boxes, giving access to its name, inputs, outputs, and so on. The abstract description of this interface is done in the class -\texttt{bbtk::BlackBox} and is implemented in its child classes : +\texttt{bbtk::BlackBox} of the \bbtk library +and is implemented in its children classes: \texttt{bbtk::AtomicBlackBox} and \texttt{bbtk::WxBlackBox} \footnote{all the classes of the \bbtk library are in a \emph{namespace} called \texttt{bbtk} and the \CPP header of a class called \texttt{NameOfAClass} is in the file called \texttt{bbtkNameOfAClass.h}}. -To create a new black box, you have to inherit one of these two -concrete classes in order to inherit the black box interface and a + +To create a new black box, you have to inherit from one of these two +actual classes in order to inherit the black box interface and a particular implementation of this interface. + If your black box is a \emph{Widget} black box, -that is a black box which has (or is) +that is a black box that has (or is) a piece of a graphical interface based on the \wx library, -then it must inherit the class \texttt{bbtk::WxBlackBox}. +then it must inherit from the class \texttt{bbtk::WxBlackBox}. -Concretely, a \texttt{bbtk::WxBlackBox} is associated to +Concretely, a \texttt{bbtk::WxBlackBox} is associated to a \texttt{wxWindow} and must be able to return a pointer to it. If your black box is not a widget black box -(that is : doesn't returns a pointer to a \emph{Widget}), +(that is: does not return a pointer to a \texttt{wxWindow}), it must inherit from \texttt{bbtk::AtomicBlackBox}. + +NOTE: \emph{modal dialogs} +that are created and destroyed at the end of the process +method of the box are NOT \texttt{WxBlackBoxes}: +they do not return a \texttt{wxWindow}, +see the code of \texttt{wx::FileSelector} for example. -\subsubsection{Inherit or encapsulate ?} +% ========================================== +\subsubsection{Inherit or encapsulate?} +% ========================================== -Now, your black box will do something (hopefully !). +Now, your black box will do something (hopefully!). When you decide to write a new black box, you should be in one of these three cases : \begin{enumerate} -\item You already have a \texttt{C}-like function which -does the processing that you wish to 'blackboxify' -\item You already have a \CPP class which -does the processing that you wish to 'blackboxify' +\item You already have a \texttt{C}-like function that +does the processing and that you wish to 'blackboxify' ('bbfy' in short). +\item You already have a \CPP class that +does the processing and that you wish to 'bbfy' \item You start from scratch without any existing code \end{enumerate} The idea of \BBTK is to embed processing codes into -\CPP objects which have a standard and generic interface - +\CPP objects that have a standard and generic interface - namely black boxes - to be able to chain arbitrary processes afterwards. -In \CPP, in order to embed an existing processing \emph{class} -into a standard interface you only have two possibilities : +In \CPPns, in order to embed an existing processing \emph{class} +into a standard interface you only have two possibilities: \begin{enumerate} -\item {\bf Inherit} the existing processing class -\emph{and} the interface class (e.g. \texttt{bbtk::AtomicBlackBox}). -In this case you have to : +\item {\bf Inherit} from the interface class (e.g. \texttt{bbtk::AtomicBlackBox}) +\emph{and} from the existing processing class. +In this case you have to: \begin{enumerate} \item make the link between the inputs and outputs of the black box and the interface of the inherited class @@ -415,14 +459,15 @@ method of the inherited class in the processing method of the black box. \item {\bf Encapsulate} the existing processing class in a class inherited from the interface class (e.g. \texttt{bbtk::AtomicBlackBox}). -In this case you have to : +In this case you have to: \begin{enumerate} -\item declare it as a member of the black box, +\item declare an instance of the processing class +as a member of the black box, \item instantiate it at the right time (either in the constructor or in the processing method of the black box) \item in the processing method of the black box : \begin{enumerate} -\item set the inputs of the member procesing class with the inputs of the black box, +\item set the inputs of the member processing class with the inputs of the black box, \item call the processing method of the encapsulated class \item set the ouputs of the black box with the outputs of the encapsulated class. @@ -430,78 +475,23 @@ class. \end{enumerate} \end{enumerate} -If you wish to 'blackboxify' a C-like \emph{function}, +If you wish to 'bbfy' a C-like \emph{function}, you do not have the choice, you can only use the second mechanism, namely encapsulation. -Obviously, the inheritance mechanism is more powerfull -and - when it is possible to use it - it demands less effort -because, as we will see, in \bbtk you can directly +Obviously, the inheritance mechanism is more powerful +and - when it is possible to use it - it demands less effort. +Indeed, as we will see, in \bbtk you can directly link the accessors to the input and output data of the box to the accessors of the inherited processing class, -as well as the procesing method of the black box +as well as the processing method of the black box to the processing method of the inherited processing class, very much like a callback mechanism. +%\itk and \vtk classes -\subsubsection{How to generate a Black Box skeleton} - -Run \texttt{bbStudio}, choose \texttt{Tools} in the menu bar, option -\texttt{Create Black Box}. -You will be shown something like in fig. \ref{bbCreateBlackbox} : - -\begin{figure}[!ht] -\caption{\label{bbCreateBlackbox}Create Black Box} -\begin{center} -\includegraphics[width=0.6\textwidth]{bbCreateBackbox.png} -\end{center} -\end{figure} - - -\subsubsection{Informations to provide} - -Finally, to create a new black box, you will have to give : -\begin{enumerate} - \item The {\bf name} of the box - \item The {\bf package} to which the box belongs (can we do it automatically ? LG : think about it) - \item The {\bf author}(s) of the box - \item A {\bf description} of the box - - \item Its {\bf type}, either - \begin{enumerate} - \item a standard one (\texttt{std-template}) - \item a VTK Polydata Algorithm based box (\texttt{VTK\_PolydataAlgorithm-template}), - \item a VTK Image Algorithm based box (\texttt{VTK\_ImageaAlgorithm-template}), - \item if it uses the wxWidget Library (\texttt{widget-template}) - \end{enumerate} - - \item The output format of the file, either a C++ file or an XML file. - - %\item $[$Optional$]$ The additional {\bf include files} which are necessary for the code to compile (classes or functions declarations ...) - %\item $[$Optional$]$ The other {\bf parent(s)} of the box (which must be known hence their header included) - %\item $[$Optional$]$ The {\bf namespace} to which the box belongs - %\item The box {\bf inputs} and {\bf outputs}, and for each one : - %\begin{enumerate} - %\item Its {\bf name} : the string which will identify the input or output - %\item Its {\bf type} : any \CPP type, either a basic type or a user defined type (class ...) but which must be known, hence the necessary files must be included. - %\item Its {\bf help} : a string describing the input / output - %\end{enumerate} -%\item Its {\bf processing} code, which can be a simple callback or an arbitrary complex code -\end{enumerate} - -WARNING: -Under Linux, for reasons we shall not discuss here, you'll get an error message : - - \texttt{No such file or directory} - -Have a look at the console, you'll see a shell command (whose syntax is OK although there is is a lot of -quotes),something like : - - \texttt{ "/usr/local/bin/bbCreateBlackBox" "/home/jpr/Desktop/essai" MyPackage - myVtkPolydataBlackBox VTK-PolyDataAlgorithm C++ 'author1, author2' 'myVtkPolydataBlackBox description'} - - Just copy the command, and run it manually. - +% ========================================== \subsubsection{Input and output accessors} +% ========================================== When you encapsulate a processing class or a C function or when you write down a black box from scratch, @@ -518,7 +508,7 @@ or an output of a black box then two \emph{accessors} for this input or output are generated : one to \emph{get} the value of the input or output and one to \emph{set} it. -These accessors have normalized names : +These accessors have normalized names: \begin{itemize} \item The declaration of an {\bf input} called \texttt{NAME} and @@ -544,21 +534,60 @@ For example, declaring an input called \texttt{Image} would generate the two accessors \texttt{bbSetInputImage} and \texttt{bbGetInputImage}. -Note that +Note that: \begin{itemize} \item All \bbtk methods are prefixed by \texttt{bb} to avoid conflicts with potential inherited methods. -\item An input and an output can have the same name (e.g. 'Image'). -No conflict between accessors occur (e.g. -four distinct accessors are created : +\item An input and an output can have the same name (e.g. 'Image') and no conflict between accessors occurs, since +four distinct accessors are created, as follows: \texttt{bbSetInputImage}, \texttt{bbGetInputImage}, -\texttt{bbSetOutputImage} and -\texttt{bbGetOutputImage}). +\texttt{bbSetOutputImage}, +\texttt{bbGetOutputImage}. \end{itemize} + +% ========================================== +\subsection{Generate the black box skeleton} +% ========================================== + +The command line application \bbCreateBlackBox +allows to create a skeleton \CPP or \xml files for a new black box. +It has a rather complex usage, +we recommend you use the graphical interface to it +which is accessible with \bbStudio menu \texttt{Tools $>$ Create black box}. +You will first be prompted to choose the location for the new black box, which should be the \texttt{src} directory of your package sources tree. +Then the actual interface will appear, which looks like in fig. \ref{bbCreateBlackBox}. + +\begin{figure}[!ht] +\caption{\label{bbCreateBlackBox}Create Black Box interface} +\begin{center} +\includegraphics[width=0.6\textwidth]{bbCreateBackBox.png} +\end{center} +\end{figure} + +You will have to give: +\begin{enumerate} + \item The {\bf name} of the box. + \item The {\bf package} to which the box belongs. Caution! You may not make a mistake, otherwise you will be unable to carry out the final build of your project. + \item The {\bf author}(s) of the box. + \item A {\bf description} of the box. + + \item Its {\bf type}, which is one of the following: + \begin{enumerate} + \item \emph{Basic}, has no particular Input/Output, inherits from \texttt{AtomicBlackBox}; + \item \emph{Widget}, has an output \texttt{Widget}, type \texttt{wxWindow*}, inherits from \texttt{WxBlackBox}; + \item \emph{VTK PolyDataAlgorithm}, has standard vtk Inputs/Outputs, inherits from \texttt{AtomicBlackBox} and from \texttt{vtkPolyDataAlgorithm}; + \item \emph{VTK ImageAlgorithm}, has standard vtk Inputs/Outputs, inherits from \texttt{AtomicBlackBox} and from \texttt{vtkImageAlgorithm}. + + \end{enumerate} + + \item The output format of the file, either a C++ file or an XML file. +\end{enumerate} + % ========================================== \subsection{\texttt{XML} description of a box} +\label{sec:XML-box} % ========================================== % ========================================== @@ -566,7 +595,7 @@ four distinct accessors are created : % ========================================== Let us examine the \texttt{xml} file -describing the \texttt{Add} box of the \texttt{std} package : +describing the \texttt{Add} box of the \texttt{std} package: \begin{file}{\texttt{packages/std/src/bbAdd.xml}} \small @@ -597,187 +626,425 @@ describing the \texttt{Add} box of the \texttt{std} package : \end{verbatim} \end{file} -The tags and their role are easily understandable. - -As the box is not a widget, we inherit implicitely from -\texttt{bbtk::AtomicBlackBox}. +As the box is not a widget, it implicitly inherits from +\texttt{bbtk::AtomicBlackBox} (the default). - -The only part of the file which needs a bit of explaination is +The tags and their role are (hopefully) easily understandable. +The only part of the file, which needs a bit of explanation, is the body of the \texttt{process} tag, which describes the actual code to execute in the box. This code must be enclosed in a \texttt{
} tag 
 to tell the \xml parser not to interpret it as \xml instructions. 
-This is necessary to be able to use any symbol, 
-like the \texttt{<} and \texttt{>} which have a 
-special meaning in \xml. 
+Thus we will be able to use such symbols as \texttt{<} and \texttt{>}, which have a 
+special meaning in \xmlns. 
+
 In the case of the \texttt{Add} box, the process code 
-is very simple : remember that 
-\texttt{bbGetInputIn1()} is the 
-accessor to the input \texttt{In1} declared above and 
-\texttt{bbGetInputIn2()} is the 
-accessor to the input \texttt{In2};  
+is very simple. Remember that 
+\texttt{bbGetInputIn1()} and 
+\texttt{bbGetInputIn2()} respectively are the 
+accessors to the inputs \texttt{In1} and \texttt{In2} declared above;  
 the code simply adds the values of the two inputs 
 and sets the output \texttt{Out} with the resulting value.
 
-To describe your own black boxes in \xml code, 
-you must modify the xml file generated in previous step : 
+Note that the afore cited code of the \texttt{Add} box was cleaned so as to only contain the necessary lines.
+The actual \xml file generated by \bbCreateBlackBox utility is more complete. 
+It contains many comments to guide you, it already includes the informations you provided when running the \bbCreateBlackBoxns, and it looks like this:
+
+\begin{file}{\texttt{MyPackage/bbMyPackageMyBox.xml}}
+\small
+\begin{verbatim}
+
+
+
+
+  
+
+  myself
+  no idea of what it can do
+  __CATEGORY__
+  
+
+  
+  
iostream

+  
+
+  
+  
+
+  
+  
+  
+  
+  
+
+  
+
+  
+  
+    bbSetOutputOut( bbGetInputIn() );
+    std::cout << "Output value = " <
+  
+  
+
+  
+  
+  
+    bbSetInputIn(0);
+  

+  
+
+  
+  
+  
+  

+  
+
+  
+  
+  
+  

+  
+  
+
+
+
+
+
+
+
+
+\end{verbatim}
+\end{file}
+
+To describe your own black box in \xml code, 
+you have to modify this \xml file as follows: 
 
 \begin{enumerate}
-  \item Complete the description and author tags if you feel like.
-  \item add the \texttt{\#include} directives to be put in the generated \texttt{.h} file
+  \item Complete the category, description and author tags if you feel like.
+  \item Add the \texttt{\#include} directives to be put in the generated \texttt{.h} file (the example given in the \xml file includes the standard \texttt{iostream} header; depending on the actual file to be included, you will have to put or omit the \texttt{.h} extension).
   \item Create your inputs and outputs
   \item Fill in the process tag
   \item Fill in the constructor tag
   \item Fill in the copyconstructor tag
   \item Fill in the destructor tag
-  \item Pray
 \end{enumerate}
 
 
+
 % ==========================================
-\subsubsection{Specific \texttt{xml} tags for \texttt{itk::ImageToImageFilter} classes bbfication}
+\subsubsection{Writing new widget boxes in \xml}
 % ==========================================
+See the example \texttt{packages/wx/src/bbwxOutputText.xml}
+
+\begin{file}{\texttt{packages/wx/src/bbwxOutputText.xml}}
+\small
+\begin{verbatim}
+
+
+  laurent.guigues at creatis.insa-lyon.fr
+  Text zone to be inserted into a window (wxStaticText)
+                                                             
+  
+
+  
+  
+
+  
+   bbSetOutputWidget( new wxStaticText ( bbGetWxParent() , -1 , _T("") ) );
+   Process();
+  

+ 
+  
+   std::string msg;
+    if (bbGetInputTitle()!="")
+      {
+        msg = bbGetInputTitle()+": " + bbGetInputIn();
+      }  
+    else 
+      {
+        msg = bbGetInputIn();
+      }
+   ((wxStaticText*)bbGetOutputWidget())->SetLabel( bbtk::std2wx( msg ) ); 
+  

+  
+  
 
+    bbSetInputIn("");
+    bbSetInputTitle("");
+  
    
+
+
+\end{verbatim}
+\end{file}
+
+Explanations:
+\begin{itemize}
+	\item The attribute \texttt{widget} of the \texttt{blackbox} tag instructs 
+		\bbfy that the box inherits from \texttt{bbtk::WxBlackBox}.
+	\item An output called \texttt{'Widget'} of type \texttt{wxWindow*} is 
+		automatically declared (you do not have to do it).
+	\item The tag \texttt{createwidget} provides the body of the method which creates the widget. 
+		At the end of this method the output \texttt{'Widget'} must 
+		have been set with the newly created \texttt{wxWindow}. 
+		Here we create a new \texttt{wxStaticText}.
+		The parent of the widget to create MUST BE the one provided by the method 
+		\texttt{bbGetWxParent()} which returns a \texttt{wxWindow*}. 
+		To update the static text after creation we simply call the \texttt{Process} 
+		method.
+	\item The body of the \texttt{process} method simply concatenates the 
+		input \texttt{'Title'} (if non empty) and the input \texttt{'In'} and 
+		updates the \texttt{wxStaticText}. 
+		Remark that to get it, we use the \texttt{bbGetOutputWidget()} method 
+		which returns a \texttt{wxWindow*} which we cast into a 
+		\texttt{wxStaticText*} to use its specific method \texttt{SetLabel}.
+\end{itemize}
+
+More complex examples can be found in the \texttt{package/wx/src} folder.
 
 % ==========================================
-\subsubsection{Specific \texttt{xml} tags for \texttt{vtkImageAlgorithm} classes bbfication}
+\subsubsection{Specific \texttt{xml} tags for \texttt{vtkImageAlgorithm} classes bbfication by inheritance}
+\label{sec:Specific-VTK}
 % ==========================================
+To 'bbfy' \texttt{vtkImageAlgorithm} classes such as \texttt{vtkImageAnisotropicDiffusion3D},  
+we recommend you the use of \xmlns. You can have a look at the examples 
+in the \vtk core package 'src' folder. 
+The bbfication mechanism is inheritance. In the \xml file you have to add:
+
+\begin{itemize}
+\item the attribute \texttt{type="VTK\_ImageAlgorithm"} 
+	to the \texttt{blackbox} tag:
+	\begin{verbatim}
+		
+	\end{verbatim}
+
+\item the tag \texttt{vtkparent} which gives the \vtk parent of the box, e.g.:
+	\begin{verbatim}
+		 vtkImageAnisotropicDiffusion3D 
+	\end{verbatim}
+
+\item an \texttt{include} tag to include the appropriate \vtk parent header, such as:
+	\begin{verbatim}
+		 vtkImageAnisotropicDiffusion3D.h  
+	\end{verbatim}
+\end{itemize}
+
+The \vtk algorithm inputs/ouputs are wrapped directly using the 
+\texttt{special} attributes of the \texttt{input} and \texttt{output} tags. 
+A typical example is:
 \begin{verbatim}
+
+
+\end{verbatim}
+In this example, the attribute \texttt{special="vtk input"} of the input 'In' definition 
+directly connects it to the input of the vtk object the box inherits. 
+No additional code is needed, the vtk object will directly receive 
+the value of this input. 
+The same mechanism holds for the output.
+
+Similarly, the attribute \texttt{special="vtk parameter"} of the \texttt{input} tag permits to directly 
+wrap the parameters of the vtk object, which are declared using 
+\texttt{vtkSetMacro} and \texttt{vtkGetMacro}, e.g.:
+\begin{verbatim}
+
+\end{verbatim}
+Here, the attribute \texttt{special="vtk parameter"} 
+of the input \texttt{DiffusionThreshold} instructs \bbfy to call the \texttt{SetDiffusionThreshold} and 
+\texttt{GetDiffusionThreshold} 
+methods of the \vtk parent, when needed. 
 
-
+{\bf NOTE:} 
+For this mechanism to work, 
+the name of the \bbtk input MUST be the same as the name 
+of the \vtk parent parameter. 
 
-the vtk ImageAlgorithm class it inherits from
-
-
+No \texttt{process} method has to be given, 
+\bbfy generates a process body for you, which simply calls the 
+\texttt{Update()} method of the \vtk parent.
+
+{\bf NOTE:}
+You can write your own \texttt{process} code which will overload 
+the default. Don't forget to call \texttt{Update()}. 
+See \texttt{packages/vtk/src/bbvtkConeSource.xml} for an example.
 
-
-
-\end{verbatim}
 % ==========================================
-\subsubsection{Specific \texttt{xml} tags for \texttt{vtkPolyDataAlgorithm} classes bbfication}
+\subsubsection{Specific \texttt{xml} tags for \texttt{vtkPolyDataAlgorithm} classes bbfication by inheritance}
 % ==========================================
+To bbfy \texttt{vtkPolyDataAlgorithm} classes such as \texttt{vtkConeSource},  
+we also recommend the use of \xml (you can have a look at the examples 
+in the \vtk core package 'src' folder). 
+The bbfication mechanism is inheritance. 
+You have to use the same \xml tags and attributes as for wrapping a 
+\texttt{vtkImageAlgorithm} (see above): 
+
 \begin{verbatim}
-
+
 
 the vtk Polydata class it inherits from
-
-
+
+
+
+\end{verbatim}
 
-
-
+% ==========================================
+\subsubsection{Specific \texttt{xml} tags for \texttt{itk::ImageToImageFilter} classes bbfication by inheritance}
+\label{sec:Specific-ITK}
+% ==========================================
+
+to be written...
+
+\newpage
 
-\end{verbatim}
 % ==========================================
 \subsubsection{\bbfy \texttt{xml} tags reference}
 % ==========================================
 
-  
+% See tables \ref{xml_tags}, \ref{xml_tags2}
 % ==========================================
 \begin{table}[!ht]
 \caption{\label{xml_tags}
-\bbfy \texttt{xml} tags reference}
+\bbfy \texttt{xml} tags reference (part 1). \emph{'Cond' stands for 'Condition' (see Tab.\ref{xml_tags-conditions}), while 'Mult' stands for 'Multiplicity'}}
 \small
-\begin{tabular}{|lcllm{6cm}|}
+\begin{tabular}{|lcllm{5.7cm}|}
 \hline
-Tag & Attributes & Condition & Multiplicity & Description
- \\ \hline
-
-\texttt{} & \texttt{name} & - & 1 & The name of the box \\ \hline
-		& \texttt{type} & - & 1 & The type of the box. In: 
-	\{\texttt{standard} (default), 
-\texttt{ITK\_ImageToImageFilter},
-\texttt{VTK\_ImageAlgorithm},
-\texttt{VTK\_PolyDataAlgorithm}\} \\\hline
-& \texttt{generic} & a) & 0-1 &
-Generate the generic filter (see text)\\ \hline 
-
-\texttt{} & - & - & 0-n &  The description of the box. Multiple occurrence are concatenated \\\hline 
-\texttt{} & - & - & 0-n &  The author of the box. Multiple occurrence are concatenated \\\hline 
-\texttt{} & - & - & 0-1 &  The box category (if more than one, they are separated with commas) see Tab \ref{categories}\\\hline 
-\texttt{} & - & - & 1 &  The parent black box of the box.
-In: \{\texttt{bbtk::BlackBox, bbtk::WxBlackBox, bbtk::WxContainerBlackBox}\}\\\hline 
-\texttt{} & - & - & 1 &  The package of the box \\\hline 
-\texttt{} & - & - & 0-1 &  The namespace of the box. 
-Use \texttt{bbPACKAGE}, where \texttt{PACKAGE} is the name of the package\\\hline 
-\texttt{} & - & - & 0-n & Additionnal file to include 
-(generates : \texttt{\#include 'value'})\\\hline 
-
-\texttt{