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