#769 Add a placeholder for encoders to be available in AST.

Author: yruslan

cobol-parser/src/main/scala/za/co/absa/cobrix/cobol/parser/antlr/ParserVisitor.scala

@@ -23,7 +23,7 @@ import za.co.absa.cobrix.cobol.parser.CopybookParser.CopybookAST
 import za.co.absa.cobrix.cobol.parser.ast.datatype._
 import za.co.absa.cobrix.cobol.parser.ast.{Group, Primitive}
 import za.co.absa.cobrix.cobol.parser.common.Constants
-import za.co.absa.cobrix.cobol.parser.decoders.DecoderSelector
+import za.co.absa.cobrix.cobol.parser.decoders.{DecoderSelector, EncoderSelector}
 import za.co.absa.cobrix.cobol.parser.decoders.FloatingPointFormat.FloatingPointFormat
 import za.co.absa.cobrix.cobol.parser.encoding.codepage.CodePage
 import za.co.absa.cobrix.cobol.parser.encoding._
@@ -855,8 +855,9 @@ class ParserVisitor(enc: Encoding,
       Map(),
       isDependee = false,
       identifier.toUpperCase() == Constants.FILLER,
-      DecoderSelector.getDecoder(pic.value, stringTrimmingPolicy, isDisplayAlwaysString, effectiveEbcdicCodePage, effectiveAsciiCharset, isUtf16BigEndian = isUtf16BigEndian, floatingPointFormat, strictSignOverpunch = strictSignOverpunch, improvedNullDetection = improvedNullDetection, strictIntegralPrecision = strictIntegralPrecision)
-      ) (Some(parent))
+      DecoderSelector.getDecoder(pic.value, stringTrimmingPolicy, isDisplayAlwaysString, effectiveEbcdicCodePage, effectiveAsciiCharset, isUtf16BigEndian = isUtf16BigEndian, floatingPointFormat, strictSignOverpunch = strictSignOverpunch, improvedNullDetection = improvedNullDetection, strictIntegralPrecision = strictIntegralPrecision),
+      EncoderSelector.getEncoder(pic.value, effectiveEbcdicCodePage, effectiveAsciiCharset),
+    )(Some(parent))
 
     parent.children.append(prim)
 

cobol-parser/src/main/scala/za/co/absa/cobrix/cobol/parser/ast/Primitive.scala

@@ -17,19 +17,26 @@
 package za.co.absa.cobrix.cobol.parser.ast
 
 import za.co.absa.cobrix.cobol.parser.ast.datatype.{AlphaNumeric, CobolType, Decimal, Integral}
-import za.co.absa.cobrix.cobol.parser.decoders.{BinaryUtils, DecoderSelector}
+import za.co.absa.cobrix.cobol.parser.decoders.{BinaryUtils, DecoderSelector, EncoderSelector}
 
 /** An abstraction of the statements describing fields of primitive data types in the COBOL copybook
   *
-  * @param level        A level for the statement
-  * @param name         An identifier
-  * @param originalName Original name of the AST element (before the conversion to the Spark-compatible name)
-  * @param lineNumber   An line number in the copybook
-  * @param redefines    A name of a field which is redefined by this one
-  * @param occurs       The number of elements in an fixed size array / minimum items in variable-sized array
-  * @param to           The maximum number of items in a variable size array
-  * @param dependingOn  A field which specifies size of the array in a record
-  * @param parent       A parent node
+  * @param level               A level for the statement
+  * @param name                An identifier
+  * @param originalName        Original name of the AST element (before the conversion to the Spark-compatible name)
+  * @param lineNumber          An line number in the copybook
+  * @param redefines           A name of a field which is redefined by this one
+  * @param isRedefined         A flag indicating if the field is redefined
+  * @param occurs              The number of elements in an fixed size array / minimum items in variable-sized array
+  * @param to                  The maximum number of items in a variable size array
+  * @param dependingOn         A field which specifies size of the array in a record
+  * @param dependingOnHandlers A map of handlers for the dependingOn field
+  * @param isDependee          A flag indicating if the field is a dependee
+  * @param isFiller            A flag indicating if the field is a filler
+  * @param decode              A decoder for the field to convert from raw data to a JVM data type
+  * @param encode              An optional encoder for the field to convert from a JVM data type to raw data
+  * @param binaryProperties    Binary properties of the field, such as size in bits, alignment, etc.
+  * @param parent              A parent node
   */
 case class Primitive(
                       level: Int,
@@ -46,6 +53,7 @@ case class Primitive(
                       isDependee: Boolean = false,
                       isFiller: Boolean = false,
                       decode: DecoderSelector.Decoder,
+                      encode: Option[EncoderSelector.Encoder],
                       binaryProperties: BinaryProperties = BinaryProperties(0, 0, 0)
                     )
                     (val parent: Option[Group] = None)

cobol-parser/src/main/scala/za/co/absa/cobrix/cobol/parser/asttransform/NonTerminalsAdder.scala

@@ -20,7 +20,7 @@ import za.co.absa.cobrix.cobol.parser.CopybookParser.CopybookAST
 import za.co.absa.cobrix.cobol.parser.ast.datatype.AlphaNumeric
 import za.co.absa.cobrix.cobol.parser.ast.{Group, Primitive, Statement}
 import za.co.absa.cobrix.cobol.parser.common.Constants
-import za.co.absa.cobrix.cobol.parser.decoders.DecoderSelector
+import za.co.absa.cobrix.cobol.parser.decoders.{DecoderSelector, EncoderSelector}
 import za.co.absa.cobrix.cobol.parser.decoders.FloatingPointFormat.FloatingPointFormat
 import za.co.absa.cobrix.cobol.parser.encoding.Encoding
 import za.co.absa.cobrix.cobol.parser.encoding.codepage.CodePage
@@ -74,13 +74,15 @@ class NonTerminalsAdder(
             val sz = g.binaryProperties.actualSize
             val dataType = AlphaNumeric(s"X($sz)", sz, enc = Some(enc))
             val decode = DecoderSelector.getDecoder(dataType, stringTrimmingPolicy, isDisplayAlwaysString = false, ebcdicCodePage, asciiCharset, isUtf16BigEndian, floatingPointFormat, strictSignOverpunch, improvedNullDetection)
+            val encode = EncoderSelector.getEncoder(dataType, ebcdicCodePage, asciiCharset)
             val newName = getNonTerminalName(g.name, g.parent.get)
             newChildren.append(
               Primitive(
                 g.level, newName, "", g.lineNumber,
                 dataType,
                 redefines = Some(g.name),
                 decode = decode,
+                encode = encode,
                 binaryProperties = g.binaryProperties
               )(g.parent)
             )

cobol-parser/src/main/scala/za/co/absa/cobrix/cobol/parser/decoders/EncoderSelector.scala

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2018 ABSA Group Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package za.co.absa.cobrix.cobol.parser.decoders
+
+import za.co.absa.cobrix.cobol.parser.ast.datatype.CobolType
+import za.co.absa.cobrix.cobol.parser.encoding.codepage.{CodePage, CodePageCommon}
+
+import java.nio.charset.{Charset, StandardCharsets}
+
+object EncoderSelector {
+  type Encoder = Any => Array[Byte]
+
+  def getEncoder(dataType: CobolType,
+                 ebcdicCodePage: CodePage = new CodePageCommon,
+                 asciiCharset: Charset = StandardCharsets.US_ASCII): Option[Encoder] = {
+    None
+  }
+
+}

cobol-parser/src/test/scala/za/co/absa/cobrix/cobol/parser/extract/BinaryExtractorSpec.scala

@@ -20,7 +20,7 @@ import org.scalatest.funsuite.AnyFunSuite
 import za.co.absa.cobrix.cobol.parser.CopybookParser
 import za.co.absa.cobrix.cobol.parser.ast.datatype.{AlphaNumeric, CobolType}
 import za.co.absa.cobrix.cobol.parser.ast.{BinaryProperties, Group, Primitive}
-import za.co.absa.cobrix.cobol.parser.decoders.DecoderSelector
+import za.co.absa.cobrix.cobol.parser.decoders.{DecoderSelector, EncoderSelector}
 import za.co.absa.cobrix.cobol.parser.encoding.EBCDIC
 
 class BinaryExtractorSpec extends AnyFunSuite {
@@ -160,7 +160,7 @@ class BinaryExtractorSpec extends AnyFunSuite {
     val binaryProperties: BinaryProperties = BinaryProperties(2, 10, 10)
 
     val primitive: Primitive = Primitive(level, name, name, lineNumber, dataType, redefines, isRedefined,
-      occurs, to, dependingOn, Map(), isDependee, isFiller, DecoderSelector.getDecoder(dataType), binaryProperties)(None)
+      occurs, to, dependingOn, Map(), isDependee, isFiller, DecoderSelector.getDecoder(dataType), EncoderSelector.getEncoder(dataType), binaryProperties)(None)
     val result2: Any = copybook.extractPrimitiveField(primitive, bytes, startOffset)
     assert(result2.asInstanceOf[String] === "EXAMPLE4")
   }