next up previous contents
Next: Option file Up: General Topics Previous: A first example

   
Running OPTIMIX from shell


\begin{examplefoot}shell>> optimix [options] filenames
shell>> optimix - [options] < filename
shell>> optimix -typedefs [options] filenames
\end{examplefoot}

can be run as standalone command (line 1), or as a filter in a pipe (line 2). Thus a previous run of cpp can be used to resolve any conditional #ifdef-commands in a specification.

C mode only:If the special option -typedefs is set, only pointer type definitions for the used C types are produced (line 3).end C mode.

If the user specifies several input files, the generated files are prefixed by the file name prefix of the first file. For instance,


\begin{examplefoot}optimix optimizer.ox optimizer2.ox
\end{examplefoot}

will create two files optimizer.c and optimizer.h1.2 which contain the generated code and its interface. Also the option -o <file> overrides the name of the output file to <file>.

File-suffixes need not be specified. Then looks for the file in the current directory, trying the following suffixes in order: .ox., .cg, .ast, .jox.

Java mode only:In Java mode, files have to have the suffix .jox. These files consist of ordinary Java classes which contain methods in -style.end Java mode.

can be parametrized in different ways. There are options, which are set in the specification file, and command line options. Command line options fall in directly recognized options (e.g. -typedefs) or option keywords after the generic prefix option -x (e.g. -x PrintSuperClasses) The latter ones refer to options which are not often used or development options. It is likely that in future version of option keywords become directly recognized options. The command line options of are:




  -- General Options: --
-help (-h) print this message and exit
-x name set option flag name
-x name= value set option keyword name to value
  -- Input Options: --
-ff name use name for fSDL flat form file; CoSy-fSDL mode is turned on
-ast name use name as AST/CG data specification file
-classpath|-cp classpath use classpath as array of directories where to look for Optimix and Java imports
+classpath|+cp classpath add classpath to the array of directories where to look for Optimix and Java imports
  -- Output Options: --
-o name use name for output files
-typedefs if AST data specifications are used, only print a file oxtypes.h
  with forward declarations for C types of flat sol functor applications.
-x InternalTypedefs if AST data specifications are used, print all forward declarations
  for C types of flat sol functor applications in the .h-file.
  Otherwise they are printed in the external file oxtypes.h
-comments value (currently has limited effect) emit generated code with comment
  level value. The larger value, the more comment is
  printed. 3 is current maximum.
-SimpleNestedLoopJoin use nested loop join code generation (default code generation mode)
-ETJoin use element-test-join code generation
-ETFilters use element-test path filters during code generation
-nobitsetopt do not generate bitset operations in code
-noindex do not use index optimization
-view name (CoSy-fSDL mode) use name as view name of the engine
-helpfuns (CoSy-fSDL mode) produce help functions together with other functions
-helpfun name (CoSy-fSDL mode) produce help functions in file name
  -- Verbosity: --
-v print version info, do nothing else
-VersionNumber print version number only, do nothing else
-v1 be a bit verbose (default)
-v2 be fully verbose
-silent be totally silent
-poem print a poem and exit
  -- Debug information: --
-x ShowSuperClasses print the super classes of all class or fSDL domains.
-x ShowClassAttributes print the classes and their attributes (only for AST classes)
-ShowOptions print all options which are set
-ShowBinding print bindings of types for variables during type inference
-ShowComparing print comparisons of types for variables during type inference
-ShowSignatures print signatures of all rules (types of rule test root nodes).
-ShowNodeTypes print all infered types of all variables.
-ShowRTG write all rule test graph in VCG format to files
-ShowRTGPaths print all paths of path coverings in rule test graphs.
-ShowTermination print the termination labels of each rule and stratum
-prio int print test outputs that have priority less than int
-diag name (obsolet) use diagnostic output file name
-ShowParseTree (
  -- General Options: --
-help (-h) print this message and exit
-x name set option flag name
-x name= value set option keyword name to value
  -- Input Options: --
-ff name use name for fSDL flat form file; CoSy-fSDL mode is turned on
-ast name use name as AST/CG data specification file
-classpath|-cp classpath use classpath as array of directories where to look for Optimix and Java imports
+classpath|+cp classpath add classpath to the array of directories where to look for Optimix and Java imports
  -- Output Options: --
-o name use name for output files
-typedefs if AST data specifications are used, only print a file oxtypes.h
  with forward declarations for C types of flat sol functor applications.
-x InternalTypedefs if AST data specifications are used, print all forward declarations
  for C types of flat sol functor applications in the .h-file.
  Otherwise they are printed in the external file oxtypes.h
-comments value (currently has limited effect) emit generated code with comment
  level value. The larger value, the more comment is
  printed. 3 is current maximum.
-SimpleNestedLoopJoin use nested loop join code generation (default code generation mode)
-ETJoin use element-test-join code generation
-ETFilters use element-test path filters during code generation
-nobitsetopt do not generate bitset operations in code
-noindex do not use index optimization
-view name (CoSy-fSDL mode) use name as view name of the engine
-helpfuns (CoSy-fSDL mode) produce help functions together with other functions
-helpfun name (CoSy-fSDL mode) produce help functions in file name
  -- Verbosity: --
-v print version info, do nothing else
-VersionNumber print version number only, do nothing else
-v1 be a bit verbose (default)
-v2 be fully verbose
-silent be totally silent
-poem print a poem and exit
  -- Debug information: --
-x ShowSuperClasses print the super classes of all class or fSDL domains.
-x ShowClassAttributes print the classes and their attributes (only for AST classes)
-ShowOptions print all options which are set
-ShowBinding print bindings of types for variables during type inference
-ShowComparing print comparisons of types for variables during type inference
-ShowSignatures print signatures of all rules (types of rule test root nodes).
-ShowNodeTypes print all infered types of all variables.
-ShowRTG write all rule test graph in VCG format to files
-ShowRTGPaths print all paths of path coverings in rule test graphs.
-ShowTermination print the termination labels of each rule and stratum
-prio int print test outputs that have priority less than int
-diag name (obsolet) use diagnostic output file name
-ShowParseTree (obsolet) write internal data structures of ox in ASCII format
-parser run only the parser

|l|l| & -- General Options: --
-help (-h) & print this message and exit
-x name & set option flag name
-x name=value & set option keyword name to value
& -- Input Options: --
-ff name & use name for fSDL flat form file; CoSy-fSDL mode is turned on
-ast name & use name as AST/CG data specification file
-classpath|-cp classpath & use classpath as array of directories where to look for Optimix and Java imports
+classpath|+cp classpath & add classpath to the array of directories where to look for Optimix and Java imports
& -- Output Options: --
-o name & use name for output files
-typedefs & if AST data specifications are used, only print a file oxtypes.h
& with forward declarations for C types of flat sol functor applications.
-x InternalTypedefs & if AST data specifications are used, print all forward declarations
& for C types of flat sol functor applications in the .h-file.
& Otherwise they are printed in the external file oxtypes.h
-comments value & (currently has limited effect) emit generated code with comment
& level value. The larger value, the more comment is
& printed. 3 is current maximum.
-SimpleNestedLoopJoin & use nested loop join code generation (default code generation mode)
-ETJoin & use element-test-join code generation
-ETFilters & use element-test path filters during code generation
-nobitsetopt & do not generate bitset operations in code
-noindex & do not use index optimization
-view name & (CoSy-fSDL mode) use name as view name of the engine
-helpfuns & (CoSy-fSDL mode) produce help functions together with other functions
-helpfun name & (CoSy-fSDL mode) produce help functions in file name
& -- Verbosity: --
-v & print version info, do nothing else
-VersionNumber & print version number only, do nothing else
-v1 & be a bit verbose (default)
-v2 & be fully verbose
-silent & be totally silent
-poem & print a poem and exit
& -- Debug information: --
-x ShowSuperClasses & print the super classes of all class or fSDL domains.
-x ShowClassAttributes & print the classes and their attributes (only for AST classes)
-ShowOptions & print all options which are set
-ShowBinding & print bindings of types for variables during type inference
-ShowComparing & print comparisons of types for variables during type inference
-ShowSignatures & print signatures of all rules (types of rule test root nodes).
-ShowNodeTypes & print all infered types of all variables.
-ShowRTG & write all rule test graph in VCG format to files
-ShowRTGPaths & print all paths of path coverings in rule test graphs.
-ShowTermination & print the termination labels of each rule and stratum
-prio int & print test outputs that have priority less than int
-diag name & (obsolet) use diagnostic output file name
-ShowParseTree & (
  -- General Options: --
-help (-h) print this message and exit
-x name set option flag name
-x name= value set option keyword name to value
  -- Input Options: --
-ff name use name for fSDL flat form file; CoSy-fSDL mode is turned on
-ast name use name as AST/CG data specification file
-classpath|-cp classpath use classpath as array of directories where to look for Optimix and Java imports
+classpath|+cp classpath add classpath to the array of directories where to look for Optimix and Java imports
  -- Output Options: --
-o name use name for output files
-typedefs if AST data specifications are used, only print a file oxtypes.h
  with forward declarations for C types of flat sol functor applications.
-x InternalTypedefs if AST data specifications are used, print all forward declarations
  for C types of flat sol functor applications in the .h-file.
  Otherwise they are printed in the external file oxtypes.h
-comments value (currently has limited effect) emit generated code with comment
  level value. The larger value, the more comment is
  printed. 3 is current maximum.
-SimpleNestedLoopJoin use nested loop join code generation (default code generation mode)
-ETJoin use element-test-join code generation
-ETFilters use element-test path filters during code generation
-nobitsetopt do not generate bitset operations in code
-noindex do not use index optimization
-view name (CoSy-fSDL mode) use name as view name of the engine
-helpfuns (CoSy-fSDL mode) produce help functions together with other functions
-helpfun name (CoSy-fSDL mode) produce help functions in file name
  -- Verbosity: --
-v print version info, do nothing else
-VersionNumber print version number only, do nothing else
-v1 be a bit verbose (default)
-v2 be fully verbose
-silent be totally silent
-poem print a poem and exit
  -- Debug information: --
-x ShowSuperClasses print the super classes of all class or fSDL domains.
-x ShowClassAttributes print the classes and their attributes (only for AST classes)
-ShowOptions print all options which are set
-ShowBinding print bindings of types for variables during type inference
-ShowComparing print comparisons of types for variables during type inference
-ShowSignatures print signatures of all rules (types of rule test root nodes).
-ShowNodeTypes print all infered types of all variables.
-ShowRTG write all rule test graph in VCG format to files
-ShowRTGPaths print all paths of path coverings in rule test graphs.
-ShowTermination print the termination labels of each rule and stratum
-prio int print test outputs that have priority less than int
-diag name (obsolet) use diagnostic output file name
-ShowParseTree (obsolet) write internal data structures of ox in ASCII format
-parser run only the parser


next up previous contents
Next: Option file Up: General Topics Previous: A first example
Uwe Assmann
1998-12-22