KDb/Build

Note

 

• This page is intended for power users and developers.
• This recipe was tested on Linux only.
• Follow this guide as an ordinary user. Do not login as root!
• Some distributions (*Buntu, Arch) are now making Qt5 the defaulft! That does not work. Do not try to use Qt5, use Qt4. Make sure packages like qt4-default are installed. You might have to also switch your default Qt setup with a tool like qtchooser.

Requirements

Required software components

• C++ compiler, e.g. gcc
• Qt 4.7.0 or newer (both libraries and development files/tools)
• SQLite 3.6.16 or newer (both the library and development files)

Optional components

• For PostgreSQL support:
  • libpq, postgresql server devel 7.3 or newer (both the access library and client/server development files), usual package names: libpq5, libpq-dev (ubuntu), postgresql{version}-devel (openSUSE), postgresql-server-dev-{version} (ubuntu). Ubuntu needs 3 packages (1 lib, 2 devel), openSUSE 2 packages (1 lib, 1 devel).

Note

PostgreSQL Server installation is not needed for building Predicate or software that uses Predicate. The server is needed only for running the actual database service. Any installation on separate (e.g. remote) machine can be reused.

• For MySQL support: libmysqlclient (both the access library and development files)

Note

MySQL Server installation is not needed for building Predicate or software that uses Predicate. The server is needed only for running the actual database service. Any installaton on separate (e.g. remote) machine can be reused.

• For Sybase and MSSQL support: libfreetds (both the access library and development files), usual package names: libfreetds (openSUSE), freetds-devel (openSUSE), libfreetds-common (Ubuntu), freetds-dev (Ubuntu)

• For Xbase files support: xbase (both the access library and development files), usual package names: xbase (openSUSE), xbase-devel (openSUSE), libxbase2.0-0 (Ubuntu), libxbase2.0-dev (Ubuntu)

Note

Sybase/MSSQL and xBase support is disabled for now --Jstaniek (talk) 14:14, 9 October 2014 (UTC)

Get the source code

Download Predicate source code as explained on the Download page. The root directory of the source code is referred as {predicate-source-dir}, and the root build directory is referred as {predicate-build-dir}.

Configuration

Variant 1: Configuration for global installation

If you want to have Predicate installed in the global PREFIX, type:

mkdir {predicate-build-dir}
cd {predicate-build-dir}
cmake {options} {predicate-source-dir}

This will configure installation of Predicate libraries into /usr/local/lib, its binaries into /usr/local/bin, etc.

To change that to /usr/lib, etc., change the cmake command to:

cmake -DCMAKE_INSTALL_PREFIX=/usr {options} {predicate-source-dir}

cmake options

{options} are extra cmake options that let you to:

• Set up debugging (CMAKE_BUILD_TYPE)
• Enable tests (BUILD_TESTING)
• Speed up linking on Linux (CMAKE_C_FLAGS, CMAKE_CXX_FLAGS)

Instead of using command line, you can also alter these options once you configure the build by invoking an interactive tool:

ccmake .

in {predicate-build-dir}, then to reconfigure press c key when you're done and then press q key.

Read about more cmake options here.

Note

TODO: explain BUILD_TEST_COVERAGE, PREDICATE_DEBUG_GUI, PREDICATE_EXPRESSION_DEBUG

Variant 2: Configuration for local installation

Here is recommendation of a directory structure:

$HOME/predicate/src

{predicate-source-dir}

$HOME/predicate/build

{predicate-build-dir}

$HOME/predicate/inst

directory that Predicate will be installed in

To avoid installing to global a location such as /usr, for whatever reason, for your convenience, config-for-local.sh script has been prepared with default configuration settings. You can find it in tools/ subdirectory of the source code. Use it as follows:

1. Make sure $PREDICATE_INSTALL_PREFIX environment variable is set to directory that is indended PREFIX for the local Predicate installation, e.g. $HOME/predicate/inst.

2. To have the Predicate installation work environment variables PATH, LD_LIBRARY_PATH, PKG_CONFIG_PATH, QT_PLUGIN_PATH should be set properly. Double check this:

_libdir=lib # or lib64 for 64-bit platforms
export PATH=$PREDICATE_INSTALL_PREFIX/bin:$PATH
export LD_LIBRARY_PATH=$PREDICATE_INSTALL_PREFIX/$_libdir:$LD_LIBRARY_PATH
export PKG_CONFIG_PATH=$PREDICATE_INSTALL_PREFIX/$_libdir/pkgconfig:$PKG_CONFIG_PATH
export QT_PLUGIN_PATH=$PREDICATE_INSTALL_PREFIX/$_libdir/plugins/predicate:$QT_PLUGIN_PATH

3. Then:

mkdir -p {predicate-build-dir}
cd {predicate-build-dir}

(better pick your {predicate-build-dir} outside of the source code)

{predicate-source-dir}/tools/config-for-local.sh {cmake-options}

For explanation of {cmake_options}, see the cmake options section.

Variant 3: Configuration for re-using local KDE 4 installation

Here is recommendation of a directory structure:

$HOME/kde4/src/predicate

{predicate-source-dir}

$HOME/kde4/build/predicate

{predicate-build-dir}

$HOME/kde4/inst

directory that Predicate will be installed in, shared with other locally installed KDE software

If you use local KDE 4 installation, e.g. for developed applications, for your convenience, config-for-kde.sh script has been prepared with default configuration settings. You can find it in tools/ subdirectory of the source code. Use it as follows:

1. Make sure $KDEDIRS environment variable is set to directory that is intended PREFIX for the local KDE 4 installation, e.g. $HOME/kde4/inst.

2. To make the Predicate installation work, environment variables PATH, LD_LIBRARY_PATH, PKG_CONFIG_PATH, QT_PLUGIN_PATH should be set properly. Several of these are probably already set for the local KDE 4 installation but better double check this:

_libdir=lib # or lib64 for 64-bit platforms
export PATH=$KDEDIRS/bin:$PATH
export LD_LIBRARY_PATH=$KDEDIRS/$_libdir:$LD_LIBRARY_PATH
export PKG_CONFIG_PATH=$KDEDIRS/$_libdir/pkgconfig:$PKG_CONFIG_PATH
export QT_PLUGIN_PATH=$KDEDIRS/$_libdir/kde4/plugins:$QT_PLUGIN_PATH

3. Then:

mkdir -p {predicate-build-dir}
cd {predicate-build-dir}

(better pick your {predicate-build-dir} outside of the source code)

{predicate-source-dir}/tools/config-for-kde.sh {cmake-options}

For explanation of {cmake_options}, see the cmake options section.

Debugging options

Recommended for accurate debugging: The default debug setting is RelWithDebInfo which is suitable only for obtaining backtraces. If you are developing code that uses Predicate or developing Predicate itself you may want to precisely set breakpoints, watch points, use step by step command accurately in your debugger, rely on assertions, debug and warning messages. If this is the case, you can replace -DCMAKE_BUILD_TYPE=RelWithDebInfo cmake option with:

-DCMAKE_BUILD_TYPE=DebugFull

Using DebugFull results in a slower code. That can be acceptable in most cases during testing and development given the machine is fast enough. It is not intended for production releases of the software unless you know what you're doing.

Enabling tests

To build with tests enabled (both unit tests and functional tests), add -DBUILD_TESTING=ON to the cmake command before building.

Build

For any configuration option: Type the above configuration command only once, to configure the cmake-based buildsystem. Then just type:

 make
 make install

Reconfiguration

To completely reconfigure, remove the {predicate-build-dir} directory completely and repeat the configuration process.

Speed up the build

Recommended: Taking advantage of multi-core processors. On dual-core machines compilation can be greatly speed up with the -j parameter of the make program. For example whenever you are invoking make, for dual-core processor try to invoke:

make -j3

Similarly, for quad-core processor:

make -j5

Generaly for N-core processor use the -jN+1 parameter.

Recommended: Faster linking on Linux. Linking can take noticeable time in large software such as Calligra. On Linux Gold linker can be used to speed up this task. If you're building for Linux, install the Gold linker package and add the following to your cmake command:

-DCMAKE_C_FLAGS=-fuse-linker-plugin -DCMAKE_CXX_FLAGS=-fuse-linker-plugin

(you can set the CMAKE_C_FLAGS adn CMAKE_CXX_FLAGS variables in your {build dir}/CMakeCache.txt file either using text editor or the ccmake tool)

Notes

To enable debugging inside of bison (.y) file, put this in your $HOME/.gdbinit config file:

set directories ~/dev/src/predicate/Predicate/parser