]> git.donarmstrong.com Git - kiibohd-controller.git/blobdiff - setup.cmake
Major code cleanup and preparation for PartialMap Macro Module
[kiibohd-controller.git] / setup.cmake
index a47e9157a9ad1bc2a62337b777267e9fb0b1c742..92afafcb1ddfd5aa82b832bd247169b4d523486f 100644 (file)
@@ -1,6 +1,6 @@
 ###| CMAKE Kiibohd Controller Source Configurator |###
 #
-# Written by Jacob Alexander in 2011 for the Kiibohd Controller
+# Written by Jacob Alexander in 2011-2014 for the Kiibohd Controller
 #
 # Released into the Public Domain
 #
 # Project Modules
 #
 
+#| Note: This is the only section you probably want to modify
 #| Each module is defined by it's own folder (e.g. Scan/Matrix represents the "Matrix" module)
 #| All of the modules must be specified, as they generate the sources list of files to compile
 #| Any modifications to this file will cause a complete rebuild of the project
 
-#| Please the {Scan,Macro,USB,Debug}/module.txt for information on the modules and how to create new ones
+#| Please look at the {Scan,Macro,USB,Debug}/module.txt for information on the modules and how to create new ones
 
 ##| Deals with acquiring the keypress information and turning it into a key index
-set(  ScanModule  "matrix" )
+set(   ScanModule "SKM67001" )
 
-##| Uses the key index and potentially applies special conditions to it, mapping it to a usb key code
-set( MacroModule  "basic"  )
+##| Provides the mapping functions for DefaultMap and handles any macro processing before sending to the OutputModule
+set(  MacroModule "PartialMap" )
 
 ##| Sends the current list of usb key codes through USB HID
-set(   USBModule  "pjrc"   )
+set( OutputModule "pjrcUSB" )
 
 ##| Debugging source to use, each module has it's own set of defines that it sets
-set( DebugModule  "basic"  )
+set(  DebugModule "full" )
+
+
+
+###
+# Keymap Configuration
+#
+
+##| If there are multiple DefaultMaps, it is defined here. If, the specified DefaultMap is not found, defaultMap.h is used.
+set(   DefaultMap "kishsaver" )
+
+##| PartialMap combined keymap layering. The first keymap has the "least" precedence.
+set(  CombinedMap colemak capslock2ctrl )
+
+##| ParitalMaps available on top of the CombinedMap. If there are input conflicts, the last PartialMap takes precedence.
+set(  PartialMaps hhkbnav kbdctrl )
+
+##| MacroSets define extra capabilities that are not provided by the Scan or Output modules. Last MacroSet takes precedence.
+set(    MacroSets retype )
+
+
+###
+# 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(   USBModulePath   "USB/${USBModule}"   )
-set( DebugModulePath "Debug/${DebugModule}" )
+#
+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
+#
+
+#| Usage:
+#|  PathPrepend( ModulePath <ListOfFamiliesSupported> )
+#| Uses the ${COMPILER_FAMILY} variable
+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()
 
 
 
@@ -50,13 +99,14 @@ set( DebugModulePath "Debug/${DebugModule}" )
 #| Additional options, usually define settings
 add_definitions()
 
-#| Include path for each of the modules TODO Fixme!! (../)
-add_definitions("
-       -I../${ScanModulePath}
-       -I../${MacroModulePath}
-       -I../${USBModulePath}
-       -I../${DebugModulePath}
-")
+#| Include path for each of the modules
+add_definitions(
+       -I${HEAD_DIR}/${ScanModulePath}
+       -I${HEAD_DIR}/${MacroModulePath}
+       -I${HEAD_DIR}/${OutputModulePath}
+       -I${HEAD_DIR}/${DebugModulePath}
+)
+
 
 
 
@@ -72,38 +122,143 @@ macro( PathPrepend Output SourcesPath )
 
        # Loop through items
        foreach( item ${ARGN} )
+               # Set the path
                set( tmpSource ${tmpSource} "${SourcesPath}/${item}" )
-       endforeach( item )
+       endforeach()
 
        # Finalize by writing the new list back over the old one
        set( ${Output} ${tmpSource} )
-endmacro( PathPrepend )
+endmacro()
 
 
 #| Scan Module
-include(  "${ScanModulePath}/setup.cmake" )
-PathPrepend( SCAN_SRCS ${ScanModulePath} ${SCAN_SRCS} )
+include    (            "${ScanModulePath}/setup.cmake"  )
+PathPrepend(  SCAN_SRCS  ${ScanModulePath} ${SCAN_SRCS}  )
 
 #| Macro Module
-include( "${MacroModulePath}/setup.cmake" )
+include    (           "${MacroModulePath}/setup.cmake"  )
 PathPrepend( MACRO_SRCS ${MacroModulePath} ${MACRO_SRCS} )
 
-#| USB Module
-include(   "${USBModulePath}/setup.cmake" )
-PathPrepend( USB_SRCS ${USBModulePath} ${USB_SRCS} )
+#| Output Module
+include    (             "${OutputModulePath}/setup.cmake"   )
+PathPrepend( OUTPUT_SRCS  ${OutputModulePath} ${OUTPUT_SRCS} )
 
 #| Debugging Module
-include( "${DebugModulePath}/setup.cmake" )
+include    (           "${DebugModulePath}/setup.cmake"  )
 PathPrepend( DEBUG_SRCS ${DebugModulePath} ${DEBUG_SRCS} )
 
 
+#| Default Map
+# TODO Add support for different defaultMaps
+configure_file( "${ScanModulePath}/defaultMap.h" defaultMap.h )
+
+
 #| Print list of all module sources
-message( STATUS "Detected Scan Module Source Files:
-${SCAN_SRCS}")
-message( STATUS "Detected Macro Module Source Files:
-${MACRO_SRCS}")
-message( STATUS "Detected USB Module Source Files:
-${USB_SRCS}")
-message( STATUS "Detected Debug Module Source Files:
-${DEBUG_SRCS}")
+message( STATUS "Detected Scan Module Source Files:" )
+message( "${SCAN_SRCS}" )
+message( STATUS "Detected Macro Module Source Files:" )
+message( "${MACRO_SRCS}" )
+message( STATUS "Detected Output Module Source Files:" )
+message( "${OUTPUT_SRCS}" )
+message( STATUS "Detected Debug Module Source Files:" )
+message( "${DEBUG_SRCS}" )
+
+
+
+###
+# 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 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 ()
+
+#| Branch
+execute_process( COMMAND git 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 show -s --format=%ci
+       WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
+       OUTPUT_VARIABLE Git_Date_INFO
+       RESULT_VARIABLE Git_RETURN
+       ERROR_QUIET
+       OUTPUT_STRIP_TRAILING_WHITESPACE
+)
+
+#| Commit Author and Email
+execute_process( COMMAND git show -s --format="%cn <%ce>"
+       WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
+       OUTPUT_VARIABLE Git_Commit_Author
+       RESULT_VARIABLE Git_RETURN
+       ERROR_QUIET
+       OUTPUT_STRIP_TRAILING_WHITESPACE
+)
+
+#| Commit Revision
+execute_process( COMMAND git show -s --format=%H
+       WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
+       OUTPUT_VARIABLE Git_Commit_Revision
+       RESULT_VARIABLE Git_RETURN
+       ERROR_QUIET
+       OUTPUT_STRIP_TRAILING_WHITESPACE
+)
+
+#| Origin URL
+execute_process( COMMAND git config --get remote.origin.url
+       WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
+       OUTPUT_VARIABLE Git_Origin_URL
+       RESULT_VARIABLE Git_RETURN
+       ERROR_QUIET
+       OUTPUT_STRIP_TRAILING_WHITESPACE
+)
+
+#| Date Macro
+macro ( dateNow RESULT )
+       if ( WIN32 )
+               execute_process( COMMAND "cmd" " /C date /T" OUTPUT_VARIABLE ${RESULT} OUTPUT_STRIP_TRAILING_WHITESPACE )
+       elseif ( UNIX )
+               execute_process( COMMAND "date" "+%Y-%m-%d %T %z" OUTPUT_VARIABLE ${RESULT} OUTPUT_STRIP_TRAILING_WHITESPACE )
+       else ()
+               message( send_error "date not implemented" )
+               set( ${RESULT} 000000 )
+       endif ()
+endmacro (dateNow)
+dateNow( Build_Date )
+
+
+#| Only use Git variables if we were successful in calling the commands
+if ( ${Git_RETURN} EQUAL 0 )
+       set( GitLastCommitDate "${Git_Modified_Flag_INFO}${Git_Branch_INFO} - ${Git_Date_INFO}" )
+else ()
+       # TODO Figure out a good way of finding the current branch + commit date + modified
+       set( GitLastCommitDate "Pft...Windows Build" )
+endif ()
+
+
+#| Uses CMake variables to include as defines
+#| Primarily for USB configuration
+configure_file( ${CMAKE_CURRENT_SOURCE_DIR}/Lib/_buildvars.h buildvars.h )