~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/ignores.py

  • Committer: Martin Pool
  • Date: 2010-01-29 14:09:05 UTC
  • mto: This revision was merged to the branch mainline in revision 4992.
  • Revision ID: mbp@sourcefrog.net-20100129140905-2uiarb6p8di1ywsr
Correction to url

from review: https://code.edge.launchpad.net/~mbp/bzr/doc/+merge/18250

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 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
17
17
"""Lists of ignore files, etc."""
18
18
 
19
19
import errno
20
 
import os
21
 
from cStringIO import StringIO
22
20
 
23
21
import bzrlib
24
22
from bzrlib import (
27
25
    globbing,
28
26
    )
29
27
 
30
 
from trace import warning
 
28
# This was the full ignore list for bzr 0.8
 
29
# please keep these sorted (in C locale order) to aid merging
 
30
OLD_DEFAULTS = [
 
31
    '#*#',
 
32
    '*$',
 
33
    '*,v',
 
34
    '*.BAK',
 
35
    '*.a',
 
36
    '*.bak',
 
37
    '*.elc',
 
38
    '*.exe',
 
39
    '*.la',
 
40
    '*.lo',
 
41
    '*.o',
 
42
    '*.obj',
 
43
    '*.orig',
 
44
    '*.py[oc]',
 
45
    '*.so',
 
46
    '*.tmp',
 
47
    '*~',
 
48
    '.#*',
 
49
    '.*.sw[nop]',
 
50
    '.*.tmp',
 
51
    # Our setup tests dump .python-eggs in the bzr source tree root
 
52
    './.python-eggs',
 
53
    '.DS_Store',
 
54
    '.arch-ids',
 
55
    '.arch-inventory',
 
56
    '.bzr.log',
 
57
    '.del-*',
 
58
    '.git',
 
59
    '.hg',
 
60
    '.jamdeps'
 
61
    '.libs',
 
62
    '.make.state',
 
63
    '.sconsign*',
 
64
    '.svn',
 
65
    '.sw[nop]',    # vim editing nameless file
 
66
    '.tmp*',
 
67
    'BitKeeper',
 
68
    'CVS',
 
69
    'CVS.adm',
 
70
    'RCS',
 
71
    'SCCS',
 
72
    'TAGS',
 
73
    '_darcs',
 
74
    'aclocal.m4',
 
75
    'autom4te*',
 
76
    'config.h',
 
77
    'config.h.in',
 
78
    'config.log',
 
79
    'config.status',
 
80
    'config.sub',
 
81
    'stamp-h',
 
82
    'stamp-h.in',
 
83
    'stamp-h1',
 
84
    '{arch}',
 
85
]
 
86
 
31
87
 
32
88
# ~/.bazaar/ignore will be filled out using
33
89
# this ignore list, if it does not exist
44
100
]
45
101
 
46
102
 
47
 
 
48
103
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
 
    """
 
104
    """Read in all of the lines in the file and turn it into an ignore list"""
55
105
    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:
 
106
    for line in f.read().decode('utf8').split('\n'):
75
107
        line = line.rstrip('\r\n')
76
108
        if not line or line.startswith('#'):
77
109
            continue
178
210
 
179
211
 
180
212
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.
 
213
    """Retrieve a list of ignores from the ignore file in a tree.
184
214
 
185
 
    :param tree: Working tree to update the ignore list.
186
 
    :param name_pattern_list: List of ignore patterns.
187
 
    :return: None
 
215
    :param tree: Tree to retrieve the ignore list from.
 
216
    :return:
188
217
    """
189
 
    # read in the existing ignores set
190
218
    ifn = tree.abspath(bzrlib.IGNORE_FILENAME)
191
219
    if tree.has_filename(ifn):
192
 
        f = open(ifn, 'rU')
 
220
        f = open(ifn, 'rt')
193
221
        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
 
222
            igns = f.read().decode('utf-8')
201
223
        finally:
202
224
            f.close()
203
225
    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
 
226
        igns = ""
 
227
 
 
228
    # TODO: If the file already uses crlf-style termination, maybe
 
229
    # we should use that for the newly added lines?
 
230
 
 
231
    if igns and igns[-1] != '\n':
 
232
        igns += '\n'
 
233
    for name_pattern in name_pattern_list:
 
234
        igns += name_pattern + '\n'
 
235
 
214
236
    f = atomicfile.AtomicFile(ifn, 'wb')
215
237
    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)
 
238
        f.write(igns.encode('utf-8'))
224
239
        f.commit()
225
240
    finally:
226
241
        f.close()
227
242
 
228
 
    if not tree.path2id(bzrlib.IGNORE_FILENAME):
229
 
        tree.add([bzrlib.IGNORE_FILENAME])
 
243
    if not tree.path2id('.bzrignore'):
 
244
        tree.add(['.bzrignore'])