~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

  • Committer: Andrew Bennetts
  • Date: 2009-12-04 06:13:25 UTC
  • mto: This revision was merged to the branch mainline in revision 4869.
  • Revision ID: andrew.bennetts@canonical.com-20091204061325-8s0wghkp5if1ywiu
Tweaks suggested by John.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd.
 
1
# Copyright (C) 2004, 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
import difflib
18
18
import os
19
19
import re
 
20
import shutil
20
21
import string
21
22
import sys
22
23
 
30
31
from bzrlib import (
31
32
    branch as _mod_branch,
32
33
    bzrdir,
33
 
    cmdline,
34
 
    cleanup,
 
34
    commands,
35
35
    errors,
36
36
    osutils,
37
37
    patiencediff,
39
39
    timestamp,
40
40
    views,
41
41
    )
42
 
 
43
 
from bzrlib.workingtree import WorkingTree
44
42
""")
45
43
 
46
 
from bzrlib.registry import (
47
 
    Registry,
48
 
    )
49
44
from bzrlib.symbol_versioning import (
50
45
    deprecated_function,
51
 
    deprecated_in,
52
46
    )
53
47
from bzrlib.trace import mutter, note, warning
54
48
 
290
284
                        new_abspath, e)
291
285
 
292
286
 
293
 
@deprecated_function(deprecated_in((2, 2, 0)))
294
287
def get_trees_and_branches_to_diff(path_list, revision_specs, old_url, new_url,
295
288
                                   apply_view=True):
296
289
    """Get the trees and specific files to diff given a list of paths.
315
308
    :returns:
316
309
        a tuple of (old_tree, new_tree, old_branch, new_branch,
317
310
        specific_files, extra_trees) where extra_trees is a sequence of
318
 
        additional trees to search in for file-ids.  The trees and branches
319
 
        are not locked.
320
 
    """
321
 
    op = cleanup.OperationWithCleanups(get_trees_and_branches_to_diff_locked)
322
 
    return op.run_simple(path_list, revision_specs, old_url, new_url,
323
 
            op.add_cleanup, apply_view=apply_view)
324
 
    
325
 
 
326
 
def get_trees_and_branches_to_diff_locked(
327
 
    path_list, revision_specs, old_url, new_url, add_cleanup, apply_view=True):
328
 
    """Get the trees and specific files to diff given a list of paths.
329
 
 
330
 
    This method works out the trees to be diff'ed and the files of
331
 
    interest within those trees.
332
 
 
333
 
    :param path_list:
334
 
        the list of arguments passed to the diff command
335
 
    :param revision_specs:
336
 
        Zero, one or two RevisionSpecs from the diff command line,
337
 
        saying what revisions to compare.
338
 
    :param old_url:
339
 
        The url of the old branch or tree. If None, the tree to use is
340
 
        taken from the first path, if any, or the current working tree.
341
 
    :param new_url:
342
 
        The url of the new branch or tree. If None, the tree to use is
343
 
        taken from the first path, if any, or the current working tree.
344
 
    :param add_cleanup:
345
 
        a callable like Command.add_cleanup.  get_trees_and_branches_to_diff
346
 
        will register cleanups that must be run to unlock the trees, etc.
347
 
    :param apply_view:
348
 
        if True and a view is set, apply the view or check that the paths
349
 
        are within it
350
 
    :returns:
351
 
        a tuple of (old_tree, new_tree, old_branch, new_branch,
352
 
        specific_files, extra_trees) where extra_trees is a sequence of
353
 
        additional trees to search in for file-ids.  The trees and branches
354
 
        will be read-locked until the cleanups registered via the add_cleanup
355
 
        param are run.
 
311
        additional trees to search in for file-ids.
356
312
    """
357
313
    # Get the old and new revision specs
358
314
    old_revision_spec = None
381
337
        default_location = path_list[0]
382
338
        other_paths = path_list[1:]
383
339
 
384
 
    def lock_tree_or_branch(wt, br):
385
 
        if wt is not None:
386
 
            wt.lock_read()
387
 
            add_cleanup(wt.unlock)
388
 
        elif br is not None:
389
 
            br.lock_read()
390
 
            add_cleanup(br.unlock)
391
 
 
392
340
    # Get the old location
393
341
    specific_files = []
394
342
    if old_url is None:
395
343
        old_url = default_location
396
344
    working_tree, branch, relpath = \
397
345
        bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
398
 
    lock_tree_or_branch(working_tree, branch)
399
346
    if consider_relpath and relpath != '':
400
347
        if working_tree is not None and apply_view:
401
348
            views.check_path_in_view(working_tree, relpath)
409
356
    if new_url != old_url:
410
357
        working_tree, branch, relpath = \
411
358
            bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
412
 
        lock_tree_or_branch(working_tree, branch)
413
359
        if consider_relpath and relpath != '':
414
360
            if working_tree is not None and apply_view:
415
361
                views.check_path_in_view(working_tree, relpath)
463
409
                    old_label='a/', new_label='b/',
464
410
                    extra_trees=None,
465
411
                    path_encoding='utf8',
466
 
                    using=None,
467
 
                    format_cls=None):
 
412
                    using=None):
468
413
    """Show in text form the changes from one tree to another.
469
414
 
470
 
    :param to_file: The output stream.
471
 
    :param specific_files:Include only changes to these files - None for all
472
 
        changes.
473
 
    :param external_diff_options: If set, use an external GNU diff and pass 
474
 
        these options.
475
 
    :param extra_trees: If set, more Trees to use for looking up file ids
476
 
    :param path_encoding: If set, the path will be encoded as specified, 
477
 
        otherwise is supposed to be utf8
478
 
    :param format_cls: Formatter class (DiffTree subclass)
 
415
    to_file
 
416
        The output stream.
 
417
 
 
418
    specific_files
 
419
        Include only changes to these files - None for all changes.
 
420
 
 
421
    external_diff_options
 
422
        If set, use an external GNU diff and pass these options.
 
423
 
 
424
    extra_trees
 
425
        If set, more Trees to use for looking up file ids
 
426
 
 
427
    path_encoding
 
428
        If set, the path will be encoded as specified, otherwise is supposed
 
429
        to be utf8
479
430
    """
480
 
    if format_cls is None:
481
 
        format_cls = DiffTree
482
431
    old_tree.lock_read()
483
432
    try:
484
433
        if extra_trees is not None:
486
435
                tree.lock_read()
487
436
        new_tree.lock_read()
488
437
        try:
489
 
            differ = format_cls.from_trees_options(old_tree, new_tree, to_file,
490
 
                                                   path_encoding,
491
 
                                                   external_diff_options,
492
 
                                                   old_label, new_label, using)
 
438
            differ = DiffTree.from_trees_options(old_tree, new_tree, to_file,
 
439
                                                 path_encoding,
 
440
                                                 external_diff_options,
 
441
                                                 old_label, new_label, using)
493
442
            return differ.show_diff(specific_files, extra_trees)
494
443
        finally:
495
444
            new_tree.unlock()
502
451
 
503
452
def _patch_header_date(tree, file_id, path):
504
453
    """Returns a timestamp suitable for use in a patch header."""
505
 
    try:
506
 
        mtime = tree.get_file_mtime(file_id, path)
507
 
    except errors.FileTimestampUnavailable:
508
 
        mtime = 0
 
454
    mtime = tree.get_file_mtime(file_id, path)
509
455
    return timestamp.format_patch_date(mtime)
510
456
 
511
457
 
732
678
    @classmethod
733
679
    def from_string(klass, command_string, old_tree, new_tree, to_file,
734
680
                    path_encoding='utf-8'):
735
 
        command_template = cmdline.split(command_string)
 
681
        command_template = commands.shlex_split_unicode(command_string)
736
682
        if '@' not in command_string:
737
683
            command_template.extend(['@old_path', '@new_path'])
738
684
        return klass(command_template, old_tree, new_tree, to_file,
776
722
 
777
723
    def _write_file(self, file_id, tree, prefix, relpath, force_temp=False,
778
724
                    allow_write=False):
779
 
        if not force_temp and isinstance(tree, WorkingTree):
780
 
            return tree.abspath(tree.id2path(file_id))
781
 
        
782
725
        full_path = osutils.pathjoin(self._root, prefix, relpath)
783
726
        if not force_temp and self._try_symlink_root(tree, prefix):
784
727
            return full_path
797
740
                target.close()
798
741
        finally:
799
742
            source.close()
800
 
        try:
801
 
            mtime = tree.get_file_mtime(file_id)
802
 
        except errors.FileTimestampUnavailable:
803
 
            pass
804
 
        else:
805
 
            os.utime(full_path, (mtime, mtime))
806
743
        if not allow_write:
807
744
            osutils.make_readonly(full_path)
 
745
        mtime = tree.get_file_mtime(file_id)
 
746
        os.utime(full_path, (mtime, mtime))
808
747
        return full_path
809
748
 
810
749
    def _prepare_files(self, file_id, old_path, new_path, force_temp=False,
827
766
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
828
767
        if (old_kind, new_kind) != ('file', 'file'):
829
768
            return DiffPath.CANNOT_DIFF
830
 
        (old_disk_path, new_disk_path) = self._prepare_files(
831
 
                                                file_id, old_path, new_path)
832
 
        self._execute(old_disk_path, new_disk_path)
 
769
        self._prepare_files(file_id, old_path, new_path)
 
770
        self._execute(osutils.pathjoin('old', old_path),
 
771
                      osutils.pathjoin('new', new_path))
833
772
 
834
773
    def edit_file(self, file_id):
835
774
        """Use this tool to edit a file.
932
871
    def show_diff(self, specific_files, extra_trees=None):
933
872
        """Write tree diff to self.to_file
934
873
 
935
 
        :param specific_files: the specific files to compare (recursive)
 
874
        :param sepecific_files: the specific files to compare (recursive)
936
875
        :param extra_trees: extra trees to use for mapping paths to file_ids
937
876
        """
938
877
        try:
1028
967
            if error_path is None:
1029
968
                error_path = old_path
1030
969
            raise errors.NoDiffFound(error_path)
1031
 
 
1032
 
 
1033
 
format_registry = Registry()
1034
 
format_registry.register('default', DiffTree)