Added search bar to the subtitle view.

- it is accessible via menu or ctrl-f key shortcut
- search is "smart case sensitive": it is case sensitive only when there's at least one upper case
  letter in searched phrase (@see vim's 'set smartcase')
- one search bar per subtitle view
- supports circular iterating over the search results
- when user clicks somewhere on the subtitle list, then showing the next (or previous) element will
  start from that selection (not from the last position remembered by SearchIter)

Author: Michał Góral

subconvert/gui/Detail.py

@@ -25,7 +25,7 @@
 from subconvert.utils.Locale import _, P_
 
 from PyQt4.QtGui import QListWidget, QTreeWidget, QComboBox, QAction, QIcon, QMessageBox
-from PyQt4.QtGui import QAbstractSpinBox, QStyledItemDelegate, QValidator, QBrush
+from PyQt4.QtGui import QAbstractSpinBox, QStyledItemDelegate, QValidator, QBrush, QLineEdit
 from PyQt4.QtCore import Qt, pyqtSignal
 
 # define globally to avoid mistakes
@@ -287,3 +287,13 @@ def exec(self):
             "Errors occured when trying to open following files:",
             fileListSize))
         super().exec()
+
+class SearchEdit(QLineEdit):
+    escapePressed = pyqtSignal()
+    def __init__(self, parent = None):
+        super().__init__(parent)
+
+    def keyPressEvent(self, ev):
+        if ev.key() == Qt.Key_Escape:
+            self.escapePressed.emit()
+        super().keyPressEvent(ev)

subconvert/gui/MainWindow.py

@@ -21,6 +21,7 @@
 
 import os
 import logging
+import bisect
 from string import Template
 
 from PyQt4.QtGui import QMainWindow, QWidget, QFileDialog, QVBoxLayout, QAction, QIcon, qApp
@@ -201,6 +202,10 @@ def __initActions(self):
             "list-remove", _("&Remove subtitles"), None, "delete",
             connection = lambda: self._tabs.currentPage().removeSelectedSubtitles())
 
+        self._actions["findSub"] = af.create(
+            "edit-find", _("&Find..."), None, "ctrl+f",
+            connection = lambda: self._tabs.currentPage().highlight())
+
         # Video
         self._videoRatios = [(4, 3), (14, 9), (14, 10), (16, 9), (16, 10)]
         self._actions["openVideo"] = af.create(
@@ -261,6 +266,7 @@ def __initMenuBar(self):
         subtitlesMenu.addAction(self._actions["insertSub"])
         subtitlesMenu.addAction(self._actions["addSub"])
         subtitlesMenu.addAction(self._actions["removeSub"])
+        subtitlesMenu.addAction(self._actions["findSub"])
         subtitlesMenu.addSeparator()
         self._fpsMenu = subtitlesMenu.addMenu(_("&Frames per second"))
         self._fpsMenu.addSeparator()
@@ -411,6 +417,7 @@ def __updateMenuItemsState(self):
         self._actions["insertSub"].setEnabled(not tabIsStatic)
         self._actions["addSub"].setEnabled(not tabIsStatic)
         self._actions["removeSub"].setEnabled(not tabIsStatic)
+        self._actions["findSub"].setEnabled(not tabIsStatic)
 
         self._actions["videoJump"].setEnabled(not tabIsStatic)
 

subconvert/gui/SubtitleTabs.py

@@ -1,7 +1,7 @@
 #-*- coding: utf-8 -*-
 
 """
-Copyright (C) 2011, 2012, 2013 Michal Goral.
+Copyright (C) 2011-2015 Michal Goral.
 
 This file is part of Subconvert
 
@@ -22,11 +22,13 @@
 import os
 import logging
 import encodings
-from collections import OrderedDict
+import bisect
+from enum import Enum
 
 from PyQt4.QtGui import QWidget, QHBoxLayout, QVBoxLayout, QGridLayout, QIcon, QTreeWidgetItem
 from PyQt4.QtGui import QTableView, QHeaderView, QStandardItemModel, QStandardItem, QSizePolicy
 from PyQt4.QtGui import QMessageBox, QAbstractItemView, QAction, QMenu, QCursor, QFileDialog
+from PyQt4.QtGui import QPushButton
 from PyQt4.QtCore import pyqtSignal, pyqtSlot, Qt, QTimer
 
 from subconvert.parsing.FrameTime import FrameTime
@@ -36,9 +38,11 @@
 from subconvert.utils.SubSettings import SubSettings
 from subconvert.utils.PropertyFile import SubtitleProperties, PropertiesFileApplier
 from subconvert.utils.SubFile import File
+from subconvert.utils.SubtitleSearch import SearchIterator, matchText
 from subconvert.gui.FileDialogs import FileDialog
 from subconvert.gui.Detail import ActionFactory, SubtitleList, ComboBoxWithHistory, FPS_VALUES
 from subconvert.gui.Detail import CustomDataRoles, SubListItemDelegate, DisableSignalling
+from subconvert.gui.Detail import SearchEdit
 from subconvert.gui.SubtitleCommands import *
 
 log = logging.getLogger('Subconvert.%s' % __name__)
@@ -495,6 +499,9 @@ def __initWidgets(self):
         self._subList.setItemDelegateForColumn(1, subListDelegate)
         self._subList.horizontalHeader().setResizeMode(2, QHeaderView.Stretch)
 
+        self._searchBar = SearchBar(self)
+        self._searchBar.hide()
+
         # Top toolbar
         toolbar = QHBoxLayout()
         toolbar.setAlignment(Qt.AlignLeft)
@@ -507,6 +514,7 @@ def __initWidgets(self):
         grid.setContentsMargins(0, 3, 0, 0)
         grid.addLayout(toolbar, 0, 0, 1, 1) # stretch to the right
         grid.addWidget(self._subList, 1, 0)
+        grid.addWidget(self._searchBar, 2, 0)
         self.setLayout(grid)
 
     def __initContextMenu(self):
@@ -659,6 +667,10 @@ def removeSelectedSubtitles(self):
             else:
                 self._subList.selectRow(self._model.rowCount() - 1)
 
+    def highlight(self):
+        self._searchBar.show()
+        self._searchBar.highlight()
+
     def showContextMenu(self):
         self._contextMenu.exec(QCursor.pos())
 
@@ -743,14 +755,19 @@ def updateTab(self):
         self.refreshSubtitles()
 
     def selectedSubtitles(self):
+        rows = self.selectedRows()
+        subtitleList = [self.subtitles[row] for row in rows]
+        return subtitleList
+
+    def selectedRows(self):
         indices = self._subList.selectedIndexes()
-        if len(indices) > 0:
-            tempDict = OrderedDict.fromkeys([index.row() for index in indices])
-            rows = list(tempDict)
-            rows.sort()
-            subtitleList = [self.subtitles[row] for row in rows]
-            return subtitleList
-        return []
+        # unique list
+        rows = list(set([index.row() for index in indices]))
+        rows.sort()
+        return rows
+
+    def selectRow(self, row):
+        self._subList.selectRow(row)
 
     @property
     def filePath(self):
@@ -783,3 +800,91 @@ def outputEncoding(self):
     @property
     def outputFormat(self):
         return self.data.outputFormat
+
+class SearchBar(QWidget):
+    class SearchDirection(Enum):
+        Forward = 1
+        Backward = 2
+
+    def __init__(self, parent):
+        super(SearchBar, self).__init__(parent)
+
+        self._sit = None
+
+        self._editor = SearchEdit(self)
+        self._prevButton = QPushButton("<", self)
+        self._nextButton = QPushButton(">", self)
+        self._closeButton = QPushButton(QIcon.fromTheme("window-close"), "", self)
+
+        layout = QHBoxLayout()
+        layout.setAlignment(Qt.AlignLeft)
+        layout.setSpacing(0)
+
+        layout.addWidget(self._editor)
+        layout.addWidget(self._prevButton)
+        layout.addWidget(self._nextButton)
+        layout.addWidget(self._closeButton)
+        layout.setContentsMargins(1, 1, 1, 1)
+
+        self.setLayout(layout)
+
+        self._nextButton.clicked.connect(self.next)
+        self._prevButton.clicked.connect(self.prev)
+        self._closeButton.clicked.connect(self.hide)
+        self._editor.textChanged.connect(self._reset)
+        self._editor.returnPressed.connect(self.next)
+        self._editor.escapePressed.connect(self.hide)
+
+    def highlight(self):
+        self._editor.setFocus()
+        self._editor.selectAll()
+
+    def next(self):
+        self._search(self.SearchDirection.Forward)
+
+    def prev(self):
+        self._search(self.SearchDirection.Backward)
+
+    def _search(self, direction):
+        if self._editor.text() == "":
+            self._reset()
+            return
+
+        if self._sit is None:
+            data = self.parent().data
+            case = any(map(str.isupper, self._editor.text()))
+            self._sit = SearchIterator(data.subtitles,
+                lambda sub, text = self._editor.text(), case = case: matchText(sub, text, case))
+
+        self._updateIteratorPositionFromSelection(direction)
+
+        fn = self._sit.next if direction == self.SearchDirection.Forward else self._sit.prev
+        try:
+            subNo = fn()
+            self.parent().selectRow(subNo)
+        except StopIteration:
+            self._searchError()
+
+    def _updateIteratorPositionFromSelection(self, direction):
+        selections = self.parent().selectedRows()
+        startRow = selections[-1] if len(selections) > 0 else -1
+
+        if startRow == -1 or len(self._sit.range()) == 0:
+            return
+
+        # When iterator points at different row, it means that user changed it
+        if startRow != self._sit.get():
+            pos = None
+            if direction == self.SearchDirection.Forward:
+                pos = bisect.bisect_right(self._sit.range(), startRow) - 1
+            else:
+                pos = bisect.bisect_left(self._sit.range(), startRow)
+            self._sit.setpos(pos)
+
+    def _searchError(self):
+        self._editor.setStyleSheet("background-color: #CD5555")
+
+    def _reset(self):
+        self._sit = None
+        self._editor.setStyleSheet("")
+

subconvert/utils/Makefile.am

@@ -10,6 +10,7 @@ utils_PYTHON = \
 	SubFile.py \
 	SubSettings.py \
 	SubtitleData.py \
+	SubtitleSearch.py \
 	version.py \
 	VideoPlayer.py
 

subconvert/utils/SubtitleSearch.py

@@ -0,0 +1,71 @@
+#-*- coding: utf-8 -*-
+
+"""
+Copyright (C) 2011-2015 Michal Goral.
+
+This file is part of Subconvert
+
+Subconvert 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 3 of the License, or
+(at your option) any later version.
+
+Subconvert 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 Subconvert. If not, see <http://www.gnu.org/licenses/>.
+"""
+
+def matchText(sub, text, case):
+    if (text == ""): return False
+    if case is True:
+        if text in sub.text: return True
+    else:
+        if text.lower() in sub.text.lower(): return True
+    return False
+
+class SearchIterator:
+    def __init__(self, subs, matcher):
+        """
+        subs: list of subtitles (list(subconvert.parsing.Subtitle))
+        matcher: function returning True when single subtitle matches a given criteria
+        """
+        self._range = [i for i, sub in enumerate(subs) if matcher(sub)]
+        self._idx = -1
+
+    def __iter__(self):
+        return self
+
+    def range(self):
+        return self._range
+
+    def get(self):
+        if len(self._range) == 0:
+            raise IndexError("range is empty")
+        return self._get(self._idx)
+
+    def next(self):
+        return self._get(self._idx + 1)
+
+    def prev(self):
+        return self._get(self._idx - 1)
+
+    def setpos(self, pos):
+        self._idx = pos
+
+    def _indexInRange(self, index):
+        if index < 0:
+            index = len(self._range) - 1
+        elif index >= len(self._range):
+            index = 0
+        return index
+
+    def _get(self, index):
+        if len(self._range) == 0:
+            raise StopIteration
+
+        self._idx = self._indexInRange(index)
+        return self._range[self._idx]