Use relative path in include statement

aNNiMON · aNNiMON · commit 896f76c2cff5 · 2024-10-07T23:59:52.000+03:00
diff --git a/docs/docs/en/changelog.md b/docs/docs/en/changelog.md
@@ -4,6 +4,7 @@
 
 ### Changes
 - Add `own` package manager. Usage examples: `own`, `own init`, `own add openai`.
+- Use relative path in include statement. 
 
 ### Fixes
 - Fix passing command-line arguments to scripts.
diff --git a/docs/docs/ru/changelog.md b/docs/docs/ru/changelog.md
@@ -4,6 +4,7 @@
 
 ### Изменения
 - Добавлен `own` пакетный менеджер. Примеры испльзования: `own`, `own init`, `own add openai`.
+- Относительные пути в include.
 
 ### Исправления
 - Исправлена передача аргументов командной строки скриптам.
diff --git a/ownlang-core/src/main/java/com/annimon/ownlang/util/SourceLocationFormatterStage.java b/ownlang-core/src/main/java/com/annimon/ownlang/util/SourceLocationFormatterStage.java
@@ -19,7 +19,7 @@ public String perform(StagesData stagesData, Range input) {
 
     static void printPosition(StringBuilder sb, Range range, String[] lines) {
         final Pos start = range.start();
-        final int linesCount = lines.length;;
+        final int linesCount = lines.length;
         if (range.isOnSameLine()) {
             if (start.row() < linesCount) {
                 sb.append(lines[start.row()]);
diff --git a/ownlang-core/src/main/java/com/annimon/ownlang/util/input/InputSource.java b/ownlang-core/src/main/java/com/annimon/ownlang/util/input/InputSource.java
@@ -8,8 +8,9 @@ public interface InputSource {
     String load() throws IOException;
 
     default String getBasePath() {
-        int i = getPath().lastIndexOf("/");
+        final String normalizedPath = getPath().replace("\\", "/");
+        int i = normalizedPath.lastIndexOf("/");
         if (i == -1) return "";
-        return getPath().substring(0, i + 1);
+        return normalizedPath.substring(0, i + 1);
     }
 }
diff --git a/ownlang-core/src/main/java/com/annimon/ownlang/util/input/InputSourceDetector.java b/ownlang-core/src/main/java/com/annimon/ownlang/util/input/InputSourceDetector.java
@@ -3,25 +3,29 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 
-public record InputSourceDetector() {
+public record InputSourceDetector(String basePath) {
     public static final String RESOURCE_PREFIX = "resource:";
 
+    public InputSourceDetector() {
+        this("");
+    }
+
     public boolean isReadable(String programPath) {
         if (programPath.startsWith(RESOURCE_PREFIX)) {
             String path = programPath.substring(RESOURCE_PREFIX.length());
-            return getClass().getResource(path) != null;
+            return getClass().getResource(basePath + path) != null;
         } else {
-            Path path = Path.of(programPath);
+            Path path = Path.of(basePath, programPath);
             return Files.isReadable(path) && Files.isRegularFile(path);
         }
     }
 
     public InputSource toInputSource(String programPath) {
         if (programPath.startsWith(RESOURCE_PREFIX)) {
             String path = programPath.substring(RESOURCE_PREFIX.length());
-            return new InputSourceResource(path);
+            return new InputSourceResource(basePath + path);
         } else {
-            return new InputSourceFile(programPath);
+            return new InputSourceFile(basePath + programPath);
         }
     }
 }
diff --git a/ownlang-core/src/main/java/com/annimon/ownlang/util/input/SourceLoaderStage.java b/ownlang-core/src/main/java/com/annimon/ownlang/util/input/SourceLoaderStage.java
@@ -10,6 +10,7 @@
 
 public class SourceLoaderStage implements Stage<InputSource, String> {
 
+    public static final String TAG_BASE_PATH = "basePath";
     public static final String TAG_SOURCE_LINES = "sourceLines";
 
     @Override
@@ -20,6 +21,7 @@ public String perform(StagesData stagesData, InputSource inputSource) {
                     ? new String[0]
                     : result.split("\r?\n");
             stagesData.put(TAG_SOURCE_LINES, lines);
+            stagesData.put(TAG_BASE_PATH, inputSource.getBasePath());
             return result;
         } catch (IOException e) {
             throw new OwnLangRuntimeException("Unable to read input " + inputSource, e);
diff --git a/ownlang-parser/src/main/java/com/annimon/ownlang/parser/Parser.java b/ownlang-parser/src/main/java/com/annimon/ownlang/parser/Parser.java
@@ -61,6 +61,7 @@ public static Node parse(List<Token> tokens) {
     private final List<Token> tokens;
     private final int size;
     private final ParseErrors parseErrors;
+    private ParserMetadata metadata;
     private Statement parsedStatement;
 
     private int index;
@@ -79,6 +80,10 @@ public ParseErrors getParseErrors() {
         return parseErrors;
     }
 
+    public void setMetadata(ParserMetadata metadata) {
+        this.metadata = metadata;
+    }
+
     public Node parse() {
         parseErrors.clear();
         final BlockStatement result = new BlockStatement();
@@ -177,7 +182,8 @@ private Statement statement() {
 
     private IncludeStatement includeStatement() {
         final var startTokenIndex = index - 1;
-        final var include = new IncludeStatement(expression());
+        final String basePath = (metadata != null) ? metadata.basePath() : "";
+        final var include = new IncludeStatement(expression(), basePath);
         include.setRange(getRange(startTokenIndex, index));
         return include;
     }
diff --git a/ownlang-parser/src/main/java/com/annimon/ownlang/parser/ParserMetadata.java b/ownlang-parser/src/main/java/com/annimon/ownlang/parser/ParserMetadata.java
@@ -0,0 +1,6 @@
+package com.annimon.ownlang.parser;
+
+public record ParserMetadata(
+        String basePath
+) {
+}
diff --git a/ownlang-parser/src/main/java/com/annimon/ownlang/parser/ast/IncludeStatement.java b/ownlang-parser/src/main/java/com/annimon/ownlang/parser/ast/IncludeStatement.java
@@ -18,12 +18,14 @@
 public final class IncludeStatement extends InterruptableNode implements Statement, SourceLocation {
 
     public final Node expression;
+    public final String basePath;
     private final InputSourceDetector inputSourceDetector;
     private Range range;
 
-    public IncludeStatement(Node expression) {
+    public IncludeStatement(Node expression, String basePath) {
         this.expression = expression;
-        inputSourceDetector = new InputSourceDetector();
+        this.basePath = basePath;
+        inputSourceDetector = new InputSourceDetector(basePath);
     }
 
     public void setRange(Range range) {
diff --git a/ownlang-parser/src/main/java/com/annimon/ownlang/parser/linters/IncludeSourceValidator.java b/ownlang-parser/src/main/java/com/annimon/ownlang/parser/linters/IncludeSourceValidator.java
@@ -11,9 +11,9 @@
 final class IncludeSourceValidator extends LintVisitor {
     private final InputSourceDetector detector;
 
-    IncludeSourceValidator(LinterResults results) {
+    IncludeSourceValidator(LinterResults results, String basePath) {
         super(results);
-        detector = new InputSourceDetector();
+        detector = new InputSourceDetector(basePath);
     }
 
     @Override
diff --git a/ownlang-parser/src/main/java/com/annimon/ownlang/parser/linters/LinterStage.java b/ownlang-parser/src/main/java/com/annimon/ownlang/parser/linters/LinterStage.java
@@ -7,6 +7,7 @@
 import com.annimon.ownlang.parser.ast.Visitor;
 import com.annimon.ownlang.stages.Stage;
 import com.annimon.ownlang.stages.StagesData;
+import com.annimon.ownlang.util.input.SourceLoaderStage;
 import java.util.ArrayList;
 import java.util.Comparator;
 import java.util.List;
@@ -26,7 +27,8 @@ public Node perform(StagesData stagesData, Node input) {
 
         final LinterResults results = new LinterResults();
         final List<Visitor> validators = new ArrayList<>();
-        validators.add(new IncludeSourceValidator(results));
+        String basePath = stagesData.getOrDefault(SourceLoaderStage.TAG_BASE_PATH, "");
+        validators.add(new IncludeSourceValidator(results, basePath));
         validators.add(new LoopStatementsValidator(results));
 
         if (mode == Mode.SEMANTIC || mode == Mode.INTERNAL) {
diff --git a/ownlang-parser/src/main/java/com/annimon/ownlang/parser/optimization/OptimizationVisitor.java b/ownlang-parser/src/main/java/com/annimon/ownlang/parser/optimization/OptimizationVisitor.java
@@ -30,8 +30,8 @@ public Node visit(ArrayExpression s, T t) {
     public Node visit(AssignmentExpression s, T t) {
         final Node exprNode = s.expression.accept(this, t);
         final Node targetNode = s.target.accept(this, t);
-        if ( (exprNode != s.expression || targetNode != s.target) && (targetNode instanceof Accessible) ) {
-            return new AssignmentExpression(s.operation, (Accessible) targetNode, exprNode, s.getRange());
+        if ( (exprNode != s.expression || targetNode != s.target) && (targetNode instanceof Accessible acc) ) {
+            return new AssignmentExpression(s.operation, acc, exprNode, s.getRange());
         }
         return s;
     }
@@ -254,7 +254,7 @@ public Node visit(IfStatement s, T t) {
     public Node visit(IncludeStatement s, T t) {
         final Node expression = s.expression.accept(this, t);
         if (expression != s.expression) {
-            return new IncludeStatement(expression);
+            return new IncludeStatement(expression, s.basePath);
         }
         return s;
     }
diff --git a/ownlang-parser/src/main/java/com/annimon/ownlang/stages/ParserStage.java b/ownlang-parser/src/main/java/com/annimon/ownlang/stages/ParserStage.java
@@ -2,8 +2,10 @@
 
 import com.annimon.ownlang.exceptions.OwnLangParserException;
 import com.annimon.ownlang.parser.Parser;
+import com.annimon.ownlang.parser.ParserMetadata;
 import com.annimon.ownlang.parser.Token;
 import com.annimon.ownlang.parser.ast.Node;
+import com.annimon.ownlang.util.input.SourceLoaderStage;
 import java.util.List;
 
 public class ParserStage implements Stage<List<Token>, Node> {
@@ -14,6 +16,8 @@ public class ParserStage implements Stage<List<Token>, Node> {
     @Override
     public Node perform(StagesData stagesData, List<Token> input) {
         final Parser parser = new Parser(input);
+        String basePath = stagesData.getOrDefault(SourceLoaderStage.TAG_BASE_PATH, "");
+        parser.setMetadata(new ParserMetadata(basePath));
         final Node program = parser.parse();
         final var parseErrors = parser.getParseErrors();
         stagesData.put(TAG_PROGRAM, program);
diff --git a/ownlang-parser/src/test/resources/expressions/include.own b/ownlang-parser/src/test/resources/expressions/include.own
@@ -1,7 +1,7 @@
 use std
 
 def testIncludeClass() {
-  include "src/test/resources/expressions/includeClass.own.txt"
+  include "includeClass.own.txt"
   obj = new IncludeClass()
   assertEquals("1", obj.field1)
   assertEquals(2, obj.field2)
@@ -10,26 +10,26 @@ def testIncludeClass() {
 
 def testIncludeNotExistsSource() {
   assertFail(def() {
-    include "src/test.own"
+    include "test.own"
   })
 }
 
 def testCatchingIncludeNotExistsSource() {
   res = try(def() {
-    include "src/test.own"
+    include "test.own"
   }, def(classname, message) = "ok")
   assertEquals("ok", res)
 }
 
 def testIncludeParseErrorSource() {
   assertFail(def() {
-    include "src/test/resources/expressions/includeParseErrorSource.own.txt"
+    include "includeParseErrorSource.own.txt"
   })
 }
 
 def testCatchingIncludeParseErrorSource() {
   res = try(def() {
-    include "src/test/resources/expressions/includeParseErrorSource.own.txt"
+    include "includeParseErrorSource.own.txt"
   }, def(classname, message) = "ok")
   assertEquals("ok", res)
 }

Original file line number	Diff line number	Diff line change
`@@ -8,8 +8,9 @@ public interface InputSource {`
`8`	`8`	`String load() throws IOException;`
`9`	`9`
`10`	`10`	`default String getBasePath() {`
`11`		`- int i = getPath().lastIndexOf("/");`
	`11`	`+ final String normalizedPath = getPath().replace("\\", "/");`
	`12`	`+ int i = normalizedPath.lastIndexOf("/");`
`12`	`13`	`if (i == -1) return "";`
`13`		`- return getPath().substring(0, i + 1);`
	`14`	`+ return normalizedPath.substring(0, i + 1);`
`14`	`15`	`}`
`15`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -30,8 +30,8 @@ public Node visit(ArrayExpression s, T t) {`
`30`	`30`	`public Node visit(AssignmentExpression s, T t) {`
`31`	`31`	`final Node exprNode = s.expression.accept(this, t);`
`32`	`32`	`final Node targetNode = s.target.accept(this, t);`
`33`		`- if ( (exprNode != s.expression \|\| targetNode != s.target) && (targetNode instanceof Accessible) ) {`
`34`		`- return new AssignmentExpression(s.operation, (Accessible) targetNode, exprNode, s.getRange());`
	`33`	`+ if ( (exprNode != s.expression \|\| targetNode != s.target) && (targetNode instanceof Accessible acc) ) {`
	`34`	`+ return new AssignmentExpression(s.operation, acc, exprNode, s.getRange());`
`35`	`35`	`}`
`36`	`36`	`return s;`
`37`	`37`	`}`
`@@ -254,7 +254,7 @@ public Node visit(IfStatement s, T t) {`
`254`	`254`	`public Node visit(IncludeStatement s, T t) {`
`255`	`255`	`final Node expression = s.expression.accept(this, t);`
`256`	`256`	`if (expression != s.expression) {`
`257`		`- return new IncludeStatement(expression);`
	`257`	`+ return new IncludeStatement(expression, s.basePath);`
`258`	`258`	`}`
`259`	`259`	`return s;`
`260`	`260`	`}`