com.nawforce.apexlink.cst.Variables.scala Maven / Gradle / Ivy

Go to download
/*
 Copyright (c) 2019 Kevin Jones, All rights reserved.
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:
 1. Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
 2. Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in the
    documentation and/or other materials provided with the distribution.
 3. The name of the author may not be used to endorse or promote products
    derived from this software without specific prior written permission.
 */

package com.nawforce.apexlink.cst

import com.nawforce.apexlink.cst.AssignableSupport.isAssignableDeclaration
import com.nawforce.pkgforce.diagnostics.{Diagnostic, ERROR_CATEGORY, Issue, WARNING_CATEGORY}
import com.nawforce.pkgforce.modifiers.{ApexModifiers, FINAL_MODIFIER, ModifierResults}
import com.nawforce.pkgforce.names.TypeName
import com.nawforce.runtime.parsers.CodeParser
import io.github.apexdevtools.apexparser.ApexParser._

import scala.collection.compat.immutable.ArraySeq

final case class VariableDeclarator(
  typeName: TypeName,
  isReadOnly: Boolean,
  id: Id,
  init: Option[Expression]
) extends CST {
  def verify(input: ExprContext, context: BlockVerifyContext): Unit = {
    id.validate(context)

    val lhsType = context.getTypeAndAddDependency(typeName, context.thisType).toOption

    val exprContext = new ExpressionVerifyContext(context)
    init.foreach(rhs => {
      val rhsCtx = rhs.verify(input, exprContext)

      lhsType.foreach(lhsType => {
        if (rhsCtx.isDefined) {
          if (rhsCtx.isStatic.contains(true)) {
            context.logError(
              location,
              s"Expecting instance for operation, not type '${rhsCtx.typeName}'"
            )
          } else if (!isAssignableDeclaration(lhsType.typeName, rhsCtx.typeDeclaration, context)) {
            context.log(
              Issue(
                ERROR_CATEGORY,
                location,
                s"Incompatible types in assignment, from '${rhsCtx.typeName}' to '${lhsType.typeName}'"
              )
            )
          }
        }
      })
    })

    // Needed for non-for loop vars where addVars is not called
    addVars(context)
  }

  def addVars(context: BlockVerifyContext): Unit = {
    context.addVar(id.name, this, isReadOnly, typeName)
  }

}

object VariableDeclarator {
  def construct(
    typeName: TypeName,
    isReadOnly: Boolean,
    variableDeclarator: VariableDeclaratorContext
  ): VariableDeclarator = {
    val init = CodeParser.toScala(variableDeclarator.expression()).map(Expression.construct)
    VariableDeclarator(typeName, isReadOnly, Id.construct(variableDeclarator.id()), init)
      .withContext(variableDeclarator)
  }
}

final case class VariableDeclarators(declarators: Seq[VariableDeclarator]) extends CST {
  def verify(input: ExprContext, context: BlockVerifyContext): Unit = {
    declarators.foreach(_.verify(input, context))
  }

  def addVars(context: BlockVerifyContext): Unit = {
    declarators.foreach(_.addVars(context))
  }
}

object VariableDeclarators {
  def construct(
    typeName: TypeName,
    isReadOnly: Boolean,
    variableDeclaratorsContext: VariableDeclaratorsContext
  ): VariableDeclarators = {
    val variableDeclarators: Seq[VariableDeclaratorContext] = {
      Option(variableDeclaratorsContext)
        .map(variableDeclaratorsContext => {
          CodeParser.toScala(variableDeclaratorsContext.variableDeclarator())
        })
        .getOrElse(Seq())
    }
    VariableDeclarators(
      variableDeclarators.map(x => VariableDeclarator.construct(typeName, isReadOnly, x))
    )
      .withContext(variableDeclaratorsContext)
  }
}

final case class LocalVariableDeclaration(
  modifiers: ModifierResults,
  typeName: TypeName,
  variableDeclarators: VariableDeclarators
) extends CST {
  def verify(context: BlockVerifyContext): Unit = {

    variableDeclarators.declarators.foreach(vd => {
      context.thisType.findField(vd.id.name, None).foreach {
        case field: ApexFieldDeclaration if field.isStatic == context.isStatic =>
          context.log(
            new Issue(
              location.path,
              new Diagnostic(
                WARNING_CATEGORY,
                location.location,
                s"Local variable is hiding class field '${vd.id.name}', see " +
                  s"${field.location.toString}"
              )
            )
          )
        case _ => ()
      }
    })

    modifiers.issues.foreach(context.log)
    val staticContext = if (context.isStatic) Some(true) else None
    variableDeclarators.verify(ExprContext(isStatic = staticContext, context.thisType), context)
  }

  def addVars(context: BlockVerifyContext): Unit = {
    variableDeclarators.addVars(context)
  }
}

object LocalVariableDeclaration {
  def construct(
    parser: CodeParser,
    from: LocalVariableDeclarationContext
  ): LocalVariableDeclaration = {
    val typeName = TypeReference.construct(from.typeRef())
    val modifiers = ApexModifiers.localVariableModifiers(
      parser,
      CodeParser.toScala(from.modifier()),
      from,
      isTrigger = false
    )
    LocalVariableDeclaration(
      modifiers,
      typeName,
      VariableDeclarators.construct(
        typeName,
        modifiers.modifiers.contains(FINAL_MODIFIER),
        from.variableDeclarators()
      )
    ).withContext(from)
  }

  def constructTriggerVar(
    parser: CodeParser,
    varModifiers: ArraySeq[ModifierContext],
    from: FieldDeclarationContext
  ): LocalVariableDeclaration = {
    val typeName = TypeReference.construct(from.typeRef())
    val modifiers =
      ApexModifiers.localVariableModifiers(parser, varModifiers, from, isTrigger = true)
    LocalVariableDeclaration(
      modifiers,
      typeName,
      VariableDeclarators.construct(
        typeName,
        modifiers.modifiers.contains(FINAL_MODIFIER),
        from.variableDeclarators()
      )
    ).withContext(from)
  }
}