Always use the line offset when reporting the line of a Source

eregon · eregon · commit 53e72539aa99 · 2023-05-26T15:51:13.000+02:00
* Fixes #3065
diff --git a/spec/ruby/core/binding/source_location_spec.rb b/spec/ruby/core/binding/source_location_spec.rb
@@ -6,4 +6,9 @@
     b = BindingSpecs::LocationMethod::TEST_BINDING
     b.source_location.should == [BindingSpecs::LocationMethod::FILE_PATH, 4]
   end
+
+  it "works for eval with a given line" do
+    b = eval('binding', nil, "foo", 100)
+    b.source_location.should == ["foo", 100]
+  end
 end
diff --git a/spec/ruby/core/method/source_location_spec.rb b/spec/ruby/core/method/source_location_spec.rb
@@ -104,6 +104,13 @@ def f
     end
   end
 
+  it "works for eval with a given line" do
+    c = Class.new do
+      eval('def self.m; end', nil, "foo", 100)
+    end
+    c.method(:m).source_location.should == ["foo", 100]
+  end
+
   describe "for a Method generated by respond_to_missing?" do
     it "returns nil" do
       m = MethodSpecs::Methods.new
diff --git a/spec/ruby/core/module/const_source_location_spec.rb b/spec/ruby/core/module/const_source_location_spec.rb
@@ -210,6 +210,13 @@
      ConstantSpecs.const_source_location(:CS_PRIVATE).should == [@constants_fixture_path, ConstantSpecs::CS_PRIVATE_LINE]
   end
 
+  it "works for eval with a given line" do
+    c = Class.new do
+      eval('self::C = 1', nil, "foo", 100)
+    end
+    c.const_source_location(:C).should == ["foo", 100]
+  end
+
   context 'autoload' do
     before :all do
       ConstantSpecs.autoload :CSL_CONST1, "#{__dir__}/notexisting.rb"
diff --git a/spec/ruby/core/proc/source_location_spec.rb b/spec/ruby/core/proc/source_location_spec.rb
@@ -83,4 +83,9 @@
 
     proc.source_location.should == nil
   end
+
+  it "works for eval with a given line" do
+    proc = eval('-> {}', nil, "foo", 100)
+    proc.source_location.should == ["foo", 100]
+  end
 end
diff --git a/spec/ruby/core/unboundmethod/source_location_spec.rb b/spec/ruby/core/unboundmethod/source_location_spec.rb
@@ -49,4 +49,11 @@
     method.source_location[0].should =~ /#{__FILE__}/
     method.source_location[1].should == line
   end
+
+  it "works for eval with a given line" do
+    c = Class.new do
+      eval('def m; end', nil, "foo", 100)
+    end
+    c.instance_method(:m).source_location.should == ["foo", 100]
+  end
 end
diff --git a/src/main/java/org/truffleruby/RubyLanguage.java b/src/main/java/org/truffleruby/RubyLanguage.java
@@ -44,6 +44,7 @@
 import org.truffleruby.core.array.RubyArray;
 import org.truffleruby.core.basicobject.RubyBasicObject;
 import org.truffleruby.core.binding.RubyBinding;
+import org.truffleruby.core.encoding.Encodings;
 import org.truffleruby.core.encoding.RubyEncoding;
 import org.truffleruby.core.encoding.RubyEncodingConverter;
 import org.truffleruby.core.exception.RubyException;
@@ -99,12 +100,13 @@
 import org.truffleruby.interop.RubyInnerContext;
 import org.truffleruby.interop.RubySourceLocation;
 import org.truffleruby.language.LexicalScope;
-import org.truffleruby.language.Nil;
+import org.truffleruby.language.RubyBaseNode;
 import org.truffleruby.language.RubyDynamicObject;
 import org.truffleruby.language.RubyEvalInteractiveRootNode;
 import org.truffleruby.language.RubyInlineParsingRequestNode;
 import org.truffleruby.language.RubyParsingRequestNode;
 import org.truffleruby.language.arguments.KeywordArgumentsDescriptorManager;
+import org.truffleruby.language.backtrace.BacktraceFormatter;
 import org.truffleruby.language.objects.RubyObjectType;
 import org.truffleruby.language.objects.classvariables.ClassVariableStorage;
 import org.truffleruby.language.threadlocal.SpecialVariableStorage;
@@ -134,6 +136,8 @@
 import com.oracle.truffle.api.utilities.CyclicAssumption;
 import org.truffleruby.stdlib.digest.RubyDigest;
 
+import static org.truffleruby.language.RubyBaseNode.nil;
+
 @TruffleLanguage.Registration(
         name = "Ruby",
         website = "https://www.graalvm.org/ruby/",
@@ -185,7 +189,7 @@ public final class RubyLanguage extends TruffleLanguage<RubyContext> {
     /** This is a truly empty frame descriptor and should only by dummy root nodes which require no variables. Any other
      * root nodes should should use
      * {@link TranslatorEnvironment#newFrameDescriptorBuilder(org.truffleruby.parser.ParentFrameDescriptor, boolean)}. */
-    public static final FrameDescriptor EMPTY_FRAME_DESCRIPTOR = new FrameDescriptor(Nil.INSTANCE);
+    public static final FrameDescriptor EMPTY_FRAME_DESCRIPTOR = new FrameDescriptor(nil);
 
     private RubyThread getOrCreateForeignThread(RubyContext context, Thread thread) {
         RubyThread foreignThread = rubyThreadInitMap.remove(thread);
@@ -842,6 +846,7 @@ public static String getPath(Source source) {
     /** {@link RubyLanguage#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 language. */
+    @TruffleBoundary
     public String getSourcePath(Source source) {
         final String path = getPath(source);
         if (path.startsWith(coreLoadPath)) {
@@ -906,6 +911,18 @@ public static String filenameLine(SourceSection section) {
         }
     }
 
+    public Object rubySourceLocation(RubyContext context, SourceSection section,
+            TruffleString.FromJavaStringNode fromJavaStringNode,
+            RubyBaseNode node) {
+        if (!BacktraceFormatter.isAvailable(section)) {
+            return nil;
+        } else {
+            var file = node.createString(fromJavaStringNode, getSourcePath(section.getSource()), Encodings.UTF_8);
+            Object[] objects = new Object[]{ file, RubySource.getStartLineAdjusted(context, section) };
+            return node.createArray(objects);
+        }
+    }
+
     public int getGlobalVariableIndex(String name) {
         return globalVariablesMap.lookup(name);
     }
diff --git a/src/main/java/org/truffleruby/cext/CExtNodes.java b/src/main/java/org/truffleruby/cext/CExtNodes.java
@@ -143,6 +143,7 @@
 import com.oracle.truffle.api.profiles.BranchProfile;
 import com.oracle.truffle.api.profiles.ConditionProfile;
 import com.oracle.truffle.api.source.SourceSection;
+import org.truffleruby.parser.RubySource;
 
 @CoreModule("Truffle::CExt")
 public class CExtNodes {
@@ -1180,7 +1181,7 @@ public abstract static class SourceLineNode extends CoreMethodArrayArgumentsNode
         @Specialization
         protected int sourceLine() {
             final SourceSection sourceSection = SourceFileNode.getTopUserSourceSection("rb_sourceline");
-            return sourceSection.getStartLine();
+            return RubySource.getStartLineAdjusted(getContext(), sourceSection);
         }
 
     }
diff --git a/src/main/java/org/truffleruby/core/binding/BindingNodes.java b/src/main/java/org/truffleruby/core/binding/BindingNodes.java
@@ -33,9 +33,7 @@
 import org.truffleruby.core.array.ArrayHelpers;
 import org.truffleruby.core.array.RubyArray;
 import org.truffleruby.core.cast.NameToJavaStringNode;
-import org.truffleruby.core.encoding.Encodings;
 import org.truffleruby.core.klass.RubyClass;
-import org.truffleruby.core.string.RubyString;
 import org.truffleruby.language.RubyBaseNode;
 import org.truffleruby.language.RubyBaseNodeWithExecute;
 import org.truffleruby.language.RubyNode;
@@ -533,24 +531,14 @@ protected Object receiver(RubyBinding binding) {
         }
     }
 
-    // NOTE: Introduced in Ruby 2.6, but already useful for Binding#eval
     @CoreMethod(names = "source_location")
     public abstract static class SourceLocationNode extends CoreMethodArrayArgumentsNode {
 
-        @TruffleBoundary
         @Specialization
         protected Object sourceLocation(RubyBinding binding,
                 @Cached TruffleString.FromJavaStringNode fromJavaStringNode) {
-            final SourceSection sourceSection = binding.sourceSection;
-
-            if (sourceSection == null) {
-                return nil;
-            } else {
-                final RubyString file = createString(fromJavaStringNode,
-                        getLanguage().getSourcePath(sourceSection.getSource()),
-                        Encodings.UTF_8);
-                return createArray(new Object[]{ file, sourceSection.getStartLine() });
-            }
+            var sourceSection = binding.sourceSection;
+            return getLanguage().rubySourceLocation(getContext(), sourceSection, fromJavaStringNode, this);
         }
     }
 
diff --git a/src/main/java/org/truffleruby/core/method/MethodNodes.java b/src/main/java/org/truffleruby/core/method/MethodNodes.java
@@ -20,7 +20,6 @@
 import org.truffleruby.core.Hashing;
 import org.truffleruby.core.array.RubyArray;
 import org.truffleruby.core.basicobject.BasicObjectNodes.ReferenceEqualNode;
-import org.truffleruby.core.encoding.Encodings;
 import org.truffleruby.core.inlined.AlwaysInlinedMethodNode;
 import org.truffleruby.core.klass.RubyClass;
 import org.truffleruby.core.module.MethodLookupResult;
@@ -30,7 +29,6 @@
 import org.truffleruby.core.proc.ProcOperations;
 import org.truffleruby.core.proc.ProcType;
 import org.truffleruby.core.proc.RubyProc;
-import org.truffleruby.core.string.RubyString;
 import org.truffleruby.core.symbol.RubySymbol;
 import org.truffleruby.language.RubyContextSourceNode;
 import org.truffleruby.language.RubyLambdaRootNode;
@@ -56,7 +54,6 @@
 import com.oracle.truffle.api.dsl.Specialization;
 import com.oracle.truffle.api.frame.MaterializedFrame;
 import com.oracle.truffle.api.frame.VirtualFrame;
-import com.oracle.truffle.api.source.SourceSection;
 
 @CoreModule(value = "Method", isClass = true)
 public abstract class MethodNodes {
@@ -229,30 +226,17 @@ public abstract static class ReceiverNode extends CoreMethodArrayArgumentsNode {
         protected Object receiver(RubyMethod method) {
             return method.receiver;
         }
-
     }
 
     @CoreMethod(names = "source_location")
     public abstract static class SourceLocationNode extends CoreMethodArrayArgumentsNode {
 
-        @Child private TruffleString.FromJavaStringNode fromJavaStringNode = TruffleString.FromJavaStringNode.create();
-
-        @TruffleBoundary
         @Specialization
-        protected Object sourceLocation(RubyMethod method) {
-            SourceSection sourceSection = method.method.getSharedMethodInfo().getSourceSection();
-
-            if (!sourceSection.isAvailable()) {
-                return nil;
-            } else {
-                RubyString file = createString(
-                        fromJavaStringNode,
-                        getLanguage().getSourcePath(sourceSection.getSource()),
-                        Encodings.UTF_8);
-                return createArray(new Object[]{ file, sourceSection.getStartLine() });
-            }
+        protected Object sourceLocation(RubyMethod method,
+                @Cached TruffleString.FromJavaStringNode fromJavaStringNode) {
+            var sourceSection = method.method.getSharedMethodInfo().getSourceSection();
+            return getLanguage().rubySourceLocation(getContext(), sourceSection, fromJavaStringNode, this);
         }
-
     }
 
     @CoreMethod(names = "super_method")
diff --git a/src/main/java/org/truffleruby/core/method/UnboundMethodNodes.java b/src/main/java/org/truffleruby/core/method/UnboundMethodNodes.java
@@ -21,12 +21,10 @@
 import org.truffleruby.core.Hashing;
 import org.truffleruby.core.array.RubyArray;
 import org.truffleruby.core.cast.ToSymbolNode;
-import org.truffleruby.core.encoding.Encodings;
 import org.truffleruby.core.klass.RubyClass;
 import org.truffleruby.core.module.MethodLookupResult;
 import org.truffleruby.core.module.ModuleOperations;
 import org.truffleruby.core.module.RubyModule;
-import org.truffleruby.core.string.RubyString;
 import org.truffleruby.core.symbol.RubySymbol;
 import org.truffleruby.language.RubyGuards;
 import org.truffleruby.annotations.Visibility;
@@ -45,7 +43,6 @@
 import com.oracle.truffle.api.CompilerDirectives.TruffleBoundary;
 import com.oracle.truffle.api.dsl.Cached;
 import com.oracle.truffle.api.dsl.Specialization;
-import com.oracle.truffle.api.source.SourceSection;
 
 @CoreModule(value = "UnboundMethod", isClass = true)
 public abstract class UnboundMethodNodes {
@@ -210,27 +207,12 @@ protected RubyArray parameters(RubyUnboundMethod method) {
     @CoreMethod(names = "source_location")
     public abstract static class SourceLocationNode extends CoreMethodArrayArgumentsNode {
 
-        @Child private TruffleString.FromJavaStringNode fromJavaStringNode = TruffleString.FromJavaStringNode.create();
-
-        @TruffleBoundary
         @Specialization
-        protected Object sourceLocation(RubyUnboundMethod unboundMethod) {
-            SourceSection sourceSection = unboundMethod.method
-                    .getSharedMethodInfo()
-                    .getSourceSection();
-
-            if (!sourceSection.isAvailable()) {
-                return nil;
-            } else {
-                RubyString file = createString(
-                        fromJavaStringNode,
-                        getLanguage().getSourcePath(sourceSection.getSource()),
-                        Encodings.UTF_8);
-                Object[] objects = new Object[]{ file, sourceSection.getStartLine() };
-                return createArray(objects);
-            }
+        protected Object sourceLocation(RubyUnboundMethod unboundMethod,
+                @Cached TruffleString.FromJavaStringNode fromJavaStringNode) {
+            var sourceSection = unboundMethod.method.getSharedMethodInfo().getSourceSection();
+            return getLanguage().rubySourceLocation(getContext(), sourceSection, fromJavaStringNode, this);
         }
-
     }
 
     @CoreMethod(names = "super_method")
diff --git a/src/main/java/org/truffleruby/core/module/ModuleNodes.java b/src/main/java/org/truffleruby/core/module/ModuleNodes.java
@@ -1253,11 +1253,7 @@ private Object getLocation(ConstantLookupResult lookupResult) {
             if (!BacktraceFormatter.isAvailable(sourceSection)) {
                 return createEmptyArray();
             } else {
-                final RubyString file = createString(
-                        fromJavaStringNode,
-                        getLanguage().getSourcePath(sourceSection.getSource()),
-                        Encodings.UTF_8);
-                return createArray(new Object[]{ file, sourceSection.getStartLine() });
+                return getLanguage().rubySourceLocation(getContext(), sourceSection, fromJavaStringNode, this);
             }
         }
 
diff --git a/src/main/java/org/truffleruby/core/proc/ProcNodes.java b/src/main/java/org/truffleruby/core/proc/ProcNodes.java
@@ -15,6 +15,7 @@
 import com.oracle.truffle.api.frame.Frame;
 import com.oracle.truffle.api.profiles.InlinedConditionProfile;
 import com.oracle.truffle.api.strings.TruffleString;
+import org.truffleruby.RubyLanguage;
 import org.truffleruby.annotations.CoreMethod;
 import org.truffleruby.builtins.CoreMethodArrayArgumentsNode;
 import org.truffleruby.annotations.CoreModule;
@@ -24,11 +25,9 @@
 import org.truffleruby.core.array.RubyArray;
 import org.truffleruby.core.binding.BindingNodes;
 import org.truffleruby.core.binding.RubyBinding;
-import org.truffleruby.core.encoding.Encodings;
 import org.truffleruby.core.inlined.AlwaysInlinedMethodNode;
 import org.truffleruby.core.klass.RubyClass;
 import org.truffleruby.core.method.UnboundMethodNodes.MethodRuby2KeywordsNode;
-import org.truffleruby.core.string.RubyString;
 import org.truffleruby.core.symbol.SymbolNodes;
 import org.truffleruby.language.Nil;
 import org.truffleruby.annotations.Visibility;
@@ -226,18 +225,13 @@ public abstract static class SourceLocationNode extends CoreMethodArrayArguments
         @TruffleBoundary
         @Specialization
         protected Object sourceLocation(RubyProc proc) {
-            SourceSection sourceSection = proc.getSharedMethodInfo().getSourceSection();
+            var sourceSection = proc.getSharedMethodInfo().getSourceSection();
 
-            final String sourcePath = getLanguage().getSourcePath(sourceSection.getSource());
-            if (!sourceSection.isAvailable() || sourcePath.endsWith("/lib/truffle/truffle/cext.rb")) {
+            var source = sourceSection.getSource();
+            if (!sourceSection.isAvailable() || RubyLanguage.getPath(source).endsWith("/lib/truffle/truffle/cext.rb")) {
                 return nil;
             } else {
-                final RubyString file = createString(
-                        fromJavaStringNode,
-                        sourcePath,
-                        Encodings.UTF_8);
-
-                return createArray(new Object[]{ file, sourceSection.getStartLine() });
+                return getLanguage().rubySourceLocation(getContext(), sourceSection, fromJavaStringNode, this);
             }
         }
 
diff --git a/src/main/java/org/truffleruby/core/thread/ThreadBacktraceLocationNodes.java b/src/main/java/org/truffleruby/core/thread/ThreadBacktraceLocationNodes.java
@@ -27,6 +27,7 @@
 import com.oracle.truffle.api.source.Source;
 import com.oracle.truffle.api.source.SourceSection;
 import org.truffleruby.language.backtrace.BacktraceFormatter;
+import org.truffleruby.parser.RubySource;
 
 @CoreModule(value = "Thread::Backtrace::Location", isClass = true)
 public class ThreadBacktraceLocationNodes {
@@ -134,7 +135,7 @@ public abstract static class LinenoNode extends CoreMethodArrayArgumentsNode {
         protected int lineno(RubyBacktraceLocation threadBacktraceLocation) {
             final SourceSection sourceSection = getAvailableSourceSection(getContext(), threadBacktraceLocation);
 
-            return sourceSection.getStartLine();
+            return RubySource.getStartLineAdjusted(getContext(), sourceSection);
         }
 
     }
diff --git a/src/main/java/org/truffleruby/core/tracepoint/TraceBaseEventNode.java b/src/main/java/org/truffleruby/core/tracepoint/TraceBaseEventNode.java
@@ -21,6 +21,7 @@
 import com.oracle.truffle.api.instrumentation.EventContext;
 import com.oracle.truffle.api.instrumentation.ExecutionEventNode;
 import com.oracle.truffle.api.source.Source;
+import org.truffleruby.parser.RubySource;
 
 public class TraceBaseEventNode extends ExecutionEventNode {
 
@@ -52,7 +53,7 @@ protected RubyString getFile() {
     protected int getLine() {
         if (line == 0) {
             CompilerDirectives.transferToInterpreterAndInvalidate();
-            line = eventContext.getInstrumentedSourceSection().getStartLine();
+            line = RubySource.getStartLineAdjusted(context, eventContext.getInstrumentedSourceSection());
         }
         return line;
     }
diff --git a/src/main/java/org/truffleruby/language/RubyBaseNode.java b/src/main/java/org/truffleruby/language/RubyBaseNode.java
diff --git a/src/main/java/org/truffleruby/language/backtrace/BacktraceFormatter.java b/src/main/java/org/truffleruby/language/backtrace/BacktraceFormatter.java
diff --git a/src/main/java/org/truffleruby/language/methods/SharedMethodInfo.java b/src/main/java/org/truffleruby/language/methods/SharedMethodInfo.java
diff --git a/src/main/java/org/truffleruby/parser/RubySource.java b/src/main/java/org/truffleruby/parser/RubySource.java
diff --git a/src/main/java/org/truffleruby/stdlib/ObjSpaceNodes.java b/src/main/java/org/truffleruby/stdlib/ObjSpaceNodes.java

Original file line number	Diff line number	Diff line change
`@@ -143,6 +143,7 @@`
`143`	`143`	`import com.oracle.truffle.api.profiles.BranchProfile;`
`144`	`144`	`import com.oracle.truffle.api.profiles.ConditionProfile;`
`145`	`145`	`import com.oracle.truffle.api.source.SourceSection;`
	`146`	`+import org.truffleruby.parser.RubySource;`
`146`	`147`
`147`	`148`	`@CoreModule("Truffle::CExt")`
`148`	`149`	`public class CExtNodes {`
`@@ -1180,7 +1181,7 @@ public abstract static class SourceLineNode extends CoreMethodArrayArgumentsNode`
`1180`	`1181`	`@Specialization`
`1181`	`1182`	`protected int sourceLine() {`
`1182`	`1183`	`final SourceSection sourceSection = SourceFileNode.getTopUserSourceSection("rb_sourceline");`
`1183`		`- return sourceSection.getStartLine();`
	`1184`	`+ return RubySource.getStartLineAdjusted(getContext(), sourceSection);`
`1184`	`1185`	`}`
`1185`	`1186`
`1186`	`1187`	`}`