1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
const fs = require('fs')
const path = require('path')
const filter = require('lodash/filter')
const flatten = require('lodash/flatten')
const get = require('lodash/get')
const keyBy = require('lodash/keyBy')
const map = require('lodash/map')
const uniq = require('lodash/uniq')
const { renderTable } = require('./layout')
class KeymapValidationError extends Error {
constructor (errors) {
super()
this.name = 'KeymapValidationError'
this.errors = errors
}
}
const behaviours = JSON.parse(fs.readFileSync(path.join(__dirname, 'data/zmk-behaviors.json')))
const behavioursByBind = keyBy(behaviours, 'code')
function encodeBindValue(parsed) {
const params = (parsed.params || []).map(encodeBindValue)
const paramString = params.length > 0 ? `(${params.join(',')})` : ''
return parsed.value + paramString
}
function encodeKeyBinding(parsed) {
const { value, params } = parsed
return `${value} ${params.map(encodeBindValue).join(' ')}`.trim()
}
function encodeKeymap(parsedKeymap) {
return Object.assign({}, parsedKeymap, {
layers: parsedKeymap.layers.map(layer => layer.map(encodeKeyBinding))
})
}
function getBehavioursUsed(keymap) {
const keybinds = flatten(keymap.layers)
return uniq(map(keybinds, 'value'))
}
/**
* Parse a bind string into a tree of values and parameters
* @param {String} binding
* @returns {Object}
*/
function parseKeyBinding(binding) {
const paramsPattern = /\((.+)\)/
function parse(code) {
const value = code.replace(paramsPattern, '')
const params = get(code.match(paramsPattern), '[1]', '').split(',')
.map(s => s.trim())
.filter(s => s.length > 0)
.map(parse)
return { value, params }
}
const value = binding.match(/^(&.+?)\b/)[1]
const params = filter(binding.replace(/^&.+?\b\s*/, '')
.split(' '))
.map(parse)
return { value, params }
}
function parseKeymap (keymap) {
return Object.assign({}, keymap, {
layers: keymap.layers.map(layer => {
return layer.map(parseKeyBinding)
})
})
}
const header = `
/*
* Copyright (c) 2020 The ZMK Contributors
*
* SPDX-License-Identifier: MIT
*/
/* THIS FILE WAS GENERATED!
*
* This file was generated automatically. You may or may not want to
* edit it directly.
*/
#include <behaviors.dtsi>
#include <dt-bindings/zmk/keys.h>
`
function generateKeymap (layout, keymap) {
const encoded = encodeKeymap(keymap)
return {
code: generateKeymapCode(layout, keymap, encoded),
json: generateKeymapJSON(layout, keymap, encoded)
}
}
function generateKeymapCode (layout, keymap, encoded) {
const { layer_names: names = [] } = keymap
const behaviourHeaders = flatten(getBehavioursUsed(keymap).map(
bind => get(behavioursByBind, [bind, 'includes'], [])
))
const layers = encoded.layers.map((layer, i) => {
const name = i === 0 ? 'default_layer' : `layer_${names[i] || i}`
const rendered = renderTable(layout, layer, {
linePrefix: '',
columnSeparator: ' '
})
return `
${name.replace(/[^a-zA-Z0-9_]/g, '_')} {
bindings = <
${rendered}
>;
};
`
})
const keymapOut = `${header}
${behaviourHeaders.join('\n')}
/ {
keymap {
compatible = "zmk,keymap";
${layers.join('')}
};
};
`
return keymapOut
}
function generateKeymapJSON (layout, keymap, encoded) {
const base = JSON.stringify(Object.assign({}, encoded, { layers: null }), null, 2)
const layers = encoded.layers.map(layer => {
const rendered = renderTable(layout, layer, {
useQuotes: true,
linePrefix: ' '
})
return `[\n${rendered}\n ]`
})
return base.replace('"layers": null', `"layers": [\n ${layers.join(', ')}\n ]`)
}
function validateKeymapJson(keymap) {
const errors = []
if (typeof keymap !== 'object' || keymap === null) {
errors.push('keymap.json root must be an object')
} else if (!Array.isArray(keymap.layers)) {
errors.push('keymap must include "layers" array')
} else {
for (let i in keymap.layers) {
const layer = keymap.layers[i]
if (!Array.isArray(layer)) {
errors.push(`Layer at layers[${i}] must be an array`)
} else {
for (let j in layer) {
const key = layer[j]
const keyPath = `layers[${i}][${j}]`
if (typeof key !== 'string') {
errors.push(`Value at "${keyPath}" must be a string`)
} else {
const bind = key.match(/^&.+?\b/)
if (!(bind && bind[0] in behavioursByBind)) {
errors.push(`Key bind at "${keyPath}" has invalid behaviour`)
}
}
// TODO: validate remaining bind parameters
}
}
}
}
if (errors.length) {
throw new KeymapValidationError(errors)
}
}
module.exports = {
KeymapValidationError,
encodeKeymap,
parseKeymap,
generateKeymap,
validateKeymapJson
}
|
