# record.py

#

# Copyright 2007 Bryan O'Sullivan <bos@serpentine.com>

#

# This software may be used and distributed according to the terms of the

# GNU General Public License version 2 or any later version.

'''commands to interactively select changes for commit/qrefresh'''

from mercurial.i18n import gettext, _

from mercurial import cmdutil, commands, extensions, hg, mdiff, patch

from mercurial import util

import copy, cStringIO, errno, os, re, shutil, tempfile

cmdtable = {}

command = cmdutil.command(cmdtable)

lines_re = re.compile(r'@@ -(\d+),(\d+) \+(\d+),(\d+) @@\s*(.*)')

diffopts = [

    ('w', 'ignore-all-space', False,

     _('ignore white space when comparing lines')),

    ('b', 'ignore-space-change', None,

     _('ignore changes in the amount of white space')),

    ('B', 'ignore-blank-lines', None,

     _('ignore changes whose lines are all blank')),

]

def scanpatch(fp):

    """like patch.iterhunks, but yield different events

    - ('file',    [header_lines + fromfile + tofile])

    - ('context', [context_lines])

    - ('hunk',    [hunk_lines])

    - ('range',   (-start,len, +start,len, diffp))

    """

    lr = patch.linereader(fp)

    def scanwhile(first, p):

        """scan lr while predicate holds"""

        lines = [first]

        while True:

            line = lr.readline()

            if not line:

                break

            if p(line):

                lines.append(line)

            else:

                lr.push(line)

                break

        return lines

    while True:

        line = lr.readline()

        if not line:

            break

        if line.startswith('diff --git a/') or line.startswith('diff -r '):

            def notheader(line):

                s = line.split(None, 1)

                return not s or s[0] not in ('---', 'diff')

            header = scanwhile(line, notheader)

            fromfile = lr.readline()

            if fromfile.startswith('---'):

                tofile = lr.readline()

                header += [fromfile, tofile]

            else:

                lr.push(fromfile)

            yield 'file', header

        elif line[0] == ' ':

            yield 'context', scanwhile(line, lambda l: l[0] in ' \\')

        elif line[0] in '-+':

            yield 'hunk', scanwhile(line, lambda l: l[0] in '-+\\')

        else:

            m = lines_re.match(line)

            if m:

                yield 'range', m.groups()

            else:

                raise patch.PatchError('unknown patch content: %r' % line)

class header(object):

    """patch header

    XXX shoudn't we move this to mercurial/patch.py ?

    """

    diffgit_re = re.compile('diff --git a/(.*) b/(.*)$')

    diff_re = re.compile('diff -r .* (.*)$')

    allhunks_re = re.compile('(?:index|new file|deleted file) ')

    pretty_re = re.compile('(?:new file|deleted file) ')

    special_re = re.compile('(?:index|new|deleted|copy|rename) ')

    def __init__(self, header):

        self.header = header

        self.hunks = []

    def binary(self):

        return util.any(h.startswith('index ') for h in self.header)

    def pretty(self, fp):

        for h in self.header:

            if h.startswith('index '):

                fp.write(_('this modifies a binary file (all or nothing)\n'))

                break

            if self.pretty_re.match(h):

                fp.write(h)

                if self.binary():

                    fp.write(_('this is a binary file\n'))

                break

            if h.startswith('---'):

                fp.write(_('%d hunks, %d lines changed\n') %

                         (len(self.hunks),

                          sum([max(h.added, h.removed) for h in self.hunks])))

                break

            fp.write(h)

    def write(self, fp):

        fp.write(''.join(self.header))

    def allhunks(self):

        return util.any(self.allhunks_re.match(h) for h in self.header)

    def files(self):

        match = self.diffgit_re.match(self.header[0])

        if match:

            fromfile, tofile = match.groups()

            if fromfile == tofile:

                return [fromfile]

            return [fromfile, tofile]

        else:

            return self.diff_re.match(self.header[0]).groups()

    def filename(self):

        return self.files()[-1]

    def __repr__(self):

        return '<header %s>' % (' '.join(map(repr, self.files())))

    def special(self):

        return util.any(self.special_re.match(h) for h in self.header)

def countchanges(hunk):

    """hunk -> (n+,n-)"""

    add = len([h for h in hunk if h[0] == '+'])

    rem = len([h for h in hunk if h[0] == '-'])

    return add, rem

class hunk(object):

    """patch hunk

    XXX shouldn't we merge this with patch.hunk ?

    """

    maxcontext = 3

    def __init__(self, header, fromline, toline, proc, before, hunk, after):

        def trimcontext(number, lines):

            delta = len(lines) - self.maxcontext

            if False and delta > 0:

                return number + delta, lines[:self.maxcontext]

            return number, lines

        self.header = header

        self.fromline, self.before = trimcontext(fromline, before)

        self.toline, self.after = trimcontext(toline, after)

        self.proc = proc

        self.hunk = hunk

        self.added, self.removed = countchanges(self.hunk)

    def write(self, fp):

        delta = len(self.before) + len(self.after)

        if self.after and self.after[-1] == '\\ No newline at end of file\n':

            delta -= 1

        fromlen = delta + self.removed

        tolen = delta + self.added

        fp.write('@@ -%d,%d +%d,%d @@%s\n' %

                 (self.fromline, fromlen, self.toline, tolen,

                  self.proc and (' ' + self.proc)))

        fp.write(''.join(self.before + self.hunk + self.after))

    pretty = write

    def filename(self):

        return self.header.filename()

    def __repr__(self):

        return '<hunk %r@%d>' % (self.filename(), self.fromline)

def parsepatch(fp):

    """patch -> [] of headers -> [] of hunks """

    class parser(object):

        """patch parsing state machine"""

        def __init__(self):

            self.fromline = 0

            self.toline = 0

            self.proc = ''

            self.header = None

            self.context = []

            self.before = []

            self.hunk = []

            self.headers = []

        def addrange(self, limits):

            fromstart, fromend, tostart, toend, proc = limits

            self.fromline = int(fromstart)

            self.toline = int(tostart)

            self.proc = proc

        def addcontext(self, context):

            if self.hunk:

                h = hunk(self.header, self.fromline, self.toline, self.proc,

                         self.before, self.hunk, context)

                self.header.hunks.append(h)

                self.fromline += len(self.before) + h.removed

                self.toline += len(self.before) + h.added

                self.before = []

                self.hunk = []

                self.proc = ''

            self.context = context

        def addhunk(self, hunk):

            if self.context:

                self.before = self.context

                self.context = []

            self.hunk = hunk

        def newfile(self, hdr):

            self.addcontext([])

            h = header(hdr)

            self.headers.append(h)

            self.header = h

        def finished(self):

            self.addcontext([])

            return self.headers

        transitions = {

            'file': {'context': addcontext,

                     'file': newfile,

                     'hunk': addhunk,

                     'range': addrange},

            'context': {'file': newfile,

                        'hunk': addhunk,

                        'range': addrange},

            'hunk': {'context': addcontext,

                     'file': newfile,

                     'range': addrange},

            'range': {'context': addcontext,

                      'hunk': addhunk},

            }

    p = parser()

    state = 'context'

    for newstate, data in scanpatch(fp):

        try:

            p.transitions[state][newstate](p, data)

        except KeyError:

            raise patch.PatchError('unhandled transition: %s -> %s' %

                                   (state, newstate))

        state = newstate

    return p.finished()

def filterpatch(ui, headers):

    """Interactively filter patch chunks into applied-only chunks"""

    def prompt(skipfile, skipall, query):

        """prompt query, and process base inputs

        - y/n for the rest of file

        - y/n for the rest

        - ? (help)

        - q (quit)

        Return True/False and possibly updated skipfile and skipall.

        """

        if skipall is not None:

            return skipall, skipfile, skipall

        if skipfile is not None:

            return skipfile, skipfile, skipall

        while True:

            resps = _('[Ynsfdaq?]')

            choices = (_('&Yes, record this change'),

                    _('&No, skip this change'),

                    _('&Skip remaining changes to this file'),

                    _('Record remaining changes to this &file'),

                    _('&Done, skip remaining changes and files'),

                    _('Record &all changes to all remaining files'),

                    _('&Quit, recording no changes'),

                    _('&?'))

            r = ui.promptchoice("%s %s" % (query, resps), choices)

            ui.write("\n")

            if r == 7: # ?

                doc = gettext(record.__doc__)

                c = doc.find('::') + 2

                for l in doc[c:].splitlines():

                    if l.startswith('      '):

                        ui.write(l.strip(), '\n')

                continue

            elif r == 0: # yes

                ret = True

            elif r == 1: # no

                ret = False

            elif r == 2: # Skip

                ret = skipfile = False

            elif r == 3: # file (Record remaining)

                ret = skipfile = True

            elif r == 4: # done, skip remaining

                ret = skipall = False

            elif r == 5: # all

                ret = skipall = True

            elif r == 6: # quit

                raise util.Abort(_('user quit'))

            return ret, skipfile, skipall

    seen = set()

    applied = {}        # 'filename' -> [] of chunks

    skipfile, skipall = None, None

    pos, total = 1, sum(len(h.hunks) for h in headers)

    for h in headers:

        pos += len(h.hunks)

        skipfile = None

        fixoffset = 0

        hdr = ''.join(h.header)

        if hdr in seen:

            continue

        seen.add(hdr)

        if skipall is None:

            h.pretty(ui)

        msg = (_('examine changes to %s?') %

               _(' and ').join(map(repr, h.files())))

        r, skipfile, skipall = prompt(skipfile, skipall, msg)

        if not r:

            continue

        applied[h.filename()] = [h]

        if h.allhunks():

            applied[h.filename()] += h.hunks

            continue

        for i, chunk in enumerate(h.hunks):

            if skipfile is None and skipall is None:

                chunk.pretty(ui)

            if total == 1:

                msg = _('record this change to %r?') % chunk.filename()

            else:

                idx = pos - len(h.hunks) + i

                msg = _('record change %d/%d to %r?') % (idx, total,

                                                         chunk.filename())

            r, skipfile, skipall = prompt(skipfile, skipall, msg)

            if r:

                if fixoffset:

                    chunk = copy.copy(chunk)

                    chunk.toline += fixoffset

                applied[chunk.filename()].append(chunk)

            else:

                fixoffset += chunk.removed - chunk.added

    return sum([h for h in applied.itervalues()

               if h[0].special() or len(h) > 1], [])

@command("record",

         # same options as commit + white space diff options

         commands.table['^commit|ci'][1][:] + diffopts,

          _('hg record [OPTION]... [FILE]...'))

def record(ui, repo, *pats, **opts):

    '''interactively select changes to commit

    If a list of files is omitted, all changes reported by :hg:`status`

    will be candidates for recording.

    See :hg:`help dates` for a list of formats valid for -d/--date.

    You will be prompted for whether to record changes to each

    modified file, and for files with multiple changes, for each

    change to use. For each query, the following responses are

    possible::