-
Notifications
You must be signed in to change notification settings - Fork 114
/
grammar.ts
1768 lines (1503 loc) · 57.5 KB
/
grammar.ts
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
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*---------------------------------------------------------
* Copyright (C) Microsoft Corporation. All rights reserved.
*--------------------------------------------------------*/
import { clone, mergeObjects } from './utils';
import { IRawGrammar, IRawRepository, IRawRule, IOnigLib, IOnigCaptureIndex, OnigString, OnigScanner, FindOption } from './types';
import { IRuleRegistry, IRuleFactoryHelper, RuleFactory, Rule, CaptureRule, BeginEndRule, BeginWhileRule, MatchRule, CompiledRule } from './rule';
import { createMatchers, Matcher } from './matcher';
import { MetadataConsts, IGrammar, ITokenizeLineResult, ITokenizeLineResult2, IToken, IEmbeddedLanguagesMap, StandardTokenType, StackElement as StackElementDef, ITokenTypeMap } from './main';
import { DebugFlags, UseOnigurumaFindOptions } from './debug';
import { FontStyle, ThemeTrieElementRule } from './theme';
declare let performance: { now: () => number } | undefined;
const performanceNow = (function () {
if (typeof performance === 'undefined') {
// performance.now() is not available in this environment, so use Date.now()
return () => Date.now();
} else {
return () => performance!.now();
}
})();
export const enum TemporaryStandardTokenType {
Other = 0,
Comment = 1,
String = 2,
RegEx = 4,
MetaEmbedded = 8
}
export function createGrammar(scopeName: string, grammar: IRawGrammar, initialLanguage: number, embeddedLanguages: IEmbeddedLanguagesMap | null, tokenTypes: ITokenTypeMap | null, grammarRepository: IGrammarRepository & IThemeProvider, onigLib: IOnigLib): Grammar {
return new Grammar(scopeName, grammar, initialLanguage, embeddedLanguages, tokenTypes, grammarRepository, onigLib);//TODO
}
export interface IThemeProvider {
themeMatch(scopeName: string): ThemeTrieElementRule[];
getDefaults(): ThemeTrieElementRule;
}
export interface IGrammarRepository {
lookup(scopeName: string): IRawGrammar | undefined;
injections(scopeName: string): string[];
}
export interface IScopeNameSet {
[scopeName: string]: boolean;
}
export class FullScopeDependency {
constructor(
public readonly scopeName: string
) { }
}
export class PartialScopeDependency {
constructor(
public readonly scopeName: string,
public readonly include: string
) { }
public toKey(): string {
return `${this.scopeName}#${this.include}`;
}
}
export type ScopeDependency = FullScopeDependency | PartialScopeDependency;
export class ScopeDependencyCollector {
public readonly full: FullScopeDependency[];
public readonly partial: PartialScopeDependency[];
public readonly visitedRule: Set<IRawRule>;
private readonly _seenFull: Set<string>;
private readonly _seenPartial: Set<string>;
constructor() {
this.full = [];
this.partial = [];
this.visitedRule = new Set<IRawRule>();
this._seenFull = new Set<string>();
this._seenPartial = new Set<string>();
}
public add(dep: ScopeDependency): void {
if (dep instanceof FullScopeDependency) {
if (!this._seenFull.has(dep.scopeName)) {
this._seenFull.add(dep.scopeName);
this.full.push(dep);
}
} else {
if (!this._seenPartial.has(dep.toKey())) {
this._seenPartial.add(dep.toKey());
this.partial.push(dep);
}
}
}
}
/**
* Fill in `result` all external included scopes in `patterns`
*/
function _extractIncludedScopesInPatterns(result: ScopeDependencyCollector, baseGrammar: IRawGrammar, selfGrammar: IRawGrammar, patterns: IRawRule[], repository: IRawRepository | undefined): void {
for (const pattern of patterns) {
if (result.visitedRule.has(pattern)) {
continue;
}
result.visitedRule.add(pattern);
const patternRepository = (pattern.repository ? mergeObjects({}, repository, pattern.repository) : repository);
if (Array.isArray(pattern.patterns)) {
_extractIncludedScopesInPatterns(result, baseGrammar, selfGrammar, pattern.patterns, patternRepository);
}
const include = pattern.include;
if (!include) {
continue;
}
if (include === '$base' || include === baseGrammar.scopeName) {
collectDependencies(result, baseGrammar, baseGrammar);
} else if (include === '$self' || include === selfGrammar.scopeName) {
collectDependencies(result, baseGrammar, selfGrammar);
} else if (include.charAt(0) === '#') {
collectSpecificDependencies(result, baseGrammar, selfGrammar, include.substring(1), patternRepository);
} else {
const sharpIndex = include.indexOf('#');
if (sharpIndex >= 0) {
const scopeName = include.substring(0, sharpIndex);
const includedName = include.substring(sharpIndex + 1);
if (scopeName === baseGrammar.scopeName) {
collectSpecificDependencies(result, baseGrammar, baseGrammar, includedName, patternRepository);
} else if (scopeName === selfGrammar.scopeName) {
collectSpecificDependencies(result, baseGrammar, selfGrammar, includedName, patternRepository);
} else {
result.add(new PartialScopeDependency(scopeName, include.substring(sharpIndex + 1)));
}
} else {
result.add(new FullScopeDependency(include));
}
}
}
}
export class ScopeDependencyProcessor {
public readonly seenFullScopeRequests = new Set<string>();
public readonly seenPartialScopeRequests = new Set<string>();
public Q: ScopeDependency[];
constructor(
public readonly repo: IGrammarRepository,
public readonly initialScopeName: string
) {
this.seenFullScopeRequests.add(this.initialScopeName);
this.Q = [new FullScopeDependency(this.initialScopeName)];
}
public processQueue(): void {
const q = this.Q;
this.Q = [];
const deps = new ScopeDependencyCollector();
for (const dep of q) {
collectDependenciesForDep(this.repo, this.initialScopeName, deps, dep);
}
for (const dep of deps.full) {
if (this.seenFullScopeRequests.has(dep.scopeName)) {
// already processed
continue;
}
this.seenFullScopeRequests.add(dep.scopeName);
this.Q.push(dep);
}
for (const dep of deps.partial) {
if (this.seenFullScopeRequests.has(dep.scopeName)) {
// already processed in full
continue;
}
if (this.seenPartialScopeRequests.has(dep.toKey())) {
// already processed
continue;
}
this.seenPartialScopeRequests.add(dep.toKey());
this.Q.push(dep);
}
}
}
function collectDependenciesForDep(repo: IGrammarRepository, initialScopeName: string, result: ScopeDependencyCollector, dep: FullScopeDependency | PartialScopeDependency) {
const grammar = repo.lookup(dep.scopeName);
if (!grammar) {
if (dep.scopeName === initialScopeName) {
throw new Error(`No grammar provided for <${initialScopeName}>`);
}
return;
}
if (dep instanceof FullScopeDependency) {
collectDependencies(result, repo.lookup(initialScopeName)!, grammar);
} else {
collectSpecificDependencies(result, repo.lookup(initialScopeName)!, grammar, dep.include);
}
const injections = repo.injections(dep.scopeName);
if (injections) {
for (const injection of injections) {
result.add(new FullScopeDependency(injection));
}
}
}
/**
* Collect a specific dependency from the grammar's repository
*/
function collectSpecificDependencies(result: ScopeDependencyCollector, baseGrammar: IRawGrammar, selfGrammar: IRawGrammar, include: string, repository: IRawRepository | undefined = selfGrammar.repository): void {
if (repository && repository[include]) {
const rule = repository[include];
_extractIncludedScopesInPatterns(result, baseGrammar, selfGrammar, [rule], repository);
}
}
/**
* Collects the list of all external included scopes in `grammar`.
*/
function collectDependencies(result: ScopeDependencyCollector, baseGrammar: IRawGrammar, selfGrammar: IRawGrammar): void {
if (selfGrammar.patterns && Array.isArray(selfGrammar.patterns)) {
_extractIncludedScopesInPatterns(result, baseGrammar, selfGrammar, selfGrammar.patterns, selfGrammar.repository);
}
if (selfGrammar.injections) {
let injections: IRawRule[] = [];
for (let injection in selfGrammar.injections) {
injections.push(selfGrammar.injections[injection]);
}
_extractIncludedScopesInPatterns(result, baseGrammar, selfGrammar, injections, selfGrammar.repository);
}
}
export interface Injection {
readonly debugSelector: string;
readonly matcher: Matcher<string[]>;
readonly priority: -1 | 0 | 1; // 0 is the default. -1 for 'L' and 1 for 'R'
readonly ruleId: number;
readonly grammar: IRawGrammar;
}
function scopesAreMatching(thisScopeName: string, scopeName: string): boolean {
if (!thisScopeName) {
return false;
}
if (thisScopeName === scopeName) {
return true;
}
const len = scopeName.length;
return thisScopeName.length > len && thisScopeName.substr(0, len) === scopeName && thisScopeName[len] === '.';
}
function nameMatcher(identifers: string[], scopes: string[]) {
if (scopes.length < identifers.length) {
return false;
}
let lastIndex = 0;
return identifers.every(identifier => {
for (let i = lastIndex; i < scopes.length; i++) {
if (scopesAreMatching(scopes[i], identifier)) {
lastIndex = i + 1;
return true;
}
}
return false;
});
}
function collectInjections(result: Injection[], selector: string, rule: IRawRule, ruleFactoryHelper: IRuleFactoryHelper, grammar: IRawGrammar): void {
const matchers = createMatchers(selector, nameMatcher);
const ruleId = RuleFactory.getCompiledRuleId(rule, ruleFactoryHelper, grammar.repository);
for (const matcher of matchers) {
result.push({
debugSelector: selector,
matcher: matcher.matcher,
ruleId: ruleId,
grammar: grammar,
priority: matcher.priority
});
}
}
export class ScopeMetadata {
public readonly scopeName: string;
public readonly languageId: number;
public readonly tokenType: TemporaryStandardTokenType;
public readonly themeData: ThemeTrieElementRule[] | null;
constructor(scopeName: string, languageId: number, tokenType: TemporaryStandardTokenType, themeData: ThemeTrieElementRule[] | null) {
this.scopeName = scopeName;
this.languageId = languageId;
this.tokenType = tokenType;
this.themeData = themeData;
}
}
class ScopeMetadataProvider {
private readonly _initialLanguage: number;
private readonly _themeProvider: IThemeProvider;
private _cache: Map<string, ScopeMetadata>;
private _defaultMetaData: ScopeMetadata;
private readonly _embeddedLanguages: IEmbeddedLanguagesMap;
private readonly _embeddedLanguagesRegex: RegExp | null;
constructor(initialLanguage: number, themeProvider: IThemeProvider, embeddedLanguages: IEmbeddedLanguagesMap | null) {
this._initialLanguage = initialLanguage;
this._themeProvider = themeProvider;
this._cache = new Map();
this._defaultMetaData = new ScopeMetadata(
'',
this._initialLanguage,
TemporaryStandardTokenType.Other,
[this._themeProvider.getDefaults()]
);
// embeddedLanguages handling
this._embeddedLanguages = Object.create(null);
if (embeddedLanguages) {
// If embeddedLanguages are configured, fill in `this._embeddedLanguages`
const scopes = Object.keys(embeddedLanguages);
for (let i = 0, len = scopes.length; i < len; i++) {
const scope = scopes[i];
const language = embeddedLanguages[scope];
if (typeof language !== 'number' || language === 0) {
console.warn('Invalid embedded language found at scope ' + scope + ': <<' + language + '>>');
// never hurts to be too careful
continue;
}
this._embeddedLanguages[scope] = language;
}
}
// create the regex
const escapedScopes = Object.keys(this._embeddedLanguages).map((scopeName) => ScopeMetadataProvider._escapeRegExpCharacters(scopeName));
if (escapedScopes.length === 0) {
// no scopes registered
this._embeddedLanguagesRegex = null;
} else {
escapedScopes.sort();
escapedScopes.reverse();
this._embeddedLanguagesRegex = new RegExp(`^((${escapedScopes.join(')|(')}))($|\\.)`, '');
}
}
public onDidChangeTheme(): void {
this._cache = new Map();
this._defaultMetaData = new ScopeMetadata(
'',
this._initialLanguage,
TemporaryStandardTokenType.Other,
[this._themeProvider.getDefaults()]
);
}
public getDefaultMetadata(): ScopeMetadata {
return this._defaultMetaData;
}
/**
* Escapes regular expression characters in a given string
*/
private static _escapeRegExpCharacters(value: string): string {
return value.replace(/[\-\\\{\}\*\+\?\|\^\$\.\,\[\]\(\)\#\s]/g, '\\$&');
}
private static _NULL_SCOPE_METADATA = new ScopeMetadata('', 0, 0, null);
public getMetadataForScope(scopeName: string | null): ScopeMetadata {
if (scopeName === null) {
return ScopeMetadataProvider._NULL_SCOPE_METADATA;
}
let value = this._cache.get(scopeName);
if (value) {
return value;
}
value = this._doGetMetadataForScope(scopeName);
this._cache.set(scopeName, value);
return value;
}
private _doGetMetadataForScope(scopeName: string): ScopeMetadata {
const languageId = this._scopeToLanguage(scopeName);
const standardTokenType = this._toStandardTokenType(scopeName);
const themeData = this._themeProvider.themeMatch(scopeName);
return new ScopeMetadata(scopeName, languageId, standardTokenType, themeData);
}
/**
* Given a produced TM scope, return the language that token describes or null if unknown.
* e.g. source.html => html, source.css.embedded.html => css, punctuation.definition.tag.html => null
*/
private _scopeToLanguage(scope: string): number {
if (!scope) {
return 0;
}
if (!this._embeddedLanguagesRegex) {
// no scopes registered
return 0;
}
const m = scope.match(this._embeddedLanguagesRegex);
if (!m) {
// no scopes matched
return 0;
}
const language = this._embeddedLanguages[m[1]] || 0;
if (!language) {
return 0;
}
return language;
}
private static STANDARD_TOKEN_TYPE_REGEXP = /\b(comment|string|regex|meta\.embedded)\b/;
private _toStandardTokenType(tokenType: string): TemporaryStandardTokenType {
const m = tokenType.match(ScopeMetadataProvider.STANDARD_TOKEN_TYPE_REGEXP);
if (!m) {
return TemporaryStandardTokenType.Other;
}
switch (m[1]) {
case 'comment':
return TemporaryStandardTokenType.Comment;
case 'string':
return TemporaryStandardTokenType.String;
case 'regex':
return TemporaryStandardTokenType.RegEx;
case 'meta.embedded':
return TemporaryStandardTokenType.MetaEmbedded;
}
throw new Error('Unexpected match for standard token type!');
}
}
export class Grammar implements IGrammar, IRuleFactoryHelper, IOnigLib {
private readonly _scopeName: string;
private _rootId: number;
private _lastRuleId: number;
private readonly _ruleId2desc: Rule[];
private readonly _includedGrammars: { [scopeName: string]: IRawGrammar; };
private readonly _grammarRepository: IGrammarRepository;
private readonly _grammar: IRawGrammar;
private _injections: Injection[] | null;
private readonly _scopeMetadataProvider: ScopeMetadataProvider;
private readonly _tokenTypeMatchers: TokenTypeMatcher[];
private readonly _onigLib: IOnigLib;
constructor(scopeName: string, grammar: IRawGrammar, initialLanguage: number, embeddedLanguages: IEmbeddedLanguagesMap | null, tokenTypes: ITokenTypeMap | null, grammarRepository: IGrammarRepository & IThemeProvider, onigLib: IOnigLib) {
this._scopeName = scopeName;
this._scopeMetadataProvider = new ScopeMetadataProvider(initialLanguage, grammarRepository, embeddedLanguages);
this._onigLib = onigLib;
this._rootId = -1;
this._lastRuleId = 0;
this._ruleId2desc = [null!];
this._includedGrammars = {};
this._grammarRepository = grammarRepository;
this._grammar = initGrammar(grammar, null);
this._injections = null;
this._tokenTypeMatchers = [];
if (tokenTypes) {
for (const selector of Object.keys(tokenTypes)) {
const matchers = createMatchers(selector, nameMatcher);
for (const matcher of matchers) {
this._tokenTypeMatchers.push({
matcher: matcher.matcher,
type: tokenTypes[selector]
});
}
}
}
}
public dispose(): void {
for (const rule of this._ruleId2desc) {
if (rule) {
rule.dispose();
}
}
}
public createOnigScanner(sources: string[]): OnigScanner {
return this._onigLib.createOnigScanner(sources);
}
public createOnigString(sources: string): OnigString {
return this._onigLib.createOnigString(sources);
}
public onDidChangeTheme(): void {
this._scopeMetadataProvider.onDidChangeTheme();
}
public getMetadataForScope(scope: string): ScopeMetadata {
return this._scopeMetadataProvider.getMetadataForScope(scope);
}
private _collectInjections(): Injection[] {
const grammarRepository: IGrammarRepository = {
lookup: (scopeName: string): IRawGrammar | undefined => {
if (scopeName === this._scopeName) {
return this._grammar;
}
return this.getExternalGrammar(scopeName);
},
injections: (scopeName: string): string[] => {
return this._grammarRepository.injections(scopeName);
}
};
const dependencyProcessor = new ScopeDependencyProcessor(grammarRepository, this._scopeName);
// TODO: uncomment below to visit all scopes
// while (dependencyProcessor.Q.length > 0) {
// dependencyProcessor.processQueue();
// }
const result: Injection[] = [];
dependencyProcessor.seenFullScopeRequests.forEach((scopeName) => {
const grammar = grammarRepository.lookup(scopeName);
if (!grammar) {
return;
}
// add injections from the current grammar
const rawInjections = grammar.injections;
if (rawInjections) {
for (let expression in rawInjections) {
collectInjections(result, expression, rawInjections[expression], this, grammar);
}
}
// add injection grammars contributed for the current scope
if (this._grammarRepository) {
const injectionScopeNames = this._grammarRepository.injections(scopeName);
if (injectionScopeNames) {
injectionScopeNames.forEach(injectionScopeName => {
const injectionGrammar = this.getExternalGrammar(injectionScopeName);
if (injectionGrammar) {
const selector = injectionGrammar.injectionSelector;
if (selector) {
collectInjections(result, selector, injectionGrammar, this, injectionGrammar);
}
}
});
}
}
});
result.sort((i1, i2) => i1.priority - i2.priority); // sort by priority
return result;
}
public getInjections(): Injection[] {
if (this._injections === null) {
this._injections = this._collectInjections();
if (DebugFlags.InDebugMode && this._injections.length > 0) {
console.log(`Grammar ${this._scopeName} contains the following injections:`);
for (const injection of this._injections) {
console.log(` - ${injection.debugSelector}`);
}
}
}
return this._injections;
}
public registerRule<T extends Rule>(factory: (id: number) => T): T {
const id = (++this._lastRuleId);
const result = factory(id);
this._ruleId2desc[id] = result;
return result;
}
public getRule(patternId: number): Rule {
return this._ruleId2desc[patternId];
}
public getExternalGrammar(scopeName: string, repository?: IRawRepository): IRawGrammar | undefined {
if (this._includedGrammars[scopeName]) {
return this._includedGrammars[scopeName];
} else if (this._grammarRepository) {
const rawIncludedGrammar = this._grammarRepository.lookup(scopeName);
if (rawIncludedGrammar) {
// console.log('LOADED GRAMMAR ' + pattern.include);
this._includedGrammars[scopeName] = initGrammar(rawIncludedGrammar, repository && repository.$base);
return this._includedGrammars[scopeName];
}
}
return undefined;
}
public tokenizeLine(lineText: string, prevState: StackElement | null, timeLimit: number = 0): ITokenizeLineResult {
const r = this._tokenize(lineText, prevState, false, timeLimit);
return {
tokens: r.lineTokens.getResult(r.ruleStack, r.lineLength),
ruleStack: r.ruleStack,
stoppedEarly: r.stoppedEarly
};
}
public tokenizeLine2(lineText: string, prevState: StackElement | null, timeLimit: number = 0): ITokenizeLineResult2 {
const r = this._tokenize(lineText, prevState, true, timeLimit);
return {
tokens: r.lineTokens.getBinaryResult(r.ruleStack, r.lineLength),
ruleStack: r.ruleStack,
stoppedEarly: r.stoppedEarly
};
}
private _tokenize(lineText: string, prevState: StackElement | null, emitBinaryTokens: boolean, timeLimit: number): { lineLength: number; lineTokens: LineTokens; ruleStack: StackElement; stoppedEarly: boolean; } {
if (this._rootId === -1) {
this._rootId = RuleFactory.getCompiledRuleId(this._grammar.repository.$self, this, this._grammar.repository);
}
let isFirstLine: boolean;
if (!prevState || prevState === StackElement.NULL) {
isFirstLine = true;
const rawDefaultMetadata = this._scopeMetadataProvider.getDefaultMetadata();
const defaultTheme = rawDefaultMetadata.themeData![0];
const defaultMetadata = StackElementMetadata.set(0, rawDefaultMetadata.languageId, rawDefaultMetadata.tokenType, defaultTheme.fontStyle, defaultTheme.foreground, defaultTheme.background);
const rootScopeName = this.getRule(this._rootId).getName(null, null);
const rawRootMetadata = this._scopeMetadataProvider.getMetadataForScope(rootScopeName);
const rootMetadata = ScopeListElement.mergeMetadata(defaultMetadata, null, rawRootMetadata);
const scopeList = new ScopeListElement(null, rootScopeName === null ? 'unknown' : rootScopeName, rootMetadata);
prevState = new StackElement(null, this._rootId, -1, -1, false, null, scopeList, scopeList);
} else {
isFirstLine = false;
prevState.reset();
}
lineText = lineText + '\n';
const onigLineText = this.createOnigString(lineText);
const lineLength = onigLineText.content.length;
const lineTokens = new LineTokens(emitBinaryTokens, lineText, this._tokenTypeMatchers);
const r = _tokenizeString(this, onigLineText, isFirstLine, 0, prevState, lineTokens, true, timeLimit);
disposeOnigString(onigLineText);
return {
lineLength: lineLength,
lineTokens: lineTokens,
ruleStack: r.stack,
stoppedEarly: r.stoppedEarly
};
}
}
function disposeOnigString(str: OnigString) {
if (typeof str.dispose === 'function') {
str.dispose();
}
}
function initGrammar(grammar: IRawGrammar, base: IRawRule | null | undefined): IRawGrammar {
grammar = clone(grammar);
grammar.repository = grammar.repository || <any>{};
grammar.repository.$self = {
$vscodeTextmateLocation: grammar.$vscodeTextmateLocation,
patterns: grammar.patterns,
name: grammar.scopeName
};
grammar.repository.$base = base || grammar.repository.$self;
return grammar;
}
function handleCaptures(grammar: Grammar, lineText: OnigString, isFirstLine: boolean, stack: StackElement, lineTokens: LineTokens, captures: (CaptureRule | null)[], captureIndices: IOnigCaptureIndex[]): void {
if (captures.length === 0) {
return;
}
const lineTextContent = lineText.content;
const len = Math.min(captures.length, captureIndices.length);
const localStack: LocalStackElement[] = [];
const maxEnd = captureIndices[0].end;
for (let i = 0; i < len; i++) {
const captureRule = captures[i];
if (captureRule === null) {
// Not interested
continue;
}
const captureIndex = captureIndices[i];
if (captureIndex.length === 0) {
// Nothing really captured
continue;
}
if (captureIndex.start > maxEnd) {
// Capture going beyond consumed string
break;
}
// pop captures while needed
while (localStack.length > 0 && localStack[localStack.length - 1].endPos <= captureIndex.start) {
// pop!
lineTokens.produceFromScopes(localStack[localStack.length - 1].scopes, localStack[localStack.length - 1].endPos);
localStack.pop();
}
if (localStack.length > 0) {
lineTokens.produceFromScopes(localStack[localStack.length - 1].scopes, captureIndex.start);
} else {
lineTokens.produce(stack, captureIndex.start);
}
if (captureRule.retokenizeCapturedWithRuleId) {
// the capture requires additional matching
const scopeName = captureRule.getName(lineTextContent, captureIndices);
const nameScopesList = stack.contentNameScopesList.push(grammar, scopeName);
const contentName = captureRule.getContentName(lineTextContent, captureIndices);
const contentNameScopesList = nameScopesList.push(grammar, contentName);
const stackClone = stack.push(captureRule.retokenizeCapturedWithRuleId, captureIndex.start, -1, false, null, nameScopesList, contentNameScopesList);
const onigSubStr = grammar.createOnigString(lineTextContent.substring(0, captureIndex.end));
_tokenizeString(grammar, onigSubStr, (isFirstLine && captureIndex.start === 0), captureIndex.start, stackClone, lineTokens, false, /* no time limit */0);
disposeOnigString(onigSubStr);
continue;
}
const captureRuleScopeName = captureRule.getName(lineTextContent, captureIndices);
if (captureRuleScopeName !== null) {
// push
const base = localStack.length > 0 ? localStack[localStack.length - 1].scopes : stack.contentNameScopesList;
const captureRuleScopesList = base.push(grammar, captureRuleScopeName);
localStack.push(new LocalStackElement(captureRuleScopesList, captureIndex.end));
}
}
while (localStack.length > 0) {
// pop!
lineTokens.produceFromScopes(localStack[localStack.length - 1].scopes, localStack[localStack.length - 1].endPos);
localStack.pop();
}
}
interface IMatchInjectionsResult {
readonly priorityMatch: boolean;
readonly captureIndices: IOnigCaptureIndex[];
readonly matchedRuleId: number;
}
function debugCompiledRuleToString(ruleScanner: CompiledRule): string {
const r: string[] = [];
for (let i = 0, len = ruleScanner.rules.length; i < len; i++) {
r.push(' - ' + ruleScanner.rules[i] + ': ' + ruleScanner.debugRegExps[i]);
}
return r.join('\n');
}
function getFindOptions(allowA: boolean, allowG: boolean): number {
let options = FindOption.None;
if (!allowA) {
options |= FindOption.NotBeginString;
}
if (!allowG) {
options |= FindOption.NotBeginPosition;
}
return options;
}
function prepareRuleSearch(rule: Rule, grammar: Grammar, endRegexSource: string | null, allowA: boolean, allowG: boolean): { ruleScanner: CompiledRule; findOptions: number; } {
if (UseOnigurumaFindOptions) {
const ruleScanner = rule.compile(grammar, endRegexSource);
const findOptions = getFindOptions(allowA, allowG);
return { ruleScanner, findOptions };
}
const ruleScanner = rule.compileAG(grammar, endRegexSource, allowA, allowG);
return { ruleScanner, findOptions: FindOption.None };
}
function prepareRuleWhileSearch(rule: BeginWhileRule, grammar: Grammar, endRegexSource: string | null, allowA: boolean, allowG: boolean): { ruleScanner: CompiledRule; findOptions: number; } {
if (UseOnigurumaFindOptions) {
const ruleScanner = rule.compileWhile(grammar, endRegexSource);
const findOptions = getFindOptions(allowA, allowG);
return { ruleScanner, findOptions };
}
const ruleScanner = rule.compileWhileAG(grammar, endRegexSource, allowA, allowG);
return { ruleScanner, findOptions: FindOption.None };
}
function matchInjections(injections: Injection[], grammar: Grammar, lineText: OnigString, isFirstLine: boolean, linePos: number, stack: StackElement, anchorPosition: number): IMatchInjectionsResult | null {
// The lower the better
let bestMatchRating = Number.MAX_VALUE;
let bestMatchCaptureIndices: IOnigCaptureIndex[] | null = null;
let bestMatchRuleId: number;
let bestMatchResultPriority: number = 0;
const scopes = stack.contentNameScopesList.generateScopes();
for (let i = 0, len = injections.length; i < len; i++) {
const injection = injections[i];
if (!injection.matcher(scopes)) {
// injection selector doesn't match stack
continue;
}
const rule = grammar.getRule(injection.ruleId);
const { ruleScanner, findOptions } = prepareRuleSearch(rule, grammar, null, isFirstLine, linePos === anchorPosition);
const matchResult = ruleScanner.scanner.findNextMatchSync(lineText, linePos, findOptions);
if (!matchResult) {
continue;
}
if (DebugFlags.InDebugMode) {
console.log(` matched injection: ${injection.debugSelector}`);
console.log(debugCompiledRuleToString(ruleScanner));
}
const matchRating = matchResult.captureIndices[0].start;
if (matchRating >= bestMatchRating) {
// Injections are sorted by priority, so the previous injection had a better or equal priority
continue;
}
bestMatchRating = matchRating;
bestMatchCaptureIndices = matchResult.captureIndices;
bestMatchRuleId = ruleScanner.rules[matchResult.index];
bestMatchResultPriority = injection.priority;
if (bestMatchRating === linePos) {
// No more need to look at the rest of the injections.
break;
}
}
if (bestMatchCaptureIndices) {
return {
priorityMatch: bestMatchResultPriority === -1,
captureIndices: bestMatchCaptureIndices,
matchedRuleId: bestMatchRuleId!
};
}
return null;
}
interface IMatchResult {
readonly captureIndices: IOnigCaptureIndex[];
readonly matchedRuleId: number;
}
function matchRule(grammar: Grammar, lineText: OnigString, isFirstLine: boolean, linePos: number, stack: StackElement, anchorPosition: number): IMatchResult | null {
const rule = stack.getRule(grammar);
const { ruleScanner, findOptions } = prepareRuleSearch(rule, grammar, stack.endRule, isFirstLine, linePos === anchorPosition);
let perfStart = 0;
if (DebugFlags.InDebugMode) {
perfStart = performanceNow();
}
const r = ruleScanner.scanner.findNextMatchSync(lineText, linePos, findOptions);
if (DebugFlags.InDebugMode) {
const elapsedMillis = performanceNow() - perfStart;
if (elapsedMillis > 5) {
console.warn(`Rule ${rule.debugName} (${rule.id}) matching took ${elapsedMillis} against '${lineText}'`);
}
console.log(` scanning for (linePos: ${linePos}, anchorPosition: ${anchorPosition})`);
console.log(debugCompiledRuleToString(ruleScanner));
if (r) {
console.log(`matched rule id: ${ruleScanner.rules[r.index]} from ${r.captureIndices[0].start} to ${r.captureIndices[0].end}`);
}
}
if (r) {
return {
captureIndices: r.captureIndices,
matchedRuleId: ruleScanner.rules[r.index]
};
}
return null;
}
function matchRuleOrInjections(grammar: Grammar, lineText: OnigString, isFirstLine: boolean, linePos: number, stack: StackElement, anchorPosition: number): IMatchResult | null {
// Look for normal grammar rule
const matchResult = matchRule(grammar, lineText, isFirstLine, linePos, stack, anchorPosition);
// Look for injected rules
const injections = grammar.getInjections();
if (injections.length === 0) {
// No injections whatsoever => early return
return matchResult;
}
const injectionResult = matchInjections(injections, grammar, lineText, isFirstLine, linePos, stack, anchorPosition);
if (!injectionResult) {
// No injections matched => early return
return matchResult;
}
if (!matchResult) {
// Only injections matched => early return
return injectionResult;
}
// Decide if `matchResult` or `injectionResult` should win
const matchResultScore = matchResult.captureIndices[0].start;
const injectionResultScore = injectionResult.captureIndices[0].start;
if (injectionResultScore < matchResultScore || (injectionResult.priorityMatch && injectionResultScore === matchResultScore)) {
// injection won!
return injectionResult;
}
return matchResult;
}
interface IWhileStack {
readonly stack: StackElement;
readonly rule: BeginWhileRule;
}
interface IWhileCheckResult {
readonly stack: StackElement;
readonly linePos: number;
readonly anchorPosition: number;
readonly isFirstLine: boolean;
}
/**
* Walk the stack from bottom to top, and check each while condition in this order.
* If any fails, cut off the entire stack above the failed while condition. While conditions
* may also advance the linePosition.
*/
function _checkWhileConditions(grammar: Grammar, lineText: OnigString, isFirstLine: boolean, linePos: number, stack: StackElement, lineTokens: LineTokens): IWhileCheckResult {
let anchorPosition = (stack.beginRuleCapturedEOL ? 0 : -1);
const whileRules: IWhileStack[] = [];
for (let node: StackElement | null = stack; node; node = node.pop()) {
const nodeRule = node.getRule(grammar);
if (nodeRule instanceof BeginWhileRule) {
whileRules.push({
rule: nodeRule,
stack: node
});
}
}
for (let whileRule = whileRules.pop(); whileRule; whileRule = whileRules.pop()) {
const { ruleScanner, findOptions } = prepareRuleWhileSearch(whileRule.rule, grammar, whileRule.stack.endRule, isFirstLine, linePos === anchorPosition);
const r = ruleScanner.scanner.findNextMatchSync(lineText, linePos, findOptions);
if (DebugFlags.InDebugMode) {
console.log(' scanning for while rule');
console.log(debugCompiledRuleToString(ruleScanner));
}
if (r) {
const matchedRuleId = ruleScanner.rules[r.index];
if (matchedRuleId !== -2) {
// we shouldn't end up here
stack = whileRule.stack.pop()!;
break;
}
if (r.captureIndices && r.captureIndices.length) {
lineTokens.produce(whileRule.stack, r.captureIndices[0].start);
handleCaptures(grammar, lineText, isFirstLine, whileRule.stack, lineTokens, whileRule.rule.whileCaptures, r.captureIndices);
lineTokens.produce(whileRule.stack, r.captureIndices[0].end);
anchorPosition = r.captureIndices[0].end;
if (r.captureIndices[0].end > linePos) {
linePos = r.captureIndices[0].end;
isFirstLine = false;
}
}
} else {
if (DebugFlags.InDebugMode) {
console.log(' popping ' + whileRule.rule.debugName + ' - ' + whileRule.rule.debugWhileRegExp);
}
stack = whileRule.stack.pop()!;
break;
}
}
return { stack: stack, linePos: linePos, anchorPosition: anchorPosition, isFirstLine: isFirstLine };
}
class TokenizeStringResult {
constructor(
public readonly stack: StackElement,
public readonly stoppedEarly: boolean