Command Reference

NAME

occ --- the Open C++ compiler

SYNOPSIS

occ [-l] [-s] [-V] [-v] [-m[file_name]] [-c] [-E] [-n] [-p] [-P]
    [-Iinclude_directory] [-Dname[=def]] [-Moption[=value]]
    [-Smetaclass] [-doption] [--regular-c++]
    [-- C++ compiler options [.o and .a files]] source_file

DESCRIPTION

occ compiles an OpenC++ program into an object file. It first invokes the C++ preprocessor with the predefined macro __opencxx and generates a .occ file, then translates it into a .ii file according to the meta-level program. The .ii file is compiled by the back-end C++ compiler, and finally an a.out file is produced. If occ is run with the -c option, it generates a .o file but suppresses linking.

For example, to compile a base-level program sample.cc with the meta-level program MyClass.mc, the user should do as follows:


% occ -m MyClass.mc

First, MyClass.mc should be compiled into shared libraries MyClass.so and MyClass-init.so. The produced shared libraries must be under the directory specified by LD_LIBRARY_PATH. Then, the user can compile the base-level program:


% occ -- -o sample sample.cc

If sample.cc requires a metaclass MyClass, occ dynamically loads and links MyClass.so and MyClass-init.so. Then sample.cc is compiled according to the metaclass MyClass and an executable file sample is produced.

The separate compilation of meta-level programs is also supported. Suppose that MyClass is implemented by foo.mc and bar.mc. The user should compile them as follows:


% occ -c -m foo.mc

% occ -c -m bar.mc

This produces foo.o, bar.o, and MyClass-init.so. Although the second invocation of occ overrides MyClass-init.so produced by the first invocation, this is not a problem. To get the shared library, foo.o and bar.o have to be linked by hand into MyClass.so by:


% occ -mMyClass foo.o bar.o

For the reason of efficiency, the user can statically link the meta-level program with the OpenC++ compiler. To do this, the user must not specify the -m option:


% occ -- -o myocc -locc -lgc MyClass.mc

First, MyClass.mc should be compiled and linked to the OpenC++ compiler. The command shown above produces the OpenC++ compiler that MyClass.mc is embedded in. libocc.a is the archive of the original OpenC++ compiler. (Note: The Solaris users have to add the -ldl option after -locc.)

Then, the produced compiler myocc is used to compile the base-level program:


% myocc -- -o sample sample.cc

This compiles sample.cc and produces an executable file sample.

OPTIONS

-D: Define a macro name as def.
-E: Don't run the back-end C++ compiler. Stop after generating a .ii file.
-I: Add a directory to the search path of the #include directive.
-M: Specify an option with value. It is passed to metaobjects.
-P: Run the preprocessor again after translation (Unix only).
-S: Load metaclass at the beginning. It enables to load a metaclass and invoke Initialize() without the metaclass declaration. It is usedful to call ChangeDefaultMetaclass() on Class.
-V: Show the version number.
-c: Suppress linking and produce a .o file.
-d: Pass option to the preprocessor. For example, -d/MDd directs the compiler to pass /MDd to the preprocessor.
-l: Print the list of statically loaded metaclasses.
-m: Produce a shared library (a .so file.) This is used to compile a metaclass. If file_name is specified, the name of the shared library is file_name.so. If the -c option is specified together, occ produces a .so file, which should be linked by the user to be a shared library.
-n: Suppress invoking the preprocessor.
-p: Stop after the parsing stage. No translation is done.
-s: Print the whole parse tree of the given source program. Don't perform translation or compilation. If no source file is given, occ reads from the standard input.
-v: Specify the verbose mode.
--regular-c++: Inhibit the extended syntax. This enables the keyword metaclass to be used as a variable name. This option is useful when parsing legacy code being not intended to translation. When this option is used, the symbol __opencxx is not defined.
--: The following options are interpreted as options for the back-end C++ compiler. For example, if you type; % occ -I.. -- -g foo.c; Then the -g option is passed to the C++ compiler. Note that these options are not passed to the C++ preprocessor. The -D and -I options need to be placed before --.

FILES

file.{cc,C,c,cpp,cxx,mc}: source file.
file.occ: output file after C++ preprocessing.
file.ii: output file after translation.
file.o: object file.
file.so: shared library dynamically loaded by occ.
$libdir/libocc.a: library to link with meta-level program. $libdir depends on the arguments given to the configure script when building, the default being /usr/local/lib.

NOTES

While the C++ processor is running, the macro __opencxx is predefined.
The programs compiled by occ do not need any runtime libraries or a garbage collector unless the meta-level program requires them at the base level.

COPYRIGHT

AUTHOR

Shigeru Chiba, University of Tsukuba, Japan.

Email: chiba@is.tsukuba.ac.jp

[First | Prev]