View Javadoc
1   /*
2    * Copyright (C) 2009, Google Inc.
3    * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
4    * and other copyright owners as documented in the project's IP log.
5    *
6    * This program and the accompanying materials are made available
7    * under the terms of the Eclipse Distribution License v1.0 which
8    * accompanies this distribution, is reproduced below, and is
9    * available at http://www.eclipse.org/org/documents/edl-v10.php
10   *
11   * All rights reserved.
12   *
13   * Redistribution and use in source and binary forms, with or
14   * without modification, are permitted provided that the following
15   * conditions are met:
16   *
17   * - Redistributions of source code must retain the above copyright
18   *   notice, this list of conditions and the following disclaimer.
19   *
20   * - Redistributions in binary form must reproduce the above
21   *   copyright notice, this list of conditions and the following
22   *   disclaimer in the documentation and/or other materials provided
23   *   with the distribution.
24   *
25   * - Neither the name of the Eclipse Foundation, Inc. nor the
26   *   names of its contributors may be used to endorse or promote
27   *   products derived from this software without specific prior
28   *   written permission.
29   *
30   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
31   * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
32   * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
33   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
34   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
35   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
36   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
37   * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
38   * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
39   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
41   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
42   * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
43   */
44  
45  package org.eclipse.jgit.pgm.opt;
46  
47  import java.io.IOException;
48  
49  import org.eclipse.jgit.errors.IncorrectObjectTypeException;
50  import org.eclipse.jgit.errors.MissingObjectException;
51  import org.eclipse.jgit.lib.ObjectId;
52  import org.eclipse.jgit.pgm.internal.CLIText;
53  import org.eclipse.jgit.revwalk.RevCommit;
54  import org.eclipse.jgit.revwalk.RevFlag;
55  import org.kohsuke.args4j.CmdLineException;
56  import org.kohsuke.args4j.CmdLineParser;
57  import org.kohsuke.args4j.OptionDef;
58  import org.kohsuke.args4j.spi.OptionHandler;
59  import org.kohsuke.args4j.spi.Parameters;
60  import org.kohsuke.args4j.spi.Setter;
61  
62  /**
63   * Custom argument handler {@link org.eclipse.jgit.revwalk.RevCommit} from
64   * string values.
65   * <p>
66   * Assumes the parser has been initialized with a Repository.
67   */
68  public class RevCommitHandler extends OptionHandler<RevCommit> {
69  	private final org.eclipse.jgit.pgm.opt.CmdLineParser clp;
70  
71  	/**
72  	 * Create a new handler for the command name.
73  	 * <p>
74  	 * This constructor is used only by args4j.
75  	 *
76  	 * @param parser
77  	 *            a {@link org.kohsuke.args4j.CmdLineParser} object.
78  	 * @param option
79  	 *            a {@link org.kohsuke.args4j.OptionDef} object.
80  	 * @param setter
81  	 *            a {@link org.kohsuke.args4j.spi.Setter} object.
82  	 */
83  	public RevCommitHandler(final CmdLineParser parser, final OptionDef option,
84  			final Setter<? super RevCommit> setter) {
85  		super(parser, option, setter);
86  		clp = (org.eclipse.jgit.pgm.opt.CmdLineParser) parser;
87  	}
88  
89  	/** {@inheritDoc} */
90  	@Override
91  	public int parseArguments(Parameters params) throws CmdLineException {
92  		String name = params.getParameter(0);
93  
94  		boolean interesting = true;
95  		if (name.startsWith("^")) { //$NON-NLS-1$
96  			name = name.substring(1);
97  			interesting = false;
98  		}
99  
100 		final int dot2 = name.indexOf(".."); //$NON-NLS-1$
101 		if (dot2 != -1) {
102 			if (!option.isMultiValued())
103 				throw new CmdLineException(clp,
104 						CLIText.format(CLIText.get().onlyOneMetaVarExpectedIn),
105 						option.metaVar(), name);
106 
107 			final String left = name.substring(0, dot2);
108 			final String right = name.substring(dot2 + 2);
109 			addOne(left, false);
110 			addOne(right, true);
111 			return 1;
112 		}
113 
114 		addOne(name, interesting);
115 		return 1;
116 	}
117 
118 	private void addOne(String name, boolean interesting)
119 			throws CmdLineException {
120 		final ObjectId id;
121 		try {
122 			id = clp.getRepository().resolve(name);
123 		} catch (IOException e) {
124 			throw new CmdLineException(clp, CLIText.format(e.getMessage()));
125 		}
126 		if (id == null)
127 			throw new CmdLineException(clp,
128 					CLIText.format(CLIText.get().notACommit), name);
129 
130 		final RevCommit c;
131 		try {
132 			c = clp.getRevWalk().parseCommit(id);
133 		} catch (MissingObjectException e) {
134 			throw new CmdLineException(clp,
135 					CLIText.format(CLIText.get().notACommit), name);
136 		} catch (IncorrectObjectTypeException e) {
137 			throw new CmdLineException(clp,
138 					CLIText.format(CLIText.get().notACommit), name);
139 		} catch (IOException e) {
140 			throw new CmdLineException(clp,
141 					CLIText.format(CLIText.get().cannotReadBecause), name,
142 					e.getMessage());
143 		}
144 
145 		if (interesting)
146 			c.remove(RevFlag.UNINTERESTING);
147 		else
148 			c.add(RevFlag.UNINTERESTING);
149 
150 		setter.addValue(c);
151 	}
152 
153 	/** {@inheritDoc} */
154 	@Override
155 	public String getDefaultMetaVariable() {
156 		return CLIText.get().metaVar_commitish;
157 	}
158 }