Mirrors/cmake-examples
1
0
Fork 0
mirror of https://github.com/ttroy50/cmake-examples.git synced 2025-12-18 20:24:35 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #6 from ttroy50/add_basic_clang_ninja_example

Browse Source 
Add basic clang ninja example
This commit is contained in:
Thom Troy
2016-02-14 12:25:54 +00:00
parent 9c07934ba7 bcd01e8f60
commit b872b7c062
13 changed files with 386 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
.gitignore vendored
View File

@@ -57,4 +57,5 @@ install_manifest.txt
*.out
*.app
/**/build
/**/build
/**/build.*

6
.travis.yml
View File

@@ -3,12 +3,12 @@ sudo: required
compiler:
- gcc
before_install:
- if [ $TRAVIS_OS_NAME == linux ]; then sudo apt-get update && sudo apt-get install -y cmake libboost-all-dev libprotobuf-dev protobuf-compiler cppcheck; fi
- if [ $TRAVIS_OS_NAME == linux ]; then sudo apt-get update && sudo apt-get install -y cmake libboost-all-dev libprotobuf-dev protobuf-compiler cppcheck ninja-build clang; fi
script:
- ./test.sh
branches:
only:
- master
except:
- gh-pages
notifications:
email: true
os:

10
01-basic/I-compiling-with-clang/CMakeLists.txt Normal file
View File

@@ -0,0 +1,10 @@
# Set the minimum version of CMake that can be used
# To find the cmake version run
# $ cmake --version
cmake_minimum_required(VERSION 2.6)
# Set the project name
project (hello_cmake)
# Add an executable
add_executable(hello_cmake main.cpp)

126
01-basic/I-compiling-with-clang/README.adoc Normal file
View File

@@ -0,0 +1,126 @@
= Compiling with clang
:toc:
:toc-placement!:
toc::[]
# Introduction
When building with CMake it is possible to set the C and C++ compiler. This example
is the same as the link:../A-hello-cmake[hello-cmake] example except that it shows the most basic
method of changing the compiler from the default gcc to http://clang.llvm.org/[clang].
The files in this tutorial are below:
```
A-hello-cmake$ tree
.
├── CMakeLists.txt
├── main.cpp
```
* CMakeLists.txt - Contains the CMake commands you wish to run
* main.cpp - A simple "Hello World" cpp file.
# Concepts
### Compiler Option
CMake exposes options to control the programs used to compile and link your code. These
programs include:
* CMAKE_C_COMPILER - The program used to compile c code.
* CMAKE_CXX_COMPILER - The program used to compile c++ code.
* CMAKE_LINKER - The program used to link your binary.
[NOTE]
====
In this example clang-3.6 is installed via the command `sudo apt-get install clang-3.6`
====
[NOTE]
====
This is the most basic and easiest way to invoke clang. Future examples will show better
ways to invoke the compiler.
====
### Setting Flags
As described in the link:../F-build-type[Build Type] example, you can set CMake options
using either a cmake gui or by passing from the command line.
Below is an example of passing the compiler via the command line.
[source,cmake]
----
cmake .. -DCMAKE_C_COMPILER=clang-3.6 -DCMAKE_CXX_COMPILER=clang++-3.6
----
After setting these options when your run `make` clang will be used to compile your binary. This
can be seen from the following lines in the make output.
[source,bash]
----
/usr/bin/clang++-3.6 -o CMakeFiles/hello_cmake.dir/main.cpp.o -c /home/matrim/workspace/cmake-examples/01-basic/I-compiling-with-clang/main.cpp
Linking CXX executable hello_cmake
/usr/bin/cmake -E cmake_link_script CMakeFiles/hello_cmake.dir/link.txt --verbose=1
/usr/bin/clang++-3.6 CMakeFiles/hello_cmake.dir/main.cpp.o -o hello_cmake -rdynamic
----
# Building the Examples
Below is sample output from building this example.
[source,bash]
----
$ mkdir build.clang
$ cd build.clang/
$ cmake .. -DCMAKE_C_COMPILER=clang-3.6 -DCMAKE_CXX_COMPILER=clang++-3.6
-- The C compiler identification is Clang 3.6.0
-- The CXX compiler identification is Clang 3.6.0
-- Check for working C compiler: /usr/bin/clang-3.6
-- Check for working C compiler: /usr/bin/clang-3.6 -- works
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Check for working CXX compiler: /usr/bin/clang++-3.6
-- Check for working CXX compiler: /usr/bin/clang++-3.6 -- works
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Configuring done
-- Generating done
-- Build files have been written to: /home/matrim/workspace/cmake-examples/01-basic/I-compiling-with-clang/build.clang
$ make VERBOSE=1
/usr/bin/cmake -H/home/matrim/workspace/cmake-examples/01-basic/I-compiling-with-clang -B/home/matrim/workspace/cmake-examples/01-basic/I-compiling-with-clang/build.clang --check-build-system CMakeFiles/Makefile.cmake 0
/usr/bin/cmake -E cmake_progress_start /home/matrim/workspace/cmake-examples/01-basic/I-compiling-with-clang/build.clang/CMakeFiles /home/matrim/workspace/cmake-examples/01-basic/I-compiling-with-clang/build.clang/CMakeFiles/progress.marks
make -f CMakeFiles/Makefile2 all
make[1]: Entering directory `/home/matrim/workspace/cmake-examples/01-basic/I-compiling-with-clang/build.clang'
make -f CMakeFiles/hello_cmake.dir/build.make CMakeFiles/hello_cmake.dir/depend
make[2]: Entering directory `/home/matrim/workspace/cmake-examples/01-basic/I-compiling-with-clang/build.clang'
cd /home/matrim/workspace/cmake-examples/01-basic/I-compiling-with-clang/build.clang && /usr/bin/cmake -E cmake_depends "Unix Makefiles" /home/matrim/workspace/cmake-examples/01-basic/I-compiling-with-clang /home/matrim/workspace/cmake-examples/01-basic/I-compiling-with-clang /home/matrim/workspace/cmake-examples/01-basic/I-compiling-with-clang/build.clang /home/matrim/workspace/cmake-examples/01-basic/I-compiling-with-clang/build.clang /home/matrim/workspace/cmake-examples/01-basic/I-compiling-with-clang/build.clang/CMakeFiles/hello_cmake.dir/DependInfo.cmake --color=
Dependee "/home/matrim/workspace/cmake-examples/01-basic/I-compiling-with-clang/build.clang/CMakeFiles/hello_cmake.dir/DependInfo.cmake" is newer than depender "/home/matrim/workspace/cmake-examples/01-basic/I-compiling-with-clang/build.clang/CMakeFiles/hello_cmake.dir/depend.internal".
Dependee "/home/matrim/workspace/cmake-examples/01-basic/I-compiling-with-clang/build.clang/CMakeFiles/CMakeDirectoryInformation.cmake" is newer than depender "/home/matrim/workspace/cmake-examples/01-basic/I-compiling-with-clang/build.clang/CMakeFiles/hello_cmake.dir/depend.internal".
Scanning dependencies of target hello_cmake
make[2]: Leaving directory `/home/matrim/workspace/cmake-examples/01-basic/I-compiling-with-clang/build.clang'
make -f CMakeFiles/hello_cmake.dir/build.make CMakeFiles/hello_cmake.dir/build
make[2]: Entering directory `/home/matrim/workspace/cmake-examples/01-basic/I-compiling-with-clang/build.clang'
/usr/bin/cmake -E cmake_progress_report /home/matrim/workspace/cmake-examples/01-basic/I-compiling-with-clang/build.clang/CMakeFiles 1
[100%] Building CXX object CMakeFiles/hello_cmake.dir/main.cpp.o
/usr/bin/clang++-3.6 -o CMakeFiles/hello_cmake.dir/main.cpp.o -c /home/matrim/workspace/cmake-examples/01-basic/I-compiling-with-clang/main.cpp
Linking CXX executable hello_cmake
/usr/bin/cmake -E cmake_link_script CMakeFiles/hello_cmake.dir/link.txt --verbose=1
/usr/bin/clang++-3.6 CMakeFiles/hello_cmake.dir/main.cpp.o -o hello_cmake -rdynamic
make[2]: Leaving directory `/home/matrim/workspace/cmake-examples/01-basic/I-compiling-with-clang/build.clang'
/usr/bin/cmake -E cmake_progress_report /home/matrim/workspace/cmake-examples/01-basic/I-compiling-with-clang/build.clang/CMakeFiles 1
[100%] Built target hello_cmake
make[1]: Leaving directory `/home/matrim/workspace/cmake-examples/01-basic/I-compiling-with-clang/build.clang'
/usr/bin/cmake -E cmake_progress_start /home/matrim/workspace/cmake-examples/01-basic/I-compiling-with-clang/build.clang/CMakeFiles 0
$ ./hello_cmake
Hello CMake!
----

7
01-basic/I-compiling-with-clang/main.cpp Normal file
View File

@@ -0,0 +1,7 @@
#include <iostream>
int main(int argc, char *argv[])
{
std::cout << "Hello CMake!" << std::endl;
return 0;
}

17
01-basic/I-compiling-with-clang/run_test.sh Executable file
View File

@@ -0,0 +1,17 @@
#!/bin/bash
# Ubuntu supports multiple versions of clang to be installed at the same time.
# The tests need to determin the clang binary before calling cmake
clang_bin=`which clang`
clang_xx_bin=`which clang++`
if [ -z $clang_bin ]; then
clang_ver=`dpkg --get-selections | grep clang | grep -v -m1 libclang | cut -f1 | cut -d '-' -f2`
clang_bin="clang-$clang_ver"
clang_xx_bin="clang++-$clang_ver"
fi
echo "Will use clang [$clang_bin] and clang++ [$clang_xx_bin]"
mkdir -p build.clang && cd build.clang && \
cmake .. -DCMAKE_C_COMPILER=$clang_bin -DCMAKE_CXX_COMPILER=$clang_xx_bin && make

10
01-basic/J-building-with-ninja/CMakeLists.txt Normal file
View File

@@ -0,0 +1,10 @@
# Set the minimum version of CMake that can be used
# To find the cmake version run
# $ cmake --version
cmake_minimum_required(VERSION 2.6)
# Set the project name
project (hello_cmake)
# Add an executable
add_executable(hello_cmake main.cpp)

160
01-basic/J-building-with-ninja/README.adoc Normal file
View File

@@ -0,0 +1,160 @@
= Building with ninja
:toc:
:toc-placement!:
toc::[]
# Introduction
As mentioned in the introduction, CMake is a meta-build system that can be used to
create the build files for many other build tools. This example shows how
to have CMake use the https://ninja-build.org/[ninja build] tool.
The files in this tutorial are below:
```
A-hello-cmake$ tree
.
├── CMakeLists.txt
├── main.cpp
```
* CMakeLists.txt - Contains the CMake commands you wish to run
* main.cpp - A simple "Hello World" cpp file.
# Concepts
### Generators
CMake https://cmake.org/cmake/help/v3.0/manual/cmake-generators.7.html[generators] are
responsible for writing the input files (e.g. Makefiles) for the underlying build system. Running `cmake --help`
will show the generators available. For cmake v2.8.12.2 the generators supported
on my system include:
[source,bash]
----
Generators
The following generators are available on this platform:
Unix Makefiles = Generates standard UNIX makefiles.
Ninja = Generates build.ninja files (experimental).
CodeBlocks - Ninja = Generates CodeBlocks project files.
CodeBlocks - Unix Makefiles = Generates CodeBlocks project files.
Eclipse CDT4 - Ninja = Generates Eclipse CDT 4.0 project files.
Eclipse CDT4 - Unix Makefiles
= Generates Eclipse CDT 4.0 project files.
KDevelop3 = Generates KDevelop 3 project files.
KDevelop3 - Unix Makefiles = Generates KDevelop 3 project files.
Sublime Text 2 - Ninja = Generates Sublime Text 2 project files.
Sublime Text 2 - Unix Makefiles
= Generates Sublime Text 2 project files.Generators
----
As specified in this https://stackoverflow.com/questions/25941536/what-is-a-cmake-generator[post],
CMake includes different types of generators such as Command-Line, IDE, and Extra generators.
#### Command-Line Build Tool Generators
These generators are for command-line build tools, like Make and Ninja. The chosen tool chain must be configured prior to generating the build system with CMake.
The supported generators include:
* Borland Makefiles
* MSYS Makefiles
* MinGW Makefiles
* NMake Makefiles
* NMake Makefiles JOM
* Ninja
* Unix Makefiles
* Watcom WMake
#### IDE Build Tool Generators
These generators are for Integrated Development Environments that include their own compiler. Examples are Visual Studio and Xcode which include a compiler natively.
The supported generators include:
* Visual Studio 6
* Visual Studio 7
* Visual Studio 7 .NET 2003
* Visual Studio 8 2005
* Visual Studio 9 2008
* Visual Studio 10 2010
* Visual Studio 11 2012
* Visual Studio 12 2013
* Xcode
#### Extra Generators
These are generators create a configuration to work with an alternative IDE tool and must be included with either an IDE or Command-Line generator.
The supported generators include:
* CodeBlocks
* CodeLite
* Eclipse CDT4
* KDevelop3
* Kate
* Sublime Text 2
[NOTE]
====
In this example ninja is installed via the command `sudo apt-get install ninja-build`
====
### Calling a Generator
To call a CMake generator you can use the `-G` command line switch, for example:
[source,cmake]
----
cmake .. -G Ninja
----
After doing the above CMake will generate the required Ninja build files, which can be run
from using the `ninja` command.
[source,bash]
----
$ cmake .. -G Ninja
$ ls
build.ninja CMakeCache.txt CMakeFiles cmake_install.cmake rules.ninja
----
# Building the Examples
Below is sample output from building this example.
[source,bash]
----
$ mkdir build.ninja
$ cd build.ninja/
$ cmake .. -G Ninja
-- The C compiler identification is GNU 4.8.4
-- The CXX compiler identification is GNU 4.8.4
-- Check for working C compiler using: Ninja
-- Check for working C compiler using: Ninja -- works
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Check for working CXX compiler using: Ninja
-- Check for working CXX compiler using: Ninja -- works
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Configuring done
-- Generating done
-- Build files have been written to: /home/matrim/workspace/cmake-examples/01-basic/J-building-with-ninja/build.ninja
$ ninja -v
[1/2] /usr/bin/c++ -MMD -MT CMakeFiles/hello_cmake.dir/main.cpp.o -MF "CMakeFiles/hello_cmake.dir/main.cpp.o.d" -o CMakeFiles/hello_cmake.dir/main.cpp.o -c ../main.cpp
[2/2] : && /usr/bin/c++ CMakeFiles/hello_cmake.dir/main.cpp.o -o hello_cmake -rdynamic && :
$ ls
build.ninja CMakeCache.txt CMakeFiles cmake_install.cmake hello_cmake rules.ninja
$ ./hello_cmake
Hello CMake!
----

7
01-basic/J-building-with-ninja/main.cpp Normal file
View File

@@ -0,0 +1,7 @@
#include <iostream>
int main(int argc, char *argv[])
{
std::cout << "Hello CMake!" << std::endl;
return 0;
}

11
01-basic/J-building-with-ninja/run_test.sh Executable file
View File

@@ -0,0 +1,11 @@
#!/bin/bash
# Travis-ci cmake version doesn't support ninja, so first check if it's supported
ninja_supported=`cmake --help | grep Ninja`
if [ -z $ninja_supported ]; then
echo "Ninja not supported"
exit
fi
mkdir -p build.ninja && cd build.ninja && \
cmake .. -G Ninja && ninja

4
01-basic/README.adoc
View File

@@ -6,10 +6,12 @@ set compile flags, create and link executables and libraries, and install them.
The examples included are
- link:A-hello-cmake[hello-cmake]. A hello world example.
- link:B-hello-headers[hello-headers]. A slighly more complicated hello world example, using seperate source and include folders.
- link:B-hello-headers[hello-headers]. A slightly more complicated hello world example, using seperate source and include folders.
- link:C-static-library[static-library]. An example using a static library.
- link:D-shared-library[shared-library]. An example using a shared library.
- link:E-installing[installing]. Shows how to create a 'make install' target that will install binaries and libraries.
- link:F-build-type[build-type]. An example showing how to set a default build and optimization flags for your project.
- link:G-compile-flags[compile-flags]. Shows how to set additional compile flags.
- link:H-third-party-library[third-party-library]. Shows an example of how to link third party libraries.
- link:I-compiling-with-clang[compiling-with-clang]. An example of invoking the clang compiler.
- link:J-building-with-ninja[building-with-ninja] - Shows how to generate ninja build files

11
README.adoc
View File

@@ -7,8 +7,8 @@ toc::[]
# Introduction
https://cmake.org/[CMake] is a cross-platform open-source build system which can build, test and package
software. It can be used to support multiple native build environments including
https://cmake.org/[CMake] is a cross-platform open-source meta-build system which
can build, test and package software. It can be used to support multiple native build environments including
make, Apple's xcode and Microsoft Visual Studio.
This repository includes some example CMake configurations which I have picked up
@@ -51,6 +51,13 @@ Some specific examples may require other tools including:
$ sudo apt-get install cppcheck
* http://clang.llvm.org/[clang]
$ sudo apt-get install clang-3.6
* https://ninja-build.org/[ninja]
$ sudo apt-get install ninja-build
# Other Links

25
test.sh
View File

@@ -1,5 +1,11 @@
#!/bin/bash
# print out cmake information to help with debugging.
cmake --version
cmake --help
dirs=( ./01-basic/A-hello-cmake \
./01-basic/B-hello-headers \
./01-basic/C-static-library \
@@ -8,6 +14,8 @@ dirs=( ./01-basic/A-hello-cmake \
./01-basic/F-build-type \
./01-basic/G-compile-flags \
./01-basic/H-third-party-library \
./01-basic/I-compiling-with-clang \
./01-basic/J-building-with-ninja \
./02-sub-projects/A-basic \
./03-code-generation/protobuf \
./03-code-generation/configure-files \
@@ -38,10 +46,19 @@ do
fi
fi
cd $dir && mkdir -p build && cd build && cmake .. && make
if [ $? -ne 0 ]; then
echo "Error running example $dir"
exit 1
if [ -f "$dir/run_test.sh" ]; then
echo "running run_test"
cd $dir && $ROOT_DIR/$dir/run_test.sh
if [ $? -ne 0 ]; then
echo "Error running run_test for $dir"
exit 1
fi
else
cd $dir && mkdir -p build && cd build && cmake .. && make
if [ $? -ne 0 ]; then
echo "Error running example $dir"
exit 1
fi
fi
if [ -f "$ROOT_DIR/$dir/post_test.sh" ]; then