/brz/remove-bazaar

# Copyright (C) 2009 Canonical Ltd

#

# This program is free software; you can redistribute it and/or modify

# it under the terms of the GNU General Public License as published by

# the Free Software Foundation; either version 2 of the License, or

# (at your option) any later version.

#

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

# GNU General Public License for more details.

#

# You should have received a copy of the GNU General Public License

# along with this program; if not, write to the Free Software

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

"""Functionality for doing annotations in the 'optimal' way"""

cdef extern from "python-compat.h":

    pass

cdef extern from "Python.h":

    ctypedef int Py_ssize_t

    ctypedef struct PyObject:

        pass

    ctypedef struct PyListObject:

        PyObject **ob_item

    int PyList_CheckExact(object)

    PyObject *PyList_GET_ITEM(object, Py_ssize_t o)

    Py_ssize_t PyList_GET_SIZE(object)

    int PyList_Append(object, object) except -1

    int PyList_SetItem(object, Py_ssize_t o, object) except -1

    int PyList_Sort(object) except -1

    int PyTuple_CheckExact(object)

    object PyTuple_New(Py_ssize_t len)

    void PyTuple_SET_ITEM(object, Py_ssize_t pos, object)

    void PyTuple_SET_ITEM_ptr "PyTuple_SET_ITEM" (object, Py_ssize_t,

                                                  PyObject *)

    int PyTuple_Resize(PyObject **, Py_ssize_t newlen)

    PyObject *PyTuple_GET_ITEM(object, Py_ssize_t o)

    Py_ssize_t PyTuple_GET_SIZE(object)

    PyObject *PyDict_GetItem(object d, object k)

    int PyDict_SetItem(object d, object k, object v) except -1

    void Py_INCREF(object)

    void Py_INCREF_ptr "Py_INCREF" (PyObject *)

    void Py_DECREF_ptr "Py_DECREF" (PyObject *)

    int Py_EQ

    int Py_LT

    int PyObject_RichCompareBool(object, object, int opid) except -1

    int PyObject_RichCompareBool_ptr "PyObject_RichCompareBool" (

        PyObject *, PyObject *, int opid)

from bzrlib import errors, graph as _mod_graph, osutils, patiencediff, ui

cdef class _NeededTextIterator:

    cdef object counter

    cdef object text_cache

    cdef object stream

    cdef object ann_keys

    cdef object stream_len

    cdef object pb

    cdef int stream_is_consumed

    cdef int ann_key_pos

    def __init__(self, stream, text_cache, stream_len, ann_keys, pb=None):

        self.counter = 0

        self.stream = stream

        self.stream_len = stream_len

        self.text_cache = text_cache

        self.stream_len = stream_len

        self.ann_keys = list(ann_keys)

        self.pb = pb

        self.stream_is_consumed = 0

        self.ann_key_pos = 0

    def __iter__(self):

        return self

    cdef _get_ann_text(self):

        if self.ann_key_pos >= len(self.ann_keys):

            raise StopIteration

        key = self.ann_keys[self.ann_key_pos]

        self.ann_key_pos = self.ann_key_pos + 1

        lines = self.text_cache[key]

        num_lines = len(lines)

        return key, lines, num_lines

    def __next__(self):

        if self.stream_is_consumed:

            return self._get_ann_text()

        try:

            record = self.stream.next()

        except StopIteration:

            self.stream_is_consumed = 1

            return self._get_ann_text()

        if self.pb is not None:

            self.pb.update('extracting', self.counter, self.stream_len)

        if record.storage_kind == 'absent':

            raise errors.RevisionNotPresent(record.key, None)

        self.counter = self.counter + 1

        lines = osutils.chunks_to_lines(record.get_bytes_as('chunked'))

        num_lines = len(lines)

        self.text_cache[record.key] = lines

        return record.key, lines, num_lines

cdef int _check_annotations_are_lists(annotations,

                                      parent_annotations) except -1:

    if not PyList_CheckExact(annotations):

        raise TypeError('annotations must be a list')

    if not PyList_CheckExact(parent_annotations):

        raise TypeError('parent_annotations must be a list')

    return 0

cdef int _check_match_ranges(parent_annotations, annotations,

                             Py_ssize_t parent_idx, Py_ssize_t lines_idx,

                             Py_ssize_t match_len) except -1:

    if parent_idx + match_len > PyList_GET_SIZE(parent_annotations):

        raise ValueError('Match length exceeds len of'

                         ' parent_annotations %s > %s'

                         % (parent_idx + match_len,

                            PyList_GET_SIZE(parent_annotations)))

    if lines_idx + match_len > PyList_GET_SIZE(annotations):

        raise ValueError('Match length exceeds len of'

                         ' annotations %s > %s'

                         % (lines_idx + match_len,

                            PyList_GET_SIZE(annotations)))

    return 0

cdef PyObject *_next_tuple_entry(object tpl, Py_ssize_t *pos):

    pos[0] = pos[0] + 1

    if pos[0] >= PyTuple_GET_SIZE(tpl):

        return NULL

    return PyTuple_GET_ITEM(tpl, pos[0])

cdef object _combine_annotations(ann_one, ann_two, cache):

    """Combine the annotations from both sides."""

    cdef Py_ssize_t pos_one, pos_two, len_one, len_two

    cdef Py_ssize_t out_pos

    cdef PyObject *temp, *left, *right

    if (PyObject_RichCompareBool(ann_one, ann_two, Py_LT)):

        cache_key = (ann_one, ann_two)

    else:

        cache_key = (ann_two, ann_one)

    temp = PyDict_GetItem(cache, cache_key)

    if temp != NULL:

        return <object>temp

    if not PyTuple_CheckExact(ann_one) or not PyTuple_CheckExact(ann_two):

        raise TypeError('annotations must be tuples')

    # We know that annotations are tuples, and that both sides are already

    # sorted, so we can just walk and update a new list.

    pos_one = -1

    pos_two = -1

    out_pos = 0

    left = _next_tuple_entry(ann_one, &pos_one)

    right = _next_tuple_entry(ann_two, &pos_two)

    new_ann = PyTuple_New(PyTuple_GET_SIZE(ann_one)

                          + PyTuple_GET_SIZE(ann_two))

    while left != NULL and right != NULL:

        if (PyObject_RichCompareBool_ptr(left, right, Py_EQ)):

            # Identical values, step both

            Py_INCREF_ptr(left)

            PyTuple_SET_ITEM_ptr(new_ann, out_pos, left)

            left = _next_tuple_entry(ann_one, &pos_one)

            right = _next_tuple_entry(ann_two, &pos_two)

        elif (PyObject_RichCompareBool_ptr(left, right, Py_LT)):

            # left < right or right == NULL

            Py_INCREF_ptr(left)

            PyTuple_SET_ITEM_ptr(new_ann, out_pos, left)

            left = _next_tuple_entry(ann_one, &pos_one)

        else: # right < left or left == NULL

            Py_INCREF_ptr(right)

            PyTuple_SET_ITEM_ptr(new_ann, out_pos, right)

            right = _next_tuple_entry(ann_two, &pos_two)

        out_pos = out_pos + 1

    while left != NULL:

        Py_INCREF_ptr(left)

        PyTuple_SET_ITEM_ptr(new_ann, out_pos, left)

        left = _next_tuple_entry(ann_one, &pos_one)

        out_pos = out_pos + 1

    while right != NULL:

        Py_INCREF_ptr(right)

        PyTuple_SET_ITEM_ptr(new_ann, out_pos, right)

        right = _next_tuple_entry(ann_two, &pos_two)

        out_pos = out_pos + 1

    if out_pos != PyTuple_GET_SIZE(new_ann):

        # Timing _PyTuple_Resize was not significantly faster that slicing

        # PyTuple_Resize((<PyObject **>new_ann), out_pos)

        new_ann = new_ann[0:out_pos]

    PyDict_SetItem(cache, cache_key, new_ann)

    return new_ann

cdef _apply_parent_annotations(annotations, parent_annotations,

                               matching_blocks):

    """Apply the annotations from parent_annotations into annotations.

    matching_blocks defines the ranges that match.

    """

    cdef Py_ssize_t parent_idx, lines_idx, match_len, idx

    cdef PyListObject *par_list, *ann_list

    cdef PyObject **par_temp, **ann_temp

    _check_annotations_are_lists(annotations, parent_annotations)

    par_list = <PyListObject *>parent_annotations

    ann_list = <PyListObject *>annotations

    # For NEWS and bzrlib/builtins.py, over 99% of the lines are simply copied

    # across from the parent entry. So this routine is heavily optimized for

    # that. Would be interesting if we could use memcpy() but we have to incref

    # and decref

    for parent_idx, lines_idx, match_len in matching_blocks:

        _check_match_ranges(parent_annotations, annotations,

                            parent_idx, lines_idx, match_len)

        par_temp = par_list.ob_item + parent_idx

        ann_temp = ann_list.ob_item + lines_idx

        for idx from 0 <= idx < match_len:

            Py_INCREF_ptr(par_temp[idx])

            Py_DECREF_ptr(ann_temp[idx])

            ann_temp[idx] = par_temp[idx]

class Annotator:

    """Class that drives performing annotations."""

    def __init__(self, vf):

        """Create a new Annotator from a VersionedFile."""

        self._vf = vf

        self._parent_map = {}

        self._text_cache = {}

        # Map from key => number of nexts that will be built from this key

        self._num_needed_children = {}

        self._annotations_cache = {}

        self._heads_provider = None

        self._ann_tuple_cache = {}

    def _update_needed_children(self, key, parent_keys):

        for parent_key in parent_keys:

            if parent_key in self._num_needed_children:

                self._num_needed_children[parent_key] += 1

            else:

                self._num_needed_children[parent_key] = 1

    def _get_needed_keys(self, key):

        """Determine the texts we need to get from the backing vf.

        :return: (vf_keys_needed, ann_keys_needed)

            vf_keys_needed  These are keys that we need to get from the vf

            ann_keys_needed Texts which we have in self._text_cache but we

                            don't have annotations for. We need to yield these

                            in the proper order so that we can get proper

                            annotations.

        """

        parent_map = self._parent_map

        # We need 1 extra copy of the node we will be looking at when we are

        # done

        self._num_needed_children[key] = 1

        vf_keys_needed = set()

        ann_keys_needed = set()

        needed_keys = set([key])

        while needed_keys:

            parent_lookup = []

            next_parent_map = {}

            for key in needed_keys:

                if key in self._parent_map:

                    # We don't need to lookup this key in the vf

                    if key not in self._text_cache:

                        # Extract this text from the vf

                        vf_keys_needed.add(key)

                    elif key not in self._annotations_cache:

                        # We do need to annotate

                        ann_keys_needed.add(key)

                        next_parent_map[key] = self._parent_map[key]

                else:

                    parent_lookup.append(key)

                    vf_keys_needed.add(key)

            needed_keys = set()

            next_parent_map.update(self._vf.get_parent_map(parent_lookup))

            for key, parent_keys in next_parent_map.iteritems():

                if parent_keys is None:

                    parent_keys = ()

                    next_parent_map[key] = ()

                self._update_needed_children(key, parent_keys)

                for key in parent_keys:

                    if key not in parent_map:

                        needed_keys.add(key)

            parent_map.update(next_parent_map)

            # _heads_provider does some graph caching, so it is only valid while

            # self._parent_map hasn't changed

            self._heads_provider = None

        return vf_keys_needed, ann_keys_needed

    def _get_needed_texts(self, key, pb=None):

        """Get the texts we need to properly annotate key.

        :param key: A Key that is present in self._vf

        :return: Yield (this_key, text, num_lines)

            'text' is an opaque object that just has to work with whatever

            matcher object we are using. Currently it is always 'lines' but

            future improvements may change this to a simple text string.

        """

        keys, ann_keys = self._get_needed_keys(key)

        if pb is not None:

            pb.update('getting stream', 0, len(keys))

        stream  = self._vf.get_record_stream(keys, 'topological', True)

        iterator = _NeededTextIterator(stream, self._text_cache, len(keys),

                                       ann_keys, pb)

        return iterator

    def _get_parent_annotations_and_matches(self, key, text, parent_key):

        """Get the list of annotations for the parent, and the matching lines.

        :param text: The opaque value given by _get_needed_texts

        :param parent_key: The key for the parent text

        :return: (parent_annotations, matching_blocks)

            parent_annotations is a list as long as the number of lines in

                parent

            matching_blocks is a list of (parent_idx, text_idx, len) tuples

                indicating which lines match between the two texts

        """

        parent_lines = self._text_cache[parent_key]

        parent_annotations = self._annotations_cache[parent_key]

        # PatienceSequenceMatcher should probably be part of Policy

        matcher = patiencediff.PatienceSequenceMatcher(None,

            parent_lines, text)

        matching_blocks = matcher.get_matching_blocks()

        return parent_annotations, matching_blocks

    def _update_from_one_parent(self, key, annotations, lines, parent_key):

        """Reannotate this text relative to its first parent."""

        parent_annotations, matching_blocks = self._get_parent_annotations_and_matches(

            key, lines, parent_key)

        _apply_parent_annotations(annotations, parent_annotations,

                                  matching_blocks)

    def _update_from_other_parents(self, key, annotations, lines,

                                   this_annotation, parent_key):

        """Reannotate this text relative to a second (or more) parent."""

        cdef Py_ssize_t parent_idx, ann_idx, lines_idx, match_len, idx

        cdef Py_ssize_t pos

        cdef PyObject *ann_temp, *par_temp

        parent_annotations, matching_blocks = self._get_parent_annotations_and_matches(

            key, lines, parent_key)

        _check_annotations_are_lists(annotations, parent_annotations)

        last_ann = None

        last_parent = None

        last_res = None

        cache = self._ann_tuple_cache

        for parent_idx, lines_idx, match_len in matching_blocks:

            _check_match_ranges(parent_annotations, annotations,

                                parent_idx, lines_idx, match_len)

            # For lines which match this parent, we will now resolve whether

            # this parent wins over the current annotation

            for idx from 0 <= idx < match_len:

                ann_idx = lines_idx + idx

                ann_temp = PyList_GET_ITEM(annotations, ann_idx)

                par_temp = PyList_GET_ITEM(parent_annotations, parent_idx + idx)

                if (ann_temp == par_temp):

                    # This is parent, do nothing

                    # Pointer comparison is fine here. Value comparison would

                    # be ok, but it will be handled in the final if clause by

                    # merging the two tuples into the same tuple

                    # Avoiding the Py_INCREF by using pointer comparison drops

                    # timing from 215ms => 125ms

                    continue

                par_ann = <object>par_temp

                ann = <object>ann_temp

                if (ann is this_annotation):

                    # Originally claimed 'this', but it was really in this

                    # parent

                    Py_INCREF(par_ann)

                    PyList_SetItem(annotations, ann_idx, par_ann)

                    continue

                # Resolve the fact that both sides have a different value for

                # last modified

                if (ann is last_ann and par_ann is last_parent):

                    Py_INCREF(last_res)

                    PyList_SetItem(annotations, ann_idx, last_res)

                else:

                    new_ann = _combine_annotations(ann, par_ann, cache)

                    Py_INCREF(new_ann)

                    PyList_SetItem(annotations, ann_idx, new_ann)

                    last_ann = ann

                    last_parent = par_ann

                    last_res = new_ann

    def _record_annotation(self, key, parent_keys, annotations):

        self._annotations_cache[key] = annotations

        for parent_key in parent_keys:

            num = self._num_needed_children[parent_key]

            num = num - 1

            if num == 0:

                del self._text_cache[parent_key]

                del self._annotations_cache[parent_key]

                # Do we want to clean up _num_needed_children at this point as

                # well?

            self._num_needed_children[parent_key] = num

    def _annotate_one(self, key, text, num_lines):

        this_annotation = (key,)

        # Note: annotations will be mutated by calls to _update_from*

        annotations = [this_annotation] * num_lines

        parent_keys = self._parent_map[key]

        if parent_keys:

            self._update_from_one_parent(key, annotations, text, parent_keys[0])

            for parent in parent_keys[1:]:

                self._update_from_other_parents(key, annotations, text,

                                                this_annotation, parent)

        self._record_annotation(key, parent_keys, annotations)

    def add_special_text(self, key, parent_keys, text):

        """Add a specific text to the graph."""

        self._parent_map[key] = parent_keys

        self._text_cache[key] = osutils.split_lines(text)

        self._heads_provider = None

    def annotate(self, key):

        """Return annotated fulltext for the given key."""

        pb = ui.ui_factory.nested_progress_bar()

        try:

            for text_key, text, num_lines in self._get_needed_texts(key, pb=pb):

                self._annotate_one(text_key, text, num_lines)

        finally:

            pb.finished()

        try:

            annotations = self._annotations_cache[key]

        except KeyError:

            raise errors.RevisionNotPresent(key, self._vf)

        return annotations, self._text_cache[key]

    def _get_heads_provider(self):

        if self._heads_provider is None:

            self._heads_provider = _mod_graph.KnownGraph(self._parent_map)

        return self._heads_provider

    def annotate_flat(self, key):

        """Determine the single-best-revision to source for each line.

        This is meant as a compatibility thunk to how annotate() used to work.

        """

        cdef Py_ssize_t pos, num_lines

        annotations, lines = self.annotate(key)

        assert len(annotations) == len(lines)

        num_lines = len(lines)

        out = []

        heads = self._get_heads_provider().heads

        for pos from 0 <= pos < num_lines:

            annotation = annotations[pos]

            line = lines[pos]

            if len(annotation) == 1:

                head = annotation[0]

            else:

                the_heads = heads(annotation)

                if len(the_heads) == 1:

                    for head in the_heads:

                        break

                else:

                    # We need to resolve the ambiguity, for now just pick the

                    # sorted smallest

                    head = sorted(the_heads)[0]

            PyList_Append(out, (head, line))

        return out