Allow to pass Scala Native c interop file as an Input

This should provide simpler interop functionality, removing to rely on
passing c files through resource directories.
A new resource caching mechanizm was also added, to smoothen the
development experience. Before, it would be easy for SN linking errors
to appear - any rename or move of an interop file would cause it to be
duplicated. The mappingremoves those issues, as long as users will not
tamper with the newly added file (.project_native_resources) to output
directory. This can be extended for use with regular JVM resources, to
solve a similar issue.

Author: jchyb

modules/build/src/main/scala/scala/build/Inputs.scala

@@ -201,6 +201,10 @@ object Inputs {
       extends OnDisk with SourceFile with Compiled {
     lazy val path: os.Path = base / subPath
   }
+  final case class CFile(base: os.Path, subPath: os.SubPath)
+      extends OnDisk with SourceFile with Compiled {
+    lazy val path = base / subPath
+  }
   final case class MarkdownFile(base: os.Path, subPath: os.SubPath)
       extends OnDisk with SourceFile {
     lazy val path: os.Path = base / subPath
@@ -240,6 +244,8 @@ object Inputs {
           Inputs.SourceScalaFile(d.path, p.subRelativeTo(d.path))
         case p if p.last.endsWith(".sc") =>
           Inputs.Script(d.path, p.subRelativeTo(d.path))
+        case p if p.last.endsWith(".c") || p.last.endsWith(".h") =>
+          Inputs.CFile(d.path, p.subRelativeTo(d.path))
         case p if p.last.endsWith(".md") && enableMarkdown =>
           Inputs.MarkdownFile(d.path, p.subRelativeTo(d.path))
       }
@@ -269,6 +275,7 @@ object Inputs {
           case _: Inputs.JavaFile          => "java:"
           case _: Inputs.SettingsScalaFile => "config:"
           case _: Inputs.SourceScalaFile   => "scala:"
+          case _: Inputs.CFile             => "c:"
           case _: Inputs.Script            => "sc:"
           case _: Inputs.MarkdownFile      => "md:"
         }
@@ -455,6 +462,7 @@ object Inputs {
       else if (arg.endsWith(".sc")) Right(Seq(Script(dir, subPath)))
       else if (arg.endsWith(".scala")) Right(Seq(SourceScalaFile(dir, subPath)))
       else if (arg.endsWith(".java")) Right(Seq(JavaFile(dir, subPath)))
+      else if (arg.endsWith(".c") || arg.endsWith(".h")) Right(Seq(CFile(dir, subPath)))
       else if (arg.endsWith(".md")) Right(Seq(MarkdownFile(dir, subPath)))
       else if (os.isDir(path)) Right(Seq(Directory(path)))
       else if (acceptFds && arg.startsWith("/dev/fd/")) {

modules/build/src/main/scala/scala/build/internal/resource/NativeResourceMapper.scala

@@ -0,0 +1,36 @@
+package scala.build.internal.resource
+
+import scala.build.{Build, Inputs}
+
+object NativeResourceMapper {
+
+  private def scalaNativeCFileMapping(build: Build.Successful): Map[os.Path, os.RelPath] =
+    build
+      .inputs
+      .flattened()
+      .collect {
+        case cfile: Inputs.CFile =>
+          val inputPath = cfile.path
+          val destPath  = os.rel / "scala-native" / cfile.subPath
+          (inputPath, destPath)
+      }
+      .toMap
+
+  private def resolveProjectCFileRegistryPath(nativeWorkDir: os.Path) =
+    nativeWorkDir / ".native_registry"
+
+  /** Copies and maps c file resources from their original path to the destination path in build
+    * output, also caching output paths in a file.
+    *
+    * Remembering the mapping this way allows for the resource to be removed if the original file is
+    * renamed/deleted.
+    */
+  def copyCFilesToScalaNativeDir(build: Build.Successful, nativeWorkDir: os.Path): Unit = {
+    val mappingFilePath = resolveProjectCFileRegistryPath(nativeWorkDir)
+    ResourceMapper.copyResourcesToDirWithMapping(
+      build.output,
+      mappingFilePath,
+      scalaNativeCFileMapping(build)
+    )
+  }
+}

modules/cli/src/main/scala/scala/cli/commands/Package.scala

@@ -22,6 +22,7 @@ import scala.build.errors.*
 import scala.build.interactive.InteractiveFileOps
 import scala.build.internal.Util.*
 import scala.build.internal.{Runner, ScalaJsLinkerConfig}
+import scala.build.internal.resource.NativeResourceMapper
 import scala.build.options.{PackageType, Platform}
 import scala.cli.CurrentParams
 import scala.cli.commands.OptionsHelper.*
@@ -941,7 +942,8 @@ object Package extends ScalaCommand[PackageOptions] with BuildCommandHelpers {
         nativeWorkDir
       )
 
-    if (cacheData.changed)
+    if (cacheData.changed) {
+      NativeResourceMapper.copyCFilesToScalaNativeDir(build, nativeWorkDir)
       Library.withLibraryJar(build, dest.last.stripSuffix(".jar")) { mainJar =>
 
         val classpath = mainJar.toString +: build.artifacts.classPath.map(_.toString)
@@ -977,5 +979,6 @@ object Package extends ScalaCommand[PackageOptions] with BuildCommandHelpers {
         else
           throw new ScalaNativeBuildError
       }
+    }
   }
 }

modules/integration/src/test/scala/scala/cli/integration/RunTestDefinitions.scala

@@ -292,6 +292,59 @@ abstract class RunTestDefinitions(val scalaVersionOpt: Option[String])
     }
   }
 
+  test("Scala Native C Files are correctly handled as a regular Input") {
+    val projectDir      = "native-interop"
+    val interopFileName = "bindings.c"
+    val interopMsg      = "Hello C!"
+    val inputs = TestInputs(
+      os.rel / projectDir / "main.scala" ->
+        s"""|//> using platform "scala-native"
+            |
+            |import scala.scalanative.unsafe._
+            |
+            |@extern
+            |object Bindings {
+            |  @name("scalanative_print")
+            |  def print(): Unit = extern
+            |}
+            |
+            |object Main {
+            |  def main(args: Array[String]): Unit = {
+            |    Bindings.print()
+            |  }
+            |}
+            |""".stripMargin,
+      os.rel / projectDir / interopFileName ->
+        s"""|#include <stdio.h>
+            |
+            |void scalanative_print() {
+            |    printf("$interopMsg\\n");
+            |}
+            |""".stripMargin
+    )
+    inputs.fromRoot { root =>
+      val output =
+        os.proc(TestUtil.cli, extraOptions, projectDir, "-q")
+          .call(cwd = root)
+          .out.trim()
+      expect(output == interopMsg)
+
+      os.move(root / projectDir / interopFileName, root / projectDir / "bindings2.c")
+      val output2 =
+        os.proc(TestUtil.cli, extraOptions, projectDir, "-q")
+          .call(cwd = root)
+          .out.trim()
+
+      // LLVM throws linking errors if scalanative_print is internally repeated.
+      // This can happen if a file containing it will be removed/renamed in src,
+      // but somehow those changes will not be reflected in the output directory,
+      // causing symbols inside linked files to be doubled.
+      // Because of that, the removed file should not be passed to linker,
+      // otherwise this test will fail.
+      expect(output2 == interopMsg)
+    }
+  }
+
   if (actualScalaVersion.startsWith("3.1"))
     test("Scala 3 in Scala Native") {
       val message  = "using Scala 3 Native"