rules_mk.py 3.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697
  1. """Used by the make system to generate a rules.mk
  2. """
  3. from pathlib import Path
  4. from dotty_dict import dotty
  5. from milc import cli
  6. from qmk.info import info_json
  7. from qmk.json_schema import json_load, validate
  8. from qmk.keyboard import keyboard_completer, keyboard_folder
  9. from qmk.keymap import locate_keymap
  10. from qmk.commands import dump_lines
  11. from qmk.path import normpath
  12. from qmk.constants import GPL2_HEADER_SH_LIKE, GENERATED_HEADER_SH_LIKE
  13. def process_mapping_rule(kb_info_json, rules_key, info_dict):
  14. """Return the rules.mk line(s) for a mapping rule.
  15. """
  16. if not info_dict.get('to_c', True):
  17. return None
  18. info_key = info_dict['info_key']
  19. key_type = info_dict.get('value_type', 'str')
  20. try:
  21. rules_value = kb_info_json[info_key]
  22. except KeyError:
  23. return None
  24. if key_type in ['array', 'list']:
  25. return f'{rules_key} ?= {" ".join(rules_value)}'
  26. elif key_type == 'bool':
  27. return f'{rules_key} ?= {"yes" if rules_value else "no"}'
  28. elif key_type == 'mapping':
  29. return '\n'.join([f'{key} ?= {value}' for key, value in rules_value.items()])
  30. return f'{rules_key} ?= {rules_value}'
  31. @cli.argument('-o', '--output', arg_only=True, type=normpath, help='File to write to')
  32. @cli.argument('-q', '--quiet', arg_only=True, action='store_true', help="Quiet mode, only output error messages")
  33. @cli.argument('-e', '--escape', arg_only=True, action='store_true', help="Escape spaces in quiet mode")
  34. @cli.argument('-kb', '--keyboard', arg_only=True, type=keyboard_folder, completer=keyboard_completer, required=True, help='Keyboard to generate rules.mk for.')
  35. @cli.argument('-km', '--keymap', arg_only=True, help='Keymap to generate rules.mk for.')
  36. @cli.subcommand('Used by the make system to generate rules.mk from info.json', hidden=True)
  37. def generate_rules_mk(cli):
  38. """Generates a rules.mk file from info.json.
  39. """
  40. # Determine our keyboard/keymap
  41. if cli.args.keymap:
  42. km = locate_keymap(cli.args.keyboard, cli.args.keymap)
  43. km_json = json_load(km)
  44. validate(km_json, 'qmk.keymap.v1')
  45. kb_info_json = dotty(km_json.get('config', {}))
  46. else:
  47. kb_info_json = dotty(info_json(cli.args.keyboard))
  48. info_rules_map = json_load(Path('data/mappings/info_rules.json'))
  49. rules_mk_lines = [GPL2_HEADER_SH_LIKE, GENERATED_HEADER_SH_LIKE]
  50. # Iterate through the info_rules map to generate basic rules
  51. for rules_key, info_dict in info_rules_map.items():
  52. new_entry = process_mapping_rule(kb_info_json, rules_key, info_dict)
  53. if new_entry:
  54. rules_mk_lines.append(new_entry)
  55. # Iterate through features to enable/disable them
  56. if 'features' in kb_info_json:
  57. for feature, enabled in kb_info_json['features'].items():
  58. feature = feature.upper()
  59. enabled = 'yes' if enabled else 'no'
  60. rules_mk_lines.append(f'{feature}_ENABLE ?= {enabled}')
  61. # Set SPLIT_TRANSPORT, if needed
  62. if kb_info_json.get('split', {}).get('transport', {}).get('protocol') == 'custom':
  63. rules_mk_lines.append('SPLIT_TRANSPORT ?= custom')
  64. # Set CUSTOM_MATRIX, if needed
  65. if kb_info_json.get('matrix_pins', {}).get('custom'):
  66. if kb_info_json.get('matrix_pins', {}).get('custom_lite'):
  67. rules_mk_lines.append('CUSTOM_MATRIX ?= lite')
  68. else:
  69. rules_mk_lines.append('CUSTOM_MATRIX ?= yes')
  70. # Show the results
  71. dump_lines(cli.args.output, rules_mk_lines)
  72. if cli.args.output:
  73. if cli.args.quiet:
  74. if cli.args.escape:
  75. print(cli.args.output.as_posix().replace(' ', '\\ '))
  76. else:
  77. print(cli.args.output)
  78. else:
  79. cli.log.info('Wrote rules.mk to %s.', cli.args.output)