za.co.absa.cobrix.cobol.parser.ast.CBTree.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cobol-parser Show documentation
There is a newer version: 1.1.2
/*
 * Copyright 2018 Barclays Africa 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.ast

/** Trait for Cobol copybook AST element. */
trait CBTree {
  val camelCased: String = {
    camelCase(name)
  }

  /** Returns the level of the AST element */
  def level: Int

  /** Returns the name of the AST element */
  def name: String

  /** Returns the parent element of the ASt element */
  def parent: Option[Group]

  /** Returns a fields name that this AST element redefines (REDEFINES property) */
  def redefines: Option[String]

  /** Returns true is the AST element is an array (has OCCURS) */
  def isArray: Boolean = occurs.nonEmpty

  /** Returns OCCURS property of the AST element if present */
  def occurs: Option[Int]

  /** Returns TO property of the AST element if present */
  def to: Option[Int]

  /** Returns the minimum OCCURS (array) size of the field. Returns 1 for non-OCCURS (non-array) fields. */
  def arrayMinSize: Int = {
    (occurs, to) match {
      case (None, None) => 1
      case (Some(n), None) => 1
      case (None, Some(_)) => throw new IllegalThreadStateException(s"Field properties 'OCCURS' and 'TO' are incorrectly specified for '$name'")
      case (Some(n), Some(_)) => n
    }
  }

  /** Returns the maximum OCCURS (array) size of the field. Returns 1 for non-OCCURS (non-array) fields. */
  def arrayMaxSize: Int = {
    (occurs, to) match {
      case (None, None) => 1
      case (Some(n), None) => n
      case (None, Some(_)) => throw new IllegalThreadStateException(s"Field properties 'OCCURS' and 'TO' are incorrectly specified for '$name'")
      case (Some(_), Some(m)) => m
    }
  }

  /** Returns a field name this fields depends on. This is used for OCCURS (arrays). */
  def dependingOn: Option[String]

  /** Returns true if this field is redefined by some other field */
  def isRedefined: Boolean

  /** A binary properties of a field */
  val binaryProperties: BinaryProperties

  /** Returns a parent of the current node **/
  def up(): Option[CBTree] = this.parent

  /** Returns a string representation of the AST element */
  override def toString: String = {
    s"${" " * 2 * level}$camelCased ${camelCase(redefines.getOrElse(""))}"
  }

  /** Returns this the name of this fields as a camel cased string */
  def camelCase(s: String): String = {
    s.replace(".", "")
      .split("-")
      .map(c => c.toLowerCase.capitalize)
      .mkString
  }

  /** Returns the original AST element with updated binary properties */
  def withUpdatedBinaryProperties(newBinaryProperties: BinaryProperties): CBTree

  /** Returns the original AST element with updated `isRedefined` flag */
  def withUpdatedIsRedefined(newIsRedefined: Boolean): CBTree

}