Merge lp:~abudden/qbzr/tab-width-on-view-menu into lp:qbzr

[Dr Al]

> Hi Alan,
>
> I've just thought that you may want to add support to change Tab Width directly for GUI: via View Options menu on toolbar (in qdiff and qannotate) similar to encoding change, if you like. You don't have to though. That's just a thought.

Implemented in this branch.

[Alexander Belchenko (bialix)]

You need to update your NEWS changes to 0.20b2 cycle now.

Also, I wonder why don't you want to save the changed value in corresponding branch.conf as encoding selector does? See get_set_encoding() function in util.py as reference (but please use the latest revision from lp:qbzr).

[Alexander Belchenko (bialix)]

review: Needs Fixing

[lp:~abudden/qbzr/tab-width-on-view-menu]

1370. By Dr Al on 2011-05-03

Merged latest trunk.

1371. By Dr Al on 2011-05-03

Store custom tab width in branch.conf if it is changed in annotate or diff window.

[Dr Al (abudden)]

NEWS moved and branch.conf saving implemented.

[Alexander Belchenko (bialix)]

Your both util functions are extended to get aditional parameter tab_width, but their signatures different:

def get_set_tab_width_chars(tab_width=None, branch=None):
vs
def get_tab_width_pixels(branch=None, tab_width_chars=None):

As I undersstand in both cases you might pass optional tab_width in chars. I think we should use the same order of arguments in both functions to reduce the possible mistakes in usage of that API. I'm asking you for consistency between those 2 functions. Can you fix this please?

[lp:~abudden/qbzr/tab-width-on-view-menu]

1372. By Dr Al on 2011-05-04

Changed parameter order in get_set_tab_width_chars to match that of get_set_tab_width_pixels.

1373. By Dr Al on 2011-05-04

Expanded docstrings describing utility function usage.

[Dr Al (abudden)]

Fixed. I've also put more explanation into the docstrings since they're util functions.

[Alexander Belchenko (bialix)]

Thanks for descriptive docstring.

[Alexander Belchenko (bialix)]

Okay, we need couple of small fixes there.

1) Please put the new file under lib/widgets/ subdirectory (it does not exist yet in trun, so add it). I've long imagined how to improve qbzr internal modules layout. So let's start with it. See https://bugs.launchpad.net/qbzr/+bug/420757 for refrence.

2) It seems the import of from bzrlib.plugins.qbzr.lib.util import get_tab_width_pixels is unneeded in tab_width_selector.py. Remove it.

Otherwise it's fine for me.

review: Needs Fixing

[lp:~abudden/qbzr/tab-width-on-view-menu]

1374. By Dr Al on 2011-05-09

Merge trunk

1375. By Dr Al on 2011-05-09

Removed redundant import and moved tab width selector into widgets subdirectory.

[Dr Al (abudden)]

Okay, that's done.

[Alexander Belchenko (bialix)]

Dr Al пишет:
> Okay, that's done.
You should fix the imports in the modules that requires new TabSelector.
Also, please keep 2 blank lines between NEWS groups for different releases.

Othewrwise, I'm fine with that. Please land.

--
All the dude wanted was his rug back

[Alexander Belchenko (bialix)]

review: Needs Fixing

[Dr Al (abudden)]

Fixed the imports (oops) and re-added blank lines. I can't land this.

[lp:~abudden/qbzr/tab-width-on-view-menu]

1376. By Dr Al on 2011-05-11

Fixed imports and re-added blank line to news.

[Dr Al (abudden)]

Merged.

=== modified file 'NEWS.txt'
--- NEWS.txt	2011-05-03 09:21:56 +0000
+++ NEWS.txt	2011-05-11 11:51:06 +0000
@@ -5,6 +5,10 @@
    * Fixed problem with viewing file from qbrowse.
      (Alexander Belchenko, Bug #776196)
 
+ * qdiff, qannotate:
+     Tab-width can be customised from the view menu.
+     (Bug #490377, A. S. Budden)
+
 
 0.21 beta 1 - 2011/05/02
 ------------------------
@@ -63,16 +67,16 @@
  * qannotate, qdiff:
    * Find text box turns red if no matches are found.
      (A. S. Budden, Bug #772244)
+
  * qcat, qannotate, qdiff, qconfig:
    * Added ability to customise the tab-stop width (setting in qconfig,
-     affects qcat, qannotate and qdiff).  
+     affects qcat, qannotate and qdiff).
      The setting is stored in [DEFAULT] section of bazaar.conf,
      and is named tab_width (it can also be configured with qconfig).  Units
      are characters (so 4 means a tab should be displayed with the width of 4
      spaces).  The default value is 8.  The setting can also be adjusted in
      branch.conf for specific branches.  (Bug #490377, A. S. Budden)
 
-
 0.20.1 - 2011/04/26
 --------------------
 Maintenance release.

=== modified file 'lib/annotate.py'
--- lib/annotate.py	2011-04-27 14:13:50 +0000
+++ lib/annotate.py	2011-05-11 11:51:06 +0000
@@ -37,6 +37,7 @@
     get_icon,
     get_monospace_font,
     get_set_encoding,
+    get_set_tab_width_chars,
     get_tab_width_pixels,
     runs_in_loading_queue,
     )
@@ -53,6 +54,7 @@
 from bzrlib.revisiontree import RevisionTree
 from bzrlib.plugins.qbzr.lib.revisionmessagebrowser import LogListRevisionMessageBrowser
 from bzrlib.plugins.qbzr.lib.encoding_selector import EncodingMenuSelector
+from bzrlib.plugins.qbzr.lib.widgets.tab_width_selector import TabWidthMenuSelector
 from bzrlib.plugins.qbzr.lib.syntaxhighlighter import highlight_document
 from bzrlib.plugins.qbzr.lib.revtreeview import paint_revno, get_text_color
 from bzrlib.plugins.qbzr.lib import logmodel
@@ -269,8 +271,6 @@
         self.text_edit.setLineWrapMode(QtGui.QPlainTextEdit.NoWrap)
         
         self.text_edit.document().setDefaultFont(get_monospace_font())
-
-        self.text_edit.setTabStopWidth(get_tab_width_pixels(branch))
         
         self.annotate_bar = AnnotateBar(self.text_edit, self, self.get_revno)
         annotate_spliter = QtGui.QSplitter(QtCore.Qt.Horizontal, self)
@@ -337,7 +337,15 @@
         self.connect(word_wrap,
                      QtCore.SIGNAL("toggled (bool)"),
                      self.word_wrap_toggle)
+
+        def setTabStopWidth(tw):
+            self.text_edit.setTabStopWidth(get_tab_width_pixels(tab_width_chars=tw))
+            get_set_tab_width_chars(branch=self.branch,tab_width_chars=tw)
+        self.tab_width_selector = TabWidthMenuSelector(get_set_tab_width_chars(branch=branch),
+                gettext("Tab Width"),
+                setTabStopWidth)
         
+        view_menu.addMenu(self.tab_width_selector)
         view_menu.addMenu(self.encoding_selector)
         view_menu.addAction(word_wrap)
         

=== modified file 'lib/config.py'
--- lib/config.py	2011-04-26 08:26:28 +0000
+++ lib/config.py	2011-05-11 11:51:06 +0000
@@ -35,7 +35,7 @@
     extract_name,
     get_qbzr_config,
     get_global_config,
-    get_tab_width_chars,
+    get_set_tab_width_chars,
     )
 
 
@@ -305,7 +305,7 @@
                 self.emailClientCombo.setCurrentIndex(index)
 
         # Tab-width
-        self.tabWidthSpinner.setValue(get_tab_width_chars())
+        self.tabWidthSpinner.setValue(get_set_tab_width_chars())
 
         # Spellcheck language
         spellcheck_language = config.get_user_option('spellcheck_language') or 'en'

=== modified file 'lib/diffwindow.py'
--- lib/diffwindow.py	2011-04-29 10:12:04 +0000
+++ lib/diffwindow.py	2011-05-11 11:51:06 +0000
@@ -54,6 +54,7 @@
     ToolBarThrobberWidget,
     get_icon,
     get_set_encoding,
+    get_set_tab_width_chars,
     get_tab_width_pixels,
     is_binary_content,
     run_in_loading_queue,
@@ -63,6 +64,7 @@
 from bzrlib.plugins.qbzr.lib.uifactory import ui_current_widget
 from bzrlib.plugins.qbzr.lib.trace import reports_exception
 from bzrlib.plugins.qbzr.lib.encoding_selector import EncodingMenuSelector
+from bzrlib.plugins.qbzr.lib.widgets.tab_width_selector import TabWidthMenuSelector
 
 try:
     from bzrlib.errors import FileTimestampUnavailable
@@ -154,6 +156,11 @@
         vbox = QtGui.QVBoxLayout(self.centralwidget)
         vbox.addWidget(self.stack)
 
+        # Don't use a custom tab width by default
+        # Indices are left side, right side and unidiff
+        # respectively
+        self.custom_tab_widths = [-1,-1,-1]
+
         for browser in self.diffview.browsers:
             browser.installEventFilter(self)
 
@@ -273,6 +280,42 @@
         self.ignore_whitespace_action = self.create_ignore_ws_action()
         view_menu.addAction(self.ignore_whitespace_action)
 
+        def on_unidiff_tab_width_changed(tabwidth):
+            if self.branches:
+                get_set_tab_width_chars(branch=self.branches[0],tab_width_chars=tabwidth)
+            self.custom_tab_widths[2] = tabwidth
+            self.setup_tab_width()
+        self.tab_width_selector_unidiff = TabWidthMenuSelector(
+                label_text=gettext("Tab width"),
+                onChanged=on_unidiff_tab_width_changed)
+        view_menu.addMenu(self.tab_width_selector_unidiff)
+
+        def on_left_tab_width_changed(tabwidth):
+            if self.branches:
+                get_set_tab_width_chars(branch=self.branches[0],tab_width_chars=tabwidth)
+            self.custom_tab_widths[0] = tabwidth
+            self.setup_tab_width()
+        self.tab_width_selector_left = TabWidthMenuSelector(
+                label_text=gettext("Left side tab width"),
+                onChanged=on_left_tab_width_changed)
+        view_menu.addMenu(self.tab_width_selector_left)
+
+        def on_right_tab_width_changed(tabwidth):
+            if self.branches:
+                get_set_tab_width_chars(branch=self.branches[1],tab_width_chars=tabwidth)
+            self.custom_tab_widths[1] = tabwidth
+            self.setup_tab_width()
+        self.tab_width_selector_right = TabWidthMenuSelector(
+                label_text=gettext("Right side tab width"),
+                onChanged=on_right_tab_width_changed)
+        view_menu.addMenu(self.tab_width_selector_right)
+
+        if self.stack.currentWidget() == self.diffview:
+            self.tab_width_selector_unidiff.menuAction().setVisible(False)
+        else:
+            self.tab_width_selector_left.menuAction().setVisible(False)
+            self.tab_width_selector_right.menuAction().setVisible(False)
+
         def on_left_encoding_changed(encoding):
             if self.branches:
                 get_set_encoding(encoding, self.branches[0])
@@ -371,10 +414,19 @@
         self.processEvents()
 
     def setup_tab_width(self):
-        tabWidths = (get_tab_width_pixels(self.branches[0]),
-                     get_tab_width_pixels(self.branches[1]))
-        self.diffview.setTabStopWidths(tabWidths)
-        self.sdiffview.setTabStopWidth(tabWidths[0])
+        tabWidths = self.custom_tab_widths
+        if tabWidths[0] < 0:
+            tabWidths[0] = get_set_tab_width_chars(branch=self.branches[0])
+            self.tab_width_selector_left.setTabWidth(tabWidths[0])
+        if tabWidths[1] < 0:
+            tabWidths[1] = get_set_tab_width_chars(branch=self.branches[1])
+            self.tab_width_selector_right.setTabWidth(tabWidths[1])
+        if tabWidths[2] < 0:
+            tabWidths[2] = get_set_tab_width_chars(branch=self.branches[0])
+            self.tab_width_selector_unidiff.setTabWidth(tabWidths[2])
+        tabWidthsPixels = [get_tab_width_pixels(tab_width_chars=i) for i in tabWidths]
+        self.diffview.setTabStopWidths(tabWidthsPixels)
+        self.sdiffview.setTabStopWidth(tabWidthsPixels[2])
 
     def load_diff(self):
         self.view_refresh.setEnabled(False)
@@ -532,9 +584,15 @@
         if checked:
             view = self.sdiffview
             self.find_toolbar.text_edit = view
+            self.tab_width_selector_left.menuAction().setVisible(False)
+            self.tab_width_selector_right.menuAction().setVisible(False)
+            self.tab_width_selector_unidiff.menuAction().setVisible(True)
         else:
             view = self.diffview
             self.find_toolbar.text_edit = view.browsers[0]
+            self.tab_width_selector_left.menuAction().setVisible(True)
+            self.tab_width_selector_right.menuAction().setVisible(True)
+            self.tab_width_selector_unidiff.menuAction().setVisible(False)
         view.rewind()
         index = self.stack.indexOf(view)
         self.stack.setCurrentIndex(index)

=== modified file 'lib/util.py'
--- lib/util.py	2011-05-07 15:50:46 +0000
+++ lib/util.py	2011-05-11 11:51:06 +0000
@@ -1232,17 +1232,46 @@
     font.setFixedPitch(True)
     return font
 
-def get_tab_width_chars(branch=None):
-    """Function to get the tab width in characters from the configuration."""
-    config = get_branch_config(branch)
-    try:
-        tabWidth = int(config.get_user_option('tab_width'))
-    except TypeError:
-        tabWidth = 8
-    return tabWidth
-
-def get_tab_width_pixels(branch=None):
-    """Function to get the tab width in pixels based on a monospaced font."""
+def get_set_tab_width_chars(branch=None, tab_width_chars=None):
+    """Function to get the tab width in characters from the configuration.
+
+    @param branch: Use branch.conf as well as bazaar.conf if this is provided.
+    @param tab_width_chars: Number of characters to use as tab width: if branch
+        is provided, the tab width will be stored in branch.conf
+
+    Both arguments are optional, but if tab_width_chars is provided and branch is
+    not, nothing will be done.
+    
+    @return: Tab width, in characters.
+    """
+    if tab_width_chars is None:
+        config = get_branch_config(branch)
+        try:
+            tab_width_chars = int(config.get_user_option('tab_width'))
+            if tab_width_chars < 0:
+                raise TypeError("Invalid tab width")
+        except TypeError:
+            tab_width_chars = 8
+    else:
+        if branch:
+            branch.get_config().set_user_option("tab_width", tab_width_chars)
+
+    return tab_width_chars
+
+def get_tab_width_pixels(branch=None, tab_width_chars=None):
+    """Function to get the tab width in pixels based on a monospaced font.
+
+    If tab_width_chars is provided, it is simply converted to a value in pixels.  If
+    it is not provided, the configuration is retrieved from bazaar.conf.  If branch is
+    provided (and tab_width_chars is not), branch.conf is also checked.
+
+    @param tab_width_chars: Number of characters of tab width to convert to pixels.
+    @param branch: Branch to use when retrieving tab width from configuration.
+    
+    @return: Tab width, in pixels.
+    """
     monospacedFont = get_monospace_font()
     char_width = QtGui.QFontMetrics(monospacedFont).width(" ")
-    return char_width*get_tab_width_chars(branch)
+    if tab_width_chars is None:
+        tab_width_chars = get_set_tab_width_chars(branch=branch)
+    return char_width*tab_width_chars

=== added directory 'lib/widgets'
=== added file 'lib/widgets/__init__.py'
--- lib/widgets/__init__.py	1970-01-01 00:00:00 +0000
+++ lib/widgets/__init__.py	2011-05-11 11:51:06 +0000
@@ -0,0 +1,1 @@
+"" 

=== added file 'lib/widgets/tab_width_selector.py'
--- lib/widgets/tab_width_selector.py	1970-01-01 00:00:00 +0000
+++ lib/widgets/tab_width_selector.py	2011-05-11 11:51:06 +0000
@@ -0,0 +1,85 @@
+# -*- coding: utf-8 -*-
+#
+# QBzr - Qt frontend to Bazaar commands
+#
+# 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.
+
+from PyQt4 import QtGui, QtCore
+
+# Range of tab widths to display by default on the menu (if others are
+# specified in either bazaar.conf or branch.conf they'll be added after
+# a separator).
+MIN_TAB_WIDTH = 1
+MAX_TAB_WIDTH = 12
+
+class TabWidthMenuSelector(QtGui.QMenu):
+    """Menu to control tab width."""
+    def __init__(self, initial_tab_width=None, label_text=None, onChanged=None, *args):
+        """Create tab width menu.
+        @param label_text: text for label.
+        @param onChanged: callback to processing tab width change.
+        """
+        QtGui.QMenu.__init__(self, *args)
+        self.onChanged = onChanged
+        if onChanged is None:
+            self.onChanged = lambda settabwidth: None
+
+        self.setTitle(label_text)
+
+        self.action_group = QtGui.QActionGroup(self)
+
+        self.tabwidth_actions = {}
+        for tabwidth in range(MIN_TAB_WIDTH, MAX_TAB_WIDTH+1):
+            action = QtGui.QAction(str(tabwidth), self.action_group)
+            action.setCheckable(True)
+            action.setData(QtCore.QVariant(tabwidth))
+            self.addAction(action)
+            self.tabwidth_actions[tabwidth] = action
+
+        self._tabwidth = None
+        self._has_separator = False
+        self.connect(self, QtCore.SIGNAL("triggered(QAction *)"),
+                self.triggered)
+
+        if initial_tab_width is not None:
+            self.setTabWidth(initial_tab_width)
+            self.triggered(self.tabwidth_actions[initial_tab_width])
+
+    def triggered(self, action):
+        tw, success = action.data().toInt()
+        if success and tw != self._tabwidth:
+            self._tabwidth = tw
+            self.onChanged(tw)
+
+    def setTabWidth(self, width):
+        if width not in self.tabwidth_actions:
+            action = QtGui.QAction(str(width), self.action_group)
+            action.setCheckable(True)
+            action.setData(QtCore.QVariant(width))
+            # Find the next highest tab width currently in the menu
+            for tw in sorted(self.tabwidth_actions.keys()):
+                if tw > width:
+                    self.insertAction(action, self.tabwidth_actions[tw])
+                    break
+            else:
+                # Not found
+                if not self._has_separator:
+                    self.addSeparator()
+                    self._has_separator = True
+                self.addAction(action)
+
+            self.tabwidth_actions[width] = action
+
+        self.tabwidth_actions[width].setChecked(True)