Zorba

> The XQuery Processor

 

Build Instructions

Requirements

Build System

In order to build Zorba, you need the Cross-Platform Make CMake 2.4 or higher. You can download it from http://www.cmake.org/.

Compilers

Zorba is tested with the following compilers:

• GNU Compiler: GCC 3.4.x (32bit & 64bit) and GCC 4.x.x
• Microsoft Compiler: MS VC++ 2005 and MS VC++ 2008

Packages

In order ot build Zorba, you need the following libraries and development headers to be installed:

• Libxml2 2.2.16 or higher (http://xmlsoft.org/ )
  • Iconv 1.12 (used by Libxml2; http://www.gnu.org/software/libiconv/)
• ICU 2.6 or higher (http://www.icu-project.org/)
• Boost 1.32 or higher (http://www.boost.org/)
  • boost_program_options
  • boost_date_time
  • boost_filesystem
• Xerces-C 2.7.0 or higher (http://xerces.apache.org/xerces-c/)
• Optional Packages
  • CURL 7.12 (used to enable REST and HTTP; http://curl.haxx.se/)
• Optional Packages that are required if you want to build the scanner and parser
  • Flex 2.5.33 or higher (http://flex.sourceforge.net/)
  • Bison 2.3 or higher (http://www.gnu.org/software/bison/)

Building Zorba

1. Install the Zorba source distribution (see Installation). The directory in which the Zorba sources are installed is refered to as [ZORBA] in the following.
2. Change the working directory into [ZORBA].
3. The recommended way to build Zorba is by creating and out-of-source build. We suggest to create the directory [ZORBA]/build and refer to this directory as [ZORBABUILD] in the following.
4. Change the working directory into the [ZORBABUILD] directory and execute cmake as follows: cmake [ZORBA]. In case the [ZORBABUILD] is located directly within the [ZORBA] directory just type cmake .. . This command should configure Zorba and prepare for the build. CMake will tell you if your installation is missing some of the required libraries or development headers.
5. If CMake was executed successfully, you should be able to run make. Running make will take some time. If make finished successfully, you're ready to install and run Zorba (see Installation).

Build Options

• CMake is a meta build system, meaning it is able to generate native makefiles (e.g. GNU Make or NMake) and workspaces (e.g. KDevelop or Visual Studio Projects). For example, you can create a KDevelop Project by executing the following command in the [ZORBA] directory: cmake -G KDevelop3 [ZORBABUILD].
• CMake supports multiple build configurations (e.g. Debug, Release, or MinSizeRel. By default, Zorba is build with the Release configuration. To change the build mode (to Debug, Release, RelWithDebInfo or MinSizeRel), you can pass an additional parameter to CMake, e.g. cmake -D CMAKE_BUILD_TYPE=Debug [ZORBA].

Note for Mac OS Users

The easiest way to install the required packages (like CMake, Boost, etc.) is to use Darwin Ports (http://darwinports.com/). After installating Darwin Ports, you should run sudo port -d selfupdate to upgrade the package lists. If this was successfull, you can simply install packages by typing e.g. sudo port install cmake.

Notes for Windows Users

• In order to compile Zorba on Windows, you need a working Visual Studio installation.
• Additionally, you need the following packages to be installed for your Visual Studio installation.
  1. CMake (http://www.cmake.org/)
  2. Boost (program_options, date_time, filesystem). We recommend to use the package provided by boost consulting (http://www.boost-consulting.com/products/free/).
  3. Libxml2 and Iconv (http://www.zlatkovic.com/pub/libxml/)
  4. ICU (http://download.icu-project.org/files/icu4c/)
• Note that the path to all of the installed libraries need to be included in the PATH environment variable.

   path_to_boost\bin;path_to_libxml2\bin;path_to_icu\bin;path_to_iconv\bin;path_to_xerces\bin 
  

Building Zorba using a NMake Project

1. Start a Visual Studio Command Line
2. Change the current working directory into the [ZORBA] directory.
3. The recommended way to build Zorba is by creating and out-of-source build. We suggest to create the directory [ZORBA]/build and refer to this directory as [ZORBABUILD] in the following.
4. Execute CMake as follows cmake -G "NMake Makefiles" [ZORBA]. Unfortunately, CMake does not find all the development headers and libraries itself. Hence, you need to tell CMake where they are located. This can be done by the following command:

   "cmake" 
   -G "NMake Makefiles"
   -D ICU_LIBRARY="path_to_icu\lib\icuuc.lib" 
   -D ICU_DATA_LIBRARY="path_to_icu\lib\icudt.lib" 
   -D ICU_I18N_LIBRARY="path_to_icu\lib\icuin.lib" 
   -D ICU_INCLUDE="path_to_icu\include" 
   -D ICONV_INCLUDE_DIR="path_to_iconv\include" 
   -D ICONV_LIBRARY="path_to_iconv\lib\iconv.lib" 
   -D LIBXML2_INCLUDE_DIR="path_to_libxml2\include" 
   -D LIBXML2_LIBRARIES="path_to_libxml2\lib\libxml2.lib" 
   -D BOOST_ROOT="path_to_boost" 
   -D XERCESC_INCLUDE="path_to_xerces\include" 
   -D XERCESC_LIBRARY="path_to_xerces\lib\xerces-c_2.lib"
   ..\
   

5. Compile Zorba by calling nmake from the [ZORBABUILD] directory.

Building Visual Studio Project

1. Start Visual Studio Command Line
2. Change the current working directory into the [ZORBA] directory.
3. Execute CMake as described above but with the -G "Visual Stuido X 200Y</tt> option instead of <tt>-G "NMake Makefiles".
4. Start Visual Studio, open the generated zorba.svl project file, and start compilation.

---