Add support for constants

Author: waleedyaseen

CHANGELOG.md

@@ -5,6 +5,7 @@
 - Support for basic spell checking and custom dictionary.
 - Support for specific parameter types in triggers.
 - Support for game variable type checking/refactoring/find usages.
+- Support for constant type checking/refactoring/find usages.
 
 ## [1.1.0] - 2023-08-11
 

src/main/gen/io/runescript/plugin/lang/psi/RsConstantExpression.java

@@ -5,7 +5,7 @@
 import org.jetbrains.annotations.*;
 import com.intellij.psi.PsiElement;
 
-public interface RsConstantExpression extends RsExpression {
+public interface RsConstantExpression extends RsExpression, RsNamedElement {
 
   @NotNull
   RsNameLiteral getNameLiteral();

src/main/gen/io/runescript/plugin/lang/psi/RsVisitor.java

@@ -67,6 +67,7 @@ public void visitConditionOp(@NotNull RsConditionOp o) {
 
   public void visitConstantExpression(@NotNull RsConstantExpression o) {
     visitExpression(o);
+    // visitNamedElement(o);
   }
 
   public void visitCoordLiteralExpression(@NotNull RsCoordLiteralExpression o) {

src/main/gen/io/runescript/plugin/lang/psi/impl/RsConstantExpressionImpl.java

@@ -8,15 +8,15 @@
 import com.intellij.psi.PsiElementVisitor;
 import com.intellij.psi.util.PsiTreeUtil;
 import static io.runescript.plugin.lang.psi.RsElementTypes.*;
+import io.runescript.plugin.lang.psi.mixin.RsConstantExpressionMixin;
 import io.runescript.plugin.lang.psi.*;
 
-public class RsConstantExpressionImpl extends RsExpressionImpl implements RsConstantExpression {
+public class RsConstantExpressionImpl extends RsConstantExpressionMixin implements RsConstantExpression {
 
   public RsConstantExpressionImpl(@NotNull ASTNode node) {
     super(node);
   }
 
-  @Override
   public void accept(@NotNull RsVisitor visitor) {
     visitor.visitConstantExpression(this);
   }

src/main/grammars/RuneScript.bnf

@@ -238,7 +238,10 @@ GosubExpression ::= '~' NameLiteral ArgumentList? {
     implements="io.runescript.plugin.lang.psi.RsNamedElement"
 }
 ArgumentList ::= '(' ExpressionList? ')'
-ConstantExpression ::= '^' NameLiteral
+ConstantExpression ::= '^' NameLiteral {
+    mixin="io.runescript.plugin.lang.psi.mixin.RsConstantExpressionMixin"
+    implements="io.runescript.plugin.lang.psi.RsNamedElement"
+}
 DynamicExpression ::= NameLiteral {
     mixin="io.runescript.plugin.lang.psi.mixin.RsDynamicExpressionMixin"
     implements="io.runescript.plugin.lang.psi.RsNamedElement"

src/main/kotlin/io/runescript/plugin/ide/inspections/RuneScriptUnresolvedConstantInspection.kt

@@ -0,0 +1,27 @@
+package io.runescript.plugin.ide.inspections
+
+import com.intellij.codeInspection.LocalInspectionTool
+import com.intellij.codeInspection.ProblemHighlightType
+import com.intellij.codeInspection.ProblemsHolder
+import com.intellij.psi.PsiElementVisitor
+import io.runescript.plugin.ide.RsBundle
+import io.runescript.plugin.lang.psi.RsConstantExpression
+import io.runescript.plugin.lang.psi.RsScopedVariableExpression
+import io.runescript.plugin.lang.psi.RsVisitor
+
+class RuneScriptUnresolvedConstantInspection : LocalInspectionTool() {
+
+    override fun buildVisitor(holder: ProblemsHolder, isOnTheFly: Boolean): PsiElementVisitor {
+        return object : RsVisitor() {
+            override fun visitConstantExpression(o: RsConstantExpression) {
+                val reference = o.reference ?: return
+                if (reference.resolve() == null) {
+                    holder.registerProblem(o,
+                        RsBundle.message("inspection.error.unresolved.constant", o.nameLiteral.text),
+                        ProblemHighlightType.LIKE_UNKNOWN_SYMBOL
+                    )
+                }
+            }
+        }
+    }
+}

src/main/kotlin/io/runescript/plugin/lang/psi/mixin/RsConstantExpressionMixin.kt

@@ -0,0 +1,33 @@
+package io.runescript.plugin.lang.psi.mixin
+
+import com.intellij.extapi.psi.ASTWrapperPsiElement
+import com.intellij.lang.ASTNode
+import com.intellij.psi.PsiElement
+import com.intellij.psi.PsiReference
+import com.intellij.refactoring.suggested.startOffset
+import io.runescript.plugin.lang.psi.RsConstantExpression
+import io.runescript.plugin.lang.psi.RsPsiImplUtil
+import io.runescript.plugin.lang.psi.refs.RsConstantReference
+
+abstract class RsConstantExpressionMixin(node: ASTNode) : ASTWrapperPsiElement(node), RsConstantExpression {
+
+    override fun getReference(): PsiReference? {
+        return RsConstantReference(this)
+    }
+
+    override fun getName(): String? {
+        return RsPsiImplUtil.getName(nameLiteral)
+    }
+
+    override fun setName(name: String): PsiElement {
+        return RsPsiImplUtil.setName(nameLiteral, name)
+    }
+
+    override fun getTextOffset(): Int {
+        return nameLiteral.startOffset
+    }
+
+    override fun getNameIdentifier(): PsiElement? {
+        return nameLiteral
+    }
+}

src/main/kotlin/io/runescript/plugin/lang/psi/refs/RsConstantReference.kt

@@ -0,0 +1,26 @@
+package io.runescript.plugin.lang.psi.refs
+
+import com.intellij.psi.*
+import io.runescript.plugin.lang.psi.RsConstantExpression
+import io.runescript.plugin.lang.psi.type.RsPrimitiveType
+import io.runescript.plugin.symbollang.psi.index.RsSymbolIndex
+
+class RsConstantReference(element: RsConstantExpression) :
+        PsiReferenceBase<RsConstantExpression>(element, element.nameLiteral.textRangeInParent), PsiPolyVariantReference {
+
+    override fun resolve(): PsiElement? {
+        val result = multiResolve(false)
+        return result.singleOrNull()?.element
+    }
+
+    override fun multiResolve(incompleteCode: Boolean): Array<ResolveResult> {
+        val symbol = RsSymbolIndex.lookup(element.project, RsPrimitiveType.CONSTANT, element.name!!)
+            ?: return emptyArray()
+        return arrayOf(PsiElementResolveResult(symbol))
+    }
+
+    override fun handleElementRename(newElementName: String): PsiElement {
+        element.setName(newElementName)
+        return element
+    }
+}

src/main/kotlin/io/runescript/plugin/lang/psi/type/RsPrimitiveType.kt

@@ -54,7 +54,8 @@ enum class RsPrimitiveType(val literal: String, val referencable: Boolean = true
     HOOK("hook", referencable = false),
     VARPHOOK("varphook", referencable = false),
     STATHOOK("stathook", referencable = false),
-    INVHOOK("invhook", referencable = false);
+    INVHOOK("invhook", referencable = false),
+    CONSTANT("constant", referencable = false);
 
     override val representation: String
         get() = literal

src/main/kotlin/io/runescript/plugin/lang/psi/type/inference/RsTypeInferenceVisitor.kt

@@ -485,8 +485,41 @@ class RsTypeInferenceVisitor(private val myInferenceData: RsTypeInference) : RsV
     }
 
     override fun visitConstantExpression(o: RsConstantExpression) {
-        // TODO(Walied): Implement when constants have references
+        val reference = o.reference?.resolve() as? RsSymSymbol
+        val type = o.typeHint
+        if (reference == null || type !is RsPrimitiveType || !type.referencable) {
+            o.type = RsErrorType
+            return
+        }
         o.type = o.typeHint
+        val value = reference.fieldList[1].text
+        when (type) {
+            RsPrimitiveType.STRING -> {
+                // Do nothing
+            }
+
+            RsPrimitiveType.INT -> {
+                val radix: Int
+                val trimmedValue: String
+                if (value.startsWith("0x")) {
+                    radix = 16
+                    trimmedValue = value.substring(2)
+                } else {
+                    radix = 10
+                    trimmedValue = value
+                }
+                if (trimmedValue.toIntOrNull(radix) == null) {
+                    o.error("Could not convert constant value '${value}' to an integer number.")
+                }
+            }
+
+            else -> {
+                val configReference = RsSymbolIndex.lookup(o.project, type, value)
+                if (configReference == null) {
+                    o.error("Could not resolve constant value '${value} to a reference.'")
+                }
+            }
+        }
     }
 
     override fun visitNullLiteralExpression(o: RsNullLiteralExpression) {