Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
   * Version: EPL 1.0/GPL 2.0/LGPL 2.1
   * The contents of this file are subject to the Eclipse Public
   * License Version 1.0 (the "License"); you may not use this file
   * except in compliance with the License. You may obtain a copy of
   * the License at
  * Software distributed under the License is distributed on an "AS
  * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
  * implied. See the License for the specific language governing
  * rights and limitations under the License.
  * Copyright (C) 2001-2011 The JRuby Community (and contribs)
  * Alternatively, the contents of this file may be used under the terms of
  * either of the GNU General Public License Version 2 or later (the "GPL"),
  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  * in which case the provisions of the GPL or the LGPL are applicable instead
  * of those above. If you wish to allow use of your version of this file only
  * under the terms of either the GPL or the LGPL, and not to allow others to
  * use your version of this file under the terms of the EPL, indicate your
  * decision by deleting the provisions above and replace them with the notice
  * and other provisions required by the GPL or the LGPL. If you do not delete
  * the provisions above, a recipient may use your version of this file under
  * the terms of any one of the EPL, the GPL or the LGPL.
  ***** END LICENSE BLOCK *****/
 package org.jruby.util.cli;
 import java.util.List;
 import static org.jruby.util.cli.Category.*;
 import static org.jruby.RubyInstanceConfig.Verbosity;
 import static org.jruby.RubyInstanceConfig.ProfilingMode;

Options defines all configuration settings for JRuby in a consistent form. Loading of individual settings, printing documentation for settings and their options and defaults, and categorizing properties by function are all part of the built-in structure.
 public class Options {
     private static final List<Option_loadedOptions = new ArrayList<Option>();
     private static final boolean INVOKEDYNAMIC_DEFAULT = calculateInvokedynamicDefault();
     // This section holds all Options for JRuby. They will be listed in the
     // --properties output.
     public static final Option<StringCOMPILE_MODE = string("compile.mode"new String[]{"JIT""FORCE""OFF""OFFIR"}, "JIT""Set compilation mode. JIT = at runtime; FORCE = before execution.");
     public static final Option<BooleanCOMPILE_DUMP = bool("compile.dump"false"Dump to console all bytecode generated at runtime.");
     public static final Option<BooleanCOMPILE_THREADLESS = bool("compile.threadless"false"(EXPERIMENTAL) Turn on compilation without polling for \"unsafe\" thread events.");
     public static final Option<BooleanCOMPILE_FASTOPS = bool("compile.fastops"true"Turn on fast operators for Fixnum and Float.");
     public static final Option<IntegerCOMPILE_CHAINSIZE = integer("compile.chainsize"."Set the number of lines at which compiled bodies are \"chained\".");
     public static final Option<BooleanCOMPILE_LAZYHANDLES = bool("compile.lazyHandles"false"Generate method bindings (handles) for compiled methods lazily.");
     public static final Option<BooleanCOMPILE_PEEPHOLE = bool("compile.peephole"true"Enable or disable peephole optimizations.");
     public static final Option<BooleanCOMPILE_NOGUARDS = bool("compile.noguards"false"Compile calls without guards, for experimentation.");
     public static final Option<BooleanCOMPILE_FASTEST = bool("compile.fastest"false"Compile with all \"mostly harmless\" compiler optimizations.");
     public static final Option<BooleanCOMPILE_FASTSEND = bool("compile.fastsend"false"Compile obj.__send__(<literal>, ...) as obj.<literal>(...).");
     public static final Option<BooleanCOMPILE_FASTMASGN = bool("compile.fastMasgn"false"Return true from multiple assignment instead of a new array.");
     public static final Option<BooleanCOMPILE_INVOKEDYNAMIC = bool("compile.invokedynamic""Use invokedynamic for optimizing Ruby code.");
     public static final Option<IntegerCOMPILE_OUTLINE_CASECOUNT = integer("compile.outline.casecount", 50, "Outline when bodies when number of cases exceeds this value.");
     public static final Option<IntegerINVOKEDYNAMIC_MAXFAIL = integer("invokedynamic.maxfail", 1000, "Maximum call site failures after which to inline cache.");
     public static final Option<IntegerINVOKEDYNAMIC_MAXPOLY = integer("invokedynamic.maxpoly", 6, "Maximum polymorphism of PIC binding.");
     public static final Option<BooleanINVOKEDYNAMIC_LOG_BINDING = bool("invokedynamic.log.binding"false"Log binding of invokedynamic call sites.");
     public static final Option<BooleanINVOKEDYNAMIC_LOG_CONSTANTS = bool("invokedynamic.log.constants"false"Log invokedynamic-based constant lookups.");
     public static final Option<BooleanINVOKEDYNAMIC_LOG_GLOBALS = bool("invokedynamic.log.globals"false"Log invokedynamic-based global lookups.");
     public static final Option<BooleanINVOKEDYNAMIC_ALL = bool("invokedynamic.all"false"Enable all possible uses of invokedynamic.");
     public static final Option<BooleanINVOKEDYNAMIC_SAFE = bool(""false"Enable all safe (but maybe not fast) uses of invokedynamic.");
     public static final Option<BooleanINVOKEDYNAMIC_INVOCATION = bool("invokedynamic.invocation"true"Enable invokedynamic for method invocations.");
     public static final Option<BooleanINVOKEDYNAMIC_INVOCATION_SWITCHPOINT = bool("invokedynamic.invocation.switchpoint"true"Use SwitchPoint for class modification guards on invocations.");
     public static final Option<BooleanINVOKEDYNAMIC_INVOCATION_INDIRECT = bool("invokedynamic.invocation.indirect"true"Also bind indirect method invokers to invokedynamic.");
     public static final Option<BooleanINVOKEDYNAMIC_INVOCATION_JAVA = bool(""true"Bind Ruby to Java invocations with invokedynamic.");
     public static final Option<BooleanINVOKEDYNAMIC_INVOCATION_ATTR = bool("invokedynamic.invocation.attr"true"Bind Ruby attribue invocations directly to invokedynamic.");
     public static final Option<BooleanINVOKEDYNAMIC_INVOCATION_FASTOPS = bool("invokedynamic.invocation.fastops"true"Bind Fixnum and Float math using optimized logic.");
     public static final Option<BooleanINVOKEDYNAMIC_CACHE = bool("invokedynamic.cache"true"Use invokedynamic to load cached values like literals and constants.");
     public static final Option<BooleanINVOKEDYNAMIC_CACHE_CONSTANTS = bool("invokedynamic.cache.constants"true"Use invokedynamic to load constants.");
     public static final Option<BooleanINVOKEDYNAMIC_CACHE_LITERALS = bool("invokedynamic.cache.literals"true"Use invokedynamic to load literals.");
     public static final Option<BooleanINVOKEDYNAMIC_CACHE_IVARS = bool("invokedynamic.cache.ivars"true"Use invokedynamic to get/set instance variables.");
     public static final Option<BooleanINVOKEDYNAMIC_CLASS_VALUES = bool("invokedynamic.class.values"false"Use ClassValue to store class-specific data.");
     public static final Option<IntegerINVOKEDYNAMIC_GLOBAL_MAXFAIL = integer("", 100, "Maximum global cache failures after which to use slow path.");
     public static final Option<BooleanINVOKEDYNAMIC_HANDLES = bool("invokedynamic.handles"false"Use MethodHandles rather than generated code to bind Ruby methods.");
     public static final Option<IntegerJIT_THRESHOLD = integer("jit.threshold"."Set the JIT threshold to the specified method invocation count.");
     public static final Option<IntegerJIT_MAX = integer("jit.max"."Set the max count of active methods eligible for JIT-compilation.");
     public static final Option<IntegerJIT_MAXSIZE = integer("jit.maxsize"."Set the maximum full-class byte size allowed for jitted methods.");
     public static final Option<BooleanJIT_LOGGING = bool("jit.logging"false"Enable JIT logging (reports successful compilation).");
     public static final Option<BooleanJIT_LOGGING_VERBOSE = bool("jit.logging.verbose"false"Enable verbose JIT logging (reports failed compilation).");
     public static final Option<BooleanJIT_DUMPING = bool("jit.dumping"false"Enable stdout dumping of JITed bytecode.");
     public static final Option<IntegerJIT_LOGEVERY = integer("jit.logEvery", 0, "Log a message every n methods JIT compiled.");
     public static final Option<StringJIT_EXCLUDE = string("jit.exclude"new String[]{"ClsOrMod","ClsOrMod::method_name","-::method_name"}, """Exclude methods from JIT. Comma delimited.");
    public static final Option<BooleanJIT_CACHE = bool("jit.cache", !.load(), "Cache jitted method in-memory bodies across runtimes and loads.");
    public static final Option<StringJIT_CODECACHE = string("jit.codeCache"new String[]{"dir"}, "Save jitted methods to <dir> as they're compiled, for future runs.");
    public static final Option<BooleanJIT_DEBUG = bool("jit.debug"false"Log loading of JITed bytecode.");
    public static final Option<BooleanJIT_BACKGROUND = bool("jit.background"true"Run the JIT compiler in a background thread.");
    public static final Option<BooleanIR_DEBUG             = bool("ir.debug"false"Debug generation of JRuby IR.");
    public static final Option<BooleanIR_PROFILE           = bool("ir.profile"false"[EXPT]: Profile IR code during interpretation.");
    public static final Option<BooleanIR_COMPILER_DEBUG    = bool("ir.compiler.debug"false"Debug compilation of JRuby IR.");
    public static final Option<BooleanIR_VISUALIZER        = bool("ir.visualizer"false"Visualization of JRuby IR.");
    public static final Option<String>  IR_COMPILER_PASSES = string("ir.passes""Specify comma delimeted list of passes to run.");
    public static final Option<String>  IR_INLINE_COMPILER_PASSES = string("ir.inline_passes""Specify comma delimeted list of passes to run after inlining a method.");
    public static final Option<BooleanNATIVE_ENABLED = bool("native.enabled"true"Enable/disable native code, including POSIX features and C exts.");
    public static final Option<BooleanNATIVE_VERBOSE = bool("native.verbose"false"Enable verbose logging of native extension loading.");
    public static final Option<BooleanCEXT_ENABLED = bool("cext.enabled"false"Enable or disable C extension support.");
    public static final Option<BooleanFFI_COMPILE_DUMP = bool("ffi.compile.dump"false"Dump bytecode-generated FFI stubs to console.");
    public static final Option<IntegerFFI_COMPILE_THRESHOLD = integer("ffi.compile.threshold", 100, "Number of FFI invocations before generating a bytecode stub.");
    public static final Option<BooleanFFI_COMPILE_INVOKEDYNAMIC = bool("ffi.compile.invokedynamic"false"Use invokedynamic to bind FFI invocations.");
    public static final Option<BooleanFFI_COMPILE_REIFY = bool("ffi.compile.reify"false"Reify FFI compiled classes.");
    public static final Option<BooleanTHREADPOOL_ENABLED = bool("thread.pool.enabled"false"Enable reuse of native threads via a thread pool.");
    public static final Option<IntegerTHREADPOOL_MIN = integer("thread.pool.min", 0, "The minimum number of threads to keep alive in the pool.");
    public static final Option<IntegerTHREADPOOL_MAX = integer("thread.pool.max"."The maximum number of threads to allow in the pool.");
    public static final Option<IntegerTHREADPOOL_TTL = integer("thread.pool.ttl", 60, "The maximum number of seconds to keep alive an idle thread.");
    public static final Option<IntegerFIBER_THREADPOOL_TTL = integer("fiber.thread.pool.ttl", 60, "The maximum number of seconds to keep alive a pooled fiber thread.");
    public static final Option<StringCOMPAT_VERSION = string("compat.version"new String[]{"1.8","1.9","2.0"}, ."Specify the major Ruby version to be compatible with.");
    public static final Option<BooleanOBJECTSPACE_ENABLED = bool("objectspace.enabled"false"Enable or disable ObjectSpace.each_object.");
    public static final Option<BooleanSIPHASH_ENABLED = bool("siphash.enabled"false"Enable or disable SipHash for String hash function.");
    public static final Option<BooleanLAUNCH_INPROC = bool("launch.inproc"false"Set in-process launching of e.g. system('ruby ...').");
    public static final Option<StringBYTECODE_VERSION = string("bytecode.version"new String[]{"1.5","1.6","1.7"}, SafePropertyAccessor.getProperty("java.specification.version""1.5"), "Specify the major Java bytecode version.");
    public static final Option<BooleanMANAGEMENT_ENABLED = bool("management.enabled"false"Set whether JMX management is enabled.");
    public static final Option<BooleanJUMP_BACKTRACE = bool("jump.backtrace"false"Make non-local flow jumps generate backtraces.");
    public static final Option<BooleanPROCESS_NOUNWRAP = bool("process.noUnwrap"false"Do not unwrap process streams (issue on some recent JVMs).");
    public static final Option<BooleanREIFY_CLASSES = bool("reify.classes"false"Before instantiation, stand up a real Java class for every Ruby class.");
    public static final Option<BooleanREIFY_LOGERRORS = bool("reify.logErrors"false"Log errors during reification (reify.classes=true).");
    public static final Option<BooleanREFLECTED_HANDLES = bool("reflected.handles"false"Use reflection for binding methods, not generated bytecode.");
    public static final Option<BooleanBACKTRACE_COLOR = bool("backtrace.color"false"Enable colorized backtraces.");
    public static final Option<StringBACKTRACE_STYLE = string(""new String[]{"normal","raw","full","mri"}, "normal""Set the style of exception backtraces.");
    public static final Option<BooleanBACKTRACE_MASK = bool("backtrace.mask"false"Mask .java lines in Ruby backtraces.");
    public static final Option<StringTHREAD_DUMP_SIGNAL = string("thread.dump.signal"new String[]{"USR1""USR2""etc"}, "USR2""Set the signal used for dumping thread stacks.");
    public static final Option<BooleanNATIVE_NET_PROTOCOL = bool(""false"Use native impls for parts of net/protocol.");
    public static final Option<BooleanFIBER_COROUTINES = bool("fiber.coroutines"false"Use JVM coroutines for Fiber.");
    public static final Option<BooleanGLOBAL_REQUIRE_LOCK = bool("global.require.lock"false"Use a single global lock for requires.");
    public static final Option<BooleanNATIVE_EXEC = bool("native.exec"true"Do a true process-obliterating native exec for Kernel#exec.");
    public static final Option<BooleanENUMERATOR_LIGHTWEIGHT = bool("enumerator.lightweight"true"Use lightweight Enumerator#next logic when possible.");
    public static final Option<BooleanCONSISTENT_HASHING = bool("consistent.hashing"false"Generate consistent object hashes across JVMs");
    public static final Option<BooleanREIFY_VARIABLES = bool("reify.variables"false"Attempt to expand instance vars into Java fields");
    public static final Option<BooleanPREFER_IPV4 = bool("net.preferIPv4"true"Prefer IPv4 network stack");
    public static final Option<BooleanFCNTL_LOCKING = bool("file.flock.fcntl"true"Use fcntl rather than flock for File#flock");
    public static final Option<BooleanDEBUG_LOADSERVICE = bool("debug.loadService"false"Log require/load file searches.");
    public static final Option<BooleanDEBUG_LOADSERVICE_TIMING = bool("debug.loadService.timing"false"Log require/load parse+evaluate times.");
    public static final Option<BooleanDEBUG_LAUNCH = bool("debug.launch"false"Log externally-launched processes.");
    public static final Option<BooleanDEBUG_FULLTRACE = bool("debug.fullTrace"false"Set whether full traces are enabled (c-call/c-return).");
    public static final Option<BooleanDEBUG_SCRIPTRESOLUTION = bool("debug.scriptResolution"false"Print which script is executed by '-S' flag.");
    public static final Option<BooleanDEBUG_PARSER = bool("debug.parser"false"disables JRuby impl script loads and prints parse exceptions");
    public static final Option<BooleanERRNO_BACKTRACE = bool("errno.backtrace"false"Generate backtraces for heavily-used Errno exceptions (EAGAIN).");
    public static final Option<BooleanSTOPITERATION_BACKTRACE = bool("stop_iteration.backtrace"false"Generate backtraces for heavily-used Errno exceptions (EAGAIN).");
    public static final Option<BooleanLOG_EXCEPTIONS = bool("log.exceptions"false"Log every time an exception is constructed.");
    public static final Option<BooleanLOG_BACKTRACES = bool("log.backtraces"false"Log every time an exception backtrace is generated.");
    public static final Option<BooleanLOG_CALLERS = bool("log.callers"false"Log every time a Kernel#caller backtrace is generated.");
    public static final Option<BooleanLOG_WARNINGS = bool("log.warnings"false"Log every time a built-in warning backtrace is generated.");
    public static final Option<StringLOGGER_CLASS = string("logger.class"new String[] {"class name"}, "org.jruby.util.log.StandardErrorLogger""Use specified class for logging.");
    public static final Option<BooleanDUMP_INSTANCE_VARS = bool("dump.variables"false"Dump class + instance var names on first new of Object subclasses.");
    public static final Option<BooleanREWRITE_JAVA_TRACE = bool(""true"Rewrite stack traces from exceptions raised in Java calls.");
    public static final Option<BooleanJI_SETACCESSIBLE = bool("ji.setAccessible"true"Try to set inaccessible Java methods to be accessible.");
    public static final Option<BooleanJI_LOGCANSETACCESSIBLE = bool("ji.logCanSetAccessible"false"Log whether setAccessible is working.");
    public static final Option<BooleanJI_UPPER_CASE_PACKAGE_NAME_ALLOWED = bool(""false"Allow Capitalized Java pacakge names.");
    public static final Option<BooleanINTERFACES_USEPROXY = bool("interfaces.useProxy"false"Use java.lang.reflect.Proxy for interface impl.");
    public static final Option<BooleanJAVA_HANDLES = bool("java.handles"false"Use generated handles instead of reflection for calling Java.");
    public static final Option<BooleanJI_NEWSTYLEEXTENSION = bool("ji.newStyleExtension"false"Extend Java classes without using a proxy object.");
    public static final Option<BooleanJI_OBJECTPROXYCACHE = bool("ji.objectProxyCache"true"Cache Java object wrappers between calls.");
    public static final Option<StringJI_PROXYCLASSFACTORY = string("ji.proxyClassFactory""Allow external envs to replace JI proxy class factory");
    public static final Option<IntegerPROFILE_MAX_METHODS = integer("profile.max.methods", 100000, "Maximum number of methods to consider for profiling.");
    public static final Option<BooleanCLI_AUTOSPLIT = bool("cli.autosplit"false"Split $_ into $F for -p or -n. Same as -a.");
    public static final Option<BooleanCLI_DEBUG = bool("cli.debug"false"Enable debug mode logging. Same as -d.");
    public static final Option<BooleanCLI_PROCESS_LINE_ENDS = bool("cli.process.line.ends"false"Enable line ending processing. Same as -l.");
    public static final Option<BooleanCLI_ASSUME_LOOP = bool("cli.assume.loop"false"Wrap execution with a gets() loop. Same as -n.");
    public static final Option<BooleanCLI_ASSUME_PRINT = bool("cli.assume.print"false"Print $_ after each execution of script. Same as -p.");
    public static final Option<BooleanCLI_VERBOSE = bool("cli.verbose"false"Verbose mode, as -w or -W2. Sets default for cli.warning.level.");
    public static final Option<VerbosityCLI_WARNING_LEVEL = enumeration("cli.warning.level"Verbosity.class.load() ? . : ."Warning level (off=0,normal=1,on=2). Same as -W.");
    public static final Option<BooleanCLI_PARSER_DEBUG = bool("cli.parser.debug"false"Enable parser debug logging. Same as -y.");
    public static final Option<BooleanCLI_VERSION = bool("cli.version"false"Print version to stderr. Same as --version.");
    public static final Option<BooleanCLI_BYTECODE = bool("cli.bytecode"false"Print target script bytecode to stderr. Same as --bytecode.");
    public static final Option<BooleanCLI_COPYRIGHT = bool("cli.copyright"false"Print copyright to stderr. Same as --copyright but runs script.");
    public static final Option<BooleanCLI_CHECK_SYNTAX = bool("cli.check.syntax"false"Check syntax of target script. Same as -c but runs script.");
    public static final Option<StringCLI_AUTOSPLIT_SEPARATOR = string("cli.autosplit.separator""Set autosplit separator. Same as -F.");
    public static final Option<KCodeCLI_KCODE = enumeration("cli.kcode"KCode.class."Set kcode character set. Same as -K (1.8).");
    public static final Option<BooleanCLI_HELP = bool(""false"Print command-line usage. Same as --help but runs script.");
    public static final Option<BooleanCLI_PROPERTIES = bool(""false"Print config properties. Same as --properties but runs script.");
    public static final Option<StringCLI_ENCODING_INTERNAL = string("cli.encoding.internal""Encoding name to use internally.");
    public static final Option<StringCLI_ENCODING_EXTERNAL = string("cli.encoding.external""Encoding name to treat external data.");
    public static final Option<StringCLI_ENCODING_SOURCE = string("cli.encoding.source""Encoding name to treat source code.");
    public static final Option<StringCLI_RECORD_SEPARATOR = string("cli.record.separator""\n""Default record separator.");
    public static final Option<StringCLI_BACKUP_EXTENSION = string("cli.backup.extension""Backup extension for in-place ARGV files. Same as -i.");
    public static final Option<ProfilingModeCLI_PROFILING_MODE = enumeration("cli.profiling.mode"ProfilingMode.class."Enable instrumented profiling modes.");
    public static final Option<BooleanCLI_RUBYGEMS_ENABLE = bool("cli.rubygems.enable"true"Enable/disable RubyGems.");
    public static final Option<BooleanCLI_STRIP_HEADER = bool("cli.strip.header"false"Strip text before shebang in script. Same as -x.");
    public static final Option<BooleanCLI_LOAD_GEMFILE = bool("cli.load.gemfile"false"Load a bundler Gemfile in cwd before running. Same as -G.");
    public static String dump() {
        return "# JRuby configuration options with current values\n" +
    public static final Collection<OptionPROPERTIES = Collections.unmodifiableCollection();
    private static Option<Stringstring(Category categoryString nameString[] optionsString defvalString description) {
        Option<Stringoption = Option.string("jruby"namecategoryoptionsdefvaldescription);
        return option;
    private static Option<Stringstring(Category categoryString nameString defvalString description) {
        Option<Stringoption = Option.string("jruby"namecategorydefvaldescription);
        return option;
    private static Option<Stringstring(Category categoryString nameString[] optionsString description) {
        Option<Stringoption = Option.string("jruby"namecategoryoptionsdescription);
        return option;
    private static Option<Stringstring(Category categoryString nameString description) {
        Option<Stringoption = Option.string("jruby"namecategorydescription);
        return option;
    private static Option<Booleanbool(Category categoryString nameBoolean defvalString description) {
        Option<Booleanoption = Option.bool("jruby"namecategorydefvaldescription);
        return option;
    private static Option<Integerinteger(Category categoryString nameInteger defvalString description) {
        Option<Integeroption = Option.integer("jruby"namecategorydefvaldescription);
        return option;
    private static <T extends Enum<T>> Option<T> enumeration(Category categoryString nameClass<T> enumClass, T defvalString description) {
        Option<T> option = Option.enumeration("jruby"namecategorydefvaldescription);
        return option;
    private static boolean calculateInvokedynamicDefault() {
        String javaVersion = SafePropertyAccessor.getProperty("java.specification.version""");
        if (!javaVersion.equals("") && new BigDecimal(javaVersion).compareTo(new BigDecimal("1.8")) >= 0) {
            return true;
        } else {
            // on only if forced
            return false;
New to GrepCode? Check out our FAQ X