Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document new --idl-version and macro #283

Merged
merged 3 commits into from
Jul 14, 2023
Merged

Document new --idl-version and macro #283

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7f1d4d4
Document new --idl-version and macro
jwillemsen Jul 13, 2023
51f46d5
IDL4 restriction
jwillemsen Jul 13, 2023
39658ac
Updated doc
jwillemsen Jul 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 18 additions & 4 deletions docs/src/ridlc.adoc
View file
Open in desktop
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