This file describes how to build Freeze for C++ from source and how to test the resulting build.
ZeroC provides Freeze binary distributions for many platforms and compilers, including Windows and Visual Studio, so building Freeze from source is usually unnecessary.
- C++ Build Requirements
- Building Freeze for Linux or macOS
- Building Freeze for Windows
- Installing a C++ Source Build on Linux or macOS
- Creating a NuGet Package on Windows
- Running the Test Suite
Freeze was extensively tested using the operating systems and compiler versions listed on supported platforms.
Freeze uses Berkeley DB as its underlying database and currently requires Berkeley DB version 5.3 (the recommended version is 5.3.28).
ZeroC supplies binary packages for Berkeley DB on supported Linux distributions that do not include them.
You can install Berkeley DB with Homebrew as follows:
brew install zeroc-ice/tap/[email protected]
The Freeze build system for Windows automatically downloads and installs
NuGet and NuGet packages for Berkeley DB when you build Freeze for C++.
These packages are installed in freeze\cpp\msbuild\packages.
If freeze/ice is an empty directory, fetch the ice submodule with:
cd freeze
git submodule update --init
Edit freeze/ice/config/Make.rules to establish your build configuration. The
comments in the file provide more information.
cd freeze/ice/cpp
make -j8 src/IceXML TestCommon
Edit freeze/config/Make.rules to establish your build configuration. The
comments in the file provide more information.
cd freeze/cpp
make -j8
This builds the Freeze library, the FreezeScript utilities, and all Freeze tests.
Open a Visual Studio command prompt. For example, with Visual Studio 2015, you can open one of:
- VS2015 x86 Native Tools Command Prompt
- VS2015 x64 Native Tools Command Prompt
Using the first Command Prompt produces Win32 binaries by default, while
the second Command Prompt produces x64 binaries by default.
If freeze\ice is an empty directory, change to the freeze directory and
fetch the ice submodule:
cd freeze
git submodule update --init
Change to the freeze\cpp subdirectory:
cd freeze\cpp
Now you're ready to build Freeze:
msbuild /m msbuild\freeze.proj
This builds several Ice C++ components in freeze\ice\cpp, the Freeze
library, the FreezeScript utilities and all the Freeze tests in Release
mode.
Set the MSBuild Configuration property to Debug to build debug binaries
instead:
msbuild msbuild\freeze.proj /p:Configuration=Debug
The Configuration property may be set to Debug or Release.
Set the MSBuild Platform property to Win32 or x64 to build binaries
for a specific platform, for example:
msbuild msbuild\freeze.proj /p:Configuration=Debug /p:Platform=x64
You can also skip the build of the test suite with the BuildDist target:
msbuild msbuild\freeze.proj /t:BuildDist /p:Platform=x64
To build the test suite using the NuGet binary distribution use:
msbuild msbuild\freeze.proj /p:FREEZE_BIN_DIST=all
You can also sign the Freeze binaries with Authenticode, by setting the following environment variables:
- SIGN_CERTIFICATE to your Authenticode certificate
- SIGN_PASSWORD to the certificate password
Simply run make install. This will install Freeze in the directory specified
by the prefix variable in freeze/config/Make.rules.
After installation, make sure that the prefix/bin directory is in your PATH.
When compiling Freeze programs, you must pass the location of the
prefix/include directory to the compiler with the -I option, and the
location of the library directory with the -L option.
You can create a NuGet package with the following command:
msbuild msbuild\ice.proj /t:NuGetPack /p:BuildAllConfigurations=yes
This creates zeroc.freeze.v120\zeroc.freeze.v120.nupkg or
zeroc.freeze.v140\zeroc.freeze.v140.nupkg depending on the compiler you are
using.
Python is required to run the test suite.
After a successful source build, you can run the tests as follows:
python allTests.py
If everything worked out, you should see lots of ok messages. In case of a
failure, the tests abort with failed.