Files
OpenSpace/support/cmake/module_definition.cmake
T
Alexander Bock 713b5bb97b Fix compile error in iSWA module
Update warning specification for modules
Disable unreferenced local function warning
Update Ghoul
2017-07-15 17:48:03 -04:00

238 lines
12 KiB
CMake

#########################################################################################
# #
# OpenSpace #
# #
# Copyright (c) 2014-2017 #
# #
# Permission is hereby granted, free of charge, to any person obtaining a copy of this #
# software and associated documentation files (the "Software"), to deal in the Software #
# without restriction, including without limitation the rights to use, copy, modify, #
# merge, publish, distribute, sublicense, and/or sell copies of the Software, and to #
# permit persons to whom the Software is furnished to do so, subject to the following #
# conditions: #
# #
# The above copyright notice and this permission notice shall be included in all copies #
# or substantial portions of the Software. #
# #
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, #
# INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A #
# PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT #
# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF #
# CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE #
# OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. #
#########################################################################################
include (${OPENSPACE_CMAKE_EXT_DIR}/module_common.cmake)
include (${GHOUL_BASE_DIR}/support/cmake/handle_external_library.cmake)
# Creates a new project and a library for the module with name <module_name>. The name of
# the library is returned in <output_library_name> for outside configuration
# The library will have the name openspace-module-<name> and has all of their
# dependencies set correctly.
# Dependencies will have to be set in a file called "include.cmake"
function (create_new_module module_name output_library_name)
set(sources ${ARGN})
project(${module_name})
# Create a library name of the style: openspace-module-${name}
create_library_name(${module_name} library_name)
message(STATUS "Configuring module ${module_name}: ${library_name}")
# Add the module files to the list of sources
add_module_files()
set(library_mode STATIC)
if (${library_name}_LIBRARY_MODE)
set(library_mode ${${library_name}_LIBRARY_MODE})
message(STATUS "\t Overwritten library mode: ${library_mode}")
endif ()
# Create the library
add_library(${library_name} ${library_mode} ${sources})
# Set compile settings that are common to all modules
set_common_compile_settings(${library_name})
# Propagate the includes and compiler definitions that are set in the libOpenSpace target
set_openspace_settings(${library_name})
handle_dependencies(${library_name} ${module_name})
write_module_name(${module_name})
set(${output_library_name} ${library_name} PARENT_SCOPE)
endfunction ()
# I couldn't make adding the module files to the ${sources} variable to work with a function ---abock
# Adds the <name>module.h and <name>module.cpp files to the list of sources and provides
# Them with a source group
macro (add_module_files)
string(TOLOWER ${module_name} module_name_lower)
set(module_files
${CMAKE_CURRENT_SOURCE_DIR}/${module_name_lower}module.h
${CMAKE_CURRENT_SOURCE_DIR}/${module_name_lower}module.cpp
)
source_group("Module Files" FILES ${module_files})
list(APPEND sources ${module_files})
endmacro ()
# Set the compiler settings that are common to all modules
function (set_common_compile_settings target_name)
set_property(TARGET ${target_name} PROPERTY CXX_STANDARD 17)
set_property(TARGET ${target_name} PROPERTY CXX_STANDARD_REQUIRED On)
if (MSVC)
target_compile_options(${target_name} PRIVATE
"/ZI" # Edit and continue support
"/MP" # Multi-threading support
"/W4" # Highest warning level
"/w44062" # enumerator 'identifier' in a switch of enum 'enumeration' is not handled
"/wd4127" # conditional expression is constant
"/wd4201" # nonstandard extension used : nameless struct/union
"/w44255" # 'function': no function prototype given: converting '()' to '(void)'
"/w44263" # 'function': member function does not override any base class virtual member function
"/w44264" # 'virtual_function': no override available for virtual member function from base 'class'; function is hidden
"/w44265" # 'class': class has virtual functions, but destructor is not virtual
"/w44266" # 'function': no override available for virtual member function from base 'type'; function is hidden
"/w44289" # nonstandard extension used : 'var' : loop control variable declared in the for-loop is used outside the for-loop scope
"/w44296" # 'operator': expression is always false
"/w44311" # 'variable' : pointer truncation from 'type' to 'type'
"/w44339" # 'type' : use of undefined type detected in CLR meta-data - use of this type may lead to a runtime exception
"/w44342" # behavior change: 'function' called, but a member operator was called in previous versions
"/w44350" # behavior change: 'member1' called instead of 'member2'
"/w44431" # missing type specifier - int assumed. Note: C no longer supports default-int
"/w44471" # a forward declaration of an unscoped enumeration must have an underlying type (int assumed)
"/wd4505" # unreferenced local function has been removed
"/w44545" # expression before comma evaluates to a function which is missing an argument list
"/w44546" # function call before comma missing argument list
"/w44547" # 'operator': operator before comma has no effect; expected operator with side-effect
"/w44548" # expression before comma has no effect; expected expression with side-effect
"/w44549" # 'operator': operator before comma has no effect; did you intend 'operator'?
"/w44555" # expression has no effect; expected expression with side-effect
"/w44574" # 'identifier' is defined to be '0': did you mean to use '#if identifier'?
"/w44608" # 'symbol1' has already been initialized by another union member in the initializer list, 'symbol2'
"/w44619" # #pragma warning: there is no warning number 'number'
"/w44628" # digraphs not supported with -Ze. Character sequence 'digraph' not interpreted as alternate token for 'char'
"/w44640" # 'instance': construction of local static object is not thread-safe
"/w44905" # wide string literal cast to 'LPSTR'
"/w44906" # string literal cast to 'LPWSTR'
"/w44946" # reinterpret_cast used between related classes: 'class1' and 'class2'
"/w44986" # 'symbol': exception specification does not match previous declaration
"/w44988" # 'symbol': variable declared outside class/function scope
"/std:c++latest"
"/permissive-"
"/Zc:strictStrings-" # Windows header don't adhere to this
)
target_compile_definitions(${target_name} PUBLIC "NOMINMAX")
if (OPENSPACE_WARNINGS_AS_ERRORS)
target_compile_options(${target_name} PUBLIC "/Wx")
endif ()
# Boost as of 1.64 still uses unary_function unless we define this
target_compile_definitions(${target_name} PRIVATE "_HAS_AUTO_PTR_ETC")
elseif (APPLE)
target_compile_definitions(${target_name} PUBLIC "__APPLE__")
target_compile_options(${target_name} PUBLIC "-stdlib=libc++")
if (OPENSPACE_WARNINGS_AS_ERRORS)
target_compile_options(${target_name} PUBLIC "-Werror")
endif ()
elseif (UNIX)
include (CheckCXXCompilerFlag)
CHECK_CXX_COMPILER_FLAG("-std=c++11" COMPILER_SUPPORTS_CXX11)
CHECK_CXX_COMPILER_FLAG("-std=c++0x" COMPILER_SUPPORTS_CXX0X)
mark_as_advanced(COMPILER_SUPPORTS_CXX11, COMPILER_SUPPORTS_CXX0X)
if (COMPILER_SUPPORTS_CXX11)
target_compile_options(${target_name} PUBLIC "-std=c++11")
elseif (COMPILER_SUPPORTS_CXX0X)
target_compile_options(${target_name} PUBLIC "-std=c++0x")
else ()
message(FATAL_ERROR "Compiler does not have C++11 support")
endif ()
target_compile_options(${target_name} PUBLIC "-ggdb" "-Wall" "-Wno-long-long" "-pedantic" "-Wextra")
if (OPENSPACE_WARNINGS_AS_ERRORS)
target_compile_options(${target_name} PUBLIC "-Werror")
endif ()
endif ()
endfunction ()
# Propagate the include directives from the libOpenSpace target into this module
function (set_openspace_settings target_name)
# Get the include directories from the OpenSpace library
get_property(
OPENSPACE_INCLUDE_DIR
TARGET libOpenSpace
PROPERTY INTERFACE_INCLUDE_DIRECTORIES
)
target_include_directories(${target_name} PUBLIC
"${OPENSPACE_BASE_DIR}"
${OPENSPACE_INCLUDE_DIR}
)
get_property(
OPENSPACE_DEFINES
TARGET libOpenSpace
PROPERTY INTERFACE_COMPILE_DEFINITIONS
)
target_compile_definitions(${target_name} PUBLIC ${OPENSPACE_DEFINES})
target_link_libraries(${target_name} Ghoul)
target_link_libraries(${target_name} libOpenSpace)
endfunction ()
# Loads the dependencies from 'include.cmake' and deals with them
function (handle_dependencies target_name module_name)
if (EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/include.cmake")
include(${CMAKE_CURRENT_SOURCE_DIR}/include.cmake)
# Handle OpenSpace dependencies
foreach (dep ${OPENSPACE_DEPENDENCIES})
create_library_name(${dep} dep_library)
message(STATUS "Link: ${target_name} <- ${dep_library}")
target_link_libraries(${target_name} ${dep_library})
get_property(
DEP_INCLUDE_DIR
TARGET ${dep_library}
PROPERTY INTERFACE_INCLUDE_DIRECTORIES
)
target_include_directories(${target_name} PUBLIC ${DEP_INCLUDE_DIR})
endforeach ()
# Handle extenal dependencies
foreach (dep ${EXTERNAL_DEPENDENCIES})
string(TOUPPER ${dep} dep_upper)
find_package(${dep} REQUIRED)
target_include_directories(${target_name} PUBLIC
${${dep_upper}_INCLUDE_DIR} ${${dep_upper}_INCLUDE_DIRS}
)
message(STATUS "Link: ${target_name} <- ${${dep_upper}_LIBRARIES}")
target_link_libraries(${target_name} ${${dep_upper}_LIBRARIES})
endforeach ()
endif ()
endfunction ()
# Writes the modulename.cmake containing the MODULE_NAME and MODULE_PATH
function (write_module_name module_name)
string(TOLOWER ${module_name} module_name_lower)
set(MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/${module_name_lower}module.h)
string(REPLACE "${OPENSPACE_BASE_DIR}/" "" MODULE_PATH ${MODULE_PATH})
file(WRITE ${CMAKE_BINARY_DIR}/modules/${module_name_lower}/modulename.cmake
"set(MODULE_NAME ${module_name}Module)\n"
"set(MODULE_PATH ${MODULE_PATH})"
)
endfunction ()