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
|
/*
* BRLTTY - A background process providing access to the console screen (when in
* text mode) for a blind person using a refreshable braille display.
*
* Copyright (C) 1995-2024 by The BRLTTY Developers.
*
* BRLTTY comes with ABSOLUTELY NO WARRANTY.
*
* This is free software, placed under the terms of the
* GNU Lesser General Public License, as published by the Free Software
* Foundation; either version 2.1 of the License, or (at your option) any
* later version. Please see the file LICENSE-LGPL for details.
*
* Web Page: http://brltty.app/
*
* This software is maintained by Dave Mielke <dave@mielke.cc>.
*/
#include "prologue.h"
#include <stdio.h>
#include "log.h"
#include "strfmt.h"
#include "ktb.h"
#include "ktb_internal.h"
#include "ktb_inspect.h"
typedef struct {
KeyTable *table;
const KeyContext *ctx;
const char *path;
} KeyTableAuditorParameters;
#define KEY_TABLE_AUDITOR(name) int name (const KeyTableAuditorParameters *kta)
typedef KEY_TABLE_AUDITOR(KeyTableAuditor);
static void
reportKeyTableAudit (const char *audit) {
logMessage(LOG_WARNING, "%s", audit);
}
static
STR_BEGIN_FORMATTER(
formatKeyTableAuditPrefix,
const KeyTableAuditorParameters *kta,
const char *problem
)
if (kta->path) STR_PRINTF("%s: ", kta->path);
STR_PRINTF("%s", problem);
if (kta->ctx) STR_PRINTF(": %" PRIws, kta->ctx->name);
STR_END_FORMATTER
static KEY_TABLE_AUDITOR(reportKeyContextProblems) {
int ok = 1;
if (kta->ctx->name && !kta->ctx->isSpecial) {
const char *problem = NULL;
if (!kta->ctx->isDefined) {
problem = "undefined context";
} else if (!kta->ctx->isReferenced) {
problem = "unreferenced context";
} else if (!(kta->ctx->keyBindings.count ||
kta->ctx->mappedKeys.count ||
kta->ctx->mappedKeys.superimpose ||
kta->ctx->hotkeys.count)) {
problem = "empty context";
}
if (problem) {
ok = 0;
char audit[0X100];
STR_BEGIN(audit, sizeof(audit));
STR_FORMAT(formatKeyTableAuditPrefix, kta, problem);
STR_END;
reportKeyTableAudit(audit);
}
}
return ok;
}
static KEY_TABLE_AUDITOR(reportDuplicateKeyBindings) {
int ok = 1;
const KeyBinding *binding = kta->ctx->keyBindings.table;
const KeyBinding *end = binding + kta->ctx->keyBindings.count;
while (binding < end) {
if (binding->flags & KBF_DUPLICATE) {
ok = 0;
char audit[0X100];
STR_BEGIN(audit, sizeof(audit));
STR_FORMAT(formatKeyTableAuditPrefix, kta, "duplicate key binding");
STR_PRINTF(": ");
STR_FORMAT(formatKeyCombination, kta->table, &binding->keyCombination);
STR_END;
reportKeyTableAudit(audit);
}
binding += 1;
}
return ok;
}
static void
reportKeyProblem (const KeyTableAuditorParameters *kta, const KeyValue *key, const char *problem) {
char audit[0X100];
STR_BEGIN(audit, sizeof(audit));
STR_FORMAT(formatKeyTableAuditPrefix, kta, problem);
STR_PRINTF(": ");
STR_FORMAT(formatKeyName, kta->table, key);
STR_END;
reportKeyTableAudit(audit);
}
static KEY_TABLE_AUDITOR(reportDuplicateHotkeys) {
int ok = 1;
const HotkeyEntry *hotkey = kta->ctx->hotkeys.table;
const HotkeyEntry *end = hotkey + kta->ctx->hotkeys.count;
while (hotkey < end) {
if (hotkey->flags & HKF_DUPLICATE) {
ok = 0;
reportKeyProblem(kta, &hotkey->keyValue, "duplicate hotkey");
}
hotkey += 1;
}
return ok;
}
static KEY_TABLE_AUDITOR(reportDuplicateMappedKeys) {
int ok = 1;
const MappedKeyEntry *map = kta->ctx->mappedKeys.table;
const MappedKeyEntry *end = map + kta->ctx->mappedKeys.count;
while (map < end) {
if (map->flags & MKF_DUPLICATE) {
ok = 0;
reportKeyProblem(kta, &map->keyValue, "duplicate mapped key");
}
map += 1;
}
return ok;
}
int
auditKeyTable (KeyTable *table, const char *path) {
int ok = 1;
for (unsigned int context=0; context<table->keyContexts.count; context+=1) {
const KeyContext *ctx = getKeyContext(table, context);
if (ctx) {
static KeyTableAuditor *const auditors[] = {
reportKeyContextProblems,
reportDuplicateKeyBindings,
reportDuplicateHotkeys,
reportDuplicateMappedKeys,
NULL
};
const KeyTableAuditorParameters kta = {
.table = table,
.ctx = ctx,
.path = path
};
for (
KeyTableAuditor *const *auditor=auditors;
*auditor!=NULL; auditor+=1
) {
if (!(*auditor)(&kta)) ok = 0;
}
}
}
return ok;
}
|
