20.3 Invoking the Generator with an XML Schema

Given the command

<prompt> rwsfgen -projectname MyProject MySchema.xsd 

the generator creates a project titled MyProject based on the schema MySchema.xsd and places it into a directory MyProject.

Section 20.4.1 illustrates the architecture of the generated classes. Section 20.4.2 describes the generated output.

The generator creates a log file rwsfgen.log, located in the directory where the generator was invoked, listing all generated files. If you run the command again, HydraExpress regenerates only those files that need to be updated due to changes in the schema or generation options.

---

You should never add business logic or make any other changes to the generated source code as these changes will be lost the next time the code is generated.

---

HydraExpress creates several subdirectories containing the generated files, as well as a project file reflecting the various options used when generating the project. For more detail on the project file and the code generation directory, see Chapter 21, "The Project File and Directory Structure."

This section includes a UML diagram of the interfaces and sample applications generated by the schema compiler. (Additional internal and support files not included in the diagram are also generated, but these are for internal use only.)

Figure 12: Architecture of the Datatype Generated Classes

The generator creates a C++ class for each complex type defined in the schema. Each of these classes is based on the handle/body idiom, as illustrated in Figure 12, and each one is derived from the library classes rwsf::XmlBindingHandle and rwsf::XmlBindingBody respectively.

These complex type classes are represented by the handle/body pair <complexType> and <complexType>Imp in the figure above. If the schema defines any top-level elements that are of type <complexType>, an XML binding for that element is created deriving from type <complexType>, shown by the handle/body pair <element name> and <element name>Imp.

The class <schema name>_types_main.cpp is a generated sample application to use the datatype classes. It contains a main() method with sample unmarshaling code.

The two supporting classes, <complextype>Marshal.cpp and <schema name>_typesConverter.cpp, provide marshaling and string conversion functionality, respectively.

For more information on the generated XML bindings, see , "XML Binding Concepts," in the HydraExpress XML Binding Development Guide.

Table 9 shows the output files HydraExpress would produce for the command line

<prompt> rwsfgen -projectname MyProject MySchema.xsd

where MyProject is the name of the project and subsequent HydraExpress project file, MyProject is also the code generation directory into which HydraExpress places the generated code, and MySchema.xsd is the schema to compile.

The list below assumes that the schema file contains the complex type definitions TypeA and TypeB, in addition to the element definition, ElementA.

---

Files that are overwrite-protected will be generated with a ".sample" extension if a file exists in the output directory of the same name. See Section 20.7

---

Table 9: Generated files for an XML Schema 

MyProject/

MyProject.xml

makefile
makefile_debug

makefile.include

MyProject.sln

deployRelease.bat
deployDebug.bat

    app/

makefile
makefile_debug

        /data

makefile
makefile_debug

<MySchema>_main.cpp or
<MySchema>_main.cpp.sample

<MySchema>_main.vcproj

    bin

    codegen/

makefile
makefile_debug

        /data/

makefile
makefile_debug

[<MySchema>Statics.cpp]

<MySchema>Library.vcproj

            /<namespace>

TypeA.cpp  
TypeB.cpp
ElementA.cpp

TypeAMarshal.cpp
TypeBMarshal.cpp
ElementAMarshal.cpp

        /etc/

<MySchema>-manifest.xml

    docs/

index.html  

    include/

      /<MyProject>

TypeAConverter.h
TypeBConverter.h
ElementAConverter.h

[<MySchema>Statics.h]

         /<namespace>

TypeA.h 
TypeB.h
ElementA.h
ElementAMarshal.h 

    lib

To view the HTML API documentation, open the index.html file, using the browser of your choice. For documentation about the non-generated classes on which these generated classes may depend, see the HydraExpress C++ API Reference Guide.

HydraExpress generates an implemented sample application named MySchema_main.cpp.sample. This file is a simple template from which you can create an application that uses the generated XML binding.

To help you build the C++ generated libraries and sample applications, HydraExpress also generates the following versions of makefiles:

• a debug version: makefile_debug

• a non-debug version: makefile

A project-level makefile is generated in the code generation directory. This makefile builds the entire project. Makefiles are also generated in the each subdirectory in the event that you wish to build individual directories. For more information on using the generated makefiles, or creating your own, see Chapter 22, "Options for Compiling."

For Windows users with Microsoft Visual C++, HydraExpress also generates project and solutions files for MSVC 7 or 8. The files generated depend on the platform you selected when you installed HydraExpress. You can change the default behavior by specifying the
-projectversion flag when you generate the project, as described in Table 11.

Large schemas can result in quite long generation times, and may also cause heap overflow in Java. To avoid these problems:

• Adjust your settings for the environment variable RW_JAVAOPT, which sends the specified options to Java at each invocation of the code generator By default, the generator sets RW_JAVAOPT to -Xmx512M, which sets the heap size to 512 MB. This heap size is sufficient for most large schemas, although some very large schemas may require an even higher value.

• Invoke rwsfgen with the -nohtml option. While the generated documentation is useful for understanding the generated code, its generation adds significantly to the total generation time for complex schemas.

© Copyright Rogue Wave Software, Inc. All Rights Reserved. All Rights Reserved. Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. HydraExpress is a trademark of Rogue Wave Software, Inc. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.