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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
|
/* SPDX-License-Identifier: GPL-2.0-or-later */
/** \file
* \ingroup sptext
*/
#include <string.h>
#include "BLI_blenlib.h"
#include "DNA_space_types.h"
#include "DNA_text_types.h"
#include "BKE_text.h"
#include "text_format.h"
/* *** Local Functions (for format_line) *** */
/**
* Checks the specified source string for a Python built-in function name. This
* name must start at the beginning of the source string and must be followed by
* a non-identifier (see #text_check_identifier(char)) or null character.
*
* If a built-in function is found, the length of the matching name is returned.
* Otherwise, -1 is returned.
*
* See:
* http://docs.python.org/py3k/reference/lexical_analysis.html#keywords
*/
static int txtfmt_py_find_builtinfunc(const char *string)
{
int i, len;
/* list is from...
* ", ".join(['"%s"' % kw
* for kw in sorted(__import__("keyword").kwlist + __import__("keyword").softkwlist)
* if kw not in {"False", "None", "True", "def", "class", "_"}])
*
* ... and for this code:
* import keyword
* ignore = {"False", "None", "True", "def", "class", "_"}
* keywords = sorted(set(keyword.kwlist + keyword.softkwlist) - ignore)
* longest = max(len(kw) for kw in keywords)
* first = 'if (STR_LITERAL_STARTSWITH(string, "%s",%s len)) { i = len;'
* middle = '} else if (STR_LITERAL_STARTSWITH(string, "%s",%s len)) { i = len;'
* last = '} else %s { i = 0;'
* print("\n".join([(first if i==0 else middle) % (kw, ' '*(longest - len(kw)))
* for (i, kw) in enumerate(keywords)]) + "\n" +
* last % (' '*(longest-2)) + "\n" +
* "}")
*/
/* Keep aligned args for readability. */
/* clang-format off */
if (STR_LITERAL_STARTSWITH(string, "and", len)) { i = len;
} else if (STR_LITERAL_STARTSWITH(string, "as", len)) { i = len;
} else if (STR_LITERAL_STARTSWITH(string, "assert", len)) { i = len;
} else if (STR_LITERAL_STARTSWITH(string, "async", len)) { i = len;
} else if (STR_LITERAL_STARTSWITH(string, "await", len)) { i = len;
} else if (STR_LITERAL_STARTSWITH(string, "break", len)) { i = len;
} else if (STR_LITERAL_STARTSWITH(string, "case", len)) { i = len;
} else if (STR_LITERAL_STARTSWITH(string, "continue", len)) { i = len;
} else if (STR_LITERAL_STARTSWITH(string, "del", len)) { i = len;
} else if (STR_LITERAL_STARTSWITH(string, "elif", len)) { i = len;
} else if (STR_LITERAL_STARTSWITH(string, "else", len)) { i = len;
} else if (STR_LITERAL_STARTSWITH(string, "except", len)) { i = len;
} else if (STR_LITERAL_STARTSWITH(string, "finally", len)) { i = len;
} else if (STR_LITERAL_STARTSWITH(string, "for", len)) { i = len;
} else if (STR_LITERAL_STARTSWITH(string, "from", len)) { i = len;
} else if (STR_LITERAL_STARTSWITH(string, "global", len)) { i = len;
} else if (STR_LITERAL_STARTSWITH(string, "if", len)) { i = len;
} else if (STR_LITERAL_STARTSWITH(string, "import", len)) { i = len;
} else if (STR_LITERAL_STARTSWITH(string, "in", len)) { i = len;
} else if (STR_LITERAL_STARTSWITH(string, "is", len)) { i = len;
} else if (STR_LITERAL_STARTSWITH(string, "lambda", len)) { i = len;
} else if (STR_LITERAL_STARTSWITH(string, "match", len)) { i = len;
} else if (STR_LITERAL_STARTSWITH(string, "nonlocal", len)) { i = len;
} else if (STR_LITERAL_STARTSWITH(string, "not", len)) { i = len;
} else if (STR_LITERAL_STARTSWITH(string, "or", len)) { i = len;
} else if (STR_LITERAL_STARTSWITH(string, "pass", len)) { i = len;
} else if (STR_LITERAL_STARTSWITH(string, "raise", len)) { i = len;
} else if (STR_LITERAL_STARTSWITH(string, "return", len)) { i = len;
} else if (STR_LITERAL_STARTSWITH(string, "try", len)) { i = len;
} else if (STR_LITERAL_STARTSWITH(string, "while", len)) { i = len;
} else if (STR_LITERAL_STARTSWITH(string, "with", len)) { i = len;
} else if (STR_LITERAL_STARTSWITH(string, "yield", len)) { i = len;
} else { i = 0;
}
/* clang-format on */
/* If next source char is an identifier (eg. 'i' in "definite") no match */
if (i == 0 || text_check_identifier(string[i])) {
return -1;
}
return i;
}
/* Checks the specified source string for a Python special name. This name must
* start at the beginning of the source string and must be followed by a non-
* identifier (see text_check_identifier(char)) or null character.
*
* If a special name is found, the length of the matching name is returned.
* Otherwise, -1 is returned. */
static int txtfmt_py_find_specialvar(const char *string)
{
int i, len;
/* Keep aligned args for readability. */
/* clang-format off */
if (STR_LITERAL_STARTSWITH(string, "def", len)) { i = len;
} else if (STR_LITERAL_STARTSWITH(string, "class", len)) { i = len;
} else { i = 0;
}
/* clang-format on */
/* If next source char is an identifier (eg. 'i' in "definite") no match */
if (i == 0 || text_check_identifier(string[i])) {
return -1;
}
return i;
}
static int txtfmt_py_find_decorator(const char *string)
{
if (string[0] != '@') {
return -1;
}
if (!text_check_identifier(string[1])) {
return -1;
}
/* Interpret as matrix multiplication when followed by whitespace. */
if (text_check_whitespace(string[1])) {
return -1;
}
int i = 1;
while (text_check_identifier(string[i])) {
i++;
}
return i;
}
static int txtfmt_py_find_bool(const char *string)
{
int i, len;
/* Keep aligned args for readability. */
/* clang-format off */
if (STR_LITERAL_STARTSWITH(string, "None", len)) { i = len;
} else if (STR_LITERAL_STARTSWITH(string, "True", len)) { i = len;
} else if (STR_LITERAL_STARTSWITH(string, "False", len)) { i = len;
} else { i = 0;
}
/* clang-format on */
/* If next source char is an identifier (eg. 'i' in "Nonetheless") no match */
if (i == 0 || text_check_identifier(string[i])) {
return -1;
}
return i;
}
/* Numeral character matching. */
#define TXTFMT_PY_NUMERAL_STRING_COUNT_IMPL(txtfmt_py_numeral_char_is_fn) \
{ \
uint count = 0; \
for (; txtfmt_py_numeral_char_is_fn(*string); string += 1) { \
count += 1; \
} \
return count; \
} \
((void)0)
/* Binary. */
static bool txtfmt_py_numeral_char_is_binary(const char c)
{
return ELEM(c, '0', '1') || (c == '_');
}
static uint txtfmt_py_numeral_string_count_binary(const char *string)
{
TXTFMT_PY_NUMERAL_STRING_COUNT_IMPL(txtfmt_py_numeral_char_is_binary);
}
/* Octal. */
static bool txtfmt_py_numeral_char_is_octal(const char c)
{
return (c >= '0' && c <= '7') || (c == '_');
}
static uint txtfmt_py_numeral_string_count_octal(const char *string)
{
TXTFMT_PY_NUMERAL_STRING_COUNT_IMPL(txtfmt_py_numeral_char_is_octal);
}
/* Decimal. */
static bool txtfmt_py_numeral_char_is_decimal(const char c)
{
return (c >= '0' && c <= '9') || (c == '_');
}
static uint txtfmt_py_numeral_string_count_decimal(const char *string)
{
TXTFMT_PY_NUMERAL_STRING_COUNT_IMPL(txtfmt_py_numeral_char_is_decimal);
}
/* Hexadecimal. */
static bool txtfmt_py_numeral_char_is_hexadecimal(const char c)
{
return (c >= '0' && c <= '9') || (c >= 'a' && c <= 'f') || (c >= 'A' && c <= 'F') || (c == '_');
}
static uint txtfmt_py_numeral_string_count_hexadecimal(const char *string)
{
TXTFMT_PY_NUMERAL_STRING_COUNT_IMPL(txtfmt_py_numeral_char_is_hexadecimal);
}
/* Zeros. */
static bool txtfmt_py_numeral_char_is_zero(const char c)
{
return (ELEM(c, '0', '_'));
}
static uint txtfmt_py_numeral_string_count_zeros(const char *string)
{
TXTFMT_PY_NUMERAL_STRING_COUNT_IMPL(txtfmt_py_numeral_char_is_zero);
}
#undef TXTFMT_PY_NUMERAL_STRING_COUNT_IMPL
static int txtfmt_py_find_numeral_inner(const char *string)
{
if (string == NULL || *string == '\0') {
return -1;
}
const char first = *string, second = *(string + 1);
/* Decimal dot must be followed by a digit, any decimal digit.
* Note that the there can be any number of leading zeros after
* the decimal point (leading zeros are not allowed in integers) */
if (first == '.') {
if (text_check_digit(second)) {
return 1 + txtfmt_py_numeral_string_count_decimal(string + 1);
}
}
else if (first == '0') {
/* Numerals starting with '0x' or '0X' is followed by hexadecimal digits. */
if (ELEM(second, 'x', 'X')) {
return 2 + txtfmt_py_numeral_string_count_hexadecimal(string + 2);
}
/* Numerals starting with '0o' or '0O' is followed by octal digits. */
if (ELEM(second, 'o', 'O')) {
return 2 + txtfmt_py_numeral_string_count_octal(string + 2);
}
/* Numerals starting with '0b' or '0B' is followed by binary digits. */
if (ELEM(second, 'b', 'B')) {
return 2 + txtfmt_py_numeral_string_count_binary(string + 2);
}
/* Other numerals starting with '0' can be followed by any number of '0' characters. */
if (ELEM(second, '0', '_')) {
return 2 + txtfmt_py_numeral_string_count_zeros(string + 2);
}
}
/* Any non-zero digit is the start of a decimal number. */
else if (first > '0' && first <= '9') {
return 1 + txtfmt_py_numeral_string_count_decimal(string + 1);
}
/* A single zero is also allowed. */
return (first == '0') ? 1 : 0;
}
static int txtfmt_py_literal_numeral(const char *string, char prev_fmt)
{
if (string == NULL || *string == '\0') {
return -1;
}
const char first = *string, second = *(string + 1);
if (prev_fmt == FMT_TYPE_NUMERAL) {
/* Previous was a number; if immediately followed by 'e' or 'E' and a digit,
* it's a base 10 exponent (scientific notation). */
if (ELEM(first, 'e', 'E') && (text_check_digit(second) || second == '-')) {
return 1 + txtfmt_py_find_numeral_inner(string + 1);
}
/* Previous was a number; if immediately followed by '.' it's a floating point decimal number.
* NOTE: keep the decimal point, it's needed to allow leading zeros. */
if (first == '.') {
return txtfmt_py_find_numeral_inner(string);
}
/* "Imaginary" part of a complex number ends with 'j' */
if (ELEM(first, 'j', 'J') && !text_check_digit(second)) {
return 1;
}
}
else if ((prev_fmt != FMT_TYPE_DEFAULT) &&
(text_check_digit(first) || (first == '.' && text_check_digit(second)))) {
/* New numeral, starting with a digit or a decimal point followed by a digit. */
return txtfmt_py_find_numeral_inner(string);
}
/* Not a literal numeral. */
return 0;
}
static char txtfmt_py_format_identifier(const char *str)
{
char fmt;
/* Keep aligned args for readability. */
/* clang-format off */
if (txtfmt_py_find_specialvar(str) != -1) { fmt = FMT_TYPE_SPECIAL;
} else if (txtfmt_py_find_builtinfunc(str) != -1) { fmt = FMT_TYPE_KEYWORD;
} else if (txtfmt_py_find_decorator(str) != -1) { fmt = FMT_TYPE_RESERVED;
} else { fmt = FMT_TYPE_DEFAULT;
}
/* clang-format on */
return fmt;
}
static void txtfmt_py_format_line(SpaceText *st, TextLine *line, const bool do_next)
{
FlattenString fs;
const char *str;
char *fmt;
char cont_orig, cont, find, prev = ' ';
int len, i;
/* Get continuation from previous line */
if (line->prev && line->prev->format != NULL) {
fmt = line->prev->format;
cont = fmt[strlen(fmt) + 1]; /* Just after the null-terminator */
BLI_assert((FMT_CONT_ALL & cont) == cont);
}
else {
cont = FMT_CONT_NOP;
}
/* Get original continuation from this line */
if (line->format != NULL) {
fmt = line->format;
cont_orig = fmt[strlen(fmt) + 1]; /* Just after the null-terminator */
BLI_assert((FMT_CONT_ALL & cont_orig) == cont_orig);
}
else {
cont_orig = 0xFF;
}
len = flatten_string(st, &fs, line->line);
str = fs.buf;
if (!text_check_format_len(line, len)) {
flatten_string_free(&fs);
return;
}
fmt = line->format;
while (*str) {
/* Handle escape sequences by skipping both \ and next char */
if (*str == '\\') {
*fmt = prev;
fmt++;
str++;
if (*str == '\0') {
break;
}
*fmt = prev;
fmt++;
str += BLI_str_utf8_size_safe(str);
continue;
}
/* Handle continuations */
if (cont) {
/* Triple strings ("""...""" or '''...''') */
if (cont & FMT_CONT_TRIPLE) {
find = (cont & FMT_CONT_QUOTEDOUBLE) ? '"' : '\'';
if (*str == find && *(str + 1) == find && *(str + 2) == find) {
*fmt = FMT_TYPE_STRING;
fmt++;
str++;
*fmt = FMT_TYPE_STRING;
fmt++;
str++;
cont = FMT_CONT_NOP;
}
/* Handle other strings */
}
else {
find = (cont & FMT_CONT_QUOTEDOUBLE) ? '"' : '\'';
if (*str == find) {
cont = FMT_CONT_NOP;
}
}
*fmt = FMT_TYPE_STRING;
str += BLI_str_utf8_size_safe(str) - 1;
}
/* Not in a string... */
else {
/* Deal with comments first */
if (*str == '#') {
/* fill the remaining line */
text_format_fill(&str, &fmt, FMT_TYPE_COMMENT, len - (int)(fmt - line->format));
}
else if (ELEM(*str, '"', '\'')) {
/* Strings */
find = *str;
cont = (*str == '"') ? FMT_CONT_QUOTEDOUBLE : FMT_CONT_QUOTESINGLE;
if (*(str + 1) == find && *(str + 2) == find) {
*fmt = FMT_TYPE_STRING;
fmt++;
str++;
*fmt = FMT_TYPE_STRING;
fmt++;
str++;
cont |= FMT_CONT_TRIPLE;
}
*fmt = FMT_TYPE_STRING;
}
/* White-space (all ws. has been converted to spaces). */
else if (*str == ' ') {
*fmt = FMT_TYPE_WHITESPACE;
}
/* Literal numerals, "numbers". */
else if ((i = txtfmt_py_literal_numeral(str, prev)) > 0) {
text_format_fill(&str, &fmt, FMT_TYPE_NUMERAL, i);
}
/* Booleans */
else if (prev != FMT_TYPE_DEFAULT && (i = txtfmt_py_find_bool(str)) != -1) {
if (i > 0) {
text_format_fill_ascii(&str, &fmt, FMT_TYPE_NUMERAL, i);
}
else {
str += BLI_str_utf8_size_safe(str) - 1;
*fmt = FMT_TYPE_DEFAULT;
}
}
/* Punctuation */
else if ((*str != '@') && text_check_delim(*str)) {
*fmt = FMT_TYPE_SYMBOL;
}
/* Identifiers and other text (no previous ws. or delims. so text continues) */
else if (prev == FMT_TYPE_DEFAULT) {
str += BLI_str_utf8_size_safe(str) - 1;
*fmt = FMT_TYPE_DEFAULT;
}
/* Not ws, a digit, punct, or continuing text. Must be new, check for special words */
else {
/* Keep aligned args for readability. */
/* clang-format off */
/* Special vars(v) or built-in keywords(b) */
/* keep in sync with 'txtfmt_py_format_identifier()' */
if ((i = txtfmt_py_find_specialvar(str)) != -1) { prev = FMT_TYPE_SPECIAL;
} else if ((i = txtfmt_py_find_builtinfunc(str)) != -1) { prev = FMT_TYPE_KEYWORD;
} else if ((i = txtfmt_py_find_decorator(str)) != -1) { prev = FMT_TYPE_DIRECTIVE;
}
/* clang-format on */
if (i > 0) {
if (prev == FMT_TYPE_DIRECTIVE) { /* can contain utf8 */
text_format_fill(&str, &fmt, prev, i);
}
else {
text_format_fill_ascii(&str, &fmt, prev, i);
}
}
else {
str += BLI_str_utf8_size_safe(str) - 1;
*fmt = FMT_TYPE_DEFAULT;
}
}
}
prev = *fmt;
fmt++;
str++;
}
/* Terminate and add continuation char */
*fmt = '\0';
fmt++;
*fmt = cont;
/* If continuation has changed and we're allowed, process the next line */
if (cont != cont_orig && do_next && line->next) {
txtfmt_py_format_line(st, line->next, do_next);
}
flatten_string_free(&fs);
}
void ED_text_format_register_py(void)
{
static TextFormatType tft = {NULL};
static const char *ext[] = {"py", NULL};
tft.format_identifier = txtfmt_py_format_identifier;
tft.format_line = txtfmt_py_format_line;
tft.ext = ext;
ED_text_format_register(&tft);
}
|