Generating Module Stubs

| iMatix home page
| Libero home page | Libero documentation
| << | < | > | >>

Libero
Version 2.32

Generating Module Stubs

Take a hypothetical language where a module stub looks like this:

//###################  SOME FUNCTION   ##################//

MODULE some_function () {

}

To generate stubs like this we add these commands to the schema:

:internal initialise_the_program
:internal get_external_event
:set $module_line  = "MODULE %s () {"
:set $stub_first   = "//"
:set $stub_between = "#"
:set $stub_last    = "//"
:do stubs

MODULE $name () {

}

:enddo stubs

This is how it works:

The :internal commands tell Libero to ignore these two modules when it looks through the source file. Without these two commands, Libero would print a message saying that the source file contained modules no longer used in the dialog. We tell it that some modules are used internally by the generated code.
The $module_line tells Libero what to look for when it is running its idle module check. This must always match the header of the stub below.
Libero looks at each file specified in the :do stubs line. If you do not specify any files, Libero looks just at the source file.
When it builds a new module stub, Libero outputs a line containing $stub_before before each stub. Usually this is a blank line.
Libero uses $stub_first, $stub_between, and $stub_last to build-up the header line.
The text between the :do and :enddo is repeated, with a header, for each missing module.

The :do stubs command can come at any point in the schema. It does not do any output to the current output file. However, in many cases it is a good idea to list generated files in the :dostubs line, which means that this should come at the end of the schema, when everything has been generated.