Переглянути джерело

basic json validator supporting most used properties. converted some regex to cmake-compatible expressions

Jack Humbert 3 роки тому
батько
коміт
2ebad0d33f

+ 3 - 1
CMakeLists.txt

@@ -31,7 +31,9 @@ while(NOT ${QMK_KEYBOARD_CURRENT_FOLDER} STREQUAL "")
 endwhile()
 
 # would be nice to also do validation here
-file(READ keyboards/${QMK_KEYBOARD_FOLDER}/info.json QMK_KEYBOARD_INFO_JSON_STRING)
+include(ValidateJSON)
+validate_json(keyboards/${QMK_KEYBOARD_FOLDER}/info.json keyboard QMK_KEYBOARD_INFO_JSON_STRING)
+
 string(JSON KEYBOARD_NAME GET ${QMK_KEYBOARD_INFO_JSON_STRING} keyboard_name)
 string(JSON MANUFACTURER GET ${QMK_KEYBOARD_INFO_JSON_STRING} manufacturer)
 string(JSON URL GET ${QMK_KEYBOARD_INFO_JSON_STRING} url)

+ 5 - 2
cmake/AddKeyboard.cmake

@@ -27,8 +27,11 @@ macro(add_keyboard KEYBOARD_FOLDER KEYMAP_FOLDER)
   endif()
 
   # find the right toolchain
-  message(STATUS "Reading config from ${KEYBOARD_FOLDER_ABS}/info.json")
-  file(READ ${KEYBOARD_FOLDER_ABS}/info.json JSON_STRING)
+  
+  # not sure we need to validate here
+  include(ValidateJSON)
+  validate_json(${KEYBOARD_FOLDER_ABS}/info.json keyboard JSON_STRING)
+
   string(JSON PROCESSOR GET ${JSON_STRING} processor)
   if(${PROCESSOR} MATCHES "^at.*")
     set(PLATFORM "avr")

+ 2 - 2
cmake/FindARMToolchain.cmake

@@ -58,6 +58,6 @@ macro(find_arm_toolchain)
     endif()
 
     set(TOOLCHAIN_ROOT ${ARM_TOOLCHAIN_ROOT})
-    message("ARM toolchain found: ${ARM_TOOLCHAIN_ROOT}")
-    message("Found make: ${MAKE_ROOT}")
+    message(STATUS "ARM toolchain found: ${ARM_TOOLCHAIN_ROOT}")
+    message(STATUS "Found make: ${MAKE_ROOT}")
 endmacro()

+ 2 - 2
cmake/FindAVRToolchain.cmake

@@ -57,6 +57,6 @@ macro(find_avr_toolchain)
     endif()
 
     set(TOOLCHAIN_ROOT ${AVR_TOOLCHAIN_ROOT})
-    message("AVR toolchain found: ${AVR_TOOLCHAIN_ROOT}")
-    message("Found make: ${MAKE_ROOT}")
+    message(STATUS "AVR toolchain found: ${AVR_TOOLCHAIN_ROOT}")
+    message(STATUS "Found make: ${MAKE_ROOT}")
 endmacro()

+ 199 - 0
cmake/ValidateJson.cmake

@@ -0,0 +1,199 @@
+function(validate_json JSON_FILE SCHEMA_NAME JSON_STRING_STR)
+  unset(${JSON_STRING_STR} PARENT_SCOPE)
+  message(STATUS "Validating ${JSON_FILE} with '${SCHEMA_NAME}' schema")
+  file(READ ${JSON_FILE} JSON_STRING)
+  file(READ ${CMAKE_SOURCE_DIR}/data/schemas/${SCHEMA_NAME}.jsonschema SCHEMA_STRING)
+  string(JSON SCHEMA_ID GET ${SCHEMA_STRING} $id)
+
+  set(DEFINITIONS "{}")
+  file(READ ${CMAKE_SOURCE_DIR}/data/schemas/definitions.jsonschema DEFINITIONS_STRING)
+  string(JSON DEFINITION_ID GET ${DEFINITIONS_STRING} $id)
+  string(JSON DEFINITIONS SET ${DEFINITIONS} "${DEFINITION_ID}#" ${DEFINITIONS_STRING})
+
+  string(JSON SCHEMA_DEFINITIONS ERROR_VARIABLE JSON_ERROR GET ${SCHEMA_STRING} definitions)
+  if(${JSON_ERROR} STREQUAL "NOTFOUND")
+    string(JSON DEFINITIONS SET ${DEFINITIONS} "#" "{}")
+    string(JSON DEFINITIONS SET ${DEFINITIONS} "#" definitions ${SCHEMA_DEFINITIONS})
+    # string(JSON DEFINITIONS_LENGTH LENGTH ${SCHEMA_DEFINITIONS})
+    # math(EXPR MAX "${DEFINITIONS_LENGTH} - 1")
+    # foreach(IDX RANGE ${MAX})
+    #   string(JSON DEFINITION_NAME MEMBER ${SCHEMA_DEFINITIONS} ${IDX})
+    #   string(JSON DEFINITION GET ${SCHEMA_DEFINITIONS} ${DEFINITION_NAME})
+    #   message(DEBUG "Loading local definition '${DEFINITION_NAME}'")
+    #   string(JSON DEFINITIONS_STRING SET ${DEFINITIONS_STRING} ${DEFINITION_NAME} ${DEFINITION})
+    # endforeach()
+  endif()
+  
+  validate_object(${JSON_STRING} ${SCHEMA_STRING} OBJECT_ERROR)
+  if(DEFINED OBJECT_ERROR)
+    message(FATAL_ERROR ${OBJECT_ERROR})
+  else()
+    set(${JSON_STRING_STR} ${JSON_STRING} PARENT_SCOPE)
+  endif()
+endfunction()
+
+function(validate_object JSON_STRING SCHEMA_STRING OBJECT_ERROR_STR)
+  unset(${OBJECT_ERROR_STR} PARENT_SCOPE)
+  set(OBJECT_ERROR)
+  string(JSON PROPERTY_NAME_SCHEMA ERROR_VARIABLE PROPERTY_NAMES_ERROR GET ${SCHEMA_STRING} propertyNames)
+  string(JSON REQUIRED_PROPERTIES ERROR_VARIABLE REQUIRED_PROPERTIES_ERROR GET ${SCHEMA_STRING} required)
+  set(REQUIRED_LIST)
+  if(${REQUIRED_PROPERTIES_ERROR} STREQUAL "NOTFOUND")
+    string(JSON REQUIRED_LENGTH LENGTH ${REQUIRED_PROPERTIES})
+    math(EXPR MAX "${REQUIRED_LENGTH} - 1")
+    foreach(IDX RANGE ${MAX})
+      string(JSON REQUIRED GET ${REQUIRED_PROPERTIES} ${IDX})
+      list(APPEND REQUIRED_LIST ${REQUIRED})
+    endforeach()
+  endif()
+  string(JSON NUM_PROPERTIES LENGTH ${JSON_STRING})
+  math(EXPR MAX "${NUM_PROPERTIES} - 1")
+  foreach(IDX RANGE ${MAX})
+    string(JSON PROPERTY_NAME MEMBER ${JSON_STRING} ${IDX})
+    list(REMOVE_ITEM REQUIRED_LIST ${PROPERTY_NAME})
+    message(DEBUG "Validating property '${PROPERTY_NAME}'")
+    if(${PROPERTY_NAMES_ERROR} STREQUAL "NOTFOUND")
+      validate_property(${PROPERTY_NAME} ${PROPERTY_NAME_SCHEMA} PROPERTY_NAME_ERROR)
+      if(DEFINED PROPERTY_NAME_ERROR)
+        list(APPEND OBJECT_ERROR "${PROPERTY_NAME_ERROR}")
+      endif()
+    endif()
+    string(JSON PROPERTY GET ${JSON_STRING} ${PROPERTY_NAME})
+    string(JSON SCHEMA_PROPERTIES ERROR_VARIABLE PROPERTIES_ERROR GET ${SCHEMA_STRING} properties ${PROPERTY_NAME})
+    if(${PROPERTIES_ERROR} STREQUAL "NOTFOUND")
+      string(JSON PROPERTY_SCHEMA GET ${SCHEMA_STRING} properties ${PROPERTY_NAME})
+    else()
+      string(JSON PROPERTY_SCHEMA ERROR_VARIABLE ADDITIONAL_PROPERTIES_ERROR GET ${SCHEMA_STRING} additionalProperties)
+      if(NOT ${ADDITIONAL_PROPERTIES_ERROR} STREQUAL "NOTFOUND" OR "${PROPERTY_SCHEMA}" STREQUAL "OFF")
+        list(APPEND OBJECT_ERROR "Additional properties like '${PROPERTY_NAME}' not permitted in '${JSON_STRING}'")
+      endif()
+    endif()
+    validate_property(${PROPERTY} ${PROPERTY_SCHEMA} PROPERTY_ERROR)
+    if(DEFINED PROPERTY_ERROR)
+      list(APPEND OBJECT_ERROR "${PROPERTY_ERROR}")
+    endif()
+  endforeach()
+  list(LENGTH REQUIRED_LIST REQUIRED_REMAINING_LENGTH)
+  if(${REQUIRED_REMAINING_LENGTH} GREATER 0)
+    list(APPEND OBJECT_ERROR "Required properties not found: ${REQUIRED_LIST}")
+  endif()
+  set(${OBJECT_ERROR_STR} ${OBJECT_ERROR} PARENT_SCOPE)
+endfunction()
+
+function(validate_property PROPERTY PROPERTY_SCHEMA PROPERTY_ERROR_STR)
+  unset(${PROPERTY_ERROR_STR} PARENT_SCOPE)
+  set(PROPERTY_ERROR)
+  string(JSON PROPERTY_REF ERROR_VARIABLE JSON_ERROR GET ${PROPERTY_SCHEMA} $ref)
+  if(${JSON_ERROR} STREQUAL "NOTFOUND")
+    string(REPLACE "/" ";" REF_COMPONENTS "${PROPERTY_REF}")
+    string(JSON PROPERTY_SCHEMA GET ${DEFINITIONS} ${REF_COMPONENTS})
+  endif()
+  string(JSON PROPERTY_TYPE ERROR_VARIABLE JSON_ERROR GET ${PROPERTY_SCHEMA} type)
+  if(${JSON_ERROR} STREQUAL "NOTFOUND")
+    message(DEBUG "Validating property type '${PROPERTY_TYPE}'")
+    if(${PROPERTY_TYPE} STREQUAL "object")
+      validate_object(${PROPERTY} ${PROPERTY_SCHEMA} OBJECT_ERROR)
+      if(DEFINED OBJECT_ERROR)
+        list(APPEND PROPERTY_ERROR ${OBJECT_ERROR})
+      endif()
+    elseif(${PROPERTY_TYPE} STREQUAL "array")
+      string(JSON ARRAY_LENGTH LENGTH ${PROPERTY})
+      string(JSON MAX_ITEMS ERROR_VARIABLE JSON_ERROR GET ${PROPERTY_SCHEMA} maxItems)
+      if(${JSON_ERROR} STREQUAL "NOTFOUND" AND ${ARRAY_LENGTH} GREATER ${MAX_ITEMS})
+        list(APPEND PROPERTY_ERROR "Number of items in '${PROPERTY}' exceeds maximum ${MAX_ITEMS}")
+      endif()
+      string(JSON MIN_ITEMS ERROR_VARIABLE JSON_ERROR GET ${PROPERTY_SCHEMA} minItems)
+      if(${JSON_ERROR} STREQUAL "NOTFOUND" AND ${ARRAY_LENGTH} LESS ${MIN_ITEMS})
+        list(APPEND PROPERTY_ERROR "Number of items in '${PROPERTY}' is less than ${MIN_ITEMS}")
+      endif()
+      string(JSON ITEM_SCHEMA ERROR_VARIABLE JSON_ERROR GET ${PROPERTY_SCHEMA} items)
+      if(${JSON_ERROR} STREQUAL "NOTFOUND")
+        math(EXPR MAX "${ARRAY_LENGTH} - 1")
+        foreach(IDX RANGE ${MAX})
+          string(JSON ITEM GET ${PROPERTY} ${IDX})
+          validate_property(${ITEM} ${ITEM_SCHEMA} ITEM_ERROR)
+          if(DEFINED ITEM_ERROR)
+            list(APPEND PROPERTY_ERROR ${ITEM_ERROR})
+          endif()
+        endforeach()
+      endif()
+    elseif(${PROPERTY_TYPE} STREQUAL "null")
+      if(NOT "${PROPERTY}" STREQUAL "null")
+        list(APPEND PROPERTY_ERROR "Property '${PROPERTY}' is not null'")
+      endif()
+    elseif(${PROPERTY_TYPE} STREQUAL "boolean")
+      if(NOT "${PROPERTY}" STREQUAL "OFF" AND NOT "${PROPERTY}" STREQUAL "ON")
+        list(APPEND PROPERTY_ERROR "Property '${PROPERTY}' is not a boolean'")
+      endif()
+    elseif(${PROPERTY_TYPE} STREQUAL "number")
+      if(NOT "${PROPERTY}" MATCHES "-?[0-9]+\\.?[0-9]*")
+        list(APPEND PROPERTY_ERROR "Property '${PROPERTY}' is not a number'")
+      endif()
+    elseif(${PROPERTY_TYPE} STREQUAL "integer")
+      if(NOT "${PROPERTY}" MATCHES "-?[0-9]+")
+        list(APPEND PROPERTY_ERROR "Property '${PROPERTY}' is not an integer'")
+      endif()
+      string(JSON MIN ERROR_VARIABLE JSON_ERROR GET ${PROPERTY_SCHEMA} minimum)
+      if(${JSON_ERROR} STREQUAL "NOTFOUND" AND ${PROPERTY} LESS ${MIN})
+        list(APPEND PROPERTY_ERROR "Property '${PROPERTY}' is less than the minimum of ${MIN}")
+      endif()
+      string(JSON MAX ERROR_VARIABLE JSON_ERROR GET ${PROPERTY_SCHEMA} maximum)
+      if(${JSON_ERROR} STREQUAL "NOTFOUND" AND ${PROPERTY} GREATER ${MAX})
+        list(APPEND PROPERTY_ERROR "Property '${PROPERTY}' is greater than the maximum of ${MAX}")
+      endif()
+    elseif(${PROPERTY_TYPE} STREQUAL "string")
+      # cmake regex doesn't support {}, so other options might be needed here
+      string(JSON PATTERN ERROR_VARIABLE JSON_ERROR GET ${PROPERTY_SCHEMA} pattern)
+      if(${JSON_ERROR} STREQUAL "NOTFOUND" AND NOT "${PROPERTY}" MATCHES "${PATTERN}")
+        list(APPEND PROPERTY_ERROR "Property '${PROPERTY}' does not match '${PATTERN}'")
+      endif()
+      string(LENGTH ${PROPERTY} STRING_LENGTH)
+      string(JSON MIN_LENGTH ERROR_VARIABLE JSON_ERROR GET ${PROPERTY_SCHEMA} minLength)
+      if(${JSON_ERROR} STREQUAL "NOTFOUND" AND ${STRING_LENGTH} LESS ${MIN_LENGTH})
+        list(APPEND PROPERTY_ERROR "Length of property '${PROPERTY}' is less than the minimum of ${MIN_LENGTH}")
+      endif()
+      string(JSON MAX_LENGTH ERROR_VARIABLE JSON_ERROR GET ${PROPERTY_SCHEMA} maxLength)
+      if(${JSON_ERROR} STREQUAL "NOTFOUND" AND ${STRING_LENGTH} GREATER ${MAX_LENGTH})
+        list(APPEND PROPERTY_ERROR "Length of property '${PROPERTY}' is greater than the maximum of ${MAX_LENGTH}")
+      endif()
+      string(JSON ENUM_LIST ERROR_VARIABLE JSON_ERROR GET ${PROPERTY_SCHEMA} enum)
+      if(${JSON_ERROR} STREQUAL "NOTFOUND")
+        set(FOUND_IN_ENUM_LIST FALSE)
+        string(JSON ENUM_LENGTH LENGTH ${ENUM_LIST})
+        math(EXPR MAX "${ENUM_LENGTH} - 1")
+        foreach(IDX RANGE ${MAX})
+          string(JSON ENUM GET ${PROPERTY_SCHEMA} enum ${IDX})
+          if(${ENUM} STREQUAL ${PROPERTY})
+            set(FOUND_IN_ENUM_LIST TRUE)
+          endif()
+        endforeach()
+        if(NOT ${FOUND_IN_ENUM_LIST})
+          list(APPEND PROPERTY_ERROR "Property '${PROPERTY}' is not defined in the schema's enum: ${ENUM_LIST}")
+        endif()
+      endif()
+    else()
+      message(STATUS "Unknown type '${PROPERTY_TYPE}'")
+    endif()
+  else()
+    string(JSON PROPERTY_ONEOF ERROR_VARIABLE JSON_ERROR GET ${PROPERTY_SCHEMA} oneOf)
+    if(${JSON_ERROR} STREQUAL "NOTFOUND")
+      set(TYPE_SUCCESS FALSE)
+      string(JSON NUM_ONEOF LENGTH ${PROPERTY_ONEOF})
+      math(EXPR MAX "${NUM_ONEOF} - 1")
+      set(ONEOF_ERRORS)
+      foreach(IDX RANGE ${MAX})
+        string(JSON PROPERTY_SCHEMA GET ${PROPERTY_ONEOF} ${IDX})
+        validate_property(${PROPERTY} ${PROPERTY_SCHEMA} ONEOF_ERROR)
+        if(NOT DEFINED ONEOF_ERROR)
+          set(TYPE_SUCCESS TRUE)
+        else()
+          list(APPEND ONEOF_ERRORS "${ONEOF_ERROR}\n")
+        endif()
+      endforeach()
+      if(NOT TYPE_SUCCESS)
+        list(APPEND PROPERTY_ERROR "Could not validate oneOf type '${PROPERTY}' :\n${ONEOF_ERRORS}")
+      endif()
+    endif()
+  endif()
+  set(${PROPERTY_ERROR_STR} ${PROPERTY_ERROR} PARENT_SCOPE)
+endfunction()

+ 2 - 2
cmake/features/backlight.cmake

@@ -2,12 +2,12 @@ option(BACKLIGHT_ENABLE "" TRUE)
 set(BACKLIGHT_DRIVER "pwm" CACHE STRING "Backlight driver")
 set_property(CACHE BACKLIGHT_DRIVER PROPERTY STRINGS pwm timer software custom)
 
-if(${BACKLIGHT_ENABLE})
+string(JSON BACKLIGHT_PIN ERROR_VARIABLE NO_BACKLIGHT_PIN GET ${QMK_KEYBOARD_INFO_JSON_STRING} backlight pin)
+if(${BACKLIGHT_ENABLE} AND NOT ${NO_BACKLIGHT_PIN} STREQUAL "backlight-NOTFOUND")
     add_library(backlight
       quantum/backlight/backlight.c 
       quantum/process_keycode/process_backlight.c
     )
-    string(JSON BACKLIGHT_PIN GET ${QMK_KEYBOARD_INFO_JSON_STRING} backlight pin)
     add_compile_definitions(
         BACKLIGHT_ENABLE
         BACKLIGHT_PIN=${BACKLIGHT_PIN}

+ 6 - 6
data/schemas/definitions.jsonschema

@@ -14,15 +14,15 @@
     },
     "hex_number_2d": {
         "type": "string",
-        "pattern": "^0x[0-9A-F]{2}$"
+        "pattern": "^0x[0-9A-F][0-9A-F]$"
     },
     "hex_number_4d": {
         "type": "string",
-        "pattern": "^0x[0-9A-F]{4}$"
+        "pattern": "^0x[0-9A-F][0-9A-F][0-9A-F][0-9A-F]$"
     },
     "bcd_version": {
         "type": "string",
-        "pattern": "^[0-9]{1,2}\\.[0-9]\\.[0-9]$"
+        "pattern": "^[0-9][0-9]?\\.[0-9]\\.[0-9]$"
     },
     "text_identifier": {
         "type": "string",
@@ -83,15 +83,15 @@
             },
             {
                 "type": "string",
-                "pattern": "^[A-K]\\d{1,2}$"
+                "pattern": "^[A-K]\\d\\d?$"
             },
             {
                 "type": "string",
-                "pattern": "^LINE_PIN\\d{1,2}$"
+                "pattern": "^LINE_PIN\\d\\d?$"
             },
             {
                 "type": "string",
-                "pattern": "^GP\\d{1,2}$"
+                "pattern": "^GP\\d\\d?$"
             },
             {
                 "type": "integer"

+ 21 - 13
platforms/chibios/toolchain.cmake

@@ -9,7 +9,7 @@ endif()
 # find_arm_toolchain()
 
 set(CMAKE_SYSTEM_NAME Generic)
-set(CMAKE_SYSTEM_PROCESSOR avr)
+set(CMAKE_SYSTEM_PROCESSOR arm)
 set(CMAKE_CROSS_COMPILING 1)
 
 set(CMAKE_MAKE_PROGRAM "${MAKE_ROOT}/make${OS_SUFFIX}"                   CACHE PATH "make"    FORCE)
@@ -32,27 +32,35 @@ add_compile_options(
     -Os
     -Wall
     -Wstrict-prototypes
-    -fcommon
+    # -fcommon
     # -g
-    -funsigned-char
-    -funsigned-bitfields
+    -fomit-frame-pointer
     -ffunction-sections
     -fdata-sections
-    -fpack-struct
-    -fshort-enums
+    -fno-common
+    -fshort-wchar
     -fno-builtin-printf
-    $<$<COMPILE_LANGUAGE:C>:-fno-inline-small-functions>
-    $<$<COMPILE_LANGUAGE:C>:-fno-strict-aliasing>
-    $<$<COMPILE_LANGUAGE:CXX>:-fno-exceptions>
+    # -funsigned-char
+    # -funsigned-bitfields
+    # -ffunction-sections
+    # -fdata-sections
+    # -fpack-struct
+    # -fshort-enums
+    # -fno-builtin-printf
+    # $<$<COMPILE_LANGUAGE:C>:-fno-inline-small-functions>
+    # $<$<COMPILE_LANGUAGE:C>:-fno-strict-aliasing>
+    # $<$<COMPILE_LANGUAGE:CXX>:-fno-exceptions>
 )
 
 add_compile_definitions(
-    F_CPU=16000000
-    F_USB=16000000UL
-    __AVR_ATmega32U4__
+    # F_CPU=16000000
+    # F_USB=16000000UL
+    # __AVR_ATmega32U4__
     # LTO_ENABLE
 )
 
+add_link_options(--specs=nosys.specs)
+
 # include_directories("C:/Users/Jack/Downloads/avr-gcc-12.1.0-x64-windows/avr/include")
 
 macro(add_qmk_executable target_name)
@@ -62,7 +70,7 @@ macro(add_qmk_executable target_name)
     set(hex_file ${target_name}-${QMK_MCU}.hex)
     set(lst_file ${target_name}-${QMK_MCU}.lst)
 
-    add_link_options(-Wl,--gc-sections,-Map=${map_file})
+    add_link_options(-Wl,--gc-sections,-nostartfiles)
 
     # create elf file
     add_executable(${elf_file}