Merge pull request #30 from emerge-lang/debuginfo

Optionally emit debug info

Author: tmarsteel

backend-api/src/main/kotlin/io/github/tmarsteel/emerge/backend/api/ir/basetype.kt

@@ -44,6 +44,8 @@ interface IrClass : IrBaseType {
 
     val destructor: IrFunction
 
+    val declaredAt: IrSourceLocation
+
     interface MemberVariable {
         val name: String
 
@@ -59,6 +61,8 @@ interface IrClass : IrBaseType {
          */
         val writeStrategy: AccessStrategy
 
+        val declaredAt: IrSourceLocation
+
         sealed interface AccessStrategy {
             /**
              * The member variable is supposed to be read/written by directly accessing the [Field] with [Field.id] == [BareField.fieldId].

backend-api/src/main/kotlin/io/github/tmarsteel/emerge/backend/api/ir/executable.kt

@@ -29,7 +29,7 @@ interface IrCreateTemporaryValue : IrExecutable {
  *   that the mutation of the reference counter cannot be observed by the input program.
  */
 interface IrCreateStrongReferenceStatement : IrExecutable {
-    /** the temporary holding the reference to the object whichs reference count needs to increased */
+    /** the temporary holding the reference to the object whose reference count needs to be increased */
     val reference: IrCreateTemporaryValue
 }
 
@@ -67,6 +67,38 @@ interface IrVariableDeclaration : IrExecutable {
      * [isSSA] implies [isReAssignable] `== false`.
      */
     val isSSA: Boolean
+
+    val declaredAt: IrSourceLocation
+
+    /**
+     * The [Scope] in which this variable is valid.
+     */
+    val scope: Scope
+
+    interface Scope {
+        interface Lexical : Scope {
+            val beginMarker: BeginMarker
+            val endMarker: EndMarker
+
+            /**
+             * No-op executable that just marks the start of a [Scope].
+             */
+            interface BeginMarker : IrExecutable {
+                val scope: Scope
+            }
+
+            /**
+             * No-op executable that just marks the end of a [Scope].
+             */
+            interface EndMarker : IrExecutable {
+                val scope: Scope
+            }
+        }
+
+        interface File : Scope {
+            val file: IrSourceFile
+        }
+    }
 }
 
 interface IrAssignmentStatement : IrExecutable {

backend-api/src/main/kotlin/io/github/tmarsteel/emerge/backend/noop/NoopBackend.kt

@@ -19,7 +19,7 @@ class NoopBackend : EmergeBackend<NoopBackend.Config, Unit> {
         projectConfig: Unit
     ): Iterable<ConfigModuleDefinition> {
         return listOf(ConfigModuleDefinition(
-            EmergeConstants.PLATFORM_MODULE_NAME,
+            EmergeConstants.PlatformModule.NAME,
             toolchainConfig.platformSources,
         ))
     }

bazel/rules_emerge/binary.bzl

@@ -5,7 +5,8 @@ def _build_project_config_json(
         path_from_project_config_toolchain_cwd,
         target_triple,
         output_directory,
-        all_modules):
+        all_modules,
+        emit_debug_info):
     return {
         "modules": [{
             "name": module.name,
@@ -15,6 +16,7 @@ def _build_project_config_json(
         "targets": {
             target_triple: {
                 "output-directory": path_from_project_config_toolchain_cwd + output_directory,
+                "emit-debug-info": emit_debug_info,
             },
         },
     }
@@ -65,6 +67,7 @@ emerge_binary = rule(
     implementation = _emerge_binary_impl,
     attrs = {
         "root_module": attr.label(mandatory = True, allow_files = False, allow_rules = ["emerge_module_internal"]),
+        "emit_debug_info": attr.bool(default = True, doc = "If true, the executable will contain debugging symbols (variable names and types). Line numbers and function names are always included."),
         "_triple": attr.label(
             default = "//target:selected_target_triple",
         ),

common/src/main/kotlin/io/github/tmarsteel/emerge/common/EmergeConstants.kt

@@ -7,14 +7,42 @@ import io.github.tmarsteel.emerge.common.EmergeConstants.IterableContract.RANGE_
  * Necessary, "magic" constants that are chosen arbitrarily
  */
 data object EmergeConstants {
-    val CORE_MODULE_NAME = CanonicalElementName.Package(listOf("emerge", "core"))
-    val STD_MODULE_NAME = CanonicalElementName.Package(listOf("emerge", "std"))
-    val PLATFORM_MODULE_NAME = CanonicalElementName.Package(listOf("emerge", "platform"))
+    data object CoreModule {
+        val NAME = CanonicalElementName.Package(listOf("emerge", "core"))
+        val ANY_TYPE_NAME = CanonicalElementName.BaseType(NAME, "Any")
+        val UNIT_TYPE_NAME = CanonicalElementName.BaseType(NAME, "Unit")
+        val THROWABLE_TYPE_NAME = CanonicalElementName.BaseType(NAME, "Throwable")
+        val ERROR_TYPE_NAME = CanonicalElementName.BaseType(NAME, "Error")
+        val CAST_ERROR_TYPE_NAME = CanonicalElementName.BaseType(NAME, "CastError")
+        val ARITHMETIC_ERROR_TYPE_NAME = CanonicalElementName.BaseType(NAME, "ArithmeticError")
 
-    val UNIT_TYPE_NAME = CanonicalElementName.BaseType(CORE_MODULE_NAME, "Unit")
-    val THROWABLE_TYPE_NAME = CanonicalElementName.BaseType(CORE_MODULE_NAME, "Throwable")
-    val ERROR_TYPE_NAME = CanonicalElementName.BaseType(CORE_MODULE_NAME, "Error")
-    val CAST_ERROR_TYPE_NAME = CanonicalElementName.BaseType(CORE_MODULE_NAME, "CastError")
+        val BOOL_TYPE_NAME = CanonicalElementName.BaseType(NAME, "Bool")
+        val S8_TYPE_NAME = CanonicalElementName.BaseType(NAME, "S8")
+        val U8_TYPE_NAME = CanonicalElementName.BaseType(NAME, "U8")
+        val S16_TYPE_NAME = CanonicalElementName.BaseType(NAME, "S16")
+        val U16_TYPE_NAME = CanonicalElementName.BaseType(NAME, "U16")
+        val S32_TYPE_NAME = CanonicalElementName.BaseType(NAME, "S32")
+        val U32_TYPE_NAME = CanonicalElementName.BaseType(NAME, "U32")
+        val S64_TYPE_NAME = CanonicalElementName.BaseType(NAME, "S64")
+        val U64_TYPE_NAME = CanonicalElementName.BaseType(NAME, "U64")
+        val F32_TYPE_NAME = CanonicalElementName.BaseType(NAME, "F32")
+        val F64_TYPE_NAME = CanonicalElementName.BaseType(NAME, "F64")
+        val SWORD_TYPE_NAME = CanonicalElementName.BaseType(NAME, "SWord")
+        val UWORD_TYPE_NAME = CanonicalElementName.BaseType(NAME, "UWord")
+    }
+
+    data object ReflectionModule {
+        val NAME = CoreModule.NAME + "reflection"
+        val REFLECTION_BASE_TYPE_TYPE_NAME = CanonicalElementName.BaseType(NAME, "ReflectionBaseType")
+    }
+
+    data object StdModule {
+        val NAME = CanonicalElementName.Package(listOf("emerge", "std"))
+    }
+
+    data object PlatformModule {
+        val NAME = CanonicalElementName.Package(listOf("emerge", "platform"))
+    }
 
     /**
      * the identifier to use in the initialization expression for member variables to indicate that the
@@ -51,7 +79,7 @@ data object EmergeConstants {
          * range is empty.
          */
         val EMPTY_RANGE_EXCEPTION_NAME = CanonicalElementName.BaseType(
-            CORE_MODULE_NAME.plus("range"),
+            CoreModule.NAME.plus("range"),
             "EmptyRangeException",
         )
 
@@ -60,7 +88,7 @@ data object EmergeConstants {
          * one type parameter: `T : Any?` which denotes the type of the elements that can be iterated over.
          */
         val ITERABLE_TYPE_NAME = CanonicalElementName.BaseType(
-            CORE_MODULE_NAME.plus("range"),
+            CoreModule.NAME.plus("range"),
             "Iterable",
         )
     }

common/src/main/kotlin/io/github/tmarsteel/emerge/common/config/ConfigModuleDefinition.kt

@@ -18,8 +18,8 @@ data class ConfigModuleDefinition(
     val uses: Set<CanonicalElementName.Package> = emptySet()
 ) {
     val implicitlyUses: Set<CanonicalElementName.Package> = when (this.name) {
-        EmergeConstants.CORE_MODULE_NAME -> emptySet()
-        EmergeConstants.STD_MODULE_NAME -> setOf(EmergeConstants.CORE_MODULE_NAME)
-        else -> setOf(EmergeConstants.CORE_MODULE_NAME, EmergeConstants.STD_MODULE_NAME)
+        EmergeConstants.CoreModule.NAME -> emptySet()
+        EmergeConstants.StdModule.NAME -> setOf(EmergeConstants.CoreModule.NAME)
+        else -> setOf(EmergeConstants.CoreModule.NAME, EmergeConstants.StdModule.NAME)
     }
 }

frontend/src/main/kotlin/compiler/ast/ASTSourceFile.kt

@@ -37,8 +37,8 @@ import io.github.tmarsteel.emerge.common.CanonicalElementName
 import io.github.tmarsteel.emerge.common.EmergeConstants
 
 val DEFAULT_IMPORT_PACKAGES = listOf(
-    EmergeConstants.CORE_MODULE_NAME,
-    EmergeConstants.STD_MODULE_NAME,
+    EmergeConstants.CoreModule.NAME,
+    EmergeConstants.StdModule.NAME,
 )
 
 /**

frontend/src/main/kotlin/compiler/ast/expression/AstCatchBlockExpression.kt

@@ -27,7 +27,7 @@ class AstCatchBlockExpression(
             ownership = null,
             name = throwableVariableNameToken,
             type = AstAbsoluteTypeReference(
-                EmergeConstants.THROWABLE_TYPE_NAME,
+                EmergeConstants.CoreModule.THROWABLE_TYPE_NAME,
                 mutability = TypeMutability.MUTABLE,
                 span = throwableVariableNameToken.span,
             ),

frontend/src/main/kotlin/compiler/binding/BoundVariable.kt

@@ -54,6 +54,7 @@ import compiler.diagnostic.visibilityNotAllowedOnVariable
 import compiler.handleCyclicInvocation
 import compiler.lexer.Span
 import io.github.tmarsteel.emerge.backend.api.ir.IrExecutable
+import io.github.tmarsteel.emerge.backend.api.ir.IrSourceLocation
 import io.github.tmarsteel.emerge.backend.api.ir.IrType
 import io.github.tmarsteel.emerge.backend.api.ir.IrVariableDeclaration
 
@@ -269,12 +270,16 @@ class BoundVariable(
                 isExternallyInitialized
             }
         }
+        val scope = context.parentScopeContext
+            ?: throw InternalCompilerError("No parent scope context for variable $name at ${declaration.span.fileLineColumnText}")
         IrVariableDeclarationImpl(
             name,
             typeAtDeclarationTime!!.toBackendIr(),
             isBorrowed = ownershipAtDeclarationTime == VariableOwnership.BORROWED,
             isReAssignable = isReAssignable,
             isSSA = isSSA,
+            declaredAt = declaration.declaredAt,
+            scope = scope.irScope,
         )
     }
 
@@ -618,4 +623,6 @@ private class IrVariableDeclarationImpl(
     override val isBorrowed: Boolean,
     override val isReAssignable: Boolean,
     override val isSSA: Boolean,
+    override val declaredAt: IrSourceLocation,
+    override val scope: IrVariableDeclaration.Scope
 ) : IrVariableDeclaration

frontend/src/main/kotlin/compiler/binding/BoundVisibility.kt

@@ -212,7 +212,7 @@ private fun validateCrossModuleAccess(contextOfAccessedElement: CTContext, acces
     }
 
     // always allow accessing emerge.platform
-    if (EmergeConstants.PLATFORM_MODULE_NAME.containsOrEquals(moduleOfAccessedElement.moduleName)) {
+    if (EmergeConstants.PlatformModule.NAME.containsOrEquals(moduleOfAccessedElement.moduleName)) {
         return
     }