anki/qt/aqt/utils.py

817 lines
21 KiB
Python
Raw Normal View History

2019-02-05 04:59:03 +01:00
# Copyright: Ankitects Pty Ltd and contributors
# -*- coding: utf-8 -*-
# License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
from __future__ import annotations
2019-12-20 10:19:03 +01:00
import os
import re
import subprocess
import sys
from typing import TYPE_CHECKING, Any, Optional, Union
import anki
import aqt
2019-03-04 02:58:34 +01:00
from anki.lang import _
from anki.rsbackend import TR # pylint: disable=unused-import
2019-12-23 01:34:10 +01:00
from anki.utils import invalidFilename, isMac, isWin, noBundledLibs, versionWithBuild
2019-12-20 10:19:03 +01:00
from aqt.qt import *
2020-01-23 22:55:14 +01:00
from aqt.theme import theme_manager
2019-12-20 10:19:03 +01:00
if TYPE_CHECKING:
from anki.rsbackend import TRValue
def aqt_data_folder() -> str:
# wheel install?
dir = os.path.join(sys.prefix, "aqt_data")
if not os.path.exists(dir) or not os.listdir(dir):
# running in place?
dir = os.path.join(os.path.dirname(__file__), "..", "aqt_data")
return dir
def locale_dir() -> str:
return os.path.join(aqt_data_folder(), "locale")
def tr(key: TRValue, **kwargs: Union[str, int, float]) -> str:
"Shortcut to access Fluent translations."
2020-02-24 09:37:02 +01:00
return anki.lang.current_i18n.translate(key, **kwargs)
def openHelp(section):
link = aqt.appHelpSite
if section:
link += "#%s" % section
openLink(link)
2019-12-23 01:34:10 +01:00
def openLink(link):
tooltip(_("Loading..."), period=1000)
with noBundledLibs():
QDesktopServices.openUrl(QUrl(link))
2019-12-23 01:34:10 +01:00
def showWarning(text, parent=None, help="", title="Anki", textFormat=None):
"Show a small warning with an OK button."
return showInfo(text, parent, help, "warning", title=title, textFormat=textFormat)
2019-12-23 01:34:10 +01:00
def showCritical(text, parent=None, help="", title="Anki", textFormat=None):
"Show a small critical error with an OK button."
return showInfo(text, parent, help, "critical", title=title, textFormat=textFormat)
2019-12-23 01:34:10 +01:00
def showInfo(
text,
parent=False,
help="",
type="info",
title="Anki",
textFormat=None,
2020-01-03 18:23:28 +01:00
customBtns=None,
):
"Show a small info window with an OK button."
if parent is False:
parent = aqt.mw.app.activeWindow() or aqt.mw
if type == "warning":
icon = QMessageBox.Warning
elif type == "critical":
icon = QMessageBox.Critical
else:
icon = QMessageBox.Information
mb = QMessageBox(parent)
if textFormat == "plain":
mb.setTextFormat(Qt.PlainText)
elif textFormat == "rich":
mb.setTextFormat(Qt.RichText)
2019-02-27 05:16:35 +01:00
elif textFormat is not None:
raise Exception("unexpected textFormat type")
mb.setText(text)
mb.setIcon(icon)
mb.setWindowTitle(title)
if customBtns:
default = None
for btn in customBtns:
b = mb.addButton(btn)
if not default:
default = b
mb.setDefaultButton(default)
else:
b = mb.addButton(QMessageBox.Ok)
b.setDefault(True)
if help:
b = mb.addButton(QMessageBox.Help)
qconnect(b.clicked, lambda: openHelp(help))
b.setAutoDefault(False)
return mb.exec_()
2019-12-23 01:34:10 +01:00
def showText(
txt,
parent=None,
type="text",
run=True,
geomKey=None,
minWidth=500,
minHeight=400,
title="Anki",
copyBtn=False,
):
if not parent:
parent = aqt.mw.app.activeWindow() or aqt.mw
diag = QDialog(parent)
diag.setWindowTitle(title)
layout = QVBoxLayout(diag)
diag.setLayout(layout)
text = QTextBrowser()
text.setOpenExternalLinks(True)
if type == "text":
text.setPlainText(txt)
else:
text.setHtml(txt)
layout.addWidget(text)
box = QDialogButtonBox(QDialogButtonBox.Close)
layout.addWidget(box)
if copyBtn:
2019-12-23 01:34:10 +01:00
def onCopy():
QApplication.clipboard().setText(text.toPlainText())
2019-12-23 01:34:10 +01:00
btn = QPushButton(_("Copy to Clipboard"))
qconnect(btn.clicked, onCopy)
box.addButton(btn, QDialogButtonBox.ActionRole)
2019-12-23 01:34:10 +01:00
def onReject():
if geomKey:
saveGeom(diag, geomKey)
QDialog.reject(diag)
2019-12-23 01:34:10 +01:00
qconnect(box.rejected, onReject)
2019-12-23 01:34:10 +01:00
def onFinish():
if geomKey:
saveGeom(diag, geomKey)
2019-12-23 01:34:10 +01:00
qconnect(box.accepted, onFinish)
diag.setMinimumHeight(minHeight)
diag.setMinimumWidth(minWidth)
if geomKey:
restoreGeom(diag, geomKey)
if run:
diag.exec_()
else:
return diag, box
2019-12-23 01:34:10 +01:00
def askUser(text, parent=None, help="", defaultno=False, msgfunc=None, title="Anki"):
"Show a yes/no question. Return true if yes."
if not parent:
parent = aqt.mw.app.activeWindow()
if not msgfunc:
msgfunc = QMessageBox.question
sb = QMessageBox.Yes | QMessageBox.No
if help:
sb |= QMessageBox.Help
while 1:
if defaultno:
default = QMessageBox.No
else:
default = QMessageBox.Yes
r = msgfunc(parent, title, text, sb, default)
if r == QMessageBox.Help:
openHelp(help)
else:
break
return r == QMessageBox.Yes
2019-12-23 01:34:10 +01:00
class ButtonedDialog(QMessageBox):
2016-05-01 05:32:17 +02:00
def __init__(self, text, buttons, parent=None, help="", title="Anki"):
2019-03-04 06:59:53 +01:00
QMessageBox.__init__(self, parent)
self.buttons = []
self.setWindowTitle(title)
self.help = help
self.setIcon(QMessageBox.Warning)
self.setText(text)
# v = QVBoxLayout()
# v.addWidget(QLabel(text))
# box = QDialogButtonBox()
# v.addWidget(box)
for b in buttons:
2019-12-23 01:34:10 +01:00
self.buttons.append(self.addButton(b, QMessageBox.AcceptRole))
if help:
self.addButton(_("Help"), QMessageBox.HelpRole)
buttons.append(_("Help"))
2019-12-23 01:34:10 +01:00
# self.setLayout(v)
def run(self):
self.exec_()
but = self.clickedButton().text()
if but == "Help":
# FIXME stop dialog closing?
openHelp(self.help)
txt = self.clickedButton().text()
# work around KDE 'helpfully' adding accelerators to button text of Qt apps
return txt.replace("&", "")
def setDefault(self, idx):
self.setDefaultButton(self.buttons[idx])
2019-12-23 01:34:10 +01:00
def askUserDialog(text, buttons, parent=None, help="", title="Anki"):
if not parent:
parent = aqt.mw
diag = ButtonedDialog(text, buttons, parent, help, title=title)
return diag
2019-12-23 01:34:10 +01:00
class GetTextDialog(QDialog):
def __init__(
self,
parent,
question,
help=None,
edit=None,
default="",
title="Anki",
minWidth=400,
):
QDialog.__init__(self, parent)
self.setWindowTitle(title)
self.question = question
self.help = help
self.qlabel = QLabel(question)
self.setMinimumWidth(minWidth)
v = QVBoxLayout()
v.addWidget(self.qlabel)
if not edit:
edit = QLineEdit()
self.l = edit
if default:
self.l.setText(default)
self.l.selectAll()
v.addWidget(self.l)
buts = QDialogButtonBox.Ok | QDialogButtonBox.Cancel
if help:
buts |= QDialogButtonBox.Help
b = QDialogButtonBox(buts)
v.addWidget(b)
self.setLayout(v)
qconnect(b.button(QDialogButtonBox.Ok).clicked, self.accept)
qconnect(b.button(QDialogButtonBox.Cancel).clicked, self.reject)
if help:
qconnect(b.button(QDialogButtonBox.Help).clicked, self.helpRequested)
def accept(self):
return QDialog.accept(self)
def reject(self):
return QDialog.reject(self)
def helpRequested(self):
openHelp(self.help)
2019-12-23 01:34:10 +01:00
def getText(
prompt,
parent=None,
help=None,
edit=None,
default="",
title="Anki",
geomKey=None,
**kwargs,
):
if not parent:
parent = aqt.mw.app.activeWindow() or aqt.mw
2019-12-23 01:34:10 +01:00
d = GetTextDialog(
parent, prompt, help=help, edit=edit, default=default, title=title, **kwargs
)
d.setWindowModality(Qt.WindowModal)
2017-05-03 10:55:24 +02:00
if geomKey:
restoreGeom(d, geomKey)
ret = d.exec_()
2017-05-03 10:55:24 +02:00
if geomKey and ret:
saveGeom(d, geomKey)
return (str(d.l.text()), ret)
2019-12-23 01:34:10 +01:00
def getOnlyText(*args, **kwargs):
(s, r) = getText(*args, **kwargs)
if r:
return s
else:
return ""
2019-12-23 01:34:10 +01:00
# fixme: these utilities could be combined into a single base class
def chooseList(prompt, choices, startrow=0, parent=None):
if not parent:
parent = aqt.mw.app.activeWindow()
d = QDialog(parent)
d.setWindowModality(Qt.WindowModal)
l = QVBoxLayout()
d.setLayout(l)
t = QLabel(prompt)
l.addWidget(t)
c = QListWidget()
c.addItems(choices)
c.setCurrentRow(startrow)
l.addWidget(c)
bb = QDialogButtonBox(QDialogButtonBox.Ok)
qconnect(bb.accepted, d.accept)
l.addWidget(bb)
d.exec_()
return c.currentRow()
2019-12-23 01:34:10 +01:00
def getTag(parent, deck, question, tags="user", **kwargs):
from aqt.tagedit import TagEdit
2019-12-23 01:34:10 +01:00
te = TagEdit(parent)
te.setCol(deck)
2019-12-23 01:34:10 +01:00
ret = getText(question, parent, edit=te, geomKey="getTag", **kwargs)
te.hideCompleter()
return ret
2019-12-23 01:34:10 +01:00
def setupComboBoxHistory(comboBox, name):
name += "BoxHistory"
history = aqt.mw.pm.profile.get(name, [])
comboBox.addItems(history)
comboBox.lineEdit().setText(history[0] if history else "")
comboBox.lineEdit().selectAll()
return history
def saveComboBoxHistory(comboBox, history, name):
name += "BoxHistory"
text_input = comboBox.lineEdit().text()
if text_input in history:
history.remove(text_input)
history.insert(0, text_input)
history = history[:50]
comboBox.clear()
comboBox.addItems(history)
aqt.mw.pm.profile[name] = history
return text_input
# File handling
######################################################################
2019-12-23 01:34:10 +01:00
def getFile(parent, title, cb, filter="*.*", dir=None, key=None, multi=False):
"Ask the user for a file."
assert not dir or not key
if not dir:
2019-12-23 01:34:10 +01:00
dirkey = key + "Directory"
dir = aqt.mw.pm.profile.get(dirkey, "")
else:
dirkey = None
d = QFileDialog(parent)
mode = QFileDialog.ExistingFiles if multi else QFileDialog.ExistingFile
d.setFileMode(mode)
if os.path.exists(dir):
d.setDirectory(dir)
d.setWindowTitle(title)
d.setNameFilter(filter)
ret = []
2019-12-23 01:34:10 +01:00
def accept():
files = list(d.selectedFiles())
if dirkey:
dir = os.path.dirname(files[0])
aqt.mw.pm.profile[dirkey] = dir
result = files if multi else files[0]
if cb:
cb(result)
ret.append(result)
2019-12-23 01:34:10 +01:00
qconnect(d.accepted, accept)
2018-07-23 05:57:17 +02:00
if key:
restoreState(d, key)
d.exec_()
2018-07-23 05:57:17 +02:00
if key:
saveState(d, key)
return ret and ret[0]
2019-12-23 01:34:10 +01:00
def getSaveFile(parent, title, dir_description, key, ext, fname=None):
"""Ask the user for a file to save. Use DIR_DESCRIPTION as config
variable. The file dialog will default to open with FNAME."""
2019-12-23 01:34:10 +01:00
config_key = dir_description + "Directory"
defaultPath = QStandardPaths.writableLocation(QStandardPaths.DocumentsLocation)
base = aqt.mw.pm.profile.get(config_key, defaultPath)
path = os.path.join(base, fname)
file = QFileDialog.getSaveFileName(
2019-12-23 01:34:10 +01:00
parent,
title,
path,
"{0} (*{1})".format(key, ext),
options=QFileDialog.DontConfirmOverwrite,
)[0]
if file:
# add extension
if not file.lower().endswith(ext):
file += ext
# save new default
dir = os.path.dirname(file)
aqt.mw.pm.profile[config_key] = dir
# check if it exists
if os.path.exists(file):
if not askUser(
2019-12-23 01:34:10 +01:00
_("This file exists. Are you sure you want to overwrite it?"), parent
):
return None
return file
2019-12-23 01:34:10 +01:00
def saveGeom(widget, key):
key += "Geom"
if isMac and widget.windowState() & Qt.WindowFullScreen:
geom = None
else:
geom = widget.saveGeometry()
aqt.mw.pm.profile[key] = geom
2019-12-23 01:34:10 +01:00
def restoreGeom(widget, key, offset=None, adjustSize=False):
key += "Geom"
if aqt.mw.pm.profile.get(key):
widget.restoreGeometry(aqt.mw.pm.profile[key])
if isMac and offset:
2013-05-17 08:17:04 +02:00
if qtminor > 6:
# bug in osx toolkit
s = widget.size()
2019-12-23 01:34:10 +01:00
widget.resize(s.width(), s.height() + offset * 2)
ensureWidgetInScreenBoundaries(widget)
else:
if adjustSize:
widget.adjustSize()
2019-12-23 01:34:10 +01:00
def ensureWidgetInScreenBoundaries(widget):
handle = widget.window().windowHandle()
if not handle:
# window has not yet been shown, retry later
aqt.mw.progress.timer(50, lambda: ensureWidgetInScreenBoundaries(widget), False)
return
# ensure widget is smaller than screen bounds
geom = handle.screen().availableGeometry()
wsize = widget.size()
cappedWidth = min(geom.width(), wsize.width())
cappedHeight = min(geom.height(), wsize.height())
if cappedWidth > wsize.width() or cappedHeight > wsize.height():
widget.resize(QSize(cappedWidth, cappedHeight))
# ensure widget is inside top left
wpos = widget.pos()
x = max(geom.x(), wpos.x())
y = max(geom.y(), wpos.y())
# and bottom right
2019-12-23 01:34:10 +01:00
x = min(x, geom.width() + geom.x() - cappedWidth)
y = min(y, geom.height() + geom.y() - cappedHeight)
if x != wpos.x() or y != wpos.y():
widget.move(x, y)
2019-12-23 01:34:10 +01:00
def saveState(widget, key):
key += "State"
aqt.mw.pm.profile[key] = widget.saveState()
2019-12-23 01:34:10 +01:00
def restoreState(widget, key):
key += "State"
if aqt.mw.pm.profile.get(key):
widget.restoreState(aqt.mw.pm.profile[key])
2019-12-23 01:34:10 +01:00
def saveSplitter(widget, key):
key += "Splitter"
aqt.mw.pm.profile[key] = widget.saveState()
2019-12-23 01:34:10 +01:00
def restoreSplitter(widget, key):
key += "Splitter"
if aqt.mw.pm.profile.get(key):
widget.restoreState(aqt.mw.pm.profile[key])
2019-12-23 01:34:10 +01:00
def saveHeader(widget, key):
key += "Header"
aqt.mw.pm.profile[key] = widget.saveState()
2019-12-23 01:34:10 +01:00
def restoreHeader(widget, key):
key += "Header"
if aqt.mw.pm.profile.get(key):
widget.restoreState(aqt.mw.pm.profile[key])
2019-12-23 01:34:10 +01:00
def mungeQA(col, txt):
print("mungeQA() deprecated; use mw.prepare_card_text_for_display()")
txt = col.media.escapeImages(txt)
return txt
2019-12-23 01:34:10 +01:00
def openFolder(path):
if isWin:
2019-12-23 01:34:10 +01:00
subprocess.Popen(["explorer", "file://" + path])
else:
with noBundledLibs():
QDesktopServices.openUrl(QUrl("file://" + path))
2019-12-23 01:34:10 +01:00
def shortcut(key):
if isMac:
return re.sub("(?i)ctrl", "Command", key)
return key
2019-12-23 01:34:10 +01:00
def maybeHideClose(bbox):
if isMac:
b = bbox.button(QDialogButtonBox.Close)
if b:
bbox.removeButton(b)
2019-12-23 01:34:10 +01:00
def addCloseShortcut(widg):
if not isMac:
return
widg._closeShortcut = QShortcut(QKeySequence("Ctrl+W"), widg)
qconnect(widg._closeShortcut.activated, widg.reject)
2019-12-23 01:34:10 +01:00
def downArrow():
if isWin:
return ""
# windows 10 is lacking the smaller arrow on English installs
return ""
2019-12-23 01:34:10 +01:00
# Tooltips
######################################################################
2019-12-20 06:07:40 +01:00
_tooltipTimer: Optional[QTimer] = None
2019-12-20 08:55:19 +01:00
_tooltipLabel: Optional[QLabel] = None
2019-12-23 01:34:10 +01:00
def tooltip(msg, period=3000, parent=None, x_offset=0, y_offset=100):
global _tooltipTimer, _tooltipLabel
2019-12-23 01:34:10 +01:00
class CustomLabel(QLabel):
silentlyClose = True
2019-12-23 01:34:10 +01:00
def mousePressEvent(self, evt):
evt.accept()
self.hide()
2019-12-23 01:34:10 +01:00
closeTooltip()
aw = parent or aqt.mw.app.activeWindow() or aqt.mw
2019-12-23 01:34:10 +01:00
lab = CustomLabel(
"""\
<table cellpadding=10>
<tr>
<td>%s</td>
</tr>
2019-12-23 01:34:10 +01:00
</table>"""
% msg,
aw,
)
lab.setFrameStyle(QFrame.Panel)
lab.setLineWidth(2)
lab.setWindowFlags(Qt.ToolTip)
2020-01-23 22:55:14 +01:00
if not theme_manager.night_mode:
p = QPalette()
p.setColor(QPalette.Window, QColor("#feffc4"))
p.setColor(QPalette.WindowText, QColor("#000000"))
lab.setPalette(p)
lab.move(aw.mapToGlobal(QPoint(0 + x_offset, aw.height() - y_offset)))
lab.show()
_tooltipTimer = aqt.mw.progress.timer(
2019-12-23 01:34:10 +01:00
period, closeTooltip, False, requiresCollection=False
)
_tooltipLabel = lab
2019-12-23 01:34:10 +01:00
def closeTooltip():
global _tooltipLabel, _tooltipTimer
if _tooltipLabel:
try:
_tooltipLabel.deleteLater()
except:
# already deleted as parent window closed
pass
_tooltipLabel = None
if _tooltipTimer:
_tooltipTimer.stop()
_tooltipTimer = None
2019-12-23 01:34:10 +01:00
# true if invalid; print warning
def checkInvalidFilename(str, dirsep=True):
bad = invalidFilename(str, dirsep)
if bad:
2019-12-23 01:34:10 +01:00
showWarning(_("The following character can not be used: %s") % bad)
return True
return False
2019-12-23 01:34:10 +01:00
# Menus
######################################################################
2019-12-23 01:34:10 +01:00
class MenuList:
def __init__(self):
self.children = []
def addItem(self, title, func):
item = MenuItem(title, func)
self.children.append(item)
return item
def addSeparator(self):
self.children.append(None)
def addMenu(self, title):
submenu = SubMenu(title)
self.children.append(submenu)
return submenu
def addChild(self, child):
self.children.append(child)
def renderTo(self, qmenu):
for child in self.children:
if child is None:
qmenu.addSeparator()
elif isinstance(child, QAction):
qmenu.addAction(child)
else:
child.renderTo(qmenu)
def popupOver(self, widget):
qmenu = QMenu()
self.renderTo(qmenu)
2019-12-23 01:34:10 +01:00
qmenu.exec_(widget.mapToGlobal(QPoint(0, 0)))
# Chunking
######################################################################
chunkSize = 30
def chunked(self):
if len(self.children) <= self.chunkSize:
return self
newList = MenuList()
oldItems = self.children[:]
while oldItems:
2019-12-23 01:34:10 +01:00
chunk = oldItems[: self.chunkSize]
del oldItems[: self.chunkSize]
label = self._chunkLabel(chunk)
menu = newList.addMenu(label)
menu.children = chunk
return newList
def _chunkLabel(self, items):
start = items[0].title
end = items[-1].title
prefix = os.path.commonprefix([start.upper(), end.upper()])
2019-12-23 01:34:10 +01:00
n = len(prefix) + 1
return "{}-{}".format(start[:n].upper(), end[:n].upper())
2019-12-23 01:34:10 +01:00
class SubMenu(MenuList):
def __init__(self, title):
super().__init__()
self.title = title
def renderTo(self, menu):
submenu = menu.addMenu(self.title)
super().renderTo(submenu)
2019-12-23 01:34:10 +01:00
class MenuItem:
def __init__(self, title, func):
self.title = title
self.func = func
def renderTo(self, qmenu):
a = qmenu.addAction(self.title)
qconnect(a.triggered, self.func)
2019-12-23 01:34:10 +01:00
def qtMenuShortcutWorkaround(qmenu):
if qtminor < 10:
return
for act in qmenu.actions():
act.setShortcutVisibleInContextMenu(True)
2019-12-23 01:34:10 +01:00
2018-12-13 11:59:06 +01:00
######################################################################
2019-12-23 01:34:10 +01:00
def supportText():
import platform
2020-02-03 02:17:10 +01:00
import time
from aqt import mw
if isWin:
platname = "Windows " + platform.win32_ver()[0]
elif isMac:
platname = "Mac " + platform.mac_ver()[0]
else:
platname = "Linux"
def schedVer():
try:
return mw.col.schedVer()
except:
return "?"
2020-02-03 02:17:10 +01:00
lc = mw.pm.last_addon_update_check()
lcfmt = time.strftime("%Y-%m-%d %H:%M:%S", time.localtime(lc))
return """\
Anki {} Python {} Qt {} PyQt {}
Platform: {}
Flags: frz={} ao={} sv={}
2020-02-03 02:17:10 +01:00
Add-ons, last update check: {}
2019-12-23 01:34:10 +01:00
""".format(
versionWithBuild(),
platform.python_version(),
QT_VERSION_STR,
PYQT_VERSION_STR,
platname,
getattr(sys, "frozen", False),
mw.addonManager.dirty,
schedVer(),
2020-02-03 02:17:10 +01:00
lcfmt,
2019-12-23 01:34:10 +01:00
)
2018-12-18 10:29:34 +01:00
######################################################################
# adapted from version detection in qutebrowser
def opengl_vendor():
old_context = QOpenGLContext.currentContext()
old_surface = None if old_context is None else old_context.surface()
surface = QOffscreenSurface()
surface.create()
ctx = QOpenGLContext()
ok = ctx.create()
if not ok:
return None
ok = ctx.makeCurrent(surface)
if not ok:
return None
try:
if ctx.isOpenGLES():
# Can't use versionFunctions there
return None
vp = QOpenGLVersionProfile()
vp.setVersion(2, 0)
try:
vf = ctx.versionFunctions(vp)
except ImportError as e:
return None
if vf is None:
return None
return vf.glGetString(vf.GL_VENDOR)
finally:
ctx.doneCurrent()
if old_context and old_surface:
old_context.makeCurrent(old_surface)
2019-12-23 01:34:10 +01:00
2018-12-18 10:29:34 +01:00
def gfxDriverIsBroken():
driver = opengl_vendor()
return driver == "nouveau"
######################################################################
def startup_info() -> Any:
"Use subprocess.Popen(startupinfo=...) to avoid opening a console window."
if not sys.platform == "win32":
return None
si = subprocess.STARTUPINFO() # pytype: disable=module-attr
si.dwFlags |= subprocess.STARTF_USESHOWWINDOW # pytype: disable=module-attr
return si