Renaming macros to common.

Change-Id: I5f4085718afa7519ec2ec67566e3685d36412f27
Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>

1 files changed, 336 insertions, 0 deletions

diff --git a/default/cmake/common.cmake b/default/cmake/common.cmake
new file mode 100644
index 0000000..9650ad0
--- /dev/null
+++ b/default/cmake/common.cmake
@@ -0,0 +1,336 @@
+###########################################################################
+# Copyright 2015, 2016, 2017 IoT.bzh
+#
+# author: Fulup Ar Foll <fulup@iot.bzh>
+# contrib: Romain Forlot <romain.forlot@iot.bzh>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+###########################################################################
+
+
+#--------------------------------------------------------------------------
+#  WARNING:
+#     Do not change this cmake template
+#     Customise your preferences in "./etc/config.cmake"
+#--------------------------------------------------------------------------
+
+# Get colorized message output non Windows OS. You know bash ? :)
+if(NOT WIN32)
+  string(ASCII 27 Esc)
+  set(ColourReset "${Esc}[m")
+  set(ColourBold  "${Esc}[1m")
+  set(Red         "${Esc}[31m")
+  set(Green       "${Esc}[32m")
+  set(Yellow      "${Esc}[33m")
+  set(Blue        "${Esc}[34m")
+  set(Magenta     "${Esc}[35m")
+  set(Cyan        "${Esc}[36m")
+  set(White       "${Esc}[37m")
+  set(BoldRed     "${Esc}[1;31m")
+  set(BoldGreen   "${Esc}[1;32m")
+  set(BoldYellow  "${Esc}[1;33m")
+  set(BoldBlue    "${Esc}[1;34m")
+  set(BoldMagenta "${Esc}[1;35m")
+  set(BoldCyan    "${Esc}[1;36m")
+  set(BoldWhite   "${Esc}[1;37m")
+endif()
+
+# Generic useful macro
+# -----------------------
+macro(PROJECT_TARGET_ADD TARGET_NAME)
+	set_property(GLOBAL APPEND PROPERTY PROJECT_TARGETS ${TARGET_NAME})
+	set(TARGET_NAME ${TARGET_NAME})
+endmacro(PROJECT_TARGET_ADD)
+
+# Check GCC minimal version version
+if (gcc_minimal_version)
+	message (STATUS "${Blue}-- Check gcc_minimal_version (found gcc version ${CMAKE_C_COMPILER_VERSION})  (found g++ version ${CMAKE_CXX_COMPILER_VERSION})${ColourReset}")
+if (CMAKE_CXX_COMPILER_VERSION VERSION_LESS ${gcc_minimal_version} OR CMAKE_C_COMPILER_VERSION VERSION_LESS ${gcc_minimal_version})
+	message(FATAL_ERROR "${Red}**** FATAL: Require at least gcc-${gcc_minimal_version} please set CMAKE_C[XX]_COMPILER")
+endif()
+endif(gcc_minimal_version)
+
+macro(defstr name value)
+	add_definitions(-D${name}=${value})
+endmacro(defstr)
+
+# WGT packaging
+macro(project_targets_populate)
+	# Default Widget default directory
+	set(PACKAGE_BINDIR  ${PROJECT_PKG_DIR}/bin)
+	set(PACKAGE_ETCDIR  ${PROJECT_PKG_DIR}/etc)
+	set(PACKAGE_LIBDIR  ${PROJECT_PKG_DIR}/lib)
+	set(PACKAGE_HTTPDIR ${PROJECT_PKG_DIR}/htdocs)
+	set(PACKAGE_DATADIR ${PROJECT_PKG_DIR}/data)
+
+	add_custom_target(populate)
+	get_property(PROJECT_TARGETS GLOBAL PROPERTY PROJECT_TARGETS)
+	foreach(TARGET ${PROJECT_TARGETS})
+		get_target_property(T ${TARGET} LABELS)
+		if(T)
+			# Declaration of a custom command that will populate widget tree with the target
+			set(POPULE_PACKAGE_TARGET "project_populate_${TARGET}")
+
+			get_target_property(P ${TARGET} PREFIX)
+			get_target_property(BD ${TARGET} BINARY_DIR)
+			get_target_property(OUT ${TARGET} OUTPUT_NAME)
+
+			if(P MATCHES "NOTFOUND$")
+				if (${T} STREQUAL "BINDING")
+					set(P "lib")
+				else()
+					set(P "")
+				endif()
+			endif()
+
+			if(${T} STREQUAL "BINDING")
+				add_custom_command(OUTPUT ${PACKAGE_LIBDIR}/${P}${TARGET}.so
+					DEPENDS ${TARGET}
+					COMMAND mkdir -p ${PACKAGE_LIBDIR}
+					COMMAND cp ${BD}/${P}${OUT}.so ${PACKAGE_LIBDIR}
+				)
+				add_custom_target(${POPULE_PACKAGE_TARGET} DEPENDS ${PACKAGE_LIBDIR}/${P}${TARGET}.so)
+				add_dependencies(populate ${POPULE_PACKAGE_TARGET}) 
+			elseif(${T} STREQUAL "EXECUTABLE")
+				add_custom_command(OUTPUT ${PACKAGE_BINDIR}/${P}${TARGET}
+					DEPENDS ${TARGET}
+					COMMAND mkdir -p ${PACKAGE_BINDIR}
+					COMMAND cp ${BD}/${P}${OUT} ${PACKAGE_BINDIR}
+				)
+				add_custom_target(${POPULE_PACKAGE_TARGET} DEPENDS ${PACKAGE_BINDIR}/${P}${TARGET})
+				add_dependencies(populate ${POPULE_PACKAGE_TARGET}) 
+			elseif(${T} STREQUAL "HTDOCS")
+				add_custom_command(OUTPUT ${PACKAGE_HTTPDIR}
+					DEPENDS ${TARGET}
+					COMMAND mkdir -p ${PROJECT_PKG_DIR}/${PACKAGE_HTTPDIR}
+					COMMAND cp -r ${BD}/${P}${OUT}/* ${PACKAGE_HTTPDIR}
+					)
+					add_custom_target(${POPULE_PACKAGE_TARGET} DEPENDS ${PACKAGE_HTTPDIR})
+					add_dependencies(populate ${POPULE_PACKAGE_TARGET}) 
+			elseif(${T} STREQUAL "DATA")
+				add_custom_command(OUTPUT ${PACKAGE_DATADIR}
+					DEPENDS ${TARGET}
+					COMMAND mkdir -p ${PROJECT_PKG_DIR}/${PACKAGE_DATADIR}
+					COMMAND cp -r ${BD}/${P}${OUT}/* ${PACKAGE_DATADIR}
+					)
+					add_custom_target(${POPULE_PACKAGE_TARGET} DEPENDS ${PACKAGE_DATADIR})
+					add_dependencies(populate ${POPULE_PACKAGE_TARGET}) 
+			endif(${T} STREQUAL "BINDING")
+#		elseif(${CMAKE_BUILD_TYPE} MATCHES "[Dd][Ee][Bb][Uu][Gg]")
+#					MESSAGE(WARNING "This target, ${TARGET}, will be not be included in the package.")
+		endif()
+	endforeach()
+endmacro(project_targets_populate)
+
+macro(wgt_package_build)
+	if(NOT EXISTS ${TEMPLATE_WGT_DIR}/config.xml.in OR NOT EXISTS ${TEMPLATE_WGT_DIR}/${PROJECT_ICON})
+		MESSAGE(SEND_ERROR "${Red}WARNING ! Missing mandatory files to build widget file.\nYou need config.xml.in and ${PROJECT_ICON} files in ${TEMPLATE_WGT_DIR} folder.${ColourReset}")
+	else()
+		# Build widget spec file from template only once (Fulup good idea or should depend on time ????)
+		if(NOT EXISTS ${TEMPLATE_WGT_DIR}/config.xml.in OR NOT EXISTS ${TEMPLATE_WGT_DIR}/${PROJECT_ICON})
+				configure_file(${TEMPLATE_WGT_DIR}/config.xml.in ${PROJECT_PKG_DIR}/config.xml)
+				file(COPY ${TEMPLATE_WGT_DIR}/${PROJECT_ICON} DESTINATION ${PROJECT_PKG_DIR}/${PROJECT_ICON})
+		endif(NOT EXISTS ${TEMPLATE_WGT_DIR}/config.xml.in OR NOT EXISTS ${TEMPLATE_WGT_DIR}/${PROJECT_ICON})
+
+		# Fulup ??? copy any extra file in wgt/etc into populate package before building the widget
+		file(GLOB PROJECT_CONF_FILES "${TEMPLATE_WGT_DIR}/etc/*")
+		if(${PROJECT_CONF_FILES})
+				file(COPY "${TEMPLATE_WGT_DIR}/etc/*" DESTINATION ${PROJECT_PKG_DIR}/etc/)
+		endif(${PROJECT_CONF_FILES})
+
+		add_custom_command(OUTPUT ${PROJECT_NAME}.wgt
+				DEPENDS ${PROJECT_TARGETS}
+				COMMAND wgtpkg-pack -f -o ${PROJECT_NAME}.wgt ${PROJECT_PKG_DIR}
+		)
+
+		add_custom_target(widget DEPENDS ${PROJECT_NAME}.wgt)
+		add_dependencies(widget populate)
+		set(ADDITIONAL_MAKE_CLEAN_FILES, "${PROJECT_NAME}.wgt")
+
+		if(PACKAGE_MESSAGE)
+		add_custom_command(TARGET widget
+				POST_BUILD
+				COMMAND ${CMAKE_COMMAND} -E cmake_echo_color --cyan "++ ${PACKAGE_MESSAGE}")
+		endif()
+	endif()
+endmacro(wgt_package_build)
+
+macro(rpm_package_build)
+	if(NOT EXISTS ${PROJECT_RPM_DIR}/config.spec.in)
+			MESSAGE(STATUS "Missing mandatory files: you need config.spec.in in ${PROJECT_RPM_DIR} folder.")
+	else()
+		# extract PROJECT_PKG_DEPS and replace ; by , for RPM spec file
+		get_property(PROJECT_PKG_DEPS GLOBAL PROPERTY PROJECT_PKG_DEPS)
+		foreach (PKFCONF ${PROJECT_PKG_DEPS})
+		set(RPM_PKG_DEPS "${RPM_PKG_DEPS}, pkgconfig(${PKFCONF})")
+		endforeach()
+
+		# build rpm spec file from template
+		configure_file(${PROJECT_RPM_DIR}/config.spec.in ${PROJECT_PKG_DIR}/config.spec)
+
+		add_custom_command(OUTPUT ${PROJECT_NAME}.spec
+				DEPENDS ${PROJECT_TARGETS}
+				COMMAND rpmbuild -ba  ${PROJECT_PKG_DIR}/config.spec
+		)
+
+		add_custom_target(rpm DEPENDS ${PROJECT_NAME}.spec)
+		add_dependencies(rpm populate)
+		set(ADDITIONAL_MAKE_CLEAN_FILES, "${PROJECT_NAME}.spec")
+
+		if(PACKAGE_MESSAGE)
+		add_custom_command(TARGET rpm
+				POST_BUILD
+				COMMAND ${CMAKE_COMMAND} -E cmake_echo_color --cyan "++ ${PACKAGE_MESSAGE}")
+		endif()
+	endif()
+endmacro(rpm_package_build)
+
+macro(project_package_build)
+	if(EXISTS ${TEMPLATE_RPM_DIR})
+		rpm_package_build()
+	endif()
+
+	if(EXISTS ${TEMPLATE_WGT_DIR})
+		wgt_package_build()
+	endif()
+
+	if(EXISTS ${TEMPLATE_DEB_DIR})
+		deb_package_build()
+	endif()
+endmacro(project_package_build)
+
+macro(project_subdirs_add)
+	if(${ARGV0})
+		file(GLOB filelist "${ARGV0}")
+	else()
+		file(GLOB filelist "*")
+	endif(${ARGV0})
+
+	foreach(filename ${filelist})
+		if(EXISTS "${filename}/CMakeLists.txt")
+			add_subdirectory(${filename})
+		endif(EXISTS "${filename}/CMakeLists.txt")
+	endforeach()
+endmacro(project_subdirs_add)
+
+set(CMAKE_BUILD_TYPE Debug CACHE STRING "the type of build")
+set(CMAKE_POSITION_INDEPENDENT_CODE ON)
+set(CMP0048 1)
+
+# Include project configuration
+# ------------------------------
+project(${PROJECT_NAME} VERSION ${PROJECT_VERSION} LANGUAGES ${PROJECT_LANGUAGES})
+set(PROJECT_LIBDIR "${CMAKE_SOURCE_DIR}/libs" CACHE PATH "Subpath to libraries")
+set(PROJECT_RESOURCES "${CMAKE_SOURCE_DIR}/data" CACHE PATH "Subpath to data")
+
+INCLUDE(FindPkgConfig)
+INCLUDE(CheckIncludeFiles)
+INCLUDE(CheckLibraryExists)
+INCLUDE(GNUInstallDirs)
+
+# Default compilation options
+############################################################################
+link_libraries(-Wl,--as-needed -Wl,--gc-sections)
+add_compile_options(-Wall -Wextra -Wconversion)
+add_compile_options(-Wno-unused-parameter) # frankly not using a parameter does it care?
+add_compile_options(-Wno-sign-compare -Wno-sign-conversion)
+add_compile_options(-Werror=maybe-uninitialized)
+add_compile_options(-Werror=implicit-function-declaration)
+add_compile_options(-ffunction-sections -fdata-sections)
+add_compile_options(-fPIC)
+add_compile_options(-g)
+
+set(CMAKE_C_FLAGS_PROFILING   "-g -O2 -pg -Wp,-U_FORTIFY_SOURCE" CACHE STRING "Flags for profiling")
+set(CMAKE_C_FLAGS_DEBUG       "-g -O2 -ggdb -Wp,-U_FORTIFY_SOURCE" CACHE STRING "Flags for debugging")
+set(CMAKE_C_FLAGS_RELEASE     "-O2" CACHE STRING "Flags for releasing")
+set(CMAKE_C_FLAGS_CCOV        "-g -O2 --coverage" CACHE STRING "Flags for coverage test")
+
+set(CMAKE_CXX_FLAGS_PROFILING    "-g -O0 -pg -Wp,-U_FORTIFY_SOURCE")
+set(CMAKE_CXX_FLAGS_DEBUG        "-g -O0 -ggdb -Wp,-U_FORTIFY_SOURCE")
+set(CMAKE_CXX_FLAGS_RELEASE      "-g -O2")
+set(CMAKE_CXX_FLAGS_CCOV "-g -O2 --coverage")
+
+set(CMAKE_INSTALL_PREFIX      "${CMAKE_SOURCE_DIR}/Install" CACHE PATH "The path where to install")
+
+# (BUG!!!) as PKG_CONFIG_PATH does not work [should be en env variable]
+set(PKG_CONFIG_USE_CMAKE_PREFIX_PATH ON CACHE BOOLEAN "Flag for using prefix path")
+
+# Loop on required package and add options
+foreach (PKG_CONFIG ${PKG_REQUIRED_LIST})
+	string(REGEX REPLACE "[<>]?=.*$" "" XPREFIX ${PKG_CONFIG})
+	PKG_CHECK_MODULES(${XPREFIX} REQUIRED ${PKG_CONFIG})
+
+	INCLUDE_DIRECTORIES(${${XPREFIX}_INCLUDE_DIRS})
+	list (APPEND link_libraries ${${XPREFIX}_LIBRARIES})
+	add_compile_options (${${XPREFIX}_CFLAGS})
+endforeach(PKG_CONFIG)
+
+# Optional LibEfence Malloc debug library
+IF(CMAKE_BUILD_TYPE MATCHES DEBUG)
+CHECK_LIBRARY_EXISTS(efence malloc "" HAVE_LIBEFENCE)
+IF(HAVE_LIBEFENCE)
+	MESSAGE(STATUS "Linking with ElectricFence for debugging purposes...")
+	SET(libefence_LIBRARIES "-lefence")
+	list (APPEND link_libraries ${libefence_LIBRARIES})
+ENDIF(HAVE_LIBEFENCE)
+ENDIF(CMAKE_BUILD_TYPE MATCHES DEBUG)
+
+# set default include directories
+INCLUDE_DIRECTORIES(${EXTRA_INCLUDE_DIRS})
+
+# If no install dir try to guess some smart default
+if(BINDINGS_INSTALL_PREFIX)
+	set(BINDINGS_INSTALL_DIR ${BINDINGS_INSTALL_PREFIX}/${PROJECT_NAME} CACHE PATH "Where the binding will be installed in your system")
+else()
+	set(BINDINGS_INSTALL_DIR ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME} CACHE PATH "Where the binding will be installed in your system")
+endif()
+
+# Define a default package directory
+if(PACKAGE_PREFIX)
+	set(PROJECT_PKG_DIR ${PKG_PREFIX}/package CACHE PATH "Where the package will be built.")
+else()
+	set(PROJECT_PKG_DIR ${CMAKE_CURRENT_BINARY_DIR}/package CACHE PATH "Where the package will be built")
+endif()
+
+set (PKG_TEMPLATE_PREFIX ${CMAKE_SOURCE_DIR}/etc CACHE PATH "Default Package Templates Directory")
+set(TEMPLATE_WGT_DIR "${CMAKE_SOURCE_DIR}/conf.d/app-templates/wgt" CACHE PATH "Subpath to a directory where are stored needed files to build widget")
+set(TEMPLATE_RPM_DIR "${CMAKE_SOURCE_DIR}/conf.d/app-templates/rpm" CACHE PATH "Subpath to a directory where are stored needed files to build rpm package")
+set(TEMPLATE_DEB_DIR "${CMAKE_SOURCE_DIR}/conf.d/app-templates/deb" CACHE PATH "Subpath to a directory where are stored needed files to build deb package")
+
+# Default Linkflag
+if(NOT BINDINGS_LINK_FLAG)
+	set(BINDINGS_LINK_FLAG "-Wl,--version-script=${CMAKE_SOURCE_DIR}/conf.d/app-templates/cmake/export.map")
+endif()
+
+# Add a dummy target to enable global dependency order
+# -----------------------------------------------------
+if(EXTRA_DEPENDENCIES_ORDER)
+	set(DEPENDENCIES_TARGET ${PROJECT_NAME}_extra_dependencies)
+	add_custom_target(${DEPENDENCIES_TARGET} ALL
+		DEPENDS ${EXTRA_DEPENDENCY_ORDER}
+	)
+endif()
+
+# Print developer helper message when build is done
+# -------------------------------------------------------
+macro(project_closing_msg)
+	get_property(PROJECT_TARGETS_SET GLOBAL PROPERTY PROJECT_TARGETS SET)
+	get_property(PROJECT_TARGETS GLOBAL PROPERTY PROJECT_TARGETS)
+	if(CLOSING_MESSAGE AND ${PROJECT_TARGETS_SET})
+		add_custom_target(${PROJECT_NAME}_build_done ALL
+			COMMAND ${CMAKE_COMMAND} -E cmake_echo_color --cyan "++ ${CLOSING_MESSAGE}"
+		)
+		 add_dependencies(${PROJECT_NAME}_build_done
+		 	${DEPENDENCIES_TARGET} ${PROJECT_TARGETS})
+	endif()
+endmacro()