Mercurial > octave
view libgui/src/octave-qobject.cc @ 29544:4eeef8cdaa2c
Backout changes to octave-qobject.cc in cset 3d34b70b5a49 (bug #60420)
* octave-qobject.cc: Reverse changes in cset 3d34b70b5a49.
author | Rik <rik@octave.org> |
---|---|
date | Tue, 20 Apr 2021 09:53:31 -0700 |
parents | 3d34b70b5a49 |
children | f6ad83cbe3c4 |
line wrap: on
line source
//////////////////////////////////////////////////////////////////////// // // Copyright (C) 2011-2021 The Octave Project Developers // // See the file COPYRIGHT.md in the top-level directory of this // distribution or <https://octave.org/copyright/>. // // This file is part of Octave. // // Octave 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. // // Octave 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 Octave; see the file COPYING. If not, see // <https://www.gnu.org/licenses/>. // //////////////////////////////////////////////////////////////////////// #if defined (HAVE_CONFIG_H) # include "config.h" #endif #include <utility> #include <QApplication> #include <QClipboard> #include <QFile> #include <QTextCodec> #include <QThread> #include <QTimer> #include <QTranslator> #include "interpreter-qobject.h" #include "main-window.h" #include "octave-qobject.h" #include "qt-application.h" #include "qt-interpreter-events.h" #include "resource-manager.h" #include "shortcut-manager.h" // Bug #55940 (Disable App Nap on Mac) #if defined (Q_OS_MAC) # include <objc/runtime.h> # include <objc/message.h> #endif #include "interpreter.h" #include "oct-env.h" #include "version.h" #include "ovl.h" // Bug #55940 (Disable App Nap on Mac) #if defined (Q_OS_MAC) static void disable_app_nap (void) { Class process_info_class; SEL process_info_selector; SEL begin_activity_with_options_selector; id process_info; id reason_string; id osx_latencycritical_activity; // Option codes found at https://stackoverflow.com/questions/22784886/what-can-make-nanosleep-drift-with-exactly-10-sec-on-mac-os-x-10-9/32729281#32729281 unsigned long long NSActivityUserInitiatedAllowingIdleSystemSleep = 0x00FFFFFFULL; unsigned long long NSActivityLatencyCritical = 0xFF00000000ULL; // Avoid errors on older versions of OS X process_info_class = static_cast<Class> (objc_getClass ("NSProcessInfo")); if (process_info_class == nil) return; process_info_selector = sel_getUid ("processInfo"); if (class_getClassMethod (process_info_class, process_info_selector) == nullptr) return; begin_activity_with_options_selector = sel_getUid ("beginActivityWithOptions:reason:"); if (class_getInstanceMethod (process_info_class, begin_activity_with_options_selector) == nullptr) return; process_info = reinterpret_cast<id (*) (id, SEL)> (objc_msgSend) (reinterpret_cast<id> (process_info_class), process_info_selector); if (process_info == nil) return; reason_string = reinterpret_cast<id (*) (id, SEL)> (objc_msgSend) (reinterpret_cast<id> (objc_getClass ("NSString")), sel_getUid ("alloc")); reason_string = reinterpret_cast<id (*) (id, SEL, const char *)> (objc_msgSend) (reason_string, sel_getUid ("initWithUTF8String:"), "App Nap causes pause() malfunction"); // Start an Activity that suppresses App Nap. This Activity will run for // the entire duration of the Octave process. This is intentional, // not a leak. osx_latencycritical_activity = reinterpret_cast<id (*) (id, SEL, unsigned long long, id)> (objc_msgSend) (process_info, begin_activity_with_options_selector, NSActivityUserInitiatedAllowingIdleSystemSleep | NSActivityLatencyCritical, reason_string); } #endif namespace octave { // Disable all Qt messages by default. static void message_handler (QtMsgType, const QMessageLogContext &, const QString &) { } //! Reimplement QApplication::notify. Octave's own exceptions are //! caught and rethrown in the interpreter thread. bool octave_qapplication::notify (QObject *receiver, QEvent *ev) { try { return QApplication::notify (receiver, ev); } catch (execution_exception& ee) { emit interpreter_event ([=] (void) { // INTERPRETER THREAD throw ee; }); } return false; } // We will create a QApplication object, even if START_GUI is false, // so that we can use Qt widgets for plot windows when running in // command-line mode. Note that we are creating an // octave_qapplication object but handling it as a QApplication object // because the octave_qapplication should behave identically to a // QApplication object except that it overrides the notify method so // we can handle forward Octave interpreter exceptions from the GUI // thread to the interpreter thread. base_qobject::base_qobject (qt_application& app_context, bool gui_app) : QObject (), m_app_context (app_context), m_argc (m_app_context.sys_argc ()), m_argv (m_app_context.sys_argv ()), m_qapplication (new octave_qapplication (m_argc, m_argv)), m_resource_manager (), m_shortcut_manager (*this), m_workspace_model (new workspace_model (*this)), m_qt_tr (new QTranslator ()), m_gui_tr (new QTranslator ()), m_qsci_tr (new QTranslator ()), m_translators_installed (false), m_qt_interpreter_events (new qt_interpreter_events (*this)), m_interpreter_qobj (new interpreter_qobject (*this)), m_main_thread (new QThread ()), m_gui_app (gui_app), m_interpreter_ready (false), m_main_window (nullptr) { std::string show_gui_msgs = sys::env::getenv ("OCTAVE_SHOW_GUI_MESSAGES"); // Installing our handler suppresses the messages. if (show_gui_msgs.empty ()) { qInstallMessageHandler (message_handler); } // Set the codec for all strings (before wizard or any GUI object) #if ! defined (Q_OS_WIN32) QTextCodec::setCodecForLocale (QTextCodec::codecForName ("UTF-8")); #endif // Initialize global Qt application metadata. QCoreApplication::setApplicationName ("GNU Octave"); QCoreApplication::setApplicationVersion (OCTAVE_VERSION); // Register octave_value_list for connecting thread crossing signals. qRegisterMetaType<octave_value_list> ("octave_value_list"); // Bug #55940 (Disable App Nap on Mac) #if defined (Q_OS_MAC) // Mac App Nap feature causes pause() and sleep() to misbehave. // Disable it for the entire program run. disable_app_nap (); #endif // Force left-to-right alignment (see bug #46204) m_qapplication->setLayoutDirection (Qt::LeftToRight); if (! m_app_context.experimental_terminal_widget ()) { connect (m_interpreter_qobj, SIGNAL (execution_finished (int)), this, SLOT (handle_interpreter_execution_finished (int))); connect (this, SIGNAL (request_interpreter_shutdown (int)), m_interpreter_qobj, SLOT (shutdown (int))); } connect (m_interpreter_qobj, SIGNAL (shutdown_finished (int)), this, SLOT (handle_interpreter_shutdown_finished (int))); connect (m_main_thread, SIGNAL (finished (void)), m_main_thread, SLOT (deleteLater (void))); // Handle any interpreter_event signal from the octave_qapplication // object here. connect (m_qapplication, SIGNAL (interpreter_event (const fcn_callback&)), this, SLOT (interpreter_event (const fcn_callback&))); connect (m_qapplication, SIGNAL (interpreter_event (const meth_callback&)), this, SLOT (interpreter_event (const meth_callback&))); if (m_app_context.experimental_terminal_widget ()) { connect (qt_link (), SIGNAL (start_gui_signal (bool)), this, SLOT (start_gui (bool))); } connect (qt_link (), SIGNAL (copy_image_to_clipboard_signal (const QString&, bool)), this, SLOT (copy_image_to_clipboard (const QString&, bool))); if (m_app_context.experimental_terminal_widget ()) { // Get settings file. m_resource_manager.reload_settings (); // After settings. config_translators (); m_qapplication->setQuitOnLastWindowClosed (false); } else { if (gui_app) { m_main_window = new main_window (*this); if (m_interpreter_ready) m_main_window->handle_octave_ready (); else connect (m_interpreter_qobj, SIGNAL (ready ()), m_main_window, SLOT (handle_octave_ready ())); connect (qt_link (), SIGNAL (focus_window_signal (const QString&)), m_main_window, SLOT (focus_window (const QString&))); m_app_context.gui_running (true); } else { // Get settings file. m_resource_manager.reload_settings (); // After settings. config_translators (); m_qapplication->setQuitOnLastWindowClosed (false); } } start_main_thread (); } base_qobject::~base_qobject (void) { // Note that we don't delete m_main_thread here. That is handled by // deleteLater slot that is called when the m_main_thread issues a // finished signal. delete m_main_window; delete m_interpreter_qobj; delete m_qsci_tr; delete m_gui_tr; delete m_qt_tr; delete m_qapplication; delete m_workspace_model; string_vector::delete_c_str_vec (m_argv); } void base_qobject::config_translators (void) { if (m_translators_installed) return; m_resource_manager.config_translators (m_qt_tr, m_qsci_tr, m_gui_tr); m_qapplication->installTranslator (m_qt_tr); m_qapplication->installTranslator (m_gui_tr); m_qapplication->installTranslator (m_qsci_tr); m_translators_installed = true; } void base_qobject::start_main_thread (void) { // Note: if using the new experimental terminal widget, we defer // initializing and executing the interpreter until the main event // loop begins executing. // With the old terminal widget, we defer initializing and executing // the interpreter until after the main window and QApplication are // running to prevent race conditions. QTimer::singleShot (0, m_interpreter_qobj, SLOT (execute (void))); m_interpreter_qobj->moveToThread (m_main_thread); m_main_thread->start (); } int base_qobject::exec (void) { int status; if (m_app_context.experimental_terminal_widget ()) { status = m_qapplication->exec (); m_main_thread->quit (); m_main_thread->wait (); } else status = m_qapplication->exec (); return status; } // Provided for convenience. Will be removed once we eliminate the // old terminal widget. bool base_qobject::experimental_terminal_widget (void) const { return m_app_context.experimental_terminal_widget (); } bool base_qobject::gui_running (void) const { return m_app_context.gui_running (); } bool base_qobject::confirm_shutdown (void) { // Currently, we forward to main_window::confirm_shutdown instead of // just displaying a dialog box here because the main_window also // knows about and is responsible for notifying the editor. return m_main_window ? m_main_window->confirm_shutdown () : true; } void base_qobject::start_gui (bool gui_app) { if (m_app_context.experimental_terminal_widget ()) { if (m_main_window) return; m_gui_app = gui_app; m_main_window = new main_window (*this); connect (qt_link (), SIGNAL (focus_window_signal (const QString&)), m_main_window, SLOT (focus_window (const QString&))); connect (qt_link (), SIGNAL (close_gui_signal ()), this, SLOT (close_gui ())); connect (m_main_window, SIGNAL (close_gui_signal ()), this, SLOT (close_gui ())); if (m_interpreter_ready) m_main_window->handle_octave_ready (); else connect (m_interpreter_qobj, SIGNAL (ready ()), m_main_window, SLOT (handle_octave_ready ())); if (m_gui_app) m_qapplication->setQuitOnLastWindowClosed (true); else { // FIXME: Save current values of PS1 and PS2 so they can be // restored when we return to the command line? } m_app_context.gui_running (true); } } void base_qobject::close_gui (void) { if (m_app_context.experimental_terminal_widget ()) { if (! m_main_window) return; // FIXME: Restore previous values of PS1 and PS2 if we are // returning to the command line? interpreter_event ([=] (interpreter& interp) { // INTERPRETER THREAD application *app = interp.get_app_context (); cmdline_options opts = app->options (); if (opts.gui ()) interp.quit (0, false, false); }); m_app_context.gui_running (false); if (m_main_window) { m_main_window->deleteLater (); m_main_window = nullptr; } } } void base_qobject::handle_interpreter_execution_finished (int exit_status) { if (! m_app_context.experimental_terminal_widget ()) emit request_interpreter_shutdown (exit_status); } void base_qobject::interpreter_ready (void) { m_interpreter_ready = true; } void base_qobject::handle_interpreter_shutdown_finished (int exit_status) { #if defined (Q_OS_MAC) // fprintf to stderr is needed by macOS, for poorly-understood reasons. fprintf (stderr, "\n"); #endif m_main_thread->quit (); m_main_thread->wait (); qApp->exit (exit_status); } void base_qobject::interpreter_event (const fcn_callback& fcn) { // The following is a direct function call across threads. It works // because the it is accessing a thread-safe queue of events that // are later executed by the Octave interpreter in the other thread. // See also the comments in interpreter-qobject.h about // interpreter_qobject slots. m_interpreter_qobj->interpreter_event (fcn); } void base_qobject::interpreter_event (const meth_callback& meth) { // The following is a direct function call across threads. It works // because the it is accessing a thread-safe queue of events that // are later executed by the Octave interpreter in the other thread. // See also the comments in interpreter-qobject.h about // interpreter_qobject slots. m_interpreter_qobj->interpreter_event (meth); } void base_qobject::interpreter_interrupt (void) { m_interpreter_qobj->interrupt (); } // FIXME: Should we try to make the pause, stop, and resume actions // work for both the old and new terminal widget? void base_qobject::interpreter_pause (void) { if (m_app_context.experimental_terminal_widget ()) m_interpreter_qobj->pause (); } void base_qobject::interpreter_stop (void) { if (m_app_context.experimental_terminal_widget ()) m_interpreter_qobj->stop (); } void base_qobject::interpreter_resume (void) { if (m_app_context.experimental_terminal_widget ()) m_interpreter_qobj->resume (); } void base_qobject::copy_image_to_clipboard (const QString& file, bool remove_file) { QClipboard *clipboard = QApplication::clipboard (); QImage img (file); if (img.isNull ()) { // Report error? return; } clipboard->setImage (img); if (remove_file) QFile::remove (file); } }