Merge pull request #274 from BalticAmadeus/261-format-functionmethod-…

…arguments-over-multiple-lines

261 format function method arguments over multiple lines

package.json

@@ -248,6 +248,22 @@
           "default": "true",
           "description": "Enable PROCEDURE PARAMETER formatting"
         },
+        "AblFormatter.functionParameterFormatting": {
+          "order": 1600,
+          "type": "boolean",
+          "default": "true",
+          "description": "Enable FUNCTION PARAMETER formatting"
+        },
+        "AblFormatter.functionParameterFormattingAlignParameterTypes": {
+          "order": 1601,
+          "type": "string",
+          "default": "Yes",
+          "enum": [
+            "Yes",
+            "No"
+          ],
+          "description": "Align parameter types?"
+        },
         "AblFormatter.showTreeInfoOnHover": {
           "order": 10100,
           "type": "boolean",

resources/functionalTests/assign/2inFunction/input.p

@@ -1,6 +1,7 @@
 /* formatterSettingsOverride */
 /*  { "AblFormatter.assignFormatting": true,
 "abl.completion.upperCase": true,
+"AblFormatter.functionParameterFormatting": false,
 "AblFormatter.assignFormattingAssignLocation": "New",
 "AblFormatter.assignFormattingAlignRightExpression": "Yes",
 "AblFormatter.assignFormattingEndDotLocation": "New aligned"}*/

resources/functionalTests/assign/2inFunction/target.p

@@ -1,6 +1,7 @@
 /* formatterSettingsOverride */
 /*  { "AblFormatter.assignFormatting": true,
 "abl.completion.upperCase": true,
+"AblFormatter.functionParameterFormatting": false,
 "AblFormatter.assignFormattingAssignLocation": "New",
 "AblFormatter.assignFormattingAlignRightExpression": "Yes",
 "AblFormatter.assignFormattingEndDotLocation": "New aligned"}*/

resources/functionalTests/block/20function-block-end3/input.p

@@ -1,8 +1,7 @@
 /* formatterSettingsOverride */
 /*  { "AblFormatter.blockFormatting": true}*/
 
-function fun returns integer (input p1 as integer,
-                              input-output p2 as logical,
-                              output p3 as character):
-    return p1.
-   end function.
+function GetDLC returns character
+():
+    define variable cValue as character no-undo.
+end function.

resources/functionalTests/block/20function-block-end3/target.p

@@ -1,8 +1,7 @@
 /* formatterSettingsOverride */
 /*  { "AblFormatter.blockFormatting": true}*/
 
-function fun returns integer (input p1 as integer,
-                              input-output p2 as logical,
-                              output p3 as character):
-    return p1.
+function GetDLC returns character
+():
+    define variable cValue as character no-undo.
 end function.

resources/functionalTests/block/25function-block-inner5/target.p

@@ -1,8 +1,8 @@
 /* formatterSettingsOverride */
 /*  { "AblFormatter.blockFormatting": true}*/
 
-function fun returns integer (input p1 as integer,
+function fun returns integer (input        p1 as integer,
                               input-output p2 as logical,
-                              output p3 as character):
+                              output       p3 as character):
     return p1.
 end function.

resources/functionalTests/block/6do-end2/input.p

@@ -2,6 +2,7 @@
 /*  { "AblFormatter.blockFormatting": true}*/
 
 do transaction:
- do while true:         
-        a = 3.    end. 
-      end.
+    do while true:         
+        a = 3.    
+    end. 
+end.

resources/functionalTests/functionParameter/1method/input.p

@@ -0,0 +1,8 @@
+/* formatterSettingsOverride */
+/*  { "AblFormatter.functionParameterFormatting": true,
+      "AblFormatter.functionParameterFormattingAlignParameterTypes": "No"}*/
+
+class FunClass:
+    method public Table fill(poQuery as Query, poOnNotAvailable as QueryNotAvailable):
+    end end method.
+end class.

resources/functionalTests/functionParameter/1method/target.p

@@ -0,0 +1,9 @@
+/* formatterSettingsOverride */
+/*  { "AblFormatter.functionParameterFormatting": true,
+      "AblFormatter.functionParameterFormattingAlignParameterTypes": "No"}*/
+
+class FunClass:
+    method public Table fill(poQuery as Query,
+                             poOnNotAvailable as QueryNotAvailable):
+    end end method.
+end class.

resources/functionalTests/functionParameter/2function/input.p

@@ -0,0 +1,7 @@
+/* formatterSettingsOverride */
+/*  { "AblFormatter.functionParameterFormatting": true,
+      "AblFormatter.functionParameterFormattingAlignParameterTypes": "Yes"}*/
+
+FUNCTION doubler RETURNS INTEGER(INPUT parm1 AS INTEGER):
+    RETURN (2 * parm1).
+END FUNCTION.

resources/functionalTests/functionParameter/2function/target.p

@@ -0,0 +1,7 @@
+/* formatterSettingsOverride */
+/*  { "AblFormatter.functionParameterFormatting": true,
+      "AblFormatter.functionParameterFormattingAlignParameterTypes": "Yes"}*/
+
+FUNCTION doubler RETURNS INTEGER(INPUT parm1 AS INTEGER):
+    RETURN (2 * parm1).
+END FUNCTION.

resources/functionalTests/functionParameter/3dataset-align-types/input.p

@@ -0,0 +1,11 @@
+/* formatterSettingsOverride */
+/*  { "AblFormatter.functionParameterFormatting": true,
+      "AblFormatter.functionParameterFormattingAlignParameterTypes": "Yes"}*/
+
+class MyEntityClass:
+    method public void Fetch( input-output dataset dsMyDataset,poParameter2   as integer,
+                             piParameterInteger as myParameter):
+
+    end method.
+end class.
+

resources/functionalTests/functionParameter/3dataset-align-types/target.p

@@ -0,0 +1,12 @@
+/* formatterSettingsOverride */
+/*  { "AblFormatter.functionParameterFormatting": true,
+      "AblFormatter.functionParameterFormattingAlignParameterTypes": "Yes"}*/
+
+class MyEntityClass:
+    method public void Fetch(input-output dataset dsMyDataset,
+                             poParameter2       as integer,
+                             piParameterInteger as myParameter):
+
+    end method.
+end class.
+

resources/functionalTests/functionParameter/3dataset-handle/input.p

@@ -0,0 +1,9 @@
+/* formatterSettingsOverride */
+/*  { "AblFormatter.functionParameterFormatting": true,
+      "AblFormatter.functionParameterFormattingAlignParameterTypes": "Yes"}*/
+
+class FunkyWorld.Util.KittyLogHelper:
+    method private void SnuggleDataset(dataset-handle dsCuddlePuddle bind):
+        /* PURR */
+    end method.
+end class.

resources/functionalTests/functionParameter/3dataset-handle/target.p

@@ -0,0 +1,9 @@
+/* formatterSettingsOverride */
+/*  { "AblFormatter.functionParameterFormatting": true,
+      "AblFormatter.functionParameterFormattingAlignParameterTypes": "Yes"}*/
+
+class FunkyWorld.Util.KittyLogHelper:
+    method private void SnuggleDataset(dataset-handle dsCuddlePuddle bind):
+        /* PURR */
+    end method.
+end class.

resources/functionalTests/functionParameter/3table-handle/input.p

@@ -0,0 +1,16 @@
+/* formatterSettingsOverride */
+/*  { "AblFormatter.functionParameterFormatting": true,
+      "AblFormatter.functionParameterFormattingAlignParameterTypes": "Yes"}*/
+
+class Olympus.Util.HermesHelper:
+    method public static void ExecuteOracleQuery(pcOracleString as character,
+                                                    pcOlympianFields as character,
+                                                    piNumProphecies as integer,
+                                                    output table-handle phOracleTable):
+
+        ZeusCollectorHelper:SmiteObject(hHermesQuery).
+        ZeusCollectorHelper:SmiteObject(hDionysusBuffer).
+
+    end method.
+
+end class.

resources/functionalTests/functionParameter/3table-handle/target.p

@@ -0,0 +1,16 @@
+/* formatterSettingsOverride */
+/*  { "AblFormatter.functionParameterFormatting": true,
+      "AblFormatter.functionParameterFormattingAlignParameterTypes": "Yes"}*/
+
+class Olympus.Util.HermesHelper:
+    method public static void ExecuteOracleQuery(pcOracleString   as character,
+                                                 pcOlympianFields as character,
+                                                 piNumProphecies  as integer,
+                                                 output table-handle phOracleTable):
+
+        ZeusCollectorHelper:SmiteObject(hHermesQuery).
+        ZeusCollectorHelper:SmiteObject(hDionysusBuffer).
+
+    end method.
+
+end class.

resources/functionalTests/functionParameter/4function-align/input.p

@@ -0,0 +1,7 @@
+/* formatterSettingsOverride */
+/*  { "AblFormatter.functionParameterFormatting": true,
+      "AblFormatter.functionParameterFormattingAlignParameterTypes": "Yes"}*/
+
+function finalShot returns character (input myDribbleShot as character, output tipOffAll as TipOff):
+
+end function.

resources/functionalTests/functionParameter/4function-align/target.p

@@ -0,0 +1,8 @@
+/* formatterSettingsOverride */
+/*  { "AblFormatter.functionParameterFormatting": true,
+      "AblFormatter.functionParameterFormattingAlignParameterTypes": "Yes"}*/
+
+function finalShot returns character (input  myDribbleShot as character,
+                                      output tipOffAll     as TipOff):
+
+end function.

resources/functionalTests/functionParameter/4function/input.p

@@ -0,0 +1,8 @@
+/* formatterSettingsOverride */
+/*  { "AblFormatter.functionParameterFormatting": true,
+      "AblFormatter.functionParameterFormattingAlignParameterTypes": "No"}*/
+
+function finalShot returns character (input myDribble as character, output tipOff as character):
+
+end function.
+

resources/functionalTests/functionParameter/4function/target.p

@@ -0,0 +1,9 @@
+/* formatterSettingsOverride */
+/*  { "AblFormatter.functionParameterFormatting": true,
+      "AblFormatter.functionParameterFormattingAlignParameterTypes": "No"}*/
+
+function finalShot returns character (input myDribble as character,
+                                      output tipOff as character):
+
+end function.
+

src/model/SyntaxNodeType.ts

@@ -65,6 +65,9 @@ export enum SyntaxNodeType {
     LeftParenthesis = "(",
     RightParenthesis = ")",
     Label = "label",
+    Parameters = "parameters",
+    FunctionParameter = "function_parameter",
+    FunctionParameterMode = "function_parameter_mode",
 
     // keywords
     WhenKeyword = "WHEN",
@@ -107,6 +110,10 @@ export enum SyntaxNodeType {
     ReturnKeyword = "RETURN",
     ParameterKeyword = "PARAMETER",
     VariableKeyword = "VARIABLE",
+    TableKeyword = "TABLE",
+    TableHandleKeyword = "TABLE-HANDLE",
+    DatasetKeyword = "DATASET",
+    DatasetHandleKeyword = "DATASET-HANDLE",
 }
 
 export const afterThenStatements = new MyFancySet<string>([
@@ -124,6 +131,13 @@ export const definitionKeywords = new MyFancySet<string>([
     SyntaxNodeType.DefKeyword,
 ]);
 
+export const dataStructureKeywords = new MyFancySet<string>([
+    SyntaxNodeType.TableKeyword,
+    SyntaxNodeType.TableHandleKeyword,
+    SyntaxNodeType.DatasetKeyword,
+    SyntaxNodeType.DatasetHandleKeyword,
+]);
+
 export const bodyBlockKeywords = new MyFancySet<string>([
     SyntaxNodeType.Body,
     SyntaxNodeType.CaseBody,
@@ -137,3 +151,8 @@ export const parameterTypes = new MyFancySet<string>([
     SyntaxNodeType.InputOutputKeyword,
     SyntaxNodeType.ReturnKeyword,
 ]);
+
+export const parentheses = new MyFancySet<string>([
+    SyntaxNodeType.LeftParenthesis,
+    SyntaxNodeType.RightParenthesis,
+]);

src/v2/formatterFramework/enableFormatterDecorators.ts

@@ -13,6 +13,7 @@ import { BodyFormatter } from "../formatters/body/BodyFormatter";
 import { EnumFormatter } from "../formatters/enum/EnumFormatter";
 import { VariableDefinitionFormatter } from "../formatters/variableDefinition/VariableDefinitionFormatter";
 import { ProcedureParameterFormatter } from "../formatters/procedureParameter/ProcedureParameterFormatter";
+import { FunctionParameterFormatter } from "../formatters/functionParameter/FunctionParameterFormatter";
 
 // needed just for enabling decorators. Decorators does not work if there is no usage of a class in the reachable code
 export function enableFormatterDecorators(): void {
@@ -31,4 +32,5 @@ export function enableFormatterDecorators(): void {
     VariableDefinitionFormatter;
     EnumFormatter;
     ProcedureParameterFormatter;
+    FunctionParameterFormatter;
 }