Split Arg into ShortName and Name

- Allow for multiple parameter annotations
- Rework the code of main to reflect changes and simplify treatment
- Change output of help and usage to accomodate for multiple names

Author: timotheeandres

library/src/scala/main.scala

@@ -9,8 +9,10 @@ object MiMaFilters {
     ProblemFilters.exclude[DirectMissingMethodProblem]("scala.main.this"),
     ProblemFilters.exclude[DirectMissingMethodProblem]("scala.main.command"),
     ProblemFilters.exclude[MissingClassProblem]("scala.main$"),
-    ProblemFilters.exclude[MissingClassProblem]("scala.main$Arg"),
-    ProblemFilters.exclude[MissingClassProblem]("scala.main$Arg$"),
+    ProblemFilters.exclude[MissingClassProblem]("scala.main$Name"),
+    ProblemFilters.exclude[MissingClassProblem]("scala.main$Name$"),
+    ProblemFilters.exclude[MissingClassProblem]("scala.main$ShortName"),
+    ProblemFilters.exclude[MissingClassProblem]("scala.main$ShortName$"),
     ProblemFilters.exclude[MissingClassProblem]("scala.annotation.MainAnnotation"),
     ProblemFilters.exclude[MissingClassProblem]("scala.annotation.MainAnnotation$"),
     ProblemFilters.exclude[MissingClassProblem]("scala.annotation.MainAnnotation$Command"),

project/MiMaFilters.scala

@@ -2,157 +2,157 @@ Usage: doc1 [--num] <Int> [--inc] <Int>
 
 Adds two numbers.
 Arguments:
-  num - Int
-  inc - Int
+  --num - Int
+  --inc - Int
 Usage: doc1 [--num] <Int> [--inc] <Int>
 
 Adds two numbers.
 Arguments:
-  num - Int
-  inc - Int
+  --num - Int
+  --inc - Int
 Usage: doc1 [--num] <Int> [--inc] <Int>
 
 Adds two numbers.
 Arguments:
-  num - Int
-  inc - Int
+  --num - Int
+  --inc - Int
 Usage: doc1 [--num] <Int> [--inc] <Int>
 
 Adds two numbers.
 Arguments:
-  num - Int
-  inc - Int
+  --num - Int
+  --inc - Int
 Usage: doc2 [--num] <Int> [--inc] <Int>
 
 Adds two numbers.
 Arguments:
-  num - Int
-  inc - Int
+  --num - Int
+  --inc - Int
 Usage: doc3 [--num] <Int> [--inc] <Int>
 
 Adds two numbers.
 Arguments:
-  num - Int
-  inc - Int
+  --num - Int
+  --inc - Int
 Usage: doc4 [--num] <Int> [[--inc] <Int>]
 
 Adds two numbers.
 Arguments:
-  num - Int
+  --num - Int
     the first number
-  inc - Int (optional)
+  --inc - Int (optional)
     the second number
 Usage: doc5 [--num] <Int> [--inc] <Int>
 
 Adds two numbers.
 Arguments:
-  num - Int
+  --num - Int
     the first number
-  inc - Int
+  --inc - Int
 Usage: doc6 [--num] <Int> [--inc] <Int>
 
 Adds two numbers.
 Arguments:
-  num - Int
-  inc - Int
+  --num - Int
+  --inc - Int
 Usage: doc7 [--num] <Int> [--inc] <Int>
 
 Adds two numbers.
 Arguments:
-  num - Int
+  --num - Int
     the first number
-  inc - Int
+  --inc - Int
     the second number
 Usage: doc8 [--num] <Int> [--inc] <Int>
 
 Adds two numbers.
 Arguments:
-  num - Int
+  --num - Int
     the first number
-  inc - Int
+  --inc - Int
     the second number
 Usage: doc9 [--num] <Int> [--inc] <Int>
 
 Adds two numbers. Same as doc1.
 Arguments:
-  num - Int
+  --num - Int
     the first number
-  inc - Int
+  --inc - Int
     the second number
 Usage: doc10 [--num] <Int> [--inc] <Int>
 
 Adds two numbers.
 This should be on another line.
 And this also.
 Arguments:
-  num - Int
+  --num - Int
     I might have to write this on two lines
-  inc - Int
+  --inc - Int
     I might even have to write this one on three lines
 Usage: doc11 [--num] <Int> [--inc] <Int>
 
 Adds two numbers.
 Arguments:
-  num - Int
+  --num - Int
     the first number
     Oh, a new line!
-  inc - Int
+  --inc - Int
     the second number
     And another one!
 Usage: doc12 [--num] <Int> [--inc] <Int>
 
 Adds two numbers. It seems that I have a very long line of documentation and therefore might need to be cut at some
 point to fit a small terminal screen.
 Arguments:
-  num - Int
-  inc - Int
+  --num - Int
+  --inc - Int
 Usage: doc13 [--num] <Int> [--inc] <Int>
 
 Addstwonumbers.ItseemsthatIhaveaverylonglineofdocumentationandthereforemightneedtobecutatsomepointtofitasmallterminalscreen.
 Arguments:
-  num - Int
-  inc - Int
+  --num - Int
+  --inc - Int
 Usage: doc14 [--arg1] <String> [--arg2] <Int> [--arg3] <String> [--arg4] <Int> [--arg5] <String> [--arg6] <Int>
              [--arg7] <String> [--arg8] <Int> [[--arg9] <String>] [[--arg10] <Int>] [[--arg11] <String>]
              [[--arg12] <Int>] [[--arg13] <String>] [[--arg14] <Int>] [[--arg15] <String>] [<Int> [<Int> [...]]]
 
 Loudly judges the number of argument you gave to this poor function.
 Arguments:
-  arg1 - String
-  arg2 - Int
-  arg3 - String
-  arg4 - Int
-  arg5 - String
-  arg6 - Int
-  arg7 - String
-  arg8 - Int
-  arg9 - String (optional)
-  arg10 - Int (optional)
-  arg11 - String (optional)
-  arg12 - Int (optional)
-  arg13 - String (optional)
-  arg14 - Int (optional)
-  arg15 - String (optional)
-  arg16 - Int (vararg)
+  --arg1 - String
+  --arg2 - Int
+  --arg3 - String
+  --arg4 - Int
+  --arg5 - String
+  --arg6 - Int
+  --arg7 - String
+  --arg8 - Int
+  --arg9 - String (optional)
+  --arg10 - Int (optional)
+  --arg11 - String (optional)
+  --arg12 - Int (optional)
+  --arg13 - String (optional)
+  --arg14 - Int (optional)
+  --arg15 - String (optional)
+  --arg16 - Int (vararg)
 Usage: doc15 [--myNum] <MyNumber> [--myInc] <MyNumber>
 
 Adds two instances of MyNumber.
 Arguments:
-  myNum - MyNumber
+  --myNum - MyNumber
     my first number to add
-  myInc - MyNumber
+  --myInc - MyNumber
     my second number to add
 Usage: doc16 [--first] <MyGeneric[Int]> [--second] <MyGeneric[Int]>
 
 Compares two instances of MyGeneric.
 Arguments:
-  first - MyGeneric[Int]
+  --first - MyGeneric[Int]
     my first element
-  second - MyGeneric[Int]
+  --second - MyGeneric[Int]
     my second element
 Usage: doc17 [--a] <Int> [--b] <Int> [--c] <String>
 
 Arguments:
-  a - Int
-  b - Int
-  c - String
+  --a - Int
+  --b - Int
+  --c - String

tests/run/main-annotation-help.check

@@ -2,23 +2,23 @@ Usage: doc1 [--a] <Int> [--b] <Int> [--c] <String>
 
 Help is printed normally.
 Arguments:
-  a - Int
+  --a - Int
     the first argument
-  b - Int
+  --b - Int
     the second argument
-  c - String
+  --c - String
     the third argument. This one is a String
 Usage: doc2 [--a] <Int> [--b] <Int>
             [--c] <String>
 
 Help is printed in a slightly narrow
 column.
 Arguments:
-  a - Int
+  --a - Int
     the first argument
-  b - Int
+  --b - Int
     the second argument
-  c - String
+  --c - String
     the third argument. This one is a
     String
 Usage: doc3 [--a] <Int>
@@ -28,13 +28,13 @@ Usage: doc3 [--a] <Int>
 Help is printed in a
 very narrow column!
 Arguments:
-  a - Int
+  --a - Int
     the first
     argument
-  b - Int
+  --b - Int
     the second
     argument
-  c - String
+  --c - String
     the third
     argument. This
     one is a String

tests/run/main-annotation-max-line-length.check

@@ -0,0 +1,20 @@
+2 + 3 = 5
+2 + 3 = 5
+2 + 3 = 5
+2 + 3 = 5
+2 + 3 = 5
+2 + 3 = 5
+2 + 3 = 5
+2 + 3 = 5
+2 + 3 = 5
+2 + 3 = 5
+2 + 3 = 5
+2 + 3 = 5
+2 + 3 = 5
+2 + 3 = 5
+2 + 3 = 5
+2 + 3 = 5
+2 + 3 = 5
+2 + 3 = 5
+2 + 3 = 5
+2 + 3 = 5

tests/run/main-annotation-param-annot-1.check

@@ -1,44 +1,33 @@
 object myProgram:
-  @main def noParamAnnotArgs(
-    @main.Arg() num: Int,
-    @main.Arg() inc: Int
-  ): Unit =
-    println(s"$num + $inc = ${num + inc}")
-
   @main def altName1(
-    @main.Arg(name = "myNum") num: Int,
+    @main.Name("myNum") num: Int,
     inc: Int
   ): Unit =
     println(s"$num + $inc = ${num + inc}")
 
   @main def altName2(
-    @main.Arg(name = "myNum") num: Int,
-    @main.Arg(name = "myInc") inc: Int
+    @main.Name("myNum") num: Int,
+    @main.Name("myInc") inc: Int
   ): Unit =
     println(s"$num + $inc = ${num + inc}")
 
   @main def shortName1(
-    @main.Arg(shortName = 'n') num: Int,
+    @main.ShortName('n') num: Int,
     inc: Int
   ): Unit =
     println(s"$num + $inc = ${num + inc}")
 
   @main def shortName2(
-    @main.Arg(shortName = 'n') num: Int,
-    @main.Arg(shortName = 'i') inc: Int
+    @main.ShortName('n') num: Int,
+    @main.ShortName('i') inc: Int
   ): Unit =
     println(s"$num + $inc = ${num + inc}")
 
   @main def mix(
-    @main.Arg(name = "myNum", shortName = 'n') num: Int,
-    @main.Arg(shortName = 'i', name = "myInc") inc: Int
+    @main.Name("myNum") @main.ShortName('n') num: Int,
+    @main.ShortName('i') @main.Name("myInc") inc: Int
   ): Unit =
     println(s"$num + $inc = ${num + inc}")
-
-  @main def multipleSameShortName(
-    @main.Arg(shortName = 'n') num: Int,
-    @main.Arg(shortName = 'n') inc: Int
-  ): Unit = ()
 end myProgram
 
 
@@ -49,8 +38,6 @@ object Test:
     method.invoke(null, args)
 
   def main(args: Array[String]): Unit =
-    callMain("noParamAnnotArgs", Array("--num", "2", "--inc", "3"))
-
     callMain("altName1", Array("--num", "2", "--inc", "3"))
     callMain("altName1", Array("--myNum", "2", "--inc", "3"))
 
@@ -75,6 +62,4 @@ object Test:
     callMain("mix", Array("-n", "2", "--myInc", "3"))
     callMain("mix", Array("--myNum", "2", "-i", "3"))
     callMain("mix", Array("-n", "2", "-i", "3"))
-
-    callMain("multipleSameShortName", Array("2", "3"))
 end Test

tests/run/main-annotation-param-annot.scala renamed to tests/run/main-annotation-param-annot-1.scala

@@ -0,0 +1,9 @@
+OK
+OK
+OK
+OK
+OK
+OK
+OK
+OK
+OK