Newer
Older
Angus Lothian
committed
"""B-ASIC Main Window Module.
This file opens the main window of the GUI for B-ASIC when run.
"""
Angus Lothian
committed
import importlib
import logging
Angus Lothian
committed
import sys
from typing import Dict, List, Optional, Tuple, cast
Angus Lothian
committed
from qtpy.QtCore import QCoreApplication, QFileInfo, QSettings, QSize, Qt, QThread
from qtpy.QtGui import QCursor, QIcon, QKeySequence, QPainter
from qtpy.QtWidgets import (
QAction,
QApplication,
QFileDialog,
QGraphicsScene,
QGraphicsTextItem,
QGraphicsView,
QInputDialog,
QLineEdit,
QListWidgetItem,
QMainWindow,
QShortcut,
)
import b_asic.core_operations
import b_asic.special_operations
from b_asic.GUI._preferences import GAP, GRID, MINBUTTONSIZE, PORTHEIGHT
Angus Lothian
committed
from b_asic.GUI.drag_button import DragButton
from b_asic.GUI.gui_interface import Ui_main_window
from b_asic.GUI.port_button import PortButton
from b_asic.GUI.precedence_graph_window import PrecedenceGraphWindow
from b_asic.GUI.select_sfg_window import SelectSFGWindow
from b_asic.GUI.simulate_sfg_window import SimulateSFGWindow
from b_asic.GUI.simulation_worker import SimulationWorker
from b_asic.GUI.util_dialogs import FaqWindow, KeybindingsWindow
from b_asic.gui_utils.about_window import AboutWindow
from b_asic.gui_utils.decorators import decorate_class, handle_error
from b_asic.gui_utils.plot_window import PlotWindow
from b_asic.port import InputPort, OutputPort
from b_asic.save_load_structure import python_to_sfg, sfg_to_python
from b_asic.simulation import Simulation
Angus Lothian
committed
from b_asic.special_operations import Input, Output
logging.basicConfig(level=logging.INFO)
QCoreApplication.setOrganizationName("Linköping University")
QCoreApplication.setOrganizationDomain("liu.se")
QCoreApplication.setApplicationName("B-ASIC SFG GUI")
QCoreApplication.setApplicationVersion(__version__)
Angus Lothian
committed
@decorate_class(handle_error)
class MainWindow(QMainWindow):
def __init__(self):
self._ui = Ui_main_window()
self._ui.setupUi(self)
self._zoom = 1
self._sfg_name_i = 0
self._drag_operation_scenes = {}
self._drag_buttons: Dict[Operation, DragButton] = {}
self._arrows: List[Arrow] = []
self._mouse_pressed = False
self._mouse_dragging = False
self._starting_port = None
self._pressed_operations = []
self._ports = {}
self._signal_ports = {}
self._operation_to_sfg: Dict[DragButton, SFG] = {}
self._pressed_ports = []
self._sfg_dict = {}
Angus Lothian
committed
self._window = self
self._logger = logging.getLogger(__name__)
self._plot: Dict[Simulation, PlotWindow] = dict()
self._graphics_view = QGraphicsView(self._scene, self)
self._graphics_view.setRenderHint(QPainter.Antialiasing)
self._graphics_view.setGeometry(
self._ui.operation_box.width(), 20, self.width(), self.height()
self._graphics_view.setDragMode(QGraphicsView.RubberBandDrag)
# Create _toolbar
self._toolbar = self.addToolBar("Toolbar")
self._toolbar.addAction("Create SFG", self.create_sfg_from_toolbar)
self._toolbar.addAction("Clear workspace", self._clear_workspace)
self._max_recent_files = 4
self._recent_files = []
self._recent_files_paths = deque(maxlen=self._max_recent_files)
Angus Lothian
committed
self.add_operations_from_namespace(
b_asic.core_operations, self._ui.core_operations_list
Angus Lothian
committed
self.add_operations_from_namespace(
b_asic.special_operations, self._ui.special_operations_list
Angus Lothian
committed
self._shortcut_core = QShortcut(QKeySequence("Ctrl+R"), self._ui.operation_box)
self._shortcut_core.activated.connect(
self._scene.selectionChanged.connect(self._select_operations)
Angus Lothian
committed
self.move_button_index = 0
self.is_show_names = True
self._check_show_names = QAction("Show operation names")
self._check_show_names.triggered.connect(self.view_operation_names)
self._check_show_names.setCheckable(True)
self._check_show_names.setChecked(True)
self._ui.view_menu.addAction(self._check_show_names)
self._ui.actionShowPC.triggered.connect(self._show_precedence_graph)
self._ui.actionSimulateSFG.triggered.connect(self.simulate_sfg)
self._ui.faqBASIC.triggered.connect(self.display_faq_page)
self._ui.aboutBASIC.triggered.connect(self.display_about_page)
self._ui.keybindsBASIC.triggered.connect(self.display_keybindings_page)
self._ui.core_operations_list.itemClicked.connect(
self._ui.special_operations_list.itemClicked.connect(
self._ui.custom_operations_list.itemClicked.connect(
self._ui.save_menu.triggered.connect(self.save_work)
self._ui.load_menu.triggered.connect(self.load_work)
self._ui.load_operations.triggered.connect(self.add_namespace)
self._ui.exit_menu.triggered.connect(self.exit_app)
self._shortcut_open = QShortcut(QKeySequence("Ctrl+O"), self)
self._shortcut_open.activated.connect(self.load_work)
self._shortcut_save = QShortcut(QKeySequence("Ctrl+S"), self)
self._shortcut_save.activated.connect(self.save_work)
self._shortcut_help = QShortcut(QKeySequence("Ctrl+?"), self)
self._shortcut_help.activated.connect(self.display_faq_page)
self._shortcut_signal = QShortcut(QKeySequence(Qt.Key_Space), self)
self._shortcut_signal.activated.connect(self._connect_callback)
self._create_recent_file_actions_and_menus()
Angus Lothian
committed
self._keybindings_page = None
self._about_page = None
self._faq_page = None
self._logger.info("Finished setting up GUI")
self._logger.info(
"For questions please refer to 'Ctrl+?', or visit the 'Help' "
Angus Lothian
committed
ui_width = self._ui.operation_box.width()
self._ui.operation_box.setGeometry(10, 10, ui_width, self.height())
self._graphics_view.setGeometry(
super().resizeEvent(event)
Angus Lothian
committed
if event.modifiers() == Qt.KeyboardModifier.ControlModifier:
old_zoom = self._zoom
self._zoom += event.angleDelta().y() / 2500
self._graphics_view.scale(self._zoom, self._zoom)
self._zoom = old_zoom
Angus Lothian
committed
if self._check_show_names.isChecked():
Angus Lothian
committed
self.is_show_names = True
else:
self.is_show_names = False
for operation in self._drag_operation_scenes:
Angus Lothian
committed
operation.label.setOpacity(self.is_show_names)
operation.is_show_name = self.is_show_names
sfg = cast(SFG, self.sfg_widget.sfg)
Angus Lothian
committed
file_dialog = QFileDialog()
file_dialog.setDefaultSuffix(".py")
module, accepted = file_dialog.getSaveFileName()
if not accepted:
return
self._logger.info("Saving SFG to path: " + str(module))
for op_drag, op_scene in self._drag_operation_scenes.items():
int(op_scene.x()),
int(op_scene.y()),
Angus Lothian
committed
try:
with open(module, "w+") as file_obj:
sfg_to_python(sfg, suffix=f"positions = {operation_positions}")
Angus Lothian
committed
except Exception as e:
self._logger.error(
f"Failed to save SFG to path: {module}, with error: {e}."
)
Angus Lothian
committed
return
self._logger.info("Saved SFG to path: " + str(module))
Angus Lothian
committed
Angus Lothian
committed
self.sfg_widget = SelectSFGWindow(self)
self.sfg_widget.show()
# Wait for input to dialog.
self.sfg_widget.ok.connect(self._save_work)
Angus Lothian
committed
module, accepted = QFileDialog().getOpenFileName()
if not accepted:
return
self._load_from_file(module)
Angus Lothian
committed
def _load_from_file(self, module) -> None:
self._logger.info("Loading SFG from path: " + str(module))
Angus Lothian
committed
try:
sfg, positions = python_to_sfg(module)
except ImportError as e:
f"Failed to load module: {module} with the following error: {e}."
Angus Lothian
committed
return
while sfg.name in self._sfg_dict:
self._logger.warning(
Angus Lothian
committed
name, accepted = QInputDialog.getText(
self, "Change SFG Name", "Name: ", QLineEdit.Normal
)
Angus Lothian
committed
if not accepted:
return
sfg.name = name
self._load_sfg(sfg, positions)
self._logger.info("Loaded SFG from path: " + str(module))
def _load_sfg(self, sfg, positions=None) -> None:
if positions is None:
positions = {}
Angus Lothian
committed
for op in sfg.split():
self.create_operation(
positions[op.graph_id][0:2] if op.graph_id in positions else None,
positions[op.graph_id][-1] if op.graph_id in positions else None,
Angus Lothian
committed
def connect_ports(ports):
for port in ports:
for signal in port.signals:
for source in self._ports[
self._drag_buttons[signal.source.operation]
]
if source.port is signal.source
]
destination = [
destination
for destination in self._ports[
self._drag_buttons[signal.destination.operation]
]
if destination.port is signal.destination
]
Angus Lothian
committed
if source and destination:
self._connect_button(source[0], destination[0])
Angus Lothian
committed
Angus Lothian
committed
port.select_port()
for op in sfg.split():
connect_ports(op.inputs)
for op in sfg.split():
self._drag_buttons[op].setToolTip(sfg.name)
self._operation_to_sfg[self._drag_buttons[op]] = sfg
Angus Lothian
committed
Angus Lothian
committed
self.update()
def _create_recent_file_actions_and_menus(self):
for i in range(self._max_recent_files):
recentFileAction = QAction(self._ui.recent_sfg)
recentFileAction.setVisible(False)
recentFileAction.triggered.connect(
lambda b=0, x=recentFileAction: self._open_recent_file(x)
self._recent_files.append(recentFileAction)
self._ui.recent_sfg.addAction(recentFileAction)
settings = QSettings()
rfp = settings.value("SFG/recentFiles")
# print(rfp)
if rfp:
dequelen = len(rfp)
if dequelen > 0:
for i in range(dequelen):
action.setText(rfp[i])
action.setData(QFileInfo(rfp[i]))
for i in range(dequelen, self._max_recent_files):
self._recent_files[i].setVisible(False)
def _open_recent_file(self, action):
settings = QSettings()
rfp = settings.value("SFG/recentFiles")
if rfp:
if module not in rfp:
rfp.append(module)
rfp = deque(maxlen=self._max_recent_files)
self._logger.info("Exiting the application.")
Angus Lothian
committed
QApplication.quit()
def _clear_workspace(self) -> None:
self._logger.info("Clearing workspace from operations and SFGs.")
self._pressed_operations.clear()
self._pressed_ports.clear()
self._drag_buttons.clear()
self._drag_operation_scenes.clear()
self._arrows.clear()
self._ports.clear()
self._signal_ports.clear()
self._sfg_dict.clear()
self._scene.clear()
self._logger.info("Workspace cleared.")
Angus Lothian
committed
Angus Lothian
committed
inputs = []
outputs = []
Angus Lothian
committed
if isinstance(op.operation, Input):
inputs.append(op.operation)
elif isinstance(op.operation, Output):
outputs.append(op.operation)
name, accepted = QInputDialog.getText(
Angus Lothian
committed
if not accepted:
return
self._logger.warning("Failed to initialize SFG with empty name.")
Angus Lothian
committed
return
self._logger.info("Creating SFG with name: %s from selected operations." % name)
Angus Lothian
committed
sfg = SFG(inputs=inputs, outputs=outputs, name=name)
self._logger.info("Created SFG with name: %s from selected operations." % name)
Angus Lothian
committed
def check_equality(signal: Signal, signal_2: Signal) -> bool:
source = cast(OutputPort, signal.source)
source2 = cast(OutputPort, signal_2.source)
dest = cast(InputPort, signal.destination)
dest2 = cast(InputPort, signal_2.destination)
source.operation.type_name() == source2.operation.type_name()
and dest.operation.type_name() == dest2.operation.type_name()
Angus Lothian
committed
return False
hasattr(source.operation, "value")
and hasattr(source2.operation, "value")
and hasattr(dest.operation, "value")
and hasattr(dest2.operation, "value")
source.operation.value == source2.operation.value
and dest.operation.value == dest2.operation.value
Angus Lothian
committed
return False
hasattr(source.operation, "name")
and hasattr(source2.operation, "name")
and hasattr(dest.operation, "name")
and hasattr(dest2.operation, "name")
source.operation.name == source2.operation.name
and dest.operation.name == dest2.operation.name
Angus Lothian
committed
return False
try:
source.operation.outputs.index(port)
for port in source.operation.outputs
source2.operation.outputs.index(port)
for port in source2.operation.outputs
Angus Lothian
committed
except ValueError:
return False # Signal output connections not matching
try:
dest.operation.inputs.index(port)
for port in dest.operation.inputs
dest2.operation.inputs.index(port)
for port in dest2.operation.inputs
Angus Lothian
committed
except ValueError:
return False # Signal input connections not matching
return (
_signal_source_index == _signal_2_source_index
and _signal_destination_index == _signal_2_destination_index
)
Angus Lothian
committed
for _pressed_op in self._pressed_operations:
Angus Lothian
committed
for operation in sfg.operations:
for input_ in operation.inputs:
for signal in input_.signals:
Angus Lothian
committed
if check_equality(line.signal, signal):
line.source.operation.operation = (
signal.source.operation
)
line.destination.operation.operation = (
signal.destination.operation
)
Angus Lothian
committed
for output_ in operation.outputs:
for signal in output_.signals:
Angus Lothian
committed
if check_equality(line.signal, signal):
line.source.operation.operation = (
signal.source.operation
)
line.destination.operation.operation = (
signal.destination.operation
)
Angus Lothian
committed
Angus Lothian
committed
op.setToolTip(sfg.name)
self._operation_to_sfg[op] = sfg
Angus Lothian
committed
Angus Lothian
committed
def _show_precedence_graph(self, event=None) -> None:
self._precedence_graph_dialog = PrecedenceGraphWindow(self)
self._precedence_graph_dialog.add_sfg_to_dialog()
self._precedence_graph_dialog.show()
Angus Lothian
committed
def get_operations_from_namespace(self, namespace) -> List[str]:
"Fetching operations from namespace: " + str(namespace.__name__)
)
return [
comp
for comp in dir(namespace)
if hasattr(getattr(namespace, comp), "type_name")
]
Angus Lothian
committed
def add_operations_from_namespace(self, namespace, _list) -> None:
Angus Lothian
committed
for attr_name in self.get_operations_from_namespace(namespace):
attr = getattr(namespace, attr_name)
try:
attr.type_name()
item = QListWidgetItem(attr_name)
_list.addItem(item)
self._operations_from_name[attr_name] = attr
except NotImplementedError:
pass
self._logger.info("Added operations from namespace: " + str(namespace.__name__))
Angus Lothian
committed
Angus Lothian
committed
module, accepted = QFileDialog().getOpenFileName()
if not accepted:
return
spec = importlib.util.spec_from_file_location(
Angus Lothian
committed
namespace = importlib.util.module_from_spec(spec)
spec.loader.exec_module(namespace)
self.add_operations_from_namespace(namespace, self._ui.custom_operations_list)
Angus Lothian
committed
def create_operation(
self,
op: Operation,
position: Optional[Tuple[float, float]] = None,
is_flipped: bool = False,
) -> None:
"""
Parameters
----------
op : Operation
position : (float, float), optional
is_flipped : bool, default: False
"""
Angus Lothian
committed
try:
if op in self._drag_buttons:
self._logger.warning("Multiple instances of operation with same name")
attr_button = DragButton(op, True, window=self)
Angus Lothian
committed
if position is None:
attr_button.move(GRID * 3, GRID * 2)
Angus Lothian
committed
else:
attr_button.move(*position)
max_ports = max(op.input_count, op.output_count)
button_height = max(
MINBUTTONSIZE, max_ports * PORTHEIGHT + (max_ports - 1) * GAP
attr_button.setFixedSize(MINBUTTONSIZE, button_height)
attr_button.setStyleSheet(
"background-color: white; border-style: solid;"
self._ports[attr_button] = attr_button.ports
Angus Lothian
committed
icon_path = os.path.join(
os.path.dirname(__file__),
"operation_icons",
f"{op.type_name().lower()}.png",
)
icon_path = os.path.join(
os.path.dirname(__file__),
"operation_icons",
"custom_operation.png",
)
Angus Lothian
committed
attr_button.setIcon(QIcon(icon_path))
attr_button.setIconSize(QSize(MINBUTTONSIZE, MINBUTTONSIZE))
"QToolTip { background-color: white; color: black }"
Angus Lothian
committed
attr_button.setParent(None)
attr_button_scene = self._scene.addWidget(attr_button)
Angus Lothian
committed
if position is None:
attr_button_scene.moveBy(
int(self._scene.width() / 4), int(self._scene.height() / 4)
attr_button_scene.setFlag(QGraphicsItem.ItemIsSelectable, True)
Angus Lothian
committed
operation_label = QGraphicsTextItem(op.name, attr_button_scene)
if not self.is_show_names:
operation_label.setOpacity(0)
operation_label.setTransformOriginPoint(
Angus Lothian
committed
operation_label.moveBy(10, -20)
attr_button.add_label(operation_label)
if isinstance(is_flipped, bool):
if is_flipped:
attr_button._flip()
self._drag_buttons[op] = attr_button
self._drag_operation_scenes[attr_button] = attr_button_scene
Angus Lothian
committed
except Exception as e:
"Unexpected error occurred while creating operation: " + str(e)
Angus Lothian
committed
self._logger.info("Creating operation of type: %s" % str(item.text()))
Angus Lothian
committed
try:
attr_operation = self._operations_from_name[item.text()]()
self.create_operation(attr_operation)
Angus Lothian
committed
except Exception as e:
"Unexpected error occurred while creating operation: " + str(e)
Angus Lothian
committed
def _refresh_operations_list_from_namespace(self) -> None:
self._logger.info("Refreshing operation list.")
self._ui.core_operations_list.clear()
self._ui.special_operations_list.clear()
Angus Lothian
committed
self.add_operations_from_namespace(
b_asic.core_operations, self._ui.core_operations_list
Angus Lothian
committed
self.add_operations_from_namespace(
b_asic.special_operations, self._ui.special_operations_list
self._logger.info("Finished refreshing operation list.")
Angus Lothian
committed
Angus Lothian
committed
self._create_operation_item(item)
for pressed_op in self._pressed_operations:
Angus Lothian
committed
pressed_op.remove()
self.move_button_index -= 1
Angus Lothian
committed
super().keyPressEvent(event)
if len(self._pressed_ports) < 2:
self._logger.warning(
"Cannot connect less than two ports. Please select at least two."
Angus Lothian
committed
return
pressed_op_inports = [
pressed
if isinstance(pressed.port, InputPort)
]
pressed_op_outports = [
pressed
if isinstance(pressed.port, OutputPort)
]
Angus Lothian
committed
if len(pressed_op_outports) != 1:
raise ValueError("Exactly one output port must be selected!")
Angus Lothian
committed
pressed_op_outport = pressed_op_outports[0]
for pressed_op_inport in pressed_op_inports:
self._connect_button(pressed_op_outport, pressed_op_inport)
Angus Lothian
committed
Angus Lothian
committed
port.select_port()
def _connect_button(self, source: PortButton, destination: PortButton) -> None:
"""
Connect two PortButtons with an Arrow.
Parameters
----------
source : PortButton
The PortButton to start the signal at.
destination : PortButton
The PortButton to end the signal at.
Returns
-------
None.
"""
Angus Lothian
committed
signal_exists = (
signal
for signal in source.port.signals
if signal.destination is destination.port
)
"Connecting: %s -> %s."
% (
source.operation.operation.type_name(),
destination.operation.operation.type_name(),
)
Angus Lothian
committed
try:
arrow = Arrow(source, destination, self, signal=next(signal_exists))
Angus Lothian
committed
except StopIteration:
arrow = Arrow(source, destination, self)
Angus Lothian
committed
if arrow not in self._signal_ports:
self._signal_ports[arrow] = []
Angus Lothian
committed
self._signal_ports[arrow].append((source, destination))
self._scene.addItem(arrow)
self._arrows.append(arrow)
Angus Lothian
committed
self.update()
for signal in self._signal_ports.keys():
Angus Lothian
committed
signal.moveLine()
selected = [button.widget() for button in self._scene.selectedItems()]
Angus Lothian
committed
for button in selected:
button._toggle_button(pressed=False)
for button in self._pressed_operations:
Angus Lothian
committed
if button not in selected:
button._toggle_button(pressed=True)
Angus Lothian
committed
self._thread = dict()
self._sim_worker = dict()
for sfg, properties in self._simulation_dialog._properties.items():
self._logger.info("Simulating SFG with name: %s" % str(sfg.name))
self._sim_worker[sfg] = SimulationWorker(sfg, properties)
self._thread[sfg] = QThread()
self._sim_worker[sfg].moveToThread(self._thread[sfg])
self._thread[sfg].started.connect(self._sim_worker[sfg].start_simulation)
self._sim_worker[sfg].finished.connect(self._thread[sfg].quit)
self._sim_worker[sfg].finished.connect(self._show_plot_window)
self._sim_worker[sfg].finished.connect(self._sim_worker[sfg].deleteLater)
self._thread[sfg].finished.connect(self._thread[sfg].deleteLater)
self._thread[sfg].start()
def _show_plot_window(self, sim: Simulation):
self._plot[sim] = PlotWindow(sim.results, sfg_name=sim.sfg.name)
Angus Lothian
committed
def simulate_sfg(self, event=None) -> None:
self._simulation_dialog = SimulateSFGWindow(self)
Angus Lothian
committed
for _, sfg in self._sfg_dict.items():
self._simulation_dialog.add_sfg_to_dialog(sfg)
Angus Lothian
committed
Angus Lothian
committed
# Wait for input to dialog.
# Kinda buggy because of the separate window in the same thread.
self._simulation_dialog.simulate.connect(self._simulate_sfg)
Angus Lothian
committed
def display_faq_page(self, event=None) -> None:
if self._faq_page is None:
self._faq_page = FaqWindow(self)
Angus Lothian
committed
def display_about_page(self, event=None) -> None:
if self._about_page is None:
self._about_page = AboutWindow(self)
Angus Lothian
committed
def display_keybindings_page(self, event=None) -> None:
if self._keybindings_page is None:
self._keybindings_page = KeybindingsWindow(self)
self._keybindings_page.show()
Angus Lothian
committed
def start_editor(sfg: Optional[SFG] = None):
Angus Lothian
committed
app = QApplication(sys.argv)
window = MainWindow()
if sfg:
window._load_sfg(sfg)
Angus Lothian
committed
window.show()
sys.exit(app.exec_())
if __name__ == "__main__":