forked from swiftlang/swift-syntax
-
Notifications
You must be signed in to change notification settings - Fork 0
/
SwiftSyntax.md.gyb
176 lines (135 loc) · 4.01 KB
/
SwiftSyntax.md.gyb
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
%{
# -*- mode: Swift -*-
from gyb_syntax_support import *
from gyb_syntax_support.Traits import TRAITS
NODE_MAP = create_node_map()
# Ignore the following admonition it applies to the resulting .md file only
}%
# ``SwiftSyntax``
@Comment {
Automatically Generated From SwiftSyntax.md.gyb.
Do Not Edit Directly!
}
A library for working with Swift code.
## Overview
SwiftSyntax is a source accurate tree representation of Swift source code. It
allows Swift tools to parse, inspect, generate, and transform Swift source code.
## Topics
### Articles
- <doc:ChangingSwiftSyntax>
- <doc:Create-SwiftSyntax-Release>
### Syntax
- <doc:SwiftSyntax/Syntax>
- <doc:SwiftSyntax/SyntaxCollection>
### Trivia
- <doc:SwiftSyntax/Trivia>
- <doc:SwiftSyntax/TriviaPiece>
- <doc:SwiftSyntax/TriviaPosition>
### Tokens
- <doc:SwiftSyntax/TokenSyntax>
- <doc:SwiftSyntax/TokenKind>
- <doc:SwiftSyntax/TokenSequence>
- <doc:SwiftSyntax/SourcePresence>
### Syntax Visitors
- <doc:SwiftSyntax/SyntaxVisitor>
- <doc:SwiftSyntax/SyntaxAnyVisitor>
- <doc:SwiftSyntax/SyntaxRewriter>
- <doc:SwiftSyntax/SyntaxTreeViewMode>
- <doc:SwiftSyntax/SyntaxVisitorContinueKind>
- <doc:SwiftSyntax/ReversedTokenSequence>
### Declarations
- <doc:SwiftSyntax/DeclSyntax>
- <doc:SwiftSyntax/DeclSyntaxProtocol>
% for node in SYNTAX_NODES:
% if not node.is_missing() and node.base_type == 'DeclSyntax':
- <doc:SwiftSyntax/${node.name}>
% end
% end
### Statements
- <doc:SwiftSyntax/StmtSyntax>
- <doc:SwiftSyntax/StmtSyntaxProtocol>
% for node in SYNTAX_NODES:
% if not node.is_missing() and node.base_type == 'StmtSyntax':
- <doc:SwiftSyntax/${node.name}>
% end
% end
### Expressions
- <doc:SwiftSyntax/ExprSyntax>
- <doc:SwiftSyntax/ExprSyntaxProtocol>
% for node in SYNTAX_NODES:
% if not node.is_missing() and node.base_type == 'ExprSyntax':
- <doc:SwiftSyntax/${node.name}>
% end
% end
### Types
- <doc:SwiftSyntax/TypeSyntax>
- <doc:SwiftSyntax/TypeSyntaxProtocol>
% for node in SYNTAX_NODES:
% if not node.is_missing() and node.base_type == 'TypeSyntax':
- <doc:SwiftSyntax/${node.name}>
% end
% end
### Patterns
- <doc:SwiftSyntax/PatternSyntax>
- <doc:SwiftSyntax/PatternSyntaxProtocol>
% for node in SYNTAX_NODES:
% if not node.is_missing() and node.base_type == 'PatternSyntax':
- <doc:SwiftSyntax/${node.name}>
% end
% end
### Collections
- <doc:SwiftSyntax/SyntaxChildren>
% for node in SYNTAX_NODES:
% if node.collection_element:
% element_node = NODE_MAP.get(node.collection_element)
% if element_node:
- <doc:SwiftSyntax/${node.name}>
- <doc:SwiftSyntax/${element_node.name}>
% end
% end
% end
- <doc:SwiftSyntax/SyntaxChildrenIndex>
- <doc:SwiftSyntax/SyntaxChildrenIndexData>
### Miscellaneous Syntax
% for node in SYNTAX_NODES:
% if not node.is_missing() and not node.is_base() and node.base_type == 'Syntax':
- <doc:SwiftSyntax/${node.name}>
% end
% end
### Missing and Unknown Syntax
% for node in SYNTAX_NODES:
% if node.is_missing():
- <doc:SwiftSyntax/${node.name}>
% end
% end
### Traits
% for trait in TRAITS:
- <doc:SwiftSyntax/${trait.trait_name}Syntax>
% end
### Syntax Position
- <doc:SwiftSyntax/AbsolutePosition>
- <doc:SwiftSyntax/ByteSourceRange>
- <doc:SwiftSyntax/SourceLocation>
- <doc:SwiftSyntax/SourceLocationConverter>
- <doc:SwiftSyntax/SourceRange>
- <doc:SwiftSyntax/SourceLength>
### Classifying Syntax
- <doc:SwiftSyntax/SyntaxClassification>
- <doc:SwiftSyntax/SyntaxClassifications>
- <doc:SwiftSyntax/SyntaxClassifiedRange>
### Incremental Parsing
- <doc:SwiftSyntax/IncrementalParseLookup>
- <doc:SwiftSyntax/IncrementalParseTransition>
- <doc:SwiftSyntax/IncrementalParseReusedNodeDelegate>
- <doc:SwiftSyntax/IncrementalParseReusedNodeCollector>
- <doc:SwiftSyntax/SourceEdit>
- <doc:SwiftSyntax/ConcurrentEdits>
### Internals
- <doc:SwiftSyntax/SyntaxProtocol>
- <doc:SwiftSyntax/SyntaxArena>
- <doc:SwiftSyntax/SyntaxEnum>
- <doc:SwiftSyntax/SyntaxFactory>
- <doc:SwiftSyntax/SyntaxHashable>
- <doc:SwiftSyntax/SyntaxIdentifier>
- <doc:SwiftSyntax/RawTokenKind>
- <doc:SwiftSyntax/SyntaxNode>