alma.tools.idlgen

Class XmlIdlCompiler

java.lang.Object

alma.tools.idlgen.XmlIdlCompiler

public class XmlIdlCompiler
extends java.lang.Object

TODO: Update for JacORB!! Main class of the ACS IDL compiler that produces interfaces, structs, and holders for use with XML binding classes. The generated code will be similar but different from the output of a regular CORBA IDL compiler. IDL interfaces, structs, etc. that contain a field or parameter of type XmlEntityStruct will be compiled into source code that contains a corresponding XML binding class.

In collaboration with the other classes from this package, this class performs the following steps for each IDL file specified:

1. parses the IDL file (using an org.openorb.compiler.parser.IdlParser). The intermediate result is a tree of org.openorb.compiler.object.IdlObject nodes.
2. identifies IDL typedefs for the type XmlEntityStruct, e.g. the definition of the type SchedBlock. (see IdlTreeManipulator#findXmlTypedefNodes)
3. marks the nodes in the parse tree that are affected by the XML entity types (using IdlTreeManipulator#findXmlEntityNodes). This ensures that later we don't generate code that would be functionally identical to the code generated by a standard IDL compiler.
   Note that the identification of parse tree nodes works upward-recursive: for example, if an IDL struct contains another struct which has a member of type SchedBlock, then both IDL structs will get marked.
4. translates the relevant nodes of the manipulated IDL parse tree into Java code (using JavaGenerator#translateData).
   Note that the logic of mapping IDL to Java and the code generation itself are not separated.
5. optionally runs the code generator for component helper class templates, see ComponentHelperGeneratorProxy and CompHelperGenerator.
   Information about (component) interfaces and Java packages is transmitted as an XML string that conforms to the schema HelperInfo in the package alma.acs.tools.comphelpergen.

Parameters and properties:

• Takes all command line arguments that are valid for org.openorb.compiler.IdlCompiler, although some of them don't apply and will be ignored.
  Interesting for tracing is -verbose.
• The property ACS.idl2jbind specifies the mappings from typedef'd XmlEntityStructs to Java binding classes.
  For example, the value "SchedBlock=alma.xmljbind.test.schedblock.SchedBlock; ObsProject=alma.xmljbind.test.obsproject.ObsProject" instructs the compiler to use the Java class alma.xmljbind.test.schedblock.SchedBlock whereever an XmlEntityStruct typedef'd to SchedBlock is found.
• Two properties control the optional invocation of the code generator for component helper classes:
  • alma.acs.tools.comphelpergen.doGenerate: if true, the ACS IDL compiler will run the generator after compiling an IDL file. See ComponentHelperGeneratorProxy.
  • alma.acs.tools.comphelpergen.outRootDir specifies the directory under which the component helper classes will be generated according to their Java packages.

In order to keep things simple, the implementation uses the OpenORB IDL compiler (org.openorb.compiler.IdlCompiler and related classes) whereever this is possible. No OpenORB code is modified; this goal results in some less intuitive handling of parse tree nodes, since new behavior could not be attached to the existing classes. On the other hand, we won't have to insert our patches into any new version of OpenORB that we might want to use in the future.

A half-inspired attempt has been made to pave the road for code generation for languages other than Java. The tree manipulations could also be used by other code generators. For Java we reused OpenORB's implementation of the IDL2Java mapping logic (see JavaGenerator), but similar generators for other languages would be much more complex.

Remark on the proprietary code generation strategy used: Since OpenORB does not separate IDL2Java mapping logic from Java code generation, we can't use any standard code generation framework without reimplementing the IDL2Java logic ourselves. The choice was to accept being different from other ACS code generators, with the advantage of not writing lots of new code.

Author:

hsommer

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROP_COMP_HELPERS_OUTDIR
static java.lang.String	PROP_DO_GENERATE_COMP_HELPERS

Constructor Summary

Constructors

Constructor and Description
XmlIdlCompiler() Constructor for XmlIdlCompiler.

Method Summary

Modifier and Type	Method and Description
static java.io.File	createFile(java.lang.String jpackage, java.lang.String className) Utility method that creates a File object for code generation.
void	generateCode(JacorbVisitor jacorbVisitor) This operation is used to generate code for an IDL file that has been parsed already.
static void	main(java.lang.String[] args) The main method gets called from ACS/LGPL/Kit/acs/include/acsMakefileCore.mk with the following JVM properties and application arguments: -d <outputDir> with the root of the directory tree for the generated output.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROP_DO_GENERATE_COMP_HELPERS

public static final java.lang.String PROP_DO_GENERATE_COMP_HELPERS

See Also:

Constant Field Values

PROP_COMP_HELPERS_OUTDIR

public static final java.lang.String PROP_COMP_HELPERS_OUTDIR

See Also:

Constant Field Values

Constructor Detail

XmlIdlCompiler

public XmlIdlCompiler()

Constructor for XmlIdlCompiler.

Method Detail

generateCode

public void generateCode(JacorbVisitor jacorbVisitor)
                  throws java.lang.Exception

This operation is used to generate code for an IDL file that has been parsed already.

Throws:

java.lang.Exception

createFile

public static java.io.File createFile(java.lang.String jpackage,
                                      java.lang.String className)
                               throws java.io.IOException

Utility method that creates a File object for code generation.

Throws:

java.io.IOException

main

public static void main(java.lang.String[] args)

The main method gets called from ACS/LGPL/Kit/acs/include/acsMakefileCore.mk with the following JVM properties and application arguments:

• -d <outputDir> with the root of the directory tree for the generated output.
• JVM property ACS.idl2jbind that contains the ';'-separated bindings of XmlEntityStruct typedefs to XML java binding classes as obtained from the Makefile directive XML_IDL;
  Example value: "ObsProposal=alma.xmljbind.test.obsproposal.ObsProposal; SchedBlock=alma.xmljbind.test.schedblock.SchedBlock"
• Optional JVM properties alma.acs.tools.comphelpergen.doGenerate and alma.acs.tools.comphelpergen.outRootDir
• The command line also contains $(verboseDef) but it seems to be always empty.

It runs the JacORB IDL parser with the custom ACS plugin and generates code for the nodes involved in XML translation.

Parameters:

externalArgs - -d <outdir> -I<myIdlIncludePath1> -I<myIdlIncludePath2> <myIdlFile>