Configuration.java example

Explorer
sx10-master
/*
 *  This file is part of the X10 project (http://x10-lang.org).
 *
 *  This file is licensed to You under the Eclipse Public License (EPL);
 *  You may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *      http://www.opensource.org/licenses/eclipse-1.0.php
 *
 *  (C) Copyright IBM Corporation 2006-2010.
 */

package x10;

import x10.config.ConfigurationError;
import x10.config.OptionError;

/**
 * This class provides the configuration for the X10 compiler.
 * The configuration is a set of values that can be used to
 * configure the compiler, for example in order to tune performance
 * of the generated code.
 *
 * @see x10.config.Configuration
 *
 * @author Christian Grothoff
 * @author Igor Peshansky
 */
public final class Configuration extends x10.config.Configuration {

    public String MAIN_CLASS = null;
    private static final String MAIN_CLASS_desc = "The class whose main() will be invoked";

    public boolean CHECK_INVARIANTS = false;
    private static final String CHECK_INVARIANTS_desc = "Check AST invariants such as position containment, existence of xxxInstance(), etc";

    public boolean ONLY_TYPE_CHECKING = false;
    private static final String ONLY_TYPE_CHECKING_desc = "Do only type-checking, without optimizations or code generation";

    public boolean OPTIMIZE = false;
    private static final String OPTIMIZE_desc = "Generate optimized code";

    public boolean CHECK_ERR_MARKERS = false;
    private static final String CHECK_ERR_MARKERS_desc = "Check for @ERR markers";

    public boolean DEBUG = false;
    private static final String DEBUG_desc = "Generate debug information";
    
    public boolean DEBUG_APP_ONLY = false;
    private static final String DEBUG_APP_ONLY_desc = "Only generate debug information for the user application; still link with non-debug version of libraries";

    public boolean NO_TRACES = false;
    private static final String NO_TRACES_desc = "Disable traces";

    public boolean NO_CHECKS = false;
    private static final String NO_CHECKS_desc = "Disable generation of all null, bounds, and place checks";

    public boolean LOOP_OPTIMIZATIONS = true;
    private static final String LOOP_OPTIMIZATIONS_desc = "Optimize rectangular region iteration";

    public boolean EXPERIMENTAL = false;
    private static final String EXPERIMENTAL_desc = "Enable experimental optimizations";

    public boolean ELIMINATE_DEAD_VARIABLES = false;
    private static final String ELIMINATE_DEAD_VARIABLES_desc = "Get rid of unused local variables";

    public boolean SPLIT_CONSTRUCTORS = true;
    private static final String SPLIT_CONSTRUCTORS_desc = "Replace New with Allocation and ConstructorCall nodes";

    public boolean INLINE = true;
    private static final String INLINE_desc = "Enable explicit and implicit inlining of methods, constructors, closures, andcommand-line constants";

    public int INLINE_SIZE = 1;
    private static final String INLINE_SIZE_desc = "Maximum number of calls in a method to be implicitly inlined (-1 turns off implicit inlining)";
    
    public boolean FLATTEN_EXPRESSIONS = false;
    private static final String FLATTEN_EXPRESSIONS_desc = "Flatten all expressions";
    
    public boolean CODE_CLEAN_UP = true;
    private static final String CODE_CLEAN_UP_desc = "Code clean up - removing excess blocks and unreachable code";

    public String PLUGINS = "";
    private static final String PLUGINS_desc = "Comma-separated list of compiler plugins to run.";

    public String PLUGIN_COMPILER = "";
    private static final String PLUGIN_COMPILER_desc = "Javac-like compiler to use to compile plugins";

    public boolean WORK_STEALING = false;
    private static final String WORK_STEALING_desc = "Code generation for work-stealing scheduling";

    public boolean WS_DISABLE_EXCEPTION_HANDLE = false;
    private static final String WS_DISABLE_EXCEPTION_HANDLE_desc = "Disable exception handling code generation in work-stealing scheduling";
    
    public boolean WALA = false;
    private static final String WALA_desc = "Produce WALA IR from X10 sources";

    public boolean WALADEBUG = false;
    private static final String WALADEBUG_desc = "Produce WALA call graph from X10 sources";

    public boolean VERBOSE_CHECKS = false;
    private static final String VERBOSE_CHECKS_desc = "Print details of casts introduced for dynamic constraint checks.";

    public boolean STATIC_CHECKS = false;
    private static final String STATIC_CHECKS_desc = "Treat dynamic constraint checks as errors.";


    public boolean VERBOSE = false;
    private static final String VERBOSE_desc = "Print details for various warnings that might be interested to the programmer.";


    public boolean FINISH_ASYNCS = false;
    private static final String FINISH_ASYNCS_desc = "finish-async analysis.";

    public boolean STATICS_PER_PLACE_ANALYSIS = false;
    private static final String STATICS_PER_PLACE_ANALYSIS_desc = "Enable deep analysis for converting place-0 static initializers to per-place initializers";
    
    public boolean COPY_PROPAGATION = false;
    private static final String COPY_PROPAGATION_desc = "Enable copy propagation pass after optimizer. Use together with -O -EXPERIMENTAL -ELIMINATE_DEAD_VARIABLES";

    public boolean DEBUG_CODEGEN = false;
    private static final String DEBUG_CODEGEN_desc = "Enable HTML version of the generated source code for codegen debugging";

    public boolean OPTIMIZE_COMMUNICATIONS = false;
    private static final String OPTIMIZE_COMMUNICATIONS_desc = "Communication optimizations, i.e. scalar replacement";

    /**
     * Parses one argument from the command line.  This allows the user
     * to specify options also on the command line (in addition to the
     * configuration file and the defaults).
     *
     * @param arg the current argument, e.g., -STATISTICS_DISABLE=all
     * @throws OptionError if the argument is not recognized
     * @throws ConfigurationError if there was a problem processing the argument
     */
    public void parseArgument(String arg) throws OptionError, ConfigurationError {
        parseArgument(this, Configuration.class, arg);
    }

    public Object get(String key) throws ConfigurationError, OptionError {
        return get(this, Configuration.class, key);
    }

    /**
     * Return an array of (option,description) pairs.
     */
    public String[][] options() {
        return options(this, Configuration.class);
    }

    public Configuration() {
        super(Configuration.class);
    }

    public Configuration(String cfg) {
        super(Configuration.class, cfg);
    }
}