-
Notifications
You must be signed in to change notification settings - Fork 278
/
ast.go
1057 lines (893 loc) · 27.5 KB
/
ast.go
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 2018 The CUE Authors
//
// 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.
// Package ast declares the types used to represent syntax trees for CUE
// packages.
package ast // import "cuelang.org/go/cue/ast"
import (
"fmt"
"strings"
"cuelang.org/go/cue/literal"
"cuelang.org/go/cue/token"
)
// ----------------------------------------------------------------------------
// Interfaces
//
// There are three main classes of nodes: expressions, clauses, and declaration
// nodes. The node names usually match the corresponding CUE spec production
// names to which they correspond. The node fields correspond to the individual
// parts of the respective productions.
//
// All nodes contain position information marking the beginning of the
// corresponding source text segment; it is accessible via the Pos accessor
// method. Nodes may contain additional position info for language constructs
// where comments may be found between parts of the construct (typically any
// larger, parenthesized subpart). That position information is needed to
// properly position comments when printing the construct.
// A Node represents any node in the abstract syntax tree.
type Node interface {
Pos() token.Pos // position of first character belonging to the node
End() token.Pos // position of first character immediately after the node
// pos reports the pointer to the position of first character belonging to
// the node or nil if there is no such position.
pos() *token.Pos
// Deprecated: use ast.Comments
Comments() []*CommentGroup
// Deprecated: use ast.AddComment
AddComment(*CommentGroup)
commentInfo() *comments
}
// Name describes the type of n.
func Name(n Node) string {
s := fmt.Sprintf("%T", n)
return strings.ToLower(s[strings.Index(s, "ast.")+4:])
}
func getPos(n Node) token.Pos {
p := n.pos()
if p == nil {
return token.NoPos
}
return *p
}
// SetPos sets a node to the given position, if possible.
func SetPos(n Node, p token.Pos) {
ptr := n.pos()
if ptr == nil {
return
}
*ptr = p
}
// SetRelPos sets the relative position of a node without modifying its
// file position. Setting it to token.NoRelPos allows a node to adopt default
// formatting.
func SetRelPos(n Node, p token.RelPos) {
ptr := n.pos()
if ptr == nil {
return
}
pos := *ptr
*ptr = pos.WithRel(p)
}
// An Expr is implemented by all expression nodes.
type Expr interface {
Node
declNode() // An expression can be used as a declaration.
exprNode()
}
type expr struct{ decl }
func (expr) exprNode() {}
// A Decl node is implemented by all declarations.
type Decl interface {
Node
declNode()
}
type decl struct{}
func (decl) declNode() {}
// A Label is any production that can be used as a LHS label.
type Label interface {
Node
labelNode()
}
type label struct{}
func (l label) labelNode() {}
// Clause nodes are part of comprehensions.
type Clause interface {
Node
clauseNode()
}
type clause struct{}
func (clause) clauseNode() {}
func (x *ForClause) clauseNode() {}
func (x *IfClause) clauseNode() {}
func (x *Alias) clauseNode() {}
// Comments
type comments struct {
groups *[]*CommentGroup
}
func (c *comments) commentInfo() *comments { return c }
func (c *comments) Comments() []*CommentGroup {
if c.groups == nil {
return []*CommentGroup{}
}
return *c.groups
}
// // AddComment adds the given comments to the fields.
// // If line is true the comment is inserted at the preceding token.
func (c *comments) AddComment(cg *CommentGroup) {
if cg == nil {
return
}
if c.groups == nil {
a := []*CommentGroup{cg}
c.groups = &a
return
}
*c.groups = append(*c.groups, cg)
a := *c.groups
for i := len(a) - 2; i >= 0 && a[i].Position > cg.Position; i-- {
a[i], a[i+1] = a[i+1], a[i]
}
}
func (c *comments) SetComments(cgs []*CommentGroup) {
if c.groups == nil {
a := cgs
c.groups = &a
return
}
*c.groups = cgs
}
// A Comment node represents a single //-style or /*-style comment.
type Comment struct {
Slash token.Pos // position of "/" starting the comment
Text string // comment text (excluding '\n' for //-style comments)
}
func (c *Comment) Comments() []*CommentGroup { return nil }
func (c *Comment) AddComment(*CommentGroup) {}
func (c *Comment) commentInfo() *comments { return nil }
func (c *Comment) Pos() token.Pos { return c.Slash }
func (c *Comment) pos() *token.Pos { return &c.Slash }
func (c *Comment) End() token.Pos { return c.Slash.Add(len(c.Text)) }
// A CommentGroup represents a sequence of comments
// with no other tokens and no empty lines between.
type CommentGroup struct {
// TODO: remove and use the token position of the first comment.
Doc bool
Line bool // true if it is on the same line as the node's end pos.
// Position indicates where a comment should be attached if a node has
// multiple tokens. 0 means before the first token, 1 means before the
// second, etc. For instance, for a field, the positions are:
// <0> Label <1> ":" <2> Expr <3> "," <4>
Position int8
List []*Comment // len(List) > 0
decl
}
func (g *CommentGroup) Pos() token.Pos { return getPos(g) }
func (g *CommentGroup) pos() *token.Pos { return g.List[0].pos() }
func (g *CommentGroup) End() token.Pos { return g.List[len(g.List)-1].End() }
func (g *CommentGroup) Comments() []*CommentGroup { return nil }
func (g *CommentGroup) AddComment(*CommentGroup) {}
func (g *CommentGroup) commentInfo() *comments { return nil }
func isWhitespace(ch byte) bool { return ch == ' ' || ch == '\t' || ch == '\n' || ch == '\r' }
func stripTrailingWhitespace(s string) string {
i := len(s)
for i > 0 && isWhitespace(s[i-1]) {
i--
}
return s[0:i]
}
// Text returns the text of the comment.
// Comment markers (//, /*, and */), the first space of a line comment, and
// leading and trailing empty lines are removed. Multiple empty lines are
// reduced to one, and trailing space on lines is trimmed. Unless the result
// is empty, it is newline-terminated.
func (g *CommentGroup) Text() string {
if g == nil {
return ""
}
comments := make([]string, len(g.List))
for i, c := range g.List {
comments[i] = c.Text
}
lines := make([]string, 0, 10) // most comments are less than 10 lines
for _, c := range comments {
// Remove comment markers.
// The parser has given us exactly the comment text.
switch c[1] {
case '/':
//-style comment (no newline at the end)
c = c[2:]
// strip first space - required for Example tests
if len(c) > 0 && c[0] == ' ' {
c = c[1:]
}
case '*':
/*-style comment */
c = c[2 : len(c)-2]
}
// Split on newlines.
cl := strings.Split(c, "\n")
// Walk lines, stripping trailing white space and adding to list.
for _, l := range cl {
lines = append(lines, stripTrailingWhitespace(l))
}
}
// Remove leading blank lines; convert runs of
// interior blank lines to a single blank line.
n := 0
for _, line := range lines {
if line != "" || n > 0 && lines[n-1] != "" {
lines[n] = line
n++
}
}
lines = lines[0:n]
// Add final "" entry to get trailing newline from Join.
if n > 0 && lines[n-1] != "" {
lines = append(lines, "")
}
return strings.Join(lines, "\n")
}
// An Attribute provides meta data about a field.
type Attribute struct {
At token.Pos
Text string // must be a valid attribute format.
comments
decl
}
func (a *Attribute) Pos() token.Pos { return a.At }
func (a *Attribute) pos() *token.Pos { return &a.At }
func (a *Attribute) End() token.Pos { return a.At.Add(len(a.Text)) }
func (a *Attribute) Split() (key, body string) {
s := a.Text
p := strings.IndexByte(s, '(')
if p < 0 || !strings.HasPrefix(s, "@") || !strings.HasSuffix(s, ")") {
return "", ""
}
return a.Text[1:p], a.Text[p+1 : len(s)-1]
}
// A Field represents a field declaration in a struct.
type Field struct {
Label Label // must have at least one element.
Optional token.Pos
// No TokenPos: Value must be an StructLit with one field.
TokenPos token.Pos
Token token.Token // ':' or '::', ILLEGAL implies ':'
Value Expr // the value associated with this field.
Attrs []*Attribute
comments
decl
}
func (d *Field) Pos() token.Pos { return d.Label.Pos() }
func (d *Field) pos() *token.Pos { return d.Label.pos() }
func (d *Field) End() token.Pos {
if len(d.Attrs) > 0 {
return d.Attrs[len(d.Attrs)-1].End()
}
return d.Value.End()
}
// TODO: make Alias a type of Field. This is possible now we have different
// separator types.
// An Alias binds another field to the alias name in the current struct.
type Alias struct {
Ident *Ident // field name, always an Ident
Equal token.Pos // position of "="
Expr Expr // An Ident or SelectorExpr
comments
decl
expr
label
}
func (a *Alias) Pos() token.Pos { return a.Ident.Pos() }
func (a *Alias) pos() *token.Pos { return a.Ident.pos() }
func (a *Alias) End() token.Pos { return a.Expr.End() }
// A Comprehension node represents a comprehension declaration.
type Comprehension struct {
Clauses []Clause // There must be at least one clause.
Value Expr // Must be a struct TODO: change to Struct
comments
decl
expr // TODO: only allow Comprehension in "Embedding" productions.
}
func (x *Comprehension) Pos() token.Pos { return getPos(x) }
func (x *Comprehension) pos() *token.Pos { return x.Clauses[0].pos() }
func (x *Comprehension) End() token.Pos {
return x.Value.End()
}
// ----------------------------------------------------------------------------
// Expressions and types
//
// An expression is represented by a tree consisting of one
// or more of the following concrete expression nodes.
// A BadExpr node is a placeholder for expressions containing
// syntax errors for which no correct expression nodes can be
// created. This is different from an ErrorExpr which represents
// an explicitly marked error in the source.
type BadExpr struct {
From, To token.Pos // position range of bad expression
comments
expr
}
// A BottomLit indicates an error.
type BottomLit struct {
Bottom token.Pos
comments
expr
}
// An Ident node represents an left-hand side identifier.
type Ident struct {
NamePos token.Pos // identifier position
// This LHS path element may be an identifier. Possible forms:
// foo: a normal identifier
// "foo": JSON compatible
Name string
Scope Node // scope in which node was found or nil if referring directly
Node Node
comments
label
expr
}
// A BasicLit node represents a literal of basic type.
type BasicLit struct {
ValuePos token.Pos // literal position
Kind token.Token // INT, FLOAT, DURATION, or STRING
Value string // literal string; e.g. 42, 0x7f, 3.14, 1_234_567, 1e-9, 2.4i, 'a', '\x7f', "foo", or '\m\n\o'
comments
expr
label
}
// TODO: introduce and use NewLabel and NewBytes and perhaps NewText (in the
// later case NewString would return a string or bytes type) to distinguish from
// NewString. Consider how to pass indentation information.
// NewString creates a new BasicLit with a string value without position.
// It quotes the given string.
// Useful for ASTs generated by code other than the CUE parser.
func NewString(str string) *BasicLit {
str = literal.String.Quote(str)
return &BasicLit{Kind: token.STRING, ValuePos: token.NoPos, Value: str}
}
// NewNull creates a new BasicLit configured to be a null value.
// Useful for ASTs generated by code other than the CUE parser.
func NewNull() *BasicLit {
return &BasicLit{Kind: token.NULL, Value: "null"}
}
// NewLit creates a new BasicLit with from a token type and string without
// position.
// Useful for ASTs generated by code other than the CUE parser.
func NewLit(tok token.Token, s string) *BasicLit {
return &BasicLit{Kind: tok, Value: s}
}
// NewBool creates a new BasicLit with a bool value without position.
// Useful for ASTs generated by code other than the CUE parser.
func NewBool(b bool) *BasicLit {
x := &BasicLit{}
if b {
x.Kind = token.TRUE
x.Value = "true"
} else {
x.Kind = token.FALSE
x.Value = "false"
}
return x
}
// TODO:
// - use CUE-specific quoting (hoist functionality in export)
// - NewBytes
// A Interpolation node represents a string or bytes interpolation.
type Interpolation struct {
Elts []Expr // interleaving of strings and expressions.
comments
expr
label
}
// A StructLit node represents a literal struct.
type StructLit struct {
Lbrace token.Pos // position of "{"
Elts []Decl // list of elements; or nil
Rbrace token.Pos // position of "}"
comments
expr
}
// NewStruct creates a struct from the given fields.
//
// A field is either a *Field, an *Elipsis, *LetClause, a *CommentGroup, or a
// Label, optionally followed by a a token.OPTION to indicate the field is
// optional, optionally followed by a token.ISA to indicate the field is a
// definition followed by an expression for the field value.
//
// It will panic if a values not matching these patterns are given. Useful for
// ASTs generated by code other than the CUE parser.
func NewStruct(fields ...interface{}) *StructLit {
s := &StructLit{
// Set default positions so that comment attachment is as expected.
Lbrace: token.NoSpace.Pos(),
}
for i := 0; i < len(fields); i++ {
var (
label Label
optional = token.NoPos
tok = token.ILLEGAL
expr Expr
)
switch x := fields[i].(type) {
case *Field:
s.Elts = append(s.Elts, x)
continue
case *CommentGroup:
s.Elts = append(s.Elts, x)
continue
case *Ellipsis:
s.Elts = append(s.Elts, x)
continue
case *LetClause:
s.Elts = append(s.Elts, x)
continue
case *embedding:
s.Elts = append(s.Elts, (*EmbedDecl)(x))
continue
case Label:
label = x
case string:
label = NewString(x)
default:
panic(fmt.Sprintf("unsupported label type %T", x))
}
inner:
for i++; i < len(fields); i++ {
switch x := (fields[i]).(type) {
case Expr:
expr = x
break inner
case token.Token:
switch x {
case token.ISA:
tok = x
case token.OPTION:
optional = token.Blank.Pos()
case token.COLON, token.ILLEGAL:
default:
panic(fmt.Sprintf("invalid token %s", x))
}
default:
panic(fmt.Sprintf("unsupported expression type %T", x))
}
}
if expr == nil {
panic("label not matched with expression")
}
s.Elts = append(s.Elts, &Field{
Label: label,
Optional: optional,
Token: tok,
Value: expr,
})
}
return s
}
// Embed can be used in conjunction with NewStruct to embed values.
func Embed(x Expr) *embedding {
return (*embedding)(&EmbedDecl{Expr: x})
}
type embedding EmbedDecl
// A ListLit node represents a literal list.
type ListLit struct {
Lbrack token.Pos // position of "["
// TODO: change to embedding or similar.
Elts []Expr // list of composite elements; or nil
Rbrack token.Pos // position of "]"
comments
expr
label
}
// NewList creates a list of Expressions.
// Useful for ASTs generated by code other than the CUE parser.
func NewList(exprs ...Expr) *ListLit {
return &ListLit{Elts: exprs}
}
type Ellipsis struct {
Ellipsis token.Pos // open list if set
Type Expr // type for the remaining elements
comments
decl
expr
}
// A ForClause node represents a for clause in a comprehension.
type ForClause struct {
For token.Pos
Key *Ident // allow pattern matching?
// TODO: change to Comma
Colon token.Pos
Value *Ident // allow pattern matching?
In token.Pos
Source Expr
comments
clause
}
// A IfClause node represents an if guard clause in a comprehension.
type IfClause struct {
If token.Pos
Condition Expr
comments
clause
}
// A LetClause node represents a let clause in a comprehension.
type LetClause struct {
Let token.Pos
Ident *Ident
Equal token.Pos
Expr Expr
comments
clause
decl
}
// A ParenExpr node represents a parenthesized expression.
type ParenExpr struct {
Lparen token.Pos // position of "("
X Expr // parenthesized expression
Rparen token.Pos // position of ")"
comments
expr
label
}
// A SelectorExpr node represents an expression followed by a selector.
type SelectorExpr struct {
X Expr // expression
Sel Label // field selector
comments
expr
}
// NewSel creates a sequence of selectors.
// Useful for ASTs generated by code other than the CUE parser.
func NewSel(x Expr, sel ...string) Expr {
for _, s := range sel {
x = &SelectorExpr{X: x, Sel: NewIdent(s)}
}
return x
}
// An IndexExpr node represents an expression followed by an index.
type IndexExpr struct {
X Expr // expression
Lbrack token.Pos // position of "["
Index Expr // index expression
Rbrack token.Pos // position of "]"
comments
expr
}
// An SliceExpr node represents an expression followed by slice indices.
type SliceExpr struct {
X Expr // expression
Lbrack token.Pos // position of "["
Low Expr // begin of slice range; or nil
High Expr // end of slice range; or nil
Rbrack token.Pos // position of "]"
comments
expr
}
// A CallExpr node represents an expression followed by an argument list.
type CallExpr struct {
Fun Expr // function expression
Lparen token.Pos // position of "("
Args []Expr // function arguments; or nil
Rparen token.Pos // position of ")"
comments
expr
}
// NewCall creates a new CallExpr.
// Useful for ASTs generated by code other than the CUE parser.
func NewCall(fun Expr, args ...Expr) *CallExpr {
return &CallExpr{Fun: fun, Args: args}
}
// A UnaryExpr node represents a unary expression.
type UnaryExpr struct {
OpPos token.Pos // position of Op
Op token.Token // operator
X Expr // operand
comments
expr
}
// A BinaryExpr node represents a binary expression.
type BinaryExpr struct {
X Expr // left operand
OpPos token.Pos // position of Op
Op token.Token // operator
Y Expr // right operand
comments
expr
}
// NewBinExpr creates for list of expressions of length 2 or greater a chained
// binary expression of the form (((x1 op x2) op x3) ...). For lists of length
// 1 it returns the expression itself. It panics for empty lists.
// Useful for ASTs generated by code other than the CUE parser.
func NewBinExpr(op token.Token, operands ...Expr) Expr {
if len(operands) == 0 {
return nil
}
expr := operands[0]
for _, e := range operands[1:] {
expr = &BinaryExpr{X: expr, Op: op, Y: e}
}
return expr
}
// token.Pos and End implementations for expression/type nodes.
func (x *BadExpr) Pos() token.Pos { return x.From }
func (x *BadExpr) pos() *token.Pos { return &x.From }
func (x *Ident) Pos() token.Pos { return x.NamePos }
func (x *Ident) pos() *token.Pos { return &x.NamePos }
func (x *BasicLit) Pos() token.Pos { return x.ValuePos }
func (x *BasicLit) pos() *token.Pos { return &x.ValuePos }
func (x *Interpolation) Pos() token.Pos { return x.Elts[0].Pos() }
func (x *Interpolation) pos() *token.Pos { return x.Elts[0].pos() }
func (x *StructLit) Pos() token.Pos { return getPos(x) }
func (x *StructLit) pos() *token.Pos {
if x.Lbrace == token.NoPos && len(x.Elts) > 0 {
return x.Elts[0].pos()
}
return &x.Lbrace
}
func (x *ListLit) Pos() token.Pos { return x.Lbrack }
func (x *ListLit) pos() *token.Pos { return &x.Lbrack }
func (x *Ellipsis) Pos() token.Pos { return x.Ellipsis }
func (x *Ellipsis) pos() *token.Pos { return &x.Ellipsis }
func (x *LetClause) Pos() token.Pos { return x.Let }
func (x *LetClause) pos() *token.Pos { return &x.Let }
func (x *ForClause) Pos() token.Pos { return x.For }
func (x *ForClause) pos() *token.Pos { return &x.For }
func (x *IfClause) Pos() token.Pos { return x.If }
func (x *IfClause) pos() *token.Pos { return &x.If }
func (x *ParenExpr) Pos() token.Pos { return x.Lparen }
func (x *ParenExpr) pos() *token.Pos { return &x.Lparen }
func (x *SelectorExpr) Pos() token.Pos { return x.X.Pos() }
func (x *SelectorExpr) pos() *token.Pos { return x.X.pos() }
func (x *IndexExpr) Pos() token.Pos { return x.X.Pos() }
func (x *IndexExpr) pos() *token.Pos { return x.X.pos() }
func (x *SliceExpr) Pos() token.Pos { return x.X.Pos() }
func (x *SliceExpr) pos() *token.Pos { return x.X.pos() }
func (x *CallExpr) Pos() token.Pos { return x.Fun.Pos() }
func (x *CallExpr) pos() *token.Pos { return x.Fun.pos() }
func (x *UnaryExpr) Pos() token.Pos { return x.OpPos }
func (x *UnaryExpr) pos() *token.Pos { return &x.OpPos }
func (x *BinaryExpr) Pos() token.Pos { return x.X.Pos() }
func (x *BinaryExpr) pos() *token.Pos { return x.X.pos() }
func (x *BottomLit) Pos() token.Pos { return x.Bottom }
func (x *BottomLit) pos() *token.Pos { return &x.Bottom }
func (x *BadExpr) End() token.Pos { return x.To }
func (x *Ident) End() token.Pos {
return x.NamePos.Add(len(x.Name))
}
func (x *BasicLit) End() token.Pos { return x.ValuePos.Add(len(x.Value)) }
func (x *Interpolation) End() token.Pos { return x.Elts[len(x.Elts)-1].Pos() }
func (x *StructLit) End() token.Pos {
if x.Rbrace == token.NoPos && len(x.Elts) > 0 {
return x.Elts[len(x.Elts)-1].Pos()
}
return x.Rbrace.Add(1)
}
func (x *ListLit) End() token.Pos { return x.Rbrack.Add(1) }
func (x *Ellipsis) End() token.Pos {
if x.Type != nil {
return x.Type.End()
}
return x.Ellipsis.Add(3) // len("...")
}
func (x *LetClause) End() token.Pos { return x.Expr.End() }
func (x *ForClause) End() token.Pos { return x.Source.End() }
func (x *IfClause) End() token.Pos { return x.Condition.End() }
func (x *ParenExpr) End() token.Pos { return x.Rparen.Add(1) }
func (x *SelectorExpr) End() token.Pos { return x.Sel.End() }
func (x *IndexExpr) End() token.Pos { return x.Rbrack.Add(1) }
func (x *SliceExpr) End() token.Pos { return x.Rbrack.Add(1) }
func (x *CallExpr) End() token.Pos { return x.Rparen.Add(1) }
func (x *UnaryExpr) End() token.Pos { return x.X.End() }
func (x *BinaryExpr) End() token.Pos { return x.Y.End() }
func (x *BottomLit) End() token.Pos { return x.Bottom.Add(1) }
// ----------------------------------------------------------------------------
// Convenience functions for Idents
// NewIdent creates a new Ident without position.
// Useful for ASTs generated by code other than the CUE parser.
func NewIdent(name string) *Ident {
return &Ident{token.NoPos, name, nil, nil, comments{}, label{}, expr{}}
}
func (id *Ident) String() string {
if id != nil {
return id.Name
}
return "<nil>"
}
// ----------------------------------------------------------------------------
// Declarations
// An ImportSpec node represents a single package import.
type ImportSpec struct {
Name *Ident // local package name (including "."); or nil
Path *BasicLit // import path
EndPos token.Pos // end of spec (overrides Path.Pos if nonzero)
comments
}
func (*ImportSpec) specNode() {}
func NewImport(name *Ident, importPath string) *ImportSpec {
importPath = literal.String.Quote(importPath)
path := &BasicLit{Kind: token.STRING, Value: importPath}
return &ImportSpec{Name: name, Path: path}
}
// Pos and End implementations for spec nodes.
func (s *ImportSpec) Pos() token.Pos { return getPos(s) }
func (s *ImportSpec) pos() *token.Pos {
if s.Name != nil {
return s.Name.pos()
}
return s.Path.pos()
}
// func (s *AliasSpec) Pos() token.Pos { return s.Name.Pos() }
// func (s *ValueSpec) Pos() token.Pos { return s.Names[0].Pos() }
// func (s *TypeSpec) Pos() token.Pos { return s.Name.Pos() }
func (s *ImportSpec) End() token.Pos {
if s.EndPos != token.NoPos {
return s.EndPos
}
return s.Path.End()
}
// A BadDecl node is a placeholder for declarations containing
// syntax errors for which no correct declaration nodes can be
// created.
type BadDecl struct {
From, To token.Pos // position range of bad declaration
comments
decl
}
// A ImportDecl node represents a series of import declarations. A valid
// Lparen position (Lparen.Line > 0) indicates a parenthesized declaration.
type ImportDecl struct {
Import token.Pos
Lparen token.Pos // position of '(', if any
Specs []*ImportSpec
Rparen token.Pos // position of ')', if any
comments
decl
}
type Spec interface {
Node
specNode()
}
// An EmbedDecl node represents a single expression used as a declaration.
// The expressions in this declaration is what will be emitted as
// configuration output.
//
// An EmbedDecl may only appear at the top level.
type EmbedDecl struct {
Expr Expr
comments
decl
}
// Pos and End implementations for declaration nodes.
func (d *BadDecl) Pos() token.Pos { return d.From }
func (d *BadDecl) pos() *token.Pos { return &d.From }
func (d *ImportDecl) Pos() token.Pos { return d.Import }
func (d *ImportDecl) pos() *token.Pos { return &d.Import }
func (d *EmbedDecl) Pos() token.Pos { return d.Expr.Pos() }
func (d *EmbedDecl) pos() *token.Pos { return d.Expr.pos() }
func (d *BadDecl) End() token.Pos { return d.To }
func (d *ImportDecl) End() token.Pos {
if d.Rparen.IsValid() {
return d.Rparen.Add(1)
}
if len(d.Specs) == 0 {
return token.NoPos
}
return d.Specs[0].End()
}
func (d *EmbedDecl) End() token.Pos { return d.Expr.End() }
// ----------------------------------------------------------------------------
// Files and packages
// A File node represents a Go source file.
//
// The Comments list contains all comments in the source file in order of
// appearance, including the comments that are pointed to from other nodes
// via Doc and Comment fields.
type File struct {
Filename string
Decls []Decl // top-level declarations; or nil
Imports []*ImportSpec // imports in this file
Unresolved []*Ident // unresolved identifiers in this file
comments
}
// Preamble returns the declarations of the preamble.
func (f *File) Preamble() []Decl {
p := 0
outer:
for i, d := range f.Decls {
switch d.(type) {
default:
break outer
case *Package:
p = i + 1
case *CommentGroup:
case *Attribute:
case *ImportDecl:
p = i + 1
}
}
return f.Decls[:p]
}
func (f *File) VisitImports(fn func(d *ImportDecl)) {
for _, d := range f.Decls {
switch x := d.(type) {
case *CommentGroup:
case *Package:
case *Attribute:
case *ImportDecl:
fn(x)
default:
return
}
}
}
// PackageName returns the package name associated with this file or "" if no
// package is associated.
func (f *File) PackageName() string {
for _, d := range f.Decls {
switch x := d.(type) {
case *Package:
return x.Name.Name
case *CommentGroup, *Attribute:
default:
return ""
}
}