Implement -W warning category options

bjfish · eregon · commit 436518f08056 · 2020-12-07T13:06:43.000+01:00
(cherry picked from commit 1042db1)
diff --git a/spec/tags/command_line/dash_upper_w_tags.txt b/spec/tags/command_line/dash_upper_w_tags.txt
@@ -3,5 +3,4 @@ slow:The -W command line option with 1 sets $VERBOSE to false
 slow:The -W command line option with 2 sets $VERBOSE to true
 slow:The -W command line option with :no-deprecated suppresses deprecation warnings
 slow:The -W command line option with :no-experimental suppresses experimental warnings
-fails:The -W command line option with :no-deprecated suppresses deprecation warnings
 fails:The -W command line option with :no-experimental suppresses experimental warnings
diff --git a/spec/tags/core/warning/element_set_tags.txt b/spec/tags/core/warning/element_set_tags.txt
@@ -1,6 +1,5 @@
 slow:Warning.[]= emits and suppresses warnings for :deprecated
 slow:Warning.[]= emits and suppresses warnings for :experimental
-fails:Warning.[]= emits and suppresses warnings for :deprecated
 fails:Warning.[]= emits and suppresses warnings for :experimental
 slow:Warning.[]= :experimental emits and suppresses warnings for :experimental
 fails:Warning.[]= :experimental emits and suppresses warnings for :experimental
diff --git a/spec/tags/language/predefined_tags.txt b/spec/tags/language/predefined_tags.txt
@@ -6,8 +6,6 @@ slow:The predefined global constant ARGV contains Strings encoded in locale Enco
 slow:Global variable $0 is the path given as the main script and the same as __FILE__
 slow:Global variable $? is thread-local
 slow:Global variable $0 actually sets the program name
-fails:Predefined global $, warns if assigned non-nil
-fails:Predefined global $; warns if assigned non-nil
 fails:$LOAD_PATH.resolve_feature_path returns what will be loaded without actual loading, .rb file
 fails:$LOAD_PATH.resolve_feature_path returns what will be loaded without actual loading, .so file
 fails:$LOAD_PATH.resolve_feature_path raises LoadError if feature cannot be found
diff --git a/src/launcher/java/org/truffleruby/launcher/CommandLineParser.java b/src/launcher/java/org/truffleruby/launcher/CommandLineParser.java
@@ -340,26 +340,46 @@ private void processArgument() throws CommandLineException {
                     break;
                 case 'w':
                     config.setOption(OptionsCatalog.VERBOSITY, Verbosity.TRUE);
+                    setAllWarningCategories(true);
                     break;
                 case 'W': {
                     String temp = grabOptionalValue();
                     if (temp == null) {
-                        config.setOption(OptionsCatalog.VERBOSITY, Verbosity.TRUE);
+                        temp = "2";
+                    }
+                    if (temp.startsWith(":")) {
+                        switch (temp) {
+                            case ":deprecated":
+                                config.setOption(OptionsCatalog.WARN_DEPRECATED, true);
+                                break;
+                            case ":no-deprecated":
+                                config.setOption(OptionsCatalog.WARN_DEPRECATED, false);
+                                break;
+                            case ":experimental":
+                                config.setOption(OptionsCatalog.WARN_EXPERIMENTAL, true);
+                                break;
+                            case ":no-experimental":
+                                config.setOption(OptionsCatalog.WARN_EXPERIMENTAL, false);
+                                break;
+                            default:
+                                LOGGER.warning("unknown warning category: `" + temp.substring(1) + "'");
+                                break;
+                        }
                     } else {
                         switch (temp) {
                             case "0":
                                 config.setOption(OptionsCatalog.VERBOSITY, Verbosity.NIL);
-                                break;
-                            case "1":
-                                config.setOption(OptionsCatalog.VERBOSITY, Verbosity.FALSE);
+                                setAllWarningCategories(false);
                                 break;
                             case "2":
                                 config.setOption(OptionsCatalog.VERBOSITY, Verbosity.TRUE);
+                                setAllWarningCategories(true);
                                 break;
+                            case "1":
                             default:
-                                throw new CommandLineException(
-                                        getArgumentError(" -W must be followed by either 0, 1, 2 or nothing"),
-                                        true);
+                                config.setOption(OptionsCatalog.VERBOSITY, Verbosity.FALSE);
+                                config.setOption(OptionsCatalog.WARN_DEPRECATED, false);
+                                break;
                         }
                     }
                     break FOR;
@@ -466,6 +486,11 @@ private void processArgument() throws CommandLineException {
         }
     }
 
+    private void setAllWarningCategories(boolean value) {
+        config.setOption(OptionsCatalog.WARN_DEPRECATED, value);
+        config.setOption(OptionsCatalog.WARN_EXPERIMENTAL, value);
+    }
+
     private void enableDisableFeature(String name, boolean enable) {
         final BiConsumer<CommandLineParser, Boolean> feature = FEATURES.get(name);
 
diff --git a/src/main/java/org/truffleruby/RubyContext.java b/src/main/java/org/truffleruby/RubyContext.java
@@ -82,7 +82,6 @@
 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;
 
@@ -177,8 +176,8 @@ 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);
+        warningCategoryDeprecated = new AssumedValue<>(options.WARN_DEPRECATED);
+        warningCategoryExperimental = new AssumedValue<>(options.WARN_EXPERIMENTAL);
 
         safepointManager = new SafepointManager(this, language);
         coreExceptions = new CoreExceptions(this, language);
@@ -294,6 +293,12 @@ protected boolean patch(Env newEnv) {
             return false;
         }
         this.options = newOptions;
+        if (newOptions.WARN_DEPRECATED != oldOptions.WARN_DEPRECATED) {
+            warningCategoryDeprecated.set(newOptions.WARN_DEPRECATED);
+        }
+        if (newOptions.WARN_EXPERIMENTAL != oldOptions.WARN_EXPERIMENTAL) {
+            warningCategoryExperimental.set(newOptions.WARN_EXPERIMENTAL);
+        }
         this.rubyHome = newHome;
         this.rubyHomeTruffleFile = newHome == null ? null : newEnv.getInternalTruffleFile(newHome);
 
diff --git a/src/main/java/org/truffleruby/options/Options.java b/src/main/java/org/truffleruby/options/Options.java
@@ -121,6 +121,10 @@ public class Options {
     public final boolean CEXTS_LOG_LOAD;
     /** --cexts-log-warnings=false */
     public final boolean CEXTS_LOG_WARNINGS;
+    /** --warn-deprecated=false */
+    public final boolean WARN_DEPRECATED;
+    /** --warn-experimental=true */
+    public final boolean WARN_EXPERIMENTAL;
     /** --argv-globals=false */
     public final boolean ARGV_GLOBALS;
     /** --chomp-loop=false */
@@ -300,6 +304,8 @@ public Options(Env env, OptionValues options, LanguageOptions languageOptions) {
         METRICS_PROFILE_REQUIRE = options.get(OptionsCatalog.METRICS_PROFILE_REQUIRE_KEY);
         CEXTS_LOG_LOAD = options.get(OptionsCatalog.CEXTS_LOG_LOAD_KEY);
         CEXTS_LOG_WARNINGS = options.get(OptionsCatalog.CEXTS_LOG_WARNINGS_KEY);
+        WARN_DEPRECATED = options.get(OptionsCatalog.WARN_DEPRECATED_KEY);
+        WARN_EXPERIMENTAL = options.get(OptionsCatalog.WARN_EXPERIMENTAL_KEY);
         ARGV_GLOBALS = options.get(OptionsCatalog.ARGV_GLOBALS_KEY);
         CHOMP_LOOP = options.get(OptionsCatalog.CHOMP_LOOP_KEY);
         GETS_LOOP = options.get(OptionsCatalog.GETS_LOOP_KEY);
@@ -466,6 +472,10 @@ public Object fromDescriptor(OptionDescriptor descriptor) {
                 return CEXTS_LOG_LOAD;
             case "ruby.cexts-log-warnings":
                 return CEXTS_LOG_WARNINGS;
+            case "ruby.warn-deprecated":
+                return WARN_DEPRECATED;
+            case "ruby.warn-experimental":
+                return WARN_EXPERIMENTAL;
             case "ruby.argv-globals":
                 return ARGV_GLOBALS;
             case "ruby.chomp-loop":
diff --git a/src/main/ruby/truffleruby/core/truffle/kernel_operations.rb b/src/main/ruby/truffleruby/core/truffle/kernel_operations.rb
@@ -78,9 +78,25 @@ def self.define_read_only_global(name, getter)
         if v && !Primitive.object_kind_of?(v, String)
           raise TypeError, '$, must be a String'
         end
+        warn "`$,' is deprecated", uplevel: 1 if !Primitive.nil?(v) && Warning[:deprecated]
         Primitive.global_variable_set :$,, v
       })
 
+    define_read_only_global(:'$-W',
+      -> {
+        case $VERBOSE
+        when nil
+          0
+        when false
+          1
+        when true
+          2
+        else
+          nil
+        end
+      })
+
+
     $, = nil # It should be defined by the time boot has finished.
 
     $= = false
@@ -127,6 +143,14 @@ def self.define_read_only_global(name, getter)
         Primitive.global_variable_set :$stderr, v
       })
 
+    define_hooked_variable(
+      :"$;",
+      -> { Primitive.global_variable_get :"$;" },
+      -> v {
+        warn "`$;' is deprecated", uplevel: 1 if !Primitive.nil?(v) && Warning[:deprecated]
+        Primitive.global_variable_set :"$;", v
+      })
+
     def self.load_error(name)
       load_error = LoadError.new("cannot load such file -- #{name}")
       load_error.path = name
diff --git a/src/options.yml b/src/options.yml
@@ -91,6 +91,9 @@ EXPERT:
     CEXTS_LOG_LOAD: [cexts-log-load, boolean, false, Log loading of cexts]
     CEXTS_LOG_WARNINGS: [cexts-log-warnings, boolean, false, Log cexts warnings]
 
+    WARN_DEPRECATED: [[warn-deprecated, -W], boolean, false, 'Sets deprecated Warning category']
+    WARN_EXPERIMENTAL: [[warn-experimental, -W], boolean, true, 'Sets experimental Warning category']
+
 INTERNAL: # Options for debugging the TruffleRuby implementation
   EXPERIMENTAL:
     # Options corresponding to MRI options, which are only meaningful when using the TruffleRuby launcher
diff --git a/src/shared/java/org/truffleruby/shared/options/OptionsCatalog.java b/src/shared/java/org/truffleruby/shared/options/OptionsCatalog.java
@@ -73,6 +73,8 @@ public class OptionsCatalog {
     public static final OptionKey<Profile> METRICS_PROFILE_REQUIRE_KEY = new OptionKey<>(Profile.NONE, EnumOptionType.optionTypeFor(Profile.class));
     public static final OptionKey<Boolean> CEXTS_LOG_LOAD_KEY = new OptionKey<>(false);
     public static final OptionKey<Boolean> CEXTS_LOG_WARNINGS_KEY = new OptionKey<>(false);
+    public static final OptionKey<Boolean> WARN_DEPRECATED_KEY = new OptionKey<>(false);
+    public static final OptionKey<Boolean> WARN_EXPERIMENTAL_KEY = new OptionKey<>(true);
     public static final OptionKey<Boolean> ARGV_GLOBALS_KEY = new OptionKey<>(false);
     public static final OptionKey<Boolean> CHOMP_LOOP_KEY = new OptionKey<>(false);
     public static final OptionKey<Boolean> GETS_LOOP_KEY = new OptionKey<>(false);
@@ -519,6 +521,20 @@ public class OptionsCatalog {
             .stability(OptionStability.EXPERIMENTAL)
             .build();
 
+    public static final OptionDescriptor WARN_DEPRECATED = OptionDescriptor
+            .newBuilder(WARN_DEPRECATED_KEY, "ruby.warn-deprecated")
+            .help("Sets deprecated Warning category (configured by the -W Ruby option)")
+            .category(OptionCategory.EXPERT)
+            .stability(OptionStability.EXPERIMENTAL)
+            .build();
+
+    public static final OptionDescriptor WARN_EXPERIMENTAL = OptionDescriptor
+            .newBuilder(WARN_EXPERIMENTAL_KEY, "ruby.warn-experimental")
+            .help("Sets experimental Warning category (configured by the -W Ruby option)")
+            .category(OptionCategory.EXPERT)
+            .stability(OptionStability.EXPERIMENTAL)
+            .build();
+
     public static final OptionDescriptor ARGV_GLOBALS = OptionDescriptor
             .newBuilder(ARGV_GLOBALS_KEY, "ruby.argv-globals")
             .help("Parse options in script argv into global variables (configured by the -s Ruby option)")
@@ -1145,6 +1161,10 @@ public static OptionDescriptor fromName(String name) {
                 return CEXTS_LOG_LOAD;
             case "ruby.cexts-log-warnings":
                 return CEXTS_LOG_WARNINGS;
+            case "ruby.warn-deprecated":
+                return WARN_DEPRECATED;
+            case "ruby.warn-experimental":
+                return WARN_EXPERIMENTAL;
             case "ruby.argv-globals":
                 return ARGV_GLOBALS;
             case "ruby.chomp-loop":
@@ -1353,6 +1373,8 @@ public static OptionDescriptor[] allDescriptors() {
             METRICS_PROFILE_REQUIRE,
             CEXTS_LOG_LOAD,
             CEXTS_LOG_WARNINGS,
+            WARN_DEPRECATED,
+            WARN_EXPERIMENTAL,
             ARGV_GLOBALS,
             CHOMP_LOOP,
             GETS_LOOP,
diff --git a/test/mri/excludes/TestRubyOptions.rb b/test/mri/excludes/TestRubyOptions.rb
@@ -34,8 +34,13 @@
 exclude :test_usage_long, "needs investigation"
 exclude :test_verbose, "needs investigation"
 exclude :test_version, "needs investigation"
-exclude :test_warning, "needs investigation"
 exclude :test_yydebug, "needs investigation"
 exclude :test_segv_loaded_features, "needs investigation"
 exclude :test_segv_setproctitle, "needs investigation"
 exclude :test_segv_test, "needs investigation"
+exclude :test_assignment_in_conditional, "needs investigation"
+exclude :test_cwd_encoding, "needs investigation"
+exclude :test_disable, "needs investigation"
+exclude :test_flag_in_shebang, "needs investigation"
+exclude :test_frozen_string_literal, "needs investigation"
+exclude :test_jit_debug, "needs investigation"
diff --git a/test/mri/failing.exclude b/test/mri/failing.exclude
@@ -30,7 +30,6 @@ win32ole/test_word.rb
 
 # Failing since upgrade to 2.6.1
 
-ruby/test_rubyoptions.rb # uses RubyVM
 test_pp.rb # uses RubyVM
 ruby/test_time_tz.rb
 monitor/test_monitor.rb # hangs
diff --git a/test/mri/tests/ruby/test_rubyoptions.rb b/test/mri/tests/ruby/test_rubyoptions.rb
@@ -8,7 +8,7 @@
 
 class TestRubyOptions < Test::Unit::TestCase
   NO_JIT_DESCRIPTION =
-    if RubyVM::MJIT.enabled? # checking -DMJIT_FORCE_ENABLE
+    if defined?(RubyVM::MJIT) && RubyVM::MJIT.enabled? # checking -DMJIT_FORCE_ENABLE
       RUBY_DESCRIPTION.sub(/\+JIT /, '')
     else
       RUBY_DESCRIPTION
