Merge pull request #118 from Martian-Technologies/ciuicn-keybinds

Ciuicn keybinds

Author: ItchyTrack

src/gui/circuitViewWidget.cpp

@@ -17,13 +17,13 @@
 #include "circuitViewWidget.h"
 #include "backend/backend.h"
 
-CircuitViewWidget::CircuitViewWidget(QWidget* parent, Ui::CircuitViewUi* ui, CircuitFileManager* fileManager) :
-	QWidget(parent), mouseControls(false), circuitSelector(ui->CircuitSelector), evaluatorSelector(ui->EvaluatorSelector), fileManager(fileManager) {
+CircuitViewWidget::CircuitViewWidget(QWidget* parent, Ui::CircuitViewUi* ui, CircuitFileManager* fileManager, KeybindManager* keybindManager) :
+	QWidget(parent), mouseControls(false), circuitSelector(ui->CircuitSelector), evaluatorSelector(ui->EvaluatorSelector), fileManager(fileManager), keybindManager(keybindManager) {
 
 	// create circuitView
 	renderer = std::make_unique<QtRenderer>();
 	circuitView = std::make_unique<CircuitView>(renderer.get());
-	
+    
 	// qt settings
 	setFocusPolicy(Qt::StrongFocus);
 	grabGesture(Qt::PinchGesture);
@@ -46,9 +46,25 @@ CircuitViewWidget::CircuitViewWidget(QWidget* parent, Ui::CircuitViewUi* ui, Cir
 	renderer->resize(w, h);
 	renderer->initializeTileSet(":logicTiles.png");
 
+	// create keybind shortcuts and connect them
+	connect(keybindManager->createShortcut("Save", this), &QShortcut::activated, this, &CircuitViewWidget::save);
+	connect(keybindManager->createShortcut("Undo", this), &QShortcut::activated, this, [this]() { 
+		circuitView->getCircuit()->undo(); 
+	});
+	connect(keybindManager->createShortcut("Redo", this), &QShortcut::activated, this, [this]() { 
+		circuitView->getCircuit()->redo(); 
+	});
+	connect(keybindManager->createShortcut("BlockRotateCCW", this), &QShortcut::activated, this, [this]() { 
+		circuitView->getEventRegister().doEvent(Event("tool rotate block ccw"));
+	});
+	connect(keybindManager->createShortcut("BlockRotateCW", this), &QShortcut::activated, this, [this]() { 
+		circuitView->getEventRegister().doEvent(Event("tool rotate block cw"));
+	});
+  connect(keybindManager->createShortcut("ToggleInteractive", this), &QShortcut::activated, this, [this]() { 
+		circuitView->toggleInteractive(); 
+	});
+	
 	// connect buttons and actions
-	QShortcut* saveShortcut = new QShortcut(QKeySequence("Ctrl+S"), this);
-	connect(saveShortcut, &QShortcut::activated, this, &CircuitViewWidget::save);
 	connect(ui->StartSim, &QPushButton::clicked, this, &CircuitViewWidget::setSimState);
 	connect(ui->UseSpeed, &QCheckBox::checkStateChanged, this, &CircuitViewWidget::simUseSpeed);
 	connect(ui->Speed, &QDoubleSpinBox::valueChanged, this, &CircuitViewWidget::setSimSpeed);
@@ -229,29 +245,6 @@ void CircuitViewWidget::wheelEvent(QWheelEvent* event) {
 	}
 }
 
-void CircuitViewWidget::keyPressEvent(QKeyEvent* event) {
-	if (/*event->modifiers() & Qt::MetaModifier && */event->key() == Qt::Key_Z) {
-		circuitView->getCircuit()->undo();
-		event->accept();
-	} else if (/*event->modifiers() & Qt::MetaModifier && */event->key() == Qt::Key_Y) {
-		circuitView->getCircuit()->redo();
-		event->accept();
-	} else if (event->key() == Qt::Key_Q) {
-		if (circuitView->getEventRegister().doEvent(Event("tool rotate block ccw"))) {
-			event->accept();
-		}
-	} else if (event->key() == Qt::Key_E) {
-		if (circuitView->getEventRegister().doEvent(Event("tool rotate block cw"))) {
-			event->accept();
-		}
-	} else if (event->key() == Qt::Key_I) {
-		circuitView->toggleInteractive();
-		event->accept();
-	}
-}
-
-void CircuitViewWidget::keyReleaseEvent(QKeyEvent* event) { }
-
 void CircuitViewWidget::mousePressEvent(QMouseEvent* event) {
 	if (event->button() == Qt::LeftButton) {
 		if (QGuiApplication::keyboardModifiers().testFlag(Qt::AltModifier)) {
@@ -295,13 +288,14 @@ void CircuitViewWidget::leaveEvent(QEvent* event) {
 
 // save current circuit view widget we are viewing. Right now only works if it is the only widget in application.
 void CircuitViewWidget::save() {
-    std::cout << "Trying to save\n";
-    if (fileManager) {
-        QString filePath = QFileDialog::getSaveFileName(this, "Save Circuit", "", "Circuit Files (*.cir);;All Files (*)");
-        if (!filePath.isEmpty()) {
-            fileManager->saveToFile(filePath.toStdString(), circuitView->getCircuit());
-        }
-    }
+	logInfo("Trying to save Circuit");
+	if (fileManager) {
+		QString filePath = QFileDialog::getSaveFileName(this, "Save Circuit", "", "Circuit Files (*.cir);;All Files (*)");
+		if (!filePath.isEmpty()) {
+			fileManager->saveToFile(filePath.toStdString(), circuitView->getCircuit());
+			logInfo("Successfully saved Circuit to: " + filePath.toStdString());
+		}
+	}
 }
 
 // for drag and drop load directly onto this circuit view widget

src/gui/circuitViewWidget.h

@@ -12,13 +12,14 @@ class QTimer;
 #include "computerAPI/circuits/circuitFileManager.h"
 #include "circuitView/renderer/qtRenderer.h"
 #include "circuitView/circuitView.h"
+#include "keybinds/keybindManager.h"
 #include "ui_circuitViewUi.h"
 #include "util/vec2.h"
 
 class CircuitViewWidget : public QWidget {
 	Q_OBJECT
 public:
-    CircuitViewWidget(QWidget* parent, Ui::CircuitViewUi* ui, CircuitFileManager* fileManager);
+    CircuitViewWidget(QWidget* parent, Ui::CircuitViewUi* ui, CircuitFileManager* fileManager, KeybindManager* keybindManager);
 
 	// setup
 	inline CircuitView* getCircuitView() { return circuitView.get(); }
@@ -37,8 +38,6 @@ class CircuitViewWidget : public QWidget {
 	void paintEvent(QPaintEvent* event) override;
 	void resizeEvent(QResizeEvent* event) override;
 	void wheelEvent(QWheelEvent* event) override;
-	void keyPressEvent(QKeyEvent* event) override;
-	void keyReleaseEvent(QKeyEvent* event) override;
 	void mousePressEvent(QMouseEvent* event) override;
 	void mouseReleaseEvent(QMouseEvent* event) override;
 	void mouseMoveEvent(QMouseEvent* event) override;
@@ -58,6 +57,8 @@ class CircuitViewWidget : public QWidget {
 	std::unique_ptr<QtRenderer> renderer;
     CircuitFileManager* fileManager;
 
+	KeybindManager* keybindManager;
+
 	// update loop
 	QTimer* updateLoopTimer;
 	const float updateInterval = 0.008f;

src/gui/mainWindow.cpp

@@ -25,6 +25,14 @@ MainWindow::MainWindow(KDDockWidgets::MainWindowOptions options)
 	setWindowTitle(tr("Gatality"));
 	setWindowIcon(QIcon(":/gateIcon.ico"));
 
+	// set default keybinds
+	keybindManager.setKeybind("Save", "Ctrl+S");
+	keybindManager.setKeybind("Undo", "Z");
+	keybindManager.setKeybind("Redo", "Y");
+	keybindManager.setKeybind("BlockRotateCCW", "Q");
+	keybindManager.setKeybind("BlockRotateCW", "E");
+	keybindManager.setKeybind("ToggleInteractive", "I");
+
 	// create default circuit and evaluator
     logInfo("Creating default circuitViewWidget");
 	circuit_id_t id = backend.createCircuit();
@@ -303,7 +311,7 @@ CircuitViewWidget* MainWindow::openNewCircuitViewWindow() {
 	QWidget* w = new QWidget();
 	Ui::CircuitViewUi* circuitViewUi = new Ui::CircuitViewUi();
 	circuitViewUi->setupUi(w);
-	CircuitViewWidget* circuitViewWidget = new CircuitViewWidget(w, circuitViewUi, &circuitFileManager);
+	CircuitViewWidget* circuitViewWidget = new CircuitViewWidget(w, circuitViewUi, &circuitFileManager, &keybindManager);
 	backend.linkCircuitView(circuitViewWidget->getCircuitView());
 	circuitViews.push_back(circuitViewWidget);
 	circuitViewUi->verticalLayout_2->addWidget(circuitViewWidget);

src/gui/mainWindow.h

@@ -8,6 +8,8 @@ class QGraphicsScene;
 #include <kddockwidgets/DockWidget.h>
 
 #include "computerAPI/circuits/circuitFileManager.h"
+#include "circuitView/renderer/qtRenderer.h"
+#include "keybinds/keybindManager.h"
 #include "backend/backend.h"
 
 namespace Ui {
@@ -48,6 +50,7 @@ class MainWindow : public KDDockWidgets::QtWidgets::MainWindow {
     QMenu* loadIntoSubMenu;
     QMenu* loadMergedSubMenu;
 	Backend backend;
+	KeybindManager keybindManager;
 	std::vector<CircuitViewWidget*> circuitViews;
     std::unordered_map<QWidget*, CircuitViewWidget*> activeWidgets;
     CircuitFileManager circuitFileManager;

src/keybinds/keybindManager.cpp

@@ -0,0 +1,35 @@
+#include "keybindManager.h"
+
+void KeybindManager::setKeybind(const std::string& bindName, const std::string& keyString) {
+  QKeySequence keySequence = QKeySequence(QString::fromStdString(keyString));
+  auto keybind_itr = keybinds.find(bindName);
+  if(keybind_itr == keybinds.end()) {
+    // add a new keybind if it doesn't exist
+    keybinds.insert({bindName, keySequence});
+  } else {
+    // change the old keybind if it already exists
+    keybind_itr->second = keySequence;
+    // update this keybind's QShortcuts to use the new key sequence
+    auto shortcut_itr = shortcuts.find(bindName);
+    if(shortcut_itr != shortcuts.end()) {
+      for(auto shortcut : shortcut_itr->second) {
+        shortcut->setKey(keySequence);
+      }
+    }
+  }
+}
+
+QShortcut* KeybindManager::createShortcut(const std::string& bindName, QWidget* parent) {
+  // try to find this keybind's key sequence
+  QKeySequence keySequence;
+  auto keybind_itr = keybinds.find(bindName);
+  if(keybind_itr == keybinds.end()) {
+    logWarning("No keybind found matching bindname: " + bindName);
+    return nullptr;
+  } 
+  keySequence = keybind_itr->second;
+  // create a new QShortcut that is activated by this keybind's key sequence
+  QShortcut* shortcut = new QShortcut(keySequence, parent);
+  shortcuts[bindName].push_back(shortcut);
+  return shortcut;
+}

src/keybinds/keybindManager.h

@@ -0,0 +1,19 @@
+#ifndef keybindManager_h
+#define keybindManager_h
+
+#include <QKeySequence>
+#include <QShortcut>
+#include <QWidget>
+
+class KeybindManager {
+public:
+	// give a keybind a name and set/reset the key sequence that triggers it
+  void setKeybind(const std::string& bindName, const std::string& keyString);
+  // create a QShortcut that is activated by its keybind's key sequence
+  QShortcut* createShortcut(const std::string& bindName, QWidget* parent);
+private:
+  std::unordered_map<std::string, QKeySequence> keybinds;
+  std::unordered_map<std::string, std::vector<QShortcut*>> shortcuts;
+};
+
+#endif /* keybindManager_h */