← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/globbing.py

  • Committer: Ian Clatworthy
  • Date: 2007-08-13 14:33:10 UTC
  • mto: (2733.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 2734.
  • Revision ID: ian.clatworthy@internode.on.net-20070813143310-twhj4la0qnupvze8
Added Quick Start Summary

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
 
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
 
54
52
 
55
53
        The pattern must not contain capturing groups.
56
54
        The replacement might be either a string template in which \& will be
57
 
        replaced with the match, or a function that will get the matching text
58
 
        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 
59
57
        forbidden anyway.
60
58
        """
61
59
        self._pat = None
162
160
 
163
161
    Patterns are translated to regular expressions to expidite matching.
164
162
 
165
 
    The regular expressions for multiple patterns are aggregated into
166
 
    a super-regex containing groups of up to 99 patterns.
 
163
    The regular expressions for multiple patterns are aggregated into 
 
164
    a super-regex containing groups of up to 99 patterns.  
167
165
    The 99 limitation is due to the grouping limit of the Python re module.
168
166
    The resulting super-regex and associated patterns are stored as a list of
169
167
    (regex,[patterns]) in _regex_patterns.
170
 
 
 
168
    
171
169
    For performance reasons the patterns are categorised as extension patterns
172
170
    (those that match against a file extension), basename patterns
173
171
    (those that match against the basename of the filename),
174
172
    and fullpath patterns (those that match against the full path).
175
 
    The translations used for extensions and basenames are relatively simpler
 
173
    The translations used for extensions and basenames are relatively simpler 
176
174
    and therefore faster to perform than the fullpath patterns.
177
175
 
178
 
    Also, the extension patterns are more likely to find a match and
 
176
    Also, the extension patterns are more likely to find a match and 
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:
220
201
            grouped_rules = ['(%s)' % translator(pat) for pat in patterns[:99]]
221
202
            joined_rule = '%s(?:%s)$' % (prefix, '|'.join(grouped_rules))
222
 
            self._regex_patterns.append((re.compile(joined_rule, re.UNICODE),
 
203
            self._regex_patterns.append((re.compile(joined_rule, re.UNICODE), 
223
204
                patterns[:99]))
224
205
            patterns = patterns[99:]
225
206
 
226
207
    def match(self, filename):
227
208
        """Searches for a pattern that matches the given filename.
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
 
 
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
217
        
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
 
 
320
 
class _OrderedGlobster(Globster):
321
 
    """A Globster that keeps pattern order."""
322
 
 
323
 
    def __init__(self, patterns):
324
 
        """Constructor.
325
 
 
326
 
        :param patterns: sequence of glob patterns
327
 
        """
328
 
        # Note: This could be smarter by running like sequences together
329
 
        self._regex_patterns = []
330
 
        for pat in patterns:
331
 
            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'[\\/]+')
 
218
 
338
219
def normalize_pattern(pattern):
339
220
    """Converts backslashes in path patterns to forward slashes.
340
 
 
 
221
    
341
222
    Doesn't normalize regular expressions - they may contain escapes.
342
223
    """
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
 
224
    if not pattern.startswith('RE:'):
 
225
        pattern = pattern.replace('\\','/')
 
226
    return pattern.rstrip('/')