Archived
1
0
This repo is archived. You can view files and clone it, but cannot push or open issues or pull requests.
controller/Lib/CMake/modules.cmake

285 lines
7.1 KiB
CMake

###| CMAKE Kiibohd Controller Source Configurator |###
#
# Written by Jacob Alexander in 2011-2015 for the Kiibohd Controller
#
# Released into the Public Domain
#
###
###
# CMake Custom Modules Path
#
set ( CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/Lib/CMake/" )
###
# Module Overrides (Used in the buildall.bash script)
#
if ( ( DEFINED ScanModuleOverride ) AND ( EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/Scan/${ScanModuleOverride} ) )
set( ScanModule ${ScanModuleOverride} )
endif ()
###
# Path Setup
#
set( ScanModulePath "Scan/${ScanModule}" )
set( MacroModulePath "Macro/${MacroModule}" )
set( OutputModulePath "Output/${OutputModule}" )
set( DebugModulePath "Debug/${DebugModule}" )
#| Top-level directory adjustment
set( HEAD_DIR "${CMAKE_CURRENT_SOURCE_DIR}" )
###
# Module Check Function
#
function ( ModuleCompatibility ModulePath )
foreach ( mod_var ${ARGN} )
if ( ${mod_var} STREQUAL ${COMPILER_FAMILY} )
# Module found, no need to scan further
return()
endif ()
endforeach ()
message ( FATAL_ERROR "${ModulePath} does not support the ${COMPILER_FAMILY} family..." )
endfunction ()
###
# Module Processing
#
#| Go through lists of sources and append paths
#| Usage:
#| PathPrepend( OutputListOfSources <Prepend Path> <InputListOfSources> )
macro ( PathPrepend Output SourcesPath )
unset ( tmpSource )
# Loop through items
foreach ( item ${ARGN} )
# Set the path
set ( tmpSource ${tmpSource} "${SourcesPath}/${item}" )
endforeach ()
# Finalize by writing the new list back over the old one
set ( ${Output} ${tmpSource} )
endmacro ()
###
# Add Module Macro
#
# Optional Arg 1: Main Module Check, set to True/1 if adding a main module
function ( AddModule ModuleType ModuleName )
# Module path
set ( ModulePath ${ModuleType}/${ModuleName} )
set ( ModuleFullPath ${HEAD_DIR}/${ModuleType}/${ModuleName} )
# Include setup.cmake file
include ( ${ModuleFullPath}/setup.cmake )
# Check if this is a main module add
foreach ( extraArg ${ARGN} )
# Make sure this isn't a submodule
if ( DEFINED SubModule )
message ( FATAL_ERROR
"The '${ModuleName}' module is not a stand-alone module, and requires further setup."
)
endif ()
endforeach ()
# PathPrepend to give proper paths to each of the source files
PathPrepend ( Module_SRCS ${ModulePath} ${Module_SRCS} )
# Check the current scope to see if a sub-module added some source files
# Append each of the sources to each type of module srcs list
set ( ${ModuleType}_SRCS ${${ModuleType}_SRCS} ${Module_SRCS} )
# Add .h files
add_definitions ( -I${ModuleFullPath} )
# Check module compatibility
ModuleCompatibility( ${ModulePath} ${ModuleCompatibility} )
# Check if this is a main module add
foreach ( extraArg ${ARGN} )
# Display detected source files
if ( NOT DEFINED SubModule )
message ( STATUS "Detected ${ModuleType} Module Source Files:" )
message ( "${${ModuleType}_SRCS}" )
endif ()
endforeach ()
# Check for any capabilities.kll files in the Module
set ( kll_capabilities_file "${ModuleFullPath}/capabilities.kll" )
if ( EXISTS ${kll_capabilities_file} )
# Add the kll file and any submodule kll files to the running list
set ( ${ModuleType}Module_KLL ${${ModuleType}Module_KLL} ${kll_capabilities_file} )
endif ()
# Finally, add the sources and kll files to the parent scope (i.e. return)
set ( ${ModuleType}_SRCS ${${ModuleType}_SRCS} PARENT_SCOPE )
set ( ${ModuleType}Module_KLL ${${ModuleType}Module_KLL} PARENT_SCOPE )
endfunction ()
#| Add main modules
AddModule ( Scan ${ScanModule} 1 )
AddModule ( Macro ${MacroModule} 1 )
AddModule ( Output ${OutputModule} 1 )
AddModule ( Debug ${DebugModule} 1 )
###
# CMake Module Checking
#
find_package ( Git REQUIRED )
find_package ( Ctags ) # Optional
###
# Generate USB Defines
#
#| Manufacturer name
set ( MANUFACTURER "Kiibohd" )
#| Serial Number
#| Attempt to call Git to get the branch, last commit date, and whether code modified since last commit
#| Modified
#| Takes a bit of work to extract the "M " using CMake, and not using it if there are no modifications
execute_process ( COMMAND ${GIT_EXECUTABLE} status -s -uno --porcelain
WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
OUTPUT_VARIABLE Git_Modified_INFO
ERROR_QUIET
OUTPUT_STRIP_TRAILING_WHITESPACE
)
string ( LENGTH "${Git_Modified_INFO}" Git_Modified_LENGTH )
set ( Git_Modified_Status "Clean" )
if ( ${Git_Modified_LENGTH} GREATER 2 )
string ( SUBSTRING "${Git_Modified_INFO}" 1 2 Git_Modified_Flag_INFO )
set ( Git_Modified_Status "Dirty" )
endif ()
#| List of modified files
execute_process ( COMMAND ${GIT_EXECUTABLE} diff-index --name-only HEAD --
WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
OUTPUT_VARIABLE Git_Modified_Files
ERROR_QUIET
OUTPUT_STRIP_TRAILING_WHITESPACE
)
string ( REGEX REPLACE "\n" "\\\\r\\\\n\\\\t" Git_Modified_Files "${Git_Modified_Files}" )
set ( Git_Modified_Files "\\r\\n\\t${Git_Modified_Files}" )
#| Branch
execute_process( COMMAND ${GIT_EXECUTABLE} rev-parse --abbrev-ref HEAD
WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
OUTPUT_VARIABLE Git_Branch_INFO
ERROR_QUIET
OUTPUT_STRIP_TRAILING_WHITESPACE
)
#| Date
execute_process ( COMMAND ${GIT_EXECUTABLE} show -s --format=%ci
WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
OUTPUT_VARIABLE Git_Date_INFO
ERROR_QUIET
OUTPUT_STRIP_TRAILING_WHITESPACE
)
#| Commit Author and Email
execute_process ( COMMAND ${GIT_EXECUTABLE} show -s --format="%cn <%ce>"
WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
OUTPUT_VARIABLE Git_Commit_Author
ERROR_QUIET
OUTPUT_STRIP_TRAILING_WHITESPACE
)
#| Commit Revision
execute_process ( COMMAND ${GIT_EXECUTABLE} show -s --format=%H
WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
OUTPUT_VARIABLE Git_Commit_Revision
ERROR_QUIET
OUTPUT_STRIP_TRAILING_WHITESPACE
)
#| Origin URL
execute_process ( COMMAND ${GIT_EXECUTABLE} config --get remote.origin.url
WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
OUTPUT_VARIABLE Git_Origin_URL
ERROR_QUIET
OUTPUT_STRIP_TRAILING_WHITESPACE
)
#| Build Date
execute_process ( COMMAND "date" "+%Y-%m-%d %T %z"
OUTPUT_VARIABLE Build_Date
ERROR_QUIET
OUTPUT_STRIP_TRAILING_WHITESPACE
)
#| Last Commit Date
set ( GitLastCommitDate "${Git_Modified_Status} ${Git_Branch_INFO} - ${Git_Date_INFO}" )
#| Uses CMake variables to include as defines
#| Primarily for USB configuration
configure_file ( ${CMAKE_CURRENT_SOURCE_DIR}/Lib/_buildvars.h buildvars.h )
###
# Source Defines
#
set ( SRCS
${MAIN_SRCS}
${COMPILER_SRCS}
${Scan_SRCS}
${Macro_SRCS}
${Output_SRCS}
${Debug_SRCS}
)
#| Directories to include by default
include_directories ( ${CMAKE_CURRENT_SOURCE_DIR} ${CMAKE_CURRENT_BINARY_DIR} )
###
# ctag Generation
#
if ( CTAGS_EXECUTABLE )
# Populate list of directories for ctags to parse
# NOTE: Doesn't support dots in the folder names...
foreach ( filename ${SRCS} )
string ( REGEX REPLACE "/[a-zA-Z0-9_-]+.c$" "" pathglob ${filename} )
file ( GLOB filenames "${pathglob}/*.c" )
set ( CTAG_PATHS ${CTAG_PATHS} ${filenames} )
file ( GLOB filenames "${pathglob}/*.h" )
set ( CTAG_PATHS ${CTAG_PATHS} ${filenames} )
endforeach ()
# Generate the ctags
execute_process ( COMMAND ctags ${CTAG_PATHS}
WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
)
endif ()