Introduce RubyContext#getSourcePath() and use it where possible

eregon · eregon · commit 8484c42370d2 · 2020-10-02T13:53:45.000+02:00
diff --git a/src/main/java/org/truffleruby/RubyContext.java b/src/main/java/org/truffleruby/RubyContext.java
@@ -495,7 +495,7 @@ private void dispose() {
         }
 
         if (options.COVERAGE_GLOBAL) {
-            coverageManager.print(System.out);
+            coverageManager.print(this, System.out);
         }
     }
 
@@ -792,7 +792,9 @@ public WeakValueCache<RegexpCacheKey, Regex> getRegexpCache() {
         return regexpCache;
     }
 
-    /** Returns the path of a Source. Returns the short, potentially relative, path for the main script. Note however
+    /** {@link #getSourcePath(Source)} should be used instead whenever possible (i.e., when we can access the context).
+     *
+     * Returns the path of a Source. Returns the short, potentially relative, path for the main script. Note however
      * that the path of {@code eval(code, nil, filename)} is just {@code filename} and might not be absolute. */
     public static String getPath(Source source) {
         final String path = source.getPath();
@@ -806,6 +808,18 @@ public static String getPath(Source source) {
         }
     }
 
+    /** {@link RubyContext#getPath(Source)} but also handles core library sources. Ideally this method would be static
+     * but for now the core load path is an option and it also depends on the current working directory. Once we have
+     * Source metadata in Truffle we could use that to identify core library sources without needing the context. */
+    public String getSourcePath(Source source) {
+        final String path = RubyContext.getPath(source);
+        if (path.startsWith(coreLibrary.coreLoadPath)) {
+            return "<internal:core> " + path.substring(coreLibrary.coreLoadPath.length() + 1);
+        } else {
+            return RubyContext.getPath(source);
+        }
+    }
+
     public String getPathRelativeToHome(String path) {
         if (path.startsWith(rubyHome) && path.length() > rubyHome.length()) {
             return path.substring(rubyHome.length() + 1);
diff --git a/src/main/java/org/truffleruby/cext/CExtNodes.java b/src/main/java/org/truffleruby/cext/CExtNodes.java
@@ -18,7 +18,6 @@
 import org.jcodings.specific.USASCIIEncoding;
 import org.jcodings.specific.UTF8Encoding;
 import org.truffleruby.Layouts;
-import org.truffleruby.RubyContext;
 import org.truffleruby.RubyLanguage;
 import org.truffleruby.builtins.CoreMethod;
 import org.truffleruby.builtins.CoreMethodArrayArgumentsNode;
@@ -785,7 +784,7 @@ public abstract static class SourceFileNode extends CoreMethodArrayArgumentsNode
         @Specialization
         protected RubyString sourceFile() {
             final SourceSection sourceSection = getTopUserSourceSection("rb_sourcefile");
-            final String file = RubyContext.getPath(sourceSection.getSource());
+            final String file = getContext().getSourcePath(sourceSection.getSource());
 
             return makeStringNode.executeMake(file, UTF8Encoding.INSTANCE, CodeRange.CR_UNKNOWN);
         }
diff --git a/src/main/java/org/truffleruby/core/binding/BindingNodes.java b/src/main/java/org/truffleruby/core/binding/BindingNodes.java
@@ -384,7 +384,7 @@ protected Object sourceLocation(RubyBinding binding,
                 return nil;
             } else {
                 final RubyString file = makeStringNode.executeMake(
-                        RubyContext.getPath(sourceSection.getSource()),
+                        getContext().getSourcePath(sourceSection.getSource()),
                         UTF8Encoding.INSTANCE,
                         CodeRange.CR_UNKNOWN);
                 return createArray(new Object[]{ file, sourceSection.getStartLine() });
diff --git a/src/main/java/org/truffleruby/core/kernel/KernelNodes.java b/src/main/java/org/truffleruby/core/kernel/KernelNodes.java
@@ -301,7 +301,7 @@ protected RubyString getCallerPath(RubyString feature,
                             coreExceptions().loadError("cannot infer basepath", featureString, this));
                 }
 
-                String sourcePath = RubyContext.getPath(sourceSection.getSource());
+                String sourcePath = getContext().getSourcePath(sourceSection.getSource());
 
                 sourcePath = getContext().getFeatureLoader().canonicalize(sourcePath);
 
diff --git a/src/main/java/org/truffleruby/core/method/MethodNodes.java b/src/main/java/org/truffleruby/core/method/MethodNodes.java
@@ -10,7 +10,6 @@
 package org.truffleruby.core.method;
 
 import org.jcodings.specific.UTF8Encoding;
-import org.truffleruby.RubyContext;
 import org.truffleruby.RubyLanguage;
 import org.truffleruby.builtins.CoreMethod;
 import org.truffleruby.builtins.CoreMethodArrayArgumentsNode;
@@ -189,7 +188,7 @@ protected Object sourceLocation(RubyMethod method) {
                 return nil;
             } else {
                 RubyString file = makeStringNode.executeMake(
-                        RubyContext.getPath(sourceSection.getSource()),
+                        getContext().getSourcePath(sourceSection.getSource()),
                         UTF8Encoding.INSTANCE,
                         CodeRange.CR_UNKNOWN);
                 return createArray(new Object[]{ file, sourceSection.getStartLine() });
diff --git a/src/main/java/org/truffleruby/core/method/UnboundMethodNodes.java b/src/main/java/org/truffleruby/core/method/UnboundMethodNodes.java
@@ -10,7 +10,6 @@
 package org.truffleruby.core.method;
 
 import org.jcodings.specific.UTF8Encoding;
-import org.truffleruby.RubyContext;
 import org.truffleruby.RubyLanguage;
 import org.truffleruby.builtins.CoreMethod;
 import org.truffleruby.builtins.CoreMethodArrayArgumentsNode;
@@ -188,7 +187,7 @@ protected Object sourceLocation(RubyUnboundMethod unboundMethod) {
                 return nil;
             } else {
                 RubyString file = makeStringNode.executeMake(
-                        RubyContext.getPath(sourceSection.getSource()),
+                        getContext().getSourcePath(sourceSection.getSource()),
                         UTF8Encoding.INSTANCE,
                         CodeRange.CR_UNKNOWN);
                 Object[] objects = new Object[]{ file, sourceSection.getStartLine() };
diff --git a/src/main/java/org/truffleruby/core/proc/ProcNodes.java b/src/main/java/org/truffleruby/core/proc/ProcNodes.java
@@ -10,7 +10,6 @@
 package org.truffleruby.core.proc;
 
 import org.jcodings.specific.UTF8Encoding;
-import org.truffleruby.RubyContext;
 import org.truffleruby.RubyLanguage;
 import org.truffleruby.builtins.CoreMethod;
 import org.truffleruby.builtins.CoreMethodArrayArgumentsNode;
@@ -239,12 +238,12 @@ public abstract static class SourceLocationNode extends CoreMethodArrayArguments
         protected Object sourceLocation(RubyProc proc) {
             SourceSection sourceSection = proc.sharedMethodInfo.getSourceSection();
 
-            if (!sourceSection.isAvailable() ||
-                    RubyContext.getPath(sourceSection.getSource()).endsWith("/lib/truffle/truffle/cext.rb")) {
+            final String sourcePath = getContext().getSourcePath(sourceSection.getSource());
+            if (!sourceSection.isAvailable() || sourcePath.endsWith("/lib/truffle/truffle/cext.rb")) {
                 return nil;
             } else {
                 final RubyString file = makeStringNode.executeMake(
-                        RubyContext.getPath(sourceSection.getSource()),
+                        sourcePath,
                         UTF8Encoding.INSTANCE,
                         CodeRange.CR_UNKNOWN);
 
diff --git a/src/main/java/org/truffleruby/core/rope/PathToRopeCache.java b/src/main/java/org/truffleruby/core/rope/PathToRopeCache.java
@@ -35,7 +35,7 @@ public PathToRopeCache(RubyContext context) {
 
     @TruffleBoundary
     public Rope getCachedPath(Source source) {
-        final String path = RubyContext.getPath(source);
+        final String path = context.getSourcePath(source);
 
         final Lock readLock = lock.readLock();
         readLock.lock();
diff --git a/src/main/java/org/truffleruby/core/thread/ThreadBacktraceLocationNodes.java b/src/main/java/org/truffleruby/core/thread/ThreadBacktraceLocationNodes.java
@@ -20,7 +20,6 @@
 import org.truffleruby.core.string.StringNodes;
 import org.truffleruby.core.string.StringOperations;
 import org.truffleruby.language.backtrace.Backtrace;
-import org.truffleruby.language.backtrace.BacktraceFormatter;
 
 import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;
 import com.oracle.truffle.api.TruffleStackTraceElement;
@@ -56,8 +55,8 @@ protected RubyString absolutePath(RubyBacktraceLocation threadBacktraceLocation,
                 return coreStrings().UNKNOWN.createInstance(getContext());
             } else {
                 final Source source = sourceSection.getSource();
-                final String path = RubyContext.getPath(source);
                 if (source.getPath() != null) { // A normal file
+                    final String path = getContext().getSourcePath(source);
                     final String canonicalPath = getContext().getFeatureLoader().canonicalize(path);
                     final Rope cachedRope = getContext()
                             .getRopeCache()
@@ -84,15 +83,7 @@ protected RubyString path(RubyBacktraceLocation threadBacktraceLocation,
             if (sourceSection == null) {
                 return coreStrings().UNKNOWN.createInstance(getContext());
             } else {
-                final Rope path;
-                if (BacktraceFormatter.isCore(getContext(), sourceSection)) {
-                    path = StringOperations.encodeRope(
-                            BacktraceFormatter.formatCorePath(getContext(), sourceSection),
-                            UTF8Encoding.INSTANCE);
-                } else {
-                    path = getContext().getPathToRopeCache().getCachedPath(sourceSection.getSource());
-                }
-
+                final Rope path = getContext().getPathToRopeCache().getCachedPath(sourceSection.getSource());
                 return makeStringNode.fromRope(path);
             }
         }
diff --git a/src/main/java/org/truffleruby/debug/TruffleDebugNodes.java b/src/main/java/org/truffleruby/debug/TruffleDebugNodes.java
@@ -108,7 +108,7 @@ protected RubyHandle setBreak(RubyString file, int line, RubyProc block) {
             final SourceSectionFilter filter = SourceSectionFilter
                     .newBuilder()
                     .mimeTypeIs(TruffleRuby.MIME_TYPE)
-                    .sourceIs(source -> source != null && RubyContext.getPath(source).equals(fileString))
+                    .sourceIs(source -> source != null && getContext().getSourcePath(source).equals(fileString))
                     .lineIs(line)
                     .tagIs(StandardTags.StatementTag.class)
                     .build();
diff --git a/src/main/java/org/truffleruby/language/DataNode.java b/src/main/java/org/truffleruby/language/DataNode.java
@@ -10,7 +10,6 @@
 package org.truffleruby.language;
 
 import org.jcodings.Encoding;
-import org.truffleruby.RubyContext;
 import org.truffleruby.core.rope.CodeRange;
 import org.truffleruby.core.string.RubyString;
 import org.truffleruby.core.string.StringNodes;
@@ -57,7 +56,7 @@ public Object execute(VirtualFrame frame) {
 
     @TruffleBoundary
     private String getPath() {
-        return RubyContext.getPath(getEncapsulatingSourceSection().getSource());
+        return getContext().getSourcePath(getEncapsulatingSourceSection().getSource());
     }
 
 }
diff --git a/src/main/java/org/truffleruby/language/RubyInlineParsingRequestNode.java b/src/main/java/org/truffleruby/language/RubyInlineParsingRequestNode.java
@@ -47,7 +47,7 @@ public RubyInlineParsingRequestNode(
         // We use the current frame as the lexical scope to parse, but then we may run with a new frame in the future
 
         final RubyRootNode rootNode = translator.parse(
-                new RubySource(source, RubyContext.getPath(source)),
+                new RubySource(source, context.getSourcePath(source)),
                 ParserContext.INLINE,
                 null,
                 currentFrame,
diff --git a/src/main/java/org/truffleruby/language/RubyParsingRequestNode.java b/src/main/java/org/truffleruby/language/RubyParsingRequestNode.java
@@ -43,7 +43,7 @@ public RubyParsingRequestNode(RubyLanguage language, RubyContext context, Source
         final TranslatorDriver translator = new TranslatorDriver(context);
 
         final RubyRootNode rootNode = translator.parse(
-                new RubySource(source, RubyContext.getPath(source)),
+                new RubySource(source, context.getSourcePath(source)),
                 ParserContext.TOP_LEVEL,
                 argumentNames,
                 null,
diff --git a/src/main/java/org/truffleruby/language/TruffleBootNodes.java b/src/main/java/org/truffleruby/language/TruffleBootNodes.java
@@ -276,7 +276,7 @@ protected Object sourceOfCaller() {
             }
 
             return makeStringNode
-                    .executeMake(RubyContext.getPath(source), UTF8Encoding.INSTANCE, CodeRange.CR_UNKNOWN);
+                    .executeMake(getContext().getSourcePath(source), UTF8Encoding.INSTANCE, CodeRange.CR_UNKNOWN);
         }
 
     }
diff --git a/src/main/java/org/truffleruby/language/backtrace/BacktraceFormatter.java b/src/main/java/org/truffleruby/language/backtrace/BacktraceFormatter.java
@@ -83,7 +83,7 @@ public static String printableRubyBacktrace(RubyContext context, Node node) {
     /** For debug purposes. */
     public static boolean isApplicationCode(RubyContext context, SourceSection sourceSection) {
         return isUserSourceSection(context, sourceSection) &&
-                !RubyContext.getPath(sourceSection.getSource()).contains("/lib/stdlib/rubygems");
+                !context.getSourcePath(sourceSection.getSource()).contains("/lib/stdlib/rubygems");
     }
 
     public BacktraceFormatter(RubyContext context, EnumSet<FormattingFlags> flags) {
@@ -239,11 +239,7 @@ private String formatLineInternal(TruffleStackTraceElement[] stackTrace, int n,
             if (reportedSourceSection == null) {
                 builder.append("???");
             } else {
-                if (isRubyCore(context, reportedSourceSection.getSource())) {
-                    builder.append(formatCorePath(context, reportedSourceSection));
-                } else {
-                    builder.append(RubyContext.getPath(reportedSourceSection.getSource()));
-                }
+                builder.append(context.getSourcePath(reportedSourceSection.getSource()));
                 builder.append(":");
                 builder.append(RubySource.getStartLineAdjusted(context, reportedSourceSection));
             }
@@ -273,7 +269,7 @@ private String formatForeign(Node callNode, String methodName) {
 
         if (sourceSection != null) {
             final Source source = sourceSection.getSource();
-            final String path = RubyContext.getPath(source);
+            final String path = context.getSourcePath(source);
 
             builder.append(path);
             if (sourceSection.isAvailable()) {
@@ -345,24 +341,13 @@ public static boolean isAvailable(SourceSection sourceSection) {
         return sourceSection != null && sourceSection.isAvailable();
     }
 
-    public static boolean isCore(RubyContext context, SourceSection sourceSection) {
-        assert isAvailable(sourceSection);
-        return isRubyCore(context, sourceSection.getSource());
-    }
-
-    public static String formatCorePath(RubyContext context, SourceSection sourceSection) {
-        assert isCore(context, sourceSection);
-        final String path = RubyContext.getPath(sourceSection.getSource());
-        return "<internal:core> " + path.substring(context.getCoreLibrary().coreLoadPath.length() + 1);
+    public static boolean isUserSourceSection(RubyContext context, SourceSection sourceSection) {
+        return isAvailable(sourceSection) && !isRubyCore(context, sourceSection.getSource());
     }
 
     private static boolean isRubyCore(RubyContext context, Source source) {
         final String path = RubyContext.getPath(source);
-        return path.startsWith(context.getOptions().CORE_LOAD_PATH);
-    }
-
-    public static boolean isUserSourceSection(RubyContext context, SourceSection sourceSection) {
-        return isAvailable(sourceSection) && !isCore(context, sourceSection);
+        return path.startsWith(context.getCoreLibrary().coreLoadPath);
     }
 
     private Node getRootOrTopmostNode(Node node) {
diff --git a/src/main/java/org/truffleruby/language/objects/AllocationTracing.java b/src/main/java/org/truffleruby/language/objects/AllocationTracing.java
@@ -74,7 +74,7 @@ private static void callTraceAllocation(RubyContext context, RubyDynamicObject o
                 object,
                 string(context, className),
                 context.getSymbol(allocatingMethod),
-                string(context, RubyContext.getPath(allocatingSourceSection.getSource())),
+                string(context, context.getSourcePath(allocatingSourceSection.getSource())),
                 allocatingSourceSection.getStartLine(),
                 ObjectSpaceManager.getCollectionCount());
     }
diff --git a/src/main/java/org/truffleruby/parser/MethodTranslator.java b/src/main/java/org/truffleruby/parser/MethodTranslator.java
@@ -79,7 +79,7 @@ public MethodTranslator(
 
         if (parserContext == ParserContext.EVAL || context.getCoverageManager().isEnabled()) {
             shouldLazyTranslate = false;
-        } else if (RubyContext.getPath(source).startsWith(context.getCoreLibrary().coreLoadPath)) {
+        } else if (context.getSourcePath(source).startsWith(context.getCoreLibrary().coreLoadPath)) {
             shouldLazyTranslate = context.getOptions().LAZY_TRANSLATION_CORE;
         } else {
             shouldLazyTranslate = context.getOptions().LAZY_TRANSLATION_USER;
diff --git a/src/main/java/org/truffleruby/parser/TranslatorDriver.java b/src/main/java/org/truffleruby/parser/TranslatorDriver.java
@@ -455,7 +455,7 @@ private TranslatorEnvironment environmentForFrame(RubyContext context, Materiali
     public static void printParseTranslateExecuteMetric(String id, RubyContext context, Source source) {
         if (Metrics.getMetricsTime()) {
             if (context.getOptions().METRICS_TIME_PARSING_FILE) {
-                String name = RubyContext.getPath(source);
+                String name = context.getSourcePath(source);
                 int lastSlash = name.lastIndexOf('/');
                 int lastDot = name.lastIndexOf('.');
                 if (lastSlash >= 0 && lastDot >= 0 && lastSlash + 1 < lastDot) {
diff --git a/src/main/java/org/truffleruby/stdlib/CoverageManager.java b/src/main/java/org/truffleruby/stdlib/CoverageManager.java
@@ -167,7 +167,7 @@ public synchronized Map<Source, long[]> getCounts() {
         return counts;
     }
 
-    public synchronized void print(PrintStream out) {
+    public synchronized void print(RubyContext context, PrintStream out) {
         final int maxCountDigits = Long.toString(getMaxCount()).length();
 
         final String countFormat = "%" + maxCountDigits + "d";
@@ -178,7 +178,7 @@ public synchronized void print(PrintStream out) {
         final String noCodeString = new String(noCodeChars);
 
         for (Map.Entry<Source, AtomicLongArray> entry : counters.entrySet()) {
-            out.println(RubyContext.getPath(entry.getKey()));
+            out.println(context.getSourcePath(entry.getKey()));
 
             for (int n = 0; n < entry.getValue().length(); n++) {
                 // TODO CS 5-Sep-17 can we keep the line as a CharSequence rather than using toString?
diff --git a/src/main/java/org/truffleruby/stdlib/CoverageNodes.java b/src/main/java/org/truffleruby/stdlib/CoverageNodes.java
@@ -13,7 +13,6 @@
 import java.util.Map;
 
 import org.jcodings.specific.UTF8Encoding;
-import org.truffleruby.RubyContext;
 import org.truffleruby.builtins.CoreMethod;
 import org.truffleruby.builtins.CoreMethodArrayArgumentsNode;
 import org.truffleruby.builtins.CoreModule;
@@ -80,7 +79,7 @@ protected RubyArray resultArray() {
                     }
                 }
 
-                final String path = RubyContext.getPath(source.getKey());
+                final String path = getContext().getSourcePath(source.getKey());
                 assert !results.containsKey(path) : "path already exists in coverage results";
                 results.put(path, createArray(new Object[]{
                         makeStringNode.executeMake(

Original file line number	Diff line number	Diff line change
`@@ -495,7 +495,7 @@ private void dispose() {`
`495`	`495`	`}`
`496`	`496`
`497`	`497`	`if (options.COVERAGE_GLOBAL) {`
`498`		`- coverageManager.print(System.out);`
	`498`	`+ coverageManager.print(this, System.out);`
`499`	`499`	`}`
`500`	`500`	`}`
`501`	`501`
`@@ -792,7 +792,9 @@ public WeakValueCache<RegexpCacheKey, Regex> getRegexpCache() {`
`792`	`792`	`return regexpCache;`
`793`	`793`	`}`
`794`	`794`
`795`		`- /** Returns the path of a Source. Returns the short, potentially relative, path for the main script. Note however`
	`795`	`+ /** {@link #getSourcePath(Source)} should be used instead whenever possible (i.e., when we can access the context).`
	`796`	`+ *`
	`797`	`+ * Returns the path of a Source. Returns the short, potentially relative, path for the main script. Note however`
`796`	`798`	`* that the path of {@code eval(code, nil, filename)} is just {@code filename} and might not be absolute. */`
`797`	`799`	`public static String getPath(Source source) {`
`798`	`800`	`final String path = source.getPath();`
`@@ -806,6 +808,18 @@ public static String getPath(Source source) {`
`806`	`808`	`}`
`807`	`809`	`}`
`808`	`810`
	`811`	`+ /** {@link RubyContext#getPath(Source)} but also handles core library sources. Ideally this method would be static`
	`812`	`+ * but for now the core load path is an option and it also depends on the current working directory. Once we have`
	`813`	`+ * Source metadata in Truffle we could use that to identify core library sources without needing the context. */`
	`814`	`+ public String getSourcePath(Source source) {`
	`815`	`+ final String path = RubyContext.getPath(source);`
	`816`	`+ if (path.startsWith(coreLibrary.coreLoadPath)) {`
	`817`	`+ return "<internal:core> " + path.substring(coreLibrary.coreLoadPath.length() + 1);`
	`818`	`+ } else {`
	`819`	`+ return RubyContext.getPath(source);`
	`820`	`+ }`
	`821`	`+ }`
	`822`	`+`
`809`	`823`	`public String getPathRelativeToHome(String path) {`
`810`	`824`	`if (path.startsWith(rubyHome) && path.length() > rubyHome.length()) {`
`811`	`825`	`return path.substring(rubyHome.length() + 1);`
Original file line number	Diff line number	Diff line change
`@@ -301,7 +301,7 @@ protected RubyString getCallerPath(RubyString feature,`
`301`	`301`	`coreExceptions().loadError("cannot infer basepath", featureString, this));`
`302`	`302`	`}`
`303`	`303`
`304`		`- String sourcePath = RubyContext.getPath(sourceSection.getSource());`
	`304`	`+ String sourcePath = getContext().getSourcePath(sourceSection.getSource());`
`305`	`305`
`306`	`306`	`sourcePath = getContext().getFeatureLoader().canonicalize(sourcePath);`
`307`	`307`