Najprostszy, ale kompletny przykład CMake

Po kilku badaniach mam teraz własną wersję najprostszego, ale kompletnego przykładu cmake. Oto ona i stara się objąć większość podstaw, w tym zasoby i opakowania.

Jedną z rzeczy, które robi niestandardowo, jest obsługa zasobów. Domyślnie cmake chce umieścić je w /usr/ share/,/usr/local/ share / i coś równoważnego w systemie windows. Chciałem mieć prosty zip / tar.gz, który możesz wydobyć w dowolnym miejscu i uruchomić. Dlatego zasoby są ładowane względem wykonywalny.

Podstawową zasadą rozumienia poleceń cmake jest następująca składnia: <function-name>(<arg1> [<arg2> ...]) bez przecinka lub średnika. Każdy argument jest ciągiem znaków. foobar(3.0) i foobar("3.0") to to samo. możesz ustawić listy / zmienne za pomocą set(args arg1 arg2). Z tym zestawem zmiennych foobar(${args}) i foobar(arg1 arg2) są faktycznie takie same. Nieistniejąca zmienna jest równoznaczna z pustą listą. Lista jest wewnętrznie ciągiem znaków ze średnikami, aby oddzielić elementy. Dlatego lista zawierająca tylko jeden element jest z definicji tylko tym elementem, boks nie ma miejsca. Zmienne są globalne. Wbudowane funkcje oferują pewną formę nazwanych argumentów przez fakt, że oczekują pewnych identyfikatorów, takich jak PUBLIC lub DESTINATION w ich liście argumentów, do grupowania argumentów. Ale to nie jest funkcja języka, te identyfikatory są również po prostu ciągami znaków i przetwarzane przez implementację funkcji.

Możesz sklonować wszystko z github

cmake_minimum_required(VERSION 3.0)
project(example_project)

###############################################################################
## file globbing ##############################################################
###############################################################################

# these instructions search the directory tree when cmake is
# invoked and put all files that match the pattern in the variables 
# `sources` and `data`
file(GLOB_RECURSE sources      src/main/*.cpp src/main/*.h)
file(GLOB_RECURSE sources_test src/test/*.cpp)
file(GLOB_RECURSE data resources/*)
# you can use set(sources src/main.cpp) etc if you don't want to
# use globing to find files automatically

###############################################################################
## target definitions #########################################################
###############################################################################

# add the data to the target, so it becomes visible in some IDE
add_executable(example ${sources} ${data})

# just for example add some compiler flags
target_compile_options(example PUBLIC -std=c++1y -Wall -Wfloat-conversion)

# this lets me include files relative to the root src dir with a <> pair
target_include_directories(example PUBLIC src/main)

# this copies all resource files in the build directory
# we need this, because we want to work with paths relative to the executable
file(COPY ${data} DESTINATION resources)

###############################################################################
## dependencies ###############################################################
###############################################################################

# this defines the variables Boost_LIBRARIES that contain all library names
# that we need to link to
find_package(Boost 1.36.0 COMPONENTS filesystem system REQUIRED)

target_link_libraries(example PUBLIC
  ${Boost_LIBRARIES}
  # here you can add any library dependencies
)

###############################################################################
## testing ####################################################################
###############################################################################

# this is for our testing framework
# we don't add REQUIRED because it's just for testing
find_package(GTest)

if(GTEST_FOUND)
  add_executable(unit_tests ${sources_test} ${sources})

  # we add this define to prevent collision with the main
  # this might be better solved by not adding the source with the main to the
  # testing target
  target_compile_definitions(unit_tests PUBLIC UNIT_TESTS)

  # this allows us to use our executable as a link library
  # therefore we can inherit all compiler options and library dependencies
  set_target_properties(example PROPERTIES ENABLE_EXPORTS on)

  target_link_libraries(unit_tests PUBLIC
    ${GTEST_BOTH_LIBRARIES}
    example
  )

  target_include_directories(unit_tests PUBLIC
    ${GTEST_INCLUDE_DIRS} # doesn't do anything on Linux
  )
endif()

###############################################################################
## packaging ##################################################################
###############################################################################

# all install commands get the same destination. this allows us to use paths
# relative to the executable.
install(TARGETS example DESTINATION example_destination)
# this is basically a repeat of the file copy instruction that copies the
# resources in the build directory, but here we tell cmake that we want it
# in the package
install(DIRECTORY resources DESTINATION example_destination)

# now comes everything we need, to create a package
# there are a lot more variables you can set, and some
# you need to set for some package types, but we want to
# be minimal here
set(CPACK_PACKAGE_NAME "MyExample")
set(CPACK_PACKAGE_VERSION "1.0.0")

# we don't want to split our program up into several things
set(CPACK_MONOLITHIC_INSTALL 1)

# This must be last
include(CPack)