Trademark Logo Xalan-C/C++ Version 1.11
Xalan-C++ Release Notes
Apache Foundation Xalan Project Xerces Project Web Consortium Oasis Open

Xalan-C++ Release Notes

Release notes for Xalan-C++ Version 1.11

(top)

Status

(top)

Changes for Xalan-C++ version 1.8

Major updates since version 1.7 include:

(top)

Bug reporting

All known Xalan-C++ bugs are listed in JIRA (the Apache bug database). For a list of open bugs with links to each bug report, see XalanC open bugs. If you find a new bug, please enter a XalanC bug report in this database.

note Before you can enter your first bug report, you must submit your email address to Jira and receive a password.

We strongly encourage you write patches for problems you find and submit them to xalan-dev@xml.apache.org. We review the patches we receive to make sure they do not break something else, and (assuming they do not) include them in our next release. In the interest of fixing bugs, adding enhancements, and addressing outstanding design issues, we sincerely want (and need!) your active participation in the ongoing development of Xalan.

(top)

Version of Xerces-C++ to use

Xalan-C++ Version 1.11 has been tested with Xerces-C++ version 3.1.1.

For information about including the Xerces-C++ libraries on the path, see Setting up the system path.

Important: You may experience unpredictable anomalies if your Xalan and Xerces builds are not in synch. If you download an update to Xalan, check the release notes to determine which version of Xerces you should use.

If you compile both Xalan-C++ and Xerces-C++ from distribution sources using the same platform and compiler, you will avoid most of the compatibility issues.

(top)

To-do tasks for future Xalan-C++ releases

Watch the Xalan Development Mailing List for more information and for ideas about how you can get involved.

(top)

Rebuilding Xalan-C++

(top)

Rebuilding Xalan-C++

(top)

What you need from the distributions

To rebuild Xalan-C++, you need the Xalan-C++ source files, the Xerces-C++ header files, and for Windows the Xerces-C++ .lib file. If you want to rebuild with the ICU, you will need to download the ICU source package to build the ICU libraries.

note You can also download Xalan-C++ source distributions from Xalan-C downloads: Xalan-C_1_11_0-src.zip and Xalan-C_1_11_0-src.tar.gz. Xerces-C++ source distributions are available from Xerces-C downloads: xerces-c-3.1.1-src.zip and xerces-c-3.1.1-src.tar.gz.

Keep in mind that at any given point in time the Xalan-C++ and Xerces-C++ source trees in the Apache XML repository may not be consistent. When we release a version of Xalan-C++ we certify that it is compatible with a given version of Xerces-C++. To be safe, use the Xerces distributions that we certify as compatible. Reminder: Xalan-C++ Version 1.11 is compatible with Xerces-C++ version 3.1.1.

For information on using the International Components for Unicode (ICU), see Using the ICU. The recommended version of ICU for Xalan-C++ Version 1.11 is International Components for Unicode(ICU) version 3.2. You may be able to use newer ICU releases as they appear.

(top)

Steps for doing a Windows build

To build Xalan-C++ on Windows, you need Xerces-C++ and MS Visual C++ 6.0 installed with Service Pack 5 for Visual C++ and Visual Studio .NET.

If you are using a different Service Pack, you must rebuild all of the Xerces and Xalan binaries.

Before you do the following, be sure you have provided Visual C++ the paths to the Xerces headers and libraries.

  1. Create the ICUROOT environment variable and set it the the path of the ICU root.
  2. Create the XERCESCROOT environment variable and set it to the path of the root of Xerces-C++.
  3. Use Visual C++ to open the Xalan workspace (.dsw) from the xml-xalan\c\Projects\Win32\VC6. If you are building with ICU, then use XalanICU.dsw. Otherwise, open the Xalan.dsw workspace.

    note You may need to restart Visual Studio .NET in order for ICUROOT and XERCESCROOT to take effect.

    As an alternative method to the steps described above, would be to go to "Tools" and select "Options" from Visual C++. From the "Options" window, click on the "Directories" tab and do the following:
    1. Show Directories for: Executable files. Add the Xerces bin directory to the list.
    2. Show Directories for: Include files. Add the Xerces include directory to the list. If you are building with ICU, add the ICU include directory to the list as well.
    3. Show Directories for: Library files. Add the Xerces lib directory to the list. If you are building with ICU, add the ICU lib directory to the list as well.
note To recompile existing applications without changing your source code, be sure to modify your Project settings to pick up the Xalan headers in its new location. (see image below)

Visual C++ 6.0 Include Directories change

(top)

Steps for doing a Windows Build with Microsoft Visual Studio .NET

For users who want to build with Visual Studio .NET,

  1. Create the ICUROOT environment variable and set it the the path of the ICU root.
  2. Create the XERCESCROOT environment variable and set it to the path of the root of Xerces-C++.
  3. Use Visual Studio .NET to open the Xalan solution (.sln) from the xml-xalan\c\Projects\Win32\VC7. If you are building with ICU, then use XalanICU.sln. Otherwise, open the Xalan.sln solution file.

    note You may need to restart Visual Studio .NET in order for ICUROOT and XERCESCROOT to take effect.

    An alternative method to the steps described above, would be to go to "Tools" and select "Options" from Visual Studio .NET. From the "Options" window, click on the "Projects" folder to expand the list. Select "VC++ Directories" from the list and do the following:
    1. Show Directories for: Executable files. Add the Xerces bin directory to the list.
    2. Show Directories for: Include files. Add the Xerces include directory to the list. If you are building with ICU, add the ICU include directory to the list as well.
    3. Show Directories for: Library files. Add the Xerces lib directory to the list. If you are building with ICU, add the ICU lib directory to the list as well.
note To recompile existing applications without changing your source code, be sure to modify your Project settings to pick up the Xalan headers in its new location. (see image below)

Visual Studio .NET Include Directories change

(top)

Steps for doing a UNIX build

For users who want to build in the UNIX environment,

  1. The Xalan build files are written for GNU make, and will not work with other make utilities.

  2. Set the XERCESCROOT environment variable to the path to the root of Xerces-C++.

  3. Set the XALANCROOT environment variable to the path to the c directory in the root of the Xalan-C++ distribution. For example, if the distribution is located in "/home/mydir", you would set the XALANCROOT to "/home/mydir/xml-xalan/c".

  4. (Optional) If you are including the ICUBridge, install the ICU, use the shell to define XALAN_USE_ICU and to set the ICUROOT environment variable to the path to the ICU root. For more information, see (see Using the ICU). Note that building Xalan with ICU requires that Xerces must also be built with ICU.

  5. Change directory to XALANCROOT. You can also build Xalan-C outside of the source tree, but you will need to adjust the path to the runConfigure script in the next step.

  6. Run the runConfigure utility and provide the platform, C compiler, and C++ compiler flags as indicated below. The runConfigure utility is used to generate the appropriate Makefile for the desired build platform based on the options specified by the user. Valid options for the runConfigure utility are:

    ./runConfigure -p <value> -c <value> -x <value> [-[flag] <value>]

    flag Description
    p Build platform. Option must be provided by user. Valid values
    include: aix, linux, freebsd, netbsd, solaris, hp-10, hp-11, hp-11-ia64, irix,
    tru64, macosx, cygwin.
    c C compiler name. Example: gcc, cc, c89, xlc_r, etc.
    x C++ compiler name. Example: g++, xlC_r, CC, etc.
    d Indicates build is a debug build. Takes no values. Default is no
    debug.
    t Transcoder to use. Valid value is 'icu'. Default is null.
    m Type of localization support method. Valid values include: inmem,
    icu, and nls. Default is inmem.
    M Locale for Message Localization Support. Default is "en_US"
    r Threads option. Valid values include: pthread or dce. Default is
    dce
    b Specify whether it is a 32-bit or 64-bit build. Valid values are 32
    and 64. Default is 32-bit
    P Install root directory. Used if invoking build with gmake install or
    gmake install-package. Default install root directory is /usr/local
    l Extra link options other than the default. Default is null
    z Extra compiler options other than the default. Default is null
    C Extra configuration options.
    h To get help on the above commands. Default is no help.

    Linux using GCC:   ./runConfigure -p linux -c gcc -x c++
    Linux using the Intel compiler:   ./runConfigure -p linux -c icc -x icpc
    AIX (32-bit):     ./runConfigure -p aix -c xlc_r -x xlC_r

    AIX (64-bit):     ./runConfigure -p aix -c xlc_r -x xlC_r -b 64

    Cygwin (32-bit):   ./runConfigure -p cygwin -c gcc -x g++

    HP-UX 11 (32-bit):   ./runConfigure -p hp-11 -c cc -x aCC

    HP-UX 11 (64-bit):   ./runConfigure -p hp-11 -c cc -x aCC -b 64

    HP-UX 11 for Itanium (32-bit):   ./runConfigure -p hp-11-ia64 -c cc -x aCC

    HP-UX 11 for Itanium (64-bit):   ./runConfigure -p hp-11-ia64 -c cc -x aCC -b 64

    Solaris (32-bit):   ./runConfigure -p solaris -c cc -x CC

    Solaris (64-bit):   ./runConfigure -p solaris -c cc -x CC -b 64

    If you choose to install the distribution after building the libraries and executables, then you will need to indicate where you would like the distribution to be installed. To specify the install directory for your distribution, specify the flag -P <install directory>. For example, building and installing on the AIX platform:

    ./runConfigure -p aix -c xlc_r -x xlC_r -P $HOME/my_xalan

    note The standard binary directories bin, lib, and include are created in the specified directory only if the install or install-package option is specified in the build process.

    To see the other runConfigure flags you may include, use the help flag:

         ./runConfigure -h

  7. Purge the previous build:

         make clean

  8. Run the new build:

         make
    or
         make targ

    where targ can be one of:
    targ Description
    all Build the libraries and Xalan executable. This is the default target
    if no targ is specified.
    clean Deletes existing binaries, executables, libraries, tests, and
    samples.
    install Build the library, executables and copy them (along with
    the header files) the specified install location.
    install-package Installs the library, executables, samples to the
    specified location.
    Samples Builds the samples.
    Tests Builds the tests.
note To recompile existing applications without changing your source code, be sure to modify the command line in your Makefile to pick up the Xalan headers from it's new location. e.g: if your xalan source location is in /home/xml-xalan/c,


       CC ... -I/home/xml-xalan/c/src -I/home/xml-xalan/c/src/xalanc mysrc.cpp

(top)

Steps for doing a Build with Message Localization Support

Message Localization Support is a new feature to allow users to build Xalan-C++ such that diagnostic messages are issued in the language of their choice. Message localization support comes in three flavours:

Regardless of which method you choose, a message file containing translated messages in the language of your choice must be provided. The standard message file provided in the Xalan-C++ version 1.8 source package is in XML Localization Interchange File Format (XLIFF) format and conforms to the XLIFF 1.1 standard (please see http://www.oasis-open.org/committees/xliff/documents/xliff-specification.htm for more information.) All message files must be written and conform with the XLIFF 1.1 standard.

Once an XLIFF message file has been created, the XLIFF file should be stored under xml-xalan/c/src/xalanc/NLS/<locale_name> directory (for example, the default XLIFF message file provided is XalanMsg_en_US.xlf). To build, you will need to follow the same steps as shown above for building in Unix or Windows but with a small change.

For building on Windows platform with "In Memory" method:

  1. Create the environment variable XERCESCROOT and set it to the path to the root of Xerces-C++.
  2. Create the environment variable ICUROOT and set it to the path to the ICU root.
  3. Open the Xalan.dsw workspace using Microsoft Visual C++. The "inmem" localization method should be configured by default.
  4. Select the Localization project, and go to Settings and click on the "General" tab.Verify the build command line to use "nmake /f BuildMessages.mak TYPE=inmem LOCAL=en_US"
  5. Run "Build all" with the configuration of your choice.

For building on the Windows platform with ICU method:

  1. Create the environment variable XERCESCROOT and set it to the path to the root of Xerces-C++.
  2. Create the environment variable ICUROOT and set it to the path to the ICU root.
  3. Open the XalanICU.dsw workspace using Microsoft Visual C++.
  4. Select the AllInOneWithICU project, and ensure that the project depends on the LocalizationWithICU project.
  5. Select the LocalizationWithICU project, and go to Settings and click on the "General" tab. Modify the build command line to use "nmake /f BuildMessages.mak TYPE=icu LOCAL=en_US"
  6. Open the tools.ini file under Projects\Win32\VC6\Utils\Localization and add the ICU root directory to the ICUROOT variable setting.
  7. Run "Build all" with the configuration of your choice.

For building on the Unix platform:

  1. Repeat steps 1 through 5 as outlined under "Steps for doing a UNIX Build"
  2. Run the runConfigure and provide the platform, C compiler, C++ compiler, the message locale system flavour you are intending to build, and the locale support.

    Example 1: to use the NLS method for localization support using the default locale en_US:

    AIX (32-bit):   ./runConfigure -p aix -c xlc_r -x xlC -m nls

    AIX (64-bit):   ./runConfigure -p aix -c xlc_r -x xlC_r -b 64 -m nls

    Example 2: to use the 'icu' method for localization support using the locale fr_FR:

    AIX (32-bit):   ./runConfigure -p aix -c xlc_r -x xlC_r -m icu -M fr_Fr

    AIX (64-bit):   ./runConfigure -p aix -c xlc_r -x xlC_r -b 64 -m icu -M fr_Fr

  3. Perform steps 7 and 8 as outlined under "Steps for doing a UNIX Build"

After Xalan-C++ and associated libraries have been successfully built, the message catalog will be stored in the directory xml-xalan/c/bin.

Localization Build Type File Name
ICU or "in memory" method: libxalanMsg18.so (for UNIX)
XalanMessages_1_8.dll and XalanMessages_1_8.lib (for Windows)
NLS method: xalanMsg1_8.cat can be found in $XALANCROOT/nls/<locale_name>/ directory

The location of the message library, Xalan-C++ and Xerces-C++ binaries need to be added to the PATH and library path variables. Depending on the Message Localization Support method you've chosen, the following steps will need to be performed such that Xalan-C++ will be able to utilize the message library.

(top)

Steps for doing a Build with Xerces Deprecated DOM Support

If you application is dependent on the XercesBridge classes to interface with the deprecated Xerces DOM, then the following steps must be taken.

For a Windows build using Microsoft Visual C++ version 6.0:

  1. Open the Xalan.dsw workspace
  2. Go to "Projects" and select "Settings". From the "Project Settings panel", highlight the AllInOne project.
  3. Click on the "C/C++" tab on the right hand side. From the "Category" pull down menu, scroll down to find "Preprocessor" and click to highlight this category.
  4. Under the "Preprocessor Definitions" box, add "XALAN_BUILD_DEPRECATED_DOM_BRIDGE" to the list of definitions.
  5. Rebuild Xalan-C++ as described under "Steps for doing a Windows Build"

For a UNIX build, the following parameter should be added to your runConfigure step: -z -DXALAN_BUILD_DEPRECATED_DOM_BRIDGE. for example,

    ./runConfigure -p aix -c xlc_r -x xlC_r -z -DXALAN_BUILD_DEPRECATED_DOM_BRIDGE

(top)

Rebuilding a Sample application

In the 32-bit Windows distribution, all of the sample applications can be built from the Xalan.dsw Visual C++ workspace.

The Makefile that come with the UNIX distributions include targets for rebuilding one or all of the sample applications . To rebuild one or more sample applications, go to the root directory of your source package or the samples directory of your binary package, and run

     gmake Target

where Target is Samples (all the samples), ApacheModuleXSLT, CompileStylesheet, DocumentBuilder, ExternalFunctions, ParsedSourceWrappers, SerializedNodeSet, SimpleTransform, SimpleXPathAPI, SimpleXPathCAPI, StreamTransform, ThreadSafe (Windows only), TraceListen, TransformToXercesDOM, UseStylesheetParam, XPathWrapper, XalanTransform, or XalanTransformerCallback.

note For information on building Apache Module, see ApacheModuleXSLT

(top)

Getting in Touch

Your feedback is more than welcome. Offers of help are even more so! Perhaps you would like to contribute to the ongoing development, testing, or documentation of Xalan-C++.

Please email your comments, questions, suggestions, bug reports, and offers to help to Xalan Development Mailing List.

(top)

Cumulative history of software changes

The following sections list the changes in each release since Xalan-C++ version 0.40.0.

(top)

Changes for Xalan-C++ version 1.11

This is a general bug fix release with added stability features. Many null pointer references have been fixed.

Major updates since version 1.10 include:

(top)

Changes for Xalan-C++ version 1.10

Major updates since version 1.9 include:

(top)

Changes for Xalan-C++ version 1.9

Major updates since version 1.8 include:

(top)

Changes for Xalan-C++ version 1.8

Major updates since version 1.7 include:

(top)

Changes for Xalan-C++ version 1.7

Major updates since version 1.6 include:

(top)

Changes for Xalan-C++ version 1.6

Major updates since version 1.5 include:

(top)

Changes for Xalan-C++ version 1.5

Major updates since version 1.4 include:

(top)

Changes for Xalan-C++ version 1.4

Major updates since version 1.3 include:

(top)

Changes for Xalan-C++ version 1.3

Major updates since version 1.2 include:

(top)

Changes for Xalan-C++ version 1.2

Major updates since version 1.1 include:

(top)

Changes for Xalan-C++ version 1.1

In addition to adding to the list of platforms on which Xalan-C++ builds, our focus for this release has been on bug fixes, performance enhancements, and providing a simplified C++ and C API for performing standard transformations. Major updates since version 1.0 include:

(top)

Changes for Xalan-C++ version 1.0

Major updates since version 0.40.0 include:

(top)

Changes for Xalan-C++ version 0.40.0

Major updates since version 0.30.0 include:

(top)