How_to_Build_X3P_Library

This page should guide programmers through the building and installation process. Thank you for helping to complete this page!

• Preconditions
• Building
  • Building on Windows
  • Building on Mac OS X
  • Building on Unix

Preconditions

The following preconditions have to be met to build the software:

• Download or check out the software
• Download and install the xsd-tool and runtime library by CodeSynthesys
• …

Building

The build process does build the library and the demo program. The products go to the /trunk/Build/ directory in debug mode and to the /install/ directory in release mode.

Building on Windows

1. Open the solution with Microsoft Visual Studio

   /src/openGPS.sln

2. Choose the appropriate configuration. The following configurations are available:

   1. Release: Build release version of linkable object library for X3P and executable of demo program.
   2. Release-Shared: Build release version of DLL for X3P and executable of demo program.
   3. Debug: Build debug version of linkable object library for X3P and executable of demo program.
   4. Debug-Shared: Build debug version of DLL for X3P and executable of demo program.
3. Start build process.

There is not much to say about the build process except for the release build. To make a clean release build the version you are compiling must not contain local modifications nor mixed revisions. To check this have a look at /trunk/src/ISO5436_2_XML/cxx/version.h. The symbols __OPENGPS_CLEAN_BUILD_ and __OPENGPS_CLEAN_REVISION_ must be defined as empty. Otherwise the contain a warning message.

// Warning message if project contains locally modified sources, empty otherwise
#define _OPENGPS_CLEAN_BUILD
// Warning message if it contains mixed revisions, empty otherwise
#define _OPENGPS_CLEAN_REVISION

You have to build the Release configuration first and the Release-Shared configuration second. When building the Release-Shared configuration, the tool IncRev.exe is used to automatically increment the build number in /trunk/src/ISO5436_2_XML/cxx/version.in. Since this changes your source tree, you will now have local modifications. The release manager of the project would then check in the modified Version.in to save the incremented build number.

Building on Mac OS X

Building on Unix

[Category:x3p] [Category:programmers_help]