[GR-20446] Capturing proc warning for deprecated

PullRequest: truffleruby/2188

Author: bjfish

src/main/java/org/truffleruby/RubyContext.java

@@ -26,6 +26,7 @@
 import com.oracle.truffle.api.RootCallTarget;
 import com.oracle.truffle.api.nodes.EncapsulatingNodeReference;
 import com.oracle.truffle.api.nodes.Node;
+import com.oracle.truffle.api.utilities.AssumedValue;
 import org.graalvm.collections.Pair;
 import org.graalvm.options.OptionDescriptor;
 import org.joni.Regex;
@@ -81,6 +82,7 @@
 import org.truffleruby.shared.TruffleRuby;
 import org.truffleruby.shared.options.OptionsCatalog;
 import org.truffleruby.shared.options.RubyOptionTypes;
+import org.truffleruby.shared.options.Verbosity;
 import org.truffleruby.stdlib.CoverageManager;
 import org.truffleruby.stdlib.readline.ConsoleHolder;
 
@@ -150,6 +152,9 @@ public class RubyContext {
     private boolean initialized;
     private volatile boolean finalizing;
 
+    private final AssumedValue<Boolean> warningCategoryDeprecated;
+    private final AssumedValue<Boolean> warningCategoryExperimental;
+
     private static boolean preInitializeContexts = TruffleRuby.PRE_INITIALIZE_CONTEXTS;
 
     private static boolean isPreInitializingContext() {
@@ -172,6 +177,9 @@ public RubyContext(RubyLanguage language, TruffleLanguage.Env env) {
 
         options = createOptions(env, language.options);
 
+        warningCategoryDeprecated = new AssumedValue<>(options.VERBOSITY == Verbosity.TRUE);
+        warningCategoryExperimental = new AssumedValue<>(options.VERBOSITY != Verbosity.NIL);
+
         safepointManager = new SafepointManager(this, language);
         coreExceptions = new CoreExceptions(this, language);
         encodingManager = new EncodingManager(this, language);
@@ -814,6 +822,14 @@ public Object getTopScopeObject() {
         return coreLibrary.topScopeObject;
     }
 
+    public AssumedValue<Boolean> getWarningCategoryDeprecated() {
+        return warningCategoryDeprecated;
+    }
+
+    public AssumedValue<Boolean> getWarningCategoryExperimental() {
+        return warningCategoryExperimental;
+    }
+
     @TruffleBoundary
     public static String fileLine(SourceSection section) {
         if (section == null) {

src/main/java/org/truffleruby/core/kernel/KernelNodes.java

@@ -21,6 +21,7 @@
 import java.util.concurrent.TimeUnit;
 
 import com.oracle.truffle.api.dsl.CachedContext;
+import com.oracle.truffle.api.utilities.AssumedValue;
 import org.jcodings.specific.UTF8Encoding;
 import org.truffleruby.RubyContext;
 import org.truffleruby.RubyLanguage;
@@ -2104,4 +2105,42 @@ protected Object untrust(Object object,
 
     }
 
+    @Primitive(name = "warning_get_category")
+    public abstract static class WarningGetCategoryNode extends PrimitiveArrayArgumentsNode {
+
+        @Specialization(guards = "category == coreSymbols().DEPRECATED")
+        protected boolean getCategoryDeprecated(RubySymbol category) {
+            return getContext().getWarningCategoryDeprecated().get();
+        }
+
+        @Specialization(guards = "category == coreSymbols().EXPERIMENTAL")
+        protected boolean getCategoryExperimental(RubySymbol category) {
+            return getContext().getWarningCategoryExperimental().get();
+        }
+
+    }
+
+    @Primitive(name = "warning_set_category")
+    public abstract static class WarningSetCategoryNode extends PrimitiveArrayArgumentsNode {
+
+        @TruffleBoundary
+        @Specialization
+        protected boolean setCategory(RubySymbol category, boolean newValue) {
+            final AssumedValue<Boolean> existingValue;
+            if (category == coreSymbols().DEPRECATED) {
+                existingValue = getContext().getWarningCategoryDeprecated();
+            } else if (category == coreSymbols().EXPERIMENTAL) {
+                existingValue = getContext().getWarningCategoryExperimental();
+            } else {
+                throw CompilerDirectives.shouldNotReachHere("unexpected warning category");
+            }
+
+            if (existingValue.get() != newValue) {
+                existingValue.set(newValue);
+            }
+            return newValue;
+        }
+
+    }
+
 }

src/main/java/org/truffleruby/core/proc/ProcNodes.java

@@ -82,7 +82,7 @@ protected RubyProc proc(VirtualFrame frame, RubyClass procClass, Object[] args,
             if (parentBlock == nil) {
                 throw new RaiseException(getContext(), coreExceptions().argumentErrorProcWithoutBlock(this));
             } else {
-                if (warnNode.shouldWarn()) {
+                if (warnNode.shouldWarnForDeprecation()) {
                     warnNode.warningMessage(
                             getContext().getCallStack().getTopMostUserSourceSection(),
                             "Capturing the given block using Kernel#proc is deprecated; use `&block` instead");

src/main/java/org/truffleruby/core/symbol/CoreSymbols.java

@@ -36,6 +36,8 @@ public class CoreSymbols {
     public final RubySymbol LINE = createRubySymbol("line");
     public final RubySymbol NEVER = createRubySymbol("never");
     public final RubySymbol ON_BLOCKING = createRubySymbol("on_blocking");
+    public final RubySymbol DEPRECATED = createRubySymbol("deprecated");
+    public final RubySymbol EXPERIMENTAL = createRubySymbol("experimental");
 
     public static final int FIRST_OP_ID = 33;
 

src/main/java/org/truffleruby/language/WarnNode.java

@@ -36,8 +36,13 @@ public boolean shouldWarn() {
         return verbosity != nil;
     }
 
-    /** Must only be called if {@link #shouldWarn()} is true, in order to avoid computing a SourceSection and message if
-     * not needed. */
+    public boolean shouldWarnForDeprecation() {
+        final Object verbosity = readVerboseNode.execute();
+        return verbosity != nil && getContext().getWarningCategoryDeprecated().get();
+    }
+
+    /** Must only be called if {@link #shouldWarn()} or {@link #shouldWarnForDeprecation()} is true, in order to avoid
+     * computing a SourceSection and message if not needed. */
     public void warningMessage(SourceSection sourceSection, String message) {
         assert shouldWarn();
         callWarn(sourceSection, message);

src/main/ruby/truffleruby/core/warning.rb

@@ -22,15 +22,12 @@ def warn(message)
     nil
   end
 
-  @deprecated = false
-  @experimental = true
-
   def self.[](category)
     case category
     when :deprecated
-      @deprecated
+      Primitive.warning_get_category(:deprecated)
     when :experimental
-      @experimental
+      Primitive.warning_get_category(:experimental)
     else
       raise ArgumentError, "unknown category: #{category}"
     end
@@ -39,9 +36,9 @@ def self.[](category)
   def self.[]=(category, value)
     case category
     when :deprecated
-      @deprecated = !!value
+      Primitive.warning_set_category(:deprecated, !!value)
     when :experimental
-      @experimental = !!value
+      Primitive.warning_set_category(:experimental, !!value)
     else
       raise ArgumentError, "unknown category: #{category}"
     end

tool/generate-core-symbols.rb

@@ -53,6 +53,8 @@
     public final RubySymbol LINE = createRubySymbol("line");
     public final RubySymbol NEVER = createRubySymbol("never");
     public final RubySymbol ON_BLOCKING = createRubySymbol("on_blocking");
+    public final RubySymbol DEPRECATED = createRubySymbol("deprecated");
+    public final RubySymbol EXPERIMENTAL = createRubySymbol("experimental");
 
 JAVA
 lines = []