1 /*
2 * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
3 * and other copyright owners as documented in the project's IP log.
4 *
5 * This program and the accompanying materials are made available
6 * under the terms of the Eclipse Distribution License v1.0 which
7 * accompanies this distribution, is reproduced below, and is
8 * available at http://www.eclipse.org/org/documents/edl-v10.php
9 *
10 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or
13 * without modification, are permitted provided that the following
14 * conditions are met:
15 *
16 * - Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 *
19 * - Redistributions in binary form must reproduce the above
20 * copyright notice, this list of conditions and the following
21 * disclaimer in the documentation and/or other materials provided
22 * with the distribution.
23 *
24 * - Neither the name of the Eclipse Foundation, Inc. nor the
25 * names of its contributors may be used to endorse or promote
26 * products derived from this software without specific prior
27 * written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 */
43
44 package org.eclipse.jgit.pgm.opt;
45
46 import org.eclipse.jgit.pgm.CommandCatalog;
47 import org.eclipse.jgit.pgm.CommandRef;
48 import org.eclipse.jgit.pgm.TextBuiltin;
49 import org.eclipse.jgit.pgm.internal.CLIText;
50 import org.kohsuke.args4j.CmdLineException;
51 import org.kohsuke.args4j.CmdLineParser;
52 import org.kohsuke.args4j.OptionDef;
53 import org.kohsuke.args4j.spi.OptionHandler;
54 import org.kohsuke.args4j.spi.Parameters;
55 import org.kohsuke.args4j.spi.Setter;
56
57 /**
58 * Custom Argument handler for jgit command selection.
59 * <p>
60 * Translates a single argument string to a
61 * {@link org.eclipse.jgit.pgm.TextBuiltin} instance which we can execute at
62 * runtime with the remaining arguments of the parser.
63 */
64 public class SubcommandHandler extends OptionHandler<TextBuiltin> {
65 private final org.eclipse.jgit.pgm.opt.CmdLineParser clp;
66
67 /**
68 * Create a new handler for the command name.
69 * <p>
70 * This constructor is used only by args4j.
71 *
72 * @param parser
73 * a {@link org.kohsuke.args4j.CmdLineParser} object.
74 * @param option
75 * a {@link org.kohsuke.args4j.OptionDef} object.
76 * @param setter
77 * a {@link org.kohsuke.args4j.spi.Setter} object.
78 */
79 public SubcommandHandler(final CmdLineParser parser,
80 final OptionDef option, final Setter<? super TextBuiltin> setter) {
81 super(parser, option, setter);
82 clp = (org.eclipse.jgit.pgm.opt.CmdLineParser) parser;
83 }
84
85 /** {@inheritDoc} */
86 @Override
87 public int parseArguments(Parameters params) throws CmdLineException {
88 final String name = params.getParameter(0);
89 final CommandRef cr = CommandCatalog.get(name);
90 if (cr == null)
91 throw new CmdLineException(clp,
92 CLIText.format(CLIText.get().notAJgitCommand), name);
93
94 // Force option parsing to stop. Everything after us should
95 // be arguments known only to this command and must not be
96 // recognized by the current parser.
97 //
98 owner.stopOptionParsing();
99 setter.addValue(cr.create());
100 return 1;
101 }
102
103 /** {@inheritDoc} */
104 @Override
105 public String getDefaultMetaVariable() {
106 return CLIText.get().metaVar_command;
107 }
108 }