-
Notifications
You must be signed in to change notification settings - Fork 42
/
Solidity.sublime-syntax
1318 lines (1148 loc) · 37.8 KB
/
Solidity.sublime-syntax
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
%YAML 1.2
---
name: Solidity
file_extensions: [sol]
scope: source.solidity
variables:
identifier: '(?:[A-Za-z_]\w*)'
identifier_path: '(?:[A-Za-z_][\w\.]*)' # ex.: A.MyStruct
number: '(?:[+-]?\.?\d[\d_eE]*)(?:\.\d+[\deE]*)?'
hex_number: '(?:[+-]?(0[Xx])[0-9a-fA-F_]*)'
math_operator: '(?:\+|\+\+|\-|\-\-|\*|\*\*|\/|\^|\%)'
logical_operator: '(?:\!|\&|\||\~)'
question_mark: '(?:\?)'
comparison_operator: '(?:\>(?:\=)?|\<(?:\=)?|\=\=|\!\=)'
#operator: '{{math_operator}}|{{logical_operator}}|{{question_mark}}|{{comparison_operator}}'
contract: contract
abstract_keyword: abstract
contract_like: '(?:(?:{{abstract_keyword}}\s+)?{{contract}})|(?:interface|library)'
func_modifier: '(?:public|private|internal|external|pure|view|payable|virtual)'
func_modifier_override: override
elementary_type: '(?:address(?:\s+payable)?|string|bytes?\d*|int\d*|uint\d*|bool|u?fixed(?:\d+x\d+)?)'
erc_type: '(?:I?ERC[\dA-Za-z_]\w*)'
type_modifier: '(?:private|public|internal|external|constant|immutable|memory|calldata|storage|override)'
data_location: '(?:memory|storage|calldata)'
event_attributes: '(?:indexed)'
expression_keyword_main: '\b(new|selector)\b'
expression_keyword_error_handling: '\b(revert|require|assert)\b'
expression_keyword_binary_logic: '\b(true|false|null)\b'
special_accessors: '\b(?:this|super)\b'
special_members_keywords: '\.(length|timestamp)\b'
special_object_abi: '\b(?:(abi)\.(decode|encode|encodePacked|encodeWithSelector|encodeWithSignature|encodeCall))\b'
special_object_block: '\b(?:(block)\.(basefee|chainid|coinbase|difficulty|gaslimit|number|timestamp))\b'
special_object_msg: '\b(?:(msg)\.(data|sender|sig|value))\b'
special_object_tx: '\b(?:(tx)\.(gasprice|origin))\b'
special_object_elementary: '\b(?:(string|bytes)\.({{identifier}}))\b'
# standalone special functions
special_functions_crypto: '\b(?:addmod|mulmod|sha256|keccak256|ripemd160|ecrecover)\b'
special_contract_functions: '\b(?:selfdestruct|call|delegatecall|staticcall)\b'
special_functions_other: '\b(?:blockhash|gasleft)\b'
# ↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓
special_functions_standalone: '{{special_functions_crypto}}|{{special_contract_functions}}|{{special_functions_other}}'
string_literals: '\b(hex|unicode)\b'
# var keyword was deprecated in solidity 0.4.20 but we still highlight it for older contracts!
reserved_keywords: \b(var|after|alias|apply|auto|byte|case|copyof|default|define|final|implements|in|inline|let|macro|match|mutable|null|of|partial|promise|reference|relocatable|sealed|sizeof|static|supports|switch|typedef|typeof)\b
ether_units: '(?:wei|gwei|ether)'
time_units: '(?:seconds|minutes|hours|days|weeks)'
assembly_keywords: '\b(let|for|case|switch|default|if)\b'
assembly_operators: '(?:\:\=)'
# https://docs.soliditylang.org/en/v0.8.11/yul.html#evm-dialect
opcode: stop|add|sub|mul|div|sdiv|mod|smod|exp|not|lt|gt|slt|sgt|eq|iszero|and|or|xor|byte|shl|shr|sar|addmod|mulmod|signextend|keccak256|pc|pop|mload|mstore|mstore8|sload|sstore|msize|gas|address|balance|selfbalance|caller|callvalue|calldataload|calldatasize|calldatacopy|codesize|codecopy|extcodesize|extcodecopy|returndatasize|returndatacopy|extcodehash|create|create2|call|callcode|delegatecall|staticcall|return|revert|selfdestruct|invalid|log0|log1|log2|log3|log4|chainid|basefee|origin|gasprice|blockhash|coinbase|timestamp|number|difficulty|gaslimit
contexts:
main:
- match: (?=\S)
push: program
# helpers
else-pop:
- match: (?=\S)
pop: true
eol-pop:
- match: \n
pop: true
# number
number:
- match: '{{number}}'
scope: constant.numeric
hex_number:
- match: '{{hex_number}}'
scope: constant.numeric
# string
# string:
# - match: ([\"\'].*?[\"\'])
# scope: string.quoted
string:
- match: \"
push: string-contents-double-quote
scope: string.quoted
- match: \'
push: string-contents-single-quote
scope: string.quoted
string-contents-double-quote:
- meta_include_prototype: false # don't start a comment inside string
- match: \"
scope: string.quoted
pop: true
- match: \\"
scope: constant.character.escape
- match: \\'
scope: constant.character.escape
- match: \S
scope: string.quoted
- include: eol-pop
string-contents-single-quote:
- meta_include_prototype: false # don't start a comment inside string
- match: \'
scope: string.quoted
pop: true
- match: \\"
scope: constant.character.escape
- match: \\'
scope: constant.character.escape
- match: \S
scope: string.quoted
- include: eol-pop
# program structure
program:
- include: pragma
- include: import
- include: contract
- include: struct
- include: function
- include: error
- include: using-directive
- include: user-defined-type
- include: assembly
- include: variables # actually only constant declarations are allowed but we parse other definitions as well
# comments
prototype:
- include: comments
comments:
- match: /\*\*(?!/)
scope: punctuation.definition.comment.begin
push:
- meta_include_prototype: false
- meta_scope: comment.block.documentation
- match: \*/
scope: punctuation.definition.comment.end
pop: true
- match: /\*
scope: punctuation.definition.comment.begin
push:
- meta_include_prototype: false
- meta_scope: comment.block
- match: \*/
scope: punctuation.definition.comment.end
pop: true
- match: //
scope: punctuation.definition.comment
push:
- meta_include_prototype: false
- meta_scope: comment.line.double-slash
- match: \n
pop: true
# pragma
pragma:
- include: version_pragma
- include: experimental_pragma
- include: abicoder_pragma
version_pragma:
- match: (\bpragma\b)\s+(solidity)\b
captures:
1: keyword.sol
2: keyword.sol
push: version_specification
version_specification:
- match: ([\^><]\=?)?(\d+)(\.\d+(\.\d+)?)?
captures:
1: keyword.sol
2: constant.numeric.integer.sol
3: constant.numeric.integer.sol
- match: \;
pop: true
- include: else-pop
experimental_pragma:
- match: (\bpragma\b)\s+(experimental)\b
captures:
1: keyword.other.sol
2: keyword.other.sol
abicoder_pragma:
- match: (\bpragma\b)\s+(abicoder)\b
captures:
1: keyword.other.sol
2: keyword.other.sol
# import
import:
- match: (\bimport\b)
scope: keyword
push: import-declaration
import-declaration:
- match: \bas\b
scope: keyword
- match: \bfrom\b
scope: keyword
- match: \*
scope: keyword
- match: \;
pop: true
- include: string
- match: .*?
scope: scope
- include: else-pop
# contract
contract:
- match: \b({{contract_like}})\s+({{identifier}})\s+(is)\b
captures:
1: keyword.declaration.class
2: support.function
3: keyword
push: contract-parents
- match: \b({{contract_like}})\s+({{identifier}})\b
captures:
1: keyword.declaration.class
2: support.function
push: contract-body
contract-parents:
- match: '\{'
scope: punctuation.section.block.begin.sol
set: contract-body-contents
- match: '{{erc_type}}'
scope: storage.type
- match: '{{identifier}}'
scope: support.function
- match: '\('
# contract Derived1 is Base(7) {}
push: function-call-arguments
- match: \,
scope: scope
- match: \S+
scope: support.function
contract-body:
- match: '\{'
scope: punctuation.section.block.begin.sol
set: contract-body-contents
- include: else-pop
contract-body-contents:
- match: '\}'
scope: punctuation.section.block.end
pop: true
- include: using-directive
- include: event
- include: variables
- include: constructor
- include: receive_and_fallback
- include: function
- include: error
- include: modifier
- include: struct
- include: enum
- include: reserved-keywords
# struct
struct:
- match: \b(struct)(?:\s+({{identifier}}))?
captures:
1: keyword.declaration.struct
2: support.function
push:
- struct-definition-body
struct-definition-body:
- match: '\{'
scope: punctuation.section.block.begin.sol
set: struct-definition-body-contents
- include: else-pop
struct-definition-body-contents:
- include: variable-declaration
- match: '\}'
scope: punctuation.section.block.end
pop: true
# enum
enum:
- match: \b(enum)\s+({{identifier}})?
captures:
1: keyword.declaration.enum
2: support.function
push:
- enum-body
- match: \b(struct)\s*
captures:
1: keyword
push:
- enum-body
enum-body:
- match: '\{'
scope: punctuation.section.block.begin.sol
set: enum-body-contents
- include: else-pop
enum-body-contents:
#- match: \b{{identifier}}\b
# scope: variable.parameter
- match: '\}'
scope: punctuation.section.block.end
pop: true
# user defined type
# https://docs.soliditylang.org/en/latest/grammar.html#a4.SolidityParser.userDefinedValueTypeDefinition
user-defined-type:
- match: '\b(type)\s+({{identifier}})\s+(is)\s+(?:({{elementary_type}})|({{erc_type}}))'
captures:
1: keyword
2: scope
3: keyword
4: constant.language
5: storage.type
# using
# https://docs.soliditylang.org/en/latest/grammar.html#a4.SolidityParser.usingDirective
# todo?: using {add as +, addInt as +} for UncheckedInt8;
# it is not yet in docs, saw it here: https://blog.soliditylang.org/2021/09/27/user-defined-value-types/
using-directive:
- match: \b(using)\s+(.*?)\s+(for)\b
captures:
1: keyword
2: scope
3: keyword
push: using-declaration
using-declaration:
- include: function
- include: mapping
- include: using-argument
- match: '\*'
scope: keyword
- match: \;
pop: true
- include: else-pop
using-argument:
- match: '\b(?:({{elementary_type}})|({{erc_type}})|({{identifier_path}}))(\s+global)?'
captures:
1: constant.language
2: storage.type
3: scope
4: keyword
# variables
variables:
- include: variable-declaration-with-assignment
- include: variable-declaration
- include: variable-assignment
# variable-assignment
variable-assignment:
- match: \b{{identifier}}\s*(\-?\+?\*?\/?\=)
captures:
1: keyword.operator.assignment
push: expression
- match: \(
scope: punctuation.definition.start.sol
push: tuple-content
# mapping
mapping:
- match: \bmapping\b
scope: keyword
push: mapping-declaration
# mapping when used in function argument declaration
mapping-function-argument:
- match: \bmapping\b
scope: keyword
push: mapping-declaration-function-argument
mapping-declaration:
- match: \(
scope: punctuation.section.block.begin.sol
push:
- mapping-core
- include: mapping-modifiers
- match: \b{{identifier}}\b
- match: \;
pop: true
- include: eol-pop
- include: else-pop
mapping-modifiers:
- match: \b{{type_modifier}}\b
scope: storage.modifier
# mapping when used in function argument declaration
mapping-declaration-function-argument:
- match: \(
scope: punctuation.section.block.begin.sol
push:
- mapping-core
- match: \b({{data_location}})\b # this is the main difference - function argument attributes
captures:
1: storage.modifier
- match: \b{{identifier}}\b
scope: variable.parameter
- include: else-pop
mapping-core:
- include: mapping-from
- match: \=\>
scope: keyword
push:
- match: \bmapping\b # mapping of a mapping
scope: keyword
push: mapping-declaration
- include: mapping-from
- include: else-pop
- match: \)
scope: punctuation.section.block.end.sol
pop: true
# extracted out to be used for nested mappings definitions:
# mapping (address => mapping(uint256 => uint256)) internal my_mapping;
mapping-from:
- match: (?:({{elementary_type}})|({{erc_type}})|({{identifier_path}}))
captures:
1: constant.language
2: storage.type
3: scope
- match: '{{identifier}}'
scope: constant.language
# variable declaration
variable-declaration:
- include: mapping
- match: \b({{elementary_type}}|{{erc_type}})\b # uint256[3][257][16] private precomputedGenerators;
captures:
1: constant.language
2: storage.type
push:
#- variable-identifier
- variable-type
- variable-dimension
- match: \b{{identifier_path}}(?:\[(\d*)\])*\s+((?:{{type_modifier}}\s+)+) # ex: BigInt.bigint memory x = BigInt.fromUint(7); OR even BigInt.bigint[3] memory private x = BigInt.fromUint(7); (rare or never used) -- we cannot push variable-dimension on context here because we need strict matching... minuses are that only the last capture group will have a scope (this is how regexes work) and also we can only have digit, no expressions
captures:
1: constant.numeric
2: storage.modifier
variable-dimension:
- match: \[
scope: punctuation.definition.start.sol
push: expression
- match: \]
scope: punctuation.definition.end.sol
push: variable-dimension
- include: else-pop
variable-type:
- match: \b{{type_modifier}}\b
scope: storage.modifier
- include: else-pop
# variable-identifier:
# - match: \b{{identifier}}\b
# scope: scope
# pop: true
# variable declaration with assignment
variable-declaration-with-assignment:
- include: variable-declaration
- include: try-assignment
try-assignment:
- match: \=
scope: keyword.operator.assignment
push: expression
# tuple
tuple:
- match: '\('
scope: punctuation.definition.start.sol
push: tuple-content
- include: else-pop
tuple-content:
- include: variable-declaration
- include: expression-include
- match: '\)'
scope: punctuation.definition.end.sol
pop: true
- match: ','
- include: else-pop
# control-structure
control-structure:
- include: if-statement
- include: while-loop
- include: for-loop
- include: try-catch
# while loop
while-loop:
- match: \bwhile\b
scope: keyword
push:
- control-structure-body
- expression-in-brackets
- match: \bdo\b
scope: keyword
push:
#- expression-in-brackets
#- while-keyword
- control-structure-body
# if statement
if-statement:
- include: else-if-statement
- include: else-statement
- match: \bif\b
scope: keyword
push:
- control-structure-body
- expression-in-brackets
# Parentheses can *not* be omitted for conditionals, but curly brances can be omitted around single-statement bodies.
expression-in-brackets:
- match: \(
scope: punctuation.definition.start.sol
push: expression
- match: \)
scope: punctuation.section.block.end.sol
pop: true
control-structure-body:
- include: curly-brackets-body-contents # statement without curl brackets: ex.: if () return;
- match: '\{'
scope: punctuation.section.block.begin.sol
push:
- include: curly-brackets-body-contents # ex.: if () { return };
- match: '\}'
scope: punctuation.section.block.end
pop: true
- match: \;
pop: true
- include: else-pop
else-if-statement:
- match: \b(else)\s+(if)\b
captures:
1: keyword
2: keyword
push:
- control-structure-body
- expression-in-brackets
else-statement:
- match: \b(else)\b
scope: keyword
push:
- control-structure-body
# for loop
for-loop:
- match: \bfor\b
scope: keyword
push:
- control-structure-body
- for-loop-arguments
for-loop-arguments:
- match: '\('
scope: punctuation.section.block.begin.sol
push:
- variables-or-expression
- expression
- variables-push
- match: '[^\)]' # this is to contain any problems between for loop arguments (...) ... we match any unmatched thing until closing bracket!
# this way the issues (example: for (strinfg i = 0; i < n; i++) { ) don't spread outside of these brackets
- match: '\)'
scope: punctuation.section.block.end.sol
pop: true
- include: else-pop
variables-push:
- include: variables
- match: ';'
- include: else-pop
variables-or-expression:
- include: variables
- include: expression
# control structure: try-catch
try-catch: # Example: https://solidity.readthedocs.io/en/latest/control-structures.html#try-catch
- match: \btry\b
scope: keyword
push:
- include: function-returns-declaration-include # try feed.getData(token) returns (uint v) {
- include: function-call
- include: expression-include # new ContractName()
- include: else-pop
# curly braces body after try statement is handled outside of our try-catch parser
- match: \bcatch\b
scope: keyword
push:
- match: \b(Error|Panic)\b # } catch Error(string memory /*reason*/) {
scope: storage.type
- include: function-arguments # } catch (bytes memory /*lowLevelData*/) {
- include: else-pop
# curly braces body after catch statement is handled outside of our try-catch parser
# expression
reserved-keywords:
- match: '{{reserved_keywords}}'
scope: keyword.sol.reserved
expression-keyword:
- match: '{{expression_keyword_main}}'
scope: keyword
- match: '{{expression_keyword_error_handling}}'
scope: keyword
- match: '{{expression_keyword_binary_logic}}'
scope: constant.language
- match: '{{special_members_keywords}}'
captures:
1: storage.type
- match: '{{special_object_block}}'
captures:
1: storage.type
2: storage.type
- match: '{{special_object_msg}}'
captures:
1: storage.type
2: storage.type
- match: '{{special_object_tx}}'
captures:
1: storage.type
2: storage.type
expression-include:
- match: \[
scope: punctuation.section.block.begin.expr
push:
- match: \]
scope: punctuation.section.block.end.expr
pop: true
- match: \, # ... = [0,1,2]
- include: expression
- include: type-information-inquiry
- include: ternary-operator
- include: special-accessors
- include: function-call
- include: string-literals
- include: expression-keyword
- match: \b({{number}})\s+({{ether_units}}|{{time_units}})\b
captures:
1: constant.numeric
2: constant.numeric
- match: \(
scope: punctuation.section.block.begin.sol
push: tuple-content
- match: '{{math_operator}}'
scope: keyword.operator.arithmetic
- include: hex_number
- include: number
- include: string
- match: '{{identifier}}'
- match: '{{expression_keyword_main}}'
scope: keyword
- match: '\.'
- match: '{{comparison_operator}}'
scope: keyword.operator.logical
- match: '{{logical_operator}}'
scope: keyword.operator.logical
- match: '{{question_mark}}'
scope: keyword.operator.logical
expression:
- include: expression-include
- match: \;
pop: true
- include: else-pop
# type information - https://docs.soliditylang.org/en/latest/units-and-global-variables.html?highlight=type#type-information
type-information-inquiry:
- match: \b(type)\s*\((?:({{elementary_type}})|({{erc_type}})|({{identifier_path}}))?\)\.({{identifier}})\b # type conversion, ex: uint(-1)
captures:
1: keyword
2: constant.language
3: storage.type
4: scope
5: storage.type
# string literals
# https://docs.soliditylang.org/en/latest/types.html#unicode-literals
# https://docs.soliditylang.org/en/latest/types.html#hexadecimal-literals
string-literals:
- match: ({{string_literals}})(?=[\'\"])
captures:
1: variable.parameter
# ternary operator
ternary-operator:
- match: '{{question_mark}}'
scope: keyword.operator.logical
push:
- include: ternary-colon-operator
- include: expression-include
- include: else-pop
ternary-colon-operator:
- match: '\:'
scope: keyword.operator
special-accessors:
- match: '{{special_accessors}}'
scope: storage.type
# function call
# keep in sync with assembly-function-call!
function-call:
# string.concat(hiMom, missYou);
# has to be before variable-declaration otherwise
# "string" gets parsed as elementary type first and we don't detect string.concat as a group anymore
- match: '{{special_object_elementary}}\s*\('
captures:
1: constant.numeric
2: storage.type
push: function-call-arguments
# r.limbs = new uint[](max(_a.limbs.length, _b.limbs.length));
# uint[] memory newLimbs = new uint[](r.limbs.length + 1);
# we do this because of:
# uint[](...)
- include: variable-declaration
# Conversions from address to address payable are now possible via payable(x), where x must be of type address
- match: '(?:({{elementary_type}}|payable)|({{erc_type}}))\s*(\()' # type conversion, ex: uint(-1)
captures:
1: constant.language
2: storage.type
3: punctuation.section.block.begin.sol
push: function-call-arguments
- match: '({{special_functions_standalone}})\s*\('
captures:
1: storage.type
push: function-call-arguments
- match: '{{special_object_abi}}\s*\('
captures:
1: storage.type
2: storage.type
push: function-call-arguments
- match: '({{expression_keyword_error_handling}})\s*(\()'
captures:
1: keyword
2: punctuation.section.block.begin.sol
push: function-call-arguments
- match: '({{identifier}})\s*(\()'
#- match: '({{identifier}})\s*(?:\{.*?\})?\s*(\()'
captures:
1: support.function
2: punctuation.section.block.begin.sol
push: function-call-arguments
# https://docs.soliditylang.org/en/v0.8.11/control-structures.html#external-function-calls , https://docs.soliditylang.org/en/v0.8.11/control-structures.html#creating-contracts-via-new
# (bool success, ) = recipient.call{ value: amount }("");
# impl.delegatecall{gas: gasleft()}(msg.data);
- match: '\.({{special_contract_functions}})\s*\{'
captures:
1: storage.type
push:
- function-call-arguments
- function-call-named-arguments
# bentoBox.deposit{value: value}(token, msg.sender, to, uint256(amount), uint256(share));
- match: '\.({{identifier}})\s*\{'
captures:
1: support.function
push:
- function-call-arguments
- function-call-named-arguments
# pool = address(new UniswapV3Pool{salt: keccak256(abi.encode(token0, token1, fee))}());
- match: '\b(?<=new)\s+({{identifier}})\s*\{'
captures:
1: support.function
push:
- function-call-arguments
- function-call-named-arguments
function-call-named-arguments:
- include: expression-include
- match: ','
- match: '(\})\s*(\()'
captures:
1: punctuation.section.block.end.sol
2: punctuation.section.block.begin.sol
pop: true
- match: \;
pop: true
function-call-arguments:
- include: expression-include
- match: ','
- match: '\)'
scope: punctuation.section.block.end.sol
pop: true
- match: \;
pop: true
function-call-argument:
- include: expression
# error
error:
- match: \b(error)\s+({{identifier}})
captures:
1: keyword
2: support.function
push:
- curly-brackets-body
- function-returns-declaration
- function-modifiers
- function-arguments
- match: \b(error)\s*
captures:
1: keyword
push:
- curly-brackets-body
- function-returns-declaration
- function-modifiers
- function-arguments
# function declaration
function:
- match: \b(function)\s+({{identifier}})
captures:
1: keyword.declaration.function
2: entity.name.function
push:
- curly-brackets-body
- function-returns-declaration
- function-modifiers
- function-arguments
- match: \b(function)\b
captures:
1: keyword.declaration.function
push:
- curly-brackets-body
- function-returns-declaration
- function-modifiers
- function-arguments
# constructor declaration
constructor:
- match: \b(constructor)\b
scope: keyword.declaration.function
push:
- curly-brackets-body
- constructor-base-init
- constructor-modifiers
- function-arguments
# special receive and fallback functions
receive_and_fallback:
- match: \b(receive|fallback)\b
scope: keyword.declaration.function
push:
- curly-brackets-body
- function-modifiers
- function-arguments
# modifier declaration
modifier: # the actual "modifier" keyword, not as various function modifiers like: public, private etc.
- match: \b(modifier)\s+({{identifier}})
captures:
1: keyword.declaration.modifier
2: support.function
push:
- curly-brackets-body
- function-returns-declaration
- function-modifiers
- function-arguments-try
function-arguments-try:
- include: function-arguments
- include: else-pop
## function-arguments
function-arguments:
- match: '\('
scope: punctuation.section.block.begin.sol
push: function-argument
- match: ','
push:
- include: function-argument
- include: function-arguments
- match: '\)'
scope: punctuation.section.block.end.sol
pop: true
function-argument:
- include: function
- include: mapping-function-argument
# identifier is optional for cases like this: function bar(bytes memory, ...
- include: elementary-function-argument
- include: else-pop
# function testWithoutConstant(uint256[10] calldata _param) public pure (?:\[(\d*)\])?
# function testWithConstant(uint256[MY_CONST] calldata _param) public pure (?:\[({{identifier}})\])?
# ⚠️ still not working:
# function testWithConstant(uint256[2 * MY_CONST] calldata _param) public pure
elementary-function-argument:
- match: '\b(?:({{elementary_type}})|({{erc_type}})|({{identifier_path}}))(?:\[(\d*)\])?(?:\[({{identifier}})\])?(?:\s+({{data_location}}\b))?(?:\s+({{identifier}}))?'
captures:
1: constant.language
2: storage.type
3: scope
4: constant.numeric
5: scope
6: storage.modifier
7: variable.parameter
pop: true
## function-modifiers
# abstract contract MultiDistributorAuthorization is Authentication {
# constructor(IVault vault) Authentication(bytes32(uint256(address(this)))) {
# ...
# }
constructor-base-init:
- match: '({{identifier}})\s*(\()'
captures:
1: support.function
2: punctuation.section.block.begin.sol
push: function-call-arguments
- include: else-pop
constructor-modifiers:
- match: \b{{func_modifier}}\b
scope: storage.modifier
- match: \b{{identifier}}(?!\()\b # negative lookahead on bracket - avoid matching base consutrctor call public ERC20(name, symbol) {
scope: storage.type # custom modifier
- include: else-pop
function-modifiers:
- match: \b{{func_modifier}}\b
scope: storage.modifier
- match: '\b({{func_modifier_override}}\b)(?:\((?:{{identifier}}(?:,\s*)?)+\))?' # https://github.com/davidhq/SublimeEthereum/issues/50#issuecomment-611749874, 1) internal override(ERC20, ERC20Pausable) 2) internal override
captures:
1: storage.modifier
- match: \breturns\b
scope: keyword
push: function-returns-arguments
- include: function-modifier-with-arguments
- match: \b{{identifier}}\b