Generation

Documentation Alma (english) Index | Home
Version: 0.29
Date: 2001-03-05
Author: Guillaume Desnoix
The documentation of the software named Alma is protected by copyright according to the laws of the french state. Any reproduction (copy, mirror, printing, ...) is forbidden without a written autorisation from the author. Every one can read it freely (and only) on this web site www.memoire.com.

Principes

Once you have a model in memory, you can launch a generation for a chosen target. Many targets are already available.

Options

Generation languages

Command line: -g <langage>
Possible values: Java Bdl Idl Odl UmlHierarchie UmlRelations Uxf Xmi Naturel Gui Autotest Lisp C H Cpp Hpp
Default value: Java

Selects a target in the list. All the next generations will be done according to this target.

Simplified target

Command line: -s
Default: disactivated

Enables the simplified mode. Depending on the target, the general purpose is to generate a limited text, shorter than the full one. For example, attributes and methodes are not generated or only the prototypes are displayed.

Used classes comment

Command line: -u
Default disactivated
Used in: toutes

If activated, a comment is added at the end, listing all the used classes.

Trace

Command line: not available
Par défaut: disactivated
Used in: all

If activated, comments will be generated for each element. This option should be activated only for development and debugging purposes.

Style sheet

Command line: none
Possible values: *.css
Default value: DocHtml.css
Used in: DocHtml UmlHierarchie UmlRelations

Path to the style sheet for all targets generating HTML.

Pictures format

Command line: none
Possible values: Gif Jpeg Xpm Png
Default value: Gif
Used in: UmlHierarchie UmlRelations

Selects Pictures format used to save the generated pictures. Til now, only GIF, JPEG and Xpm are available. PNG will be added and will be the default format.

Natural language

Current status: non disponible
Possible values: fr en de it ...
Default value: fr

Chooses the language for generated texts (comments, Naturel target, ...).

Module

Command line: -m <module>
Possible values: partial namespace
Default value: empty
Used in: UmlHierarchie

Specifies a filter by the modul name. All elements matching this filter willbe treated differently.

Classe

Command line: -m <module>
Possible values: class name
Default value: empty
Used in: UmlRelations

Specifies a filter by the class name. This class will be treated differently.

Target descriptions

Definition languages

Bdl

Current status: unstable

This target generates a short summary of components. the point of view if a properties/events one instead of the classical attributs/methodes one. Now it's mainly used for JavaBeans components. The output is in french.

Idl

Current status: unstable

Used by Corba tools, this target has the same limitations than the Idl source.

Object-oriented programming langages

Cpp

Current status: unstable

This target generates the implementations for C++ (bodies). It should be used with the Hpp target.

Java

Current status: unstable

This target generates Java source code.

Lisp

Current status: unstable

This target generates Lisp source code. The current release uses defclass , deffield , defmethod , defvariable  to declare the elements. The compatibility with Common Lisp (CLOS) and (eventually) LeLisp (MicroCeyx) is planned.

Hpp

Current status: unstable

This target generates the declarations for C++ (headers). It should be used with the Cpp target.

Functionnal or procedural programming languages

C

This target generates the implementations for C (bodies). It should be used with the H target.

H

Current status: unstable

This target generates the declarations for C (headers). It should be used with the C target.

Rebol

Cette cible génère du code Rebol.

Sql2

Précision: version 2 (1992)
Current status: unstable

Generates scripts for creating tables in a database (RDBM).

Sql3

Précision: version 3 (2001?)
Current status: unstable

Generates scripts for creating tables in an universal database.

Description targets

DocHtml

Current status: unstable

This target generates a HTML page describing classes. Similar to javadoc by the concept, this tool is still really less developped. It has the advantage to work with all kind of sources (Java, Idl, Fortran, ...). The first release was a contribution of Axel von Arnim.

Naturel

Current status: unstable

This target generates a description in natural language. Til now, only french is available. Its goal is to provide a description of the object model.

UmlHierarchie

Current status: unstable

This target generates a graph of inheritance relations between classes, following UML rules. A HTML page is also generated, including a MAP for clickable pictures. It's important to fill the module field in the configuration panel.

UmlRelations

Current status: unstable

This target generates a graph of relations between classes, following UML rules. A HTML page is also generated, including a MAP for clickable pictures. It's important to fill the classe field in the configuration panel.

Uxf

Current status: unstable

This target generates a XML document, according to the DTD written by a japonese group. For more informations, visit their site: http://www.yy.cs.keio.ac.jp/~suzuki/project/uxf/.

Tools

Autotest

Current status: unstable

This target generates the source code in Java to test automatically some classes. It creates some instances and calls the methods with different parameters. Daily comparaison helps to detect bugs. Each class must provide a public constructor without parameters.

Déploiement

Current status: project

This target lists the necessary classes to build a distribution.

Gui

Current status: unstable

This target generates a GUI, providing an editor for each class. You get a dialog box with the fields of the object.