Skip to content
This repository was archived by the owner on Jan 12, 2024. It is now read-only.

Commit 246f4f4

Browse files
committed
Updated some names and documentation
1 parent 9bb83dd commit 246f4f4

File tree

9 files changed

+275
-273
lines changed

9 files changed

+275
-273
lines changed

src/QsFmt/Formatter/ParseTree/Statement.fs

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -117,15 +117,15 @@ type StatementVisitor(tokens) =
117117
Expression = expressionVisitor.Visit context.value
118118
Semicolon = context.semicolon |> Node.toTerminal tokens
119119
}
120-
|> Return
120+
|> ReturnStatement
121121

122122
override _.VisitFailStatement context =
123123
{
124124
Keyword = context.fail |> Node.toTerminal tokens
125125
Expression = expressionVisitor.Visit context.value
126126
Semicolon = context.semicolon |> Node.toTerminal tokens
127127
}
128-
|> Fail
128+
|> FailStatement
129129

130130
override _.VisitLetStatement context =
131131
{
@@ -135,7 +135,7 @@ type StatementVisitor(tokens) =
135135
Value = expressionVisitor.Visit context.value
136136
Semicolon = context.semicolon |> Node.toTerminal tokens
137137
}
138-
|> Let
138+
|> LetStatement
139139

140140
override _.VisitMutableStatement context =
141141
{
@@ -145,7 +145,7 @@ type StatementVisitor(tokens) =
145145
Value = expressionVisitor.Visit context.value
146146
Semicolon = context.semicolon |> Node.toTerminal tokens
147147
}
148-
|> Mutable
148+
|> MutableStatement
149149

150150
override _.VisitSetStatement context =
151151
{
@@ -157,7 +157,7 @@ type StatementVisitor(tokens) =
157157
}
158158
|> SetStatement
159159

160-
override _.VisitSetUpdateStatement context =
160+
override _.VisitUpdateStatement context =
161161
{
162162
SetKeyword = context.set |> Node.toTerminal tokens
163163
Name = context.name |> Node.toTerminal tokens
@@ -168,7 +168,7 @@ type StatementVisitor(tokens) =
168168
}
169169
|> UpdateStatement
170170

171-
override _.VisitSetWithStatement context =
171+
override _.VisitUpdateWithStatement context =
172172
{
173173
SetKeyword = context.set |> Node.toTerminal tokens
174174
Name = context.name |> Node.toTerminal tokens
@@ -178,7 +178,7 @@ type StatementVisitor(tokens) =
178178
Value = expressionVisitor.Visit context.value
179179
Semicolon = context.semicolon |> Node.toTerminal tokens
180180
}
181-
|> SetWith
181+
|> UpdateWithStatement
182182

183183
override visitor.VisitIfStatement context =
184184
{
@@ -191,7 +191,7 @@ type StatementVisitor(tokens) =
191191
CloseBrace = context.body.closeBrace |> Node.toTerminal tokens
192192
}
193193
}
194-
|> If
194+
|> IfStatement
195195

196196
override visitor.VisitElifStatement context =
197197
{
@@ -204,7 +204,7 @@ type StatementVisitor(tokens) =
204204
CloseBrace = context.body.closeBrace |> Node.toTerminal tokens
205205
}
206206
}
207-
|> Elif
207+
|> ElifStatement
208208

209209
override visitor.VisitElseStatement context =
210210
{
@@ -216,7 +216,7 @@ type StatementVisitor(tokens) =
216216
CloseBrace = context.body.closeBrace |> Node.toTerminal tokens
217217
}
218218
}
219-
|> Else
219+
|> ElseStatement
220220

221221
override visitor.VisitForStatement context =
222222
{
@@ -231,7 +231,7 @@ type StatementVisitor(tokens) =
231231
CloseBrace = context.body.closeBrace |> Node.toTerminal tokens
232232
}
233233
}
234-
|> For
234+
|> ForStatement
235235

236236
override visitor.VisitWhileStatement context =
237237
{
@@ -244,7 +244,7 @@ type StatementVisitor(tokens) =
244244
CloseBrace = context.body.closeBrace |> Node.toTerminal tokens
245245
}
246246
}
247-
|> While
247+
|> WhileStatement
248248

249249
override visitor.VisitRepeatStatement context =
250250
{
@@ -256,7 +256,7 @@ type StatementVisitor(tokens) =
256256
CloseBrace = context.body.closeBrace |> Node.toTerminal tokens
257257
}
258258
}
259-
|> Repeat
259+
|> RepeatStatement
260260

261261
override visitor.VisitUntilStatement context =
262262
{
@@ -275,9 +275,9 @@ type StatementVisitor(tokens) =
275275
}
276276
|> Fixup
277277
else
278-
context.semicolon |> Node.toTerminal tokens |> UntilCoda.Semicolon
278+
context.semicolon |> Node.toTerminal tokens |> UntilStatementCoda.Semicolon
279279
}
280-
|> Until
280+
|> UntilStatement
281281

282282
override visitor.VisitWithinStatement context =
283283
{
@@ -289,7 +289,7 @@ type StatementVisitor(tokens) =
289289
CloseBrace = context.body.closeBrace |> Node.toTerminal tokens
290290
}
291291
}
292-
|> Within
292+
|> WithinStatement
293293

294294
override visitor.VisitApplyStatement context =
295295
{
@@ -301,7 +301,7 @@ type StatementVisitor(tokens) =
301301
CloseBrace = context.body.closeBrace |> Node.toTerminal tokens
302302
}
303303
}
304-
|> Apply
304+
|> ApplyStatement
305305

306306
override visitor.VisitQubitDeclaration context =
307307
{
@@ -325,4 +325,4 @@ type StatementVisitor(tokens) =
325325
else
326326
context.semicolon |> Node.toTerminal tokens |> Semicolon
327327
}
328-
|> QubitDeclaration
328+
|> QubitDeclarationStatement

src/QsFmt/Formatter/Rules.fs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ let collapsedSpaces =
3636

3737
let operatorSpacing =
3838
{ new Rewriter<_>() with
39-
override _.Let((), lets) =
39+
override _.LetStatement((), lets) =
4040
let equals = { lets.Equals with Prefix = [ spaces 1 ] }
4141
{ lets with Equals = equals }
4242
}
@@ -90,7 +90,7 @@ let newLines =
9090
let statement = base.Statement((), statement)
9191

9292
match statement with
93-
| Else _ -> statement
93+
| ElseStatement _ -> statement
9494
| _ -> Statement.mapPrefix ensureNewLine statement
9595

9696
override _.Block((), mapper, block) =
@@ -112,7 +112,7 @@ let getTrivia paren =
112112

113113
let qubitBindingUpdate =
114114
{ new Rewriter<_>() with
115-
override rewriter.QubitDeclaration(_, decl) =
115+
override rewriter.QubitDeclarationStatement(_, decl) =
116116
let openTrivia = decl.OpenParen |> getTrivia
117117
let closeTrivia = decl.CloseParen |> getTrivia
118118

@@ -148,7 +148,7 @@ let unitUpdate =
148148

149149
let forParensUpdate =
150150
{ new Rewriter<_>() with
151-
override rewriter.For((), loop) =
151+
override rewriter.ForStatement((), loop) =
152152
let openTrivia = loop.OpenParen |> getTrivia
153153
let closeTrivia = loop.CloseParen |> getTrivia
154154

src/QsFmt/Formatter/SyntaxTree/Reducer.fs

Lines changed: 46 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -198,45 +198,45 @@ type internal 'result Reducer() as reducer =
198198
default _.Statement statement =
199199
match statement with
200200
| ExpressionStatement expr -> reducer.ExpressionStatement expr
201-
| Return returns -> reducer.Return returns
202-
| Fail fails -> reducer.Fail fails
203-
| Let lets -> reducer.Let lets
204-
| Mutable mutables -> reducer.Mutable mutables
201+
| ReturnStatement returns -> reducer.ReturnStatement returns
202+
| FailStatement fails -> reducer.FailStatement fails
203+
| LetStatement lets -> reducer.LetStatement lets
204+
| MutableStatement mutables -> reducer.MutableStatement mutables
205205
| SetStatement sets -> reducer.SetStatement sets
206206
| UpdateStatement updates -> reducer.UpdateStatement updates
207-
| SetWith withs -> reducer.SetWith withs
208-
| If ifs -> reducer.If ifs
209-
| Elif elifs -> reducer.Elif elifs
210-
| Else elses -> reducer.Else elses
211-
| For loop -> reducer.For loop
212-
| While whiles -> reducer.While whiles
213-
| Repeat repeats -> reducer.Repeat repeats
214-
| Until untils -> reducer.Until untils
215-
| Within withins -> reducer.Within withins
216-
| Apply apply -> reducer.Apply apply
217-
| QubitDeclaration decl -> reducer.QubitDeclaration decl
207+
| UpdateWithStatement withs -> reducer.UpdateWithStatement withs
208+
| IfStatement ifs -> reducer.IfStatement ifs
209+
| ElifStatement elifs -> reducer.ElifStatement elifs
210+
| ElseStatement elses -> reducer.ElseStatement elses
211+
| ForStatement loop -> reducer.ForStatement loop
212+
| WhileStatement whiles -> reducer.WhileStatement whiles
213+
| RepeatStatement repeats -> reducer.RepeatStatement repeats
214+
| UntilStatement untils -> reducer.UntilStatement untils
215+
| WithinStatement withins -> reducer.WithinStatement withins
216+
| ApplyStatement apply -> reducer.ApplyStatement apply
217+
| QubitDeclarationStatement decl -> reducer.QubitDeclarationStatement decl
218218
| Statement.Unknown terminal -> reducer.Terminal terminal
219219

220220
abstract ExpressionStatement : expr: ExpressionStatement -> 'result
221221

222222
default _.ExpressionStatement expr =
223223
[ reducer.Expression expr.Expression; reducer.Terminal expr.Semicolon ] |> reduce
224224

225-
abstract Return : returns: SimpleStatement -> 'result
225+
abstract ReturnStatement : returns: SimpleStatement -> 'result
226226

227-
default _.Return returns = defaultSimpleStatement returns
227+
default _.ReturnStatement returns = defaultSimpleStatement returns
228228

229-
abstract Fail : fails: SimpleStatement -> 'result
229+
abstract FailStatement : fails: SimpleStatement -> 'result
230230

231-
default _.Fail fails = defaultSimpleStatement fails
231+
default _.FailStatement fails = defaultSimpleStatement fails
232232

233-
abstract Let : lets: BindingStatement -> 'result
233+
abstract LetStatement : lets: BindingStatement -> 'result
234234

235-
default _.Let lets = defaultBindingStatement lets
235+
default _.LetStatement lets = defaultBindingStatement lets
236236

237-
abstract Mutable : mutables: BindingStatement -> 'result
237+
abstract MutableStatement : mutables: BindingStatement -> 'result
238238

239-
default _.Mutable mutables = defaultBindingStatement mutables
239+
default _.MutableStatement mutables = defaultBindingStatement mutables
240240

241241
abstract SetStatement : sets: BindingStatement -> 'result
242242

@@ -254,9 +254,9 @@ type internal 'result Reducer() as reducer =
254254
]
255255
|> reduce
256256

257-
abstract SetWith : withs: SetWith -> 'result
257+
abstract UpdateWithStatement : withs: UpdateWithStatement -> 'result
258258

259-
default _.SetWith withs =
259+
default _.UpdateWithStatement withs =
260260
[
261261
reducer.Terminal withs.SetKeyword
262262
reducer.Terminal withs.Name
@@ -268,21 +268,21 @@ type internal 'result Reducer() as reducer =
268268
]
269269
|> reduce
270270

271-
abstract If : ifs: ConditionalBlockStatement -> 'result
271+
abstract IfStatement : ifs: ConditionalBlockStatement -> 'result
272272

273-
default _.If ifs = defaultConditionalBlockStatement ifs
273+
default _.IfStatement ifs = defaultConditionalBlockStatement ifs
274274

275-
abstract Elif : elifs: ConditionalBlockStatement -> 'result
275+
abstract ElifStatement : elifs: ConditionalBlockStatement -> 'result
276276

277-
default _.Elif elifs = defaultConditionalBlockStatement elifs
277+
default _.ElifStatement elifs = defaultConditionalBlockStatement elifs
278278

279-
abstract Else : elses: BlockStatement -> 'result
279+
abstract ElseStatement : elses: BlockStatement -> 'result
280280

281-
default _.Else elses = defaultBlockStatement elses
281+
default _.ElseStatement elses = defaultBlockStatement elses
282282

283-
abstract For : loop: For -> 'result
283+
abstract ForStatement : loop: ForStatement -> 'result
284284

285-
default _.For loop =
285+
default _.ForStatement loop =
286286
[
287287
reducer.Terminal loop.ForKeyword |> Some
288288
loop.OpenParen |> Option.map reducer.Terminal
@@ -293,22 +293,22 @@ type internal 'result Reducer() as reducer =
293293
|> List.choose id
294294
|> reduce
295295

296-
abstract While : whiles: ConditionalBlockStatement -> 'result
296+
abstract WhileStatement : whiles: ConditionalBlockStatement -> 'result
297297

298-
default _.While whiles = defaultConditionalBlockStatement whiles
298+
default _.WhileStatement whiles = defaultConditionalBlockStatement whiles
299299

300-
abstract Repeat : repeats: BlockStatement -> 'result
300+
abstract RepeatStatement : repeats: BlockStatement -> 'result
301301

302-
default _.Repeat repeats = defaultBlockStatement repeats
302+
default _.RepeatStatement repeats = defaultBlockStatement repeats
303303

304-
abstract Until : untils: Until -> 'result
304+
abstract UntilStatement : untils: UntilStatement -> 'result
305305

306-
default _.Until untils =
306+
default _.UntilStatement untils =
307307
[
308308
reducer.Terminal untils.UntilKeyword
309309
reducer.Expression untils.Condition
310310
match untils.Coda with
311-
| UntilCoda.Semicolon semicolon -> reducer.Terminal semicolon
311+
| UntilStatementCoda.Semicolon semicolon -> reducer.Terminal semicolon
312312
| Fixup fixup -> reducer.Fixup fixup
313313
]
314314
|> reduce
@@ -317,17 +317,17 @@ type internal 'result Reducer() as reducer =
317317

318318
default _.Fixup fixup = defaultBlockStatement fixup
319319

320-
abstract Within : withins: BlockStatement -> 'result
320+
abstract WithinStatement : withins: BlockStatement -> 'result
321321

322-
default _.Within withins = defaultBlockStatement withins
322+
default _.WithinStatement withins = defaultBlockStatement withins
323323

324-
abstract Apply : apply: BlockStatement -> 'result
324+
abstract ApplyStatement : apply: BlockStatement -> 'result
325325

326-
default _.Apply apply = defaultBlockStatement apply
326+
default _.ApplyStatement apply = defaultBlockStatement apply
327327

328-
abstract QubitDeclaration : decl: QubitDeclaration -> 'result
328+
abstract QubitDeclarationStatement : decl: QubitDeclarationStatement -> 'result
329329

330-
default _.QubitDeclaration decl =
330+
default _.QubitDeclarationStatement decl =
331331
[
332332
reducer.Terminal decl.Keyword |> Some
333333
decl.OpenParen |> Option.map reducer.Terminal

0 commit comments

Comments
 (0)