Lib/CMake/kll.cmake

   1 ###| CMAKE Kiibohd Controller KLL Configurator |###
   2 #
   3 # Written by Jacob Alexander in 2014-2015 for the Kiibohd Controller
   4 #
   5 # Released into the Public Domain
   6 #
   7 ###
   8
   9
  10 ###
  11 # Check if KLL compiler is needed
  12 #
  13
  14 if ( "${MacroModule}" STREQUAL "PartialMap" )
  15
  16
  17
  18 ###
  19 # KLL Installation (Make sure repo has been cloned)
  20 #
  21
  22 if ( NOT EXISTS "${PROJECT_SOURCE_DIR}/kll/kll.py" )
  23         message ( STATUS "Downloading latest kll version:" )
  24
  25         # Make sure git is available
  26         find_package ( Git REQUIRED )
  27
  28         # Clone kll git repo
  29         execute_process ( COMMAND ${GIT_EXECUTABLE} clone https://github.com/kiibohd/kll.git
  30                 WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
  31         )
  32 elseif ( REFRESH_KLL ) # Otherwise attempt to update the repo
  33         message ( STATUS "Checking for latest kll version:" )
  34
  35         # Clone kll git repo
  36         execute_process ( COMMAND ${GIT_EXECUTABLE} pull --rebase
  37                 WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/kll
  38         )
  39 endif () # kll/kll.py exists
  40
  41
  42
  43 ###
  44 # Prepare KLL layout arguments
  45 #
  46
  47 #| KLL_DEPENDS is used to build a dependency tree for kll.py, this way when files are changed, kll.py gets re-run
  48
  49 #| Add each of the detected capabilities.kll
  50 foreach ( filename ${ScanModule_KLL} ${MacroModule_KLL} ${OutputModule_KLL} ${DebugModule_KLL} )
  51         set ( BaseMap_Args ${BaseMap_Args} ${filename} )
  52         set ( KLL_DEPENDS ${KLL_DEPENDS} ${filename} )
  53 endforeach ()
  54
  55 #| If set BaseMap cannot be found, use default map
  56 set ( pathname "${PROJECT_SOURCE_DIR}/${ScanModulePath}" )
  57
  58 string ( REPLACE " " ";" MAP_LIST ${BaseMap} ) # Change spaces to semicolons
  59 foreach ( MAP ${MAP_LIST} )
  60         # Only check the Scan Module for BaseMap .kll files, default to defaultMap.kll
  61         if ( NOT EXISTS ${pathname}/${MAP}.kll )
  62                 set ( BaseMap_Args ${BaseMap_Args} ${pathname}/defaultMap.kll )
  63                 set ( KLL_DEPENDS ${KLL_DEPENDS} ${pathname}/defaultMap.kll )
  64         elseif ( EXISTS "${pathname}/${MAP}.kll" )
  65                 set ( BaseMap_Args ${BaseMap_Args} ${pathname}/${MAP}.kll )
  66                 set ( KLL_DEPENDS ${KLL_DEPENDS} ${pathname}/${MAP}.kll )
  67         else ()
  68                 message ( FATAL " Could not find '${MAP}.kll' BaseMap in Scan module directory" )
  69         endif ()
  70 endforeach ()
  71
  72 #| Configure DefaultMap if specified
  73 if ( NOT "${DefaultMap}" STREQUAL "" )
  74         set ( DefaultMap_Args -d )
  75
  76         string ( REPLACE " " ";" MAP_LIST ${DefaultMap} ) # Change spaces to semicolons
  77         foreach ( MAP ${MAP_LIST} )
  78                 # Check if kll file is in build directory, otherwise default to layout directory
  79                 if ( EXISTS "${PROJECT_BINARY_DIR}/${MAP}.kll" )
  80                         set ( DefaultMap_Args ${DefaultMap_Args} ${MAP}.kll )
  81                         set ( KLL_DEPENDS ${KLL_DEPENDS} ${PROJECT_BINARY_DIR}/${MAP}.kll )
  82                 elseif ( EXISTS "${PROJECT_SOURCE_DIR}/kll/layouts/${MAP}.kll" )
  83                         set ( DefaultMap_Args ${DefaultMap_Args} ${PROJECT_SOURCE_DIR}/kll/layouts/${MAP}.kll )
  84                         set ( KLL_DEPENDS ${KLL_DEPENDS} ${PROJECT_SOURCE_DIR}/kll/layouts/${MAP}.kll )
  85                 else ()
  86                         message ( FATAL " Could not find '${MAP}.kll' DefaultMap" )
  87                 endif ()
  88         endforeach ()
  89 endif ()
  90
  91 #| Configure PartialMaps if specified
  92 if ( NOT "${PartialMaps}" STREQUAL "" )
  93         # For each partial layer
  94         foreach ( MAP ${PartialMaps} )
  95                 set ( PartialMap_Args ${PartialMap_Args} -p )
  96
  97                 # Combine each layer
  98                 string ( REPLACE " " ";" MAP_LIST ${MAP} ) # Change spaces to semicolons
  99                 foreach ( MAP_PART ${MAP_LIST} )
 100                         # Check if kll file is in build directory, otherwise default to layout directory
 101                         if ( EXISTS "${PROJECT_BINARY_DIR}/${MAP_PART}.kll" )
 102                                 set ( PartialMap_Args ${PartialMap_Args} ${MAP_PART}.kll )
 103                                 set ( KLL_DEPENDS ${KLL_DEPENDS} ${PROJECT_BINARY_DIR}/${MAP_PART}.kll )
 104                         elseif ( EXISTS "${PROJECT_SOURCE_DIR}/kll/layouts/${MAP_PART}.kll" )
 105                                 set ( PartialMap_Args ${PartialMap_Args} ${PROJECT_SOURCE_DIR}/kll/layouts/${MAP_PART}.kll )
 106                                 set ( KLL_DEPENDS ${KLL_DEPENDS} ${PROJECT_SOURCE_DIR}/kll/layouts/${MAP_PART}.kll )
 107                         else ()
 108                                 message ( FATAL " Could not find '${MAP_PART}.kll' PartialMap" )
 109                         endif ()
 110                 endforeach ()
 111         endforeach ()
 112 endif ()
 113
 114
 115 #| Print list of layout sources used
 116 message ( STATUS "Detected Layout Files:" )
 117 foreach ( filename ${KLL_DEPENDS} )
 118         message ( "${filename}" )
 119 endforeach ()
 120
 121
 122
 123 ###
 124 # Run KLL Compiler
 125 #
 126
 127 #| KLL Options
 128 set ( kll_backend   --backend kiibohd )
 129 set ( kll_template  --templates ${PROJECT_SOURCE_DIR}/kll/templates/kiibohdKeymap.h ${PROJECT_SOURCE_DIR}/kll/templates/kiibohdDefs.h )
 130 set ( kll_outputname generatedKeymap.h kll_defs.h )
 131 set ( kll_output    --outputs ${kll_outputname} )
 132
 133 #| KLL Cmd
 134 set ( kll_cmd ${PROJECT_SOURCE_DIR}/kll/kll.py ${BaseMap_Args} ${DefaultMap_Args} ${PartialMap_Args} ${kll_backend} ${kll_template} ${kll_output} )
 135 add_custom_command ( OUTPUT ${kll_outputname}
 136         COMMAND ${kll_cmd}
 137         DEPENDS ${KLL_DEPENDS}
 138         COMMENT "Generating KLL Layout"
 139 )
 140
 141 #| KLL Regen Convenience Target
 142 add_custom_target ( kll_regen
 143         COMMAND ${kll_cmd}
 144         COMMENT "Re-generating KLL Layout"
 145 )
 146
 147 #| Append generated file to required sources so it becomes a dependency in the main build
 148 set ( SRCS ${SRCS} ${kll_outputname} )
 149
 150
 151
 152 endif () # PartialMap
 153