radadrgen

- code generator

Synopsis

/usr/bin/radadrgen [-N] spec.xml

/usr/bin/radadrgen [-N] -c dir [-r [ -m ] [ -s ]] spec.xml

/usr/bin/radadrgen [-N] -j dir [-i] spec.xml

/usr/bin/radadrgen [-N] {-o docbook | docbook-man | man | rmdoc} spec.xml

/usr/bin/radadrgen -d baseline.xml spec.xml

Description

The radadrgen command is the ADR IDL processing tool. Its primary purpose is to generate language bindings for the rad server and the various rad client environments. It can also generate documentation, and audit changes to interfaces for consistency with their versions.

All invocations validate the given spec.xml against the ADR schema.

Options

The following options are supported:

Common Options

-N

Do not limit what types can be nullable. This restriction is in place to facilitate mapping to languages where certain types are not naturally nullable. This option relaxes this restriction for uses where it is both permissible and advantageous for all types to be nullable.

C Definition Options

-c dir

Generate C definitions for the types and interfaces defined in the input file. Files will be created under dir.

-r

Generate C server-side definitions that reference entry points using the prescribed entry-point naming scheme.

-m

Do not generate separate definitions for inherited interfaces. By default, new definitions are generated for inherited interfaces, replicating the definitions in the inherited interface.

-s

Generate C stubs for entry points referenced by the definitions created by the -r option.

Java Definition Options

-j dir

Generate Java interfaces for the types and interfaces defined in the input file. The Java source tree will be created under dir.

-i

Generate concrete implementation classes for the interfaces created for structured types.

Documentation Generation Options

-o format

Generate documentation, in the given format, for the interface definition in spec.xml. Documentation can be improved by decorating the various parts of the interface definition with summary and doc elements.

Valid formats:

docbook

standard docbook format

docbook-man

man page content in docbook format, a precursor to man format, below

man

a man page, in [nt]roff format

rmdoc

spec.xml, with the summary and doc elements removed

Interface Comparison Options

-d baseline.xml

Compare the interfaces defined by baseline.xml and spec.xml and verify that the version of the modified interface is consistent with the differences found. An error message is displayed if the versions are inconsistent.

Operands

The following operand must be specified on the command line:

spec.xml

The path to the API specification for which type and interface definitions must be generated.

Files

/usr/share/lib/xml/rng/radadr.rng.1

The core ADR RelaxNG schema definition.

/usr/share/lib/xml/rng/radadr-doc.rng.1

The ADR RelaxNG schema definition for documentation elements.

Attributes

See attributes(5) for descriptions of the following attributes:

See Also

rad(1M), attributes(5)