1 /*
2 * Copyright (C) 2010, Marc Strapetz <marc.strapetz@syntevo.com>
3 * Copyright (C) 2012-2013, Robin Rosenberg
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 package org.eclipse.jgit.treewalk;
45
46 import org.eclipse.jgit.lib.Config;
47 import org.eclipse.jgit.lib.Config.SectionParser;
48 import org.eclipse.jgit.lib.ConfigConstants;
49 import org.eclipse.jgit.lib.CoreConfig.AutoCRLF;
50 import org.eclipse.jgit.lib.CoreConfig.CheckStat;
51 import org.eclipse.jgit.lib.CoreConfig.EOL;
52 import org.eclipse.jgit.lib.CoreConfig.HideDotFiles;
53 import org.eclipse.jgit.lib.CoreConfig.SymLinks;
54
55 /**
56 * Options used by the {@link org.eclipse.jgit.treewalk.WorkingTreeIterator}.
57 */
58 public class WorkingTreeOptions {
59 /** Key for {@link Config#get(SectionParser)}. */
60 public static final Config.SectionParser<WorkingTreeOptions> KEY =
61 WorkingTreeOptions::new;
62
63 private final boolean fileMode;
64
65 private final AutoCRLF autoCRLF;
66
67 private final EOL eol;
68
69 private final CheckStat checkStat;
70
71 private final SymLinks symlinks;
72
73 private final HideDotFiles hideDotFiles;
74
75 private final boolean dirNoGitLinks;
76
77 private WorkingTreeOptions(Config rc) {
78 fileMode = rc.getBoolean(ConfigConstants.CONFIG_CORE_SECTION,
79 ConfigConstants.CONFIG_KEY_FILEMODE, true);
80 autoCRLF = rc.getEnum(ConfigConstants.CONFIG_CORE_SECTION, null,
81 ConfigConstants.CONFIG_KEY_AUTOCRLF, AutoCRLF.FALSE);
82 eol = rc.getEnum(ConfigConstants.CONFIG_CORE_SECTION, null,
83 ConfigConstants.CONFIG_KEY_EOL, EOL.NATIVE);
84 checkStat = rc.getEnum(ConfigConstants.CONFIG_CORE_SECTION, null,
85 ConfigConstants.CONFIG_KEY_CHECKSTAT, CheckStat.DEFAULT);
86 symlinks = rc.getEnum(ConfigConstants.CONFIG_CORE_SECTION, null,
87 ConfigConstants.CONFIG_KEY_SYMLINKS, SymLinks.TRUE);
88 hideDotFiles = rc.getEnum(ConfigConstants.CONFIG_CORE_SECTION, null,
89 ConfigConstants.CONFIG_KEY_HIDEDOTFILES,
90 HideDotFiles.DOTGITONLY);
91 dirNoGitLinks = rc.getBoolean(ConfigConstants.CONFIG_CORE_SECTION, null,
92 ConfigConstants.CONFIG_KEY_DIRNOGITLINKS,
93 false);
94 }
95
96 /** @return true if the execute bit on working files should be trusted. */
97 /**
98 * Whether the execute bit on working files should be trusted.
99 *
100 * @return {@code true} if the execute bit on working files should be
101 * trusted.
102 */
103 public boolean isFileMode() {
104 return fileMode;
105 }
106
107 /**
108 * Get automatic CRLF conversion configuration.
109 *
110 * @return how automatic CRLF conversion has been configured.
111 */
112 public AutoCRLF getAutoCRLF() {
113 return autoCRLF;
114 }
115
116 /**
117 * Get how text line endings should be normalized.
118 *
119 * @return how text line endings should be normalized.
120 * @since 4.3
121 */
122 public EOL getEOL() {
123 return eol;
124 }
125
126 /**
127 * Get how stat data is compared.
128 *
129 * @return how stat data is compared.
130 * @since 3.0
131 */
132 public CheckStat getCheckStat() {
133 return checkStat;
134 }
135
136 /**
137 * Get how we handle symbolic links
138 *
139 * @return how we handle symbolic links
140 * @since 3.3
141 */
142 public SymLinks getSymLinks() {
143 return symlinks;
144 }
145
146 /**
147 * Get how we create '.'-files (on Windows)
148 *
149 * @return how we create '.'-files (on Windows)
150 * @since 3.5
151 */
152 public HideDotFiles getHideDotFiles() {
153 return hideDotFiles;
154 }
155
156 /**
157 * Whether or not we treat nested repos as directories.
158 *
159 * @return whether or not we treat nested repos as directories. If true,
160 * folders containing .git entries will not be treated as gitlinks.
161 * @since 4.3
162 */
163 public boolean isDirNoGitLinks() { return dirNoGitLinks; }
164 }