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 = DiffConfig::new;
58  
59  	/** Permissible values for {@code diff.renames}. */
60  	public static enum RenameDetectionType {
61  		/** Rename detection is disabled. */
62  		FALSE,
63  
64  		/** Rename detection is enabled. */
65  		TRUE,
66  
67  		/** Copies should be detected too. */
68  		COPY
69  	}
70  
71  	private final boolean noPrefix;
72  
73  	private final RenameDetectionType renameDetectionType;
74  
75  	private final int renameLimit;
76  
77  	private DiffConfig(final Config rc) {
78  		noPrefix = rc.getBoolean(ConfigConstants.CONFIG_DIFF_SECTION,
79  				ConfigConstants.CONFIG_KEY_NOPREFIX, false);
80  		renameDetectionType = parseRenameDetectionType(rc.getString(
81  				ConfigConstants.CONFIG_DIFF_SECTION, null, ConfigConstants.CONFIG_KEY_RENAMES));
82  		renameLimit = rc.getInt(ConfigConstants.CONFIG_DIFF_SECTION,
83  				ConfigConstants.CONFIG_KEY_RENAMELIMIT, 200);
84  	}
85  
86  	/** @return true if the prefix "a/" and "b/" should be suppressed. */
87  	public boolean isNoPrefix() {
88  		return noPrefix;
89  	}
90  
91  	/** @return true if rename detection is enabled by default. */
92  	public boolean isRenameDetectionEnabled() {
93  		return renameDetectionType != RenameDetectionType.FALSE;
94  	}
95  
96  	/** @return type of rename detection to perform. */
97  	public RenameDetectionType getRenameDetectionType() {
98  		return renameDetectionType;
99  	}
100 
101 	/** @return limit on number of paths to perform inexact rename detection. */
102 	public int getRenameLimit() {
103 		return renameLimit;
104 	}
105 
106 	private static RenameDetectionType parseRenameDetectionType(
107 			final String renameString) {
108 		if (renameString == null)
109 			return RenameDetectionType.FALSE;
110 		else if (StringUtils.equalsIgnoreCase(
111 				ConfigConstants.CONFIG_RENAMELIMIT_COPY, renameString)
112 				|| StringUtils
113 						.equalsIgnoreCase(
114 								ConfigConstants.CONFIG_RENAMELIMIT_COPIES,
115 								renameString))
116 			return RenameDetectionType.COPY;
117 		else {
118 			final Boolean renameBoolean = StringUtils
119 					.toBooleanOrNull(renameString);
120 			if (renameBoolean == null)
121 				throw new IllegalArgumentException(MessageFormat.format(
122 						JGitText.get().enumValueNotSupported2,
123 						ConfigConstants.CONFIG_DIFF_SECTION,
124 						ConfigConstants.CONFIG_KEY_RENAMES, renameString));
125 			else if (renameBoolean.booleanValue())
126 				return RenameDetectionType.TRUE;
127 			else
128 				return RenameDetectionType.FALSE;
129 		}
130 	}
131 }