← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/globbing.py

  • Committer: Kent Gibson
  • Date: 2007-03-01 08:46:00 UTC
  • mto: (2319.1.1 jam-integration)
  • mto: This revision was merged to the branch mainline in revision 2320.
  • Revision ID: warthog618@gmail.com-20070301084600-mce8y9te2o548h5r
Normalise ignore patterns to use '/' path separator.
Also fixes bug 86451 where a trailing '\' crashes pattern matching.
Added detection and correction of trailing '\' in ignore REs that would
escape the closing bracket.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/globbing.py
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2006 Canonical Ltd
2
2
 
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""Tools for converting globs to regular expressions.
18
18
 
52
52
 
53
53
        The pattern must not contain capturing groups.
54
54
        The replacement might be either a string template in which \& will be
55
 
        replaced with the match, or a function that will get the matching text
56
 
        as argument. It does not get match object, because capturing is
 
55
        replaced with the match, or a function that will get the matching text  
 
56
        as argument. It does not get match object, because capturing is 
57
57
        forbidden anyway.
58
58
        """
59
59
        self._pat = None
109
109
 
110
110
 
111
111
def _trailing_backslashes_regex(m):
112
 
    """Check trailing backslashes.
113
 
 
114
 
    Does a head count on trailing backslashes to ensure there isn't an odd
115
 
    one on the end that would escape the brackets we wrap the RE in.
116
 
    """
117
 
    if (len(m) % 2) != 0:
 
112
    if len(m) %2  != 0:
118
113
        warning(u"Regular expressions cannot end with an odd number of '\\'. "
119
114
                "Dropping the final '\\'.")
120
115
        return m[:-1]
160
155
 
161
156
    Patterns are translated to regular expressions to expidite matching.
162
157
 
163
 
    The regular expressions for multiple patterns are aggregated into
164
 
    a super-regex containing groups of up to 99 patterns.
 
158
    The regular expressions for multiple patterns are aggregated into 
 
159
    a super-regex containing groups of up to 99 patterns.  
165
160
    The 99 limitation is due to the grouping limit of the Python re module.
166
161
    The resulting super-regex and associated patterns are stored as a list of
167
162
    (regex,[patterns]) in _regex_patterns.
168
 
 
 
163
    
169
164
    For performance reasons the patterns are categorised as extension patterns
170
165
    (those that match against a file extension), basename patterns
171
166
    (those that match against the basename of the filename),
172
167
    and fullpath patterns (those that match against the full path).
173
 
    The translations used for extensions and basenames are relatively simpler
 
168
    The translations used for extensions and basenames are relatively simpler 
174
169
    and therefore faster to perform than the fullpath patterns.
175
170
 
176
 
    Also, the extension patterns are more likely to find a match and
 
171
    Also, the extension patterns are more likely to find a match and 
177
172
    so are matched first, then the basename patterns, then the fullpath
178
173
    patterns.
179
174
    """
192
187
                base_patterns.append(pat)
193
188
        self._add_patterns(ext_patterns,_sub_extension,
194
189
            prefix=r'(?:.*/)?(?!.*/)(?:.*\.)')
195
 
        self._add_patterns(base_patterns,_sub_basename,
 
190
        self._add_patterns(base_patterns,_sub_basename, 
196
191
            prefix=r'(?:.*/)?(?!.*/)')
197
 
        self._add_patterns(path_patterns,_sub_fullpath)
 
192
        self._add_patterns(path_patterns,_sub_fullpath) 
198
193
 
199
194
    def _add_patterns(self, patterns, translator, prefix=''):
200
195
        while patterns:
201
196
            grouped_rules = ['(%s)' % translator(pat) for pat in patterns[:99]]
202
197
            joined_rule = '%s(?:%s)$' % (prefix, '|'.join(grouped_rules))
203
 
            self._regex_patterns.append((re.compile(joined_rule, re.UNICODE),
 
198
            self._regex_patterns.append((re.compile(joined_rule, re.UNICODE), 
204
199
                patterns[:99]))
205
200
            patterns = patterns[99:]
206
201
 
207
202
    def match(self, filename):
208
203
        """Searches for a pattern that matches the given filename.
209
 
 
 
204
        
210
205
        :return A matching pattern or None if there is no matching pattern.
211
206
        """
212
207
        for regex, patterns in self._regex_patterns:
214
209
            if match:
215
210
                return patterns[match.lastindex -1]
216
211
        return None
217
 
 
218
 
class ExceptionGlobster(object):
219
 
    """A Globster that supports exception patterns.
220
 
    
221
 
    Exceptions are ignore patterns prefixed with '!'.  Exception
222
 
    patterns take precedence over regular patterns and cause a 
223
 
    matching filename to return None from the match() function.  
224
 
    Patterns using a '!!' prefix are highest precedence, and act 
225
 
    as regular ignores. '!!' patterns are useful to establish ignores
226
 
    that apply under paths specified by '!' exception patterns.
227
 
    """
228
 
    
229
 
    def __init__(self,patterns):
230
 
        ignores = [[], [], []]
231
 
        for p in patterns:
232
 
            if p.startswith(u'!!'):
233
 
                ignores[2].append(p[2:])
234
 
            elif p.startswith(u'!'):
235
 
                ignores[1].append(p[1:])
236
 
            else:
237
 
                ignores[0].append(p)
238
 
        self._ignores = [Globster(i) for i in ignores]
239
212
        
240
 
    def match(self, filename):
241
 
        """Searches for a pattern that matches the given filename.
242
 
 
243
 
        :return A matching pattern or None if there is no matching pattern.
244
 
        """
245
 
        double_neg = self._ignores[2].match(filename)
246
 
        if double_neg:
247
 
            return "!!%s" % double_neg
248
 
        elif self._ignores[1].match(filename):
249
 
            return None
250
 
        else:
251
 
            return self._ignores[0].match(filename)
252
 
 
253
 
class _OrderedGlobster(Globster):
254
 
    """A Globster that keeps pattern order."""
255
 
 
256
 
    def __init__(self, patterns):
257
 
        """Constructor.
258
 
 
259
 
        :param patterns: sequence of glob patterns
260
 
        """
261
 
        # Note: This could be smarter by running like sequences together
262
 
        self._regex_patterns = []
263
 
        for pat in patterns:
264
 
            pat = normalize_pattern(pat)
265
 
            if pat.startswith(u'RE:') or u'/' in pat:
266
 
                self._add_patterns([pat], _sub_fullpath)
267
 
            elif pat.startswith(u'*.'):
268
 
                self._add_patterns([pat], _sub_extension,
269
 
                    prefix=r'(?:.*/)?(?!.*/)(?:.*\.)')
270
 
            else:
271
 
                self._add_patterns([pat], _sub_basename,
272
 
                    prefix=r'(?:.*/)?(?!.*/)')
273
 
 
274
 
 
275
 
_slashes = re.compile(r'[\\/]+')
 
213
 
 
214
_normalize_re = re.compile(ur'\\(?!x\d\d|\d\d\d|u\d\d\d\d)')
 
215
 
 
216
 
276
217
def normalize_pattern(pattern):
277
218
    """Converts backslashes in path patterns to forward slashes.
278
 
 
279
 
    Doesn't normalize regular expressions - they may contain escapes.
 
219
     
 
220
    Avoids converting escape backslashes.
280
221
    """
281
 
    if not (pattern.startswith('RE:') or pattern.startswith('!RE:')):
282
 
        pattern = _slashes.sub('/', pattern)
283
 
    if len(pattern) > 1:
284
 
        pattern = pattern.rstrip('/')
285
 
    return pattern
 
222
    if not pattern.startswith('RE:'):
 
223
        pattern = _normalize_re.sub('/', pattern)
 
224
    return pattern.rstrip('/')