4. HuGo parameters
Aus Hugo Doku
This section describes the common programm parameters of HuGo. You do not have to care about how to set these programm parameters if you use the default values. This section describes the meaning and default value of the parameters. How you set these parameters depends on the environement you are using; so please refer to the corresponding section.
For all path parameters please note:
* There is only one directory given as path value.
* Parameters and values are case sensitiv.
* The path is relativ to the project directory.
If you use an absolute path the path setting has to be compatible to your operating system, e.g. E:\all_models\models_abc will not work under Linux.
All the programm parameters are saved in a file named .hugo_project.xml, which is located directly in the project directory. Or say it the other way round: This file determines the project directory, as all settings are interpreted relative to .hugo_project.xml.
HuGo Programm Parameters
| Name | Description | Default Value |
|---|---|---|
| project-name | This parameter is used for interal administration, e.g. the filenames for persistent data oder the codings,saved on disk, contain this project-name. Thus codings can be distinugished by their project-name, even if the settings of the repose directory of different projects point to the same directory on disk. | The directory, from which HuGo is first called. Using the eclipse plugin this is normally the eclipse project directory. |
| model | The directory path, where the model-files are placed.
The model files are the XML files, written in a semantic DSL, which specify the generated variants. It is sensible to name the model-files .model, but you can use any extension you want; because which model-files are taken is determined by the filter-files. | model |
| gen | The relative directory path, where the frame-files are placed. Here only a relative path is allowed, not an absolute. Because this relative path is used twice:
1. Location of .jxgp files (relative to project directory) For each tag written in a model-file, a corresonding frame-class in a corresponding .jxgp is searched in this directory; e.g. For <item> a frame class item is searched in a file item.jxgp in the frames directory. (This correlation was discussed in !!!). 2. Location of .java and .class files of the compiled .jxgp files (relative to the $repose directory, see in a further below row in this table.) | frames |
| filter | The directory path, where the filter-files are placed.
The filter files determine, which model files of the model directory are the one, which are taken for the current generator running step. (You can say: These files "filter" the model file list). Thus the filter files control the generating process, which can consists on several running steps, at HuGocalled "stages". For detailed informations about the stages please refer to !!!. Here you also find examples for .filter files. | filter |
| repose | Verzeichnis für codings und compilierte Frame-Klassen | .jxgp_gen_files |
| db | The directory path, where the persistent data are placed.
Within your frames you can define persistent data. After a generator run their values are saved to disk in this directory, thus they are available for a further generator run. For an example of how to declare persistent data please refer to !!!. The process, when exactly persistent data are loaded and saved is decribed in !!!. | persistent |
| verbose-level | How talkative HuGo is on the console.
Within the eclipse plugin there is a HuGo console, where the messages are shown. -1: quiet 0..5: intensity of verbosity | 1 |
| frame-builder | Whether the frame-builder should be started.
Please remind, that you need the Frame Builder only for domain engineering; thus finishing the domain engineering you can set this parameter to false when just running your individual ready-to-run generator (see !!!) | true |
| model-builder | Whether the model- builder should be started. | true |
