edu.umd.cs.findbugs.LaunchAppropriateUI Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spotbugs Show documentation
SpotBugs: Because it's easy!
The newest version!
/*
 * FindBugs - Find Bugs in Java programs
 * Copyright (C) 2006,2008 University of Maryland
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package edu.umd.cs.findbugs;

import java.awt.GraphicsEnvironment;
import java.lang.reflect.Method;
import java.util.HashMap;
import java.util.Map;

import edu.umd.cs.findbugs.internalAnnotations.StaticConstant;

/**
 * Class to launch the appropriate textUI or GUI. This class is the Main-Class
 * in the findbugs.jar manifest, and is responsible for running an appropriate
 * main() method.
 *
 * @author Bill Pugh
 * @author David Hovemeyer
 */
public class LaunchAppropriateUI {
    /**
     * UI code for the text (command line) UI.
     */
    public static final int TEXTUI = 0;

    /**
     * UI code for the old Swing GUI. This is deprecated now.
     */
    public static final int GUI1 = 1;

    /**
     * UI code for the new Swing GUI.
     */
    public static final int GUI2 = 2;

    /**
     * UI code for displaying command line help.
     */
    public static final int SHOW_HELP = 1000;

    /**
     * UI code for displaying command line version information.
     */
    public static final int SHOW_VERSION = 1001;

    /**
     * Map of UI name strings to integer UI codes.
     */
    @StaticConstant
    public static final Map uiNameToCodeMap;
    static {
        uiNameToCodeMap = new HashMap<>();
        uiNameToCodeMap.put("textui", TEXTUI);
        uiNameToCodeMap.put("gui", GUI2);
        uiNameToCodeMap.put("gui1", GUI1);
        uiNameToCodeMap.put("gui2", GUI2);
        uiNameToCodeMap.put("help", SHOW_HELP);
        uiNameToCodeMap.put("version", SHOW_VERSION);
    }

    // Fields
    /** Command line arguments. */
    private String[] args;

    /**
     * Constructor.
     *
     * @param args
     *            command line arguments
     */
    public LaunchAppropriateUI(String[] args) {
        this.args = args;
    }

    /**
     * Launch the appropriate UI.
     *
     * @throws java.lang.Exception
     */
    public void launch() throws Exception {
        // Sanity-check the loaded BCEL classes
        if (!CheckBcel.check()) {
            System.exit(1);
        }

        int launchProperty = getLaunchProperty();

        if (GraphicsEnvironment.isHeadless() || launchProperty == TEXTUI) {
            FindBugs2.main(args);
        } else if (launchProperty == SHOW_HELP) {
            ShowHelp.main(args);
        } else if (launchProperty == SHOW_VERSION) {
            Version.main(new String[] { "-release" });
        } else {
            Class launchClass = Class.forName("edu.umd.cs.findbugs.gui2.Driver");
            Method mainMethod = launchClass.getMethod("main", args.getClass());
            mainMethod.invoke(null, (Object) args);
        }

    }

    /**
     * Find out what UI should be launched.
     *
     * 
     * First, we check the command line arguments to see if the first argument
     * specifies the UI (e.g., "-textui", "-gui", etc.)
     *
     * 

     * If the first command line argument does not specify the UI, then we check
     * the findbugs.launchUI system property to one of the
     * following values:
     *
     * 

     * -Dfindbugs.launchUI=textui for textui,
     * -Dfindbugs.launchUI=gui1 for the original swing gui,
     * -Dfindbugs.launchUI=gui2 for the new swing gui,
     * -Dfindbugs.launchUI=version for the ShowVersion main() method, or
     * -Dfindbugs.launchUI=help for the ShowHelp main() method.
     * 
     *
     * Any other value (or the absence of any value) will not change the default
     * behavior, which is to launch the newer "gui2" on systems that support it.
     *
     * @return an integer UI code: TEXTUI, GUI1, GUI2, SHOW_VERSION, SHOW_HELP,
     *         or possibly another user-set int value
     */
    private int getLaunchProperty() {
        // See if the first command line argument specifies the UI.
        if (args.length > 0) {
            String firstArg = args[0];
            if (firstArg.startsWith("-")) {
                String uiName = firstArg.substring(1);
                if (uiNameToCodeMap.containsKey(uiName)) {
                    // Strip the first argument from the command line arguments.
                    String[] modifiedArgs = new String[args.length - 1];
                    System.arraycopy(args, 1, modifiedArgs, 0, args.length - 1);
                    args = modifiedArgs;

                    return uiNameToCodeMap.get(uiName);
                }
            }
        }

        // Check findbugs.launchUI property.
        // "gui2" is the default if not otherwise specified.
        String s = System.getProperty("findbugs.launchUI");

        if (s == null) {
            for (String a : args) {
                if ("-output".equals(a) || "-xml".equals(a) || a.endsWith(".class") || a.endsWith(".jar")) {
                    return TEXTUI;
                }
            }
            s = "gui2";
        }

        // See if the property value is one of the human-readable
        // UI names.
        if (uiNameToCodeMap.containsKey(s)) {
            return uiNameToCodeMap.get(s);
        }

        // Fall back: try to parse it as an integer.
        try {
            return Integer.parseInt(s);
        } catch (NumberFormatException nfe) {
            return GUI2;
        }
    }

    /**
     * main() method. This is where execution of FindBugs (any UI) starts.
     *
     * @param args
     *            command line arguments
     * @throws java.lang.Exception
     */
    public static void main(String args[]) throws Exception {
        LaunchAppropriateUI launcher = new LaunchAppropriateUI(args);
        launcher.launch();
    }
}