Source code for mu.interface.main

Contains the main Window definition for Mu's UI.

Copyright (c) 2015-2017 Nicholas H.Tollervey and others (see the AUTHORS file).

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
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 <>.
import sys
import logging
import os.path
from PyQt5.QtCore import QSize, Qt, pyqtSignal, QTimer
from PyQt5.QtWidgets import (
from PyQt5.QtGui import QKeySequence, QStandardItemModel
from mu import __version__
from mu.interface.dialogs import (
from mu.interface.themes import (
from mu.interface.panes import (
from mu.interface.editor import EditorPane
from mu.interface.widgets import DeviceSelector
from mu.resources import load_icon, load_pixmap

logger = logging.getLogger(__name__)

[docs]class ButtonBar(QToolBar): """ Represents the bar of buttons across the top of the editor and defines their behaviour. """ def __init__(self, parent): super().__init__(parent) self.setMovable(False) self.setIconSize(QSize(64, 64)) self.setToolButtonStyle(3) self.setContextMenuPolicy(Qt.PreventContextMenu) self.setObjectName("StandardToolBar") self.reset()
[docs] def reset(self): """ Resets the button states. """ self.slots = {} self.clear()
def change_mode(self, mode): self.reset() self.addAction( name="modes", display_name=_("Mode"), tool_text=_("Change Mu's mode of behaviour."), ) self.addSeparator() self.addAction( name="new", display_name=_("New"), tool_text=_("Create a new Python script."), ) self.addAction( name="load", display_name=_("Load"), tool_text=_("Load a Python script."), ) self.addAction( name="save", display_name=_("Save"), tool_text=_("Save the current Python script."), ) self.addSeparator() for action in mode.actions(): self.addAction( name=action["name"], display_name=action["display_name"], tool_text=action["description"], ) self.addSeparator() self.addAction( name="zoom-in", display_name=_("Zoom-in"), tool_text=_("Zoom in (to make the text bigger)."), ) self.addAction( name="zoom-out", display_name=_("Zoom-out"), tool_text=_("Zoom out (to make the text smaller)."), ) self.addAction( name="theme", display_name=_("Theme"), tool_text=_( "Toggle theme between day, night or " "high contrast." ), ) self.addSeparator() self.addAction( name="check", display_name=_("Check"), tool_text=_("Check your code for mistakes."), ) if sys.version_info[:2] >= (3, 6): self.addAction( name="tidy", display_name=_("Tidy"), tool_text=_("Tidy up the layout of your code."), ) self.addAction( name="help", display_name=_("Help"), tool_text=_("Show help about Mu in a browser."), ) self.addSeparator() self.addAction( name="quit", display_name=_("Quit"), tool_text=_("Quit Mu.") )
[docs] def set_responsive_mode(self, width, height): """ Compact button bar for when window is very small. """ font_size = DEFAULT_FONT_SIZE if width < 1124 and height > 600: self.setIconSize(QSize(48, 48)) elif height < 600 and width < 940: font_size = 10 self.setIconSize(QSize(32, 32)) else: self.setIconSize(QSize(64, 64)) stylesheet = "QWidget{font-size: " + str(font_size) + "px;}" self.setStyleSheet(stylesheet)
[docs] def addAction(self, name, display_name, tool_text): """ Creates an action associated with an icon and name and adds it to the widget's slots. """ action = QAction( load_icon(name), display_name, self, toolTip=tool_text ) super().addAction(action) self.slots[name] = action
[docs] def connect(self, name, handler, shortcut=None): """ Connects a named slot to a handler function and optional hot-key shortcuts. """ self.slots[name].pyqtConfigure(triggered=handler) if shortcut: self.slots[name].setShortcut(QKeySequence(shortcut))
[docs]class FileTabs(QTabWidget): """ Extend the base class so we can override the removeTab behaviour. """ def __init__(self): super(FileTabs, self).__init__() # We are implementing closable tabs manually self.setTabsClosable(False) self.setMovable(True) self.currentChanged.connect(self.change_tab)
[docs] def removeTab(self, tab_id): """ Ask the user before closing the file. """ window = self.nativeParentWidget() modified = self.widget(tab_id).isModified() if modified: msg = ( "There is un-saved work, closing the tab will cause you " "to lose it." ) if window.show_confirmation(msg) == QMessageBox.Cancel: return super(FileTabs, self).removeTab(tab_id)
[docs] def addTab(self, widget, title): """ Add a new tab to the switcher """ # Proxy up to the real addTab tab_id = super(FileTabs, self).addTab(widget, title) # A widget to put the indicator and close button in container = QWidget() box = QHBoxLayout(container) # We don't want any margins on the layout, that would expand the tab box.setContentsMargins(0, 0, 0, 0) # Ensure some space between image and button box.setSpacing(6) # Counterintuitively QImage doesn't show an image, QLabel does state_lbl = QLabel(container) box.addWidget(state_lbl) state_lbl.setPixmap(load_pixmap("document.svg")) # Watch for status change to update the dirty indicator # We watch here as it's far easier to keep track of state_lbl # It does mean we assume all tabs are EditorPane @widget.modificationChanged.connect def on_modified(): if widget.isModified(): state_lbl.setPixmap(load_pixmap("document-dirty.svg")) else: # This icon is actually empty state_lbl.setPixmap(load_pixmap("document.svg")) # Setup our own close button since we are overriding the built in one close_btn = QPushButton(container) box.addWidget(close_btn) close_btn.setToolTip(_("Close file")) close_btn.setFlat(True) # Bit of a weird size but we want to avoid giant tabs close_btn.setIconSize(QSize(10, 10)) close_btn.setIcon(load_icon("close-tab.svg")) # Handle 'clicked' events @close_btn.clicked.connect def close(): # The tab_id isn't constant and may have changed, lookup the # current id of the EditorPane tab_id = self.indexOf(widget) # Close the tab self.removeTab(tab_id) container.setLayout(box) # Add the box, clearly it isn't a button but QTabBar actually takes # any QWidget not just buttons self.tabBar().setTabButton(tab_id, QTabBar.RightSide, container) # Return the index of the new page just like the reall addTab return tab_id
[docs] def change_tab(self, tab_id): """ Update the application title to reflect the name of the file in the currently selected tab. """ current_tab = self.widget(tab_id) window = self.nativeParentWidget() if current_tab: window.update_title(current_tab.title) else: window.update_title(None)
[docs]class Window(QMainWindow): """ Defines the look and characteristics of the application's main window. """ title = _("Mu {}").format(__version__) icon = "icon" timer = None usb_checker = None repl = None plotter = None zooms = ("xs", "s", "m", "l", "xl", "xxl", "xxxl") # levels of zoom. zoom_position = 2 # current level of zoom (as position in zooms tuple). _zoom_in = pyqtSignal(str) _zoom_out = pyqtSignal(str) data_received = pyqtSignal(bytes) open_file = pyqtSignal(str) load_theme = pyqtSignal(str) previous_folder = None def __init__(self, parent=None): super().__init__(parent)
[docs] def wheelEvent(self, event): """ Trap a CTRL-scroll event so the user is able to zoom in and out. """ modifiers = QApplication.keyboardModifiers() if modifiers == Qt.ControlModifier: zoom = event.angleDelta().y() > 0 if zoom: self.zoom_in() else: self.zoom_out() event.ignore()
[docs] def set_zoom(self): """ Sets the zoom to current zoom_position level. """ self._zoom_in.emit(self.zooms[self.zoom_position])
[docs] def zoom_in(self): """ Handles zooming in. """ self.zoom_position = min(self.zoom_position + 1, len(self.zooms) - 1) self._zoom_in.emit(self.zooms[self.zoom_position])
[docs] def zoom_out(self): """ Handles zooming out. """ self.zoom_position = max(self.zoom_position - 1, 0) self._zoom_out.emit(self.zooms[self.zoom_position])
[docs] def connect_zoom(self, widget): """ Connects a referenced widget to the zoom related signals and sets the zoom of the widget to the current zoom level. """ self._zoom_in.connect(widget.set_zoom) self._zoom_out.connect(widget.set_zoom) widget.set_zoom(self.zooms[self.zoom_position])
@property def current_tab(self): """ Returns the currently focussed tab. """ return self.tabs.currentWidget()
[docs] def set_read_only(self, is_readonly): """ Set all tabs read-only. """ self.read_only_tabs = is_readonly for tab in self.widgets: tab.setReadOnly(is_readonly)
[docs] def get_load_path(self, folder, extensions="*", allow_previous=True): """ Displays a dialog for selecting a file to load. Returns the selected path. Defaults to start in the referenced folder unless a previous folder has been used and the allow_previous flag is True (the default behaviour) """ if allow_previous: open_in = ( folder if self.previous_folder is None else self.previous_folder ) else: open_in = folder path, _ = QFileDialog.getOpenFileName( self.widget, "Open file", open_in, extensions ) logger.debug("Getting load path: {}".format(path)) if allow_previous: self.previous_folder = os.path.dirname(path) return path
[docs] def get_save_path(self, folder): """ Displays a dialog for selecting a file to save. Returns the selected path. Defaults to start in the referenced folder. """ path, _ = QFileDialog.getSaveFileName( self.widget, "Save file", folder if self.previous_folder is None else self.previous_folder, "Python (*.py);;Other (*.*)", "Python (*.py)", ) self.previous_folder = os.path.dirname(path) logger.debug("Getting save path: {}".format(path)) return path
[docs] def get_microbit_path(self, folder): """ Displays a dialog for locating the location of the BBC micro:bit in the host computer's filesystem. Returns the selected path. Defaults to start in the referenced folder. """ path = QFileDialog.getExistingDirectory( self.widget, "Locate BBC micro:bit", folder if self.previous_folder is None else self.previous_folder, QFileDialog.ShowDirsOnly, ) self.previous_folder = os.path.dirname(path) logger.debug("Getting micro:bit path: {}".format(path)) return path
[docs] def add_tab(self, path, text, api, newline): """ Adds a tab with the referenced path and text to the editor. """ new_tab = EditorPane(path, text, newline) new_tab.connect_margin(self.breakpoint_toggle) new_tab_index = self.tabs.addTab(new_tab, new_tab.label) new_tab.set_api(api) @new_tab.modificationChanged.connect def on_modified(): modified_tab_index = self.tabs.indexOf(new_tab) # Update tab label & window title # Tab dirty indicator is managed in FileTabs.addTab self.tabs.setTabText(modified_tab_index, new_tab.label) self.update_title(new_tab.title) @new_tab.open_file.connect def on_open_file(file): # Bubble the signal up self.open_file.emit(file) self.tabs.setCurrentIndex(new_tab_index) self.connect_zoom(new_tab) self.set_theme(self.theme) new_tab.setFocus() if self.read_only_tabs: new_tab.setReadOnly(self.read_only_tabs) return new_tab
[docs] def focus_tab(self, tab): """ Force focus on the referenced tab. """ index = self.tabs.indexOf(tab) self.tabs.setCurrentIndex(index) tab.setFocus()
@property def tab_count(self): """ Returns the number of active tabs. """ return self.tabs.count() @property def widgets(self): """ Returns a list of references to the widgets representing tabs in the editor. """ return [self.tabs.widget(i) for i in range(self.tab_count)] @property def modified(self): """ Returns a boolean indication if there are any modified tabs in the editor. """ for widget in self.widgets: if widget.isModified(): return True return False
[docs] def on_stdout_write(self, data): """ Called when either a running script or the REPL write to STDOUT. """ self.data_received.emit(data)
[docs] def add_filesystem(self, home, file_manager, board_name="board"): """ Adds the file system pane to the application. """ self.fs_pane = FileSystemPane(home) @self.fs_pane.open_file.connect def on_open_file(file): # Bubble the signal up self.open_file.emit(file) self.fs = QDockWidget(_("Filesystem on ") + board_name) self.fs.setWidget(self.fs_pane) self.fs.setFeatures(QDockWidget.DockWidgetMovable) self.fs.setAllowedAreas(Qt.BottomDockWidgetArea) self.addDockWidget(Qt.BottomDockWidgetArea, self.fs) self.fs_pane.setFocus() file_manager.on_list_files.connect(self.fs_pane.on_ls) self.fs_pane.list_files.connect( self.fs_pane.microbit_fs.put.connect(file_manager.put) self.fs_pane.microbit_fs.delete.connect(file_manager.delete) self.fs_pane.microbit_fs.list_files.connect( self.fs_pane.local_fs.get.connect(file_manager.get) self.fs_pane.local_fs.put.connect(file_manager.put) self.fs_pane.local_fs.list_files.connect( file_manager.on_put_file.connect(self.fs_pane.microbit_fs.on_put) file_manager.on_delete_file.connect(self.fs_pane.microbit_fs.on_delete) file_manager.on_get_file.connect(self.fs_pane.local_fs.on_get) file_manager.on_list_fail.connect(self.fs_pane.on_ls_fail) file_manager.on_put_fail.connect(self.fs_pane.on_put_fail) file_manager.on_delete_fail.connect(self.fs_pane.on_delete_fail) file_manager.on_get_fail.connect(self.fs_pane.on_get_fail) self.connect_zoom(self.fs_pane) return self.fs_pane
[docs] def add_micropython_repl(self, name, connection): """ Adds a MicroPython based REPL pane to the application. """ repl_pane = MicroPythonREPLPane(connection) connection.data_received.connect(repl_pane.process_tty_data) self.add_repl(repl_pane, name)
[docs] def add_micropython_plotter(self, name, connection, data_flood_handler): """ Adds a plotter that reads data from a serial connection. """ plotter_pane = PlotterPane() connection.data_received.connect(plotter_pane.process_tty_data) plotter_pane.data_flood.connect(data_flood_handler) self.add_plotter(plotter_pane, name)
[docs] def add_python3_plotter(self, mode): """ Add a plotter that reads from either the REPL or a running script. Since this function will only be called when either the REPL or a running script are running (but not at the same time), it'll just grab data emitted by the REPL or script via data_received. """ plotter_pane = PlotterPane() self.data_received.connect(plotter_pane.process_tty_data) plotter_pane.data_flood.connect(mode.on_data_flood) self.add_plotter(plotter_pane, _("Python3 data tuple"))
[docs] def add_jupyter_repl(self, kernel_manager, kernel_client): """ Adds a Jupyter based REPL pane to the application. """ kernel_manager.kernel.gui = "qt4" kernel_client.start_channels() ipython_widget = JupyterREPLPane() ipython_widget.kernel_manager = kernel_manager ipython_widget.kernel_client = kernel_client ipython_widget.on_append_text.connect(self.on_stdout_write) self.add_repl(ipython_widget, _("Python3 (Jupyter)"))
[docs] def add_repl(self, repl_pane, name): """ Adds the referenced REPL pane to the application. """ self.repl_pane = repl_pane self.repl = QDockWidget(_("{} REPL").format(name)) self.repl.setWidget(repl_pane) self.repl.setFeatures(QDockWidget.DockWidgetMovable) self.repl.setAllowedAreas( Qt.BottomDockWidgetArea | Qt.LeftDockWidgetArea | Qt.RightDockWidgetArea ) self.addDockWidget(Qt.BottomDockWidgetArea, self.repl) self.connect_zoom(self.repl_pane) self.repl_pane.set_theme(self.theme) self.repl_pane.setFocus()
[docs] def add_plotter(self, plotter_pane, name): """ Adds the referenced plotter pane to the application. """ self.plotter_pane = plotter_pane self.plotter = QDockWidget(_("{} Plotter").format(name)) self.plotter.setWidget(plotter_pane) self.plotter.setFeatures(QDockWidget.DockWidgetMovable) self.plotter.setAllowedAreas( Qt.BottomDockWidgetArea | Qt.LeftDockWidgetArea | Qt.RightDockWidgetArea ) self.addDockWidget(Qt.BottomDockWidgetArea, self.plotter) self.plotter_pane.set_theme(self.theme) self.plotter_pane.setFocus()
[docs] def add_python3_runner( self, interpreter, script_name, working_directory, interactive=False, debugger=False, command_args=None, envars=None, python_args=None, ): """ Display console output for the interpreter with the referenced pythonpath running the referenced script. The script will be run within the workspace_path directory. If interactive is True (default is False) the Python process will run in interactive mode (dropping the user into the REPL when the script completes). If debugger is True (default is False) the script will be run within a debug runner session. The debugger overrides the interactive flag (you cannot run the debugger in interactive mode). If there is a list of command_args (the default is None) then these will be passed as further arguments into the command run in the new process. If envars is given, these will become part of the environment context of the new chlid process. If python_args is given, these will be passed as arguments to the Python runtime used to launch the child process. """ self.process_runner = PythonProcessPane(self) self.runner = QDockWidget( _("Running: {}").format(os.path.basename(script_name)) ) self.runner.setWidget(self.process_runner) self.runner.setFeatures(QDockWidget.DockWidgetMovable) self.runner.setAllowedAreas( Qt.BottomDockWidgetArea | Qt.LeftDockWidgetArea | Qt.RightDockWidgetArea ) self.addDockWidget(Qt.BottomDockWidgetArea, self.runner) "About to start_process: %r, %r, %r, %r, %r, %r, %r, %r", interpreter, script_name, working_directory, interactive, debugger, command_args, envars, python_args, ) self.process_runner.start_process( interpreter, script_name, working_directory, interactive, debugger, command_args, envars, python_args, ) self.process_runner.setFocus() self.process_runner.on_append_text.connect(self.on_stdout_write) self.connect_zoom(self.process_runner) return self.process_runner
[docs] def add_debug_inspector(self): """ Display a debug inspector to view the call stack. """ self.debug_inspector = DebugInspector() self.debug_model = QStandardItemModel() self.debug_inspector.setModel(self.debug_model) self.inspector = QDockWidget(_("Debug Inspector")) self.inspector.setWidget(self.debug_inspector) self.inspector.setFeatures(QDockWidget.DockWidgetMovable) self.inspector.setAllowedAreas( Qt.BottomDockWidgetArea | Qt.LeftDockWidgetArea | Qt.RightDockWidgetArea ) self.addDockWidget(Qt.RightDockWidgetArea, self.inspector) self.connect_zoom(self.debug_inspector)
[docs] def update_debug_inspector(self, locals_dict): """ Given the contents of a dict representation of the locals in the current stack frame, update the debug inspector with the new values. """ excluded_names = ["__builtins__", "__debug_code__", "__debug_script__"] names = sorted([x for x in locals_dict if x not in excluded_names]) self.debug_model.clear() self.debug_model.setHorizontalHeaderLabels([_("Name"), _("Value")]) for name in names: try: # DANGER! val = eval(locals_dict[name]) except Exception: val = None if isinstance(val, list): # Show a list consisting of rows of position/value list_item = DebugInspectorItem(name) for i, i_val in enumerate(val): list_item.appendRow( [ DebugInspectorItem(str(i)), DebugInspectorItem(repr(i_val)), ] ) self.debug_model.appendRow( [ list_item, DebugInspectorItem( _("(A list of {} items.)").format(len(val)) ), ] ) elif isinstance(val, dict): # Show a dict consisting of rows of key/value pairs. dict_item = DebugInspectorItem(name) for k, k_val in val.items(): dict_item.appendRow( [ DebugInspectorItem(repr(k)), DebugInspectorItem(repr(k_val)), ] ) self.debug_model.appendRow( [ dict_item, DebugInspectorItem( _("(A dict of {} items.)").format(len(val)) ), ] ) else: self.debug_model.appendRow( [ DebugInspectorItem(name), DebugInspectorItem(locals_dict[name]), ] )
[docs] def remove_filesystem(self): """ Removes the file system pane from the application. """ if hasattr(self, "fs") and self.fs: self.fs_pane = None self.fs.setParent(None) self.fs.deleteLater() self.fs = None
[docs] def remove_repl(self): """ Removes the REPL pane from the application. """ if self.repl: self.repl_pane = None self.repl.setParent(None) self.repl.deleteLater() self.repl = None
[docs] def remove_plotter(self): """ Removes the plotter pane from the application. """ if self.plotter: self.plotter_pane = None self.plotter.setParent(None) self.plotter.deleteLater() self.plotter = None
[docs] def remove_python_runner(self): """ Removes the runner pane from the application. """ if hasattr(self, "runner") and self.runner: self.process_runner = None self.runner.setParent(None) self.runner.deleteLater() self.runner = None
[docs] def remove_debug_inspector(self): """ Removes the debug inspector pane from the application. """ if hasattr(self, "inspector") and self.inspector: self.debug_inspector = None self.debug_model = None self.inspector.setParent(None) self.inspector.deleteLater() self.inspector = None
[docs] def set_theme(self, theme): """ Sets the theme for the REPL and editor tabs. """ self.theme = theme self.load_theme.emit(theme) if theme == "contrast": new_theme = ContrastTheme new_icon = "theme_day" elif theme == "night": new_theme = NightTheme new_icon = "theme_contrast" else: new_theme = DayTheme new_icon = "theme" for widget in self.widgets: widget.set_theme(new_theme) self.button_bar.slots["theme"].setIcon(load_icon(new_icon)) if hasattr(self, "repl") and self.repl: self.repl_pane.set_theme(theme) if hasattr(self, "plotter") and self.plotter: self.plotter_pane.set_theme(theme)
[docs] def set_checker_icon(self, icon): """ Set the status icon to use on the check button """ self.button_bar.slots["check"].setIcon(load_icon(icon)) timer = QTimer() @timer.timeout.connect def reset(): self.button_bar.slots["check"].setIcon(load_icon("check.png")) timer.stop() timer.start(500)
[docs] def show_admin(self, log, settings, packages, mode, device_list): """ Display the administrative dialog with referenced content of the log and settings. Return a dictionary of the settings that may have been changed by the admin dialog. """ admin_box = AdminDialog(self) admin_box.setup(log, settings, packages, mode, device_list) result = admin_box.exec() if result: return admin_box.settings() else: return {}
[docs] def sync_packages(self, to_remove, to_add): """ Display a modal dialog that indicates the status of the add/remove package management operation. """ package_box = PackageDialog(self) package_box.setup(to_remove, to_add) package_box.exec()
[docs] def show_message(self, message, information=None, icon=None): """ Displays a modal message to the user. If information is passed in this will be set as the additional informative text in the modal dialog. Since this mechanism will be used mainly for warning users that something is awry the default icon is set to "Warning". It's possible to override the icon to one of the following settings: NoIcon, Question, Information, Warning or Critical. """ message_box = QMessageBox(self) message_box.setText(message) message_box.setWindowTitle("Mu") if information: message_box.setInformativeText(information) if icon and hasattr(message_box, icon): message_box.setIcon(getattr(message_box, icon)) else: message_box.setIcon(message_box.Warning) logger.debug(message) logger.debug(information) message_box.exec()
[docs] def show_confirmation(self, message, information=None, icon=None): """ Displays a modal message to the user to which they need to confirm or cancel. If information is passed in this will be set as the additional informative text in the modal dialog. Since this mechanism will be used mainly for warning users that something is awry the default icon is set to "Warning". It's possible to override the icon to one of the following settings: NoIcon, Question, Information, Warning or Critical. """ message_box = QMessageBox(self) message_box.setText(message) message_box.setWindowTitle(_("Mu")) if information: message_box.setInformativeText(information) if icon and hasattr(message_box, icon): message_box.setIcon(getattr(message_box, icon)) else: message_box.setIcon(message_box.Warning) message_box.setStandardButtons(message_box.Cancel | message_box.Ok) message_box.setDefaultButton(message_box.Cancel) logger.debug(message) logger.debug(information) return message_box.exec()
[docs] def update_title(self, filename=None): """ Updates the title bar of the application. If a filename (representing the name of the file currently the focus of the editor) is supplied, append it to the end of the title. """ title = self.title if filename: title += " - " + filename self.setWindowTitle(title)
[docs] def screen_size(self): """ Returns an (width, height) tuple with the screen geometry. """ screen = QDesktopWidget().screenGeometry() return screen.width(), screen.height()
[docs] def size_window(self, x=None, y=None, w=None, h=None): """ Makes the editor 80% of the width*height of the screen and centres it when none of x, y, w and h is passed in; otherwise uses the passed in values to position and size the editor window. """ screen_width, screen_height = self.screen_size() w = int(screen_width * 0.8) if w is None else w h = int(screen_height * 0.8) if h is None else h self.resize(w, h) size = self.geometry() x = (screen_width - size.width()) / 2 if x is None else x y = (screen_height - size.height()) / 2 if y is None else y self.move(x, y)
[docs] def reset_annotations(self): """ Resets the state of annotations on the current tab. """ self.current_tab.reset_annotations()
[docs] def annotate_code(self, feedback, annotation_type): """ Given a list of annotations about the code in the current tab, add the annotations to the editor window so the user can make appropriate changes. """ self.current_tab.annotate_code(feedback, annotation_type)
[docs] def show_annotations(self): """ Show the annotations added to the current tab. """ self.current_tab.show_annotations()
[docs] def setup(self, breakpoint_toggle, theme): """ Sets up the window. Defines the various attributes of the window and defines how the user interface is laid out. """ self.theme = theme self.breakpoint_toggle = breakpoint_toggle # Give the window a default icon, title and minimum size. self.setWindowIcon(load_icon(self.icon)) self.update_title() self.read_only_tabs = False screen_width, screen_height = self.screen_size() self.setMinimumSize(screen_width // 2, screen_height // 2) self.setTabPosition(Qt.AllDockWidgetAreas, QTabWidget.North) self.widget = QWidget() widget_layout = QVBoxLayout() self.widget.setLayout(widget_layout) self.button_bar = ButtonBar(self.widget) self.tabs = FileTabs() self.setCentralWidget(self.tabs) self.status_bar = StatusBar(parent=self) self.setStatusBar(self.status_bar) self.addToolBar(self.button_bar)
[docs] def resizeEvent(self, resizeEvent): """ Respond to window getting too small for the button bar to fit well. """ size = resizeEvent.size() self.button_bar.set_responsive_mode(size.width(), size.height())
[docs] def select_mode(self, modes, current_mode): """ Display the mode selector dialog and return the result. """ mode_select = ModeSelector(self) mode_select.setup(modes, current_mode) mode_select.exec() try: return mode_select.get_mode() except Exception: return None
[docs] def change_mode(self, mode): """ Given a an object representing a mode, recreates the button bar with the expected functionality. """ self.button_bar.change_mode(mode) # Update the autocomplete / tooltip APIs for each tab to the new mode. api = mode.api() for widget in self.widgets: widget.set_api(api)
[docs] def set_usb_checker(self, duration, callback): """ Sets up a timer that polls for USB changes via the "callback" every "duration" seconds. """ self.usb_checker = QTimer() self.usb_checker.timeout.connect(callback) self.usb_checker.start(duration * 1000)
[docs] def set_timer(self, duration, callback): """ Set a repeating timer to call "callback" every "duration" seconds. """ self.timer = QTimer() self.timer.timeout.connect(callback) self.timer.start(duration * 1000) # Measured in milliseconds.
[docs] def stop_timer(self): """ Stop the repeating timer. """ if self.timer: self.timer.stop() self.timer = None
[docs] def connect_tab_rename(self, handler, shortcut): """ Connect the double-click event on a tab and the keyboard shortcut to the referenced handler (causing the Save As dialog). """ self.tabs.shortcut = QShortcut(QKeySequence(shortcut), self) self.tabs.shortcut.activated.connect(handler) self.tabs.tabBarDoubleClicked.connect(handler)
[docs] def open_directory_from_os(self, path): """ Given the path to a directory, open the OS's built in filesystem explorer for that path. Works with Windows, OSX and Linux. """ if sys.platform == "win32": # Windows os.startfile(path) elif sys.platform == "darwin": # OSX os.system('open "{}"'.format(path)) else: # Assume on unix-y. os.system('xdg-open "{}"'.format(path))
[docs] def connect_find_replace(self, handler, shortcut): """ Create a keyboard shortcut and associate it with a handler for doing a find and replace. """ self.find_replace_shortcut = QShortcut(QKeySequence(shortcut), self) self.find_replace_shortcut.activated.connect(handler)
[docs] def connect_find_again(self, handlers, shortcut): """ Create keyboard shortcuts and associate them with handlers for doing a find again in forward or backward direction. Any given shortcut will be used for forward find again, while Shift+shortcut will find again backwards. """ forward, backward = handlers self.find_again_shortcut = QShortcut(QKeySequence(shortcut), self) self.find_again_shortcut.activated.connect(forward) backward_shortcut = QKeySequence("Shift+" + shortcut) self.find_again_backward_shortcut = QShortcut(backward_shortcut, self) self.find_again_backward_shortcut.activated.connect(backward)
[docs] def show_find_replace(self, find, replace, global_replace): """ Display the find/replace dialog. If the dialog's OK button was clicked return a tuple containing the find term, replace term and global replace flag. """ finder = FindReplaceDialog(self) finder.setup(find, replace, global_replace) if finder.exec(): return (finder.find(), finder.replace(), finder.replace_flag())
[docs] def replace_text(self, target_text, replace, global_replace): """ Given target_text, replace the first instance after the cursor with "replace". If global_replace is true, replace all instances of "target". Returns the number of times replacement has occurred. """ if not self.current_tab: return 0 if global_replace: counter = 0 found = self.current_tab.findFirst( target_text, True, True, False, False, line=0, index=0 ) if found: counter += 1 self.current_tab.replace(replace) while self.current_tab.findNext(): self.current_tab.replace(replace) counter += 1 return counter else: found = self.current_tab.findFirst( target_text, True, True, False, True ) if found: self.current_tab.replace(replace) return 1 else: return 0
[docs] def highlight_text(self, target_text, forward=True): """ Highlight the first match from the current position of the cursor in the current tab for the target_text. Returns True if there's a match. """ if self.current_tab: line = -1 index = -1 if not forward: # Workaround for `findFirst(forward=False)` not advancing # backwards: pass explicit line and index values. line, index, _el, _ei = self.current_tab.getSelection() return self.current_tab.findFirst( target_text, # Text to find, True, # Treat as regular expression True, # Case sensitive search False, # Whole word matches only True, # Wrap search forward=forward, # Forward search line=line, # -1 starts at current position index=index, # -1 starts at current position ) else: return False
[docs] def connect_toggle_comments(self, handler, shortcut): """ Create a keyboard shortcut and associate it with a handler for toggling comments on highlighted lines. """ self.toggle_comments_shortcut = QShortcut(QKeySequence(shortcut), self) self.toggle_comments_shortcut.activated.connect(handler)
[docs] def toggle_comments(self): """ Toggle comments on/off for all selected line in the currently active tab. """ if self.current_tab: self.current_tab.toggle_comments()
[docs] def show_device_selector(self): """ Reveals the device selector in the status bar """ self.status_bar.device_selector.setHidden(False)
[docs] def hide_device_selector(self): """ Hides the device selector in the status bar """ self.status_bar.device_selector.setHidden(True)
[docs]class StatusBar(QStatusBar): """ Defines the look and behaviour of the status bar along the bottom of the UI. """ def __init__(self, parent=None, mode="python"): super().__init__(parent) self.mode = mode self.msg_duration = 5 # Mode selector. self.mode_label = QLabel() self.mode_label.setToolTip(_("Mu's current mode of behaviour.")) self.addPermanentWidget(self.mode_label) self.set_mode(mode) # Device selector. self.device_selector = DeviceSelector() self.device_selector.setHidden(True) self.addPermanentWidget(self.device_selector) # Logs viewer self.logs_label = QLabel() self.logs_label.setObjectName("AdministrationLabel") self.logs_label.setPixmap(load_pixmap("logs").scaledToHeight(24)) self.logs_label.setToolTip(_("Mu Administration")) self.addPermanentWidget(self.logs_label)
[docs] def connect_logs(self, handler, shortcut): """ Connect the mouse press event and keyboard shortcut for the log widget to the referenced handler function. """ self.logs_label.shortcut = QShortcut( QKeySequence(shortcut), self.parent() ) self.logs_label.shortcut.activated.connect(handler) self.logs_label.mousePressEvent = handler
[docs] def connect_mode(self, handler, shortcut): """ Connect the mouse press event and keyboard shortcut for the mode widget to the referenced handler function. """ self.mode_label.shortcut = QShortcut( QKeySequence(shortcut), self.parent() ) self.mode_label.shortcut.activated.connect(handler) self.mode_label.mousePressEvent = handler
[docs] def set_message(self, message, pause=5000): """ Displays a message in the status bar for a certain period of time. """ self.showMessage(message, pause)
[docs] def set_mode(self, mode): """ Updates the mode label to the new mode. """ self.mode_label.setText(mode)
[docs] def device_connected(self, device): """ Show a tooltip whenever a new device connects """ if device.board_name: msg = _("Detected new {} device: {}.").format( device.long_mode_name, device.board_name ) else: msg = _("Detected new {} device.").format(device.long_mode_name) self.set_message(msg, self.msg_duration * 1000)