← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/globbing.py

  • Committer: Martin Pool
  • Date: 2009-08-14 12:08:08 UTC
  • mto: This revision was merged to the branch mainline in revision 4614.
  • Revision ID: mbp@sourcefrog.net-20090814120808-4gvx7fhg44z29cj3
Use platform(aliased=1)

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, 2008 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
22
22
 
23
23
import re
24
24
 
25
 
from bzrlib import errors
26
25
from bzrlib.trace import (
27
 
    mutter,
28
 
    warning,
 
26
    warning
29
27
    )
30
28
 
31
29
 
179
177
    so are matched first, then the basename patterns, then the fullpath
180
178
    patterns.
181
179
    """
182
 
    # We want to _add_patterns in a specific order (as per type_list below)
183
 
    # starting with the shortest and going to the longest.
184
 
    # As some Python version don't support ordered dicts the list below is
185
 
    # used to select inputs for _add_pattern in a specific order.
186
 
    pattern_types = [ "extension", "basename", "fullpath" ]
187
 
 
188
 
    pattern_info = {
189
 
        "extension" : {
190
 
            "translator" : _sub_extension,
191
 
            "prefix" : r'(?:.*/)?(?!.*/)(?:.*\.)'
192
 
        },
193
 
        "basename" : {
194
 
            "translator" : _sub_basename,
195
 
            "prefix" : r'(?:.*/)?(?!.*/)'
196
 
        },
197
 
        "fullpath" : {
198
 
            "translator" : _sub_fullpath,
199
 
            "prefix" : r''
200
 
        },
201
 
    }
202
 
 
203
180
    def __init__(self, patterns):
204
181
        self._regex_patterns = []
205
 
        pattern_lists = {
206
 
            "extension" : [],
207
 
            "basename" : [],
208
 
            "fullpath" : [],
209
 
        }
 
182
        path_patterns = []
 
183
        base_patterns = []
 
184
        ext_patterns = []
210
185
        for pat in patterns:
211
186
            pat = normalize_pattern(pat)
212
 
            pattern_lists[Globster.identify(pat)].append(pat)
213
 
        pi = Globster.pattern_info
214
 
        for t in Globster.pattern_types:
215
 
            self._add_patterns(pattern_lists[t], pi[t]["translator"],
216
 
                pi[t]["prefix"])
 
187
            if pat.startswith(u'RE:') or u'/' in pat:
 
188
                path_patterns.append(pat)
 
189
            elif pat.startswith(u'*.'):
 
190
                ext_patterns.append(pat)
 
191
            else:
 
192
                base_patterns.append(pat)
 
193
        self._add_patterns(ext_patterns,_sub_extension,
 
194
            prefix=r'(?:.*/)?(?!.*/)(?:.*\.)')
 
195
        self._add_patterns(base_patterns,_sub_basename,
 
196
            prefix=r'(?:.*/)?(?!.*/)')
 
197
        self._add_patterns(path_patterns,_sub_fullpath)
217
198
 
218
199
    def _add_patterns(self, patterns, translator, prefix=''):
219
200
        while patterns:
228
209
 
229
210
        :return A matching pattern or None if there is no matching pattern.
230
211
        """
231
 
        try:
232
 
            for regex, patterns in self._regex_patterns:
233
 
                match = regex.match(filename)
234
 
                if match:
235
 
                    return patterns[match.lastindex -1]
236
 
        except errors.InvalidPattern, e:
237
 
            # We can't show the default e.msg to the user as thats for
238
 
            # the combined pattern we sent to regex. Instead we indicate to
239
 
            # the user that an ignore file needs fixing.
240
 
            mutter('Invalid pattern found in regex: %s.', e.msg)
241
 
            e.msg = "File ~/.bazaar/ignore or .bzrignore contains error(s)."
242
 
            bad_patterns = ''
243
 
            for _, patterns in self._regex_patterns:
244
 
                for p in patterns:
245
 
                    if not Globster.is_pattern_valid(p):
246
 
                        bad_patterns += ('\n  %s' % p)
247
 
            e.msg += bad_patterns
248
 
            raise e
 
212
        for regex, patterns in self._regex_patterns:
 
213
            match = regex.match(filename)
 
214
            if match:
 
215
                return patterns[match.lastindex -1]
249
216
        return None
250
217
 
251
 
    @staticmethod
252
 
    def identify(pattern):
253
 
        """Returns pattern category.
254
 
 
255
 
        :param pattern: normalized pattern.
256
 
        Identify if a pattern is fullpath, basename or extension
257
 
        and returns the appropriate type.
258
 
        """
259
 
        if pattern.startswith(u'RE:') or u'/' in pattern:
260
 
            return "fullpath"
261
 
        elif pattern.startswith(u'*.'):
262
 
            return "extension"
263
 
        else:
264
 
            return "basename"
265
 
 
266
 
    @staticmethod
267
 
    def is_pattern_valid(pattern):
268
 
        """Returns True if pattern is valid.
269
 
 
270
 
        :param pattern: Normalized pattern.
271
 
        is_pattern_valid() assumes pattern to be normalized.
272
 
        see: globbing.normalize_pattern
273
 
        """
274
 
        result = True
275
 
        translator = Globster.pattern_info[Globster.identify(pattern)]["translator"]
276
 
        tpattern = '(%s)' % translator(pattern)
277
 
        try:
278
 
            re_obj = re.compile(tpattern, re.UNICODE)
279
 
            re_obj.search("") # force compile
280
 
        except errors.InvalidPattern, e:
281
 
            result = False
282
 
        return result
283
 
 
284
 
 
285
 
class ExceptionGlobster(object):
286
 
    """A Globster that supports exception patterns.
287
 
    
288
 
    Exceptions are ignore patterns prefixed with '!'.  Exception
289
 
    patterns take precedence over regular patterns and cause a 
290
 
    matching filename to return None from the match() function.  
291
 
    Patterns using a '!!' prefix are highest precedence, and act 
292
 
    as regular ignores. '!!' patterns are useful to establish ignores
293
 
    that apply under paths specified by '!' exception patterns.
294
 
    """
295
 
    
296
 
    def __init__(self,patterns):
297
 
        ignores = [[], [], []]
298
 
        for p in patterns:
299
 
            if p.startswith(u'!!'):
300
 
                ignores[2].append(p[2:])
301
 
            elif p.startswith(u'!'):
302
 
                ignores[1].append(p[1:])
303
 
            else:
304
 
                ignores[0].append(p)
305
 
        self._ignores = [Globster(i) for i in ignores]
306
 
        
307
 
    def match(self, filename):
308
 
        """Searches for a pattern that matches the given filename.
309
 
 
310
 
        :return A matching pattern or None if there is no matching pattern.
311
 
        """
312
 
        double_neg = self._ignores[2].match(filename)
313
 
        if double_neg:
314
 
            return "!!%s" % double_neg
315
 
        elif self._ignores[1].match(filename):
316
 
            return None
317
 
        else:
318
 
            return self._ignores[0].match(filename)
319
218
 
320
219
class _OrderedGlobster(Globster):
321
220
    """A Globster that keeps pattern order."""
329
228
        self._regex_patterns = []
330
229
        for pat in patterns:
331
230
            pat = normalize_pattern(pat)
332
 
            t = Globster.identify(pat)
333
 
            self._add_patterns([pat], Globster.pattern_info[t]["translator"],
334
 
                Globster.pattern_info[t]["prefix"])
335
 
 
336
 
 
337
 
_slashes = re.compile(r'[\\/]+')
 
231
            if pat.startswith(u'RE:') or u'/' in pat:
 
232
                self._add_patterns([pat], _sub_fullpath)
 
233
            elif pat.startswith(u'*.'):
 
234
                self._add_patterns([pat], _sub_extension,
 
235
                    prefix=r'(?:.*/)?(?!.*/)(?:.*\.)')
 
236
            else:
 
237
                self._add_patterns([pat], _sub_basename,
 
238
                    prefix=r'(?:.*/)?(?!.*/)')
 
239
 
 
240
 
338
241
def normalize_pattern(pattern):
339
242
    """Converts backslashes in path patterns to forward slashes.
340
243
 
341
244
    Doesn't normalize regular expressions - they may contain escapes.
342
245
    """
343
 
    if not (pattern.startswith('RE:') or pattern.startswith('!RE:')):
344
 
        pattern = _slashes.sub('/', pattern)
345
 
    if len(pattern) > 1:
346
 
        pattern = pattern.rstrip('/')
347
 
    return pattern
 
246
    if not pattern.startswith('RE:'):
 
247
        pattern = pattern.replace('\\','/')
 
248
    return pattern.rstrip('/')