layouts.py 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384
  1. """Used by the make system to generate layouts.h from info.json.
  2. """
  3. from milc import cli
  4. from qmk.constants import COL_LETTERS, ROW_LETTERS, GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE
  5. from qmk.decorators import automagic_keyboard, automagic_keymap
  6. from qmk.info import info_json
  7. from qmk.keyboard import keyboard_completer, keyboard_folder
  8. from qmk.path import is_keyboard, normpath
  9. from qmk.commands import dump_lines
  10. @cli.argument('-o', '--output', arg_only=True, type=normpath, help='File to write to')
  11. @cli.argument('-q', '--quiet', arg_only=True, action='store_true', help="Quiet mode, only output error messages")
  12. @cli.argument('-kb', '--keyboard', type=keyboard_folder, completer=keyboard_completer, help='Keyboard to generate config.h for.')
  13. @cli.subcommand('Used by the make system to generate layouts.h from info.json', hidden=True)
  14. @automagic_keyboard
  15. @automagic_keymap
  16. def generate_layouts(cli):
  17. """Generates the layouts.h file.
  18. """
  19. # Determine our keyboard(s)
  20. if not cli.config.generate_layouts.keyboard:
  21. cli.log.error('Missing parameter: --keyboard')
  22. cli.subcommands['info'].print_help()
  23. return False
  24. if not is_keyboard(cli.config.generate_layouts.keyboard):
  25. cli.log.error('Invalid keyboard: "%s"', cli.config.generate_layouts.keyboard)
  26. return False
  27. # Build the info.json file
  28. kb_info_json = info_json(cli.config.generate_layouts.keyboard)
  29. # Build the layouts.h file.
  30. layouts_h_lines = [GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE, '#pragma once']
  31. if 'matrix_size' not in kb_info_json:
  32. cli.log.error('%s: Invalid matrix config.', cli.config.generate_layouts.keyboard)
  33. return False
  34. col_num = kb_info_json['matrix_size']['cols']
  35. row_num = kb_info_json['matrix_size']['rows']
  36. for layout_name in kb_info_json['layouts']:
  37. if kb_info_json['layouts'][layout_name]['c_macro']:
  38. continue
  39. if 'matrix' not in kb_info_json['layouts'][layout_name]['layout'][0]:
  40. cli.log.debug('%s/%s: No matrix data!', cli.config.generate_layouts.keyboard, layout_name)
  41. continue
  42. layout_keys = []
  43. layout_matrix = [['KC_NO' for i in range(col_num)] for i in range(row_num)]
  44. for i, key in enumerate(kb_info_json['layouts'][layout_name]['layout']):
  45. row = key['matrix'][0]
  46. col = key['matrix'][1]
  47. identifier = 'k%s%s' % (ROW_LETTERS[row], COL_LETTERS[col])
  48. try:
  49. layout_matrix[row][col] = identifier
  50. layout_keys.append(identifier)
  51. except IndexError:
  52. key_name = key.get('label', identifier)
  53. cli.log.error('Matrix data out of bounds for layout %s at index %s (%s): %s, %s', layout_name, i, key_name, row, col)
  54. return False
  55. layouts_h_lines.append('')
  56. layouts_h_lines.append('#define %s(%s) {\\' % (layout_name, ', '.join(layout_keys)))
  57. rows = ', \\\n'.join(['\t {' + ', '.join(row) + '}' for row in layout_matrix])
  58. rows += ' \\'
  59. layouts_h_lines.append(rows)
  60. layouts_h_lines.append('}')
  61. for alias, target in kb_info_json.get('layout_aliases', {}).items():
  62. layouts_h_lines.append('')
  63. layouts_h_lines.append(f'#ifndef {alias}')
  64. layouts_h_lines.append(f'# define {alias} {target}')
  65. layouts_h_lines.append('#endif')
  66. # Show the results
  67. dump_lines(cli.args.output, layouts_h_lines, cli.args.quiet)