Formatter Updates Deprecated Specialization Declaration Parameters (#1226)

Author: yjt98765

src/QsFmt/Formatter.Tests/Examples.fs

@@ -245,6 +245,50 @@ let ``Removes For-Loop Parens`` =
     }
 }"""
 
+[<Example(ExampleKind.Update)>]
+let ``Update Specialization Declaration`` =
+    """namespace Foo {
+    operation Bar() : Unit is Ctl + Adj {
+        body () {
+        }
+        adjoint () {
+        }
+        controlled (q) {
+        }
+        controlled adjoint (q) {
+        }
+    }
+}""",
+
+    """namespace Foo {
+    operation Bar() : Unit is Ctl + Adj {
+        body (...) {
+        }
+        adjoint (...) {
+        }
+        controlled (q, ...) {
+        }
+        controlled adjoint (q, ...) {
+        }
+    }
+}"""
+
+[<Example(ExampleKind.Update)>]
+let ``Update Specialization Declaration No Parens`` =
+    """namespace Foo {
+    operation Bar() : Unit is Ctl + Adj {
+        body {}
+        adjoint {}
+    }
+}""",
+
+    """namespace Foo {
+    operation Bar() : Unit is Ctl + Adj {
+        body (...) {}
+        adjoint (...) {}
+    }
+}"""
+
 [<Example(ExampleKind.Update)>]
 let ``Allows size as an Identifier`` =
     """namespace Foo {

src/QsFmt/Formatter/Formatter.fs

@@ -84,6 +84,7 @@ let versionToUpdateRules (version: Version option) =
                 simpleRule qubitBindingUpdate
                 simpleRule unitUpdate
                 simpleRule forParensUpdate
+                simpleRule specializationUpdate
                 simpleRule arraySyntaxUpdate
                 simpleRule booleanOperatorUpdate
             ]

src/QsFmt/Formatter/ParseTree/Namespace.fs

@@ -33,8 +33,18 @@ type SpecializationGeneratorVisitor(tokens) =
         toBuiltIn context.intrinsic context.semicolon
 
     override _.VisitProvidedGenerator context =
+        let tospecializationParameters tokens (context: QSharpParser.SpecializationParameterTupleContext) =
+            let parameters = context._parameters |> Seq.map (Node.toUnknown tokens)
+            let commas = context._commas |> Seq.map (Node.toTerminal tokens)
+
+            {
+                OpenParen = context.openParen |> Node.toTerminal tokens
+                Items = Node.tupleItems parameters commas
+                CloseParen = context.closeParen |> Node.toTerminal tokens
+            }
+
         Provided(
-            parameters = (Option.ofObj context.provided.parameters |> Option.map (Node.toUnknown tokens)),
+            parameters = (Option.ofObj context.provided.parameters |> Option.map (tospecializationParameters tokens)),
             statements =
                 {
                     OpenBrace = context.provided.block.openBrace |> Node.toTerminal tokens

src/QsFmt/Formatter/Rules.fs

@@ -160,6 +160,61 @@ let forParensUpdate =
             }
     }
 
+/// <summary>
+/// Make sure that a <see cref="SequenceItem"/> contains a comma.
+/// </summary>
+let ensureComma (item: 'a SequenceItem) =
+    match item.Comma with
+    | None -> { Item = item.Item; Comma = { Prefix = []; Text = "," } |> Some }
+    | Some _ -> item
+
+/// <summary>
+/// Prepends the <paramref name="parameters"/> with an ellipsis <see cref="Terminal"/> item if it does not already contain one.
+/// </summary>
+let ensureEllipsis (parameters: Terminal Tuple) =
+    let ellipsis nspace =
+        { Prefix = [ spaces nspace ]; Text = "..." }
+
+    let ellipsisItem nspace =
+        { Item = ellipsis nspace |> Some; Comma = None }
+
+    { parameters with
+        Items =
+            match parameters.Items with
+            // Replace, e.g., `body ()` with `body (...)`
+            | [] -> [ ellipsisItem 0 ]
+            // Replace, e.g., `controlled (q)` with `controlled (q, ...)`
+            | [ x ] ->
+                match Option.get(x.Item).Text with
+                | "..." -> [ x ]
+                | _ -> [ ensureComma x; ellipsisItem 1 ]
+            | _ -> parameters.Items
+    }
+
+let specializationUpdate =
+    { new Rewriter<_>() with
+        override _.SpecializationGenerator((), generator) =
+            let emptyTuple =
+                {
+                    OpenParen = { Prefix = [ spaces 1 ]; Text = "(" }
+                    Items = []
+                    CloseParen = { Prefix = []; Text = ")" }
+                }
+
+            match generator with
+            | Provided (parameters, statements) ->
+                Provided(
+                    parameters =
+                        (match parameters with
+                         // Replace, e.g., `body` with `body (...)`
+                         | None -> ensureEllipsis emptyTuple |> Some
+                         // Replace, e.g., `body ()` with `body (...)`
+                         | Some par -> ensureEllipsis par |> Some),
+                    statements = statements
+                )
+            | _ -> generator
+    }
+
 let arraySyntaxUpdate =
 
     let getBuiltInDefault builtIn =

src/QsFmt/Formatter/Rules.fsi

@@ -29,11 +29,15 @@ val unitUpdate : unit Rewriter
 /// Updates for-loops to remove deprecated parentheses.
 val forParensUpdate: unit Rewriter
 
+/// Updates deprecated specialization declarations to add a `...` parameter.
+val specializationUpdate: unit Rewriter
+
 /// Updates the `new <Type>[n]` array syntax to the new `[val, size = n]` array syntax.
 val arraySyntaxUpdate: unit Rewriter
 
 /// Provides warnings for deprecated array syntax still in the syntax tree.
 val checkArraySyntax: string -> Document -> string list
 
-/// Replaces `&&`, `||`, and `!` with `and`, `or`, and `not`, respectively.
+/// Replaces deprecated use of boolean operators `&&`, `||`, and `!` with their keyword
+/// equivalence `and`, `or`, and `not` respectively.
 val booleanOperatorUpdate : unit Rewriter

src/QsFmt/Formatter/SyntaxTree/Namespace.fs

@@ -14,7 +14,7 @@ type TypeParameterBinding =
 
 type SpecializationGenerator =
     | BuiltIn of name: Terminal * semicolon: Terminal
-    | Provided of parameters: Terminal option * statements: Statement Block
+    | Provided of parameters: Terminal Tuple option * statements: Statement Block
 
 type Specialization = { Names: Terminal list; Generator: SpecializationGenerator }
 

src/QsFmt/Formatter/SyntaxTree/Namespace.fsi

@@ -32,7 +32,7 @@ type internal SpecializationGenerator =
     | BuiltIn of name: Terminal * semicolon: Terminal
 
     /// A provided specialization.
-    | Provided of parameters: Terminal option * statements: Statement Block
+    | Provided of parameters: Terminal Tuple option * statements: Statement Block
 
 /// A specialization.
 type internal Specialization =

src/QsFmt/Formatter/SyntaxTree/Reducer.fs

@@ -152,7 +152,7 @@ type internal 'result Reducer() as reducer =
         match generator with
         | BuiltIn (name, semicolon) -> [ reducer.Terminal name; reducer.Terminal semicolon ] |> reduce
         | Provided (parameters, statements) ->
-            (parameters |> Option.map reducer.Terminal |> Option.toList)
+            (parameters |> Option.map (curry reducer.Tuple reducer.Terminal) |> Option.toList)
             @ [ reducer.Block(reducer.Statement, statements) ]
             |> reduce
 

src/QsFmt/Formatter/SyntaxTree/Rewriter.fs

@@ -151,7 +151,7 @@ type 'context Rewriter() =
             BuiltIn(name = rewriter.Terminal(context, name), semicolon = rewriter.Terminal(context, semicolon))
         | Provided (parameters, statements) ->
             Provided(
-                parameters = (parameters |> Option.map (curry rewriter.Terminal context)),
+                parameters = (parameters |> Option.map (curry3 rewriter.Tuple context rewriter.Terminal)),
                 statements = rewriter.Block(context, rewriter.Statement, statements)
             )
 

src/QsFmt/Parser/QSharpParser.g4

@@ -109,7 +109,8 @@ specializationGenerator
 
 providedSpecialization : parameters=specializationParameterTuple? block=scope;
 
-specializationParameterTuple : '(' (specializationParameter (',' specializationParameter)*)? ')';
+specializationParameterTuple
+    : openParen='(' (parameters+=specializationParameter (commas+=',' parameters+=specializationParameter)*)? closeParen=')';
 
 specializationParameter
     : Identifier