← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/monodevelop/oneiric

« back to all changes in this revision

Viewing changes to contrib/NGit/NGit.Treewalk.Filter/PathFilter.cs

  • Committer: Bazaar Package Importer
  • Author(s): Jo Shields
  • Date: 2011-06-27 17:03:13 UTC
  • mto: (1.8.1 upstream)
  • mto: This revision was merged to the branch mainline in revision 54.
  • Revision ID: james.westby@ubuntu.com-20110627170313-6cvz3s19x6e9hqe9
Import upstream version 2.5.92+dfsg

Show diffs side-by-side

added added

removed removed

Lines of Context:
contrib/NGit/NGit.Treewalk.Filter/PathFilter.cs
 
1
/*
 
2
This code is derived from jgit (http://eclipse.org/jgit).
 
3
Copyright owners are documented in jgit'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
using System;
 
45
using NGit;
 
46
using NGit.Treewalk;
 
47
using NGit.Treewalk.Filter;
 
48
using Sharpen;
 
49
 
 
50
namespace NGit.Treewalk.Filter
 
51
{
 
52
        /// <summary>Includes tree entries only if they match the configured path.</summary>
 
53
        /// <remarks>
 
54
        /// Includes tree entries only if they match the configured path.
 
55
        /// <p>
 
56
        /// Applications should use
 
57
        /// <see cref="PathFilterGroup">PathFilterGroup</see>
 
58
        /// to connect these into a tree
 
59
        /// filter graph, as the group supports breaking out of traversal once it is
 
60
        /// known the path can never match.
 
61
        /// </remarks>
 
62
        public class PathFilter : TreeFilter
 
63
        {
 
64
                /// <summary>Create a new tree filter for a user supplied path.</summary>
 
65
                /// <remarks>
 
66
                /// Create a new tree filter for a user supplied path.
 
67
                /// <p>
 
68
                /// Path strings are relative to the root of the repository. If the user's
 
69
                /// input should be assumed relative to a subdirectory of the repository the
 
70
                /// caller must prepend the subdirectory's path prior to creating the filter.
 
71
                /// <p>
 
72
                /// Path strings use '/' to delimit directories on all platforms.
 
73
                /// </remarks>
 
74
                /// <param name="path">
 
75
                /// the path to filter on. Must not be the empty string. All
 
76
                /// trailing '/' characters will be trimmed before string's length
 
77
                /// is checked or is used as part of the constructed filter.
 
78
                /// </param>
 
79
                /// <returns>a new filter for the requested path.</returns>
 
80
                /// <exception cref="System.ArgumentException">the path supplied was the empty string.
 
81
                ///     </exception>
 
82
                public static NGit.Treewalk.Filter.PathFilter Create(string path)
 
83
                {
 
84
                        while (path.EndsWith("/"))
 
85
                        {
 
86
                                path = Sharpen.Runtime.Substring(path, 0, path.Length - 1);
 
87
                        }
 
88
                        if (path.Length == 0)
 
89
                        {
 
90
                                throw new ArgumentException(JGitText.Get().emptyPathNotPermitted);
 
91
                        }
 
92
                        return new NGit.Treewalk.Filter.PathFilter(path);
 
93
                }
 
94
 
 
95
                internal readonly string pathStr;
 
96
 
 
97
                internal readonly byte[] pathRaw;
 
98
 
 
99
                private PathFilter(string s)
 
100
                {
 
101
                        pathStr = s;
 
102
                        pathRaw = Constants.Encode(pathStr);
 
103
                }
 
104
 
 
105
                /// <returns>the path this filter matches.</returns>
 
106
                public virtual string GetPath()
 
107
                {
 
108
                        return pathStr;
 
109
                }
 
110
 
 
111
                public override bool Include(TreeWalk walker)
 
112
                {
 
113
                        return walker.IsPathPrefix(pathRaw, pathRaw.Length) == 0;
 
114
                }
 
115
 
 
116
                public override bool ShouldBeRecursive()
 
117
                {
 
118
                        foreach (byte b in pathRaw)
 
119
                        {
 
120
                                if (b == '/')
 
121
                                {
 
122
                                        return true;
 
123
                                }
 
124
                        }
 
125
                        return false;
 
126
                }
 
127
 
 
128
                public override TreeFilter Clone()
 
129
                {
 
130
                        return this;
 
131
                }
 
132
 
 
133
                public override string ToString()
 
134
                {
 
135
                        return "PATH(\"" + pathStr + "\")";
 
136
                }
 
137
 
 
138
                /// <param name="walker">The walk to check against.</param>
 
139
                /// <returns>
 
140
                /// 
 
141
                /// <code>true</code>
 
142
                /// if the path length of this filter matches the length
 
143
                /// of the current path of the supplied TreeWalk.
 
144
                /// </returns>
 
145
                public virtual bool IsDone(TreeWalk walker)
 
146
                {
 
147
                        return pathRaw.Length == walker.GetPathLength();
 
148
                }
 
149
        }
 
150
}