View Javadoc
1   /*
2    * Copyright (C) 2010, Red Hat 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  package org.eclipse.jgit.attributes;
44  
45  import java.io.BufferedReader;
46  import java.io.IOException;
47  import java.io.InputStream;
48  import java.io.InputStreamReader;
49  import java.util.ArrayList;
50  import java.util.Collections;
51  import java.util.List;
52  
53  import org.eclipse.jgit.lib.Constants;
54  
55  /**
56   * Represents a bundle of attributes inherited from a base directory.
57   *
58   * This class is not thread safe, it maintains state about the last match.
59   *
60   * @since 3.7
61   */
62  public class AttributesNode {
63  	/** The rules that have been parsed into this node. */
64  	private final List<AttributesRule> rules;
65  
66  	/**
67  	 * Create an empty ignore node with no rules.
68  	 */
69  	public AttributesNode() {
70  		rules = new ArrayList<>();
71  	}
72  
73  	/**
74  	 * Create an ignore node with given rules.
75  	 *
76  	 * @param rules
77  	 *            list of rules.
78  	 */
79  	public AttributesNode(List<AttributesRule> rules) {
80  		this.rules = rules;
81  	}
82  
83  	/**
84  	 * Parse files according to gitattribute standards.
85  	 *
86  	 * @param in
87  	 *            input stream holding the standard ignore format. The caller is
88  	 *            responsible for closing the stream.
89  	 * @throws java.io.IOException
90  	 *             Error thrown when reading an ignore file.
91  	 */
92  	public void parse(InputStream in) throws IOException {
93  		BufferedReader br = asReader(in);
94  		String txt;
95  		while ((txt = br.readLine()) != null) {
96  			txt = txt.trim();
97  			if (txt.length() > 0 && !txt.startsWith("#") /* Comments *///$NON-NLS-1$
98  					&& !txt.startsWith("!") /* Negative pattern forbidden for attributes */) { //$NON-NLS-1$
99  				int patternEndSpace = txt.indexOf(' ');
100 				int patternEndTab = txt.indexOf('\t');
101 
102 				final int patternEnd;
103 				if (patternEndSpace == -1)
104 					patternEnd = patternEndTab;
105 				else if (patternEndTab == -1)
106 					patternEnd = patternEndSpace;
107 				else
108 					patternEnd = Math.min(patternEndSpace, patternEndTab);
109 
110 				if (patternEnd > -1)
111 					rules.add(new AttributesRule(txt.substring(0, patternEnd),
112 							txt.substring(patternEnd + 1).trim()));
113 			}
114 		}
115 	}
116 
117 	private static BufferedReader asReader(InputStream in) {
118 		return new BufferedReader(new InputStreamReader(in, Constants.CHARSET));
119 	}
120 
121 	/**
122 	 * Getter for the field <code>rules</code>.
123 	 *
124 	 * @return list of all ignore rules held by this node
125 	 */
126 	public List<AttributesRule> getRules() {
127 		return Collections.unmodifiableList(rules);
128 	}
129 
130 }