Building the test suite

This section contains the instructions for building and running the test cases and documentatation examples that are packaged with Boost.CallableTraits.

	Note
	Some test cases that use language features that do not work on some supported compilers. These conflicts are "resolved" by replacing `int main(){}` with the actual test via conditional compilation.

Even though the Boost.CallableTraits headers do not rely on external dependencies, you'll need to install CMake version 3.0 or higher to use the test suite. For Windows users who wish to build the test suite with Visual Studio 2015 Update 2, it appears that CMake version 3.5 or higher is required. The build instructions assume that both CMake and Git are executable from your environment PATH.

One-click build scripts

For convenience, one-click build scripts for Linux and Windows are packaged with Boost.CallableTraits, each of which must be run from the directory in which the script resides. Running one of these scripts will create a build-xxx subdirectory in the Boost.CallableTraits root directory, and perform all testing there. Even though these scripts were designed to be as generic as possible, issues may exist because they have not seen widespread use. Refer to the console instructions below if the provided testing scripts do not work for you.

Use these scripts at your own risk.

First, clone the repository:

git clone http://github.com/badair/callable_traits

Linux (possibly OSX - untested)
- script directory: [CallableTraits root]/scripts/posix
  - gcc-libcstdxx.sh
    
    compiles with the g++ version found in the PATH
    
    This is the script most likely to work out-of-the-box, since GCC 4.8 comes pre-installed on many Linux distributions
  - clang-libcxx.sh
    
    compiles with the clang++ executable in the PATH
    
    uses libc++ as the standard library implementation
  - clang-libcstdxx.sh
    
    compiles with the clang++ executable in the PATH
    
    uses libstdc++ as the standard library implementation
Windows
- script directory: [CallableTraits root]\scripts\windows
  - MSVC-Win32-Debug.bat
    compiles with Visual Studio 2015, which must be installed in the default install directory
  - LLVM-vs2014-Win32-Debug.bat
    
    compiles with clang/c2
    
    Visual Studio 2015 must be installed in the default install directory
    
    This script assumes that the Windows Installer found on this page was used to install LLVM
  - MinGW-Win32-Release.bat
    
    compiles with a MinGW-based GCC build
    
    requires a Windows build of GNU Make to be installed and present in the PATH environment variable
    
    Expects to find the MinGW root directory at C:\\MinGW

Console instructions - Linux/OSX

Open a shell and enter the following commands:

git clone http://github.com/badair/callable_traits
cd callable_traits
mkdir build
cd build
cmake .. -DCMAKE_CXX_COMPILER=/path/to/compiler
make check

Console instructions - Windows

	Note
	Cygwin and MSYS users should refer to the Linux section (you know who you are).

Fire up cmd.exe and enter the following commands:

	Note
	These commands assume that Visual Studio 2015 was installed in the default directory. git and CMake executables are expected to be present in the evironment PATH. A 64 bit Windows install is assumed.

git clone http://github.com/badair/callable_traits
cd callable_traits
mkdir build
cd build
cmake .. -G"Visual Studio 14 2015"
"%ProgramFiles(x86)%\MSBuild\14.0\Bin\MSBuild.exe" check.vcxproj /t:build /p:Configuration=Debug /p:Platform=Win32 /v:n /nologo

To build with Clang/C2 instead of MSVC, append -TLLVM-vs2014 to the CMake arguments. This will only work if you have Clang/C2 installed.

	Tip
	If you need additional help building the test suite, contact me.

	Note
	Boost.Build isn't supported yet, but it will be supported soon.