gtk_code_gen.dart 5.7 KB
Newer Older
1 2 3 4 5 6 7
// Copyright 2014 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'package:path/path.dart' as path;

import 'base_code_gen.dart';
8
import 'constants.dart';
9 10
import 'logical_key_data.dart';
import 'physical_key_data.dart';
11 12 13
import 'utils.dart';


14
/// Generates the key mapping for GTK, based on the information in the key
15 16
/// data structure given to it.
class GtkCodeGenerator extends PlatformCodeGenerator {
17
  GtkCodeGenerator(
18 19
    super.keyData,
    super.logicalData,
20 21
    String modifierBitMapping,
    String lockBitMapping,
22
    this._layoutGoals,
23
  ) : _modifierBitMapping = parseMapOfListOfString(modifierBitMapping),
24
      _lockBitMapping = parseMapOfListOfString(lockBitMapping);
25

26 27 28 29
  /// This generates the map of XKB scan codes to Flutter physical keys.
  String get _xkbScanCodeMap {
    final OutputLines<int> lines = OutputLines<int>('GTK scancode map');
    for (final PhysicalKeyEntry entry in keyData.entries) {
30
      if (entry.xKbScanCode != null) {
31 32
        lines.add(entry.xKbScanCode!,
          '    {${toHex(entry.xKbScanCode)}, ${toHex(entry.usbHidCode)}},  // ${entry.constantName}');
33 34
      }
    }
35
    return lines.sortedJoin().trimRight();
36 37
  }

38 39 40 41 42
  /// This generates the map of GTK keyval codes to Flutter logical keys.
  String get _gtkKeyvalCodeMap {
    final OutputLines<int> lines = OutputLines<int>('GTK keyval map');
    for (final LogicalKeyEntry entry in logicalData.entries) {
      zipStrict(entry.gtkValues, entry.gtkNames, (int value, String name) {
43 44
        lines.add(value,
          '    {${toHex(value)}, ${toHex(entry.value, digits: 11)}},  // $name');
45 46 47 48 49 50 51 52 53 54 55 56 57 58
      });
    }
    return lines.sortedJoin().trimRight();
  }

  static String constructMapFromModToKeys(
      Map<String, List<String>> source,
      PhysicalKeyData physicalData,
      LogicalKeyData logicalData,
      String debugFunctionName,
  ) {
    final StringBuffer result = StringBuffer();
    source.forEach((String modifierBitName, List<String> keyNames) {
      assert(keyNames.length == 2 || keyNames.length == 3);
59 60 61
      final String primaryPhysicalName = keyNames[0];
      final String primaryLogicalName = keyNames[1];
      final String? secondaryLogicalName = keyNames.length == 3 ? keyNames[2] : null;
62
      final PhysicalKeyEntry primaryPhysical = physicalData.entryByName(primaryPhysicalName);
63 64 65 66
      final LogicalKeyEntry primaryLogical = logicalData.entryByName(primaryLogicalName);
      final LogicalKeyEntry? secondaryLogical = secondaryLogicalName == null ? null : logicalData.entryByName(secondaryLogicalName);
      if (secondaryLogical == null && secondaryLogicalName != null) {
        print('Unrecognized secondary logical key $secondaryLogicalName specified for $debugFunctionName.');
67 68
        return;
      }
69
      final String pad = secondaryLogical == null ? '' : '  ';
70 71 72 73 74
      result.writeln('''

  data = g_new(FlKeyEmbedderCheckedKey, 1);
  g_hash_table_insert(table, GUINT_TO_POINTER(GDK_${modifierBitName}_MASK), data);
  data->is_caps_lock = ${primaryPhysicalName == 'CapsLock' ? 'true' : 'false'};
75 76 77
  data->primary_physical_key = ${toHex(primaryPhysical.usbHidCode, digits: 9)};$pad   // ${primaryPhysical.constantName}
  data->primary_logical_key = ${toHex(primaryLogical.value, digits: 11)};$pad  // ${primaryLogical.constantName}''');
      if (secondaryLogical != null) {
78
        result.writeln('''
79
  data->secondary_logical_key = ${toHex(secondaryLogical.value, digits: 11)};  // ${secondaryLogical.constantName}''');
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94
      }
    });
    return result.toString().trimRight();
  }

  String get _gtkModifierBitMap {
    return constructMapFromModToKeys(_modifierBitMapping, keyData, logicalData, 'gtkModifierBitMap');
  }
  final Map<String, List<String>> _modifierBitMapping;

  String get _gtkModeBitMap {
    return constructMapFromModToKeys(_lockBitMapping, keyData, logicalData, 'gtkModeBitMap');
  }
  final Map<String, List<String>> _lockBitMapping;

95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
  final Map<String, bool> _layoutGoals;
  String get _layoutGoalsString {
    final OutputLines<int> lines = OutputLines<int>('GTK layout goals');
    _layoutGoals.forEach((String name, bool mandatory) {
      final PhysicalKeyEntry physicalEntry = keyData.entryByName(name);
      final LogicalKeyEntry logicalEntry = logicalData.entryByName(name);
      final String line = 'LayoutGoal{'
          '${toHex(physicalEntry.xKbScanCode, digits: 2)}, '
          '${toHex(logicalEntry.value, digits: 2)}, '
          '${mandatory ? 'true' : 'false'}'
          '},';
      lines.add(logicalEntry.value,
          '    ${line.padRight(39)}'
          '// ${logicalEntry.name}');
    });
    return lines.sortedJoin().trimRight();
  }

113 114 115 116 117 118 119 120 121 122 123 124 125 126
  /// This generates the mask values for the part of a key code that defines its plane.
  String get _maskConstants {
    final StringBuffer buffer = StringBuffer();
    const List<MaskConstant> maskConstants = <MaskConstant>[
      kValueMask,
      kUnicodePlane,
      kGtkPlane,
    ];
    for (final MaskConstant constant in maskConstants) {
      buffer.writeln('const uint64_t k${constant.upperCamelName} = ${toHex(constant.value, digits: 11)};');
    }
    return buffer.toString().trimRight();
  }

127 128 129
  @override
  String get templatePath => path.join(dataRoot, 'gtk_key_mapping_cc.tmpl');

130
  @override
131
  String outputPath(String platform) => path.join(PlatformCodeGenerator.engineRoot,
132
      'shell', 'platform', 'linux', 'key_mapping.g.cc');
133 134 135 136

  @override
  Map<String, String> mappings() {
    return <String, String>{
137 138 139 140
      'XKB_SCAN_CODE_MAP': _xkbScanCodeMap,
      'GTK_KEYVAL_CODE_MAP': _gtkKeyvalCodeMap,
      'GTK_MODIFIER_BIT_MAP': _gtkModifierBitMap,
      'GTK_MODE_BIT_MAP': _gtkModeBitMap,
141
      'MASK_CONSTANTS': _maskConstants,
142
      'LAYOUT_GOALS': _layoutGoalsString,
143 144 145
    };
  }
}