Veronica Berglyd Olsen
350 lines
13 KiB
Python
350 lines
13 KiB
Python
"""
|
||
novelWriter – GUI Project Search
|
||
================================
|
||
|
||
File History:
|
||
Created: 2024-03-21 [2.4b1] GuiProjectSearch
|
||
|
||
This file is a part of novelWriter
|
||
Copyright (C) 2024 Veronica Berglyd Olsen and novelWriter contributors
|
||
|
||
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 3 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, see <https://www.gnu.org/licenses/>.
|
||
""" # noqa
|
||
from __future__ import annotations
|
||
|
||
import logging
|
||
|
||
from time import time
|
||
from typing import TYPE_CHECKING
|
||
|
||
from PyQt6.QtCore import Qt, pyqtSignal, pyqtSlot
|
||
from PyQt6.QtGui import QAction, QCursor, QKeyEvent, QPalette
|
||
from PyQt6.QtWidgets import (
|
||
QApplication, QFrame, QHBoxLayout, QLabel, QLineEdit, QToolBar,
|
||
QTreeWidget, QTreeWidgetItem, QVBoxLayout, QWidget
|
||
)
|
||
|
||
from novelwriter import CONFIG, SHARED
|
||
from novelwriter.common import checkInt, qtAddAction
|
||
from novelwriter.core.coretools import DocSearch
|
||
from novelwriter.types import (
|
||
QtAlignMiddle, QtAlignRight, QtHeaderStretch, QtHeaderToContents,
|
||
QtHexArgb, QtUserRole
|
||
)
|
||
|
||
if TYPE_CHECKING:
|
||
from novelwriter.core.item import NWItem
|
||
|
||
logger = logging.getLogger(__name__)
|
||
|
||
|
||
class GuiProjectSearch(QWidget):
|
||
"""GUI: Project Search Panel."""
|
||
|
||
C_NAME = 0
|
||
C_RESULT = 0
|
||
C_COUNT = 1
|
||
|
||
D_HANDLE = QtUserRole
|
||
D_RESULT = QtUserRole + 1
|
||
|
||
selectedItemChanged = pyqtSignal(str)
|
||
openDocumentSelectRequest = pyqtSignal(str, int, int, bool)
|
||
|
||
def __init__(self, parent: QWidget) -> None:
|
||
super().__init__(parent=parent)
|
||
|
||
logger.debug("Create: GuiProjectSearch")
|
||
|
||
iPx = SHARED.theme.baseIconHeight
|
||
iSz = SHARED.theme.baseIconSize
|
||
|
||
self._time = time()
|
||
self._search = DocSearch()
|
||
self._blocked = False
|
||
self._map: dict[str, tuple[int, float]] = {}
|
||
|
||
self.setContentsMargins(0, 0, 0, 0)
|
||
self.setBackgroundRole(QPalette.ColorRole.Base)
|
||
self.setAutoFillBackground(True)
|
||
|
||
# Header
|
||
self.viewLabel = QLabel(self.tr("Project Search"), self)
|
||
self.viewLabel.setFont(SHARED.theme.guiFontB)
|
||
self.viewLabel.setContentsMargins(4, 4, 0, 2)
|
||
|
||
# Options
|
||
self.searchOpt = QToolBar(self)
|
||
self.searchOpt.setToolButtonStyle(Qt.ToolButtonStyle.ToolButtonIconOnly)
|
||
self.searchOpt.setIconSize(iSz)
|
||
self.searchOpt.setContentsMargins(0, 0, 0, 0)
|
||
|
||
self.toggleCase = qtAddAction(self.searchOpt, self.tr("Case Sensitive"))
|
||
self.toggleCase.setCheckable(True)
|
||
self.toggleCase.setChecked(CONFIG.searchProjCase)
|
||
self.toggleCase.toggled.connect(self._toggleCase)
|
||
|
||
self.toggleWord = qtAddAction(self.searchOpt, self.tr("Whole Words Only"))
|
||
self.toggleWord.setCheckable(True)
|
||
self.toggleWord.setChecked(CONFIG.searchProjWord)
|
||
self.toggleWord.toggled.connect(self._toggleWord)
|
||
|
||
self.toggleRegEx = qtAddAction(self.searchOpt, self.tr("RegEx Mode"))
|
||
self.toggleRegEx.setCheckable(True)
|
||
self.toggleRegEx.setChecked(CONFIG.searchProjRegEx)
|
||
self.toggleRegEx.toggled.connect(self._toggleRegEx)
|
||
|
||
# Search Box
|
||
self.searchAction = QAction("", self)
|
||
self.searchAction.setIcon(SHARED.theme.getIcon("search", "blue"))
|
||
self.searchAction.triggered.connect(self._processSearch)
|
||
|
||
self.searchText = QLineEdit(self)
|
||
self.searchText.setPlaceholderText(self.tr("Search for"))
|
||
self.searchText.setClearButtonEnabled(True)
|
||
self.searchText.addAction(self.searchAction, QLineEdit.ActionPosition.TrailingPosition)
|
||
|
||
# Search Result
|
||
self.searchResult = QTreeWidget(self)
|
||
self.searchResult.setHeaderHidden(True)
|
||
self.searchResult.setColumnCount(2)
|
||
self.searchResult.setIconSize(iSz)
|
||
self.searchResult.setIndentation(iPx)
|
||
self.searchResult.setFrameStyle(QFrame.Shape.NoFrame)
|
||
self.searchResult.setUniformRowHeights(True)
|
||
self.searchResult.setAllColumnsShowFocus(True)
|
||
self.searchResult.itemDoubleClicked.connect(self._searchResultDoubleClicked)
|
||
self.searchResult.itemSelectionChanged.connect(self._searchResultSelected)
|
||
self.searchResult.setAccessibleName(self.viewLabel.text())
|
||
|
||
if header := self.searchResult.header():
|
||
header.setStretchLastSection(False)
|
||
header.setSectionResizeMode(self.C_NAME, QtHeaderStretch)
|
||
header.setSectionResizeMode(self.C_COUNT, QtHeaderToContents)
|
||
|
||
# Assemble
|
||
self.headerBox = QHBoxLayout()
|
||
self.headerBox.addWidget(self.viewLabel, 1)
|
||
self.headerBox.addWidget(self.searchOpt, 0, QtAlignMiddle)
|
||
self.headerBox.setContentsMargins(0, 0, 0, 0)
|
||
self.headerBox.setSpacing(0)
|
||
|
||
self.outerBox = QVBoxLayout()
|
||
self.outerBox.addLayout(self.headerBox, 0)
|
||
self.outerBox.addWidget(self.searchText, 0)
|
||
self.outerBox.addWidget(self.searchResult, 1)
|
||
self.outerBox.setContentsMargins(0, 0, 0, 0)
|
||
self.outerBox.setSpacing(2)
|
||
|
||
self.setLayout(self.outerBox)
|
||
self.updateTheme()
|
||
|
||
logger.debug("Ready: GuiProjectSearch")
|
||
|
||
##
|
||
# Methods
|
||
##
|
||
|
||
def updateTheme(self) -> None:
|
||
"""Update theme elements."""
|
||
logger.debug("Theme Update: GuiProjectSearch")
|
||
|
||
palette = QApplication.palette()
|
||
colBase = palette.base().color().name(QtHexArgb)
|
||
colFocus = palette.highlight().color().name(QtHexArgb)
|
||
|
||
self.setStyleSheet(
|
||
"QToolBar {padding: 0; background: none;} "
|
||
f"QLineEdit {{border: 1px solid {colBase}; padding: 2px;}} "
|
||
f"QLineEdit:focus {{border: 1px solid {colFocus};}} "
|
||
)
|
||
|
||
self.searchAction.setIcon(SHARED.theme.getIcon("search", "blue"))
|
||
self.toggleCase.setIcon(SHARED.theme.getIcon("search_case"))
|
||
self.toggleWord.setIcon(SHARED.theme.getIcon("search_word"))
|
||
self.toggleRegEx.setIcon(SHARED.theme.getIcon("search_regex"))
|
||
|
||
def processReturn(self) -> None:
|
||
"""Process a return keypress forwarded from the main GUI."""
|
||
if self.searchText.hasFocus():
|
||
self._processSearch()
|
||
elif (
|
||
self.searchResult.hasFocus()
|
||
and (items := self.searchResult.selectedItems())
|
||
and (data := items[0].data(0, self.D_RESULT))
|
||
and len(data) == 3
|
||
):
|
||
self.openDocumentSelectRequest.emit(
|
||
str(data[0]), checkInt(data[1], -1), checkInt(data[2], -1), False
|
||
)
|
||
|
||
def beginSearch(self, text: str = "") -> None:
|
||
"""Focus the search box and select its text, if any."""
|
||
self.searchText.setFocus()
|
||
self.searchText.selectAll()
|
||
if text:
|
||
self.searchText.setText(text.partition("\n")[0])
|
||
self.searchText.selectAll()
|
||
|
||
def closeProjectTasks(self) -> None:
|
||
"""Run close project tasks."""
|
||
self._map = {}
|
||
self.searchText.clear()
|
||
self.searchResult.clear()
|
||
|
||
def refreshCurrentSearch(self) -> None:
|
||
"""Refresh the search if there is one."""
|
||
if self.searchResult.topLevelItemCount() > 0:
|
||
self._processSearch()
|
||
|
||
##
|
||
# Events
|
||
##
|
||
|
||
def keyPressEvent(self, event: QKeyEvent) -> None:
|
||
"""Process key press events. This handles up and down arrow key
|
||
presses to jump between search text box and result tree.
|
||
"""
|
||
if (
|
||
event.key() == Qt.Key.Key_Down
|
||
and self.searchText.hasFocus()
|
||
and (first := self.searchResult.topLevelItem(0))
|
||
):
|
||
first.setSelected(True)
|
||
self.searchResult.setFocus()
|
||
elif (
|
||
event.key() == Qt.Key.Key_Up
|
||
and self.searchResult.hasFocus()
|
||
and (first := self.searchResult.topLevelItem(0))
|
||
and first.isSelected()
|
||
):
|
||
first.setSelected(False)
|
||
self.searchText.setFocus()
|
||
else:
|
||
super().keyPressEvent(event)
|
||
|
||
##
|
||
# Public Slots
|
||
##
|
||
|
||
@pyqtSlot(str, float)
|
||
def textChanged(self, tHandle: str, timeStamp: float) -> None:
|
||
"""Update search result for a specific document."""
|
||
if (entry := self._map.get(tHandle)) and timeStamp > entry[1]:
|
||
start = time()
|
||
results, capped = self._search.searchText(SHARED.mainGui.docEditor.getText())
|
||
self._displayResultSet(SHARED.project.tree[tHandle], results, capped)
|
||
logger.debug("Updated search for '%s' in %.3f ms", tHandle, 1000*(time() - start))
|
||
|
||
##
|
||
# Private Slots
|
||
##
|
||
|
||
@pyqtSlot()
|
||
def _processSearch(self) -> None:
|
||
"""Perform a search."""
|
||
if not self._blocked:
|
||
QApplication.setOverrideCursor(QCursor(Qt.CursorShape.WaitCursor))
|
||
start = time()
|
||
SHARED.saveEditor()
|
||
self._blocked = True
|
||
self._map = {}
|
||
self.searchResult.clear()
|
||
if text := self.searchText.text():
|
||
self._search.setUserRegEx(self.toggleRegEx.isChecked())
|
||
self._search.setCaseSensitive(self.toggleCase.isChecked())
|
||
self._search.setWholeWords(self.toggleWord.isChecked())
|
||
for item, results, capped in self._search.iterSearch(SHARED.project, text):
|
||
self._displayResultSet(item, results, capped)
|
||
logger.debug("Search took %.3f ms", 1000*(time() - start))
|
||
self._time = time()
|
||
QApplication.restoreOverrideCursor()
|
||
self._blocked = False
|
||
|
||
@pyqtSlot()
|
||
def _searchResultSelected(self) -> None:
|
||
"""Process search result selection."""
|
||
if items := self.searchResult.selectedItems():
|
||
if (data := items[0].data(0, self.D_RESULT)) and len(data) == 3:
|
||
self.selectedItemChanged.emit(str(data[0]))
|
||
elif data := items[0].data(0, self.D_HANDLE):
|
||
self.selectedItemChanged.emit(str(data))
|
||
|
||
@pyqtSlot("QTreeWidgetItem*", int)
|
||
def _searchResultDoubleClicked(self, item: QTreeWidgetItem, column: int) -> None:
|
||
"""Process search result double click."""
|
||
if (data := item.data(0, self.D_RESULT)) and len(data) == 3:
|
||
self.openDocumentSelectRequest.emit(
|
||
str(data[0]), checkInt(data[1], -1), checkInt(data[2], -1), True
|
||
)
|
||
|
||
@pyqtSlot(bool)
|
||
def _toggleCase(self, state: bool) -> None:
|
||
"""Enable/disable case sensitive mode."""
|
||
CONFIG.searchProjCase = state
|
||
self.refreshCurrentSearch()
|
||
|
||
@pyqtSlot(bool)
|
||
def _toggleWord(self, state: bool) -> None:
|
||
"""Enable/disable whole word search mode."""
|
||
CONFIG.searchProjWord = state
|
||
self.refreshCurrentSearch()
|
||
|
||
@pyqtSlot(bool)
|
||
def _toggleRegEx(self, state: bool) -> None:
|
||
"""Enable/disable regular expression search mode."""
|
||
CONFIG.searchProjRegEx = state
|
||
self.refreshCurrentSearch()
|
||
|
||
##
|
||
# Internal Functions
|
||
##
|
||
|
||
def _displayResultSet(
|
||
self, nwItem: NWItem | None, results: list[tuple[int, int, str]], capped: bool
|
||
) -> None:
|
||
"""Populate the result tree."""
|
||
if results and nwItem:
|
||
tHandle = nwItem.itemHandle
|
||
ext = "+" if capped else ""
|
||
|
||
tItem = QTreeWidgetItem()
|
||
tItem.setText(self.C_NAME, nwItem.itemName)
|
||
tItem.setIcon(self.C_NAME, nwItem.getMainIcon())
|
||
tItem.setData(self.C_NAME, self.D_HANDLE, tHandle)
|
||
tItem.setText(self.C_COUNT, f"({len(results):n}{ext})")
|
||
tItem.setTextAlignment(self.C_COUNT, QtAlignRight)
|
||
tItem.setForeground(self.C_COUNT, self.palette().highlight())
|
||
|
||
index = self._map.get(tHandle, (self.searchResult.topLevelItemCount(), 0.0))[0]
|
||
self.searchResult.takeTopLevelItem(index)
|
||
self.searchResult.insertTopLevelItem(index, tItem)
|
||
self._map[tHandle] = (index, time())
|
||
|
||
rItems = []
|
||
for start, length, context in results:
|
||
rItem = QTreeWidgetItem()
|
||
rItem.setText(0, context)
|
||
rItem.setData(0, self.D_RESULT, (tHandle, start, length))
|
||
rItems.append(rItem)
|
||
|
||
tItem.addChildren(rItems)
|
||
tItem.setExpanded(True)
|
||
|
||
parent = self.searchResult.indexFromItem(tItem)
|
||
for i in range(tItem.childCount()):
|
||
self.searchResult.setFirstColumnSpanned(i, parent, True)
|
||
|
||
QApplication.processEvents()
|