Release notes for Xalan-C++ version 1.7

- Status
- Rebuilding Xalan-C++ and the sample applications
- Getting in touch
- History of software changes

| Status |

- Changes for Xalan-C++ version 1.7
- Bug reporting
- Version of Xerces-C++ to use
- To-do tasks for future Xalan-C++ releases

| Changes for Xalan-C++ version 1.7 |

Major updates since version 1.6 include:

- XalanC bugs fixed for this release.
- Message Localization Support. This feature enables Xalan-C++ to issue diagnostic messages in languages other than the default language (English). In order to utilize this feature, the user must provide a version of the Xalan-C++ message catalog that has been translated in their language of choice. For more information on how to exploit this feature, please see Steps for doing a Build with Message Localization Support.
- Build, packaging, and installation improvements. Changes to the Xalan-C++ makefiles now allow for a more flexible build, packaging, and install process. Each step in a typical build process can be invoked by specifying the appropriate target, for example to build the executable, and/or samples, or install the build at user-specified location. For more information on building Xalan-C++, please see Steps for doing a Unix build .
- Deprecated DOM Support. The XercesBridge classes have been marked deprecated and moved into an exclusive directory within the xalanc/XercesParserLiaison directory called 'Deprecated'. If your application is dependent on these classes to interface with the deprecated Xerces DOM you must alter your include directive with the 'Deprecated' directory. For example:
  `#include "xalanc/XercesParserLiaison/XercesDocumentBridge.hpp"`
  should be changed to:
  `#include "xalanc/XercesParserLiaison/Deprecated/XercesDocumentBridge.hpp"`
- Upgrade from Xerces-C 2.3 to Xerces-C 2.4.
- Porting of ThreadSafe example to UNIX platform.
- Implementation of EXSLT string extension functions encode-uri() and decode-uri().
- Implementation of EXSLT dynamic extension function evaluate().
- Implementation of EXSLT date-time extension function date-time().

| Bug reporting |

All known Xalan-C++ bugs are listed in Bugzilla (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.

| Before you can enter your first bug report, you must submit your email address to Bugzilla 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.

| Version of Xerces-C++ to use |

Xalan-C++ version 1.7 has been tested with Xerces-C++ version 2.4.0.

| The Xalan-C++ version 1.7 download no longer includes the Xerces-C++ distribution for the specified platform. You should either download the matching Xerces-C++ distribution for your platform, or rebuild both Xerces-C++ and Xalan-C++ on your system.

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.

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

- Pluggable Memory Management
- Add EXSLT functionality
- Support for XSLT 2.0 and XPath 2.0
- Add support for extension elements
- Fix any conformance bugs we or our users find

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

| Rebuilding Xalan-C++ |

- Rebuilding Xalan-C++
- Rebuilding sample applications

| Rebuilding Xalan-C++ |

- What you need from the distributions
- Steps for doing a Windows build
- Steps for doing a UNIX build
- Steps for doing a Build with Message Localization Support

| 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.

The Xalan-C++ source tree is in the src subdirectory of the Xalan-C++ binary distributions. The Xerces-C++ header files are in the include/xercesc tree of the corresponding Xerces-C++ binary distributions. The Windows Xerces .lib file is in the lib directory of the Xerces-C++ Windows binary distribution.

| You can also download Xalan-C++ source distributions from Xalan-C downloads: Xalan-C_1_7_0-src.zip and Xalan-C_1_7_0-src.tar.gz. Xerces-C++ source distributions are available from Xerces-C downloads: xerces-c2_4_0-src.zip and xerces-c2_4_0-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.7 is compatible with Xerces-C++ version 2.4.0.

For information on using the International Components for Unicode (ICU), see Using the ICU. Xalan-C++ version 1.7 has been tested with International Components for Unicode(ICU) 2.6.1 source files. You may be able to use newer ICU releases as they appear.

| 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 3 for Visual C++ and Visual Studio. You should also apply the bug fixes for the C++ standard library that shipped with Visual C++ 6.0. These fixes are available from the Dinkumware site: http://www.dinkumware.com/vc_fixes.html.

If you do not want to apply the Dinkumware patches, or 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. If you want to enable ICU support, install the ICU so the ICU root directory is at the same level as the xml-xerces directory (see Using the ICU). If you choose to build Xalan with ICU, you will need to rebuild the Xerces binary with ICU as well.
2. Use Visual C++ to open the Xalan workspace from the xml-xalan\c\Projects\Win32\VC6. If you are building with ICU, then use XalanICU.dsw. Otherwise, open the Xalan.dsw workspace.
3. From Visual C++, go to "Tools" and select "Options". 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.
4. Use Visual C++ to build the Xalan library and executables of interest.

| 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)

| Steps for doing a UNIX build |

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 xml-xalan/c in the Xalan-C++ distribution. 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, irix, tru64, macosx.
   c | C compiler name. Example: gcc, cc, c89, xlc, etc.
   x | C++ compiler name. Example: g++, xlC, 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 -x xlC`
   AIX (64-bit): `./runConfigure -p aix -c xlc -x xlC -b 64`
   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`
   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 -x xlC -P $HOME/my_xalan`

   | 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.

| 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`

| 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:

- Building static messages in the form of a library (DLL or shared object) which can be bound to the Xalan executable. This method is referred to as "in memory". By default, Xalan-C++ is built using "in memory" method.
- Building messages in the form of a library using localization support provided by the International Components for Unicode (ICU).
- Building messages in the form of a message catalog. This method utilizes the localization support provided by the Unix National Language Support (NLS) system. This method is supported for UNIX platforms only.

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.7 beta 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. Open the Xalan.dsw workspace using Microsoft Visual C++. The "inmem" localization method should be configured by default.
2. Select the Localization project, and go to Settings and click on the "General" tab.Verify the build command line to use "nmake /f Localization.mak TYPE=inmem LOCAL=en_US"
3. Add the Xerces-C bin directory to the PATH
4. Add the Xerces-C lib directory to the library directory list
5. Add the Xerces-C include directory to the include directory list.
6. Run "Build all" with the configuration of your choice.

For building on the Windows platform with ICU method:

1. Open the XalanICU.dsw workspace using Microsoft Visual C++.
2. Select the AllInOneWithICU project, and ensure that the project depends on the LocalizationWithICU project.
3. Select the LocalizationWithICU project, and go to Settings and click on the "General" tab. Modify the build command line to use "nmake /f Localization.mak TYPE=icu LOCAL=en_US"
4. Add the Xerces-C bin directory and ICU bin directory to the PATH
5. Add the Xerces-C lib directory and ICU lib directory to the library directory list
6. Add the Xerces-C include directory and ICU include directory to the include directory list
7. Open the tools.ini file under Projects\Win32\VC6\Utils\Localization and add the ICU root directory to the ICUROOT variable setting. Another option is to define ICUROOT as an environmental variable.
8. 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 -x xlC -m nls`
   AIX (64-bit): .`/runConfigure -p aix -c xlc -x xlC -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 -x xlC -m icu -M fr_Fr`
   AIX (64-bit): `./runConfigure -p aix -c xlc -x xlC -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: | libxalanMsg17.so (for UNIX) XalanMessages_1_7_0.dll and XalanMessages_1_7_0.lib (for Windows)
NLS method: | xalanMsg1_7.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.

- For an "in memory" or "icu" build, the location of the Xalan-C++ and Xerces-C++ executables need to be added to the PATH variable. The location of the message library will need to be added to:
  - the LIBPATH variable for AIX users
  - the LD_LIBRARY_PATH variable for RedHat, SuSE, and Solaris users
  - the SHLIB_PATH variable for HP-UX users.
- For an NLS build, the message catalog will need to be added to the NLSPATH.

| Rebuilding a Sample application |

In the Windows32 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`.

| For information on building Apache Module, see ApacheModuleXSLT

| 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.

| Cumulative history of software changes |

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

| Changes for Xalan-C++ version 1.6 |

Major updates since version 1.5 include:

- XalanC bugs fixed for this release.
- Directory "sane include" reorganization. A new sub-directory called 'xalanc' has been added to the src directory (for source distribution packages) and include directory (for binary distribution packages). New source files which include Xalan headers will need to be modified to include the 'xalanc' prefix in the header path. For example:
  `#include <XPath/XObject.hpp>`
  will need to be changed to
  `#include <xalanc/XPath/XObject.hpp>`
  For Windows users, all project files have been modified to reflect this change. For UNIX users, please see Steps for doing a UNIX build for migration considerations.

| Changes for Xalan-C++ version 1.5 |

Major updates since version 1.4 include:

- XalanC bugs fixed for this release.
- For Windows, Xalan-C++ is now packaged as a single DLL. The project files to build separate DLLs are now deprecated and will not be maintained.
- Support for Xerces-C++ DOMNode classes.
- New sample TransformToXercesDOM that illustrates how to perform a transform resulting in a Xerces-C++ DOMDocument
- Usage of the Xerces-C++ C++ namespace and creation of Xalan-C++ namespace.

| Changes for Xalan-C++ version 1.4 |

Major updates since version 1.3 include:

- The Xalan-C++ distributions no longer include the Xerces-C++ headers and libraries. Accordingly, you must download the appropriate Xerces-C++ distribution (see Downloading what you need.
- 64-bit build for HP-11; untested 64-bit support for Solaris and AIX.
- New Linux platform and compiler: Redhat 7.2 with gcc 3.1.
- STLport is no longer required on any of our supported platforms.
- Alpha support for a number of EXSLT functions.
- ParsedSourceWrappers, a sample that illustrates how to perform transformations with input in the form of a pre-built XalanDOM or XalanSourceTree.

| Changes for Xalan-C++ version 1.3 |

Major updates since version 1.2 include:

- A new and simplified command-line utility: the Xalan executable
- New XPath samples exploiting the XPathEvaluator C API and illustrating serialization of an XPath result set: SimpleXPathCAPI and SerializeNodeSet
- A new wrapper class that lets you pass in a Xerces DOM as input for a transformation
- Bug fixes.
- Changed XPathException to XalanXPathException because of a clash with a new Xerces class of the same name.

| Changes for Xalan-C++ version 1.2 |

Major updates since version 1.1 include:

- Introduction of a library of extension functions
- Support for pre-parsed source documents and pre-compiled stylesheets in XalanTransformer and the C API.
- Support for stylesheet params in XalanTransformer and the C API
- Support for extension functions in XalanTransformer
- Performance enhancements

| 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:

- Added HP-UX 11 build.
- Added Solaris build.
- Greatly improved performance.
- Improved conformance to the XSLT specification.
- Simplified the C++ API and provided a C API for performing standard transformations with the XalanTransformer class and associated header files.
- Added sample illustrating use of XalanTransformer and the new C++ API: XalanTransform.
- Added sample illustrating use of XalanTransformer, the new C API, and how to run Xalan-C++ and perform transformations on an Apache Web server: ApacheModuleXSLT.
- Added the StreamTransform sample.
- Eliminated dependencies on non-public Xerces headers; accordingly can now build with the Xerces distribution.
- Fixed namespace mapping and inheritance problems.
- Fixed failure of <copy-of ...> to include CRLFs (if any) in the result.
- Fixed bug sorting in reverse document order based on position.
- Fixed <xsl:number> bug with use of letter-value="traditional" for "classical" Greek numbering.
- Fixed use of <xsl:fallback> within a top-level extension function.
- Fixed HTML output method bug. The <HEAD> element was not including a <META> tag with the encoding.
- Fixed bug using key() in match patterns to find descendants.
- Fixed bug using the id() function in complex match patterns.
- Fixed problem outputting multiple single-character CDATA sections.
- Fixed problem outputting whitespace characters.
- Fixed problem transforming from a stream on UNIX platforms.
- Fixed a bug with the document() function, which was generating a syntax error if called in the following manner: document(string,/).
- Fixed named templates bug accepting global parameter when called with a parameter of the same name that the named template does not recognize.

| Changes for Xalan-C++ version 1.0 |

Major updates since version 0.40.0 include:

- Full support for namespace handling
- Full implementation of the format-number() function and support for the decimal-format element
- Integration with the International Components for Unicode (ICU) for number formatting, sorting, and output encoding
- Support for the exclude-result-prefixes attribute
- Support for the output encoding attribute

| Changes for Xalan-C++ version 0.40.0 |

Major updates since version 0.30.0 include:

- Permitting OS file names (as well as URLs) as command-line arguments with TestXSLT
- Stricter compliance for HTML and XML output
- Improved handling of relative URI's
- Improved handling of Import and Include
- Better namespace handling (although there are still problems here)
- Support for Document() function
- Support for XPath predicates
- Better handling of parameters to stylesheet and templates
- Full implementation of axes ( with the exception of namespace:: )

Copyright © 1999-2004 The Apache Software Foundation. All Rights Reserved.