eric: comparison UI/UserInterface.py

-:77189681b787
+:51eefa621de4
 # -*- coding: utf-8 -*-
-# Copyright (c) 2002 - 2018 Detlev Offenbach <detlev@die-offenbachs.de>
+# Copyright (c) 2002 - 2019 Detlev Offenbach <detlev@die-offenbachs.de>
 #
 """
 Module implementing the main user interface.
 """
 import sys
 import logging
 from PyQt5.QtCore import pyqtSlot, QTimer, QFile, QFileInfo, pyqtSignal, \
 PYQT_VERSION_STR, QDate, QIODevice, qVersion, QProcess, QSize, QUrl, \
-QObject, Qt
+QObject, Qt, QUuid, QThread
 from PyQt5.QtGui import QKeySequence, QDesktopServices
 from PyQt5.QtWidgets import QSizePolicy, QWidget, QWhatsThis, QToolBar, \
 QDialog, QSplitter, QApplication, QMenu, QVBoxLayout, QDockWidget, \
 QAction, QLabel
 from PyQt5.Qsci import QSCINTILLA_VERSION_STR
 from PyQt5.QtNetwork import QNetworkProxyFactory, QNetworkAccessManager, \
 QNetworkRequest, QNetworkReply
-from Globals import qVersionTuple
-try:
-from PyQt5 import QtWebKit      # __IGNORE_WARNING__
-WEBKIT_AVAILABLE = True
-except ImportError:
-WEBKIT_AVAILABLE = False
-if qVersionTuple() < (5, 6, 0):
-WEBENGINE_AVAILABLE = False
-else:
-try:
-from PyQt5 import QtWebEngineWidgets    # __IGNORE_WARNING__
-WEBENGINE_AVAILABLE = True
-except ImportError:
-WEBENGINE_AVAILABLE = False
 from .Info import Version, VersionOnly, BugAddress, Program, FeatureAddress
 from . import Config
 from E5Gui.E5SingleApplication import E5SingleApplicationServer
 SSL_AVAILABLE = True
 except ImportError:
 SSL_AVAILABLE = False
 from eric6config import getConfig
+from Globals import qVersionTuple
 class Redirector(QObject):
 """
 Helper class used to redirect stdout and stderr to the log window.
 self.irc = None
 self.symbolsViewer = None
 self.browser = None
 self.templateViewer = None
 self.numbersViewer = None
+self.__webBrowserProcess = None
+self.__webBrowserClient = None
+self.__webBrowserSAName = QUuid.createUuid().toString()[1:-1]
 # Create the main window now so that we can connect QActions to it.
 logging.debug("Creating Layout...")
 self.__createLayout(debugServer)
 self.__currentRightWidget = None
 splash.showMessage(self.tr("Initializing Tools..."))
 self.toolGroups, self.currentToolGroup = Preferences.readToolGroups()
 self.toolProcs = []
 self.__initExternalToolsActions()
-# create a dummy help window for shortcuts handling
-if WEBENGINE_AVAILABLE:
-from WebBrowser.WebBrowserWindow import WebBrowserWindow
-self.dummyHelpViewer = \
-WebBrowserWindow(None, '.', None, 'web_browser', True, True)
-elif WEBKIT_AVAILABLE:
-from Helpviewer.HelpWindow import HelpWindow
-self.dummyHelpViewer = \
-HelpWindow(None, '.', None, 'help viewer', True, True)
-else:
-self.dummyHelpViewer = None
 # redirect handling of http and https URLs to ourselves
-if WEBENGINE_AVAILABLE or WEBKIT_AVAILABLE:
+QDesktopServices.setUrlHandler("http", self.handleUrl)
-QDesktopServices.setUrlHandler("http", self.handleUrl)
+QDesktopServices.setUrlHandler("https", self.handleUrl)
-QDesktopServices.setUrlHandler("https", self.handleUrl)
 # register all relevant objects
 splash.showMessage(self.tr("Registering Objects..."))
 e5App().registerObject("UserInterface", self)
 e5App().registerObject("DebugUI", self.debuggerUI)
 e5App().registerObject("MultiProject", self.multiProject)
 e5App().registerObject("TaskViewer", self.taskViewer)
 if self.templateViewer is not None:
 e5App().registerObject("TemplateViewer", self.templateViewer)
 e5App().registerObject("Shell", self.shell)
-if self.dummyHelpViewer is not None:
-e5App().registerObject("DummyHelpViewer", self.dummyHelpViewer)
 e5App().registerObject("PluginManager", self.pluginManager)
 e5App().registerObject("ToolbarManager", self.toolbarManager)
 if self.cooperation is not None:
 e5App().registerObject("Cooperation", self.cooperation)
 if self.irc is not None:
 proxyAuthenticationRequired)
 if SSL_AVAILABLE:
 self.__sslErrorHandler = E5SslErrorHandler(self)
 self.__networkManager.sslErrors.connect(self.__sslErrors)
 self.__replies = []
-# attribute for the help window
-self.helpWindow = None
 # set spellchecker defaults
 from QScintilla.SpellChecker import SpellChecker
 SpellChecker.setDefaultLanguage(
 Preferences.getEditor("SpellCheckingDefaultLanguage"))
 """ context help button in the titlebar.</p>"""
 ))
 self.whatsThisAct.triggered.connect(self.__whatsThis)
 self.actions.append(self.whatsThisAct)
-if WEBENGINE_AVAILABLE or WEBKIT_AVAILABLE:
+self.helpviewerAct = E5Action(
-self.helpviewerAct = E5Action(
+self.tr('Helpviewer'),
-self.tr('Helpviewer'),
+UI.PixmapCache.getIcon("help.png"),
-UI.PixmapCache.getIcon("help.png"),
+self.tr('&Helpviewer...'),
-self.tr('&Helpviewer...'),
+QKeySequence(self.tr("F1")),
-QKeySequence(self.tr("F1")),
+0, self, 'helpviewer')
-0, self, 'helpviewer')
+self.helpviewerAct.setStatusTip(self.tr(
-self.helpviewerAct.setStatusTip(self.tr(
+'Open the helpviewer window'))
-'Open the helpviewer window'))
+self.helpviewerAct.setWhatsThis(self.tr(
-self.helpviewerAct.setWhatsThis(self.tr(
+"""<b>Helpviewer</b>"""
-"""<b>Helpviewer</b>"""
+"""<p>Display the eric6 web browser. This window will show"""
-"""<p>Display the eric6 web browser. This window will show"""
+""" HTML help files and help from Qt help collections. It"""
-""" HTML help files and help from Qt help collections. It"""
+""" has the capability to navigate to links, set bookmarks,"""
-""" has the capability to navigate to links, set bookmarks,"""
+""" print the displayed help and some more features. You may"""
-""" print the displayed help and some more features. You may"""
+""" use it to browse the internet as well</p><p>If called"""
-""" use it to browse the internet as well</p><p>If called"""
+""" with a word selected, this word is search in the Qt help"""
-""" with a word selected, this word is search in the Qt help"""
+""" collection.</p>"""
-""" collection.</p>"""
+))
-))
+self.helpviewerAct.triggered.connect(self.__helpViewer)
-self.helpviewerAct.triggered.connect(self.__helpViewer)
+self.actions.append(self.helpviewerAct)
-self.actions.append(self.helpviewerAct)
+##        else:
-else:
+##            self.helpviewerAct = None
-self.helpviewerAct = None
 self.__initQtDocActions()
 self.__initPythonDocActions()
 self.__initEricDocAction()
 self.__initPySideDocActions()
 """ binary files.</p>"""
 ))
 self.hexEditorAct.triggered.connect(self.__openHexEditor)
 self.actions.append(self.hexEditorAct)
-if WEBENGINE_AVAILABLE or WEBKIT_AVAILABLE:
+self.webBrowserAct = E5Action(
-self.webBrowserAct = E5Action(
+self.tr('eric6 Web Browser'),
-self.tr('eric6 Web Browser'),
+UI.PixmapCache.getIcon("ericWeb.png"),
-UI.PixmapCache.getIcon("ericWeb.png"),
+self.tr('eric6 &Web Browser...'),
-self.tr('eric6 &Web Browser...'),
+0, 0, self, 'web_browser')
-0, 0, self, 'web_browser')
+self.webBrowserAct.setStatusTip(self.tr(
-self.webBrowserAct.setStatusTip(self.tr(
+'Start the eric6 Web Browser'))
-'Start the eric6 Web Browser'))
+self.webBrowserAct.setWhatsThis(self.tr(
-self.webBrowserAct.setWhatsThis(self.tr(
+"""<b>eric6 Web Browser</b>"""
-"""<b>eric6 Web Browser</b>"""
+"""<p>Browse the Internet with the eric6 Web Browser.</p>"""
-"""<p>Browse the Internet with the eric6 Web Browser.</p>"""
+))
-))
+self.webBrowserAct.triggered.connect(self.__startWebBrowser)
-self.webBrowserAct.triggered.connect(self.__startWebBrowser)
+self.actions.append(self.webBrowserAct)
-self.actions.append(self.webBrowserAct)
+##        else:
-else:
+##            self.webBrowserAct = None
-self.webBrowserAct = None
 self.iconEditorAct = E5Action(
 self.tr('Icon Editor'),
 UI.PixmapCache.getIcon("iconEditor.png"),
 self.tr('&Icon Editor...'),
 .format(PYQT_VERSION_STR)
 versionText += """<tr><td><b>sip</b></td><td>{0}</td></tr>"""\
 .format(sip_version_str)
 versionText += """<tr><td><b>QScintilla</b></td><td>{0}</td></tr>"""\
 .format(QSCINTILLA_VERSION_STR)
-if WEBENGINE_AVAILABLE:
+try:
 from WebBrowser.Tools import WebBrowserTools
 chromeVersion = WebBrowserTools.getWebEngineVersions()[0]
 versionText += \
 """<tr><td><b>WebEngine</b></td><td>{0}</td></tr>"""\
 .format(chromeVersion)
-if WEBKIT_AVAILABLE:
+except ImportError:
+pass
+try:
 from PyQt5.QtWebKit import qWebKitVersion
 versionText += """<tr><td><b>WebKit</b></td><td>{0}</td></tr>"""\
 .format(qWebKitVersion())
+except ImportError:
+pass
 versionText += """<tr><td><b>{0}</b></td><td>{1}</td></tr>"""\
 .format(Program, Version)
 versionText += self.tr("""</table>""")
 E5MessageBox.about(self, Program, versionText)
 home = pythonDocDir
 if home.endswith(".chm"):
 self.__chmViewer(home)
 else:
-if WEBENGINE_AVAILABLE:
+hvType = Preferences.getWebBrowser("HelpViewerType")
-hvType = Preferences.getWebBrowser("HelpViewerType")
-else:
-hvType = Preferences.getHelp("HelpViewerType")
 if hvType == 1:
 self.launchHelpViewer(home)
 elif hvType == 2:
 if home.startswith("qthelp://"):
 self.__assistant(home, version=4)
 home = pythonDocDir
 if home.endswith(".chm"):
 self.__chmViewer(home)
 else:
-if WEBENGINE_AVAILABLE:
+hvType = Preferences.getWebBrowser("HelpViewerType")
-hvType = Preferences.getWebBrowser("HelpViewerType")
-else:
-hvType = Preferences.getHelp("HelpViewerType")
 if hvType == 1:
 self.launchHelpViewer(home)
 elif hvType == 2:
 if home.startswith("qthelp://"):
 self.__assistant(home, version=4)
 if Utilities.isWindowsPlatform():
 home = "file:///" + Utilities.fromNativeSeparators(home)
 else:
 home = "file://" + home
-if WEBENGINE_AVAILABLE:
+hvType = Preferences.getWebBrowser("HelpViewerType")
-hvType = Preferences.getWebBrowser("HelpViewerType")
-else:
-hvType = Preferences.getHelp("HelpViewerType")
 if hvType == 1:
 self.launchHelpViewer(home)
 elif hvType == 2:
 if home.startswith("qthelp://"):
 self.__assistant(home, version=4)
 else:
 home = "file://" + home
 else:
 home = pyqt4DocDir
-if WEBENGINE_AVAILABLE:
+hvType = Preferences.getWebBrowser("HelpViewerType")
-hvType = Preferences.getWebBrowser("HelpViewerType")
-else:
-hvType = Preferences.getHelp("HelpViewerType")
 if hvType == 1:
 self.launchHelpViewer(home)
 elif hvType == 2:
 if home.startswith("qthelp://"):
 self.__assistant(home, version=4)
 else:
 home = "file://" + home
 else:
 home = pyqt5DocDir
-if WEBENGINE_AVAILABLE:
+hvType = Preferences.getWebBrowser("HelpViewerType")
-hvType = Preferences.getWebBrowser("HelpViewerType")
-else:
-hvType = Preferences.getHelp("HelpViewerType")
 if hvType == 1:
 self.launchHelpViewer(home)
 elif hvType == 2:
 if home.startswith("qthelp://"):
 self.__assistant(home, version=4)
 if Utilities.isWindowsPlatform():
 home = "file:///" + Utilities.fromNativeSeparators(home)
 else:
 home = "file://" + home
-if WEBENGINE_AVAILABLE:
+hvType = Preferences.getWebBrowser("HelpViewerType")
-hvType = Preferences.getWebBrowser("HelpViewerType")
-else:
-hvType = Preferences.getHelp("HelpViewerType")
 if hvType == 1:
 self.launchHelpViewer(home)
 elif hvType == 2:
 if home.startswith("qthelp://"):
 self.__assistant(home, version=4)
 else:
 home = "file://" + home
 else:
 home = pysideDocDir
-if WEBENGINE_AVAILABLE:
+hvType = Preferences.getWebBrowser("HelpViewerType")
-hvType = Preferences.getWebBrowser("HelpViewerType")
-else:
-hvType = Preferences.getHelp("HelpViewerType")
 if hvType == 1:
 self.launchHelpViewer(home)
 elif hvType == 2:
 if home.startswith("qthelp://"):
 self.__assistant(home, version=4)
 if len(home) > 0:
 homeUrl = QUrl(home)
 if not homeUrl.scheme():
 home = QUrl.fromLocalFile(home).toString()
-if WEBENGINE_AVAILABLE or WEBKIT_AVAILABLE:
+launchResult = self.__launchExternalWebBrowser(
-single = useSingle
+home, searchWord=searchWord)
-if WEBENGINE_AVAILABLE:
+if not launchResult:
-single = single or \
+self.__webBrowser(home)
-Preferences.getWebBrowser("SingleWebBrowserWindow")
-elif WEBKIT_AVAILABLE:
+def __launchExternalWebBrowser(self, home, searchWord=None):
-single = single or Preferences.getHelp("SingleHelpWindow")
+"""
-if not single or self.helpWindow is None:
+Private method to start an external web browser and communicate with
-if WEBENGINE_AVAILABLE:
+it.
-from WebBrowser.WebBrowserWindow import WebBrowserWindow
-browser = WebBrowserWindow(home, '.', None, 'web_browser',
+@param home filename of file to be shown or URL to be opened
-True, searchWord=searchWord)
+@type str
-elif WEBKIT_AVAILABLE:
+@keyparam searchWord word to search for
-from Helpviewer.HelpWindow import HelpWindow
+@type str
-browser = HelpWindow(home, '.', None, 'help viewer', True,
+@return flag indicating a successful launch
-searchWord=searchWord)
+@rtype bool
+"""
-if QApplication.desktop().width() > 400 and \
+clientArgs = []
-QApplication.desktop().height() > 500:
+if searchWord:
-browser.show()
+clientArgs.append("--search={0}".format(searchWord))
-else:
-browser.showMaximized()
+if self.__webBrowserProcess is None:
+webBrowsers = [
+os.path.join(
+os.path.dirname(__file__), "..", "eric6_browser.py"),
+# QtWebEngine based web browser
+os.path.join(
+os.path.dirname(__file__), "..", "eric6_webbrowser.py"),
+# QtWebKit based web browser
+]
+process = QProcess()
+for browser in webBrowsers:
+args = [
+browser,
+"--quiet",
+"--qthelp",
+"--single",
+"--name={0}".format(self.__webBrowserSAName)
+]
+process.start(sys.executable, args)
+if not process.waitForStarted():
+E5MessageBox.warning(
+self,
+self.tr("Start Web Browser"),
+self.tr("""The eric6 web browser could not be"""
+""" started."""))
+return False
-if single:
+res = self.__connectToWebBrowser(process)
-self.helpWindow = browser
+if res == 1:
-try:
+# connection unsuccessful
-self.helpWindow.webBrowserWindowClosed.connect(
+return False
-self.__helpClosed)
+elif res == 0:
-except AttributeError:
+# successful
-self.helpWindow.helpClosed.connect(self.__helpClosed)
+break
-self.preferencesChanged.connect(
-self.helpWindow.preferencesChanged)
-self.masterPasswordChanged.connect(
-self.helpWindow.masterPasswordChanged)
-elif searchWord is not None:
-self.helpWindow.search(searchWord)
-self.helpWindow.raise_()
 else:
-self.helpWindow.newTab(home)
+return False
-self.helpWindow.raise_()
+process.finished.connect(self.__webBrowserFinished)
+self.__webBrowserProcess = process
+if home:
+clientArgs.append(home)
 else:
-self.__webBrowser(home)
+clientArgs.append("--newtab={0}".format(home))
-def __helpClosed(self):
+if clientArgs:
-"""
+self.__webBrowserClient.processArgs(clientArgs, disconnect=False)
-Private slot to handle the helpClosed signal of the help window.
-"""
+return True
-if WEBENGINE_AVAILABLE:
-single = Preferences.getWebBrowser("SingleWebBrowserWindow")
+def __connectToWebBrowser(self, process):
-elif WEBKIT_AVAILABLE:
+"""
-single = Preferences.getHelp("SingleHelpWindow")
+Private method to connect to a started web browser.
-if single:
-self.preferencesChanged.disconnect(
+@param process reference to the started web browser process
-self.helpWindow.preferencesChanged)
+@type QProcess
-self.masterPasswordChanged.disconnect(
+@return error indication (1 = connection not possible, 0 = ok,
-self.helpWindow.masterPasswordChanged)
+-1 = server exited with an error code)
-self.helpWindow = None
+@rtype int
+"""
+from WebBrowser.WebBrowserSingleApplication import \
+WebBrowserSingleApplicationClient
+webBrowserClient = WebBrowserSingleApplicationClient(
+self.__webBrowserSAName)
+connectCount = 30
+while connectCount:
+res = webBrowserClient.connect()
+if res != 0:
+break
+else:
+connectCount -= 1
+QThread.msleep(1000)
+QApplication.processEvents()
+if process.state() == QProcess.NotRunning and \
+process.exitStatus() == QProcess.NormalExit and \
+process.exitCode() == 100:
+# Process exited prematurely due to missing pre-requisites
+return -1
+if res <= 0:
+E5MessageBox.warning(
+self,
+self.tr("Start Web Browser"),
+self.tr("""<p>The eric6 web browser is not started.</p>"""
+"""<p>Reason: {0}</p>""").format(
+webBrowserClient.errstr())
+)
+return 1
+self.__webBrowserClient = webBrowserClient
+return 0
+def __webBrowserFinished(self):
+"""
+Private slot handling the end of the external web browser process.
+"""
+self.__webBrowserProcess.deleteLater()
+self.__webBrowserProcess = None
+self.__webBrowserClient = None
+def __webBrowserShutdown(self):
+"""
+Private method to shut down the web browser.
+"""
+self.__webBrowserClient.processArgs(["--shutdown"], disconnect=False)
 def __helpViewer(self):
 """
 Private slot to start an empty help viewer/web browser.
 """
 E5MessageBox.critical(
 self,
 self.tr('Open Browser'),
 self.tr('Could not start a web browser'))
-def getHelpViewer(self, preview=False):
-"""
-Public method to get a reference to the help window instance.
-@keyparam preview flag indicating to get a help window for preview
-(boolean)
-@return reference to the help window instance (HelpWindow)
-"""
-if WEBENGINE_AVAILABLE or WEBKIT_AVAILABLE:
-if self.helpWindow is None:
-self.launchHelpViewer("", useSingle=True)
-self.helpWindow.raise_()
-return self.helpWindow
-else:
-return None
 @pyqtSlot()
 @pyqtSlot(str)
 def showPreferences(self, pageName=None):
 """
 Public slot to set the preferences.
 """
 from Preferences.ConfigurationDialog import ConfigurationDialog
 dlg = ConfigurationDialog(
 self, 'Configuration',
 expandedEntries=self.__expandedConfigurationEntries,
-webEngine=WEBENGINE_AVAILABLE,
 )
 dlg.preferencesChanged.connect(self.__preferencesChanged)
 dlg.masterPasswordChanged.connect(self.__masterPasswordChanged)
 dlg.show()
 if pageName is not None:
 Private slot to handle the change of the master password.
 @param oldPassword current master password (string)
 @param newPassword new master password (string)
 """
+import Globals
 self.masterPasswordChanged.emit(oldPassword, newPassword)
 Preferences.convertPasswords(oldPassword, newPassword)
-if self.helpWindow is None:
+variant = Globals.getWebBrowserSupport()
-if WEBENGINE_AVAILABLE:
+if variant == "QtWebEngine":
 from WebBrowser.Passwords.PasswordManager import \
 PasswordManager
 pwManager = PasswordManager()
 pwManager.masterPasswordChanged(oldPassword, newPassword)
-elif WEBKIT_AVAILABLE:
+elif variant == "QtWebKit":
 from Helpviewer.Passwords.PasswordManager import \
 PasswordManager
 pwManager = PasswordManager()
 pwManager.masterPasswordChanged(oldPassword, newPassword)
 Utilities.crypto.changeRememberedMaster(newPassword)
 def __reloadAPIs(self):
 """
 Private slot to reload the api information.
 """
 Private slot to configure the keyboard shortcuts.
 """
 if self.shortcutsDialog is None:
 from Preferences.ShortcutsDialog import ShortcutsDialog
-self.shortcutsDialog = ShortcutsDialog(self, 'Shortcuts')
+self.shortcutsDialog = ShortcutsDialog(self)
 self.shortcutsDialog.populate()
 self.shortcutsDialog.show()
 def __exportShortcuts(self):
 """
 @return flag indicating success
 """
 if self.shutdownCalled:
 return True
-if self.helpWindow is not None:
+if self.__webBrowserProcess is not None:
-if not self.helpWindow.shutdown():
+self.__webBrowserShutdown()
-return False
 if self.irc is not None:
 if not self.irc.shutdown():
 return False

Mercurial Repositories > eric / file comparison

comparison: UI/UserInterface.py

UI/UserInterface.py