Examples of avrora.util.help.HelpCategory

avrora.util.help.HelpCategory
The HelpCategory class implements a category that provides help from the command line. It can contain multiple sections, including sections on options, and a list of other help items (such as what the values of each option does). @author Ben L. Titzer

        defs.load(new FileInputStream(f));
        mainOptions.process(defs);
    }


    static HelpCategory buildHelpCategory() {
        HelpCategory hc = new HelpCategory("main", "");
        hc.addSection("OVERVIEW","Avrora is a tool for working with " +
                "assembly language programs for the AVR architecture microcontrollers " +
                "and building simulations of hardward devices based on this microcontroller." +
                "It contains tools to read AVR programs in multiple formats, perform " +
                "actions on them, and generate output in multiple formats.\n" +
                "Typical usage is to specify a list of files that contain a program " +
                "in some format supported by Avrora and then specifying the action " +
                "to perform on that program. For example, giving the name of a file " +
                "that contains a program written in assembly language and a simulate " +
                "action might look like: \n\n" +
                "avrora -action=simulate -input=atmel program.asm \n\n" +
                "Other actions that are available include generating a control flow graph of the " +
                "program or running one of the analysis tools on the program. See the " +
                "actions section for more information.");
        hc.addOptionSection("The main options to Avrora specify the action to be performed as well as the input " +
                "format and any general configuration parameters for " +
                "Avrora. The available main options are listed below along with their types and default " +
                "values. Each action also has its own set of options. To access help for the options " +
                "related to an action, specify the name of the action along with the \"help\" option.", mainOptions);


        hc.addSubcategorySection("ADDITIONAL HELP CATEGORIES", "Additional help is available on a category by category " +
                "basis. Below is a list of the additional categories available to provide help with actions, " +
                "input formats, monitors, and more. To access help for a specific category, specify the " +
                "\"-help\" option followed by the name of category.", Defaults.getMainCategories());


        return hc;

View Full Code Here


        printFooter();
    }


    private static void buildAllCategories() {
        HelpCategory hc = new HelpCategory("all", "Print a list of all categories for which help is available.");
        hc.addSection("OVERVIEW", "Avrora provides help in many categories that are all accessible from the command " +
                "line.");
        hc.addSubcategorySection("ALL HELP CATEGORIES", "Below is a listing of all the help categories available.",
                Defaults.getAllCategories());
        Defaults.addMainCategory(hc);
    }

View Full Code Here

        Terminal.print("] when posting to the list.");
        Terminal.nextln();
    }


    private static void printHelp(String a) {
        HelpCategory hc = Defaults.getHelpCategory(a);
        hc.printHelp();
    }

View Full Code Here

            monitorMap.addClass("serial", SerialMonitor.class);
            monitorMap.addClass("trip-time", TripTimeMonitor.class);
            monitorMap.addClass("ioregs", IORegMonitor.class);
            monitorMap.addClass("real-time", RealTimeMonitor.class);


            HelpCategory hc = new HelpCategory("monitors", "Help for the supported simulation monitors.");
            addOptionSection(hc, "SIMULATION MONITORS", "Avrora's simulator offers the ability to install execution " +
                    "monitors that instrument the program in order to study and analyze its behavior. The " +
                    "\"simulate\" action supports this option that allows a monitor class " +
                    "to be loaded which will instrument the program before it is run and then generate a report " +
                    "after the program has completed execution.", "-monitors", monitorMap);

View Full Code Here

            inputs.addClass("gas", GASProgramReader.class);
            inputs.addClass("atmel", AtmelProgramReader.class);
            inputs.addClass("objdump", ObjDumpProgramReader.class);
            inputs.addClass("odpp", ObjDump2ProgramReader.class);


            HelpCategory hc = new HelpCategory("inputs", "Help for the supported program input formats.");
            addOptionSection(hc, "INPUT FORMATS", "The input format of the program is specified with the \"-input\" " +
                "option supplied at the command line. This input format is used by " +
                "actions that operate on programs to determine how to interpret the " +
                "input and build a program from the files specified. For example, the input format might " +
                "be Atmel syntax, GAS syntax, or the output of a disassembler such as avr-objdump. Currently " +

View Full Code Here

            actions.addClass("dbbc", DBBCAction.class);
            //--END EXPERIMENTAL: dbbc
            actions.addClass("odpp", ODPPAction.class);


            // plug in a new help category for actions accesible with "-help actions"
            HelpCategory hc = new HelpCategory("actions", "Help for Avrora actions.");
            addOptionSection(hc, "ACTIONS", "Avrora accepts the \"-action\" command line option " +
                    "that you can use to select from the available functionality that Avrora " +
                    "provides. This action might be to assemble the file, " +
                    "print a listing, perform a simulation, or run an analysis tool. This " +
                    "flexibility allows this single frontend to select from multiple useful " +

View Full Code Here

            simMap.addClass("single", SingleSimulation.class);
            simMap.addClass("sensor-network", SensorSimulation.class);
      simMap.addClass("external-network", ExternalSimulation.class);


            // plug in a new help category for simulations accesible with "-help simulations"
            HelpCategory hc = new HelpCategory("simulations", "Help for supported simulation types.");
            addOptionSection(hc, "SIMULATION TYPES",
                    "When running a simulation, Avrora accepts the \"-simulation\" command line option " +
                    "that selects the simulation type from multiple different types provided, or a " +
                    "user-supplied Java class of your own. For example, a simulation might be for a " +
                    "sensor network application, a single node simulation, or a robotics simulation. ",

View Full Code Here

TOP

Related Classes of avrora.util.help.HelpCategory

avrora.Defaults

avrora.Main

avrora.util.Option

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.