Examples of org.jnode.shell.syntax.ArgumentBundle

org.jnode.shell.syntax.ArgumentBundle
An ArgumentBundle holds a collection of Argument objects and provides methods for looking them up (by label), and performing command line parsing and completion based on the Arguments and a separately managed Syntax. The ArgumentBundle and the Syntax tree are related by means of the label values on their respective nodes.
Each native JNode command implements a method for providing an ArgumentBundle to the command shell / interpreters. The (provisional) interactions for executing a shell command are as follows:
1. The shell / interpreter parse the raw command line text according to the current interpreter's meta-syntax. This process strips out redirections, control constructs and so on, and performs the relevant expansions. This yields a command alias name and sequence of argument strings, wrapped up as a CommandLine object.
2. The command alias is mapped to a Java class which is loaded.
3. If the command class does not extend AbstractCommand, the command is called via its "public static void main(String[])" entry point.
4. Otherwise:
  1. An instance of the command class is created.
  2. The command's 'getArgumentBundle' method is called to get the argument bundle.
  3. The shell tries to find a Syntax for the alias. (These will be specified independently of the command class; e.g. in an XML file. Different Syntaxes may exist for a given command, depending on the interpreter, the user's preferences and so on.) If no Syntax is found, a default syntax can be generated from the ArgumentBundle.
  4. The shell calls the 'parse' method on the ArgumentBundle, passing the CommandLine and the chosen (or default) Syntax. This traverses the Syntax, attempting to match the command argument tokens against the Syntax node's corresponding Arguments. In the process, command argument tokens are converted into values that are bound the the appropriate Arguments.
  5. If the parse succeeds, the command is then run by calling the 'execute' method, passing the ArgumentBundle with the bound argument values. The command can use get the argument values, flags and so on by calling 'getArgument(..).getValue()', or by calling 'getValue()' on Argument references saved by the earlier 'getArgumentBundle()' call.
@author crawley@jnode.org


    @Test
    public void testStatefullParsing3() throws NoTokensAvailableException, CommandSyntaxException {
        IntegerArgument intArg = new IntegerArgument("intArg", Argument.MULTIPLE);
        FileArgument fileArg = new FileArgument("fileArg", Argument.MULTIPLE);
        ArgumentBundle bundle = new ArgumentBundle(intArg, fileArg);


        // <start> :: = <<intArg>> | <<fileArg>>
        MuSyntax syntax = new MuAlternation(new MuArgument("intArg"), new MuArgument("fileArg"));
        MuParser parser = new MuParser();
        CommandLine cl;

View Full Code Here


    @Test
    public void testStatefullParsing4() throws NoTokensAvailableException, CommandSyntaxException {
        IntegerArgument intArg = new IntegerArgument("intArg", Argument.MULTIPLE);
        FileArgument fileArg = new FileArgument("fileArg", Argument.MULTIPLE);
        ArgumentBundle bundle = new ArgumentBundle(intArg, fileArg);


        // <root> ::= <<fileArg>> | ( <<intArg>> <root> )
        MuSyntax syntax =
                new MuAlternation("root", new MuArgument("fileArg"), new MuSequence(new MuArgument(
                        "intArg"), new MuBackReference("root")));

View Full Code Here


    @Test
    public void testStatefullParsing5() throws NoTokensAvailableException, CommandSyntaxException {
        IntegerArgument intArg = new IntegerArgument("intArg", Argument.MULTIPLE);
        FileArgument fileArg = new FileArgument("fileArg", Argument.MULTIPLE);
        ArgumentBundle bundle = new ArgumentBundle(intArg, fileArg);


        // <root> ::= ( <<intArg>> <root> ) | <<fileArg>>
        MuSyntax syntax =
                new MuAlternation("root", new MuSequence(new MuArgument("intArg"),
                        new MuBackReference("root")), new MuArgument("fileArg"));

View Full Code Here

    @Test
    public void testStatefullParsing6() throws NoTokensAvailableException, CommandSyntaxException {
        EnumArgument<Big> bigArg = new BigArgument("bigArg", Argument.MULTIPLE);
        EnumArgument<Small> smallArg = new SmallArgument("smallArg", Argument.MULTIPLE);
        IntegerArgument intArg = new IntegerArgument("intArg", Argument.MULTIPLE);
        ArgumentBundle bundle = new ArgumentBundle(intArg, smallArg, bigArg);


        // <root> ::= ( ( <<intArg>> <root> ) | ( <<bigArg>> <<smallArg>> ) ) |
        // ( ( <<intArg>> <root> ) | <<bigArg>> ) )
        MuSyntax syntax = new MuAlternation("root", new MuAlternation(new MuSequence(new MuArgument("intArg"),
            new MuBackReference("root")), new MuSequence(new MuArgument("bigArg"), new MuArgument("smallArg"))),

View Full Code Here

        new PowersetSyntax(new OptionSyntax("intArg", 'i'), new OptionSyntax("fileArg", 'f'));
    }


    @org.junit.Test
    public void testFormat() {
        ArgumentBundle bundle = new Test().getArgumentBundle();
        Syntax syntax1 =
                new PowersetSyntax(new OptionSyntax("intArg", 'i'),
                        new OptionSyntax("fileArg", 'f'));
        Assert.assertEquals("[ ( -i <intArg> ) | ( -f <fileArg> ) ] ...", syntax1.format(bundle));
    }

View Full Code Here

            Class<?> cls = aliasMgr.getAliasClass(cmd);
            if (Command.class.isAssignableFrom(cls)) {
                return new CommandInfo(cls, cmd, syntaxBundle, aliasMgr.isInternal(cmd));
            } else {
                // check if this alias has a bare command definition
                ArgumentBundle argBundle = getSyntaxManager().getArgumentBundle(cmd);
                return new CommandInfo(cls, cmd, syntaxBundle, argBundle);
            }
        } catch (ClassNotFoundException ex) {
            throw new ShellInvocationException("Cannot load the command class for alias '" + cmd + "'", ex);
        } catch (NoSuchAliasException ex) {

View Full Code Here

0 1

TOP

Related Classes of org.jnode.shell.syntax.ArgumentBundle

org.jnode.shell.AbstractCommand

org.jnode.shell.ArgumentCompleter

org.jnode.shell.CommandInfo

org.jnode.shell.CommandLine

org.jnode.shell.CommandShell

org.jnode.shell.help.def.DefaultHelpFactory

org.jnode.test.shell.syntax.ArgumentBundleTest

org.jnode.test.shell.syntax.MuParserTest2

org.jnode.test.shell.syntax.PowersetSyntaxTest

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.