 |
girtobac
0.4
Create FB Headers from GObject Introspection *.gir files
|
|
girtobac
0.4
Create FB Headers from GObject Introspection *.gir files
|
This chapter is about
The following table lists all dependencies for girtobac and their types. At least, you have to install the GLib library (containing GObject) and the FreeBASIC compiler on your system to build your girtobac executable. (Of course, later you'll need it for your projects as well.) Beside this mandatory (M) tool, the others are optional. Some are recommended (R) in order to make use of all package features. LINUX users find some packages in their distrubution management system (D).
| Name | Type | Function |
|---|---|---|
| GLib | M D | Integrated development environment (ie. to test templates) |
| fbc | M | FreeBASIC compiler to compile the source code |
| GIT | R D | version control system to organize the files |
| CMake | R D | build management system to build executables and documentation |
| cmakefbc | R | FreeBASIC extension for CMake |
| fb-doc | R | FreeBASIC extension tool for Doxygen |
| Doxygen | R D | documentation generator (ie. for this text) |
| Graphviz | R D | Graph Visualization Software (caller/callee graphs) |
It's beyond the scope of this guide to describe the installation for those programming tools. Find detailed installation instructions on the related websides, linked by the name in the first column.
sudo in case of non-LINUX systems.sudo in case of non-LINUX systems.Depending on whether you installed the optional GIT package, there're two ways to get the girtobac package.
Using GIT is the prefered way to download the girtobac package (since it helps users to get involved in to the development process). Get your copy and change to the source tree by executing
As an alternative you can download a Zip archive by clicking the Download ZIP button on the girtobac website, and use your local Zip software to unpack the archive. Then change to the newly created folder.
Before you can use the girtobac tool to generate your header files, you've to compile the source code first by either
The prefered way to build the executable and the documentation files is to use the scripts for the CMake build system. If you don't want to install or to use CMake, then skip this section and continue at Direct compiling.
The CMake scripts check your system and through warnings if anything is missing. Otherwise you can either perform an in-source or an out-of-source build. The later should be your prefered choise.
The following command triple will compile the executable in the source tree and install it on your system:
sudo in case of non-LINUX systems.The following command quintuple will create a new build folder, change to that folder, compile the executable and install it on your system:
sudo in case of non-LINUX systems.In order to build the documentation, all recommended packages listed in section Tools have to get installed. The following command will build the documentation in form of an HTML file tree and in form of a PDF file (either in-source or out-of-source):
Both targets can get build separately by executing
In order to build the executable change from the package root directory to the src folder and compile by executing
This creates an executable binary named
that you can install wherever you need it.
In order to build the documentation, install the tools fb-doc, Doxygen and Graphviz. Then change from the package root directory to the doc folder, up-date the file fb-doc.lfn, execute the Doxygen generator and adapt correct listings by executing
to build the documentation in subfolders html (start file = index.html) and latex (call make in that folder to build refman.pdf).
1.8.6