/b-gtk/fix-viz

# Modified for use with Olive:

# Copyright (C) 2006 by Szilveszter Farkas (Phanatic) <szilveszter.farkas@gmail.com>

# Original copyright holder:

# Copyright (C) 2005 by Canonical Ltd. (Scott James Remnant <scott@ubuntu.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

"""Branch window.

This module contains the code to manage the branch information window,

which contains both the revision graph and details panes.

"""

__copyright__ = "Copyright © 2005 Canonical Ltd."

__author__    = "Scott James Remnant <scott@ubuntu.com>"

import gtk

import gobject

import pango

from bzrlib.osutils import format_date

from graph import distances, graph, same_branch

from graphcell import CellRendererGraph

class BranchWindow(gtk.Window):

    """Branch window.

    This object represents and manages a single window containing information

    for a particular branch.

    """

    def __init__(self, app=None):

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

        self.set_border_width(0)

        self.set_title("bzrk")

        self.app = app

        # Use three-quarters of the screen by default

        screen = self.get_screen()

        monitor = screen.get_monitor_geometry(0)

        width = int(monitor.width * 0.75)

        height = int(monitor.height * 0.75)

        self.set_default_size(width, height)

        # FIXME AndyFitz!

        icon = self.render_icon(gtk.STOCK_INDEX, gtk.ICON_SIZE_BUTTON)

        self.set_icon(icon)

        self.accel_group = gtk.AccelGroup()

        self.add_accel_group(self.accel_group)

        self.construct()

    def construct(self):

        """Construct the window contents."""

        vbox = gtk.VBox(spacing=0)

        self.add(vbox)

        vbox.pack_start(self.construct_navigation(), expand=False, fill=True)

        paned = gtk.VPaned()

        paned.pack1(self.construct_top(), resize=True, shrink=False)

        paned.pack2(self.construct_bottom(), resize=False, shrink=True)

        paned.show()

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

        vbox.set_focus_child(paned)

        vbox.show()

    def construct_top(self):

        """Construct the top-half of the window."""

        scrollwin = gtk.ScrolledWindow()

        scrollwin.set_policy(gtk.POLICY_NEVER, gtk.POLICY_AUTOMATIC)

        scrollwin.set_shadow_type(gtk.SHADOW_IN)

        scrollwin.show()

        self.treeview = gtk.TreeView()

        self.treeview.set_rules_hint(True)

        self.treeview.set_search_column(4)

        self.treeview.connect("cursor-changed", self._treeview_cursor_cb)

        self.treeview.connect("row-activated", self._treeview_row_activated_cb)

        scrollwin.add(self.treeview)

        self.treeview.show()

        cell = CellRendererGraph()

        column = gtk.TreeViewColumn()

        column.set_resizable(True)

        column.pack_start(cell, expand=False)

        column.add_attribute(cell, "node", 1)

        column.add_attribute(cell, "in-lines", 2)

        column.add_attribute(cell, "out-lines", 3)

        self.treeview.append_column(column)

        cell = gtk.CellRendererText()

        cell.set_property("width-chars", 40)

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

        column = gtk.TreeViewColumn("Message")

        column.set_resizable(True)

        column.pack_start(cell, expand=True)

        column.add_attribute(cell, "text", 4)

        self.treeview.append_column(column)

        cell = gtk.CellRendererText()

        cell.set_property("width-chars", 40)

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

        column = gtk.TreeViewColumn("Committer")

        column.set_resizable(True)

        column.pack_start(cell, expand=True)

        column.add_attribute(cell, "text", 5)

        self.treeview.append_column(column)

        cell = gtk.CellRendererText()

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

        column = gtk.TreeViewColumn("Date")

        column.set_resizable(True)

        column.pack_start(cell, expand=True)

        column.add_attribute(cell, "text", 6)

        self.treeview.append_column(column)

        return scrollwin

    def construct_navigation(self):

        """Construct the navigation buttons."""

        frame = gtk.Frame()

        frame.set_shadow_type(gtk.SHADOW_OUT)

        frame.show()

        hbox = gtk.HBox(spacing=12)

        frame.add(hbox)

        hbox.show()

        self.back_button = gtk.Button(stock=gtk.STOCK_GO_BACK)

        self.back_button.set_relief(gtk.RELIEF_NONE)

        self.back_button.add_accelerator("clicked", self.accel_group, ord('['),

                                         0, 0)

        self.back_button.connect("clicked", self._back_clicked_cb)

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

        self.back_button.show()

        self.fwd_button = gtk.Button(stock=gtk.STOCK_GO_FORWARD)

        self.fwd_button.set_relief(gtk.RELIEF_NONE)

        self.fwd_button.add_accelerator("clicked", self.accel_group, ord(']'),

                                        0, 0)

        self.fwd_button.connect("clicked", self._fwd_clicked_cb)

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

        self.fwd_button.show()

        return frame

    def construct_bottom(self):

        """Construct the bottom half of the window."""

        scrollwin = gtk.ScrolledWindow()

        scrollwin.set_policy(gtk.POLICY_NEVER, gtk.POLICY_AUTOMATIC)

        scrollwin.set_shadow_type(gtk.SHADOW_NONE)

        (width, height) = self.get_size()

        scrollwin.set_size_request(width, int(height / 2.5))

        scrollwin.show()

        vbox = gtk.VBox(False, spacing=6)

        vbox.set_border_width(6)

        scrollwin.add_with_viewport(vbox)

        vbox.show()

        table = gtk.Table(rows=4, columns=2)

        table.set_row_spacings(6)

        table.set_col_spacings(6)

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

        table.show()

        align = gtk.Alignment(0.0, 0.5)

        label = gtk.Label()

        label.set_markup("<b>Revision:</b>")

        align.add(label)

        table.attach(align, 0, 1, 0, 1, gtk.FILL, gtk.FILL)

        label.show()

        align.show()

        align = gtk.Alignment(0.0, 0.5)

        self.revid_label = gtk.Label()

        self.revid_label.set_selectable(True)

        align.add(self.revid_label)

        table.attach(align, 1, 2, 0, 1, gtk.EXPAND | gtk.FILL, gtk.FILL)

        self.revid_label.show()

        align.show()

        align = gtk.Alignment(0.0, 0.5)

        label = gtk.Label()

        label.set_markup("<b>Committer:</b>")

        align.add(label)

        table.attach(align, 0, 1, 1, 2, gtk.FILL, gtk.FILL)

        label.show()

        align.show()

        align = gtk.Alignment(0.0, 0.5)

        self.committer_label = gtk.Label()

        self.committer_label.set_selectable(True)

        align.add(self.committer_label)

        table.attach(align, 1, 2, 1, 2, gtk.EXPAND | gtk.FILL, gtk.FILL)

        self.committer_label.show()

        align.show()

        align = gtk.Alignment(0.0, 0.5)

        label = gtk.Label()

        label.set_markup("<b>Branch nick:</b>")

        align.add(label)

        table.attach(align, 0, 1, 2, 3, gtk.FILL, gtk.FILL)

        label.show()

        align.show()

        align = gtk.Alignment(0.0, 0.5)

        self.branchnick_label = gtk.Label()

        self.branchnick_label.set_selectable(True)

        align.add(self.branchnick_label)

        table.attach(align, 1, 2, 2, 3, gtk.EXPAND | gtk.FILL, gtk.FILL)

        self.branchnick_label.show()

        align.show()

        align = gtk.Alignment(0.0, 0.5)

        label = gtk.Label()

        label.set_markup("<b>Timestamp:</b>")

        align.add(label)

        table.attach(align, 0, 1, 3, 4, gtk.FILL, gtk.FILL)

        label.show()

        align.show()

        align = gtk.Alignment(0.0, 0.5)

        self.timestamp_label = gtk.Label()

        self.timestamp_label.set_selectable(True)

        align.add(self.timestamp_label)

        table.attach(align, 1, 2, 3, 4, gtk.EXPAND | gtk.FILL, gtk.FILL)

        self.timestamp_label.show()

        align.show()

        self.parents_table = gtk.Table(rows=1, columns=2)

        self.parents_table.set_row_spacings(3)

        self.parents_table.set_col_spacings(6)

        self.parents_table.show()

        vbox.pack_start(self.parents_table, expand=False, fill=True)

        self.parents_widgets = []

        label = gtk.Label()

        label.set_markup("<b>Parents:</b>")

        align = gtk.Alignment(0.0, 0.5)

        align.add(label)

        self.parents_table.attach(align, 0, 1, 0, 1, gtk.FILL, gtk.FILL)

        label.show()

        align.show()

        self.message_buffer = gtk.TextBuffer()

        textview = gtk.TextView(self.message_buffer)

        textview.set_editable(False)

        textview.set_wrap_mode(gtk.WRAP_WORD)

        textview.modify_font(pango.FontDescription("Monospace"))

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

        textview.show()

        return scrollwin

    def set_branch(self, branch, start, maxnum):

        """Set the branch and start position for this window.

        Creates a new TreeModel and populates it with information about

        the new branch before updating the window title and model of the

        treeview itself.

        """

        self.branch = branch

        # [ revision, node, last_lines, lines, message, committer, timestamp ]

        self.model = gtk.ListStore(gobject.TYPE_PYOBJECT,

                                   gobject.TYPE_PYOBJECT,

                                   gobject.TYPE_PYOBJECT,

                                   gobject.TYPE_PYOBJECT,

                                   str, str, str)

        self.index = {}

        index = 0

        last_lines = []

        (self.revisions, colours, self.children, self.parent_ids,

         merge_sorted) = distances(branch, start)

        for (index, (revision, node, lines)) in enumerate(graph(

                self.revisions, colours, merge_sorted)):

            # FIXME: at this point we should be able to show the graph order

            # and lines with no message or commit data - and then incrementally

            # fill the timestamp, committer etc data as desired.

            message = revision.message.split("\n")[0]

            if revision.committer is not None:

                timestamp = format_date(revision.timestamp, revision.timezone)

            else:

                timestamp = None

            self.model.append([revision, node, last_lines, lines,

                               message, revision.committer, timestamp])

            self.index[revision] = index

            last_lines = lines

            if maxnum is not None and index > maxnum:

                break

        self.set_title(branch.nick + " - bzrk")

        self.treeview.set_model(self.model)

    def _treeview_cursor_cb(self, *args):

        """Callback for when the treeview cursor changes."""

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

        revision = self.model[path][0]

        self.back_button.set_sensitive(len(self.parent_ids[revision]) > 0)

        self.fwd_button.set_sensitive(len(self.children[revision]) > 0)

        if revision.committer is not None:

            branchnick = ""

            committer = revision.committer

            timestamp = format_date(revision.timestamp, revision.timezone)

            message = revision.message

            try:

                branchnick = revision.properties['branch-nick']

            except KeyError:

                pass

        else:

            committer = ""

            timestamp = ""

            message = ""

            branchnick = ""

        self.revid_label.set_text(revision.revision_id)

        self.branchnick_label.set_text(branchnick)

        self.committer_label.set_text(committer)

        self.timestamp_label.set_text(timestamp)

        self.message_buffer.set_text(message)

        for widget in self.parents_widgets:

            self.parents_table.remove(widget)

        self.parents_widgets = []

        self.parents_table.resize(max(len(self.parent_ids[revision]), 1), 2)

        for idx, parent_id in enumerate(self.parent_ids[revision]):

            align = gtk.Alignment(0.0, 0.0)

            self.parents_widgets.append(align)

            self.parents_table.attach(align, 1, 2, idx, idx + 1,

                                      gtk.EXPAND | gtk.FILL, gtk.FILL)

            align.show()

            hbox = gtk.HBox(False, spacing=6)

            align.add(hbox)

            hbox.show()

            image = gtk.Image()

            image.set_from_stock(

                gtk.STOCK_FIND, gtk.ICON_SIZE_SMALL_TOOLBAR)

            image.show()

            button = gtk.Button()

            button.add(image)

            button.set_sensitive(self.app is not None)

            button.connect("clicked", self._show_clicked_cb,

                           revision.revision_id, parent_id)

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

            button.show()

            button = gtk.Button(parent_id)

            button.set_use_underline(False)

            button.connect("clicked", self._go_clicked_cb, parent_id)

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

            button.show()

    def _back_clicked_cb(self, *args):

        """Callback for when the back button is clicked."""

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

        revision = self.model[path][0]

        if not len(self.parent_ids[revision]):

            return

        for parent_id in self.parent_ids[revision]:

            parent = self.revisions[parent_id]

            if same_branch(revision, parent):

                self.treeview.set_cursor(self.index[parent])

                break

        else:

            next = self.revisions[self.parent_ids[revision][0]]

            self.treeview.set_cursor(self.index[next])

        self.treeview.grab_focus()

    def _fwd_clicked_cb(self, *args):

        """Callback for when the forward button is clicked."""

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

        revision = self.model[path][0]

        if not len(self.children[revision]):

            return

        for child in self.children[revision]:

            if same_branch(child, revision):

                self.treeview.set_cursor(self.index[child])

                break

        else:

            prev = list(self.children[revision])[0]

            self.treeview.set_cursor(self.index[prev])

        self.treeview.grab_focus()

    def _go_clicked_cb(self, widget, revid):

        """Callback for when the go button for a parent is clicked."""

        self.treeview.set_cursor(self.index[self.revisions[revid]])

        self.treeview.grab_focus()

    def _show_clicked_cb(self, widget, revid, parentid):

        """Callback for when the show button for a parent is clicked."""

        if self.app is not None:

            self.app.show_diff(self.branch, revid, parentid)

        self.treeview.grab_focus()

    def _treeview_row_activated_cb(self, widget, path, col):

        # TODO: more than one parent

        """Callback for when a treeview row gets activated."""

        revision = self.model[path][0]

        parent_id = self.parent_ids[revision][0]

        if self.app is not None:

            self.app.show_diff(self.branch, revision.revision_id, parent_id)

        self.treeview.grab_focus()