sjsonnet.Expr.scala Maven / Gradle / Ivy
The newest version!
package sjsonnet
import java.util.Arrays
/**
* [[Expr]]s are the parsed syntax trees of a Jsonnet program. They model the program mostly
* as-written, except for resolving local variable names and assigning them indices in the scope
* bindings array.
*
* Each [[Expr]] represents an expression in the Jsonnet program, and contains an integer offset
* into the file that is later used to provide error messages.
*/
trait Expr {
def pos: Position
private[sjsonnet] val _tag: Int = ExprTags.UNTAGGED
/** The name of this expression type to be shown in error messages */
def exprErrorString: String = {
val n = getClass.getName
if (n.startsWith("sjsonnet.Expr$")) n.substring(14) else n
}
override def toString: String = s"$exprErrorString@$pos"
}
object Expr {
private final def arrStr(a: Array[?]): String = {
if (a == null) "null" else a.mkString("[", ", ", "]")
}
final case class Self(pos: Position) extends Expr {
final override private[sjsonnet] val _tag = ExprTags.Self
}
final case class Super(pos: Position) extends Expr {
final override private[sjsonnet] val _tag = ExprTags.Super
}
final case class $(pos: Position) extends Expr {
final override private[sjsonnet] val _tag = ExprTags.`$`
}
final case class Id(pos: Position, name: String) extends Expr {
final override private[sjsonnet] val _tag = ExprTags.Id
override def exprErrorString: String = s"${super.exprErrorString} $name"
}
final case class ValidId(pos: Position, name: String, nameIdx: Int) extends Expr {
final override private[sjsonnet] val _tag = ExprTags.ValidId
override def exprErrorString: String = s"${super.exprErrorString} $name"
}
final case class Arr(pos: Position, value: Array[Expr]) extends Expr {
final override private[sjsonnet] val _tag = ExprTags.Arr
override def toString: String = s"Arr($pos, ${arrStr(value)})"
}
sealed trait FieldName
object FieldName {
final case class Fixed(value: String) extends FieldName
final case class Dyn(expr: Expr) extends FieldName
}
sealed trait Member
object Member {
sealed trait Visibility
object Visibility {
case object Normal extends Visibility
case object Hidden extends Visibility
case object Unhide extends Visibility
}
final case class Field(
pos: Position,
fieldName: FieldName,
plus: Boolean, // see https://jsonnet.org/ref/language.html#nested-field-inheritance
args: Params,
sep: Visibility,
rhs: Expr)
extends Member {
def isStatic: Boolean = fieldName
.isInstanceOf[FieldName.Fixed] && !plus && args == null && sep == Visibility.Normal && rhs
.isInstanceOf[Val.Literal]
}
final case class AssertStmt(value: Expr, msg: Expr) extends Member
}
final case class Params(names: Array[String], defaultExprs: Array[Expr]) {
val paramMap = names.zipWithIndex.toMap
override def toString: String = s"Params(${arrStr(names)}, ${arrStr(defaultExprs)})"
}
final case class UnaryOp(pos: Position, op: Int, value: Expr) extends Expr {
final override private[sjsonnet] val _tag = ExprTags.UnaryOp
override def exprErrorString: String = s"${super.exprErrorString} ${UnaryOp.name(op)}"
}
object UnaryOp {
final val OP_! = 0
final val OP_- = 1
final val OP_~ = 2
final val OP_+ = 3
private val names = Map(OP_! -> "!", OP_- -> "-", OP_~ -> "~", OP_+ -> "+")
def name(op: Int): String = names.getOrElse(op, "")
}
final case class And(pos: Position, lhs: Expr, rhs: Expr) extends Expr {
final override private[sjsonnet] val _tag = ExprTags.And
}
final case class Or(pos: Position, lhs: Expr, rhs: Expr) extends Expr {
final override private[sjsonnet] val _tag = ExprTags.Or
}
final case class BinaryOp(pos: Position, lhs: Expr, op: Int, rhs: Expr) extends Expr {
final override private[sjsonnet] val _tag = ExprTags.BinaryOp
override def exprErrorString: String = s"${super.exprErrorString} ${BinaryOp.name(op)}"
}
object BinaryOp {
final val OP_* = 0
final val OP_/ = 1
final val OP_% = 2
final val OP_+ = 3
final val OP_- = 4
final val OP_<< = 5
final val OP_>> = 6
final val OP_< = 7
final val OP_> = 8
final val OP_<= = 9
final val OP_>= = 10
final val OP_in = 11
final val OP_== = 12
final val OP_!= = 13
final val OP_& = 14
final val OP_^ = 15
final val OP_| = 16
final val OP_&& = 17
final val OP_|| = 18
private val names = Map(
OP_* -> "*",
OP_/ -> "/",
OP_% -> "%",
OP_+ -> "+",
OP_- -> "-",
OP_<< -> "<<",
OP_>> -> ">>",
OP_< -> "<",
OP_> -> ">",
OP_<= -> "<=",
OP_>= -> ">=",
OP_in -> "in",
OP_== -> "==",
OP_!= -> "!=",
OP_& -> "&",
OP_^ -> "^",
OP_| -> "|",
OP_&& -> "&&",
OP_|| -> "||"
)
def name(op: Int): String = names.getOrElse(op, "")
}
final case class AssertExpr(pos: Position, asserted: Member.AssertStmt, returned: Expr)
extends Expr {
final override private[sjsonnet] val _tag = ExprTags.AssertExpr
}
final case class LocalExpr(pos: Position, bindings: Array[Bind], returned: Expr) extends Expr {
final override private[sjsonnet] val _tag = ExprTags.LocalExpr
override def toString: String = s"LocalExpr($pos, ${arrStr(bindings)}, $returned)"
override def equals(o: Any): Boolean = o match {
case o: LocalExpr =>
pos == o.pos && Arrays.equals(
bindings.asInstanceOf[Array[AnyRef]],
o.bindings.asInstanceOf[Array[AnyRef]]
) && returned == o.returned
case _ => false
}
}
final case class Bind(pos: Position, name: String, args: Params, rhs: Expr) extends Member
final case class Import(pos: Position, value: String) extends Expr {
final override private[sjsonnet] val _tag = ExprTags.Import
}
final case class ImportStr(pos: Position, value: String) extends Expr {
final override private[sjsonnet] val _tag = ExprTags.ImportStr
}
final case class ImportBin(pos: Position, value: String) extends Expr {
final override private[sjsonnet] val _tag = ExprTags.ImportBin
}
final case class Error(pos: Position, value: Expr) extends Expr {
final override private[sjsonnet] val _tag = ExprTags.Error
}
final case class Apply(
pos: Position,
value: Expr,
args: Array[Expr],
namedNames: Array[String],
tailstrict: Boolean)
extends Expr {
final override private[sjsonnet] val _tag = ExprTags.Apply
}
final case class Apply0(pos: Position, value: Expr, tailstrict: Boolean) extends Expr {
final override private[sjsonnet] val _tag = ExprTags.Apply0
}
final case class Apply1(pos: Position, value: Expr, a1: Expr, tailstrict: Boolean) extends Expr {
final override private[sjsonnet] val _tag = ExprTags.Apply1
}
final case class Apply2(pos: Position, value: Expr, a1: Expr, a2: Expr, tailstrict: Boolean)
extends Expr {
final override private[sjsonnet] val _tag = ExprTags.Apply2
}
final case class Apply3(
pos: Position,
value: Expr,
a1: Expr,
a2: Expr,
a3: Expr,
tailstrict: Boolean)
extends Expr {
final override private[sjsonnet] val _tag = ExprTags.Apply3
}
final case class ApplyBuiltin(
pos: Position,
func: Val.Builtin,
argExprs: Array[Expr],
tailstrict: Boolean)
extends Expr {
final override private[sjsonnet] val _tag = ExprTags.ApplyBuiltin
override def exprErrorString: String = s"std.${func.functionName}"
}
final case class ApplyBuiltin0(pos: Position, func: Val.Builtin0, tailstrict: Boolean)
extends Expr {
final override private[sjsonnet] val _tag = ExprTags.ApplyBuiltin0
override def exprErrorString: String = s"std.${func.functionName}"
}
final case class ApplyBuiltin1(pos: Position, func: Val.Builtin1, a1: Expr, tailstrict: Boolean)
extends Expr {
final override private[sjsonnet] val _tag = ExprTags.ApplyBuiltin1
override def exprErrorString: String = s"std.${func.functionName}"
}
final case class ApplyBuiltin2(
pos: Position,
func: Val.Builtin2,
a1: Expr,
a2: Expr,
tailstrict: Boolean)
extends Expr {
final override private[sjsonnet] val _tag = ExprTags.ApplyBuiltin2
override def exprErrorString: String = s"std.${func.functionName}"
}
final case class ApplyBuiltin3(
pos: Position,
func: Val.Builtin3,
a1: Expr,
a2: Expr,
a3: Expr,
tailstrict: Boolean)
extends Expr {
final override private[sjsonnet] val _tag = ExprTags.ApplyBuiltin3
override def exprErrorString: String = s"std.${func.functionName}"
}
final case class ApplyBuiltin4(
pos: Position,
func: Val.Builtin4,
a1: Expr,
a2: Expr,
a3: Expr,
a4: Expr,
tailstrict: Boolean)
extends Expr {
override private[sjsonnet] val _tag = ExprTags.ApplyBuiltin4
override def exprErrorString: String = s"std.${func.functionName}"
}
final case class Select(pos: Position, value: Expr, name: String) extends Expr {
final override private[sjsonnet] val _tag = ExprTags.Select
override def exprErrorString: String = s"${super.exprErrorString} $name"
}
final case class SelectSuper(pos: Position, selfIdx: Int, name: String) extends Expr {
final override private[sjsonnet] val _tag = ExprTags.SelectSuper
override def exprErrorString: String = s"${super.exprErrorString} $name"
}
final case class InSuper(pos: Position, value: Expr, selfIdx: Int) extends Expr {
final override private[sjsonnet] val _tag = ExprTags.InSuper
}
final case class Lookup(pos: Position, value: Expr, index: Expr) extends Expr {
final override private[sjsonnet] val _tag = ExprTags.Lookup
}
final case class LookupSuper(pos: Position, selfIdx: Int, index: Expr) extends Expr {
final override private[sjsonnet] val _tag = ExprTags.LookupSuper
}
final case class Slice(
pos: Position,
value: Expr,
start: Option[Expr],
end: Option[Expr],
stride: Option[Expr])
extends Expr {
final override private[sjsonnet] val _tag = ExprTags.Slice
}
final case class Function(pos: Position, params: Params, body: Expr) extends Expr {
final override private[sjsonnet] val _tag = ExprTags.Function
}
final case class IfElse(pos: Position, cond: Expr, `then`: Expr, `else`: Expr) extends Expr {
final override private[sjsonnet] val _tag = ExprTags.IfElse
}
sealed trait CompSpec extends Expr
final case class IfSpec(pos: Position, cond: Expr) extends CompSpec
final case class ForSpec(pos: Position, name: String, cond: Expr) extends CompSpec
final case class Comp(pos: Position, value: Expr, first: ForSpec, rest: Array[CompSpec])
extends Expr {
final override private[sjsonnet] val _tag = ExprTags.Comp
}
final case class ObjExtend(pos: Position, base: Expr, ext: ObjBody) extends Expr {
final override private[sjsonnet] val _tag = ExprTags.ObjExtend
}
trait ObjBody extends Expr
object ObjBody {
final case class MemberList(
pos: Position,
binds: Array[Bind],
fields: Array[Member.Field],
asserts: Array[Member.AssertStmt])
extends ObjBody {
final override private[sjsonnet] val _tag = ExprTags.`ObjBody.MemberList`
override def toString: String =
s"MemberList($pos, ${arrStr(binds)}, ${arrStr(fields)}, ${arrStr(asserts)})"
}
final case class ObjComp(
pos: Position,
preLocals: Array[Bind],
key: Expr,
value: Expr,
plus: Boolean, // see https://jsonnet.org/ref/language.html#nested-field-inheritance
postLocals: Array[Bind],
first: ForSpec,
rest: List[CompSpec])
extends ObjBody {
final override private[sjsonnet] val _tag = ExprTags.`ObjBody.ObjComp`
override def toString: String =
s"ObjComp($pos, ${arrStr(preLocals)}, $key, $value, ${arrStr(postLocals)}, $first, $rest)"
}
}
}
private[sjsonnet] object ExprTags {
// used for optimization only, used in Evaluator#visitExpr
// the order is the same as the origin order in Evaluator#visitExpr
final val UNTAGGED =
0 // A special value used to indicate that the expression is not tagged for optimization
final val ValidId = 1
final val BinaryOp = 2
final val Select = 3
final val `Val.Literal` = 4
final val `Val.Func` = 5
final val ApplyBuiltin0 = 6
final val ApplyBuiltin1 = 7
final val ApplyBuiltin2 = 8
final val ApplyBuiltin3 = 9
final val ApplyBuiltin4 = 10
final val And = 11
final val Or = 12
final val UnaryOp = 13
final val Apply1 = 14
final val Lookup = 15
final val Function = 16
final val LocalExpr = 17
final val Apply = 18
final val IfElse = 19
final val Apply3 = 20
final val `ObjBody.MemberList` = 21
final val Apply2 = 22
final val AssertExpr = 23
final val ApplyBuiltin = 24
final val Comp = 25
final val Arr = 26
final val SelectSuper = 27
final val LookupSuper = 28
final val InSuper = 29
final val ObjExtend = 30
final val `ObjBody.ObjComp` = 31
final val Slice = 32
final val Import = 33
final val Apply0 = 34
final val ImportStr = 35
final val ImportBin = 36
final val Error = 37
// used in Evaluator#visitInvalid
final val Id = 0
final val Self = 1
final val `$` = 2
final val Super = 3
// other
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy