forked from fantaisie-software/purebasic
-
Notifications
You must be signed in to change notification settings - Fork 0
/
HighlightingEngine.pb
1800 lines (1370 loc) · 54 KB
/
HighlightingEngine.pb
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) Fantaisie Software. All rights reserved.
; Dual licensed under the GPL and Fantaisie Software licenses.
; See LICENSE and LICENSE-FANTAISIE in the project root for license information.
;--------------------------------------------------------------------------------------------
CompilerIf Not Defined(SpiderBasic, #PB_Constant)
#SpiderBasic = 0
CompilerEndIf
; Redefine this constant here as it is included by the docmaker as well
;
CompilerIf Not Defined(MaxSizeHT, #PB_Constant)
CompilerIf #PB_Compiler_Unicode
#MaxSizeHT = 65535
CompilerElse
#MaxSizeHT = 255
CompilerEndIf
CompilerEndIf
CompilerIf Not Defined(StringToAscii, #PB_Procedure)
Procedure StringToAscii(String$)
*Buffer = AllocateMemory(StringByteLength(String$, #PB_Ascii) + 1)
If *Buffer
PokeS(*Buffer, String$, -1, #PB_Ascii)
EndIf
ProcedureReturn *Buffer
EndProcedure
CompilerEndIf
; the following are repeated declarations, for the case
; that the engine is used standalone
;
Global Dim ValidCharacters.b(#MaxSizeHT) ; used by Syntax Highlighting and Structure Viewer
; stuff to use if not included from IDE/debugger
; (the ide includes the debugger sources too, that's why
; #PUREBASIC_DEBUGGER is declared there too).
;
CompilerIf Defined(PUREBASIC_DEBUGGER, #PB_Constant) = 0
Structure SourceFileParser
Encoding.l
EndStructure
Structure SourceFile
EnableASM.l
DebuggerData.i
Parser.SourceFileParser
EndStructure
#FILE_LoadFunctions = 0
#FILE_LoadAPI = 1
#DEFAULT_FunctionFile = ""
#DEFAULT_ApiFile = ""
CompilerIf #PB_Compiler_Unicode = 0
; We could use PeekS(Memory, -1, #PB_Ascii) for both code, but it will have a performance hit
;
Macro PeekAscii(Memory)
PeekS(Memory)
EndMacro
Macro PeekAsciiLength(Memory, Length)
PeekS(Memory, Length)
EndMacro
Macro MemoryAsciiLength(Memory)
MemoryStringLength(Memory)
EndMacro
Macro ToAscii(String)
@String
EndMacro
CompilerElse
; not really a macro, but this is a macro in non-unicode mode, that's why it is here
Procedure ToAscii(String$)
Static *Buffer, BufferLength
If BufferLength > 1000000 ; Very big string (> 1MB), free it to clean some mem
FreeMemory(*Buffer)
BufferLength = 0
EndIf
Length = Len(String$) + 1
; Use a cache system to avoid alloc/free at every call, as it can be called a lot
If BufferLength
If BufferLength < Length
*Buffer = ReAllocateMemory(*Buffer, Length, #PB_Memory_NoClear)
EndIf
Else
*Buffer = AllocateMemory(Length, #PB_Memory_NoClear)
EndIf
BufferLength = Length
PokeS(*Buffer, String$, -1, #PB_Ascii)
ProcedureReturn *Buffer
EndProcedure
Macro PeekAscii(Memory)
PeekS(Memory, -1, #PB_Ascii)
EndMacro
Macro PeekAsciiLength(Memory, Length)
PeekS(Memory, Length, #PB_Ascii)
EndMacro
Macro MemoryAsciiLength(Memory)
MemoryStringLength(Memory, #PB_Ascii)
EndMacro
CompilerEndIf
CompilerEndIf
; OS specific highlighting color representation:
;
Global *ASMKeywordColor, *BackgroundColor, *BasicKeywordColor, *CommentColor, *ConstantColor, *LabelColor
Global *NormalTextColor, *NumberColor, *OperatorColor, *PointerColor, *PureKeywordColor, *SeparatorColor, *CustomKeywordColor
Global *StringColor, *StructureColor, *LineNumberColor, *LineNumberBackColor, *MarkerColor, *CurrentLineColor, *CursorColor, *SelectionColor
Global *ModuleColor, *BadEscapeColor
Global *ActiveSource.SourceFile
Global EnableColoring
Global EnableCaseCorrection
Global EnableKeywordBolding
Global SourceStringFormat
Global NbASMKeywords.l ; Need to be a 'long' as the 'Data' is declared as long (32/64 bits)
CompilerIf #SpiderBasic
#NbBasicKeywords = 95
CompilerElse
#NbBasicKeywords = 111
CompilerEndIf
#BasicTypeChars = "ABCUWLSFDQI" ; characters that are basic types (uppercase)
Global Dim BasicKeywordsHT.l(#MaxSizeHT)
Global Dim BasicKeywords.s(#NbBasicKeywords)
Global Dim BasicKeywordsReal.s(#NbBasicKeywords)
Global Dim BasicKeywordsEndKeywords.s(#NbBasicKeywords)
Global Dim BasicKeywordsSpaces.s(#NbBasicKeywords)
Global Dim CustomKeywords.s(0) ; setup by the IDE, works if empty as well (index 0 is ignored!!)
Global Dim CustomKeywordsHT.l(#MaxSizeHT)
Global NbCustomKeywords
Global Dim ConstantList.S(0) ; from StructureViewer, but works also if not included (ConstantListSize will simply be 0)
Global Dim ConstantHT.L(27, 1)
Global ConstantListSize
Global Dim ASMKeywordsHT.l(#MaxSizeHT)
Global Dim APIFunctionsHT.l(#MaxSizeHT)
Global NewMap BasicFunctionMap.l(4096)
Global BasicKeyword$, ASMKeyword$, KnownConstant$, CustomKeyword$
Global NbBasicFunctions, NbApiFunctions
;- Keyword constants
;
; NOTE: These constants must be in sync with the below data section, as they
; represent the numerical index of the keyword in the keywords array.
; This is 1 based as the keyword array is 1 based too
;
; Used by: The Source Parser/resolving of related keywords features, as
; it is faster to refer to keywords by index than by name
;
Enumeration 1
#KEYWORD_Align
#KEYWORD_And
#KEYWORD_Array
#KEYWORD_As
#KEYWORD_Break
#KEYWORD_CallDebugger
#KEYWORD_Case
#KEYWORD_CompilerCase
#KEYWORD_CompilerDefault
#KEYWORD_CompilerElse
#KEYWORD_CompilerElseIf
#KEYWORD_CompilerEndIf
#KEYWORD_CompilerEndSelect
#KEYWORD_CompilerError
#KEYWORD_CompilerIf
#KEYWORD_CompilerSelect
#KEYWORD_CompilerWarning
#KEYWORD_Continue
#KEYWORD_Data
#KEYWORD_DataSection
#KEYWORD_Debug
#KEYWORD_DebugLevel
#KEYWORD_Declare
CompilerIf Not #SpiderBasic
#KEYWORD_DeclareC
#KEYWORD_DeclareCDLL
#KEYWORD_DeclareDLL
CompilerEndIf
#KEYWORD_DeclareModule
#KEYWORD_Default
#KEYWORD_Define
#KEYWORD_Dim
CompilerIf Not #SpiderBasic
#KEYWORD_DisableASM
CompilerEndIf
#KEYWORD_DisableDebugger
#KEYWORD_DisableExplicit
CompilerIf #SpiderBasic
#KEYWORD_DisableJS
CompilerEndIf
#KEYWORD_Else
#KEYWORD_ElseIf
CompilerIf Not #SpiderBasic
#KEYWORD_EnableASM
CompilerEndIf
#KEYWORD_EnableDebugger
#KEYWORD_EnableExplicit
CompilerIf #SpiderBasic
#KEYWORD_EnableJS
CompilerEndIf
#KEYWORD_End
#KEYWORD_EndDataSection
#KEYWORD_EndDeclareModule
#KEYWORD_EndEnumeration
#KEYWORD_EndIf
#KEYWORD_EndImport
#KEYWORD_EndInterface
#KEYWORD_EndMacro
#KEYWORD_EndModule
#KEYWORD_EndProcedure
#KEYWORD_EndSelect
#KEYWORD_EndStructure
CompilerIf Not #SpiderBasic
#KEYWORD_EndStructureUnion
CompilerEndIf
#KEYWORD_EndWith
#KEYWORD_Enumeration
#KEYWORD_EnumerationBinary
#KEYWORD_Extends
CompilerIf Not #SpiderBasic
#KEYWORD_FakeReturn
CompilerEndIf
#KEYWORD_For
#KEYWORD_ForEach
#KEYWORD_ForEver
#KEYWORD_Global
CompilerIf Not #SpiderBasic
#KEYWORD_Gosub
#KEYWORD_Goto
CompilerEndIf
#KEYWORD_If
#KEYWORD_Import
CompilerIf Not #SpiderBasic
#KEYWORD_ImportC
#KEYWORD_IncludeBinary
CompilerEndIf
#KEYWORD_IncludeFile
#KEYWORD_IncludePath
#KEYWORD_Interface
#KEYWORD_List
#KEYWORD_Macro
#KEYWORD_MacroExpandedCount
#KEYWORD_Map
#KEYWORD_Module
#KEYWORD_NewList
#KEYWORD_NewMap
#KEYWORD_Next
#KEYWORD_Not
#KEYWORD_Or
;#KEYWORD_Parallel
#KEYWORD_Procedure
CompilerIf Not #SpiderBasic
#KEYWORD_ProcedureC
#KEYWORD_ProcedureCDLL
#KEYWORD_ProcedureDLL
CompilerEndIf
#KEYWORD_ProcedureReturn
#KEYWORD_Protected
#KEYWORD_Prototype
CompilerIf Not #SpiderBasic
#KEYWORD_PrototypeC
CompilerEndIf
#KEYWORD_Read
#KEYWORD_ReDim
#KEYWORD_Repeat
#KEYWORD_Restore
CompilerIf Not #SpiderBasic
#KEYWORD_Return
CompilerEndIf
#KEYWORD_Runtime
#KEYWORD_Select
#KEYWORD_Shared
#KEYWORD_Static
#KEYWORD_Step
#KEYWORD_Structure
CompilerIf Not #SpiderBasic
#KEYWORD_StructureUnion
CompilerEndIf
#KEYWORD_Swap
CompilerIf Not #SpiderBasic
#KEYWORD_Threaded
CompilerEndIf
#KEYWORD_To
#KEYWORD_UndefineMacro
#KEYWORD_Until
#KEYWORD_UnuseModule
#KEYWORD_UseModule
#KEYWORD_Wend
#KEYWORD_While
#KEYWORD_With
#KEYWORD_XIncludeFile
#KEYWORD_XOr
EndEnumeration
; To reduce CompilerIf across the source, do some aliases
;
CompilerIf #SpiderBasic
#KEYWORD_DeclareC = #KEYWORD_Declare
#KEYWORD_DeclareCDLL = #KEYWORD_Declare
#KEYWORD_DeclareDLL = #KEYWORD_Declare
#KEYWORD_ImportC = #KEYWORD_Import
#KEYWORD_ProcedureC = #KEYWORD_Procedure
#KEYWORD_ProcedureCDLL = #KEYWORD_Procedure
#KEYWORD_ProcedureDLL = #KEYWORD_Procedure
#KEYWORD_PrototypeC = #KEYWORD_Prototype
#KEYWORD_Threaded = #KEYWORD_Global
#KEYWORD_IncludeBinary = #KEYWORD_IncludeFile
CompilerEndIf
CompilerIf #PB_Compiler_EnumerationValue <> #NbBasicKeywords+1
CompilerError "Keyword Constants not in sync with Keyword count!"
CompilerEndIf
; Use a prototype to have the fastest access possible to the callback
;
Prototype HighlightCallback(*StringStart.BYTE, Length, *Color, IsBold, TextChanged)
; For API/BasicFunction array
Structure FunctionEntry
Name$ ; name (in correct case)
Proto$ ; quickhelp string (if any)
*Ascii ; pointer to name in ascii
AsciiBuffer.a[256] ; name in ascii for highlighting engine (which is ascii only)
EndStructure
Structure HighlightPTR
StructureUnion
a.a[0]
b.b[0] ; even when declaring with an array like this, we still
c.c[0] ; can use the single \b, which is perfect for a universal
w.w[0] ; pointer variable
u.u[0]
l.l[0]
f.f[0]
q.q[0]
d.d[0]
i.i[0]
EndStructureUnion
EndStructure
;- Issue scan support for the IDE
;
CompilerIf Defined(PUREBASIC_IDE, #PB_Constant)
; Skip 'Count' characters (not bytes) in Ascii/UTF8 from *Pointer
;
Procedure SkipCharacters(*Pointer.Ascii, Count, StringFormat)
If StringFormat = #PB_Ascii
; simple
ProcedureReturn *Pointer + Count
Else
; must look for utf8 sequences
For i = 1 To Count
If *Pointer\a = 0
ProcedureReturn *Pointer
ElseIf *Pointer\a & %10000000 = %00000000 ; 1 byte
*Pointer + 1
ElseIf *Pointer\a & %11100000 = %11000000 ; 2 byte
*Pointer + 1
If *Pointer\a & %11000000 = %10000000: *Pointer + 1: EndIf ; follow byte
ElseIf *Pointer\a & %11110000 = %11100000 ; 3 byte
*Pointer + 1
If *Pointer\a & %11000000 = %10000000: *Pointer + 1: EndIf ; follow byte
If *Pointer\a & %11000000 = %10000000: *Pointer + 1: EndIf ; follow byte
ElseIf *Pointer\a & %11111000 = %11110000 ; 4 byte
*Pointer + 1
If *Pointer\a & %11000000 = %10000000: *Pointer + 1: EndIf ; follow byte
If *Pointer\a & %11000000 = %10000000: *Pointer + 1: EndIf ; follow byte
If *Pointer\a & %11000000 = %10000000: *Pointer + 1: EndIf ; follow byte
Else ; invalid
*Pointer + 1
EndIf
Next i
ProcedureReturn *Pointer
EndIf
EndProcedure
Procedure HighlightCommentIssues(*StringStart, *LineEnd, *StringEnd, StringFormat, Callback.HighlightCallback)
Static NewList Found.FoundIssue() ; static to avoid constant alloc/free
; scan for issues
; remove the ';' from the scanned string
Comment$ = PeekS(*StringStart+1, *LineEnd - *StringStart, SourceStringFormat)
ScanCommentIssues(Comment$, Found(), #True) ; highlight mode
; add them one by one (and manage space in between)
*Cursor = *StringStart
; Note the \Position values are 1-based, but we did not include the ';' in the
; scanned string. So by starting at 0 here, the ; will be handled correctly when the
; first issue is passed to the callback
Position = 0
ForEach Found()
If Found()\Position > Position
; something between the issues
*Start = *Cursor
*Cursor = SkipCharacters(*Cursor, Found()\Position - Position, StringFormat)
Callback(*Start, *Cursor-*Start, *CommentColor, 0, 0)
EndIf
; output the issue
; Note that only issues with Style<>-1 are returned in highlight mode
*Start = *Cursor
*Cursor = SkipCharacters(*Cursor, Found()\Length, StringFormat)
Callback(*Start, *Cursor-*Start, Found()\Style, 0, 0)
Position = Found()\Position + Found()\Length
Next Found()
; output final comment part
If *Cursor < *StringEnd
Callback(*Cursor, *StringEnd-*Cursor, *CommentColor, 0, 0)
EndIf
EndProcedure
CompilerEndIf
; If *Source and *Target have same content: returns #False
; Otherwise, copy the memory and return #True
Procedure CopyMemoryCheck(*Source.HighlightPTR, *Target.HighlightPTR, Length)
; for a fast equal check, do it in integer blocks
While Length >= SizeOf(Integer)
If *Source\i <> *Target\i
CopyMemory(*Source, *Target, Length)
ProcedureReturn #True
Else
*Source + SizeOf(Integer)
*Target + SizeOf(Integer)
Length - SizeOf(Integer)
EndIf
Wend
; check the last bytes
While Length > 0
If *Source\b <> *Target\b
CopyMemory(*Source, *Target, Length)
ProcedureReturn #True
Else
*Source + 1
*Target + 1
Length - 1
EndIf
Wend
; no check found a difference
ProcedureReturn #False
EndProcedure
Procedure ByteUcase(Byte.a) ; get the upper case value of a char in ascii mode
If Byte >= 'a' And Byte <= 'z'
ProcedureReturn Byte - 'a' + 'A'
Else
ProcedureReturn Byte
EndIf
EndProcedure
Procedure InitSyntaxCheckArrays()
; Build the ValidCharacter table to have have a faster routine to detect
; if the char is a considered as a string or not. Nice improvement :)
;
For k='0' To '9' ; Tell that the ASCII from 0 to 9 are valid
ValidCharacters(k) = 1
Next
For k='A' To 'Z' ; Tell that the ASCII from A to Z are valid
ValidCharacters(k) = 1
Next
For k='a' To 'z' ; Tell that the ASCII from a to z are valid
ValidCharacters(k) = 1
Next
ValidCharacters('_') = 1
; Now, init the internal PureBasic keywords
; can be done here, as it does not need the compiler
;
CurrentChar = 0
Restore BasicKeywords
For k=1 To #NbBasicKeywords
Read.s BasicKeywordsReal(k)
BasicKeywords(k) = LCase(BasicKeywordsReal(k))
Read.s BasicKeywordsEndKeywords(k)
Read.s BasicKeywordsSpaces(k)
Char = Asc(BasicKeywords(k))
If Char <> CurrentChar
BasicKeywordsHT(Char) = k
CurrentChar = Char
EndIf
Next
; This is for the SourceParser which does not convert to lowercase when
; checking the array (as the highlighter does)
;
For Char = 'A' To 'Z'
BasicKeywordsHT(Char) = BasicKeywordsHT(Char+('a'-'A'))
Next Char
; And next, init the ASM keywords
;
CurrentChar = 0
Restore ASMKeywords
Read.l NbASMKeywords
Global Dim ASMKeywords.s(NbASMKeywords)
For k=1 To NbASMKeywords
Read.s ASMKeywords(k)
Char = Asc(ASMKeywords(k))
If Char <> CurrentChar
ASMKeywordsHT(Char) = k
CurrentChar = Char
EndIf
Next
; ASM keywords are all uppercase, so set the lowercase index here
For Char = 'A' To 'Z'
ASMKeywordsHT(Char+('a'-'A')) = ASMKeywordsHT(Char)
Next Char
EndProcedure
Procedure InitSyntaxHighlighting()
Static APIFunctionsRead
NbBasicFunctions = 0
Global Dim BasicFunctions.FunctionEntry(0)
; Only load these files when we are inside the IDE or debugger
;
CompilerIf Defined(PUREBASIC_IDE, #PB_Constant)
If CompilerReady ; only if the compiler is loaded!
CompilerWrite("FUNCTIONLIST")
Response$ = CompilerRead()
NbBasicFunctions = Val(Response$)
If NbBasicFunctions < 10000 And NbBasicFunctions > 0 ; Sanity check... If over, it's a bit strange...
Dim BasicFunctions.FunctionEntry(NbBasicFunctions)
CurrentFunction = 0
Repeat
Response$ = CompilerRead_NoDebug()
If Response$ = "OUTPUT"+Chr(9)+"COMPLETE"
Break
ElseIf CurrentFunction < NbBasicFunctions
space = FindString(Response$, " ", 1)
If space > 0
BasicFunctions(CurrentFunction)\Name$ = Left(Response$, space-1)
BasicFunctions(CurrentFunction)\Proto$ = Right(Response$, Len(Response$)-space)
Else
BasicFunctions(CurrentFunction)\Name$ = Response$
BasicFunctions(CurrentFunction)\Proto$ = ""
EndIf
CurrentFunction + 1
EndIf
ForEver
; Note: The compiler does not always sort this in the same order than the
; PB compare functions so our hashing stops working
; So we add a sort step here to be sure
SortStructuredArray(BasicFunctions(), #PB_Sort_Ascending|#PB_Sort_NoCase, OffsetOf(FunctionEntry\Name$), #PB_String, 0, NbBasicFunctions-1)
; Do the conversion to ascii now, as our pointer field is wrong else!
For i = 0 To NbBasicFunctions-1
PokeS(@BasicFunctions(i)\AsciiBuffer[0], BasicFunctions(i)\Name$, 255, #PB_Ascii)
BasicFunctions(i)\Ascii = @BasicFunctions(i)\AsciiBuffer[0]
Next i
EndIf
EndIf
CompilerEndIf
; PureBasic function Hash Table
;
For k=1 To NbBasicFunctions
BasicFunctionMap(UCase(BasicFunctions(k-1)\Name$)) = k
Next
; Read the API Functions file
;
If APIFunctionsRead = 0 ; only needed once, not on compiler restart
APIFunctionsRead = 1
NbAPIFunctions = 0
Global Dim APIFunctions.FunctionEntry(0)
; Only load these files when we are inside the IDE or debugger
;
CompilerIf Defined(PUREBASIC_DEBUGGER, #PB_Constant)
If ReadFile(#FILE_LoadAPI, PureBasicPath$ + #DEFAULT_ApiFile)
NbAPIFunctions = Val(ReadString(#FILE_LoadAPI, #PB_Ascii))
*Cursor.Byte = AllocateMemory(Lof(#FILE_LoadAPI)+2) ; this one never changes, because the API list isn't compiler generated
*APIFunctionsBuffer = *Cursor
If *Cursor
ReadData(#FILE_LoadAPI, *Cursor, Lof(#FILE_LoadAPI))
Dim APIFunctions.FunctionEntry(NbAPIFunctions)
CurrentFunction = 0
Repeat
*NameStart = *Cursor ; FunctionName
While *Cursor\b <> ' ' And *Cursor\b <> 13 And *Cursor\b <> 10
*Cursor+1
Wend
If *Cursor\b = 13 Or *Cursor\b = 10 ; End of line
*Cursor\b = 0
*Cursor+1
APIFunctions(CurrentFunction)\Name$ = PeekS(*NameStart, -1, #PB_Ascii)
APIFunctions(CurrentFunction)\Proto$ = ""
Else
*Cursor\b = 0
*Cursor+1
APIFunctions(CurrentFunction)\Name$ = PeekS(*NameStart, -1, #PB_Ascii)
*NameStart = *Cursor ; QuickHelo
While *Cursor\b <> 13 And *Cursor\b <> 10 And *Cursor\b ; Skip the end of line
*Cursor+1
Wend
*Cursor\b = 0
*Cursor+1
APIFunctions(CurrentFunction)\Proto$ = PeekS(*NameStart, -1, #PB_Ascii)
EndIf
If (*Cursor\b = 10)
*Cursor+1
EndIf
CurrentFunction+1
Until *Cursor\b = 0 Or CurrentFunction > NbAPIFunctions
; make sure the sorting is ok here too
SortStructuredArray(APIFunctions(), #PB_Sort_Ascending|#PB_Sort_NoCase, OffsetOf(FunctionEntry\Name$), #PB_String, 0, NbAPIFunctions-1)
; Do the conversion to ascii now, as our pointer field is wrong else!
For i = 0 To NbAPIFunctions-1
PokeS(@APIFunctions(i)\AsciiBuffer[0], APIFunctions(i)\Name$, 255, #PB_Ascii)
APIFunctions(i)\Ascii = @APIFunctions(i)\AsciiBuffer[0]
Next i
FreeMemory(*APIFunctionsBuffer)
EndIf
CloseFile(#FILE_LoadAPI)
EndIf
CompilerEndIf
; API function Hash Table
;
CurrentChar = 0
For k=1 To NbAPIFunctions
If APIFunctions(k-1)\Name$
Char = ByteUcase(PeekB(APIFunctions(k-1)\Ascii))
If Char <> CurrentChar
APIFunctionsHT(Char) = k
CurrentChar = Char
EndIf
EndIf
Next
EndIf
; Indicate that highlighting is ready now:
;
IsHighlightingReady = 1
EndProcedure
CompilerIf Defined(PUREBASIC_DEBUGGER, #PB_Constant) ; only in IDE and debugger
Procedure BuildCustomKeywordTable()
Protected NewList TempList.s() ; to collect all words first (from file and list)
; needed for the ValidCharacters!
InitSyntaxCheckArrays()
; make a copy of the IDE list
;
ForEach CustomKeywordList()
Word$ = Trim(RemoveString(CustomKeywordList(), Chr(9)))
*Cursor.Character = @Word$
While *Cursor\c
If ValidCharacters(*Cursor\c) = 0 And *Cursor\c <> '_' And *Cursor\c <> '*' And *Cursor\c <> '$'
Word$ = ""
Break
EndIf
*Cursor + SizeOf(Character)
Wend
If Word$ <> ""
AddElement(TempList())
TempList() = Word$
EndIf
Next CustomKeywordList()
; add the file list if any
;
If CustomKeywordFile$ <> "" And FileSize(CustomKeywordFile$) < 50000 ; just a sanity check to not load an avi :D
If ReadFile(#FILE_LoadFunctions, CustomKeywordFile$)
While Not Eof(#FILE_LoadFunctions)
Word$ = Trim(RemoveString(ReadString(#FILE_LoadFunctions), Chr(9)))
*Cursor.Character = @Word$
While *Cursor\c
If ValidCharacters(*Cursor\c) = 0 And *Cursor\c <> '_' And *Cursor\c <> '*' And *Cursor\c <> '$'
Word$ = ""
Break
EndIf
*Cursor + SizeOf(Character)
Wend
If Word$ <> ""
AddElement(TempList())
TempList() = Word$
EndIf
Wend
CloseFile(#FILE_LoadFunctions)
EndIf
EndIf
; sort the list and fill the highlighter arrays
SortList(TempList(), #PB_Sort_Ascending|#PB_Sort_NoCase)
NbCustomKeywords = ListSize(TempList())
Global Dim CustomKeywords.s(NbCustomKeywords)
For i = 0 To 255
CustomKeywordsHT(i) = 0 ; clear the HT
Next i
CurrentChar = 0
ForEach TempList()
index = ListIndex(TempList())+1 ; index 0 is ignored
CustomKeywords(index) = TempList()
Char = Asc(UCase(Left(TempList(), 1)))
If Char <> CurrentChar
CustomKeywordsHT(Char) = index
CurrentChar = Char
EndIf
Next TempList()
EndProcedure
CompilerEndIf
; do no longer work on strings but only on buffers, to avoid unneeded ascii-unicode conversions
;
Procedure IsAPIFunction(*Word, length)
Result = -1
If length > 2 And PeekB(*Word+length-1) = '_'
length - 1
k = APIFunctionsHT(ByteUcase(PeekB(*Word))) ; We use an HashTable to get access to the index very quickly
If k
k-1
While Quit = 0 And k < NbAPIFunctions
If APIFunctions(k)\Name$ = ""
Quit = 1
Else
Compare = CompareMemoryString(APIFunctions(k)\Ascii, *Word, 1, length, #PB_Ascii) ; Case insensitive compare
If Compare <= 0
If Compare = 0 And length = MemoryAsciiLength(APIFunctions(k)\Ascii) ; important to check the length!
Result = k
Quit = 1
EndIf
Else
Quit = 1
EndIf
EndIf
k+1
Wend
EndIf
EndIf
ProcedureReturn Result
EndProcedure
Procedure IsBasicFunction(Word$) ; Word$ must be in UPPER case
ProcedureReturn BasicFunctionMap(Word$) - 1 ; Will return -1 if not found or the zerobased index of the function in the array
EndProcedure
Procedure IsASMKeyword(Word$)
Word$ = UCase(Word$)
k = ASMKeywordsHT(Asc(Word$)) ; We use an HashTable to get access to the index very quickly
If k
While Quit = 0 And k <= NbASMKeywords
If ASMKeywords(k) <= Word$
If ASMKeywords(k) = Word$
ASMKeyword$ = ASMKeywords(k)
Result = k
Quit = 1
EndIf
Else
Quit = 1
EndIf
k+1
Wend
EndIf
ProcedureReturn Result
EndProcedure
Procedure IsCustomKeyword(Word$)
k = CustomKeywordsHT(Asc(UCase(Word$))) ; We use an HashTable to get access to the index very quickly
If k
While Quit = 0 And k <= NbCustomKeywords
Compare = CompareMemoryString(@CustomKeywords(k), @Word$, #PB_String_NoCase) ; Case insensitive compare
If Compare <= 0
If Compare = 0
CustomKeyword$ = CustomKeywords(k)
Result = k
Quit = 1
EndIf
Else
Quit = 1
EndIf
k+1
Wend
EndIf
ProcedureReturn Result
EndProcedure
Procedure IsKnownConstant(Word$)
ascii = Asc(UCase(Mid(Word$, 2, 1))) ; the word is guaranteed to be longer that that (checked below)
If ascii = '_'
char = 27
ElseIf ascii >= 'A' And ascii <= 'Z'
char = ascii - 'A' + 1
Else
ProcedureReturn 0
EndIf
For i = ConstantHT(char, 0) To ConstantHT(char, 1)
If CompareMemoryString(@Word$, @ConstantList(i), #PB_String_NoCase) = 0
KnownConstant$ = ConstantList(i)
ProcedureReturn 1
EndIf
Next i
EndProcedure
; for detection. use global so it does not need to be done all the time
Global *KeywordStructure = StringToAscii("Structure") ; Don't use ToAscii as it use a single buffer
Global *KeywordInterface = StringToAscii("Interface")
Global *KeywordExtends = StringToAscii("Extends")
; returns true if the current position is after
; a structure or interface keyword
;
Procedure IsAfterStructure(Keyword, *LineStart, *Cursor.HighlightPTR)
; move away from word start char
*Cursor - 1
; skip whitespace
While *Cursor > *LineStart And (*Cursor\b = ' ' Or *Cursor\b = 9)
*Cursor - 1
Wend
; skip structure name
While *Cursor > *LineStart And ValidCharacters(*Cursor\a)
*Cursor - 1
Wend
; skip whitespace
While *Cursor > *LineStart And (*Cursor\b = ' ' Or *Cursor\b = 9)
*Cursor - 1
Wend
; skip keyword
*WordEnd = *Cursor + 1
While *Cursor > *LineStart And ValidCharacters(*Cursor\a)
*Cursor - 1
Wend
; move to start of keyword
; if the 'structure' is not the linestart, we just moved off the word
If ValidCharacters(*Cursor\a) = 0
*Cursor + 1
EndIf
Length = *WordEnd - *Cursor
If Length = 9 And CompareMemoryString(*Cursor, *KeywordStructure, #PB_String_NoCase, 9, #PB_Ascii) = #PB_String_Equal
; extends/align on structure
ProcedureReturn #True
ElseIf Keyword = #KEYWORD_Extends And Length = 9 And CompareMemoryString(*Cursor, *KeywordInterface, #PB_String_NoCase, 9, #PB_Ascii) = #PB_String_Equal
; extends on interface (no align allowed)