/b-gtk/fix-viz

# Copyright (C) 2005 Dan Loda <danloda@gmail.com>

# 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

import time

import pygtk

pygtk.require("2.0")

import gobject

import gtk

import pango

from bzrlib.errors import NoSuchRevision

from bzrlib.revision import NULL_REVISION

from colormap import AnnotateColorMap, AnnotateColorSaturation

from logview import LogView

from spanselector import SpanSelector

(

    REVISION_ID_COL,

    LINE_NUM_COL,

    COMMITTER_COL,

    REVNO_COL,

    HIGHLIGHT_COLOR_COL,

    TEXT_LINE_COL

) = range(6)

class GAnnotateWindow(gtk.Window):

    """Annotate window."""

    def __init__(self, all=False, plain=False):

        self.all = all

        self.plain = plain

        gtk.Window.__init__(self, gtk.WINDOW_TOPLEVEL)

        self.set_icon(self.render_icon(gtk.STOCK_FIND, gtk.ICON_SIZE_BUTTON))

        self.annotate_colormap = AnnotateColorSaturation()

        self._create()

        if self.plain:

            self.span_selector.hide()

    def annotate(self, branch, file_id):

        self.revisions = {}

        self.annotations = []

        self.branch = branch

        self.file_id = file_id

        # [revision id, line number, committer, revno, highlight color, line]

        self.annomodel = gtk.ListStore(gobject.TYPE_STRING,

                                       gobject.TYPE_STRING,

                                       gobject.TYPE_STRING,

                                       gobject.TYPE_STRING,

                                       gobject.TYPE_STRING,

                                       gobject.TYPE_STRING)

        last_seen = None

        try:

            branch.lock_read()

            branch.repository.lock_read()

            for line_no, (revision, revno, line)\

                    in enumerate(self._annotate(branch, file_id)):

                if revision.revision_id == last_seen and not self.all:

                    revno = committer = ""

                else:

                    last_seen = revision.revision_id

                    committer = revision.committer

                if revision.revision_id not in self.revisions:

                    self.revisions[revision.revision_id] = revision

                self.annomodel.append([revision.revision_id,

                                       line_no + 1,

                                       committer,

                                       revno,

                                       None,

                                       line.rstrip("\r\n")

                                      ])

                self.annotations.append(revision)

            if not self.plain:

                self._set_oldest_newest()

                # Recall that calling activate_default will emit "span-changed",

                # so self._span_changed_cb will take care of initial highlighting

                self.span_selector.activate_default()

        finally:

            branch.repository.unlock()

            branch.unlock()

        self.annoview.set_model(self.annomodel)

        self.annoview.grab_focus()

    def jump_to_line(self, lineno):

        if lineno > len(self.annomodel) or lineno < 1:

            row = 0

            # FIXME:should really deal with this in the gui. Perhaps a status

            # bar?

            print("gannotate: Line number %d does't exist. Defaulting to "

                  "line 1." % lineno)

        else:

            row = lineno - 1

        self.annoview.set_cursor(row)

        self.annoview.scroll_to_cell(row, use_align=True)

    def _annotate(self, branch, file_id):

        rev_hist = branch.revision_history()

        repository = branch.repository

        rev_tree = repository.revision_tree(branch.last_revision())

        rev_id = rev_tree.inventory[file_id].revision

        weave = repository.weave_store.get_weave(file_id,

                                                 branch.get_transaction())

        revision_cache = RevisionCache(repository)

        for origin, text in weave.annotate_iter(rev_id):

            rev_id = origin

            try:

                revision = revision_cache.get_revision(rev_id)

                if rev_id in rev_hist:

                    revno = branch.revision_id_to_revno(rev_id)

                else:

                    revno = "merge"

            except NoSuchRevision:

                revision = NoneRevision(rev_id)

                revno = "?"

            yield revision, revno, text

    def _set_oldest_newest(self):

        rev_dates = map(lambda i: self.revisions[i].timestamp, self.revisions)

        oldest = min(rev_dates)

        newest = max(rev_dates)

        span = self._span_from_seconds(time.time() - oldest)

        self.span_selector.set_to_oldest_span(span)

        span = self._span_from_seconds(newest - oldest)

        self.span_selector.set_newest_to_oldest_span(span)

    def _span_from_seconds(self, seconds):

        return (seconds / (24 * 60 * 60))

    def _span_changed_cb(self, w, span):

        self.annotate_colormap.set_span(span)

        now = time.time()

        self.annomodel.foreach(self._highlight_annotation, now)

    def _highlight_annotation(self, model, path, iter, now):

        revision_id, = model.get(iter, REVISION_ID_COL)

        revision = self.revisions[revision_id]

        model.set(iter, HIGHLIGHT_COLOR_COL,

                  self.annotate_colormap.get_color(revision, now))

    def _show_log(self, w):

        (path, col) = self.annoview.get_cursor()

        rev_id = self.annomodel[path][REVISION_ID_COL]

        self.logview.set_revision(self.revisions[rev_id])

    def _create(self):

        self.logview = self._create_log_view()

        self.annoview = self._create_annotate_view()

        self.span_selector = self._create_span_selector()

        vbox = gtk.VBox(False, 12)

        vbox.set_border_width(12)

        vbox.show()

        sw = gtk.ScrolledWindow()

        sw.set_policy(gtk.POLICY_AUTOMATIC, gtk.POLICY_AUTOMATIC)

        sw.set_shadow_type(gtk.SHADOW_IN)

        sw.add(self.annoview)

        self.annoview.gwindow = self

        sw.show()

        self.pane = pane = gtk.VPaned()

        pane.add1(sw)

        pane.add2(self.logview)

        pane.show()

        vbox.pack_start(pane, expand=True, fill=True)

        hbox = gtk.HBox(True, 6)

        hbox.pack_start(self.span_selector, expand=False, fill=True)

        hbox.pack_start(self._create_button_box(), expand=False, fill=True)

        hbox.show()

        vbox.pack_start(hbox, expand=False, fill=True)

        self.add(vbox)

    def row_diff(self, tv, path, tvc):

        row = path[0]

        revision = self.annotations[row]

        repository = self.branch.repository

        tree1 = repository.revision_tree(revision.revision_id)

        if len(revision.parent_ids) > 0:

            tree2 = repository.revision_tree(revision.parent_ids[0])

        else:

            tree2 = repository.revision_tree(NULL_REVISION)

        from bzrlib.plugins.gtk.viz.diffwin import DiffWindow

        window = DiffWindow()

        window.set_diff("Diff for row %d" % (row+1), tree1, tree2)

        window.set_file(tree1.id2path(self.file_id))

        window.show()

    def _create_annotate_view(self):

        tv = gtk.TreeView()

        tv.set_rules_hint(False)

        tv.connect("cursor-changed", self._show_log)

        tv.show()

        tv.connect("row-activated", self.row_diff)

        cell = gtk.CellRendererText()

        cell.set_property("xalign", 1.0)

        cell.set_property("ypad", 0)

        cell.set_property("family", "Monospace")

        cell.set_property("cell-background-gdk",

                          tv.get_style().bg[gtk.STATE_NORMAL])

        col = gtk.TreeViewColumn()

        col.set_resizable(False)

        col.pack_start(cell, expand=True)

        col.add_attribute(cell, "text", LINE_NUM_COL)

        tv.append_column(col)

        cell = gtk.CellRendererText()

        cell.set_property("ypad", 0)

        cell.set_property("ellipsize", pango.ELLIPSIZE_END)

        cell.set_property("cell-background-gdk",

                          self.get_style().bg[gtk.STATE_NORMAL])

        col = gtk.TreeViewColumn("Committer")

        col.set_resizable(True)

        col.pack_start(cell, expand=True)

        col.add_attribute(cell, "text", COMMITTER_COL)

        tv.append_column(col)

        cell = gtk.CellRendererText()

        cell.set_property("xalign", 1.0)

        cell.set_property("ypad", 0)

        cell.set_property("cell-background-gdk",

                          self.get_style().bg[gtk.STATE_NORMAL])

        col = gtk.TreeViewColumn("Revno")

        col.set_resizable(False)

        col.pack_start(cell, expand=True)

        col.add_attribute(cell, "markup", REVNO_COL)

        tv.append_column(col)

        cell = gtk.CellRendererText()

        cell.set_property("ypad", 0)

        cell.set_property("family", "Monospace")

        col = gtk.TreeViewColumn()

        col.set_resizable(False)

        col.pack_start(cell, expand=True)

#        col.add_attribute(cell, "foreground", HIGHLIGHT_COLOR_COL)

        col.add_attribute(cell, "background", HIGHLIGHT_COLOR_COL)

        col.add_attribute(cell, "text", TEXT_LINE_COL)

        tv.append_column(col)

        tv.set_search_column(LINE_NUM_COL)

        return tv

    def _create_span_selector(self):

        ss = SpanSelector()

        ss.connect("span-changed", self._span_changed_cb)

        ss.show()

        return ss

    def _create_log_view(self):

        lv = LogView()

        lv.show()

        return lv

    def _create_button_box(self):

        box = gtk.HButtonBox()

        box.set_layout(gtk.BUTTONBOX_END)

        box.show()

        button = gtk.Button()

        button.set_use_stock(True)

        button.set_label("gtk-close")

        button.connect("clicked", lambda w: self.destroy())

        button.show()

        box.pack_start(button, expand=False, fill=False)

        return box

class NoneRevision:

    """ A fake revision.

    For when a revision is referenced but not present.

    """

    def __init__(self, revision_id):

        self.revision_id = revision_id

        self.parent_ids = []

        self.committer = "?"

        self.message = "?"

        self.timestamp = 0.0

        self.timezone = 0

class RevisionCache(object):

    """A caching revision source"""

    def __init__(self, real_source):

        self.__real_source = real_source

        self.__cache = {}

    def get_revision(self, revision_id):

        if revision_id not in self.__cache:

            revision = self.__real_source.get_revision(revision_id)

            self.__cache[revision_id] = revision

        return self.__cache[revision_id]