forked from mz2/Fragaria
-
Notifications
You must be signed in to change notification settings - Fork 21
/
example.txt
1258 lines (1022 loc) · 55.5 KB
/
example.txt
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
/*
MGSFragaria
Written by Jonathan Mitchell, jonathan@mugginsoft.com
Find the latest version at https://github.com/mugginsoft/Fragaria
Smultron version 3.6b1, 2009-09-12
Written by Peter Borg, pgw3@mac.com
Find the latest version at http://smultron.sourceforge.net
Licensed under the Apache License, Version 2.0 (the "License"); you may not use
this file except in compliance with the License. You may obtain a copy of the
License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License.
*/
#import "SMLSyntaxColouring.h"
#import "MGSSyntaxDefinition.h"
#import "SMLLayoutManager.h"
#import "MGSSyntaxController.h"
#import "SMLTextView.h"
#import "SMLSyntaxColouringDelegate.h"
#import "NSScanner+Fragaria.h"
// syntax colouring information dictionary keys
NSString *SMLSyntaxGroup = @"group";
NSString *SMLSyntaxGroupID = @"groupID";
NSString *SMLSyntaxWillColour = @"willColour";
NSString *SMLSyntaxAttributes = @"attributes";
NSString *SMLSyntaxInfo = @"syntaxInfo";
// syntax colouring group names
NSString *SMLSyntaxGroupNumber = @"number";
NSString *SMLSyntaxGroupCommand = @"command";
NSString *SMLSyntaxGroupInstruction = @"instruction";
NSString *SMLSyntaxGroupKeyword = @"keyword";
NSString *SMLSyntaxGroupAutoComplete = @"autocomplete";
NSString *SMLSyntaxGroupVariable = @"variable";
NSString *SMLSyntaxGroupFirstString = @"firstString";
NSString *SMLSyntaxGroupSecondString = @"secondString";
NSString *SMLSyntaxGroupAttribute = @"attribute";
NSString *SMLSyntaxGroupSingleLineComment = @"singleLineComment";
NSString *SMLSyntaxGroupMultiLineComment = @"multiLineComment";
NSString *SMLSyntaxGroupSecondStringPass2 = @"secondStringPass2";
static char kcColoursChanged;
@interface SMLSyntaxColouring()
@property (nonatomic, assign) BOOL coloursChanged;
@end
@implementation SMLSyntaxColouring {
SMLLayoutManager __weak *layoutManager;
NSDictionary *commandsColour, *commentsColour, *instructionsColour;
NSDictionary *keywordsColour, *autocompleteWordsColour, *stringsColour;
NSDictionary *variablesColour, *attributesColour, *numbersColour;
NSString *firstStringPattern, *secondStringPattern;
NSString *firstMultilineStringPattern, *secondMultilineStringPattern;
}
@synthesize layoutManager;
#pragma mark - Instance methods
/*
* - initWithLayoutManager:
*/
- (instancetype)initWithLayoutManager:(SMLLayoutManager *)lm
{
if ((self = [super init])) {
layoutManager = lm;
_inspectedCharacterIndexes = [[NSMutableIndexSet alloc] init];
// configure colouring
_coloursOnlyUntilEndOfLine = YES;
[self setColourDefaults];
[self rebuildAttributesCache];
// register for KVO -- observe our own properties.
[self addObserver:self forKeyPath:@"coloursChanged" options:NSKeyValueObservingOptionInitial context:&kcColoursChanged];
[self layoutManagerDidChangeTextStorage];
}
return self;
}
- (void)setColourDefaults
{
_colourForCommands = [NSColor colorWithCalibratedRed:0.031f green:0.0f blue:0.855f alpha:1.0f];
_colourForComments = [NSColor colorWithCalibratedRed:0.0f green:0.45f blue:0.0f alpha:1.0f];
_colourForInstructions = [NSColor colorWithCalibratedRed:0.737f green:0.0f blue:0.647f alpha:1.0f];
_colourForKeywords = [NSColor colorWithCalibratedRed:0.737f green:0.0f blue:0.647f alpha:1.0f];
_colourForAutocomplete = [NSColor colorWithCalibratedRed:0.84f green:0.41f blue:0.006f alpha:1.0f];
_colourForVariables = [NSColor colorWithCalibratedRed:0.73f green:0.0f blue:0.74f alpha:1.0f];
_colourForStrings = [NSColor colorWithCalibratedRed:0.804f green:0.071f blue:0.153f alpha:1.0f];
_colourForAttributes = [NSColor colorWithCalibratedRed:0.50f green:0.5f blue:0.2f alpha:1.0f];
_colourForNumbers = [NSColor colorWithCalibratedRed:0.031f green:0.0f blue:0.855f alpha:1.0f];
_coloursAttributes = _coloursCommands = _coloursInstructions = YES;
_coloursComments = _coloursKeywords = _coloursNumbers = YES;
_coloursStrings = _coloursVariables = YES;
_coloursAutocomplete = NO;
}
#pragma mark - KVO
/*
* + keyPathsForValuesAffectingColoursChanged
* Instead of writing 36 getters and setters, we'll just observe the coloursChanged property.
*/
+ (NSSet *)keyPathsForValuesAffectingColoursChanged
{
return [NSSet setWithArray:@[
NSStringFromSelector(@selector(colourForAttributes)),
NSStringFromSelector(@selector(colourForAutocomplete)),
NSStringFromSelector(@selector(colourForCommands)),
NSStringFromSelector(@selector(colourForComments)),
NSStringFromSelector(@selector(colourForInstructions)),
NSStringFromSelector(@selector(colourForKeywords)),
NSStringFromSelector(@selector(colourForNumbers)),
NSStringFromSelector(@selector(colourForStrings)),
NSStringFromSelector(@selector(colourForVariables)),
NSStringFromSelector(@selector(coloursAttributes)),
NSStringFromSelector(@selector(coloursAutocomplete)),
NSStringFromSelector(@selector(coloursCommands)),
NSStringFromSelector(@selector(coloursComments)),
NSStringFromSelector(@selector(coloursInstructions)),
NSStringFromSelector(@selector(coloursKeywords)),
NSStringFromSelector(@selector(coloursNumbers)),
NSStringFromSelector(@selector(coloursStrings)),
NSStringFromSelector(@selector(coloursVariables)),
]];
}
/*
* - observeValueForKeyPath:ofObject:change:context:
*/
- (void)observeValueForKeyPath:(NSString *)keyPath ofObject:(id)object change:(NSDictionary *)change context:(void *)context
{
if (context == &kcColoursChanged) {
[self rebuildAttributesCache];
[self invalidateAllColouring];
} else {
[super observeValueForKeyPath:keyPath ofObject:object change:change context:context];
}
}
/*
* - dealloc
*/
-(void)dealloc
{
[self removeObserver:self forKeyPath:@"coloursChanged"];
[[NSNotificationCenter defaultCenter] removeObserver:self];
}
#pragma mark - Text change notification
- (void)textStorageDidProcessEditing:(NSNotification*)notification
{
NSTextStorage *ts = [notification object];
NSRange newRange = [ts editedRange];
NSRange oldRange = newRange;
NSInteger changeInLength = [ts changeInLength];
NSMutableIndexSet *insp = self.inspectedCharacterIndexes;
oldRange.length -= changeInLength;
[insp shiftIndexesStartingAtIndex:NSMaxRange(oldRange) by:changeInLength];
newRange = [[ts string] lineRangeForRange:newRange];
[insp removeIndexesInRange:newRange];
}
#pragma mark - Property getters/setters
- (void)layoutManagerWillChangeTextStorage
{
NSNotificationCenter *nc = [NSNotificationCenter defaultCenter];
[nc removeObserver:self name:NSTextStorageDidProcessEditingNotification
object:layoutManager.textStorage];
}
- (void)layoutManagerDidChangeTextStorage
{
NSNotificationCenter *nc = [NSNotificationCenter defaultCenter];
[nc addObserver:self selector:@selector(textStorageDidProcessEditing:)
name:NSTextStorageDidProcessEditingNotification object:layoutManager.textStorage];
}
/*
* @property syntaxDefinition
*/
- (void)setSyntaxDefinition:(MGSSyntaxDefinition *)syntaxDefinition
{
_syntaxDefinition = syntaxDefinition;
[self prepareRegularExpressions];
[self invalidateAllColouring];
}
/*
* @property syntaxDefinitionName
*/
- (void)setSyntaxDefinitionName:(NSString *)syntaxDefinitionName
{
NSDictionary *syntaxDict;
MGSSyntaxDefinition *syntaxDef;
syntaxDict = [[MGSSyntaxController sharedInstance] syntaxDictionaryWithName:syntaxDefinitionName];
syntaxDef = [[MGSSyntaxDefinition alloc] initFromSyntaxDictionary:syntaxDict name:syntaxDefinitionName];
[self setSyntaxDefinition:syntaxDef];
}
- (NSString*)syntaxDefinitionName
{
return self.syntaxDefinition.name;
}
/*
* @property colourMultiLineStrings
*/
- (void)setColoursMultiLineStrings:(BOOL)coloursMultiLineStrings
{
_coloursMultiLineStrings = coloursMultiLineStrings;
[self invalidateAllColouring];
}
/*
* @property coloursOnlyUntilEndOfLine
*/
- (void)setColoursOnlyUntilEndOfLine:(BOOL)coloursOnlyUntilEndOfLine
{
_coloursOnlyUntilEndOfLine = coloursOnlyUntilEndOfLine;
[self invalidateAllColouring];
}
/*
* - isSyntaxColouringRequired
*/
- (BOOL)isSyntaxColouringRequired
{
return self.syntaxDefinition && self.syntaxDefinition.syntaxDefinitionAllowsColouring;
}
#pragma mark - Colouring
/*
* - rebuildAttributesCache
*/
- (void)rebuildAttributesCache
{
commandsColour = @{NSForegroundColorAttributeName: self.colourForCommands,
SMLSyntaxGroup: SMLSyntaxGroupCommand};
commentsColour = @{NSForegroundColorAttributeName: self.colourForComments,
SMLSyntaxGroup: @"comments"};
instructionsColour = @{NSForegroundColorAttributeName: self.colourForInstructions,
SMLSyntaxGroup: SMLSyntaxGroupInstruction};
keywordsColour = @{NSForegroundColorAttributeName: self.colourForKeywords,
SMLSyntaxGroup: SMLSyntaxGroupKeyword};
autocompleteWordsColour = @{NSForegroundColorAttributeName: self.colourForAutocomplete,
SMLSyntaxGroup: SMLSyntaxGroupAutoComplete};
stringsColour = @{NSForegroundColorAttributeName: self.colourForStrings,
SMLSyntaxGroup: @"strings"};
variablesColour = @{NSForegroundColorAttributeName: self.colourForVariables,
SMLSyntaxGroup: SMLSyntaxGroupVariable};
attributesColour = @{NSForegroundColorAttributeName: self.colourForAttributes,
SMLSyntaxGroup: SMLSyntaxGroupAttribute};
numbersColour = @{NSForegroundColorAttributeName: self.colourForNumbers,
SMLSyntaxGroup: SMLSyntaxGroupNumber};
[self invalidateAllColouring];
}
- (void)prepareRegularExpressions
{
NSString *firstString = self.syntaxDefinition.firstString;
NSString *secondString = self.syntaxDefinition.secondString;
firstStringPattern = [NSString stringWithFormat:@"\\W%@[^%@\\\\\\r\\n]*+(?:\\\\(?:.|$)[^%@\\\\\\r\\n]*+)*+%@", firstString, firstString, firstString, firstString];
secondStringPattern = [NSString stringWithFormat:@"\\W%@[^%@\\\\\\r\\n]*+(?:\\\\(?:.|$)[^%@\\\\]*+)*+%@", secondString, secondString, secondString, secondString];
firstMultilineStringPattern = [NSString stringWithFormat:@"\\W%@[^%@\\\\]*+(?:\\\\(?:.|$)[^%@\\\\]*+)*+%@", firstString, firstString, firstString, firstString];
secondMultilineStringPattern = [NSString stringWithFormat:@"\\W%@[^%@\\\\]*+(?:\\\\(?:.|$)[^%@\\\\]*+)*+%@", secondString, secondString, secondString, secondString];
}
/*
* - invalidateAllColouring
*/
- (void)invalidateAllColouring
{
NSString *string;
string = self.layoutManager.textStorage.string;
NSRange wholeRange = NSMakeRange(0, [string length]);
[layoutManager removeTemporaryAttribute:NSForegroundColorAttributeName forCharacterRange:wholeRange];
[layoutManager removeTemporaryAttribute:SMLSyntaxGroup forCharacterRange:wholeRange];
[self.inspectedCharacterIndexes removeAllIndexes];
}
/*
* - invalidateVisibleRange
*/
- (void)invalidateVisibleRangeOfTextView:(SMLTextView *)textView
{
NSMutableIndexSet *validRanges;
validRanges = self.inspectedCharacterIndexes;
NSRect visibleRect = [[[textView enclosingScrollView] contentView] documentVisibleRect];
NSRange visibleRange = [[textView layoutManager] glyphRangeForBoundingRect:visibleRect inTextContainer:[textView textContainer]];
[validRanges removeIndexesInRange:visibleRange];
}
/*
* - recolourRange:
*/
- (void)recolourRange:(NSRange)range
{
NSMutableIndexSet *invalidRanges;
if (!self.isSyntaxColouringRequired) return;
invalidRanges = [NSMutableIndexSet indexSetWithIndexesInRange:range];
[invalidRanges removeIndexes:self.inspectedCharacterIndexes];
[invalidRanges enumerateRangesUsingBlock:^(NSRange range, BOOL *stop){
if (![self.inspectedCharacterIndexes containsIndexesInRange:range]) {
NSRange nowValid = [self recolourChangedRange:range];
[self.inspectedCharacterIndexes addIndexesInRange:nowValid];
}
}];
}
/*
* - recolourChangedRange:
*/
- (NSRange)recolourChangedRange:(NSRange)rangeToRecolour
{
// setup
NSString *documentString = self.layoutManager.textStorage.string;
NSRange effectiveRange = [documentString lineRangeForRange:rangeToRecolour];
// trace
//NSLog(@"rangeToRecolor location %i length %i", rangeToRecolour.location, rangeToRecolour.length);
// adjust effective range
//
// When multiline strings are coloured we need to scan backwards to
// find where the string might have started if it's "above" the top of the screen,
// or we need to scan forwards to find where a multiline string which wraps off
// the range ends.
//
// This is not always correct but it's better than nothing.
//
if (self.coloursMultiLineStrings) {
NSInteger beginFirstStringInMultiLine = [documentString rangeOfString:self.syntaxDefinition.firstString options:NSBackwardsSearch range:NSMakeRange(0, effectiveRange.location)].location;
if (beginFirstStringInMultiLine != NSNotFound) {
if ([[self syntaxColouringGroupOfCharacterAtIndex:beginFirstStringInMultiLine] isEqual:@"strings"]) {
NSInteger startOfLine = [documentString lineRangeForRange:NSMakeRange(beginFirstStringInMultiLine, 0)].location;
effectiveRange = NSMakeRange(startOfLine, rangeToRecolour.length + (rangeToRecolour.location - startOfLine));
}
}
NSInteger lastStringBegin = [documentString rangeOfString:self.syntaxDefinition.firstString options:NSBackwardsSearch range:rangeToRecolour].location;
if (lastStringBegin != NSNotFound) {
NSRange restOfString = NSMakeRange(NSMaxRange(rangeToRecolour), 0);
restOfString.length = [documentString length] - restOfString.location;
NSInteger lastStringEnd = [documentString rangeOfString:self.syntaxDefinition.firstString options:0 range:restOfString].location;
if (lastStringEnd != NSNotFound) {
NSInteger endOfLine = NSMaxRange([documentString lineRangeForRange:NSMakeRange(lastStringEnd, 0)]);
effectiveRange = NSUnionRange(effectiveRange, NSMakeRange(lastStringBegin, endOfLine-lastStringBegin));
}
}
}
/* Expand the range to not start or end in the middle of an already coloured
* block. */
NSRange longRange;
NSRange wholeRange = NSMakeRange(0, [documentString length]);
if ([layoutManager temporaryAttribute:SMLSyntaxGroup atCharacterIndex:effectiveRange.location longestEffectiveRange:&longRange inRange:wholeRange]) {
effectiveRange = NSUnionRange(effectiveRange, longRange);
}
if ([layoutManager temporaryAttribute:SMLSyntaxGroup atCharacterIndex:NSMaxRange(effectiveRange) longestEffectiveRange:&longRange inRange:wholeRange]) {
effectiveRange = NSUnionRange(effectiveRange, longRange);
}
// assign range string
NSString *rangeString = [documentString substringWithRange:effectiveRange];
NSUInteger rangeStringLength = [rangeString length];
if (rangeStringLength == 0) {
return effectiveRange;
}
// allocate the range scanner
NSScanner *rangeScanner = [[NSScanner alloc] initWithString:rangeString];
[rangeScanner setCharactersToBeSkipped:nil];
// allocate the document scanner
NSScanner *documentScanner = [[NSScanner alloc] initWithString:documentString];
[documentScanner setCharactersToBeSkipped:nil];
// uncolour the range
[layoutManager removeTemporaryAttribute:NSForegroundColorAttributeName forCharacterRange:effectiveRange];
[layoutManager removeTemporaryAttribute:SMLSyntaxGroup forCharacterRange:effectiveRange];
// colouring delegate
NSDictionary *delegateInfo = nil;
// define a block that the colour delegate can use to affect colouring
BOOL (^colourRangeBlock)(NSDictionary *, NSRange) = ^(NSDictionary *colourInfo, NSRange range) {
[self setColour:colourInfo range:range];
// at the moment we always succeed
return YES;
};
@try {
BOOL doColouring = YES;
//
// query delegate about colouring the document
//
if ([self.syntaxColouringDelegate respondsToSelector:@selector(fragariaDocument:shouldColourWithBlock:string:range:info:)]) {
// build minimal delegate info dictionary
delegateInfo = @{SMLSyntaxInfo : self.syntaxDefinition.syntaxDictionary, SMLSyntaxWillColour : @(self.isSyntaxColouringRequired)};
// query delegate about colouring
doColouring = [self.syntaxColouringDelegate fragariaDocument:self.fragaria shouldColourWithBlock:colourRangeBlock string:documentString range:rangeToRecolour info:delegateInfo ];
}
if (doColouring) {
for (NSInteger i = 0; i < kSMLCountOfSyntaxGroups; i++) {
/* Colour all syntax groups */
[self colourGroupWithIdentifier:i inRange:effectiveRange withRangeScanner:rangeScanner documentScanner:documentScanner queryingDelegate:self.syntaxColouringDelegate colouringBlock:colourRangeBlock];
}
//
// tell delegate we are did colour the document
//
if ([self.syntaxColouringDelegate respondsToSelector:@selector(fragariaDocument:didColourWithBlock:string:range:info:)]) {
// build minimal delegate info dictionary
delegateInfo = @{@"syntaxInfo" : self.syntaxDefinition.syntaxDictionary};
[self.syntaxColouringDelegate fragariaDocument:self.fragaria didColourWithBlock:colourRangeBlock string:documentString range:rangeToRecolour info:delegateInfo ];
}
}
}
@catch (NSException *exception) {
NSLog(@"Syntax colouring exception: %@", exception);
}
return effectiveRange;
}
#pragma mark - Coloring passes
- (void)colourGroupWithIdentifier:(NSInteger)group inRange:(NSRange)effectiveRange withRangeScanner:(NSScanner*)rangeScanner documentScanner:(NSScanner*)documentScanner queryingDelegate:(id)colouringDelegate colouringBlock:(BOOL(^)(NSDictionary *, NSRange))colourRangeBlock
{
NSString *groupName;
BOOL doColouring = YES;
NSDictionary *delegateInfo;
NSString *documentString = [documentScanner string];
NSDictionary *attributes;
switch (group) {
case kSMLSyntaxGroupNumber:
groupName = SMLSyntaxGroupNumber;
doColouring = self.coloursNumbers;
attributes = numbersColour;
break;
case kSMLSyntaxGroupCommand:
groupName = SMLSyntaxGroupCommand;
doColouring = self.coloursCommands && ![self.syntaxDefinition.beginCommand isEqual:@""];
attributes = commandsColour;
break;
case kSMLSyntaxGroupInstruction:
groupName = SMLSyntaxGroupInstruction;
doColouring = self.coloursInstructions && (![self.syntaxDefinition.beginInstruction isEqual:@""] || self.syntaxDefinition.instructions);
attributes = instructionsColour;
break;
case kSMLSyntaxGroupKeyword:
groupName = SMLSyntaxGroupKeyword;
doColouring = self.coloursKeywords && [self.syntaxDefinition.keywords count] > 0;
attributes = keywordsColour;
break;
case kSMLSyntaxGroupAutoComplete:
groupName = SMLSyntaxGroupAutoComplete;
doColouring = self.coloursAutocomplete && [self.syntaxDefinition.autocompleteWords count] > 0;
attributes = autocompleteWordsColour;
break;
case kSMLSyntaxGroupVariable:
groupName = SMLSyntaxGroupVariable;
doColouring = self.coloursVariables && (self.syntaxDefinition.beginVariableCharacterSet || self.syntaxDefinition.variableRegex);
attributes = variablesColour;
break;
case kSMLSyntaxGroupSecondString:
groupName = SMLSyntaxGroupSecondString;
doColouring = self.coloursStrings && ![self.syntaxDefinition.secondString isEqual:@""];
attributes = stringsColour;
break;
case kSMLSyntaxGroupFirstString:
groupName = SMLSyntaxGroupFirstString;
doColouring = self.coloursStrings && ![self.syntaxDefinition.firstString isEqual:@""];
attributes = stringsColour;
break;
case kSMLSyntaxGroupAttribute:
groupName = SMLSyntaxGroupAttribute;
doColouring = self.coloursAttributes;
attributes = attributesColour;
break;
case kSMLSyntaxGroupSingleLineComment:
groupName = SMLSyntaxGroupSingleLineComment;
doColouring = self.coloursComments;
attributes = commentsColour;
break;
case kSMLSyntaxGroupMultiLineComment:
groupName = SMLSyntaxGroupMultiLineComment;
doColouring = self.coloursComments;
attributes = commentsColour;
break;
case kSMLSyntaxGroupSecondStringPass2:
groupName = SMLSyntaxGroupSecondStringPass2;
doColouring = self.coloursStrings && ![self.syntaxDefinition.secondString isEqual:@""];
attributes = stringsColour;
break;
default:
[NSException raise:@"Bug" format:@"Unrecognized syntax group identifier %ld", (long)group];
}
if ([colouringDelegate respondsToSelector:@selector(fragariaDocument:shouldColourGroupWithBlock:string:range:info:)]) {
// build delegate info dictionary
delegateInfo = @{SMLSyntaxGroup : groupName, SMLSyntaxGroupID : @(group), SMLSyntaxWillColour : @(doColouring), SMLSyntaxAttributes : attributes, SMLSyntaxInfo : self.syntaxDefinition.syntaxDictionary};
// call the delegate
doColouring = [colouringDelegate fragariaDocument:self.fragaria shouldColourGroupWithBlock:colourRangeBlock string:documentString range:effectiveRange info:delegateInfo];
}
if (!doColouring) return;
// reset scanner
[rangeScanner mgs_setScanLocation:0];
[documentScanner mgs_setScanLocation:0];
switch (group) {
case kSMLSyntaxGroupNumber:
[self colourNumbersInRange:effectiveRange withRangeScanner:rangeScanner documentScanner:documentScanner];
break;
case kSMLSyntaxGroupCommand:
[self colourCommandsInRange:effectiveRange withRangeScanner:rangeScanner documentScanner:documentScanner];
break;
case kSMLSyntaxGroupInstruction:
[self colourInstructionsInRange:effectiveRange withRangeScanner:rangeScanner documentScanner:documentScanner];
break;
case kSMLSyntaxGroupKeyword:
[self colourKeywordsInRange:effectiveRange withRangeScanner:rangeScanner documentScanner:documentScanner];
break;
case kSMLSyntaxGroupAutoComplete:
[self colourAutocompleteInRange:effectiveRange withRangeScanner:rangeScanner documentScanner:documentScanner];
break;
case kSMLSyntaxGroupVariable:
[self colourVariablesInRange:effectiveRange withRangeScanner:rangeScanner documentScanner:documentScanner];
break;
case kSMLSyntaxGroupSecondString:
[self colourSecondStrings1InRange:effectiveRange withRangeScanner:rangeScanner documentScanner:documentScanner];
break;
case kSMLSyntaxGroupFirstString:
[self colourFirstStringsInRange:effectiveRange withRangeScanner:rangeScanner documentScanner:documentScanner];
break;
case kSMLSyntaxGroupAttribute:
[self colourAttributesInRange:effectiveRange withRangeScanner:rangeScanner documentScanner:documentScanner];
break;
case kSMLSyntaxGroupSingleLineComment:
[self colourSingleLineCommentsInRange:effectiveRange withRangeScanner:rangeScanner documentScanner:documentScanner];
break;
case kSMLSyntaxGroupMultiLineComment:
[self colourMultiLineCommentsInRange:effectiveRange withRangeScanner:rangeScanner documentScanner:documentScanner];
break;
case kSMLSyntaxGroupSecondStringPass2:
[self colourSecondStrings2InRange:effectiveRange withRangeScanner:rangeScanner documentScanner:documentScanner];
}
// inform delegate that colouring is done
if ([colouringDelegate respondsToSelector:@selector(fragariaDocument:didColourGroupWithBlock:string:range:info:)]) {
[colouringDelegate fragariaDocument:self.fragaria didColourGroupWithBlock:colourRangeBlock string:documentString range:effectiveRange info:delegateInfo];
}
}
- (void)colourNumbersInRange:(NSRange)colouringRange withRangeScanner:(NSScanner*)rangeScanner documentScanner:(NSScanner*)documentScanner
{
NSInteger colourStartLocation, colourEndLocation, queryLocation;
NSInteger rangeLocation = colouringRange.location;
unichar testCharacter;
NSString *documentString = [documentScanner string];
NSString *rangeString = [rangeScanner string];
if (self.syntaxDefinition.numberDefinition) {
[self colourMatchesOfPattern:self.syntaxDefinition.numberDefinition withAttributes:numbersColour inRange:colouringRange];
return;
}
// scan range to end
while (![rangeScanner isAtEnd]) {
// scan up to a number character
[rangeScanner scanUpToCharactersFromSet:self.syntaxDefinition.numberCharacterSet intoString:NULL];
colourStartLocation = [rangeScanner scanLocation];
// scan to number end
[rangeScanner scanCharactersFromSet:self.syntaxDefinition.numberCharacterSet intoString:NULL];
colourEndLocation = [rangeScanner scanLocation];
if (colourStartLocation == colourEndLocation) {
break;
}
// don't colour if preceding character is a letter.
// this prevents us from colouring numbers in variable names,
queryLocation = colourStartLocation + rangeLocation;
if (queryLocation > 0) {
testCharacter = [documentString characterAtIndex:queryLocation - 1];
// numbers can occur in variable, class and function names
// eg: var_1 should not be coloured as a number
if ([self.syntaxDefinition.nameCharacterSet characterIsMember:testCharacter]) {
continue;
}
}
// @todo: handle constructs such as 1..5 which may occur within some loop constructs
// don't colour a trailing decimal point as some languages may use it as a line terminator
if (colourEndLocation > 0) {
queryLocation = colourEndLocation - 1;
testCharacter = [rangeString characterAtIndex:queryLocation];
if (testCharacter == self.syntaxDefinition.decimalPointCharacter) {
colourEndLocation--;
}
}
[self setColour:numbersColour range:NSMakeRange(colourStartLocation + rangeLocation, colourEndLocation - colourStartLocation)];
}
}
- (void)colourCommandsInRange:(NSRange)colouringRange withRangeScanner:(NSScanner*)rangeScanner documentScanner:(NSScanner*)documentScanner
{
NSInteger colourStartLocation;
NSInteger rangeLocation = colouringRange.location;
NSUInteger endOfLine;
NSInteger searchSyntaxLength = [self.syntaxDefinition.endCommand length];
unichar beginCommandCharacter = [self.syntaxDefinition.beginCommand characterAtIndex:0];
unichar endCommandCharacter = [self.syntaxDefinition.endCommand characterAtIndex:0];
NSString *rangeString = [rangeScanner string];
// reset scanner
[rangeScanner mgs_setScanLocation:0];
// scan range to end
while (![rangeScanner isAtEnd]) {
[rangeScanner scanUpToString:self.syntaxDefinition.beginCommand intoString:nil];
colourStartLocation = [rangeScanner scanLocation];
endOfLine = NSMaxRange([rangeString lineRangeForRange:NSMakeRange(colourStartLocation, 0)]);
if (![rangeScanner scanUpToString:self.syntaxDefinition.endCommand intoString:nil] || [rangeScanner scanLocation] >= endOfLine) {
[rangeScanner mgs_setScanLocation:endOfLine];
continue; // Don't colour it if it hasn't got a closing tag
} else {
// To avoid problems with strings like <yada <%=yada%> yada> we need to balance the number of begin- and end-tags
// If ever there's a beginCommand or endCommand with more than one character then do a check first
NSUInteger commandLocation = colourStartLocation + 1;
NSUInteger skipEndCommand = 0;
while (commandLocation < endOfLine) {
unichar commandCharacterTest = [rangeString characterAtIndex:commandLocation];
if (commandCharacterTest == endCommandCharacter) {
if (!skipEndCommand) {
break;
} else {
skipEndCommand--;
}
}
if (commandCharacterTest == beginCommandCharacter) {
skipEndCommand++;
}
commandLocation++;
}
if (commandLocation < endOfLine) {
[rangeScanner mgs_setScanLocation:commandLocation + searchSyntaxLength];
} else {
[rangeScanner mgs_setScanLocation:endOfLine];
}
}
[self setColour:commandsColour range:NSMakeRange(colourStartLocation + rangeLocation, [rangeScanner scanLocation] - colourStartLocation)];
}
}
- (void)colourInstructionsInRange:(NSRange)rangeToRecolour withRangeScanner:(NSScanner*)rangeScanner documentScanner:(NSScanner*)documentScanner
{
NSInteger colourStartLocation, beginLocationInMultiLine, endLocationInMultiLine;
NSInteger rangeLocation = rangeToRecolour.location;
NSRange searchRange;
NSString *documentString = [documentScanner string];
NSUInteger documentStringLength = [documentString length];
NSUInteger maxRangeLocation = NSMaxRange(rangeToRecolour);
if (self.syntaxDefinition.instructions) {
[self colourKeywordsFromSet:self.syntaxDefinition.instructions withAttributes:instructionsColour inRange:rangeToRecolour withRangeScanner:rangeScanner documentScanner:documentScanner];
return;
}
// It takes too long to scan the whole document if it's large, so for instructions, first multi-line comment and second multi-line comment search backwards and begin at the start of the first beginInstruction etc. that it finds from the present position and, below, break the loop if it has passed the scanned range (i.e. after the end instruction)
beginLocationInMultiLine = [documentString rangeOfString:self.syntaxDefinition.beginInstruction options:NSBackwardsSearch range:NSMakeRange(0, rangeLocation)].location;
endLocationInMultiLine = [documentString rangeOfString:self.syntaxDefinition.endInstruction options:NSBackwardsSearch range:NSMakeRange(0, rangeLocation)].location;
if (beginLocationInMultiLine == NSNotFound || (endLocationInMultiLine != NSNotFound && beginLocationInMultiLine < endLocationInMultiLine)) {
beginLocationInMultiLine = rangeLocation;
}
NSInteger searchSyntaxLength = [self.syntaxDefinition.endInstruction length];
// scan document to end
while (![documentScanner isAtEnd]) {
searchRange = NSMakeRange(beginLocationInMultiLine, rangeToRecolour.length);
if (NSMaxRange(searchRange) > documentStringLength) {
searchRange = NSMakeRange(beginLocationInMultiLine, documentStringLength - beginLocationInMultiLine);
}
colourStartLocation = [documentString rangeOfString:self.syntaxDefinition.beginInstruction options:NSLiteralSearch range:searchRange].location;
if (colourStartLocation == NSNotFound) {
break;
}
[documentScanner mgs_setScanLocation:colourStartLocation];
if (![documentScanner scanUpToString:self.syntaxDefinition.endInstruction intoString:nil] || [documentScanner scanLocation] >= documentStringLength) {
if (self.coloursOnlyUntilEndOfLine) {
[documentScanner mgs_setScanLocation:NSMaxRange([documentString lineRangeForRange:NSMakeRange(colourStartLocation, 0)])];
} else {
[documentScanner mgs_setScanLocation:documentStringLength];
}
} else {
if ([documentScanner scanLocation] + searchSyntaxLength <= documentStringLength) {
[documentScanner mgs_setScanLocation:[documentScanner scanLocation] + searchSyntaxLength];
}
}
[self setColour:instructionsColour range:NSMakeRange(colourStartLocation, [documentScanner scanLocation] - colourStartLocation)];
if ([documentScanner scanLocation] > maxRangeLocation) {
break;
}
beginLocationInMultiLine = [documentScanner scanLocation];
}
}
- (void)colourKeywordsInRange:(NSRange)rangeToRecolour withRangeScanner:(NSScanner*)rangeScanner documentScanner:(NSScanner*)documentScanner
{
[self colourKeywordsFromSet:self.syntaxDefinition.keywords withAttributes:keywordsColour inRange:rangeToRecolour withRangeScanner:rangeScanner documentScanner:documentScanner];
}
- (void)colourAutocompleteInRange:(NSRange)rangeToRecolour withRangeScanner:(NSScanner*)rangeScanner documentScanner:(NSScanner*)documentScanner
{
[self colourKeywordsFromSet:self.syntaxDefinition.autocompleteWords withAttributes:autocompleteWordsColour inRange:rangeToRecolour withRangeScanner:rangeScanner documentScanner:documentScanner];
}
- (void)colourVariablesInRange:(NSRange)rangeToRecolour withRangeScanner:(NSScanner*)rangeScanner documentScanner:(NSScanner*)documentScanner
{
NSUInteger colourStartLocation;
NSInteger rangeLocation = rangeToRecolour.location;
NSUInteger endOfLine, colourLength;
NSString *rangeString = [rangeScanner string];
NSUInteger rangeStringLength = [rangeString length];
if (self.syntaxDefinition.variableRegex) {
[self colourMatchesOfPattern:self.syntaxDefinition.variableRegex withAttributes:variablesColour inRange:rangeToRecolour];
return;
}
// scan range to end
while (![rangeScanner isAtEnd]) {
[rangeScanner scanUpToCharactersFromSet:self.syntaxDefinition.beginVariableCharacterSet intoString:nil];
colourStartLocation = [rangeScanner scanLocation];
if (colourStartLocation + 1 < rangeStringLength) {
if ([[self.syntaxDefinition.singleLineComments firstObject] isEqual:@"%"] && [rangeString characterAtIndex:colourStartLocation + 1] == '%') { // To avoid a problem in LaTex with \%
if ([rangeScanner scanLocation] < rangeStringLength) {
[rangeScanner mgs_setScanLocation:colourStartLocation + 1];
}
continue;
}
}
endOfLine = NSMaxRange([rangeString lineRangeForRange:NSMakeRange(colourStartLocation, 0)]);
if (![rangeScanner scanUpToCharactersFromSet:self.syntaxDefinition.endVariableCharacterSet intoString:nil] || [rangeScanner scanLocation] >= endOfLine) {
[rangeScanner mgs_setScanLocation:endOfLine];
colourLength = [rangeScanner scanLocation] - colourStartLocation;
} else {
colourLength = [rangeScanner scanLocation] - colourStartLocation;
if ([rangeScanner scanLocation] < rangeStringLength) {
[rangeScanner mgs_setScanLocation:[rangeScanner scanLocation] + 1];
}
}
[self setColour:variablesColour range:NSMakeRange(colourStartLocation + rangeLocation, colourLength)];
}
}
- (void)colourSecondStrings1InRange:(NSRange)rangeToRecolour withRangeScanner:(NSScanner*)rangeScanner documentScanner:(NSScanner*)documentScanner
{
NSString *stringPattern;
NSRegularExpression *regex;
NSError *error;
NSString *rangeString = [rangeScanner string];
NSInteger rangeLocation = rangeToRecolour.location;
if (!self.coloursMultiLineStrings)
stringPattern = secondStringPattern;
else
stringPattern = secondMultilineStringPattern;
regex = [NSRegularExpression regularExpressionWithPattern:stringPattern options:0 error:&error];
if (error) return;
[regex enumerateMatchesInString:rangeString options:0 range:NSMakeRange(0, [rangeString length]) usingBlock:^(NSTextCheckingResult *match, NSMatchingFlags flags, BOOL *stop) {
NSRange foundRange = [match range];
[self setColour:stringsColour range:NSMakeRange(foundRange.location + rangeLocation + 1, foundRange.length - 1)];
}];
}
- (void)colourFirstStringsInRange:(NSRange)rangeToRecolour withRangeScanner:(NSScanner*)rangeScanner documentScanner:(NSScanner*)documentScanner
{
NSString *stringPattern;
NSRegularExpression *regex;
NSError *error;
NSString *rangeString = [rangeScanner string];
NSInteger rangeLocation = rangeToRecolour.location;
if (!self.coloursMultiLineStrings)
stringPattern = firstStringPattern;
else
stringPattern = firstMultilineStringPattern;
regex = [NSRegularExpression regularExpressionWithPattern:stringPattern options:0 error:&error];
if (error) return;
[regex enumerateMatchesInString:rangeString options:0 range:NSMakeRange(0, [rangeString length]) usingBlock:^(NSTextCheckingResult *match, NSMatchingFlags flags, BOOL *stop) {
NSRange foundRange = [match range];
if ([[self syntaxColouringGroupOfCharacterAtIndex:foundRange.location + rangeLocation] isEqual:@"strings"])
return;
[self setColour:stringsColour range:NSMakeRange(foundRange.location + rangeLocation + 1, foundRange.length - 1)];
}];
}
- (void)colourAttributesInRange:(NSRange)rangeToRecolour withRangeScanner:(NSScanner*)rangeScanner documentScanner:(NSScanner*)documentScanner
{
NSUInteger colourStartLocation, colourEndLocation;
NSInteger rangeLocation = rangeToRecolour.location;
NSString *documentString = [documentScanner string];
NSString *rangeString = [rangeScanner string];
NSUInteger rangeStringLength = [rangeString length];
// scan range to end
while (![rangeScanner isAtEnd]) {
[rangeScanner scanUpToString:@" " intoString:nil];
colourStartLocation = [rangeScanner scanLocation];
if (colourStartLocation + 1 < rangeStringLength) {
[rangeScanner mgs_setScanLocation:colourStartLocation + 1];
} else {
break;
}
if (![[self syntaxColouringGroupOfCharacterAtIndex:(colourStartLocation + rangeLocation)] isEqual:SMLSyntaxGroupCommand]) {
continue;
}
[rangeScanner scanCharactersFromSet:self.syntaxDefinition.attributesCharacterSet intoString:nil];
colourEndLocation = [rangeScanner scanLocation];
if (colourEndLocation + 1 < rangeStringLength) {
[rangeScanner mgs_setScanLocation:[rangeScanner scanLocation] + 1];
}
if ([documentString characterAtIndex:colourEndLocation + rangeLocation] == '=') {
[self setColour:attributesColour range:NSMakeRange(colourStartLocation + rangeLocation, colourEndLocation - colourStartLocation)];
}
}
}
- (void)colourSingleLineCommentsInRange:(NSRange)rangeToRecolour withRangeScanner:(NSScanner*)rangeScanner documentScanner:(NSScanner*)documentScanner
{
NSUInteger colourStartLocation, endOfLine;
NSRange rangeOfLine;
NSInteger rangeLocation = rangeToRecolour.location;
NSString *documentString = [documentScanner string];
NSString *rangeString = [rangeScanner string];
NSUInteger rangeStringLength = [rangeString length];
NSUInteger documentStringLength = [documentString length];
NSUInteger searchSyntaxLength;
if (self.syntaxDefinition.singleLineCommentRegex) {
[self colourMatchesOfPattern:self.syntaxDefinition.singleLineCommentRegex withAttributes:commentsColour inRange:rangeToRecolour];
return;
}
for (NSString *singleLineComment in self.syntaxDefinition.singleLineComments) {
if (![singleLineComment isEqualToString:@""]) {
// reset scanner
[rangeScanner mgs_setScanLocation:0];
searchSyntaxLength = [singleLineComment length];
// scan range to end
while (![rangeScanner isAtEnd]) {
// scan for comment
[rangeScanner scanUpToString:singleLineComment intoString:nil];
colourStartLocation = [rangeScanner scanLocation];
// common case handling
if ([singleLineComment isEqualToString:@"//"]) {
if (colourStartLocation > 0 && [rangeString characterAtIndex:colourStartLocation - 1] == ':') {
[rangeScanner mgs_setScanLocation:colourStartLocation + 1];
continue; // To avoid http:// ftp:// file:// etc.
}
} else if ([singleLineComment isEqualToString:@"#"]) {
if (rangeStringLength > 1) {
rangeOfLine = [rangeString lineRangeForRange:NSMakeRange(colourStartLocation, 0)];
if ([rangeString rangeOfString:@"#!" options:NSLiteralSearch range:rangeOfLine].location != NSNotFound) {
[rangeScanner mgs_setScanLocation:NSMaxRange(rangeOfLine)];
continue; // Don't treat the line as a comment if it begins with #!
} else if (colourStartLocation > 0 && [rangeString characterAtIndex:colourStartLocation - 1] == '$') {
[rangeScanner mgs_setScanLocation:colourStartLocation + 1];
continue; // To avoid $#
} else if (colourStartLocation > 0 && [rangeString characterAtIndex:colourStartLocation - 1] == '&') {
[rangeScanner mgs_setScanLocation:colourStartLocation + 1];
continue; // To avoid &#
}
}
} else if ([singleLineComment isEqualToString:@"%"]) {
if (rangeStringLength > 1) {
if (colourStartLocation > 0 && [rangeString characterAtIndex:colourStartLocation - 1] == '\\') {
[rangeScanner mgs_setScanLocation:colourStartLocation + 1];
continue; // To avoid \% in LaTex
}
}
}