Skip to content

Commit

Permalink
Merge pull request #283 from jwillemsen/jwi-idl4ridlcdoc
Browse files Browse the repository at this point in the history
Document new --idl-version and macro
  • Loading branch information
jwillemsen authored Jul 14, 2023
2 parents 733b728 + 39658ac commit 702ba4d
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions docs/src/ridlc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,12 @@ the https://www.omg.org/spec/CORBA[CORBA specification], and the
http://www.amazon.com/gp/product/0201379279/ref=as_li_tf_tl?ie=UTF8&camp=1789&creative=9325&creativeASIN=0201379279&linkCode=as2&tag=theaceorb-20[Advanced
CORBA Programming with C++] book.

All https://www.omg.org/spec/IDL/4.2[IDL4] support is experimental.
The IDL to {cxx11} language defines a mapping for the IDL4 extended datatypes, but
there is only for DDS a standardized wire protocol for transferring these types through the wire.
For CORBA this is standardized yet and need still a lot of
research and standardization work.

== Usage

The basic command line for the RIDL compiler is:
Expand Down Expand Up @@ -57,11 +63,13 @@ nil
Defines a preprocessor macro. By default the following macros are
defined: +

* `__RIDL__` set to the stringified version number of the RIDL frontend
* `__RIDLBE__` set to the id of the active (main) RIDL backend; here
* `\\__RIDL__` set to the stringified version number of the RIDL frontend
* `\\__RIDLBE__` set to the id of the active (main) RIDL backend; here
`{cxx11}`
* `__RIDLBE_VER__` set to the stringified version of the active (main)
RIDL backend|
* `\\__RIDLBE_VER__` set to the stringified version of the active (main)
RIDL backend
* `\\__RIDL_IDL_VERSION__` set to the stringified version of the IDL
version (3 or 4)|

|-n|--namespace=NAMESPACE|

Expand All @@ -75,6 +83,12 @@ Set verbosity level. Repeat to increment.|

0

||--idl-version=VERSION|

Select the IDL version, 3 or 4 |

3

||--stdidl|

Adds include path to standard IDL files provided with RIDL.|
Expand Down

0 comments on commit 702ba4d

Please sign in to comment.