1 % ==========================================
2 \documentclass[11pt,final,a4paper]{article}
5 \bbtkGuide[User's Guide]
6 % ==========================================
9 % ==========================================
12 \section{Introduction}
13 Note: pdf version of this User's Guide can be retrieved from the following URL:\\
14 \url{http://www.creatis.insa-lyon.fr/creatools/documentation}
15 % ==========================================
16 \subsection{What is bbtk?}
17 % ==========================================
18 \BBTK(\bbtkns) is a set of tools (\CPP libraries and executables)
19 providing a \CPP framework for the definition of elementary processing \emph{units}, called {\bf black boxes}, and the definition and execution of processing \emph{chains}
20 made up of these black boxes. \\
22 %It's a part of the \texttt{Creatools suite} composed mainly of :
30 %which depend on the OpenSource libraries:
38 % ==========================================
39 \subsubsection{The black box philosophy}
40 % ==========================================
42 \href{http://www.answers.com/topic/black-box-theater}{The Answers Dictionary} defines a {\bf black box} as
43 \emph{``A device or theoretical construct with known or specified performance characteristics
44 but unknown or unspecified constituents and means of operation''} \\
45 \href{http://en.wikipedia.org/wiki/Black_box_\%28disambiguation\%29}{Wikipedia}
46 defines a {\bf black box} as
47 \emph{``any component in a system in which only the input and output
48 characteristics are of interest, without regard to its internal mechanism
50 We should merge these definitions:
51 not only the inputs and outputs are of interest but also
52 \emph{what the box does!}
53 Hence, we would say that a black box is any \emph{\bf documented}
54 component of a system, letting the user know
55 \emph{\bf what} the box is supposed to do and
56 \emph{\bf how to use it}
57 but not \emph{\bf how it does it}. \\
59 \BBTK provides a systematic framework
60 to encapsulate (or ``wrap'') any
61 existing \texttt{C} or \CPP processing code into an object
62 (a black box) having a {\bf generic symbolic interface}, where
65 \item{\bf generic} means that the interface is \emph{the same}
66 for all boxes. Hence one does not need to know which particular
67 method allows, say, to set a particular input or
68 get a particular output of the box.
69 One can use a black box in a purely abstract way.
70 \item{\bf symbolic} means that a particular
71 input or output is referenced by a 'name', that is by a symbol
72 which identifies the input or output.
73 It also means that symbolic information (text) is
74 attached to a box: description of the box, author,
75 description of its inputs and outputs, etc.
78 (Actually, genericity is achieved because the interface is symbolic.
79 We let you think about this\dots)
81 Of course, symbolic data attached to a box may be
82 {\bf queried}: what are the inputs/outputs of the box?
83 what are their type? their description? etc.
84 This allows {\bf automatic documentation} of boxes.
86 The abstract definition of black boxes is the most basic
87 aspect of \BBTK architecture.
88 Another key aspect is the grouping of black boxes into
89 so called {\bf packages},
90 which are \emph{dynamic libraries} that can also
91 be queried, in particular about the boxes they provide.
92 The package structure then offers a mechanism similar to \emph{'plug-in'} mechanism.
93 \BBTK provides the methods to load a package at run-time,
94 and create instances of the boxes it contains.
96 These two mechanisms (black boxes and packages)
100 \item The definition of an {\bf interpreted script language},
101 which allows to manipulate packages and boxes very easily in symbolic way.
102 \BBTK provides one: \bbs (the Black Box Script language) and its interpreter
103 \bbi (the Black Box Interpreter).
104 \item {\bf Automatic documentation} of existing packages.
105 \texttt{html} documentation of packages is proposed by
109 Finally, these different components allow {\bf efficient}:
112 \item {\bf capitalization and reuse} of existing processing units,
113 including {\bf documentation}
114 \item {\bf testing, prototyping} in a very simple script language
115 \item {\bf inter-operability} between atomic processings that
116 have been written by different persons, using different libraries, etc.
119 % ==========================================
120 \subsubsection{\bbtk components}
121 % ==========================================
124 \item A \CPP {\bf\emph{library}} - called \bbtk - which defines a framework
125 (abstract classes) to develop black boxes and store them into
126 dynamic libraries, called black box \emph{packages}.
127 \item Different {\bf\emph{"core" black box packages}}:
129 \item {\bf\emph{std}}: the 'standard' package including basic useful boxes.
130 \item {\bf\emph{wx}}: basic graphical interface elements (widgets: sliders, buttons, etc. based on the \texttt{wxWidgets} library).
131 \item {\bf\emph{itk}}: the basic image processing package, based on the \itk library.
132 \item {\bf\emph{vtk}}: the basic images and surfaces processing and visualization package, based on the \vtk library.
133 \item {\bf\emph{wxvtk}}: widget boxes based on the \vtk library (2D and 3D visualization and
135 %\item {\bf\emph{creaImageIO}}: Provides hight level widgets to read images, including DICOM.
136 \item {\bf\emph{toolsbbtk}}: Tools for bbtk administration and package development.
138 \item A {\bf\emph{development environment}}, called \bbStudio, which provides:
140 \item An online {\bf\emph{script editor and interpreter}}
141 \item A powerful html {\bf\emph{help environment}}, integrating:
143 \item Online documentation scanning
144 \item Retrieving boxes on various criteria
145 \item Checking demos and examples
148 \item A standalone {\bf\emph{interpreter}}, called \bbins, which allows to
149 execute \bbs scripts or commands.
150 \item {\bf\emph{Various development utilities}}:
152 \item \bbfy generates the \CPP code of a black box from a
153 description file written in \texttt{xml}.
154 %\item \bbdoc generates the html documentation of a black box package
155 %(author, description, description of its black boxes :
156 %author, description, inputs, outputs, and so on).
157 \item \bbCreatePackage allows to create the basic file architecture
158 to start the development of a new black box package.
159 \item \bbCreateBlackBox allows to create the basic file architecture
160 to start the development of a new black box, that will be included in an already existing package.
161 \item \texttt{bbs2cpp} translates a \texttt{.bbs} script into a \CPP file.
162 \item \bbc (sorry: Linux only, for the moment) that compiles \texttt{.bbs} scripts into executables.
163 \item \bbRegeneratePackageDoc which creates the html documentation of the Package.
164 \item \bbRegenerateBoxesLists which creates the html pages of the various lists of all the currenly installed boxes.
165 \item \bbPlugPackage which automatically incorporates a new package.
167 \item A full {\bf\emph{documentation}} that can be printed (pdf), browsed (html) and
168 queried through keywords.
171 The general architecture of \BBTK
172 is shown in figure \ref{bb-architecture}.
175 \caption{\BBTK architecture}
177 \includegraphics[width=0.6\textwidth]{bb-architecture.png}
179 \label{bb-architecture}
184 % ==========================================
185 \subsection{Content of this guide}
186 % ==========================================
188 Read this \texttt{Users' Guide} if you want to learn how to use
189 \bbtk development environnement (\bbStudions) and how to write black box scripts.\\
190 If your aim is to write your own Packages and Black Boxes, you have to read the
191 \texttt{Package Developper's Guide}.
193 % ==========================================
196 \section{Getting started with bbStudio}
198 % ==========================================
201 % ==========================================
202 \subsection{The interface}
203 % ==========================================
206 %\vspace{0.5cm}\hrule
207 %\section{The Development environment (bbStudio)}
210 Just run it, typing in a console \bbStudio
211 or clicking on its icon or its menu entry.
212 You'll get something like in figure
213 \ref{bbi-fig-bbStudio-gui}
214 (the exact appearance of \bbStudio is Operating System and \bbtk version dependent).
216 %At start, \bbStudio opens with a very minimal 'How to use' in the middle.
217 %Don't forget to read it: it will vanish at the first mouse click.
221 %\caption{The bbStudio Development environment interface at start time}
223 %\includegraphics[width=0.7\textwidth]{bbStudioMainPageStart.png}
225 %\label{bbi-fig-bbStudio-gui-start}
228 %Let's have a look at the resized window :
230 \caption{The bbStudio Development environment interface}
232 \includegraphics[width=0.7\textwidth]{bbStudioMainPage.png}
234 \label{bbi-fig-bbStudio-gui}
237 The interface is divided into four parts: \texttt{Files}, \texttt{Messages},
238 \texttt{Command}, \texttt{Help}.
239 It is written using the Advanced User Interface library of wxWidgets
241 whose 'docking manager' allows windows and toolbars to be floated/docked
243 Feel free to resize/reposition any part you want.
244 Your preferences will be kept next time you run again \bbStudions.
246 %Please don't use this feature at learning time
247 %(the snapshots of this document wouldn't match with your screen ...)
249 \subsubsection{'Files' part}
250 \label{bbi-FilesPart}
252 It is the \bbs script editor (see section \ref{Scripting} to learn about scripting).
254 If you load a file holding a script, it will be displayed in this area, and you will be
255 able to modify it, to save it, to save-as it and to run it, using the respective
256 lower-toolbar buttons (see figure \ref{lowertoolbar})
259 \caption{The 'Files' lower toolbar}
261 \includegraphics[width=0.7\textwidth]{lowertoolbar2.png}
268 % \item {\bf\emph{New file}}: Create a new file to hold a script
269 % \item {\bf\emph{Open file}}: Open an already existing file holding a script
270 % \item {\bf\emph{Close file}}: Close a file holding a script
271 % \item {\bf\emph{Save file}}: Save he current file (if modified)
272 % \item {\bf\emph{Save file as}}: Save he current file under a different name
273 % \item {\bf\emph{Run file}}: Execute the script you just loaded/modified/written
274 % \item {\bf\emph{cursor position}}: column number : line number
278 \subsubsection{'Messages' part}
279 \label{bbi-MessagesPart}
281 Two kinds of messages will be output here:\\
283 \item {\bf\emph{System messages:}} produced by the kernel, in case of a user mistyping, or an execution error.\\
284 \item {\bf\emph{Script messages:}} produced by the \bbtk equivalent of \texttt{printf}
285 or \texttt{std::cout} in user programs.
289 \subsubsection{'Command' part}
290 \label{bbi-CommandPart}
292 You can type here \bbs commands which are executed on the fly.
293 The buttons are shortcuts to the most frequently used commands.
294 The command (or button) \texttt{help} permits to print in the \texttt{Message} zone the list of all recognized commands, while the command \texttt{help} \emph{command\_name} provides the help on the selected command.
296 \subsubsection{'Help' part}
297 \label{bbi-HelpContentsPart}
299 The 'Help' part of \bbStudio is used to browse the html help of \BBTKns. You can find there various guides (see section~\ref{sec:guides}) and detailed information about each black box available (see section~\ref{sec:boxes_help}). They can be browsed alphabetically, by package and by category. Two special categories, demos and examples, are available via direct links (see section~\ref{sec:demos_examples}).
302 % ==========================================
307 % ==========================================
308 % ==========================================
309 % ==========================================
310 % ==========================================
311 % ==========================================
315 % ==============================================
316 \subsection{Online Help}
317 % ==============================================
319 Various levels of help are supplied by \bbStudions.
321 % ==========================================
322 \subsubsection{Command-line help}
323 % ==========================================
326 The 'working' area (the left one, as opposed to the (\texttt{Help}) area, on the right side) is composed of:
327 one single line area (\texttt{Command}), at the bottom, in which you can enter your commands, and
328 a multiple line zone (\texttt{Messages}) in which the command interpreter prints out the result of your commands.
329 %The upper part contains the script editor; we shall not use it right now, you may reduce it.
330 Command-line help for the black box scripting language \bbsns (see \ref{Scripting}) can be obtained in this zone. \par
331 As mentioned above, the command (or button) \texttt{help} permits to print in the \texttt{Message} zone the list of all recognized commands, while the command \texttt{help} \emph{command\_name} displays in this zone the help about the selected command.\par
332 The command \texttt{help} \emph{package\_name} displays in the \texttt{Message} zone a short information about the selected package, provided that this package was previously loaded (Note that you can know which packages were loaded by executing the command \texttt{help packages}). Furthermore, it simultaneously displays in the right zone (\texttt{Help}) the corresponding full html help available.\par
333 In a similar way, one can obtain the information about any box from the loaded packages, by executing the command \texttt{help} \emph{box\_name}. Note that some boxes may be unavailable if the command \texttt{load} was used to load the package, since this command only loads the boxes in binary. Some boxes are defined in script files. To be sure that all the boxes from the package are loaded the command \texttt{include} is to be preferred.\par
334 You can also get the list of the objects currently present in the workspace, by executing the command \texttt{help workspace}.
336 % ==========================================
337 \subsubsection{Guides}
339 % ==========================================
341 All the guides can be browsed in html version in the \texttt{Help} part of \bbStudions. Their pdf versions (except Doxygen documentation) can be retrieved from:\\
342 \url{http://www.creatis.insa-lyon.fr/creatools/documentation}
345 \item {\bf\emph{User's Guide}}: This guide!
346 \item {\bf\emph{Package Developer's Guide}}: Step-by-step "How-to" for programmers who want to create their own
347 black boxes/packages.
348 % \item {\bf\emph{Developper's Guide}}: For bbtk kernel developpers only. (This one is probably not very much
349 % up-to-date, since we spend more time in developping than writing documentation that's not of user concern).
350 % \item {\bf\emph{Reference Manual}}: Contains a exaustive description of all the features for all the commands.
351 %\item {\bf\emph{Booklet}}: Vade mecum.
352 \item {\bf\emph{Doxygen Documentation}}: Doxygen source browser.\\ Automatically generated from source files. Should only concern the kernel developers.
358 % ==========================================
359 \subsubsection{Boxes Help}
360 \label{sec:boxes_help}
361 % ==========================================
362 Lists of currently available boxes from installed packages, sorted according to the following criteria:
364 \item {\bf\emph{Alphabetical list}}%: This is the 'zero-level' of retrieving.
365 \item {\bf\emph{List by package}}%: The boxes are indexed by package they belong to
366 \item {\bf\emph{List by category}}:
367 Each box is indexed by a list of keywords, called 'categories', such as '\texttt{read/write}',
368 '\texttt{filter}', '\texttt{viewer}', ...
369 A given box may belong to more than one \texttt{category}, however some categories are mutually exclusive.
370 Standard categories are:
372 \item\texttt{atomic box}/\texttt{complex box}\\
373 Any box is either atomic or complex.\\
374 The former are 'atomic' units written in C++ and available in binary form.\\
375 Any pipeline built up as an assembly of several black boxes (atomic or complex), and described in \bbs script language is itself viewed as a complex black box, and hence tagged as belonging to the latter category.
376 \item\texttt{example} / \texttt{demo} / \texttt{application} (see \ref{sec:demos_examples})\\
377 These ones are scripts that produce a result when executed (i.e. they
378 execute a pipeline), as opposed to the scripts that only define complex boxes but do not instanciate and execute boxes.
380 \item\texttt{example}: It is just a (simple) example, for programmers, of how to use a given feature. The \texttt{Examples} link on the starting page links to the list of the boxes of this category.
381 \item\texttt{demo}: It can be a 'good looking' (a.k.a 'sexy') example of some sophisticated work, done only by using \texttt{bbtk}. The \texttt{Demos} link on the starting page links to the list of the boxes of this category.
382 \item\texttt{application}: It is a final application, end-user intended (e.g. association of a DICOM image browser, reader, viewer with some interaction and processing)
384 \item\texttt{widget}: A piece of graphical interface (based on \texttt{wxWidgets}).
385 \item\texttt{dicom}: A box related to medical images in Dicom format.
386 \item\texttt{viewer}: A box allowing to view something (e.g. an image).
387 \item\texttt{read/write}: An I/O-related box.
388 \item\texttt{mesh}: A mesh-related box.
389 \item\texttt{filter}: A filter, mainly image filters.
390 \item\texttt{image}: An image-related box.
391 \item\texttt{3D object creator}: A box which creates a 3D object to be injected into a 3D view (e.g. a plane, a surface).
392 \item\texttt{math}: Maths of course.
393 \item\texttt{misc}: Miscellaneous...
395 Remark that the list of categories is 'auto-extensible': each time a new box is created which belongs to a new category and the boxes list is regenerated, the new category appears in the list, holding the new box. The above list only contains the categories used in the packages provided with current \bbtk release.
396 \item {\bf\emph{ List of adaptors}}: The adaptors are a special type of black boxes that are used internally to perform type conversions. Although they are not end user intended, you may see their list. Adaptors belong to the \texttt{adaptor} category.
398 For each box, the html \texttt{Help} provides the informations necessary to use it: its name, its purpose, the descriptions of its inputs/outputs and the name of the package (or script file) that is to be loaded. Additionally, for all boxes but the atomic ones (i.e. for all boxes defined in \bbs script language), the corresponding script is available via [\texttt{source}] link. Actually, by clicking on this link, one loads the script into the \texttt{Files} area where it can be analyzed, edited and executed.
400 % ==========================================
401 \subsubsection{The Package Browser}
402 \label{Package_Browser}
403 % ==========================================
405 The package browser is a standalone application \texttt{bbPackageBrowser}, which
406 dynamically loads and queries the available packages.
407 It is thus a smarter tool than the static html documentation.
408 You can run it independently or from \bbStudio using either the button labeled \texttt{Start Package Browser} of the 'Command' part or the corresponding entry in the menu 'Windows'.
409 Note that it may take some time to start because it loads all available
411 Its appearance is reproduced in figure \ref{imPackage_Browser}.
414 \caption{The Package Browser}
416 \includegraphics[width=0.6\textwidth]{Package_Browser.png}
418 \label{imPackage_Browser}
421 It allows you to find boxes by use of a multi-criteria filtering principle:
422 the boxes listed are the ones the attributes of which match \emph{all} the
423 words entered in the 'Filter' part.
424 You can get the whole description of a given box by clicking on its name.
429 \item It is case sensitive, i.e '\texttt{Button}'
430 will give different results than '\texttt{button}'.
431 \item After typing a filtering string, you have to validate it by pressing the 'Enter' key, in order to update the display of the boxes list.
432 \item A filtering string only needs to match a subpart of the related attribute of a box.
433 For example, entering 'utt' in the 'Name' attribute will match a box called 'Button'.
439 \item \texttt{Package}: The name of the package to which the box belongs (e.g. \texttt{wxvtk}, \texttt{std}).
440 \item \texttt{Name}: The name of a box or an application (e.g. \texttt{Reader}, \texttt{example}).
441 \item \texttt{Description}: A part of the description of a box (e.g. \texttt{3D}, \texttt{image}).
442 \item \texttt{Category}: The categories of the box (e.g. \texttt{demo}).
443 \item \texttt{Input/Output Type}: The \CPP type of an input or output (e.g. \texttt{vtkImageData*}, \texttt{std::string}).
444 \item \texttt{Input/Output Nature}: The \texttt{nature} of an input or output (e.g. \texttt{file name}, \texttt{signal}).
447 %If 'Show widgets' is selected then
454 % ==========================================
458 % ==============================================
459 \subsection{Running Demos and Examples}
460 \label{sec:demos_examples}
461 % ==============================================
463 As previously mentioned, the links \texttt{Demos} and \texttt{Examples} in the 'Help' part (See figure \ref{HelpContents}), give access to special complex boxes from the respective categories. Here, we use an example, both to illustrate the use of this help and to explain a short \bbs script.\\
466 \caption{\bbStudio 'Help' panel}
468 \includegraphics[width=0.7\textwidth]{HelpContents.png}
474 Select \texttt{Examples} link. You will get a list of examples (See figure \ref{example}).
476 Note: due to an unfixed bug in Linux, you have to click on 'reload' to get it. \\
480 \caption{Examples list}
482 \includegraphics[width=0.7\textwidth]{example.png}
489 %\caption{\label{BoxCategories}Box Categories}
491 %\includegraphics[width=0.7\textwidth]{BoxCategories.png}
496 Select \texttt{wx::exampleSlider}.
499 \caption{Html documentation of example 'exampleSlider'}
501 \includegraphics[width=0.7\textwidth]{exampleSlider.png}
503 \label{exampleSlider}
506 You can see information about the example and
507 the graphical representation of the workflow defined by the script
508 (the elementary boxes that compose it, and their connections, see figure \ref{exampleSlider}).
510 Click on \texttt{[source]}, it will be loaded
511 in the 'Files' part, within the script editor (See figure \ref{exampleSliderSource});
514 \caption{Source code of 'exampleSlider'}
516 \includegraphics[width=0.7\textwidth]{exampleSliderSource.png}
518 \label{exampleSliderSource}
521 Run it, using the 'Files' toolbar (see figure \ref{lowertoolbar})
523 You'll get something like in figure \ref{execSliderSource}.
526 \caption{\label{execSliderSource}Execution of 'exampleSlider'}
528 \includegraphics[width=0.7\textwidth]{execSliderSource.png}
532 Feel free to move the slider, to check whether it actually works...
536 Just a few words on what you saw:
538 \item{In the source code of the script}:
543 These \bbs commands load the packages \texttt{std} and \texttt{wx}
546 set slider.ReactiveOnTrack 1
548 We create a \texttt{Slider} box called \emph{slider}.
550 We tell it to inform anybody that's interested in, that the cursor moved, each time it moved.
551 The default behaviour is to inform only when cursor is released.
555 We create an \texttt{OutputText} box called \emph{text}
556 (in which slider value will be displayed)
559 new LayoutLine layout
561 We create a \texttt{LayoutLine} box called \emph{layout},
562 a widget box designed to embed other widgets (say, a main window)
564 connect slider.Widget layout.Widget1
565 connect text.Widget layout.Widget2
567 We embed \emph{slider} and \emph{text} into \emph{layout}.
569 connect slider.BoxChange text.BoxExecute
570 connect slider.Out text.In
572 We tell \emph{slider} to inform \emph{text} every time it's modified.
574 We tell \emph{slider} to pass its output value (\texttt{Out})
575 to \emph{text} input value (\texttt{In})
579 We tell \emph{layout} to process itself.
580 This also produces the execution of the boxes connected to it (the slider, the text).
582 \item{In the Help part}
584 You can see the graphical representation of the workflow (pipeline) created by the script,
585 as in figure \ref{SmallGraph}.
589 \caption{Graphical representation of a pipeline}
591 \includegraphics[width=0.7\textwidth]{SmallGraph.png}
596 The representation includes
597 both the graphical interface-related pipeline
598 (\emph{slider} and \emph{text} are embedded into \emph{layout})
599 and the data processing-related pipeline
600 (\emph{slider} warns \emph{text} immediately when it's modified,
601 \emph{slider} passes \emph{text} its output value)\footnote{Yes, we know : all the arrows (graphical interface pipeline arrows and data processing arrows)
602 are blue; using different colors is planned for next release...}.
604 You can get a much more detailed graph,
605 like in figure \ref{LargeGraph},
606 just clicking on the button
607 '\texttt{graph (detailed)}' in the toolbar of the \texttt{Command} part.
611 \caption{Detailed graphical representation of a pipeline}
613 \includegraphics[width=0.75\textwidth]{LargeGraph.png}
621 % ==============================================
622 \subsection{The Menu}
623 % ==============================================
625 At last, let us have a look at \bbStudio menu (see figure \ref{themenu}).
628 \caption{The bbStudio menu}
630 \includegraphics[width=0.7\textwidth]{themenu.png}
638 \item{\texttt{Open the bbtk configuration file}}
641 \item{\texttt{Tools}}
643 \item{\texttt{Create package}}:
644 Provides a graphical interface to help package developers to create a new empty package.
645 \item{\texttt{Create black box}}:
646 Provides a graphical interface to help package developers to create a new empty black box, and add it to an already existing package.
647 \item{\texttt{Plug Package}}:
648 Incorporates a package into the list of known packages. Updates the html documentation.
649 \item{\texttt{Regenerate package doc}}:
650 If a package has changed (e.g. new boxes) this updates the package html documentation.
651 \item{\texttt{Regenerate boxes list}}:
652 Updates the boxes lists (alphabetical, by package, ...)
653 \item{\texttt{Regenerate all}}:
654 Regenerates all the packages documentations and the boxes lists (may be long...).
655 \item{\texttt{Show last graph}}:
656 Shows the last pipeline graph that was generated
658 \item{\texttt{Options}}
660 \item{\texttt{Reset before running}}: Before running a script, all the already created boxes are destroyed,
661 all the already loaded packages are unloaded (this is the recommended option).
663 \item{\texttt{Windows}}
664 User may decide, for any reason of his own, to hide one or more panels:
666 \item{\texttt{Show 'Files' panel}}
667 \item{\texttt{Show 'Help' panel}}
668 \item{\texttt{Show 'Command' panel}}
669 \item{\texttt{Show 'Messages' panel}}
670 \item{\texttt{Start Package browser}}: starts the package browser (see \ref{Package_Browser}).
672 \item{\texttt{About}}
674 \item{\texttt{About}}: Info about \texttt{bbStudio}.
681 % ==========================================
682 % ==========================================
683 % ==========================================
684 % ==========================================
687 \section{Writing black box scripts (\bbsns)}
689 % ==========================================
690 % ==========================================
691 % ==========================================
693 This section introduces how to write down black box scripts (\bbsns)
694 to create and execute pipelines.
696 % ==========================================
697 \subsection{The commands}
698 % ==========================================
699 In the sequel the commands entered by the user will be preceded by a prompt (\texttt{>}).
700 To get started, type in the \texttt{Command} area:
705 you get the following list of the commands recognized by the interpreter:
738 To get the help on a particular command, type \texttt{help <command name>}, e.g.:
745 usage : author <string>
746 Adds the string <string> to the author information
747 of the black box being defined
750 The \texttt{help} command has multiple usages.
751 It is used to get help about almost anything in the interpreter, including the \texttt{help} command itself! Indeed:
760 (2) help <command name>
761 (3) help packages [all]
762 (4) help <package name> [all]
763 (5) help <black box type>
764 (6) help <black box name>
766 (1) Lists all available commands;
767 (2) Prints help on a particular command;
768 (3) Lists the packages loaded and their black boxes.
769 Add 'all' to list adaptors;
770 (4) Prints short help on the black boxes of a package.
771 Add 'all' to include adaptors;
772 (5) Prints full help on a black box type;
773 (6) Prints information on the inputs, outputs and connections
774 of a black box instance.
777 %More information about what is a 'box' will be given in the 'Scripting' part of this manual.
780 % ==========================================
781 \subsection{Creating and executing black boxes}
782 % ==========================================
784 At start the interpreter does not know any black box.
785 If you type \texttt{'help packages'}, which is
786 the third form of the \texttt{help} command, you get:
793 which means that the interpreter only knows one package
794 (library of black boxes) called \texttt{user}
795 and which contains a black box called \texttt{workspace}.
796 The \texttt{user} package is an internal package of the interpreter,
797 which stores user-defined black box types.
798 At start, it already contains
799 one box, called \texttt{workspace},
800 which is a special type of black box,
801 called complex black box, the purpose of which is
802 to store other black boxes.
803 Any black box you create in \bbStudio is stored
804 in \texttt{workspace}
805 (this will be explained in details in sections
806 \ref{bbi-writing-scripts} and
807 \ref{bbi-command-line-app}).
809 If you type \texttt{'help workspace'}, you get:
812 Complex Black Box <user::workspace>
815 Category(s): complex box;
821 In the text displayed,
822 the \texttt{user::} prepended to the name \texttt{workspace}
823 means that the box \texttt{workspace}
824 belongs to the \texttt{user} package.
825 Then comes a description and three lines which
826 tell that \texttt{workspace} does not have any input
827 nor output nor boxes yet.
829 In order to let the interpreter know of some black boxes,
830 you must load another package.
831 The \texttt{std} package is the ``standard'' package,
832 which contains basic useful black boxes.
844 you get something like:
867 Now the interpreter knows the package \texttt{std} and the black boxes it provides,
868 such as the \texttt{Add} box, the \texttt{ConcatStrings} box, and so on. Remark that the
869 content of \texttt{std} may vary from one version to another
870 as new black boxes might be added to it. Note that you will get a more detailed information about the package loaded (here \texttt{std}) if you type:
875 Indeed, each of the items listed is followed by its short description:
877 Package std v1.0.0- laurent.guigues at creatis.insa-lyon.fr
880 ASCII : ascii codes sequence to string - ...
881 Add : Adds its inputs
882 ConcatStrings : String concatenation
883 Configuration : Gets configuration informations
886 Additionally, in the right part of the screen ('Help' zone) the corresponding html page is displayed.
893 {\bbStudions} displays the appropriate html page in the 'Help' part (see figure : \ref{HelpAdd}), and the following text in the 'Message' part:
897 By : laurent.guigues@creatis.insa-lyon.fr
898 Categories : atomic box;math;
900 'BoxExecute' <bbtk::Void> [signal] : Any signal received...
902 'BoxProcessMode' <String> [] : Sets the processing mode...
903 (Pipeline | Always |...
904 'In1' <Double> [] : First number to add
905 'In2' <Double> [] : Second number to add
907 'BoxChange' <bbtk::VoidS> [signal]: Signals modifications...
908 'Out' <Double> [] : Result
912 \caption{The html Help}
914 \includegraphics[width=0.7\textwidth]{HelpAdd.png}
920 (provided by the author of the box) include:
921 the author(s) of the box (usually e-mail address(es)) and
922 the categories to which the box belongs,
923 the lists of inputs and outputs of the box.
924 For each input or output, \bbi provides
926 its \emph{type} (between \texttt{<} and \texttt{>}, e.g. \texttt{<Int>})
928 Remark that the box \texttt{Add} is not a 'complex' black box
929 but an 'atomic' box, hence its help does not
930 include a pipeline graph.
932 You can see that \texttt{Add} boxes have two inputs,
933 with name \texttt{In1} and \texttt{In2},
934 and an output, named \texttt{Out}.
936 After loading the package it belongs to, you can create an \emph{instance} of an \texttt{Add} box, by use of the command \texttt{new}:
942 Here \texttt{'a'} is the \emph{name} of the instance,
943 which will be used to reference it later.
944 It is important to distinguish a box \emph{type}
945 and an \emph{instance} of a box type.
946 The \texttt{Add} box of the package \texttt{std} is actually
947 a \emph{box type}, like \texttt{int} is a data type
948 in \texttt{C} language. The \texttt{new} command allows to create
949 an instance of a box type, exactly like \texttt{int i;} in
950 a \texttt{C} code declares a variable of type \texttt{int}, the
951 name of which is \texttt{i}.
952 Of course, like in \texttt{C} Language, you can declare multiple boxes of the
955 After the creation of the box \texttt{a}, type:
962 Complex Black Box <user::workspace>
965 Category(s): complex box;
972 This means that \bbi workspace now contains a black box named \texttt{a},
973 of type \texttt{std::Add}. If you type:
978 You get information about the actual instance \texttt{a} of the box type \texttt{std::Add}. It gives something like this:
981 Black Box 'a' <std::Add>
983 'BoxExecute' = '? (no adaptor found)' [Modified]
984 'BoxProcessMode' = 'Pipeline' [Modified]
985 'In1' = '0' [Modified]
986 'In2' = '0' [Modified]
988 'BoxChange' = '? (no adaptor found)' [Out-of-date]
989 'Out' = '0' [Out-of-date]
991 Note that the inputs appear as \texttt{[Modified]}, since the code defining the box type includes an initialization of the inputs. On the other hand, the outputs appear as \texttt{[Out-of-date]}, as the box has not yet been executed and therefore its outputs have not been updated. See the second part of this section to learn more about the updating. For a moment, just note that one way to process the box \texttt{a} is to use the command:
996 This command does not display anything (except if the
997 box itself displays something in its processing).
998 It just processes the box if needed. In our case, the result can be seen as follows:
1002 Black Box 'a' <std::Add>
1004 'BoxExecute' = '? (no adaptor found)' [Up-to-date]
1005 'BoxProcessMode' = 'Pipeline' [Up-to-date]
1006 'In1' = '0' [Up-to-date]
1007 'In2' = '0' [Up-to-date]
1009 'BoxChange' = '? (no adaptor found)' [Up-to-date]
1010 'Out' = '0' [Up-to-date]
1012 Note the change of status of all the inputs and outputs (\texttt{[Up-to-date]}).
1013 In practice, the command \texttt{exec} is useful to execute boxes that do not have any output,
1014 such as boxes that write something to a file or, display a
1015 graphical interface, and so on.
1017 Now, let us set the input \texttt{In1}
1018 of the \texttt{Add} box \texttt{a} to the value $3.5$
1024 Similarly, setting the input \texttt{In2} of \texttt{a} to the value $4.3$
1030 And you print the output \texttt{Out} of the box \texttt{a} with:
1032 > print "result=$a.Out$"
1036 In the string passed to the \texttt{print} command,
1037 each substring enclosed between a couple of \$ is considered
1038 as the name of an output of a box.
1039 To process these special substrings, the interpreter:
1041 \item Processes the box if needed (see below)
1042 \item Converts the output of the box to a string if possible
1044 \item Substitutes the result in the string to print
1045 \item Postpones an implicit 'new line' character to the string
1050 Box processing is needed if:
1053 \item either at least one input has changed since last processing
1054 \item or the input \texttt{'BoxProcessMode'} of the box is set to
1055 \texttt{'Always'}, which forces box reprocessing.
1058 Note that all boxes have an input named \texttt{'BoxProcessMode'}. \newline
1060 %To exit \bbi, type :
1068 % ==========================================
1074 \item The \texttt{include} command allows to load a package, and the complex black boxes that come with it.
1075 \item \texttt{help} gives help on:
1077 \item Available commands if you just type \texttt{help}.
1078 \item A particular command if you type \texttt{help <command-name>}.
1079 \item All available packages and their boxes (without description) if you type \texttt{help packages}.
1080 \item A particular package and its boxes (with brief description) if you type \texttt{help <package-name>}.
1081 \item A particular black box type (with full description) if you type \texttt{help <box-type-name>}. In particular, \texttt{help workspace} displays information on the content of the \texttt{'workspace'} black box, which stores the boxes created by the user (by \texttt{new}).
1082 \item A particular black box instance (with full description, as well as the values and the status of the inputs/outputs) if you type \texttt{help <box-name>}.
1084 %\item \texttt{list} displays the list of black box instances created so far (by \texttt{new}).
1085 \item \texttt{new}: creates an instance of a black box.
1086 \item \texttt{set}: sets the value of an input of a black box.
1087 \item Under any component of \bbStudions, to reference the input called \texttt{i}
1088 of a black box called \texttt{b} you must type \texttt{'b.i'}.
1089 The same syntax holds for outputs.
1090 \item \texttt{print}: prints a string, substituting each substring of the form \$b.o\$ by the value of the output \texttt{o} of the black box \texttt{b}. Note that an
1091 implicit trailing 'new line character' is added at the final string.
1092 \item \texttt{exec}: runs, if needed, the process of a box.
1093 %\item \texttt{quit}: quits \bbi.
1098 %A more 'modern' way to proceed is to run \texttt{bbStudio}, drag and drop the \texttt{Command} bookmark to the lower \texttt{Welcome to bbStudio!} bar.
1099 %Wou'll get something like in figure \ref{bbCommandPlusHelp}:
1101 %\begin{figure}[!ht]
1102 %\caption{\label{bbCommandPlusHelp}
1103 %An other way to run the command interpreter}
1105 %\includegraphics[width=0.5\textwidth]{bbCommandPlusHelp.png}
1109 % ==========================================
1111 % ==========================================
1112 \subsection{Connecting black boxes}
1113 \label{bbi-connecting-black-boxes}
1114 % ==========================================
1116 \BBTK allows to create
1117 and execute processing chains,
1118 also called \emph{pipelines},
1119 by connecting black boxes.
1120 This section explains how to do it with examples.
1121 Read section \ref{bbi-deep-box} to get
1122 more information on pipeline processing.
1124 First start \bbStudio and load the package \texttt{std}, i.e. type in the 'Command' part the following command:
1129 Assume you want to compute a sum of three numbers (e.g. $1+2+3$). You can do it by
1130 chaining two \texttt{Add} boxes, as shown in figure
1131 \ref{bbi-fig-connecting-black-boxes-1}.
1134 \caption{ A simple pipeline that adds 3 numbers}
1136 \includegraphics[width=0.5\textwidth]{1plus2plus3.png}
1138 \label{bbi-fig-connecting-black-boxes-1}
1141 The \bbs instructions to create and execute this pipeline are :
1145 > connect a.Out b.In1
1152 The first three commands build the pipeline,
1153 the next three set \texttt{a} and \texttt{b} black boxes' inputs and the last one
1154 prints the output of the black box \texttt{b}. The pipeline is executed before printing, because the interpreter 'knows' that the box \texttt{b}, the output of which is requested, is not up to date.
1156 The command \texttt{'connect a.Out b.In1'} ``plugs'' the output
1157 \texttt{Out} of the box \texttt{a} into the input \texttt{In1} of the
1159 Once the boxes are connected, the processings of the two boxes are chained:
1160 getting the output of \texttt{b} requires getting its inputs,
1161 hence getting the output of \texttt{a} which is connected to it.
1162 This pipeline mechanism can recurse into arbitrarily long
1163 chains of boxes (see \ref{bbi-deep-box}
1166 Let us consider another, more image-oriented, example :
1174 > new FileSelector fileDialog
1175 > new ImageReader reader
1177 > new Viewer2D viewer
1179 > connect fileDialog.Out reader.In
1180 > connect reader.Out viewer.In
1181 > connect slider.Out viewer.Slice
1182 > connect slider.BoxChange viewer.BoxExecute
1189 \item The \texttt{include} instructions load the necessary packages.
1190 \item \texttt{FileSelector} will pop, at run time, a File Selector dialog box that will output the user-selected file name.
1191 \item \texttt{ImageReader} will read any itk readable file, the name of which is passed as a std::string, and return a pointer on an itk image.
1192 \item \texttt{Slider} will pop, at run time, a Slider widget that will output an integer number, used later as a slice number.
1193 \item \texttt{Viewer2D} displays a plane, the number of which is specified by an integer.
1194 \item \texttt{connect fileDialog.Out reader.In} plugs the output of the File Selector (a \texttt{std::string}) to the input of the reader (a \texttt{std::string}, too).
1195 \item \texttt{connect reader.Out viewer.In} plugs the output of the reader \\(a \texttt{bbtk::any<bbitk::ImagePointer>} which is a type defined by the
1196 itk package, and which can hold any itk image pointer) to the input of the Viewer (a \texttt{vtkImageData *})
1197 \item \texttt{connect slider.Out viewer.Slice} plugs the output of the slider (an \texttt{int}) to an other output (named Slide) of the viewer.
1198 \item \texttt{connect slider.BoxChange viewer.BoxExecute} says the viewer that it must re process itself any time the slider is modified.
1199 \item \texttt{exec viewer} processes the viewer.
1202 This would correspond to the graph in figure \ref{bbi-simplegraph}
1206 \caption{\label{bbi-simplegraph}(Very) simple Graph of a (very) simple pipeline}
1208 \includegraphics[width=0.8\textwidth]{bbi-simplegraph.png}
1212 Of course, to be able to connect two boxes,
1213 the output and the input must be compatible.
1214 You can always connect an output to an input of the \emph{same} type,
1215 but you can do more, thanks to particular (hidden) black boxes called {\bf adaptors}.
1217 An adaptor is a black box that has at least one input, called \texttt{In},
1218 and at least one output called \texttt{Out} and the role of which is to convert
1219 a data of the type of \texttt{In}
1220 into a data of the type of \texttt{Out} (other inputs or outputs may serve
1221 to parameter the adaptor or retrieve other useful information).
1223 Under \bbStudions, if you type :
1230 Package std v1.0.0 - laurent.guigues@creatis.insa-lyon.fr
1231 Basic useful black boxes
1233 ASCII : ascii codes sequence to string - ...
1234 Add : Adds its inputs
1235 BoolToString [DA] : Converts a Bool (bool) into a string
1236 CastBoolToChar [DA] : Static cast from Bool (bool) to ...
1237 CastBoolToDouble [DA] : Static cast from Bool (bool) to ...
1239 CastBoolToUChar [DA] : Static cast from Bool (bool) to ...
1240 CastBoolToUInt [DA] : Static cast from Bool (bool) to ...
1242 CastUIntToBool [DA] : Static cast from UInt (unsigned ...
1243 CastUIntToChar [DA] : Static cast from UInt (unsigned ...
1244 CastUIntToDouble [DA] : Static cast from UInt (unsigned ...
1249 In this long list you find many items marked \texttt{[DA]}, which stands for \emph{default adaptor}.
1251 Once you have loaded the package \texttt{std}, you can
1252 plug an output of type \texttt{char} into an input of type \texttt{double}.
1253 When the interpreter encounters the \texttt{connect} command,
1254 it looks for an adequate \emph{adaptor} in the loaded packages.
1255 In our case, as the package \texttt{std} provides the
1256 \texttt{CastUCharToDouble} adaptor, the interpreter automatically creates an
1257 instance of this adaptor and places it \emph{between}
1258 the output and the input you want to connect
1259 (however this adaptor is hidden to you,
1260 it is embedded into the created connection and does not appear
1261 as an existing black box).
1262 When the pipeline is processed the
1263 adaptor converts the output data into the required input type,
1264 in a totally transparent way.
1265 In our example, the \texttt{CastUCharToDouble} adaptor
1266 would simply cast the value of the \texttt{char} into a \texttt{double},
1267 however arbitrarily complex type conversion may be done.\\
1268 \texttt{WARNING}: these adaptors are \texttt{C++ static cast}, i.e., there is, right now,
1269 no 'intelligent' conversion (only truncation) e.g. think of \texttt{CastDoubleToUChar}!
1272 %Question (for info-dev):
1273 %if two adaptors with the same input and output types exist
1274 %in two different packages, currenly loaded,
1275 %which one is chosen by the interpreter at connection time?
1276 %A feature is missing to specify explicitely which one user wants to choose
1277 %(use a namespace notation ?)
1279 %-> Role of default adaptors
1282 Note that the \texttt{set} and \texttt{print} commands of interpreter
1283 work with adaptors from \texttt{string} to the type of the input to set
1284 or from the type of the output to print to \texttt{string}.
1285 Hence in order to \texttt{set} or \texttt{print} values the adequate
1286 adaptors must be available in the packages currently loaded. \\
1289 % ==========================================
1294 \item The \texttt{connect} command allows to connect two black boxes
1295 \item You can connect two black boxes if (and only if):
1297 \item The output and the input are of the same type, or
1298 \item There is an adaptor black box in the packages loaded which
1299 converts data of the output type into data of the input type
1301 \item \texttt{help <package name>} does not display the adaptors of the package. To see them use: \texttt{help <package name> all}
1305 % ==========================================
1307 % ==========================================
1308 \subsection{Creating complex black boxes}
1309 \label{bbi-complex-black-boxes}
1310 % ==========================================
1312 Remind the pipeline of figure
1313 \ref{bbi-fig-connecting-black-boxes-1}, which
1314 computed the sum of three doubles.
1315 You can consider it as a whole and define
1316 a new black box type, which will be a \emph{complex black box},
1317 having three inputs and one output,
1318 as shown in figure \ref{bbi-fig-complex-black-box-1}.
1321 \caption{\label{bbi-fig-complex-black-box-1} Creating the complex black box \texttt{Add3}}
1323 \includegraphics[width=0.5\textwidth]{Add3.png}
1327 The \bbs commands to define this complex black box are
1335 > connect a.Out b.In1
1337 > description "adds 3 doubles"
1338 > input x a.In1 "first double to add"
1339 > input y a.In2 "second double to add"
1340 > input z b.In2 "third double to add"
1341 > output result b.Out "output"
1347 \item As we will use \texttt{Add} boxes, we need to load the package \texttt{std}, which is done in the first line.
1348 \item The command \texttt{define} then starts the definition
1349 of the complex box type that will be called \texttt{Add3}.
1350 \item The next three lines define the pipeline,
1351 exactly in the same way as outside a complex box definition.
1352 \item The commands \texttt{author}, \texttt{description}, \texttt{input}
1353 and \texttt{output} are specific to complex boxes definition:
1355 \item \texttt{author} and \texttt{description} are used for the documentation
1356 of the new box. You can provide multiple \texttt{author} or
1357 \texttt{description} commands, the arguments of the commands will
1358 be concatenated to produce the final author and description strings.
1359 \item \texttt{input} and \texttt{output} are used to define the inputs and outputs
1360 of the new complex box. Their syntax is the same: for each new input/output you need to say
1361 to which internal input/output it corresponds and to provide
1362 a help string documenting the input/output.
1363 In our example, we define that the box \texttt{Add3} has
1364 three inputs: \texttt{x}, \texttt{y} and \texttt{z}.
1365 The input \texttt{x} corresponds to the input \texttt{In1} of the
1366 internal box \texttt{a}.
1367 In the same way, the external input \texttt{y}
1368 corresponds to the internal input \texttt{a.In2}, and
1369 the external input \texttt{In3} to \texttt{b.In2}.
1370 The only output of the new box is called \texttt{result}
1371 and corresponds to \texttt{b.Out}.
1372 The figure \ref{bbi-fig-complex-black-box-1}
1373 illustrates the external to internal
1374 input/output correspondence.
1376 \item Finally, the \texttt{endefine} command ends the definition of the
1380 After this definition, if you ask for help
1381 on packages, you get:
1392 The \texttt{user} package now contains a new black box type, called
1393 \texttt{Add3}. If you ask for help on this type of box, you get:
1396 Complex Black Box <user::Add3>
1400 'x' <double> [] : first double to add
1401 'y' <double> [] : second double to add
1402 'z' <double> [] : third double to add
1404 'result' <double> [] : output
1410 and you can use it like any other box, for example:
1421 As a side note, we can say that, for consistency reasons, it would have been better to name
1422 \texttt{In1}, \texttt{In2} and \texttt{In3} the inputs of the black box \texttt{Add3}. Indeed,
1423 by convention all the 'natural entries' of a box are named \texttt{In}, or \texttt{In}\emph{x} if there is more than one 'natural entry'.
1425 % ==========================================
1430 \item The \texttt{define/endefine} commands allow to define complex black box types, i.e. types of black boxes made up of other black boxes.
1431 Inside a \texttt{define/endefine} block :
1433 \item The \texttt{author} and \texttt{description} commands allow to document the new type of box
1434 \item The \texttt{input} and \texttt{output} commands allow to define the inputs and outputs of the new type of box, that is to which inputs and outputs
1435 of internal boxes they correspond.
1439 % ==========================================
1441 % ==========================================
1442 \subsection{Writing scripts files}
1443 \label{bbi-writing-scripts}
1444 % ==========================================
1446 Once you have defined a new type of complex box, you
1447 may like to reuse it. To do this, you can simply
1448 write the \bbs commands defining the new box
1449 into a text file and afterwards include that file in \bbins.
1450 Doing this, you start writing \bbs scripts.
1451 The conventional (and mandatory) extension for such scripts is \texttt{bbs}
1453 For consistency reasons, you are requested to prepend \texttt{bb} to the name.
1455 For example, the \texttt{Add3} complex box we previously worked on
1456 can be defined in the \texttt{bbAdd3.bbs} file:
1458 \begin{file}{bbAdd3.bbs}
1460 # Defines the Add3 black box which adds 3 doubles
1466 description "adds 3 doubles"
1472 input x a.In1 "first double to add
1473 input y a.In2 "second double to add
1474 input z b.In2 "third double to add"
1476 output result b.Out "output"
1481 Lines starting with a \texttt{\#} character or a \texttt{\//\//} character are ignored, they
1482 are considered as comments by the interpreter.
1483 To use this file in \bbStudions, click on the \texttt{include} button, and browse your filestore to find the file.
1486 > include bbAdd3.bbs
1488 Complex Black Box <user::Add3>
1492 'x' <double> [] : first double to add
1493 'y' <double> [] : second double to add
1494 'z' <double> [] : third double to add
1496 'result' <double> [] : output
1502 If the file has the \texttt{bbs} extension, you can omit it and just type:
1506 provided that {\bbStudions} knows the path to the desired \texttt{bbs} file.
1507 See the section \ref{The_configuration_file} to learn about the configuration file and the way to add a new path to it. Note that, if you modify the configuration file, you will have to close {\bbStudions} and run it again, so that the new configuration be taken into account.
1509 \subsection{Creating complex black boxes that use complex black boxes}
1510 \label{bbi-complex-complex-black-boxes}
1513 Of course, you can include script files in other script files,
1514 like in the following example:
1516 \begin{file}{bbAdd4.bbs}
1518 # Defines the Add4 black box which adds 4 doubles
1523 description "adds 4 doubles"
1526 connect a.result b.In1
1527 input In1 a.x "first double to add
1528 input In2 a.y "second double to add
1529 input In3 a.z "third double to add"
1530 input In4 b.In2 "fourth double to add"
1531 output Out b.Out "output"
1536 Here we kept the \texttt{bbAdd3.bbs} file unchanged, so the inner box of type \texttt{Add3} \texttt{a} has the entries \texttt{x, y, z}, while the entries of the inner box \texttt{b} of type \texttt{Add} are \texttt{In1, In2}.\\
1537 Only the inputs \texttt{x, y, z} of box the \texttt{a} and the input \texttt{In2} of the box \texttt{b} are of interest for the end user, but he/she does not need to care neither about the inner boxes name, nor about the names of their inputs.\\
1538 The author of the complex box has the ability to give these inputs meaningful names (here \texttt{In1, In2, In3, In4}) and to properly document them.
1540 \subsection{Naming Conventions}
1541 \label{bbi-Naming Conventions}
1544 % ==========================================
1546 %\paragraph{Naming Conventions}
1550 % ==========================================
1554 For consistency reasons, you are requested to prepend \texttt{bb}, and postpone an extention \texttt{.bbs},
1555 to the names of the files that hold a \texttt{complex black box} definition.
1557 For example, the \texttt{Add3} complex box we previously worked on
1558 can be defined in the \texttt{bbAdd3.bbs} file.
1561 For consistency reasons, the names of dynamic libraries holding the packages start by \texttt{bb}.
1562 For instance, the package \texttt{wx} will be in the library \texttt{bbwx.dll} (Windows) or \texttt{libbbwx.so}
1567 % ==========================================
1573 \item The \texttt{include} command tells the interpreter to include a script file.
1574 \item Lines starting with a \texttt{\#} or with a \texttt{\//\//} are considered as comments by the interpreter.
1575 \item Lines between a line starting with a \texttt{\//*} an a line ending with a \texttt{*\//} are considered as comments by the interpreter.
1579 % ==========================================
1581 % ==========================================
1582 \subsection{Creating command line applications}
1583 \label{bbi-command-line-app}
1584 % ==========================================
1586 Now that you know how to create complex black boxes
1587 (with \texttt{define/endefine}), think
1588 back to the \texttt{workspace} object.
1589 Remember that it is also
1590 a \texttt{complex black box}.
1591 Actually, when you type interpreter commands
1592 outside a \texttt{define/endefine} block,
1593 you progressively define the \texttt{workspace}
1595 You can think of it like if at start the interpreter
1596 was issuing a command \texttt{'define workspace'}
1597 and then letting you define the interior of the box
1600 Remember that the command \texttt{inputs}
1601 allows to define an input of a complex box.
1602 Now, if you use the command \texttt{input}
1603 outside a \texttt{define/endefine} block then
1604 it defines an input of the \texttt{workspace} box,
1605 that is an input of the \emph{main program}.
1606 This input will then be connected to the
1607 parameters that the user passes to the command line.
1609 For example, consider the script :
1611 \begin{file}{add.bbs}
1615 input x a.In1 "first number to add"
1616 input y a.In2 "second number to add"
1621 The third and fourth lines define two inputs \texttt{x}
1622 and \texttt{y}. When you execute this script,
1623 you can pass these two arguments on the command line,
1631 You can also invoke \bbi the option \texttt{-h},
1632 which gives help on the \texttt{workspace} box :
1639 'x' <double> : first number to add
1640 'y' <double> : second number to add
1643 To get a better help, use the \texttt{description}
1644 and \texttt{author} commands :
1646 \begin{file}{add.bbs}
1648 description "Adds two numbers"
1649 author "foo@bar.com"
1652 input x a.In1 "first number to add"
1653 input y a.In2 "second number to add"
1658 Now if you ask for help on the \texttt{add} script, you get :
1665 'x' <double> : first number to add
1666 'y' <double> : second number to add
1669 Rather than getting the inputs of a script
1670 from the command line, you can ask \bbi to
1671 prompt the user for the values, using the \texttt{-t}
1676 x=[the program waits for user answer]2
1677 y=[the program waits for user answer]5
1681 You can also use the \texttt{-g} commutator.
1682 \bbi then prompts the user in graphical mode,
1683 displaying a dialog box for each input,
1684 like in fig. \ref{bb-input-dialog-box}.
1687 \caption{\label{bb-input-dialog-box}Input dialog box}
1689 \includegraphics[width=0.6\textwidth]{enter-the-value-of-x.png}
1693 Note that for both \texttt{-t} and \texttt{-g} options,
1694 the input from the user is a \texttt{string} and
1695 \bbi converts it to the right input type using
1696 an \texttt{adaptor}, hence the right adaptors must be loaded.
1698 % ==========================================
1703 \item The \texttt{input}, \texttt{description} and \texttt{author} commands,
1704 when they are used outside a \texttt{define/endefine} block allow
1705 to define the inputs, description and author of the main program.
1706 \item Inputs of the main program can be passed on the command line
1707 using the syntax \texttt{<input-name>=<value>}.
1708 No white space is allowed, if the value or the input name
1709 contains white spaces, enclose them
1710 between double quotes, e.g. \texttt{"parameter with white spaces = gnu's not unix"}.
1711 \item The \texttt{-h} option of \bbi prints help on the main program.
1712 \item The \texttt{-t} option of \bbi orders the program to prompt for its inputs in text mode.
1713 \item The \texttt{-g} option of \bbi orders the program to prompt for its inputs in graphical mode.
1716 % ==========================================
1718 % ==========================================
1719 \subsection{Using graphical interface boxes (widget boxes)}
1721 % ==========================================
1723 % ==========================================
1724 %\subsubsection{Overview}
1725 %\label{bbi-overview}
1726 % ==========================================
1728 Basic graphical interface components are provided in the package \texttt{wx},
1729 such as buttons, sliders, file open/save dialogs, etc.
1731 As first example, type the following commands in \bbi :
1738 When you type \texttt{enter} after the last line,
1739 a window pops up in which you can entrer a text.
1740 When you close the window, the text you entered is printed by
1741 the \texttt{print} command.
1743 Type \texttt{help wx}, you get something like :
1745 Package wx v1.0.0- info-dev@creatis.insa-lyon.fr
1746 Basic graphical interface elements (sliders, buttons ...) based on wxWidgets
1748 ColourSelector : Colour Selector dialog (bbfication of wxColourSele...
1749 ColourSelectorButton : A button which displays a colour picker dialog whe...
1750 CommandButton : Button which executes bbi commands
1751 DirectorySelector : Pops up a directory selection dialog (wxDirDialog)
1752 FileSelector : Pops up a file selection dialog for reading or sav...
1753 InputText : A zone in which the user can enter a text (wxTextC...
1754 LayoutLine : LayoutLine widget (wxBoxSizer)
1755 LayoutSplit : Widget which splits a window in two fixed size par...
1756 LayoutTab : LayoutTab widget (wxNotebook)
1757 OutputText : Text zone to be inserted into a window (wxStaticTe...
1758 RadioButton : RadioButton group widget 0-9 entries
1759 Slider : Slider widget (wxSlider)
1762 You can reproduce the same experiment as above using a
1763 \texttt{Slider} or a \texttt{FileDialog} rather than a \texttt{InputText}..
1766 %There are two kinds of widgets : ``terminal'' widgets and ``container'' widgets.
1767 %The \texttt{InputText}, \texttt{FileDialog} or \texttt{Slider} widgets
1768 %are ``terminal'' widgets.
1769 %``container'' widgets are of another kind : they are
1770 % ==========================================
1771 %\subsubsection{Layout widgets}
1772 %\label{bbi-layout-widgets}
1773 % ==========================================
1775 There is a special kind of widget, called '\texttt{Layout}', designed to
1776 contain other widgets in order to build larger dialog boxes.
1778 For example, the \texttt{LayoutSplit} widget is a container which
1779 ``splits'' a window into two parts, either horizontally or vertically,
1780 each part including another widget.
1781 The initial size of the two parts can be fixed by the input 'Proportion'
1782 and be adjusted by the user thanks to a ``handle''.
1784 The example \texttt{exampleLayoutSplit} demonstrates its use.
1785 Run it : it displays a window with two sliders.
1786 Move the sliders and close the window.
1787 Now look at the source file to see how this is done :
1789 \begin{file}{scripts/test/testSplit.bbs}
1797 connect s1.Widget s.Widget1
1798 connect s2.Widget s.Widget2
1804 First, the two sliders \texttt{s1} and \texttt{s2} are created.
1805 A \texttt{LayoutSplit} box \texttt{s} is also created.
1806 The \texttt{connect} commands then ``includes'' the sliders in the
1808 The input \texttt{Widget} is common to all widget boxes :
1809 every widget can be inserted into another widget.
1810 The outputs \texttt{Widget1},\texttt{Widget2} are specific of \emph{layout}
1812 (in \bbi type \texttt{help Slider}:
1813 you will see the output \texttt{Widget};
1814 type \texttt{help LayoutSplit}:
1815 you will see the inputs \texttt{Widget1} and \texttt{Widget2}
1816 and the output \texttt{Widget}).
1817 When you connect the \texttt{Widget} output of a box
1818 to the \texttt{Widget}i input of a layout widget,
1819 you order to include the widget in the layout.
1820 Of course, the order of connection is important.
1821 In our case, the slider \texttt{s1} is included first,
1822 then the slider \texttt{s2}: \texttt{s1} will be placed
1823 on top of \texttt{s2} (the \texttt{LayoutSplit} box is
1824 implemented that way, but this is arbitrary choice).
1826 Right now, there are only \emph{three} layout widgets in the \texttt{wx} package :
1828 \item {the \texttt{LayoutSplit} widget} we just described
1830 \item {the \texttt{LayoutLine} widget} can have multiple children
1831 (\texttt{Widget1}, \texttt{Widget2},\dots \texttt{Widget9} inputs) and
1832 divides its window into as much parts as children,
1833 each part of equal size.
1834 The orientation of the \texttt{LayoutSplit} or of the \texttt{LayoutLine} can be changed by the input \texttt{Orientation}.
1835 With only those two layout widgets you can already create
1836 complex dialog boxes
1837 (of course layouts can be nested, which leads to tree-like
1838 structures of widgets). \\
1839 See the script \texttt{exampleComplexLayoutSplit\_In\_LayoutSplit} for an example.
1841 \item {The \texttt{LayoutTab} widget} arranges its children
1842 in different pages or 'tabs' (\texttt{wxNotebook}-based).
1843 The label of each page is the name of the widget it contains.
1851 %One word about a special widget in the package \texttt{wx}:
1852 %the \texttt{Button}... to be continued.
1854 % ==========================================
1855 \subsection{Deeper in the boxes}
1856 \label{bbi-deep-box}
1857 % ==========================================
1859 \subsubsection{Default and mandatory inputs and outputs}
1861 \item Any \texttt{atomic} black box has two default Inputs, which are created by the system :
1863 \item {\bf\emph{BoxExecute}} : Any signal received by this input executes the box
1864 \item {\bf\emph{BoxProcessMode}}: Sets the processing mode of the box :
1866 \item {\bf\emph{Pipeline}}:% bbBackwardUpdate() calls Process() only if Status == MODIFIED \\
1867 The box executes itself only when an input was changed (normal pipeline processing).
1868 \item {\bf\emph{Reactive}}: %bbSetModifiedStatus() calls bbUpdate() \\
1869 Re-processes immediately when \emph{any input} changes.\\
1870 To be more selective, better use
1871 '\texttt{connect A.BoxChange B.BoxExecute}'.
1872 \item {\bf\emph{Always}} :% bbUpdate() always calls Process. \\
1873 Usefull for 'sources', that must be processed, even when no input changed (e.g.: FileSelector, ColorSelector)\\
1874 This one is not end user intended (for Package developer only)
1877 \item And one default output :
1879 \item {\bf\emph{BoxChange}} : Signals any modification of the box. This output may be connected if necessary to the \emph{BoxExecute}
1880 input of an other box : each time the boxes changes (e.g. a Slider is moved) the box it is connected to will be forced to update.
1883 If you create complex boxes, it is a good idea to define those inputs and outputs to be able
1884 to force the execution of your complex box or be aware of its changes...
1886 \item Any {\bf widget} box has five Inputs, that will be dealt with only if the box is not connected to the \emph{Widget}i of any \emph{Layout} box :
1888 \item {\bf\emph{WinHeight}}: Height of the window
1889 \item {\bf\emph{WinWidth}} : Width of the window
1890 \item {\bf\emph{WinTitle}} : Title of the window
1891 \item {\bf\emph{WinClose}} : Any received signal closes the window
1892 \item {\bf\emph{WinHide}} : Any received signal hides the window
1893 \item {\bf\emph{WinDialog}}: When set to 'true', creates a \emph{dialog window}, that blocks the pipeline until it is closed (\emph{modal})
1896 If you define a complex widget box, it is a good idea to define these inputs to be able
1897 to customize your window settings.
1899 \item Any {\bf widget} box has one mandatory Output :
1902 \item {\bf\emph{Widget}}: that is the \texttt{wxWindow} itself. If it's not connected to the \texttt{Widget}\emph{i} of any \emph{Layout box}, then the box will create its own window (frame or dialog) on execution. If it's connected to the \texttt{Widget}\texttt{\emph{i}} of a \texttt{Layout box},
1903 it will be embedded in its parent window.
1906 If you define a complex widget box, it is a good idea to use this standard name for your window output
1908 \item Any {\bf Layout} box (i.e. \emph{LayoutLine}, \emph{LayoutSplit} or \emph{LayoutTab}) has one or more mandatory Inputs :
1910 \item {\bf\emph{Widget}}\texttt{i}: e.g. a \emph{LayoutSplit} box (Widget which splits a window in two resizeable parts)
1911 has two Input parameters \emph{Widget1} and \emph{Widget2}, used to embed the child windows.\\
1912 e.g. a \emph{LayoutLine} divides the window in up to 9 (depending on the number of inputs \emph{Widget}i) fixed size parts.
1915 If you define a complex layout box, it is a good idea to use these standard names for your
1921 % ==========================================
1922 %\subsection{More on ...}
1923 %\label{bbi-more-on}
1924 % ==========================================
1926 % ==========================================
1927 %\subsubsection{Black box packages}
1928 %\label{bbi-more-on-packages}
1929 % ==========================================
1930 %There are various others user-intended packages :
1933 %---> Were moved in a 'Reference Manual' ?\\
1934 %---> Any suggestion welcome!
1942 % ==========================================
1943 %\subsubsection{Pipeline processing}
1944 %\label{bbi-more-on-pipeline-processing}
1945 % ==========================================
1947 %\item the ``control'' mechanism in bbi.
1949 %When a box is requested to update itself, it asks (recursively) each one of its inputs if it was modified.\\
1950 %In normal pipe-line mode, it will be re-processed if at least one of its imputs was actually modified, as the output of a previous box.
1952 %(switch exec commands, e.g. Button)
1953 %\item the role of ProcessMode to update widgets.
1956 %\subsubsection{Advanced issues}
1957 %\paragraph{Reducing the number of inputs of a box}
1959 % ==========================================
1960 %\subsubsection{Errors}
1961 %\label{bbi-more-on-errors}
1963 % ==========================================
1966 % ==========================================
1970 \section{Using third party Package}
1971 \label{Third_Party_Package}
1972 % ==========================================
1973 % ==========================================
1974 \subsection{Installing a Package}
1975 \label{Installing_a_Package}
1977 % ==========================================
1978 \subsubsection{Linux users}
1979 \label{Installing_a_Package_for_Linux_users}
1981 After compiling a Package, at install time, think of using :
1998 otherwise package documentation will not be generated. \\
2000 Think of updating your environment variable LD\_LIBRARY\_PATH (in .bashrc in
2001 you're using bash), to add the path to the shared library
2002 libbb\emph{YourNewPackageName}.so
2005 % ==========================================
2006 \subsubsection{Windows users}
2007 \label{Installing_a_Package_for_Windows_users}
2008 % ==========================================
2009 Think of updating your environment variable LD\_LIBRARY\_PATH to add the path to the dynamic library
2010 bb\emph{YourNewPackageName}.dll
2012 % ==========================================
2013 \subsection{Plugging in a Package}
2014 \label{Plugging_in_a_Package}
2015 % ==========================================
2017 \bbStudio makes it easy for you : in the menu \texttt{Tools} just click on the
2018 option \texttt{Plug Package}. You will be asked to '\texttt{Select
2019 package directory}'. Browse untill you find the install or the build directory,
2020 depending whether you installed the package or not.
2022 \bbStudio will update the configuration file, generate the 'Package
2023 documentation', and update the 'Boxes Lists'.
2025 You will be able to use the new package just as you did for any other \bbtk
2028 % ==========================================
2029 \subsection{Hard incorporating of a Package}
2030 \label{Hard_incorporating_of_a_Package}
2031 % ==========================================
2033 If the Package you want to use is supplied in a non standard way (e.g.: you
2034 where given one ore more dynamic libraries (\texttt{.dll} or \texttt{.so}), and/or
2035 one or more directories containing \bbtk scripts (\texttt{.bbs})
2036 you can edit your \bbtk configuration and add the appropriate
2037 paths, see \ref{The_configuration_file}.
2040 % ==========================================
2041 \subsection{Updating the documentation}
2042 \label{Updating_the_documentation}
2043 % ==========================================
2044 You may add your own boxes (simple boxes, if you are aware enough in \CPP
2045 language, or complex boxes if you are aware enough in bbtk scripting).
2047 To update the html help of this package,
2048 use the option \texttt{Regenerate package doc}
2049 in the menu \texttt{Tools} of \texttt{bbStudio}.
2050 You'll be prompted for the Package name.
2051 Avoid using the \texttt{-a} option (Regenerate all), since it's time consumming.
2053 To update html boxes lists with the new boxes,
2054 use the option \texttt{Regenerate Boxes Lists}
2055 in the menu \texttt{Tools} of \texttt{bbStudio}.
2057 % ==========================================
2058 \subsection{Using the package}
2059 \label{Using_the_package}
2060 % ==========================================
2062 The only thing you have to do is to \texttt{include} or \texttt{load} the package,
2063 within a script, or from the \texttt{Command} part,
2064 and enjoy the black boxes it contains.
2066 % ==========================================%\subsection{Packages you'll probably want to use }
2067 %\label{Packages_you_ll_want_to_use}
2068 % ==========================================
2070 %\item{\texttt{creaLib}} \\
2071 %a.k.a \texttt{crea}. It's a set of 'low level' utilities, needed by other
2072 %packages (an, sure, useful as well for people that doesn't use bbtkns.
2073 %\item{\texttt{creaContours}} \\
2074 %Provides sophisticated widgets for managing 3D R.O.I. (Regions of interest)
2075 %\item{\texttt{creaImageIO}} \\
2076 %Allows browsing, selectionning, ordering directories containing images of almost any type
2081 % ==========================================
2085 \section{Using black boxes in \CPP programs}
2087 % ==========================================
2089 A very useful feature is that you may use any widget
2090 black box within a \CPP program
2091 without worrying about writing a \wx main application.\\
2093 Let's look a the following bbs script :
2100 # Create the Objects
2103 new LayoutLine layout
2105 # Graphical pipeline
2106 connect slider.Widget layout.Widget1
2107 connect text.Widget layout.Widget2
2109 # Execution pipeline
2110 connect slider.BoxChange text.BoxExecute
2111 connect slider.Out text.In
2117 User wants to create a slider and an output text, within a LayoutLine,
2118 and display the slider value in the output text.
2119 Think about the (little!) nightmare to code the same, in 'raw C++', using wxWidgets.
2121 The following \CPP code does the same :
2124 #include <bbtkFactory.h>
2125 #include <bbwxSlider.h>
2126 #include <bbwxOutputText.h>
2127 #include <bbwxLayoutLine.h>
2129 int main(int argv, char* argc[])
2133 // we need to intanciate a bbtk::Factory to be aware of the adaptors
2134 bbtk::Factory::Pointer factory = bbtk::Factory::New();
2136 // Load the packages
2138 factory->LoadPackage("std");
2139 factory->LoadPackage("wx");
2141 // Create the Objects
2142 // ------------------
2143 bbwx::Slider::Pointer slider = bbwx::Slider::New("slider");
2144 bbwx::OutputText::Pointer text = bbwx::OutputText::New("text");
2145 bbwx::LayoutLine::Pointer layout = bbwx::LayoutLine::New("layout");
2147 // Graphical pipeline
2148 bbtk::Connection::Pointer c1 = bbtk::Connection::New(slider,"Widget",
2151 bbtk::Connection::Pointer c2 = bbtk::Connection::New(text,"Widget",
2154 // Execution pipeline
2155 // ------------------
2157 // We have to pass the 'factory', in order to call automatically an adaptor,
2159 bbtk::Connection::Pointer s2t = bbtk::Connection::New(slider,"Out",
2162 bbtk::Connection::Pointer c3 = bbtk::Connection::New(slider,"BoxChange",
2164 layout->bbSetInputWinDialog(true);
2168 layout->bbExecute();
2171 catch (bbtk::Exception e)
2173 bbtk::MessageManager::SetMessageLevel("Error",1);
2178 In this code, we use the headers of the \texttt{bbwx} \CPP library,
2179 which define the black boxes of the \texttt{wx} package.
2185 % ==========================================
2188 \section{\bbs language reference}
2189 \label{bbi-reference}
2190 % ==========================================
2192 % ==========================================
2193 \subsection{Pipeline creation and execution related commands}
2194 \label{bbi-reference-creation-execution}
2195 % ==========================================
2196 % See table \ref{bbi-reference-box}
2198 % ==========================================
2200 \caption{\label{bbi-reference-box} \bbs pipeline creation and execution related commands.}
2202 \begin{tabular}{|lcm{6cm}|}
2204 Command & Parameters & Effect \\ \hline
2206 \texttt{new} & \texttt{<box-type>} \texttt{<box-name>}&
2207 Creates a box of type \texttt{box-type} and name
2208 \texttt{box-name}.\\ \hline
2210 \texttt{newgui} & \texttt{<box-name>} \texttt{<gui-box-name>} &
2211 Automatically creates a graphical user interface with name \texttt{gui-box-name}
2212 for the black box \texttt{box-name} and connects it to the box inputs\\ \hline
2214 \texttt{delete} & \texttt{<box-name>} &
2215 Destroys the box named \texttt{box-name}\\ \hline
2217 \texttt{connect} & \texttt{<box1.output>} \texttt{<box2.input>} &
2219 \texttt{output} of the box named \texttt{box1}
2220 to the input \texttt{input} of the box named \texttt{box2} \\ \hline
2222 \texttt{set} & \texttt{<box.input>} \texttt{<value>} &
2223 Sets the input \texttt{input} of
2224 the box named \texttt{box} to the value \texttt{value}.
2225 An \texttt{adaptor} must exist
2226 in the packages loaded which converts a \texttt{std::string}
2227 to the type of the input \texttt{input}. \\ \hline
2229 \texttt{exec} & \texttt{<box-name>} &
2230 Executes the box named \texttt{box-name}.
2232 connected to its inputs
2233 are also processed recursively (pipeline processing).\\ \hline
2235 Allows to block execution commands while keeping definition commands active (this one is not for end user)\\ \hline
2236 & \texttt{unfreeze} &
2237 Turns back to 'normal' mode (this one is not for end user).\\ \hline
2240 % ==========================================
2244 % ==========================================
2245 \subsection{Package related commands}
2246 \label{bbi-reference-package}
2249 \caption{\label{tabbbi-reference-interpreter_1}\bbs package related commands. }% (part 1).}
2251 \begin{tabular}{|lcm{6cm}|}
2253 Command & Parameters & Effect \\ \hline
2256 \texttt{include} & \texttt{<package-name>} &
2257 Loads the package \texttt{package-name} and includes all its complex box definition scripts. \\ \hline
2259 \texttt{load} & \texttt{<package-name>} &
2260 Loads the atomic black boxes of package \texttt{package-name}.
2261 Loads the dynamic library but not the complex boxes defined in the scripts shipped with the package.
2262 Use it only if you know that you won't work with its complex black boxes \\ \hline
2264 \texttt{unload} & \texttt{<package-name>}&
2265 Unloads the package \texttt{package-name}.
2266 The package must have been previously loaded.
2267 No box of a type defined in this package must still exist.\\ \hline
2269 \texttt{reset} & - & Deletes all boxes and unloads all packages so
2270 that the interpreter gets back to its initial state \\ \hline
2273 \texttt{package} & \texttt{<package-name>} &
2274 All complex black boxes definitions until the next \texttt{endpackage}
2275 will be stored into the package \texttt{package-name} \\ \hline
2277 \texttt{endpackage} & - &
2278 Closes a \texttt{package} command \\ \hline
2285 % ==========================================
2286 \subsection{Interpreter related commands}
2287 \label{bbi-reference-interpreter}
2288 % ==========================================
2289 %See table \ref{tabbbi-reference-interpreter_1} and \ref{tabbbi-reference-interpreter_2}
2290 % ==========================================
2292 \caption{\label{tabbbi-reference-interpreter_1}\bbs intepreter related commands. }% (part 1).}
2294 \begin{tabular}{|lcm{6cm}|}
2296 Command & Parameters & Effect \\ \hline
2300 Prints help on available commands \\ \hline
2302 & \texttt{<command-name>} &
2303 Prints help on the command \texttt{command-name} \\ \hline
2305 & \texttt{packages} &
2306 Prints help on available packages and their box types
2307 (without description)\\ \hline
2309 & \texttt{<package-name>} &
2310 Prints help on the package \texttt{package-name} and its boxes
2311 (with brief description).
2312 The package must have been previously loaded \\ \hline
2314 & \texttt{<box-type>} &
2315 Prints help (with full description) on the type of box
2317 The box type must belong to a package which has been previously loaded \\ \hline
2321 Prints information on available kinds of messages and their current level\\ \hline
2323 & \texttt{<kind>} \texttt{<level>} &
2324 Sets the level of verbosity of the interpreter for the kind of messages
2325 \texttt{kind} to \texttt{level}.\\ \hline
2328 \texttt{include} & \texttt{<file-name>} &
2329 Includes and executes the content of the file named \texttt{file-name}
2330 exactly like if you were typing its content at the place were the
2331 \texttt{include} command is. \\ \hline
2333 \texttt{print} & \texttt{<string>} &
2334 Prints the string after substituting each token of the form \texttt{\$box.output\$} by the adaptation to string of the value of the
2335 output \texttt{output} of the box named \texttt{box}.
2336 An \texttt{adaptor} must exist
2337 in the packages loaded which converts
2338 the type of the output \texttt{output}
2339 to a \texttt{std::string}.
2342 \texttt{graph} & ... &
2343 Generates the html doc including the pipeline graph for a given complex box \\ \hline
2345 \texttt{index} & ... &
2346 Generates the html index of currently loaded boxes types \\ \hline
2348 \texttt{config} & - & Displays the configuration parameters\\ \hline
2351 \texttt{debug} & \texttt{<debug-directive>} &
2353 Prints debug info on living bbtk objects containing the string \texttt{expr} (default expr='').
2354 \texttt{-C} checks the factory integrity.
2355 \texttt{-D} turns on objects debug info after main ends\\ \hline
2357 \texttt{quit} & - & Exits the interpreter\\ \hline
2361 % ==========================================
2365 % ==========================================
2366 \subsection{Complex black box definition related commands}
2367 \label{bbi-reference-black-box-definition}
2368 % ==========================================
2370 %See table \ref{bbi-reference-complex-box}
2371 % ==========================================
2373 \caption{\label{bbi-reference-complex-box} \bbs complex black box definition related commands.}
2375 \begin{tabular}{|lcm{6cm}|}
2377 Command & Parameters & Effect \\ \hline
2380 \texttt{define} & \texttt{<box-type>} [\texttt{<package-name>}] &
2381 Starts the definition of a complex black box of type
2382 \texttt{box-type}. If \texttt{<package-name>} is provided then includes the
2383 box in the given package (otherwise it is defined in the current package,
2384 i.e. \texttt{user} if outside a \texttt{package/endpackage} block). \\ \hline
2386 \texttt{endefine} & - &
2387 Ends the definition of a complex black box type\\ \hline
2389 \texttt{author} & \texttt{<string>} &
2390 Concatenate the string to the author string
2391 of the current complex black box.\\ \hline
2393 \texttt{description} & \texttt{<string>} &
2394 Concatenate the string to the description of the current complex black box.
2397 \texttt{category} & \texttt{<string>} &
2398 Specifies the \texttt{categories} of the current complex black box.
2399 The categories must be separated by semicolons, e.g. "\texttt{widget;image}"\\ \hline
2401 \texttt{kind} & \texttt{<box kind>} &
2402 Specifies the \texttt{kind} of the current complex black box
2403 ( ADAPTOR, DEFAULT\_ADAPTOR, WIDGET\_ADAPTOR, DEFAULT\_WIDGET\_ADAPTOR )\\ \hline
2405 \texttt{input} & \texttt{<name>} \texttt{<box.input>} \texttt{<help>} &
2406 Defines a new input for the current complex black box,
2407 named \texttt{name}.
2408 It is defined as corresponding to
2409 the input \texttt{input} of the box \texttt{box}.
2411 \texttt{<help>} is the help string for the new input.
2412 The box \texttt{box} must already have been created in the complex box
2413 and of course have an input named \texttt{input}.\\ \hline
2415 \texttt{output} & \texttt{<name>} \texttt{<box.output>} \texttt{<help>} &
2416 Defines a new output for the current complex black box,
2417 named \texttt{name}.
2418 It is defined as corresponding to
2419 the output \texttt{output} of the box \texttt{box}.
2420 \texttt{<help>} is the help string for the new output.
2421 The box \texttt{box} must already have been created in the complex box and of course have an output named \texttt{output}. \\ \hline
2427 Note : if outside a \texttt{define/endefine} block then the current complex black box
2428 is '\texttt{user::workspace}', that is the main program equivalent
2429 (this is how applications are documented).
2430 This remark holds for all complex black box related commands.
2439 % ==========================================
2440 % ==========================================
2441 % ==========================================
2442 % ==========================================
2443 % ==========================================
2444 % ==========================================
2445 % ==========================================
2446 % ==========================================
2447 % ==========================================
2448 % ==========================================
2451 \section{Install and run time issues}
2452 % ==========================================
2457 %%==============================================================================================
2458 %%==============================================================================================
2459 \subsection{\bbtk configuration file}
2460 \label{The_configuration_file}
2461 %%==============================================================================================
2462 %%==============================================================================================
2464 At start, \bbtk applications (\bbStudio, \bbi) try
2465 to open an \texttt{xml}
2466 configuration file named \texttt{bbtk\_config.xml}.
2469 \item The current directory
2470 \item The subdir \texttt{.bbtk} of the user's home directory.
2472 \item On \texttt{Unix}, the home directory is the
2473 one stored by the environnement variable \texttt{HOME},
2474 typically \texttt{/home/username}.
2475 \item On \texttt{Windows}, the home directory is
2476 the user's profile directory stored by the environnement
2477 variable \texttt{USERPROFILE},
2478 typically \texttt{C:$\backslash$ Documents and Settings$\backslash$ username}.
2480 \item If none of these two paths contains the file then it creates
2481 a new one in the \texttt{.bbtk} directory.
2485 Information on \bbtk configuration is
2486 obtained in \bbStudio by clicking on the
2487 \texttt{Config} button of the \texttt{Command} part toolbar.
2489 If you did not installed other packages than the ones
2490 provided by \bbtk, you get something like :
2496 bbtk_config.xml : [/home/guigues/.bbtk/bbtk_config.xml]
2497 Documentation Path : [/usr/local/bin/../share/bbtk/doc]
2498 Data Path : [/usr/local/bin/../share/bbtk/data]
2500 File Separator : [/]
2503 --- [/usr/local/bin/../share/bbtk/bbs]
2506 --- [/usr/local/bin/../lib]
2509 The first line let you know which configuration file is currently used.
2511 You can open this file using \bbStudio menu \texttt{Files$>$Open bbtk Config file}.
2513 You will get something like :
2516 <?xml version=\"1.0\" encoding=\"iso-8859-1\"?>
2518 <bbs_path> </bbs_path>
2519 <package_path> </package_path>
2520 <default_temp_dir> $ </default_temp_dir>
2524 The \texttt{xml} tags \texttt{bbs\_path} and \texttt{package\_path}
2525 allow to set additionnal directories in which to search
2526 for \bbs files and packages dynamic libraries.
2528 For example, if you add the line :
2530 <bbs_path> /home/guigues/bbs </bbs_path>
2533 Then the interpreter will search for \bbs in the folder \texttt{/home/guigues/bbs},
2534 which allows a command like \texttt{'include bbMyBox.bbs'} to work if
2535 the folder \texttt{/home/guigues/bbs} contains the file \texttt{bbMyBox.bbs}.
2537 The same, the \texttt{xml} tag \texttt{<package\_path>} let you
2538 set additional path in which to find a package dynamic library,
2539 hence allowing to load additionnal packages with the \texttt{'load'} command.
2541 All \bbs and package paths are summmarized in the
2542 information output when pressing 'Config' in \bbStudio.
2543 You can see that two \bbs paths are always set :
2545 \item The current directory (\texttt{.})
2546 \item The \bbs folder of \bbtk
2548 Also, two package paths are always set :
2550 \item The current directory (\texttt{.})
2551 \item The libraries folder of \bbtk
2554 Additional paths set in your \texttt{bbtk\_config.xml} are added after those standard paths.
2555 Note that the order displayed is the one in which the folders are searched when
2556 \texttt{include} or \texttt{load} commands are issued.
2559 %%==============================================================================================
2564 %For some strange reasons (?!?), at \texttt{cmake} time,
2565 %you may be warned that an error occured while documentation generation.\\
2566 %Take it easy, \texttt{make} again!\\
2568 \item{\bbStudio} is written using the Advanced User Interface library of wxWidgets.
2569 If, after some hazardous floating/docking operations onto the frame, you feel
2570 very unhappy with the result, just remove from the hidden directory
2571 \texttt{.bbtk} the file named \texttt{bbStudio.aui}. \\