Skip to content

Instantly share code, notes, and snippets.

@henriquerichter
Last active October 30, 2018 06:02
Show Gist options
  • Save henriquerichter/c6ee9d0e221b5980ebb72756af1b6d7a to your computer and use it in GitHub Desktop.
Save henriquerichter/c6ee9d0e221b5980ebb72756af1b6d7a to your computer and use it in GitHub Desktop.
CMake
cmake_minimum_required(VERSION 3.9.0)
project(proj0)
file(GLOB_RECURSE sources ../src/*.cpp)
file(GLOB_RECURSE sources_test ../src/test/*.cpp)
file(GLOB_RECURSE data ../resources/*)
add_executable(main ${sources} ${data})
set(CMAKE_BINARY_DIR ${CMAKE_SOURCE_DIR}/../bin)
set(EXECUTABLE_OUTPUT_PATH ${CMAKE_BINARY_DIR})
set(LIBRARY_OUTPUT_PATH ${CMAKE_BINARY_DIR})
if (CMAKE_BUILD_TYPE STREQUAL "")
file(COPY ${data} DESTINATION ${CMAKE_BINARY_DIR}/Debug)
endif()
if (CMAKE_BUILD_TYPE STREQUAL "Debug")
file(COPY ${data} DESTINATION ${CMAKE_BINARY_DIR}/Debug)
endif()
if (CMAKE_BUILD_TYPE STREQUAL "Release")
file(COPY ${data} DESTINATION ${CMAKE_BINARY_DIR}/Release)
endif()
.bat to be used together
@echo off
cd proj_files
echo Creating project files...
cmake ./ -DCMAKE_BUILD_TYPE=%1 -G "Visual Studio 15 2017 Win64"
echo Building...
cmake --build ./ --config %1
echo Done.
cmake_minimum_required(VERSION 3.0) # setting this is required
project(example_project) # this sets the project name
###############################################################################
## 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 globbing to find files automatically.
###############################################################################
## target definitions #########################################################
###############################################################################
# The data is just added to the executable, because in some IDEs (QtCreator)
# files are invisible when they are not explicitly part of the project.
add_executable(example ${sources} ${data})
# Just for example add some compiler flags.
target_compile_options(example PUBLIC -std=c++1y -Wall -Wfloat-conversion)
# This allows to include files relative to the root of the src directory 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 containts all library names
# that we need to link into the program.
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.
# People who might want to build the project to use it should not be required
# to install testing dependencies.
find_package(GTest)
if(GTEST_FOUND)
add_executable(unit_tests ${sources_test} ${sources})
# This define is added to prevent collision with the main.
# It 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 the executable as a link library, and inherit all
# linker options and library dependencies from it, by simply adding it as dependency.
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 incomplete pieces.
set(CPACK_MONOLITHIC_INSTALL 1)
# This must be last
include(CPack)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment