1
# Copyright (C) 2006-2010 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
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
17
"""Tools for converting globs to regular expressions.
19
This module provides functions for converting shell-like globs to regular
25
from bzrlib import errors
26
from bzrlib.trace import (
32
class Replacer(object):
33
"""Do a multiple-pattern substitution.
35
The patterns and substitutions are combined into one, so the result of
36
one replacement is never substituted again. Add the patterns and
37
replacements via the add method and then call the object. The patterns
38
must not contain capturing groups.
41
_expand = re.compile(ur'\\&')
43
def __init__(self, source=None):
46
self._pats = list(source._pats)
47
self._funs = list(source._funs)
52
def add(self, pat, fun):
53
r"""Add a pattern and replacement.
55
The pattern must not contain capturing groups.
56
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
62
self._pats.append(pat)
63
self._funs.append(fun)
65
def add_replacer(self, replacer):
66
r"""Add all patterns from another replacer.
68
All patterns and replacements from replacer are appended to the ones
72
self._pats.extend(replacer._pats)
73
self._funs.extend(replacer._funs)
75
def __call__(self, text):
77
self._pat = re.compile(
78
u'|'.join([u'(%s)' % p for p in self._pats]),
80
return self._pat.sub(self._do_sub, text)
83
fun = self._funs[m.lastindex - 1]
84
if hasattr(fun, '__call__'):
85
return fun(m.group(0))
87
return self._expand.sub(m.group(0), fun)
90
_sub_named = Replacer()
91
_sub_named.add(ur'\[:digit:\]', ur'\d')
92
_sub_named.add(ur'\[:space:\]', ur'\s')
93
_sub_named.add(ur'\[:alnum:\]', ur'\w')
94
_sub_named.add(ur'\[:ascii:\]', ur'\0-\x7f')
95
_sub_named.add(ur'\[:blank:\]', ur' \t')
96
_sub_named.add(ur'\[:cntrl:\]', ur'\0-\x1f\x7f-\x9f')
100
if m[1] in (u'!', u'^'):
101
return u'[^' + _sub_named(m[2:-1]) + u']'
102
return u'[' + _sub_named(m[1:-1]) + u']'
105
def _invalid_regex(repl):
107
warning(u"'%s' not allowed within a regular expression. "
108
"Replacing with '%s'" % (m, repl))
113
def _trailing_backslashes_regex(m):
114
"""Check trailing backslashes.
116
Does a head count on trailing backslashes to ensure there isn't an odd
117
one on the end that would escape the brackets we wrap the RE in.
119
if (len(m) % 2) != 0:
120
warning(u"Regular expressions cannot end with an odd number of '\\'. "
121
"Dropping the final '\\'.")
127
_sub_re.add(u'^RE:', u'')
128
_sub_re.add(u'\((?!\?)', u'(?:')
129
_sub_re.add(u'\(\?P<.*>', _invalid_regex(u'(?:'))
130
_sub_re.add(u'\(\?P=[^)]*\)', _invalid_regex(u''))
131
_sub_re.add(ur'\\+$', _trailing_backslashes_regex)
134
_sub_fullpath = Replacer()
135
_sub_fullpath.add(ur'^RE:.*', _sub_re) # RE:<anything> is a regex
136
_sub_fullpath.add(ur'\[\^?\]?(?:[^][]|\[:[^]]+:\])+\]', _sub_group) # char group
137
_sub_fullpath.add(ur'(?:(?<=/)|^)(?:\.?/)+', u'') # canonicalize path
138
_sub_fullpath.add(ur'\\.', ur'\&') # keep anything backslashed
139
_sub_fullpath.add(ur'[(){}|^$+.]', ur'\\&') # escape specials
140
_sub_fullpath.add(ur'(?:(?<=/)|^)\*\*+/', ur'(?:.*/)?') # **/ after ^ or /
141
_sub_fullpath.add(ur'\*+', ur'[^/]*') # * elsewhere
142
_sub_fullpath.add(ur'\?', ur'[^/]') # ? everywhere
145
_sub_basename = Replacer()
146
_sub_basename.add(ur'\[\^?\]?(?:[^][]|\[:[^]]+:\])+\]', _sub_group) # char group
147
_sub_basename.add(ur'\\.', ur'\&') # keep anything backslashed
148
_sub_basename.add(ur'[(){}|^$+.]', ur'\\&') # escape specials
149
_sub_basename.add(ur'\*+', ur'.*') # * everywhere
150
_sub_basename.add(ur'\?', ur'.') # ? everywhere
153
def _sub_extension(pattern):
154
return _sub_basename(pattern[2:])
157
class Globster(object):
158
"""A simple wrapper for a set of glob patterns.
160
Provides the capability to search the patterns to find a match for
161
a given filename (including the full path).
163
Patterns are translated to regular expressions to expidite matching.
165
The regular expressions for multiple patterns are aggregated into
166
a super-regex containing groups of up to 99 patterns.
167
The 99 limitation is due to the grouping limit of the Python re module.
168
The resulting super-regex and associated patterns are stored as a list of
169
(regex,[patterns]) in _regex_patterns.
171
For performance reasons the patterns are categorised as extension patterns
172
(those that match against a file extension), basename patterns
173
(those that match against the basename of the filename),
174
and fullpath patterns (those that match against the full path).
175
The translations used for extensions and basenames are relatively simpler
176
and therefore faster to perform than the fullpath patterns.
178
Also, the extension patterns are more likely to find a match and
179
so are matched first, then the basename patterns, then the fullpath
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" ]
190
"translator" : _sub_extension,
191
"prefix" : r'(?:.*/)?(?!.*/)(?:.*\.)'
194
"translator" : _sub_basename,
195
"prefix" : r'(?:.*/)?(?!.*/)'
198
"translator" : _sub_fullpath,
203
def __init__(self, patterns):
204
self._regex_patterns = []
211
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"],
218
def _add_patterns(self, patterns, translator, prefix=''):
220
grouped_rules = ['(%s)' % translator(pat) for pat in patterns[:99]]
221
joined_rule = '%s(?:%s)$' % (prefix, '|'.join(grouped_rules))
222
self._regex_patterns.append((re.compile(joined_rule, re.UNICODE),
224
patterns = patterns[99:]
226
def match(self, filename):
227
"""Searches for a pattern that matches the given filename.
229
:return A matching pattern or None if there is no matching pattern.
232
for regex, patterns in self._regex_patterns:
233
match = regex.match(filename)
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)."
243
for _, patterns in self._regex_patterns:
245
if not Globster.is_pattern_valid(p):
246
bad_patterns += ('\n %s' % p)
247
e.msg += bad_patterns
252
def identify(pattern):
253
"""Returns pattern category.
255
:param pattern: normalized pattern.
256
Identify if a pattern is fullpath, basename or extension
257
and returns the appropriate type.
259
if pattern.startswith(u'RE:') or u'/' in pattern:
261
elif pattern.startswith(u'*.'):
267
def is_pattern_valid(pattern):
268
"""Returns True if pattern is valid.
270
:param pattern: Normalized pattern.
271
is_pattern_valid() assumes pattern to be normalized.
272
see: globbing.normalize_pattern
275
translator = Globster.pattern_info[Globster.identify(pattern)]["translator"]
276
tpattern = '(%s)' % translator(pattern)
278
re_obj = re.compile(tpattern, re.UNICODE)
279
re_obj.search("") # force compile
280
except errors.InvalidPattern, e:
285
class ExceptionGlobster(object):
286
"""A Globster that supports exception patterns.
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.
296
def __init__(self,patterns):
297
ignores = [[], [], []]
299
if p.startswith(u'!!'):
300
ignores[2].append(p[2:])
301
elif p.startswith(u'!'):
302
ignores[1].append(p[1:])
305
self._ignores = [Globster(i) for i in ignores]
307
def match(self, filename):
308
"""Searches for a pattern that matches the given filename.
310
:return A matching pattern or None if there is no matching pattern.
312
double_neg = self._ignores[2].match(filename)
314
return "!!%s" % double_neg
315
elif self._ignores[1].match(filename):
318
return self._ignores[0].match(filename)
320
class _OrderedGlobster(Globster):
321
"""A Globster that keeps pattern order."""
323
def __init__(self, patterns):
326
:param patterns: sequence of glob patterns
328
# Note: This could be smarter by running like sequences together
329
self._regex_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"])
337
_slashes = re.compile(r'[\\/]+')
338
def normalize_pattern(pattern):
339
"""Converts backslashes in path patterns to forward slashes.
341
Doesn't normalize regular expressions - they may contain escapes.
343
if not (pattern.startswith('RE:') or pattern.startswith('!RE:')):
344
pattern = _slashes.sub('/', pattern)
346
pattern = pattern.rstrip('/')
added
removed
bzrlib/globbing.py
