/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/mergetools.py

  • Committer: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/mergetools.py
1
 
# Copyright (C) 2010 Canonical Ltd.
2
 
#
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.
7
 
#
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.
12
 
#
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
16
 
 
17
 
"""Utility functions for managing external merge tools such as kdiff3."""
18
 
 
19
 
from __future__ import absolute_import
20
 
 
21
 
import os
22
 
import shutil
23
 
import subprocess
24
 
import sys
25
 
import tempfile
26
 
 
27
 
from .lazy_import import lazy_import
28
 
lazy_import(globals(), """
29
 
from breezy import (
30
 
    cmdline,
31
 
    osutils,
32
 
    trace,
33
 
)
34
 
""")
35
 
 
36
 
from .sixish import text_type
37
 
 
38
 
 
39
 
known_merge_tools = {
40
 
    'bcompare': 'bcompare {this} {other} {base} {result}',
41
 
    'kdiff3': 'kdiff3 {base} {this} {other} -o {result}',
42
 
    'xdiff': 'xxdiff -m -O -M {result} {this} {base} {other}',
43
 
    'meld': 'meld {base} {this_temp} {other}',
44
 
    'opendiff': 'opendiff {this} {other} -ancestor {base} -merge {result}',
45
 
    'winmergeu': 'winmergeu {result}',
46
 
}
47
 
 
48
 
 
49
 
def check_availability(command_line):
50
 
    cmd_list = cmdline.split(command_line)
51
 
    exe = cmd_list[0]
52
 
    if sys.platform == 'win32':
53
 
        exe = _get_executable_path(exe)
54
 
        if exe is None:
55
 
            return False
56
 
        base, ext = os.path.splitext(exe)
57
 
        path_ext = [s.lower()
58
 
                    for s in os.getenv('PATHEXT', '').split(os.pathsep)]
59
 
        return os.path.exists(exe) and ext in path_ext
60
 
    else:
61
 
        return (os.access(exe, os.X_OK)
62
 
                or osutils.find_executable_on_path(exe) is not None)
63
 
 
64
 
 
65
 
def invoke(command_line, filename, invoker=None):
66
 
    """Invokes the given merge tool command line, substituting the given
67
 
    filename according to the embedded substitution markers. Optionally, it
68
 
    will use the given invoker function instead of the default
69
 
    subprocess_invoker.
70
 
    """
71
 
    if invoker is None:
72
 
        invoker = subprocess_invoker
73
 
    cmd_list = cmdline.split(command_line)
74
 
    exe = _get_executable_path(cmd_list[0])
75
 
    if exe is not None:
76
 
        cmd_list[0] = exe
77
 
    args, tmp_file = _subst_filename(cmd_list, filename)
78
 
    def cleanup(retcode):
79
 
        if tmp_file is not None:
80
 
            if retcode == 0: # on success, replace file with temp file
81
 
                shutil.move(tmp_file, filename)
82
 
            else: # otherwise, delete temp file
83
 
                os.remove(tmp_file)
84
 
    return invoker(args[0], args[1:], cleanup)
85
 
 
86
 
 
87
 
def _get_executable_path(exe):
88
 
    if os.path.isabs(exe):
89
 
        return exe
90
 
    return osutils.find_executable_on_path(exe)
91
 
 
92
 
 
93
 
def _subst_filename(args, filename):
94
 
    subst_names = {
95
 
        'base': filename + u'.BASE',
96
 
        'this': filename + u'.THIS',
97
 
        'other': filename + u'.OTHER',
98
 
        'result': filename,
99
 
    }
100
 
    tmp_file = None
101
 
    subst_args = []
102
 
    for arg in args:
103
 
        if '{this_temp}' in arg and not 'this_temp' in subst_names:
104
 
            fh, tmp_file = tempfile.mkstemp(u"_bzr_mergetools_%s.THIS" %
105
 
                                            os.path.basename(filename))
106
 
            trace.mutter('fh=%r, tmp_file=%r', fh, tmp_file)
107
 
            os.close(fh)
108
 
            shutil.copy(filename + u".THIS", tmp_file)
109
 
            subst_names['this_temp'] = tmp_file
110
 
        arg = _format_arg(arg, subst_names)
111
 
        subst_args.append(arg)
112
 
    return subst_args, tmp_file
113
 
 
114
 
 
115
 
# This would be better implemented using format() from python 2.6
116
 
def _format_arg(arg, subst_names):
117
 
    arg = arg.replace('{base}', subst_names['base'])
118
 
    arg = arg.replace('{this}', subst_names['this'])
119
 
    arg = arg.replace('{other}', subst_names['other'])
120
 
    arg = arg.replace('{result}', subst_names['result'])
121
 
    if 'this_temp' in subst_names:
122
 
        arg = arg.replace('{this_temp}', subst_names['this_temp'])
123
 
    return arg
124
 
 
125
 
 
126
 
def subprocess_invoker(executable, args, cleanup):
127
 
    retcode = subprocess.call([executable] + args)
128
 
    cleanup(retcode)
129
 
    return retcode