← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/ignores.py

  • Committer: Alexander Belchenko
  • Date: 2006-07-30 16:43:12 UTC
  • mto: (1711.2.111 jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1906.
  • Revision ID: bialix@ukr.net-20060730164312-b025fd3ff0cee59e
rename  gpl.txt => COPYING.txt

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/ignores.py
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 Canonical Development 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
"""Lists of ignore files, etc."""
18
18
 
19
19
import errno
20
 
import os
21
 
from cStringIO import StringIO
22
 
 
23
 
import bzrlib
24
 
from bzrlib import (
25
 
    atomicfile,
26
 
    config,
27
 
    globbing,
28
 
    )
29
 
 
30
 
from trace import warning
 
20
 
 
21
from bzrlib import config
 
22
 
 
23
# This was the full ignore list for bzr 0.8
 
24
# please keep these sorted (in C locale order) to aid merging
 
25
OLD_DEFAULTS = [
 
26
    '#*#',
 
27
    '*$',
 
28
    '*,v',
 
29
    '*.BAK',
 
30
    '*.a',
 
31
    '*.bak',
 
32
    '*.elc',
 
33
    '*.exe',
 
34
    '*.la',
 
35
    '*.lo',
 
36
    '*.o',
 
37
    '*.obj',
 
38
    '*.orig',
 
39
    '*.py[oc]',
 
40
    '*.so',
 
41
    '*.tmp',
 
42
    '*~',
 
43
    '.#*',
 
44
    '.*.sw[nop]',
 
45
    '.*.tmp',
 
46
    # Our setup tests dump .python-eggs in the bzr source tree root
 
47
    './.python-eggs',
 
48
    '.DS_Store',
 
49
    '.arch-ids',
 
50
    '.arch-inventory',
 
51
    '.bzr.log',
 
52
    '.del-*',
 
53
    '.git',
 
54
    '.hg',
 
55
    '.jamdeps'
 
56
    '.libs',
 
57
    '.make.state',
 
58
    '.sconsign*',
 
59
    '.svn',
 
60
    '.sw[nop]',    # vim editing nameless file
 
61
    '.tmp*',
 
62
    'BitKeeper',
 
63
    'CVS',
 
64
    'CVS.adm',
 
65
    'RCS',
 
66
    'SCCS',
 
67
    'TAGS',
 
68
    '_darcs',
 
69
    'aclocal.m4',
 
70
    'autom4te*',
 
71
    'config.h',
 
72
    'config.h.in',
 
73
    'config.log',
 
74
    'config.status',
 
75
    'config.sub',
 
76
    'stamp-h',
 
77
    'stamp-h.in',
 
78
    'stamp-h1',
 
79
    '{arch}',
 
80
]
 
81
 
31
82
 
32
83
# ~/.bazaar/ignore will be filled out using
33
84
# this ignore list, if it does not exist
44
95
]
45
96
 
46
97
 
47
 
 
48
98
def parse_ignore_file(f):
49
 
    """Read in all of the lines in the file and turn it into an ignore list
50
 
    
51
 
    Continue in the case of utf8 decoding errors, and emit a warning when 
52
 
    such and error is found. Optimise for the common case -- no decoding 
53
 
    errors.
54
 
    """
 
99
    """Read in all of the lines in the file and turn it into an ignore list"""
55
100
    ignored = set()
56
 
    ignore_file = f.read()
57
 
    try:
58
 
        # Try and parse whole ignore file at once.
59
 
        unicode_lines = ignore_file.decode('utf8').split('\n')
60
 
    except UnicodeDecodeError:
61
 
        # Otherwise go though line by line and pick out the 'good'
62
 
        # decodable lines
63
 
        lines = ignore_file.split('\n')
64
 
        unicode_lines = []
65
 
        for line_number, line in enumerate(lines):
66
 
            try:
67
 
                unicode_lines.append(line.decode('utf-8'))
68
 
            except UnicodeDecodeError:
69
 
                # report error about line (idx+1)
70
 
                warning('.bzrignore: On Line #%d, malformed utf8 character. '
71
 
                        'Ignoring line.' % (line_number+1))
72
 
 
73
 
    # Append each line to ignore list if it's not a comment line
74
 
    for line in unicode_lines:
 
101
    for line in f.read().decode('utf8').split('\n'):
75
102
        line = line.rstrip('\r\n')
76
103
        if not line or line.startswith('#'):
77
104
            continue
78
 
        ignored.add(globbing.normalize_pattern(line))
 
105
        ignored.add(line)
79
106
    return ignored
80
107
 
81
108
 
136
163
    ignored = get_user_ignores()
137
164
    to_add = []
138
165
    for ignore in new_ignores:
139
 
        ignore = globbing.normalize_pattern(ignore)
140
166
        if ignore not in ignored:
141
167
            ignored.add(ignore)
142
168
            to_add.append(ignore)
162
188
 
163
189
    This is used by some plugins that want bzr to ignore files,
164
190
    but don't want to change a users ignore list.
165
 
    (Such as a conversion script that needs to ignore temporary files,
166
 
    but does not want to modify the project's ignore list.)
 
191
    (Such as a conversion script, that needs to ignore some files,
 
192
    but must preserve as much of the exact content boing converted.)
167
193
 
168
194
    :param ignores: A list or generator of ignore patterns.
169
195
    :return: None
175
201
def get_runtime_ignores():
176
202
    """Get the current set of runtime ignores."""
177
203
    return _runtime_ignores
178
 
 
179
 
 
180
 
def tree_ignores_add_patterns(tree, name_pattern_list):
181
 
    """Add more ignore patterns to the ignore file in a tree.
182
 
    If ignore file does not exist then it will be created.
183
 
    The ignore file will be automatically added under version control.
184
 
 
185
 
    :param tree: Working tree to update the ignore list.
186
 
    :param name_pattern_list: List of ignore patterns.
187
 
    :return: None
188
 
    """
189
 
    # read in the existing ignores set
190
 
    ifn = tree.abspath(bzrlib.IGNORE_FILENAME)
191
 
    if tree.has_filename(ifn):
192
 
        f = open(ifn, 'rU')
193
 
        try:
194
 
            file_contents = f.read()
195
 
            # figure out what kind of line endings are used
196
 
            newline = getattr(f, 'newlines', None)
197
 
            if type(newline) is tuple:
198
 
                newline = newline[0]
199
 
            elif newline is None:
200
 
                newline = os.linesep
201
 
        finally:
202
 
            f.close()
203
 
    else:
204
 
        file_contents = ""
205
 
        newline = os.linesep
206
 
    
207
 
    sio = StringIO(file_contents)
208
 
    try:
209
 
        ignores = parse_ignore_file(sio)
210
 
    finally:
211
 
        sio.close()
212
 
    
213
 
    # write out the updated ignores set
214
 
    f = atomicfile.AtomicFile(ifn, 'wb')
215
 
    try:
216
 
        # write the original contents, preserving original line endings
217
 
        f.write(newline.join(file_contents.split('\n')))
218
 
        if len(file_contents) > 0 and not file_contents.endswith('\n'):
219
 
            f.write(newline)
220
 
        for pattern in name_pattern_list:
221
 
            if not pattern in ignores:
222
 
                f.write(pattern.encode('utf-8'))
223
 
                f.write(newline)
224
 
        f.commit()
225
 
    finally:
226
 
        f.close()
227
 
 
228
 
    if not tree.path2id(bzrlib.IGNORE_FILENAME):
229
 
        tree.add([bzrlib.IGNORE_FILENAME])