WI #1917 Improve error messages on unexpected dots (#2025)

Author: fm-117

TypeCobol.Test/Parser/Programs/Cobol85/ConsecutiveDots.rdz.cbl

@@ -0,0 +1,24 @@
+       IDENTIFICATION DIVISION.
+       PROGRAM-ID. Pgm.
+       ENVIRONMENT DIVISION.
+       CONFIGURATION SECTION.
+       SPECIAL-NAMES. DECIMAL-POINT IS COMMA.
+       DATA DIVISION.
+       WORKING-STORAGE SECTION.
+      *OK
+       01 A pic X.
+      *KO Invalid Picture
+       01 B pic X..
+      *KO Unexpected '.'
+       01 C pic X. .
+      *KO not reported because of previous error
+       01 var1..
+          05 var2 pic XX.
+      *KO Invalid Picture
+          05 var3 pic X.05 var4 pic X.
+       PROCEDURE DIVISION..
+           move A to B..
+           move A to B...move A to B.
+           goback
+           .
+       END PROGRAM Pgm.

TypeCobol.Test/Parser/Programs/Cobol85/ConsecutiveDots.rdzMix.txt

@@ -0,0 +1,34 @@
+       IDENTIFICATION DIVISION.
+       PROGRAM-ID. Pgm.
+       ENVIRONMENT DIVISION.
+       CONFIGURATION SECTION.
+       SPECIAL-NAMES. DECIMAL-POINT IS COMMA.
+       DATA DIVISION.
+       WORKING-STORAGE SECTION.
+      *OK
+       01 A pic X.
+      *KO Invalid Picture
+Line 11[17,18] <27, Error, Syntax> - Syntax error : Combination of symbols 'X.' was not recognized as a valid PICTURE string
+       01 B pic X..
+      *KO Unexpected '.'
+Line 13[20,20] <27, Error, Syntax> - Syntax error : extraneous input '.' expecting {ProgramIdentification, ProgramEnd, ClassIdentification, ClassEnd, FactoryEnd, ObjectIdentification, ObjectEnd, MethodEnd, ProcedureDivisionHeader, WorkingStorageSectionHeader, LocalStorageSectionHeader, LinkageSectionHeader, FileDescriptionEntry, DataDescriptionEntry, DataRedefinesEntry, DataRenamesEntry, DataConditionEntry, ExecStatement, FunctionDeclarationEnd, GlobalStorageSectionHeader}
+       01 C pic X. .
+      *KO not reported because of previous error
+Line 15[15,15] <12, Warning, Tokens> - A blank was missing before character "." in column 16. A blank was assumed.
+       01 var1..
+          05 var2 pic XX.
+      *KO Invalid Picture
+Line 18[23,26] <27, Error, Syntax> - Syntax error : Invalid PICTURE string 'X.05': character '5' at position '4' was not expected
+Line 18[28,31] <27, Error, Syntax> - Syntax error : extraneous input 'var4' expecting {separator, statement starting keyword, keyword}
+          05 var3 pic X.05 var4 pic X.
+Line 19[26,26] <12, Warning, Tokens> - A blank was missing before character "." in column 27. A blank was assumed.
+       PROCEDURE DIVISION..
+Line 20[23,23] <12, Warning, Tokens> - A blank was missing before character "." in column 24. A blank was assumed.
+           move A to B..
+Line 21[23,23] <12, Warning, Tokens> - A blank was missing before character "." in column 24. A blank was assumed.
+Line 21[24,24] <12, Warning, Tokens> - A blank was missing before character "." in column 25. A blank was assumed.
+Line 21[25,25] <12, Warning, Tokens> - A blank was missing before character "m" in column 26. A blank was assumed.
+           move A to B...move A to B.
+           goback
+           .
+       END PROGRAM Pgm.

TypeCobol/Compiler/Types/PictureValidator.cs

@@ -21,7 +21,7 @@ public partial class PictureValidator
         private const string PARENTHESES_DO_NOT_MATCH = "Missing '(' or ')' in PICTURE string";
         private const string SYMBOL_COUNT_CANNOT_BE_ZERO = "Symbol count cannot be zero";
         private const string MULTIPLE_CURRENCIES_IN_SAME_PICTURE = "Cannot mix currency symbols in a PICTURE string: '{0}' symbol was not expected";
-        private const string INVALID_DATA_CATEGORY = "Invalid data category for PICTURE string '{0}'";
+        private const string INVALID_PICTURE_STRING = "Combination of symbols '{0}' was not recognized as a valid PICTURE string";
         private const string INVALID_SYMBOL_POSITION = "Invalid position in PICTURE string of the symbol: {0}";
         private const string SYMBOL_S_MUST_BE_THE_FIRST = "S must be at the beginning of a PICTURE string";
         private const string MULTIPLE_V = "V must appears only once in a PICTURE string";
@@ -60,6 +60,7 @@ public PictureValidator(string picture, bool separateSign = false, bool decimalP
             }
             _currencyDescriptor = null;
 
+            OriginalPicture = picture;
             _decimalPointIsComma = decimalPointIsComma;
             if (_decimalPointIsComma)
             {
@@ -92,7 +93,12 @@ public PictureValidator(string picture, bool separateSign = false, bool decimalP
         }
 
         /// <summary>
-        /// The Picture string, with comma and dot swapped if DECIMAL POINT IS COMMA is active.
+        /// The unaltered Picture string
+        /// </summary>
+        public string OriginalPicture { get; }
+
+        /// <summary>
+        /// The Picture string to validate, with comma and dot swapped if DECIMAL POINT IS COMMA is active.
         /// </summary>
         public string Picture { get; }
 
@@ -134,7 +140,7 @@ public Result Validate(out List<string> validationMessages)
             var category = DeterminePictureCategory(sequence, symbolCounts);
             if (category == PictureCategory.Invalid)
             {
-                validationMessages.Add(string.Format(INVALID_DATA_CATEGORY, Picture));
+                validationMessages.Add(string.Format(INVALID_PICTURE_STRING, OriginalPicture));
             }
             else
             {
@@ -266,7 +272,7 @@ private List<Tuple<string, int>> PictureStringSplitter(List<string> validationMe
 
                 if (!match)
                 {
-                    validationMessages.Add(string.Format(UNKNOWN_SYMBOL, Picture, Picture[l], l + 1));
+                    validationMessages.Add(string.Format(UNKNOWN_SYMBOL, OriginalPicture, Picture[l], l + 1));
                     return null;
                 }
             }