1
# Copyright (C) 2005, 2006 Canonical Ltd
1
# Copyright (C) 2006-2011 Canonical Ltd
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
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
17
"""Lists of ignore files, etc."""
21
from cStringIO import StringIO
24
from bzrlib.lazy_import import lazy_import
25
lazy_import(globals(), """
22
26
from bzrlib import (
28
# This was the full ignore list for bzr 0.8
29
# please keep these sorted (in C locale order) to aid merging
51
# Our setup tests dump .python-eggs in the bzr source tree root
65
'.sw[nop]', # vim editing nameless file
32
from trace import warning
88
35
# ~/.bazaar/ignore will be filled out using
89
36
# this ignore list, if it does not exist
103
53
def parse_ignore_file(f):
104
"""Read in all of the lines in the file and turn it into an ignore list"""
54
"""Read in all of the lines in the file and turn it into an ignore list
56
Continue in the case of utf8 decoding errors, and emit a warning when
57
such and error is found. Optimise for the common case -- no decoding
106
for line in f.read().decode('utf8').split('\n'):
61
ignore_file = f.read()
63
# Try and parse whole ignore file at once.
64
unicode_lines = ignore_file.decode('utf8').split('\n')
65
except UnicodeDecodeError:
66
# Otherwise go though line by line and pick out the 'good'
68
lines = ignore_file.split('\n')
70
for line_number, line in enumerate(lines):
72
unicode_lines.append(line.decode('utf-8'))
73
except UnicodeDecodeError:
74
# report error about line (idx+1)
75
warning('.bzrignore: On Line #%d, malformed utf8 character. '
76
'Ignoring line.' % (line_number+1))
78
# Append each line to ignore list if it's not a comment line
79
for line in unicode_lines:
107
80
line = line.rstrip('\r\n')
108
81
if not line or line.startswith('#'):
212
185
def tree_ignores_add_patterns(tree, name_pattern_list):
213
"""Retrieve a list of ignores from the ignore file in a tree.
186
"""Add more ignore patterns to the ignore file in a tree.
187
If ignore file does not exist then it will be created.
188
The ignore file will be automatically added under version control.
215
:param tree: Tree to retrieve the ignore list from.
190
:param tree: Working tree to update the ignore list.
191
:param name_pattern_list: List of ignore patterns.
194
# read in the existing ignores set
218
195
ifn = tree.abspath(bzrlib.IGNORE_FILENAME)
219
196
if tree.has_filename(ifn):
222
igns = f.read().decode('utf-8')
199
file_contents = f.read()
200
# figure out what kind of line endings are used
201
newline = getattr(f, 'newlines', None)
202
if type(newline) is tuple:
204
elif newline is None:
228
# TODO: If the file already uses crlf-style termination, maybe
229
# we should use that for the newly added lines?
231
if igns and igns[-1] != '\n':
233
for name_pattern in name_pattern_list:
234
igns += name_pattern + '\n'
212
sio = StringIO(file_contents)
214
ignores = parse_ignore_file(sio)
218
# write out the updated ignores set
236
219
f = atomicfile.AtomicFile(ifn, 'wb')
238
f.write(igns.encode('utf-8'))
221
# write the original contents, preserving original line endings
222
f.write(newline.join(file_contents.split('\n')))
223
if len(file_contents) > 0 and not file_contents.endswith('\n'):
225
for pattern in name_pattern_list:
226
if not pattern in ignores:
227
f.write(pattern.encode('utf-8'))
243
if not tree.path2id('.bzrignore'):
244
tree.add(['.bzrignore'])
233
if not tree.path2id(bzrlib.IGNORE_FILENAME):
234
tree.add([bzrlib.IGNORE_FILENAME])