Build-System

libFAUDES C++ sources are POSIX compliant and have been verified to compile on various platforms, incl. Linux, Mac OsX and MS Windows. Still, the build process can be a hassle. The download page therefor provides precompiled libFAUDES archives including executables of luafaudes and other utilities.

For all other system environments you need to use the standard libFAUDES distribution and re-compile. The required steps are described below.

Application-Developer Targets

The standard distribution ships with a configured source tree and provides a GNU-make Makefile that supports the following application developer targets.

After extracting the libFAUDES archive to e.g. ./libfaudes, open a shell (aka console, command line, etc) and run

> make clean
> make default

from within ./libfaudes to re-compile libFAUDES.

The Makefile uses some GNU-make specific extensions, so you are best of using the GNU tool-chain. Most Linux Distributions offer a C++ development package. For Mac OsX, the GNU tool-chain is provided by Apple's Developer Package or the Darwin project.

For MS Windows, libFAUDES has been verified to compile with Cygwin or MinGW. The former provides an almost POSIX environment and you can go ahead with the same instructions as for Linux/Unix. For MinGW you can use the supplied Makefile. however, you need to specify the platform explicitly by e.g.

C:\libfaudes> make clean   FAUDES_PLATFORM=gcc_win
C:\libfaudes> make default FAUDES_PLATFORM=gcc_win

Note that the MinGW make, g++ and gcc must be specified in your PATH environment variable.

If you want to use MS Visual C++, the starting point is to grab the configured libFAUDES source and dump them into a Visual C++ project. When we last tested this, there was an issue with STL const_iterators, which was resolved by installing an SGI implementation of STL. Let us know if MS Visual C++ is crucial for your application.

Library-Developer Targets

For library extensions by plug-ins, the build-system needs to configure the source tree and generate UI and API documentation. In this stage, the current build-system relies on a number of more or less common Unix tools. For the following library developer targets we recommend a Unix-style environment:

The libFAUDES archive provides a copy of GTML and SWIG for convenience. Assuming you have Perl installed anyway, the provided GTML will be functional as it is. SWIG, however, requires installation.

To re-configure libFAUDES sources from scratch, you may run

> make dist-clean
> make configure

HTML Documentation Processing

While libFAUDES uses doxygen as a professional tool to generate the C++ API documentation, we did not yet find a similar tool for the user-reference. In order to still have some systematic approach to a user-level documentation, the libFAUDES build-system uses the run-time-interface as a basis. The actual process invokes a number of home-grown tools and is perhaps due for a thorough re-design. However, some care has been taken to have a consistent input format that encodes relevant structural data. In the meanwhile, we would like to encourage plug-in developers to (a) contribute to the user reference to advertise the plug-in and (b) stick to the below conventions where ever possible to ease revisions of the build process.

RTI Definitions

A plug-in should provide one or more RTI definition files that define an URL and a list of keywords per user relevant faudes-function or faudes-type. The first two keywords will be interpreted as section- and subsection name, respectively. By convention, the URL consists of a filename and a location. The filename should start with the section name (which usually matches the plug-in name) followed by an underscore. The location should match the respective function or type name.

Example: URL corefaudes_regular.html#LanguageConcatenate, Keywords CoreFaudes, Regular Expressions, Languages, ... .

Documentation Source Files

A plug-in must provide documentation files corresponding to the URLs defined in the RTI definition files. In order to minimize redundancy and still have a consistent layout (navigation etc.), the documentation files are processed by the Perl script GTML. Each provided documentation file should contain valid HTML as it appears between the <body> and </body> tags and use the below GTML macros:

The above macros are defined in ./src/doxygen/faudes_macros.html (general) and ./src/registry/registry_macros.html (registry specific). For the plug-in yourplugin, you can define additional macros by providing a file ./plugins/yourplugin/src/registry/yourplugin_macros.html. This mechanism is used for a preliminary approach to manage literature references:

Processing

To trigger a re-build of the user-reference, use

> make rti-clean
> make rti

This will

 

 

libFAUDES 2.16b --- 2010-9-8 --- plugins "example synthesis observer diagnosis hiosys multitasking timed simulator iodevice luabindings"