""" novelWriter – GUI Main Window Status Bar ======================================== File History: Created: 2019-04-20 [0.0.1] GuiMainStatus This file is a part of novelWriter Copyright (C) 2019 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 . """ # noqa from __future__ import annotations import logging from datetime import datetime from time import time from PyQt6.QtCore import QLocale, pyqtSlot from PyQt6.QtWidgets import QApplication, QLabel, QStatusBar, QWidget from novelwriter import CONFIG, SHARED from novelwriter.common import formatTime from novelwriter.constants import nwConst, nwLabels, nwStats, trStats from novelwriter.extensions.modified import NClickableLabel from novelwriter.extensions.statusled import StatusLED logger = logging.getLogger(__name__) class GuiMainStatus(QStatusBar): """GUI: Main Window Status Bar.""" def __init__(self, parent: QWidget) -> None: super().__init__(parent=parent) logger.debug("Create: GuiMainStatus") self._refTime = -1.0 self._userIdle = False self._debugInfo = False iPx = SHARED.theme.baseIconHeight # Permanent Widgets # ================= # The Spell Checker Language self.langIcon = QLabel("", self) self.langText = QLabel(self.tr("None"), self) self.langIcon.setContentsMargins(0, 0, 0, 0) self.langText.setContentsMargins(0, 0, 8, 0) self.addPermanentWidget(self.langIcon) self.addPermanentWidget(self.langText) # The Editor Status self.docIcon = StatusLED(iPx, iPx, self) self.docText = QLabel(self.tr("Editor"), self) self.docIcon.setContentsMargins(0, 0, 0, 0) self.docText.setContentsMargins(0, 0, 8, 0) self.addPermanentWidget(self.docIcon) self.addPermanentWidget(self.docText) # The Project Status self.projIcon = StatusLED(iPx, iPx, self) self.projText = QLabel(self.tr("Project"), self) self.projIcon.setContentsMargins(0, 0, 0, 0) self.projText.setContentsMargins(0, 0, 8, 0) self.addPermanentWidget(self.projIcon) self.addPermanentWidget(self.projText) # The Project and Session Stats self.statsIcon = QLabel(self) self.statsText = QLabel("", self) self.statsIcon.setContentsMargins(0, 0, 0, 0) self.statsText.setContentsMargins(0, 0, 8, 0) self.addPermanentWidget(self.statsIcon) self.addPermanentWidget(self.statsText) # The Session Clock # Set the minimum width so the label doesn't rescale every second self.timeIcon = NClickableLabel(self) self.timeIcon.mouseClicked.connect(self._onClickTimerLabel) self.timeText = NClickableLabel("", self) self.timeText.setToolTip(self.tr("Session Time")) self.timeText.setMinimumWidth(SHARED.theme.getTextWidth("00:00:00:")) self.timeIcon.setContentsMargins(0, 0, 0, 0) self.timeText.setContentsMargins(0, 0, 0, 0) self.timeText.setVisible(CONFIG.showSessionTime) self.timeText.mouseClicked.connect(self._onClickTimerLabel) self.addPermanentWidget(self.timeIcon) self.addPermanentWidget(self.timeText) # Other Settings self.setSizeGripEnabled(True) logger.debug("Ready: GuiMainStatus") self.initSettings() self.updateTheme() self.clearStatus() def initSettings(self) -> None: """Apply user settings.""" if CONFIG.useCharCount: self._trStatsCount = trStats(nwLabels.STATS_DISPLAY[nwStats.CHARS]) self._trStatsTip = self.tr("Total character count (session change)") else: self._trStatsCount = trStats(nwLabels.STATS_DISPLAY[nwStats.WORDS]) self._trStatsTip = self.tr("Total word count (session change)") def clearStatus(self) -> None: """Reset all widgets on the status bar to default values.""" self.setRefTime(-1.0) self.setLanguage(*SHARED.spelling.describeDict()) self.setProjectStats(0, 0) self.setProjectStatus(None) self.setDocumentStatus(None) self.updateTime() def updateTheme(self) -> None: """Update theme elements.""" iPx = SHARED.theme.baseIconHeight self.langIcon.setPixmap(SHARED.theme.getPixmap("language", (iPx, iPx))) self.statsIcon.setPixmap(SHARED.theme.getPixmap("stats", (iPx, iPx))) self.timePixmap = SHARED.theme.getPixmap("timer", (iPx, iPx)) self.idlePixmap = SHARED.theme.getPixmap("timer_off", (iPx, iPx)) self.timeIcon.setPixmap(self.timePixmap) colNone = SHARED.theme.getBaseColor("default").darker(150) colSaved = SHARED.theme.getBaseColor("green").darker(150) colUnsaved = SHARED.theme.getBaseColor("red").darker(150) self.docIcon.setColors(colNone, colSaved, colUnsaved) self.projIcon.setColors(colNone, colSaved, colUnsaved) ## # Setters ## def setRefTime(self, refTime: float) -> None: """Set the reference time for the status bar clock.""" self._refTime = refTime def setProjectStatus(self, state: bool | None) -> None: """Set the project status colour icon.""" self.projIcon.setState(state) def setDocumentStatus(self, state: bool | None) -> None: """Set the document status colour icon.""" self.docIcon.setState(state) def setUserIdle(self, idle: bool) -> None: """Change the idle status icon.""" if not CONFIG.stopWhenIdle: idle = False if self._userIdle != idle: if idle: self.timeIcon.setPixmap(self.idlePixmap) else: self.timeIcon.setPixmap(self.timePixmap) self._userIdle = idle def setProjectStats(self, pWC: int, sWC: int) -> None: """Update the current project statistics.""" self.statsText.setText(self._trStatsCount.format(f"{pWC:n}", f"{sWC:+n}")) self.statsText.setToolTip(self._trStatsTip) def updateTime(self, idleTime: float = 0.0) -> None: """Update the session clock.""" if self._refTime < 0.0: self.timeText.setText("00:00:00") else: if CONFIG.stopWhenIdle: sessTime = round(time() - self._refTime - idleTime) else: sessTime = round(time() - self._refTime) self.timeText.setText(formatTime(sessTime)) ## # Public Slots ## @pyqtSlot(str) def setStatusMessage(self, message: str) -> None: """Set the status bar message to display.""" self.showMessage(message, nwConst.STATUS_MSG_TIMEOUT) QApplication.processEvents() @pyqtSlot(str, str) def setLanguage(self, language: str, provider: str) -> None: """Set the language code for the spell checker.""" if language == "None": self.langText.setText(self.tr("None")) self.langText.setToolTip("") else: self.langText.setText(QLocale(language).nativeLanguageName().title()) self.langText.setToolTip(f"{language} ({provider})" if provider else language) @pyqtSlot(bool) def updateProjectStatus(self, status: bool) -> None: """Update the project status.""" self.setProjectStatus(not status) @pyqtSlot(bool) def updateDocumentStatus(self, status: bool) -> None: """Update the document status.""" self.setDocumentStatus(not status) ## # Private Slots ## @pyqtSlot() def _onClickTimerLabel(self) -> None: """Process mouse click on timer label.""" state = not CONFIG.showSessionTime self.timeText.setVisible(state) CONFIG.showSessionTime = state ## # Debug ## def memInfo(self) -> None: # pragma: no cover """Display memory info on the status bar. This is used to investigate memory usage and Qt widgets that get left in memory. Enabled by the --meminfo command line flag. By default, this tracks memory usage diff after launch. To track full memory usage, set environment variable PYTHONTRACEMALLOC=1 before starting novelWriter. """ import tracemalloc count = len(QApplication.allWidgets()) if not self._debugInfo: if tracemalloc.is_tracing(): self._traceMallocRef = "Total" else: self._traceMallocRef = "Relative" tracemalloc.start() self._debugInfo = True current, peak = tracemalloc.get_traced_memory() stamp = datetime.now().strftime("%H:%M:%S") message = ( f"Widgets: {count} \u2013 " f"{self._traceMallocRef} Memory: {current/1024:,.2f} kiB \u2013 " f"Peak: {peak/1024:,.2f} kiB" ) self.showMessage(f"Debug [{stamp}] {message}", 6000) logger.debug("[MEMINFO] %s", message)