Infix file pattern

api/src/main/kotlin/io/spine/protodata/ast/FilePatternFactory.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2024, TeamDev. All rights reserved.
+ * Copyright 2025, TeamDev. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -41,11 +41,21 @@ public object FilePatternFactory {
         suffix = value
     }
 
+    /**
+     * Creates a new [FilePattern] with the [infix][FilePattern.getInfix] field filled.
+     */
+    public fun infix(value: String): FilePattern = filePattern {
+        value.checkNotBlank("infix")
+        infix = value
+    }
+
     /**
      * Creates a new [FilePattern] with the [prefix][FilePattern.getPrefix] field filled.
      */
+    @Deprecated(message = "Please use `infix` instead.", ReplaceWith("infix(value)"))
     public fun prefix(value: String): FilePattern = filePattern {
         value.checkNotBlank("prefix")
+        @Suppress("DEPRECATION") // Supporting for backward compatibility.
         prefix = value
     }
 
@@ -59,7 +69,7 @@ public object FilePatternFactory {
 
     private fun String.checkNotBlank(name: String) {
         require(isNotBlank()) {
-            "File pattern $name cannot be empty or blank: `$this`."
+            "The file pattern `$name` cannot be empty or blank. Encountered: `$this`."
         }
     }
 }

api/src/main/kotlin/io/spine/protodata/ast/FilePatterns.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2024, TeamDev. All rights reserved.
+ * Copyright 2025, TeamDev. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -29,17 +29,19 @@
 package io.spine.protodata.ast
 
 import io.spine.protodata.ast.FilePattern.KindCase.KIND_NOT_SET
-import io.spine.protodata.ast.FilePattern.KindCase.PREFIX
 import io.spine.protodata.ast.FilePattern.KindCase.REGEX
+import io.spine.protodata.ast.FilePattern.KindCase.INFIX
 import io.spine.protodata.ast.FilePattern.KindCase.SUFFIX
 
 /**
  * Tells if this patterns matches the given [file].
  */
 public fun FilePattern.matches(file: File): Boolean {
     val path = file.path
+    @Suppress("DEPRECATION") // Support the `PREFIX` kind for backward compatibility.
     return when (kindCase) {
-        PREFIX -> path.startsWith(prefix)
+        io.spine.protodata.ast.FilePattern.KindCase.PREFIX -> path.startsWith(prefix)
+        INFIX -> path.contains(infix)
         SUFFIX -> path.endsWith(suffix)
         REGEX -> path.matches(Regex(regex))
         KIND_NOT_SET -> false

api/src/main/kotlin/io/spine/protodata/ast/FilesAndPaths.kt

@@ -24,6 +24,8 @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
+@file:Suppress("TooManyFunctions") // ... we need for relative and absolute paths.
+
 package io.spine.protodata.ast
 
 import io.spine.protodata.util.Format
@@ -33,14 +35,20 @@ import kotlin.io.path.Path
 import kotlin.io.path.absolutePathString
 import kotlin.io.path.name
 import kotlin.io.path.nameWithoutExtension
+import kotlin.io.path.pathString
 
 /**
  * Converts the given path to a [File] message containing an absolute version of this path.
  */
-public fun Path.toProto(): File = file {
+public fun Path.toAbsoluteFile(): File = file {
     path = absolutePathString().toUnix()
 }
 
+/**
+ * Converts this path to a [File] message with conversion to Unix path separators.
+ */
+public fun Path.toProto(): File = file { path = this@toProto.pathString.toUnix() }
+
 private fun String.toUnix(): String = replace('\\', '/')
 
 /**
@@ -53,9 +61,19 @@ public fun java.io.File.unixPath(): String = path.toUnix()
  */
 public fun Path.toDirectory(): Directory = toFile().toDirectory()
 
+/**
+ * Converts this path to a [Directory] with the absolute path.
+ */
+public fun Path.toAbsoluteDirectory(): Directory = toAbsolutePath().toDirectory()
+
 /**
  * Converts this instance of [java.io.File] to a [File] message with an absolute path.
  */
+public fun java.io.File.toAbsoluteFile(): File = toPath().toAbsoluteFile()
+
+/**
+ * Converts this path to a [File] message with conversion to Unix path separators.
+ */
 public fun java.io.File.toProto(): File = toPath().toProto()
 
 /**

api/src/main/kotlin/io/spine/protodata/render/InsertionPointPrinter.kt

@@ -27,7 +27,8 @@
 package io.spine.protodata.render
 
 import io.spine.core.userId
-import io.spine.protodata.ast.file
+import io.spine.protodata.ast.toAbsoluteFile
+import io.spine.protodata.ast.toProto
 import io.spine.protodata.render.CoordinatesFactory.Companion.endOfFile
 import io.spine.protodata.render.event.insertionPointPrinted
 import io.spine.text.TextCoordinates
@@ -168,7 +169,7 @@ public abstract class InsertionPointPrinter<L: Language>(
 
     private fun reportPoint(sourceFile: SourceFile<*>, pointLabel: String, comment: String) {
         val event = insertionPointPrinted {
-            file = file { path = sourceFile.relativePath.toString() }
+            file = sourceFile.relativePath.toProto()
             label = pointLabel
             representationInCode = comment
         }

api/src/main/kotlin/io/spine/protodata/render/SourceFile.kt

@@ -32,6 +32,7 @@ import com.intellij.openapi.fileTypes.FileTypeRegistry
 import com.intellij.psi.PsiFile
 import com.intellij.psi.PsiFileFactory
 import io.spine.protodata.ast.file
+import io.spine.protodata.ast.toProto
 import io.spine.protodata.util.Cache
 import io.spine.server.query.select
 import io.spine.text.Text
@@ -262,7 +263,7 @@ private constructor(
      */
     public fun atInline(insertionPoint: InsertionPoint): SourceAtPoint {
         val points = sources.querying.select<InsertedPoints>()
-            .findById(file { path = relativePath.toString() })
+            .findById(relativePath.toProto())
         val point = points?.pointList?.firstOrNull { it.label == insertionPoint.label }
         return if (point != null) {
             SpecificPoint(this@SourceFile, point)

api/src/main/kotlin/io/spine/protodata/settings/SettingsDirectory.kt

@@ -27,7 +27,7 @@
 package io.spine.protodata.settings
 
 import io.spine.protodata.util.ensureExistingDirectory
-import io.spine.protodata.ast.toProto
+import io.spine.protodata.ast.toAbsoluteFile
 import io.spine.protodata.settings.event.SettingsFileDiscovered
 import io.spine.protodata.settings.event.settingsFileDiscovered
 import io.spine.protodata.util.Format
@@ -122,7 +122,7 @@ public class SettingsDirectory(
     public fun emitEvents(): List<SettingsFileDiscovered> =
         files().map {
             settingsFileDiscovered {
-                file = it.toProto()
+                file = it.toAbsoluteFile()
             }
         }
 

api/src/main/proto/spine/protodata/directory.proto

@@ -1,5 +1,5 @@
 /*
- * Copyright 2024, TeamDev. All rights reserved.
+ * Copyright 2025, TeamDev. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -36,8 +36,12 @@ option java_outer_classname = "DirectoryProto";
 option java_multiple_files = true;
 
 // A path to a directory in an arbitrary OS.
+//
+// The Protobuf compiler only works with the Unix-style file separator (`/`), regardless of
+// the current operating system. This value holds this exact format of the path.
+//
 message Directory {
 
-    // The path to the directory, could be relative or absolute.
-    string path = 1 [(required) = true];
+    // The path to the directory, could be relative or absolute, with the slash (`/`) separator.
+    string path = 1 [(required) = true, (pattern).regex = "^[^\\\\]*$"];
 }

api/src/main/proto/spine/protodata/file.proto

@@ -45,6 +45,6 @@ option java_multiple_files = true;
 //
 message File {
 
-    // The path to the file, separating directories with slash (`/`) symbol.
-    string path = 1 [(required) = true];
+    // The path to the file, separating directories with the slash (`/`) symbol.
+    string path = 1 [(required) = true, (pattern).regex = "^[^\\\\]*$"];
 }

api/src/main/proto/spine/protodata/file_pattern.proto

@@ -1,5 +1,5 @@
 /*
- * Copyright 2024, TeamDev. All rights reserved.
+ * Copyright 2025, TeamDev. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -44,8 +44,16 @@ message FilePattern {
         // The path must end with this string.
         string suffix = 1;
 
+        // The path must contain this infix.
+        string infix = 4;
+
         // The path must start with this string.
-        string prefix = 2;
+        //
+        // Deprecated: File paths managed by Spine Compiler are primarily absolute.
+        // That is why this kind of pattern would not work in most cases.
+        // Please use the `infix` property instead.
+        //
+        string prefix = 2 [deprecated = true];
 
         // The path must match this regular expression.
         string regex = 3;

api/src/test/kotlin/io/spine/protodata/CompilationSpec.kt

@@ -33,7 +33,7 @@ import io.spine.logging.testing.tapConsole
 import io.spine.protodata.Compilation.ERROR_PREFIX
 import io.spine.protodata.Compilation.WARNING_PREFIX
 import io.spine.protodata.ast.Span
-import io.spine.protodata.ast.toProto
+import io.spine.protodata.ast.toAbsoluteFile
 import io.spine.testing.TestValues
 import java.io.File
 import java.nio.file.Paths
@@ -146,7 +146,7 @@ internal class CompilationSpec {
 
     @Test
     fun `provide the 'check' utility function`() {
-        val file = File("some/path/goes/here.proto").toProto()
+        val file = File("some/path/goes/here.proto").toAbsoluteFile()
         val span = Span.getDefaultInstance()
         val msg = TestValues.randomString()
         val error = assertThrows<Compilation.Error> {

api/src/test/kotlin/io/spine/protodata/ast/FilePatternsSpec.kt

@@ -33,6 +33,7 @@ import com.google.protobuf.Timestamp
 import io.kotest.matchers.shouldBe
 import io.spine.protodata.ast.FilePatternFactory.prefix
 import io.spine.protodata.ast.FilePatternFactory.regex
+import io.spine.protodata.ast.FilePatternFactory.infix
 import io.spine.protodata.ast.FilePatternFactory.suffix
 import io.spine.validate.ValidationError
 import org.junit.jupiter.api.DisplayName
@@ -52,6 +53,13 @@ internal class FilePatternsSpec {
             assertThrowing { suffix(" ") }
         }
 
+        @Test
+        fun infix() {
+            assertThrowing { infix("") }
+            assertThrowing { infix(" ") }
+        }
+
+        @Suppress("DEPRECATION") // Supporting for backward combability.
         @Test
         fun prefix() {
             assertThrowing { prefix("") }
@@ -76,12 +84,22 @@ internal class FilePatternsSpec {
 
         @Test
         fun prefix() {
+            @Suppress("DEPRECATION") // Supporting for backward compatibility.
             prefix("google/protobuf/any").run {
                 matches(messageTypeOf<Any>()) shouldBe true
                 matches(messageTypeOf<Timestamp>()) shouldBe false
             }
         }
 
+        @Test
+        fun infix() {
+            infix("protodata/file").run {
+                matches(messageTypeOf<FilePattern>()) shouldBe true
+                matches(messageTypeOf<File>()) shouldBe true
+                matches(messageTypeOf<Directory>()) shouldBe false
+            }
+        }
+
         @Test
         fun suffix() {
             suffix("y.proto").run {

api/src/test/kotlin/io/spine/protodata/ast/FileSpec.kt

@@ -0,0 +1,47 @@
+/*
+ * Copyright 2025, TeamDev. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Redistribution and use in source and/or binary forms, with or without
+ * modification, must retain the above copyright notice and the following
+ * disclaimer.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package io.spine.protodata.ast
+
+import io.spine.validate.ValidationException
+import org.junit.jupiter.api.DisplayName
+import org.junit.jupiter.api.Test
+import org.junit.jupiter.api.assertDoesNotThrow
+import org.junit.jupiter.api.assertThrows
+
+@DisplayName("`File` should")
+internal class FileSpec {
+
+    @Test
+    fun `prohibit non-Unix path separators`() {
+        assertThrows<ValidationException> {
+            file { path = "foo\\bar.proto" }
+        }
+        assertDoesNotThrow {
+            file { path = "foo/bar.proto" }
+        }
+    }
+}

api/src/test/kotlin/io/spine/protodata/ast/ProtoDeclarationSpec.kt

@@ -31,7 +31,6 @@ import io.spine.protodata.given.StubDeclaration
 import io.spine.protodata.given.copy
 import io.spine.protodata.given.stubDeclaration
 import kotlin.io.path.Path
-import kotlin.io.path.absolutePathString
 import org.junit.jupiter.api.DisplayName
 import org.junit.jupiter.api.Nested
 import org.junit.jupiter.api.Test
@@ -97,4 +96,4 @@ private fun StubDeclaration.withAbsoluteFile(path: File): StubDeclaration =
     replaceIfNotAbsoluteAlready(path) { copy { file = path } }
 
 private fun absoluteFile(path: String): File =
-    file { this.path = Path(".").resolve(path).absolutePathString() }
+    Path(".").resolve(path).toAbsolutePath().toAbsoluteFile()

backend/src/main/kotlin/io/spine/protodata/backend/event/CompilerEvents.kt

@@ -42,7 +42,7 @@ import io.spine.protodata.ast.event.fileOptionDiscovered
 import io.spine.protodata.ast.file
 import io.spine.protodata.ast.produceOptionEvents
 import io.spine.protodata.ast.toJava
-import io.spine.protodata.ast.toProto
+import io.spine.protodata.ast.toAbsoluteFile
 import io.spine.protodata.backend.DescriptorFilter
 import io.spine.protodata.protobuf.file
 import io.spine.protodata.protobuf.toHeader
@@ -106,7 +106,7 @@ private class ProtoFileEvents(
         val relativePath = hdr.file.toJava()
         val fullPath = typeSystem.compiledProtoFiles.find(relativePath)
         if (fullPath != null) {
-            hdr.copy { file = fullPath.toProto() }
+            hdr.copy { file = fullPath.toAbsoluteFile() }
         } else {
             hdr
         }

backend/src/test/kotlin/io/spine/protodata/backend/CodeGenerationContextSpec.kt

@@ -51,7 +51,7 @@ import io.spine.protodata.ast.ProtobufSourceFile
 import io.spine.protodata.ast.doc
 import io.spine.protodata.ast.option
 import io.spine.protodata.ast.span
-import io.spine.protodata.ast.toProto
+import io.spine.protodata.ast.toAbsoluteFile
 import io.spine.protodata.ast.toType
 import io.spine.protodata.backend.event.CompilerEvents
 import io.spine.protodata.context.CodegenContext
@@ -170,7 +170,7 @@ class CodeGenerationContextSpec {
         fun `with files marked for generation`() {
             val fullPath = typeSystem.findAbsolute(DoctorProto.getDescriptor())
             val assertSourceFile = ctx.assertEntity<ProtoSourceFileView, _>(
-                fullPath!!.toProto()
+                fullPath!!.toAbsoluteFile()
             )
             assertSourceFile.exists()
 
@@ -216,7 +216,7 @@ class CodeGenerationContextSpec {
         fun `with respect for custom options among the source files`() {
             val filePath = typeSystem.findAbsolute(PhDProto.getDescriptor())
             val phdFile = ctx.assertEntity<ProtoSourceFileView, _>(
-                filePath!!.toProto()
+                filePath!!.toAbsoluteFile()
             ).actual()!!.state() as ProtobufSourceFile
             val paperType = phdFile.typeMap.values.find { it.name.simpleName == "Paper" }!!
             val keywordsField = paperType.fieldList.find { it.name.value == "keywords" }!!