# dagop.py - graph ancestry and topology algorithm for revset

#

# Copyright 2010 Matt Mackall <mpm@selenic.com>

#

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

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

from __future__ import absolute_import

import heapq

from .node import (

    nullrev,

)

from .thirdparty import (

    attr,

)

from . import (

    error,

    mdiff,

    node,

    patch,

    pycompat,

    smartset,

)

baseset = smartset.baseset

generatorset = smartset.generatorset

# possible maximum depth between null and wdir()

maxlogdepth = 0x80000000

def _walkrevtree(pfunc, revs, startdepth, stopdepth, reverse):

    """Walk DAG using 'pfunc' from the given 'revs' nodes

    'pfunc(rev)' should return the parent/child revisions of the given 'rev'

    if 'reverse' is True/False respectively.

    Scan ends at the stopdepth (exlusive) if specified. Revisions found

    earlier than the startdepth are omitted.

    """

    if startdepth is None:

        startdepth = 0

    if stopdepth is None:

        stopdepth = maxlogdepth

    if stopdepth == 0:

        return

    if stopdepth < 0:

        raise error.ProgrammingError('negative stopdepth')

    if reverse:

        heapsign = -1  # max heap

    else:

        heapsign = +1  # min heap

    # load input revs lazily to heap so earlier revisions can be yielded

    # without fully computing the input revs

    revs.sort(reverse)

    irevs = iter(revs)

    pendingheap = []  # [(heapsign * rev, depth), ...] (i.e. lower depth first)

    inputrev = next(irevs, None)

    if inputrev is not None:

        heapq.heappush(pendingheap, (heapsign * inputrev, 0))

    lastrev = None

    while pendingheap:

        currev, curdepth = heapq.heappop(pendingheap)

        currev = heapsign * currev

        if currev == inputrev:

            inputrev = next(irevs, None)

            if inputrev is not None:

                heapq.heappush(pendingheap, (heapsign * inputrev, 0))

        # rescan parents until curdepth >= startdepth because queued entries

        # of the same revision are iterated from the lowest depth

        foundnew = (currev != lastrev)

        if foundnew and curdepth >= startdepth:

            lastrev = currev

            yield currev

        pdepth = curdepth + 1

        if foundnew and pdepth < stopdepth:

            for prev in pfunc(currev):

                if prev != node.nullrev:

                    heapq.heappush(pendingheap, (heapsign * prev, pdepth))

def filectxancestors(fctxs, followfirst=False):

    """Like filectx.ancestors(), but can walk from multiple files/revisions,

    and includes the given fctxs themselves

    Yields (rev, {fctx, ...}) pairs in descending order.

    """

    visit = {}

    visitheap = []

    def addvisit(fctx):

        rev = fctx.rev()

        if rev not in visit:

            visit[rev] = set()

            heapq.heappush(visitheap, -rev)  # max heap

        visit[rev].add(fctx)

    if followfirst:

        cut = 1

    else:

        cut = None

    for c in fctxs:

        addvisit(c)

    while visit:

        currev = -heapq.heappop(visitheap)

        curfctxs = visit.pop(currev)

        yield currev, curfctxs

        for c in curfctxs:

            for parent in c.parents()[:cut]:

                addvisit(parent)

    assert not visitheap

def filerevancestors(fctxs, followfirst=False):

    """Like filectx.ancestors(), but can walk from multiple files/revisions,

    and includes the given fctxs themselves

    Returns a smartset.

    """

    gen = (rev for rev, _cs in filectxancestors(fctxs, followfirst))

    return generatorset(gen, iterasc=False)

def _genrevancestors(repo, revs, followfirst, startdepth, stopdepth, cutfunc):

    if followfirst:

        cut = 1

    else:

        cut = None

    cl = repo.changelog

    def plainpfunc(rev):

        try:

            return cl.parentrevs(rev)[:cut]

        except error.WdirUnsupported:

            return (pctx.rev() for pctx in repo[rev].parents()[:cut])

    if cutfunc is None:

        pfunc = plainpfunc

    else:

        pfunc = lambda rev: [r for r in plainpfunc(rev) if not cutfunc(r)]

        revs = revs.filter(lambda rev: not cutfunc(rev))

    return _walkrevtree(pfunc, revs, startdepth, stopdepth, reverse=True)

def revancestors(repo, revs, followfirst=False, startdepth=None,

                 stopdepth=None, cutfunc=None):

    r"""Like revlog.ancestors(), but supports additional options, includes

    the given revs themselves, and returns a smartset

    Scan ends at the stopdepth (exlusive) if specified. Revisions found

    earlier than the startdepth are omitted.

    If cutfunc is provided, it will be used to cut the traversal of the DAG.

    When cutfunc(X) returns True, the DAG traversal stops - revision X and

    X's ancestors in the traversal path will be skipped. This could be an

    optimization sometimes.

    Note: if Y is an ancestor of X, cutfunc(X) returning True does not

    necessarily mean Y will also be cut. Usually cutfunc(Y) also wants to

    return True in this case. For example,

        D     # revancestors(repo, D, cutfunc=lambda rev: rev == B)

        |\    # will include "A", because the path D -> C -> A was not cut.

        B C   # If "B" gets cut, "A" might want to be cut too.

        |/

        A

    """

    gen = _genrevancestors(repo, revs, followfirst, startdepth, stopdepth,

                           cutfunc)

    return generatorset(gen, iterasc=False)

def _genrevdescendants(repo, revs, followfirst):

    if followfirst:

        cut = 1

    else:

        cut = None

    cl = repo.changelog

    first = revs.min()

    nullrev = node.nullrev

    if first == nullrev:

        # Are there nodes with a null first parent and a non-null

        # second one? Maybe. Do we care? Probably not.

        yield first

        for i in cl:

            yield i

    else:

        seen = set(revs)

        for i in cl.revs(first):

            if i in seen:

                yield i

                continue

            for x in cl.parentrevs(i)[:cut]:

                if x != nullrev and x in seen:

                    seen.add(i)

                    yield i

                    break

def _builddescendantsmap(repo, startrev, followfirst):

    """Build map of 'rev -> child revs', offset from startrev"""

    cl = repo.changelog

    nullrev = node.nullrev

    descmap = [[] for _rev in pycompat.xrange(startrev, len(cl))]

    for currev in cl.revs(startrev + 1):

        p1rev, p2rev = cl.parentrevs(currev)

        if p1rev >= startrev:

            descmap[p1rev - startrev].append(currev)

        if not followfirst and p2rev != nullrev and p2rev >= startrev:

            descmap[p2rev - startrev].append(currev)

    return descmap

def _genrevdescendantsofdepth(repo, revs, followfirst, startdepth, stopdepth):

    startrev = revs.min()

    descmap = _builddescendantsmap(repo, startrev, followfirst)

    def pfunc(rev):

        return descmap[rev - startrev]

    return _walkrevtree(pfunc, revs, startdepth, stopdepth, reverse=False)

def revdescendants(repo, revs, followfirst, startdepth=None, stopdepth=None):

    """Like revlog.descendants() but supports additional options, includes

    the given revs themselves, and returns a smartset

    Scan ends at the stopdepth (exlusive) if specified. Revisions found

    earlier than the startdepth are omitted.

    """

    if startdepth is None and (stopdepth is None or stopdepth >= maxlogdepth):

        gen = _genrevdescendants(repo, revs, followfirst)

    else:

        gen = _genrevdescendantsofdepth(repo, revs, followfirst,

                                        startdepth, stopdepth)

    return generatorset(gen, iterasc=True)

def descendantrevs(revs, revsfn, parentrevsfn):

    """Generate revision number descendants in revision order.

    Yields revision numbers starting with a child of some rev in

    ``revs``. Results are ordered by revision number and are

    therefore topological. Each revision is not considered a descendant

    of itself.

    ``revsfn`` is a callable that with no argument iterates over all

    revision numbers and with a ``start`` argument iterates over revision

    numbers beginning with that value.

    ``parentrevsfn`` is a callable that receives a revision number and

    returns an iterable of parent revision numbers, whose values may include

    nullrev.

    """

    first = min(revs)

    if first == nullrev:

        for rev in revsfn():

            yield rev

        return

    seen = set(revs)

    for rev in revsfn(start=first + 1):

        for prev in parentrevsfn(rev):

            if prev != nullrev and prev in seen:

                seen.add(rev)

                yield rev

                break

def _reachablerootspure(repo, minroot, roots, heads, includepath):

    if not roots:

        return []

    parentrevs = repo.changelog.parentrevs

    roots = set(roots)

    visit = list(heads)

    reachable = set()

    seen = {}

    # prefetch all the things! (because python is slow)

    reached = reachable.add

    dovisit = visit.append

    nextvisit = visit.pop

    # open-code the post-order traversal due to the tiny size of

    # sys.getrecursionlimit()

    while visit:

        rev = nextvisit()

        if rev in roots:

            reached(rev)

            if not includepath:

                continue

        parents = parentrevs(rev)

        seen[rev] = parents

        for parent in parents:

            if parent >= minroot and parent not in seen:

                dovisit(parent)

    if not reachable:

        return baseset()

    if not includepath:

        return reachable

    for rev in sorted(seen):

        for parent in seen[rev]:

            if parent in reachable:

                reached(rev)

    return reachable

def reachableroots(repo, roots, heads, includepath=False):

    If includepath is True, return (<roots>::<heads>)."""

    if not roots:

        return baseset()

    minroot = roots.min()

    roots = list(roots)

    heads = list(heads)

    try:

        revs = repo.changelog.reachableroots(minroot, heads, roots, includepath)

    except AttributeError:

        revs = _reachablerootspure(repo, minroot, roots, heads, includepath)

    revs = baseset(revs)

    revs.sort()

    return revs

def _changesrange(fctx1, fctx2, linerange2, diffopts):

    """Return `(diffinrange, linerange1)` where `diffinrange` is True

    if diff from fctx2 to fctx1 has changes in linerange2 and

    `linerange1` is the new line range for fctx1.

    """

    blocks = mdiff.allblocks(fctx1.data(), fctx2.data(), diffopts)

    filteredblocks, linerange1 = mdiff.blocksinrange(blocks, linerange2)

    diffinrange = any(stype == '!' for _, stype in filteredblocks)

    return diffinrange, linerange1

def blockancestors(fctx, fromline, toline, followfirst=False):

    """Yield ancestors of `fctx` with respect to the block of lines within

    `fromline`-`toline` range.

    """

    diffopts = patch.diffopts(fctx._repo.ui)

    fctx = fctx.introfilectx()

    visit = {(fctx.linkrev(), fctx.filenode()): (fctx, (fromline, toline))}

    while visit:

        c, linerange2 = visit.pop(max(visit))

        pl = c.parents()

        if followfirst:

            pl = pl[:1]

        if not pl:

            # The block originates from the initial revision.

            yield c, linerange2

            continue

        inrange = False

        for p in pl:

            inrangep, linerange1 = _changesrange(p, c, linerange2, diffopts)

            inrange = inrange or inrangep

            if linerange1[0] == linerange1[1]:

                # Parent's linerange is empty, meaning that the block got

                # introduced in this revision; no need to go futher in this

                # branch.

                continue

            # Set _descendantrev with 'c' (a known descendant) so that, when

            # _adjustlinkrev is called for 'p', it receives this descendant

            # (as srcrev) instead possibly topmost introrev.

            p._descendantrev = c.rev()

            visit[p.linkrev(), p.filenode()] = p, linerange1

        if inrange:

            yield c, linerange2

def blockdescendants(fctx, fromline, toline):

    """Yield descendants of `fctx` with respect to the block of lines within

    `fromline`-`toline` range.

    """

    # First possibly yield 'fctx' if it has changes in range with respect to

    # its parents.

    try:

        c, linerange1 = next(blockancestors(fctx, fromline, toline))

    except StopIteration:

        pass

    else:

        if c == fctx:

            yield c, linerange1

    diffopts = patch.diffopts(fctx._repo.ui)

    fl = fctx.filelog()

    seen = {fctx.filerev(): (fctx, (fromline, toline))}

    for i in fl.descendants([fctx.filerev()]):

        c = fctx.filectx(i)

        inrange = False

        for x in fl.parentrevs(i):

            try:

                p, linerange2 = seen[x]

            except KeyError:

                # nullrev or other branch

                continue

            inrangep, linerange1 = _changesrange(c, p, linerange2, diffopts)