View Javadoc
1   /*
2    * Copyright (C) 2010, Google Inc.
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.diff;
45  
46  import java.text.MessageFormat;
47  
48  import org.eclipse.jgit.internal.JGitText;
49  import org.eclipse.jgit.lib.Config;
50  import org.eclipse.jgit.lib.Config.SectionParser;
51  import org.eclipse.jgit.lib.ConfigConstants;
52  import org.eclipse.jgit.util.StringUtils;
53  
54  /** Keeps track of diff related configuration options. */
55  public class DiffConfig {
56  	/** Key for {@link Config#get(SectionParser)}. */
57  	public static final Config.SectionParser<DiffConfig> KEY = new SectionParser<DiffConfig>() {
58  		public DiffConfig parse(final Config cfg) {
59  			return new DiffConfig(cfg);
60  		}
61  	};
62  
63  	/** Permissible values for {@code diff.renames}. */
64  	public static enum RenameDetectionType {
65  		/** Rename detection is disabled. */
66  		FALSE,
67  
68  		/** Rename detection is enabled. */
69  		TRUE,
70  
71  		/** Copies should be detected too. */
72  		COPY
73  	}
74  
75  	private final boolean noPrefix;
76  
77  	private final RenameDetectionType renameDetectionType;
78  
79  	private final int renameLimit;
80  
81  	private DiffConfig(final Config rc) {
82  		noPrefix = rc.getBoolean(ConfigConstants.CONFIG_DIFF_SECTION,
83  				ConfigConstants.CONFIG_KEY_NOPREFIX, false);
84  		renameDetectionType = parseRenameDetectionType(rc.getString(
85  				ConfigConstants.CONFIG_DIFF_SECTION, null, ConfigConstants.CONFIG_KEY_RENAMES));
86  		renameLimit = rc.getInt(ConfigConstants.CONFIG_DIFF_SECTION,
87  				ConfigConstants.CONFIG_KEY_RENAMELIMIT, 200);
88  	}
89  
90  	/** @return true if the prefix "a/" and "b/" should be suppressed. */
91  	public boolean isNoPrefix() {
92  		return noPrefix;
93  	}
94  
95  	/** @return true if rename detection is enabled by default. */
96  	public boolean isRenameDetectionEnabled() {
97  		return renameDetectionType != RenameDetectionType.FALSE;
98  	}
99  
100 	/** @return type of rename detection to perform. */
101 	public RenameDetectionType getRenameDetectionType() {
102 		return renameDetectionType;
103 	}
104 
105 	/** @return limit on number of paths to perform inexact rename detection. */
106 	public int getRenameLimit() {
107 		return renameLimit;
108 	}
109 
110 	private static RenameDetectionType parseRenameDetectionType(
111 			final String renameString) {
112 		if (renameString == null)
113 			return RenameDetectionType.FALSE;
114 		else if (StringUtils.equalsIgnoreCase(
115 				ConfigConstants.CONFIG_RENAMELIMIT_COPY, renameString)
116 				|| StringUtils
117 						.equalsIgnoreCase(
118 								ConfigConstants.CONFIG_RENAMELIMIT_COPIES,
119 								renameString))
120 			return RenameDetectionType.COPY;
121 		else {
122 			final Boolean renameBoolean = StringUtils
123 					.toBooleanOrNull(renameString);
124 			if (renameBoolean == null)
125 				throw new IllegalArgumentException(MessageFormat.format(
126 						JGitText.get().enumValueNotSupported2,
127 						ConfigConstants.CONFIG_DIFF_SECTION,
128 						ConfigConstants.CONFIG_KEY_RENAMES, renameString));
129 			else if (renameBoolean.booleanValue())
130 				return RenameDetectionType.TRUE;
131 			else
132 				return RenameDetectionType.FALSE;
133 		}
134 	}
135 }