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 /** Options used by the {@link WorkingTreeIterator}. */
56 public class WorkingTreeOptions {
57 /** Key for {@link Config#get(SectionParser)}. */
58 public static final Config.SectionParser<WorkingTreeOptions> KEY = new SectionParser<WorkingTreeOptions>() {
59 @Override
60 public WorkingTreeOptions parse(final Config cfg) {
61 return new WorkingTreeOptions(cfg);
62 }
63 };
64
65 private final boolean fileMode;
66
67 private final AutoCRLF autoCRLF;
68
69 private final EOL eol;
70
71 private final CheckStat checkStat;
72
73 private final SymLinks symlinks;
74
75 private final HideDotFiles hideDotFiles;
76
77 private final boolean dirNoGitLinks;
78
79 private WorkingTreeOptions(final Config rc) {
80 fileMode = rc.getBoolean(ConfigConstants.CONFIG_CORE_SECTION,
81 ConfigConstants.CONFIG_KEY_FILEMODE, true);
82 autoCRLF = rc.getEnum(ConfigConstants.CONFIG_CORE_SECTION, null,
83 ConfigConstants.CONFIG_KEY_AUTOCRLF, AutoCRLF.FALSE);
84 eol = rc.getEnum(ConfigConstants.CONFIG_CORE_SECTION, null,
85 ConfigConstants.CONFIG_KEY_EOL, EOL.NATIVE);
86 checkStat = rc.getEnum(ConfigConstants.CONFIG_CORE_SECTION, null,
87 ConfigConstants.CONFIG_KEY_CHECKSTAT, CheckStat.DEFAULT);
88 symlinks = rc.getEnum(ConfigConstants.CONFIG_CORE_SECTION, null,
89 ConfigConstants.CONFIG_KEY_SYMLINKS, SymLinks.TRUE);
90 hideDotFiles = rc.getEnum(ConfigConstants.CONFIG_CORE_SECTION, null,
91 ConfigConstants.CONFIG_KEY_HIDEDOTFILES,
92 HideDotFiles.DOTGITONLY);
93 dirNoGitLinks = rc.getBoolean(ConfigConstants.CONFIG_CORE_SECTION, null,
94 ConfigConstants.CONFIG_KEY_DIRNOGITLINKS,
95 false);
96 }
97
98 /** @return true if the execute bit on working files should be trusted. */
99 public boolean isFileMode() {
100 return fileMode;
101 }
102
103 /** @return how automatic CRLF conversion has been configured. */
104 public AutoCRLF getAutoCRLF() {
105 return autoCRLF;
106 }
107
108 /**
109 * @return how text line endings should be normalized.
110 *
111 * @since 4.3
112 */
113 public EOL getEOL() {
114 return eol;
115 }
116
117 /**
118 * @return how stat data is compared
119 * @since 3.0
120 */
121 public CheckStat getCheckStat() {
122 return checkStat;
123 }
124
125 /**
126 * @return how we handle symbolic links
127 * @since 3.3
128 */
129 public SymLinks getSymLinks() {
130 return symlinks;
131 }
132
133 /**
134 * @return how we create '.'-files (on Windows)
135 * @since 3.5
136 */
137 public HideDotFiles getHideDotFiles() {
138 return hideDotFiles;
139 }
140
141 /**
142 * @return whether or not we treat nested repos as directories.
143 * If true, folders containing .git entries will not be
144 * treated as gitlinks.
145 * @since 4.3
146 */
147 public boolean isDirNoGitLinks() { return dirNoGitLinks; }
148 }