Merge pull request #119 from robertbasic/feature/projects

Feature/projects. Resolves #101

Author: robertbasic

pugdebug/gui/forms.py

@@ -0,0 +1,89 @@
+# -*- coding: utf-8 -*-
+
+"""
+    pugdebug - a standalone PHP debugger
+    =========================
+    copyright: (c) 2015 Robert Basic
+    license: GNU GPL v3, see LICENSE for more details
+"""
+
+__author__ = "robertbasic"
+
+from PyQt5.QtWidgets import (QLineEdit, QFormLayout, QSpinBox, QCheckBox,
+                             QGroupBox)
+
+
+class PugdebugSettingsForm():
+
+    def __init__(self):
+        # Construct the widgets
+        self.widgets = {
+            'path/project_root': QLineEdit(),
+            'path/path_mapping': QLineEdit(),
+            'debugger/host': QLineEdit(),
+            'debugger/port_number': QSpinBox(),
+            'debugger/idekey': QLineEdit(),
+            'debugger/break_at_first_line': QCheckBox("Break at first line"),
+            'debugger/max_depth': QLineEdit(),
+            'debugger/max_children': QLineEdit(),
+            'debugger/max_data': QLineEdit(),
+        }
+
+        # Widget settings
+        self.widgets['debugger/port_number'].setRange(1, 65535)
+
+        self.setup_path_widgets()
+        self.setup_debugger_widgets()
+
+    def setup_path_widgets(self):
+        path_layout = QFormLayout()
+        path_layout.addRow("Root:", self.widgets['path/project_root'])
+        path_layout.addRow("Maps from:", self.widgets['path/path_mapping'])
+
+        self.path_group = QGroupBox("Path")
+        self.path_group.setLayout(path_layout)
+
+    def setup_debugger_widgets(self):
+        debugger_layout = QFormLayout()
+        debugger_layout.addRow("Host", self.widgets['debugger/host'])
+        debugger_layout.addRow("Port", self.widgets['debugger/port_number'])
+        debugger_layout.addRow("IDE Key", self.widgets['debugger/idekey'])
+        debugger_layout.addRow(
+            "",
+            self.widgets['debugger/break_at_first_line']
+        )
+        debugger_layout.addRow("Max depth", self.widgets['debugger/max_depth'])
+        debugger_layout.addRow(
+            "Max children",
+            self.widgets['debugger/max_children']
+        )
+        debugger_layout.addRow("Max data", self.widgets['debugger/max_data'])
+
+        self.debugger_group = QGroupBox("Debugger")
+        self.debugger_group.setLayout(debugger_layout)
+
+    def set_widget_value(self, widget, value):
+        """A generic method which can set the value of any of the used widgets.
+        """
+        if isinstance(widget, QLineEdit):
+            widget.setText(value)
+        elif isinstance(widget, QSpinBox):
+            widget.setValue(int(value))
+        elif isinstance(widget, QCheckBox):
+            widget.setCheckState(int(value))
+        else:
+            name = type(widget).__name__
+            raise Exception("Don't know how to set a value for %s" % name)
+
+    def get_widget_value(self, widget):
+        """A generic method which can set the value of any of the used widgets.
+        """
+        if isinstance(widget, QLineEdit):
+            return widget.text()
+        elif isinstance(widget, QSpinBox):
+            return widget.value()
+        elif isinstance(widget, QCheckBox):
+            return widget.checkState()
+        else:
+            name = type(widget).__name__
+            raise Exception("Don't know how to get a value for %s" % name)

pugdebug/gui/main_window.py

@@ -9,13 +9,15 @@
 
 __author__ = "robertbasic"
 
-from PyQt5.QtCore import Qt
+from PyQt5.QtCore import Qt, pyqtSignal
 from PyQt5.QtWidgets import (QMainWindow, QToolBar, QMenuBar, QDockWidget,
                              QAction)
 from PyQt5.QtGui import QFont, QKeySequence
 
 from pugdebug.gui.file_browser import PugdebugFileBrowser
 from pugdebug.gui.settings import PugdebugSettingsWindow
+from pugdebug.gui.projects import (PugdebugNewProjectWindow,
+                                   PugdebugProjectsBrowser)
 from pugdebug.gui.documents import PugdebugDocumentViewer
 from pugdebug.gui.variables import PugdebugVariableViewer
 from pugdebug.gui.stacktraces import PugdebugStacktraceViewer
@@ -27,6 +29,8 @@
 
 class PugdebugMainWindow(QMainWindow):
 
+    new_project_created_signal = pyqtSignal(str)
+
     def __init__(self):
         super(PugdebugMainWindow, self).__init__()
         self.setObjectName("pugdebug")
@@ -36,7 +40,9 @@ def __init__(self):
             self.restoreGeometry(get_setting("window/geometry"))
 
         self.file_browser = PugdebugFileBrowser()
+        self.projects_browser = PugdebugProjectsBrowser()
         self.settings_window = PugdebugSettingsWindow(self)
+        self.new_project_window = PugdebugNewProjectWindow(self)
         self.document_viewer = PugdebugDocumentViewer()
         self.variable_viewer = PugdebugVariableViewer()
         self.breakpoint_viewer = PugdebugBreakpointViewer()
@@ -60,6 +66,8 @@ def setup_gui_elements(self):
         self.setup_fonts()
         self.setup_docks()
 
+        self.setup_file_actions()
+
         self.setup_actions()
         self.toggle_actions(False)
 
@@ -85,6 +93,12 @@ def setup_docks(self):
             Qt.LeftDockWidgetArea
         )
 
+        self.__add_dock_widget(
+            self.projects_browser,
+            "Projects Browser",
+            Qt.LeftDockWidgetArea
+        )
+
         self.__add_dock_widget(
             self.variable_viewer,
             "Variables",
@@ -109,6 +123,29 @@ def setup_docks(self):
             Qt.BottomDockWidgetArea
         )
 
+    def setup_file_actions(self):
+        self.new_project_action = QAction("&New project", self)
+        self.new_project_action.setToolTip("Create a new project (Ctrl+N)")
+        self.new_project_action.setStatusTip(
+            "Create a new project. Shortcut: Ctrl+N"
+        )
+        self.new_project_action.setShortcut(QKeySequence("Ctrl+N"))
+        self.new_project_action.triggered.connect(self.new_project_window.exec)
+
+        self.show_settings_action = QAction("&Settings", self)
+        self.show_settings_action.setToolTip("Show settings (Ctrl+S)")
+        self.show_settings_action.setStatusTip(
+            "Show the settings window. Shortcut: Ctrl+S"
+        )
+        self.show_settings_action.setShortcut(QKeySequence("Ctrl+S"))
+        self.show_settings_action.triggered.connect(self.settings_window.exec)
+
+        self.quit_action = QAction("&Quit", self)
+        self.quit_action.setToolTip("Exit the application (Alt+F4)")
+        self.quit_action.setStatusTip("Exit the application. Shortcut: Alt+F4")
+        self.quit_action.setShortcut(QKeySequence("Alt+F4"))
+        self.quit_action.triggered.connect(self.close)
+
     def setup_actions(self):
         self.start_debug_action = QAction("Start", self)
         self.start_debug_action.setToolTip("Start server (F1)")
@@ -167,17 +204,6 @@ def setup_actions(self):
         )
         self.step_out_action.setShortcut(QKeySequence("F8"))
 
-        self.show_settings_action = QAction("&Settings", self)
-        self.show_settings_action.setToolTip("Show settings")
-        self.show_settings_action.setStatusTip("Show the settings window.")
-        self.show_settings_action.triggered.connect(self.settings_window.exec)
-
-        self.quit_action = QAction("&Quit", self)
-        self.quit_action.setToolTip("Exit the application (Alt+F4)")
-        self.quit_action.setStatusTip("Exit the application. Shortcut: Alt+F4")
-        self.quit_action.setShortcut(QKeySequence("Alt+F4"))
-        self.quit_action.triggered.connect(self.close)
-
     def setup_toolbar(self):
         toolbar = QToolBar("Main Toolbar")
         toolbar.setObjectName("main-toolbar")
@@ -197,6 +223,7 @@ def setup_menubar(self):
         menu_bar = QMenuBar()
 
         file_menu = menu_bar.addMenu("&File")
+        file_menu.addAction(self.new_project_action)
         file_menu.addAction(self.show_settings_action)
         file_menu.addSeparator()
         file_menu.addAction(self.quit_action)
@@ -231,6 +258,9 @@ def toggle_actions(self, enabled):
     def get_file_browser(self):
         return self.file_browser
 
+    def get_projects_browser(self):
+        return self.projects_browser
+
     def get_settings(self):
         return self.settings_window
 

pugdebug/gui/projects.py

@@ -0,0 +1,116 @@
+# -*- coding: utf-8 -*-
+
+"""
+    pugdebug - a standalone PHP debugger
+    =========================
+    copyright: (c) 2015 Robert Basic
+    license: GNU GPL v3, see LICENSE for more details
+"""
+
+__author__ = "robertbasic"
+
+from PyQt5.QtCore import Qt
+from PyQt5.QtWidgets import (QDialog, QPushButton, QVBoxLayout, QHBoxLayout,
+                             QFormLayout, QLineEdit, QTreeView, QAction, QMenu)
+from PyQt5.QtGui import QIcon
+
+from pugdebug.gui.forms import PugdebugSettingsForm
+from pugdebug.models.projects import PugdebugProject
+from pugdebug.models.settings import get_default_setting, add_project
+
+
+class PugdebugNewProjectWindow(QDialog):
+
+    def __init__(self, parent):
+        super(PugdebugNewProjectWindow, self).__init__(parent)
+
+        self.parent = parent
+
+        self.form = PugdebugSettingsForm()
+
+        self.project_name = QLineEdit()
+
+        self.accepted.connect(self.create_new_project)
+
+        self.setup_layout()
+
+        self.load_settings()
+
+    def setup_layout(self):
+        project_name_layout = QFormLayout()
+        project_name_layout.addRow("Project name:", self.project_name)
+
+        # Buttons
+        save_button = QPushButton("&Save")
+        save_button.clicked.connect(self.accept)
+
+        cancel_button = QPushButton("&Cancel")
+        cancel_button.clicked.connect(self.reject)
+
+        button_layout = QHBoxLayout()
+        button_layout.addWidget(cancel_button)
+        button_layout.addWidget(save_button)
+
+        box_layout = QVBoxLayout()
+        box_layout.addLayout(project_name_layout)
+        box_layout.addWidget(self.form.path_group)
+        box_layout.addWidget(self.form.debugger_group)
+        box_layout.addLayout(button_layout)
+
+        self.setLayout(box_layout)
+
+    def create_new_project(self):
+        project_name = self.project_name.text()
+        project = PugdebugProject(project_name)
+
+        for name, widget in self.form.widgets.items():
+            value = self.form.get_widget_value(widget)
+            project.setValue(name, value)
+
+        project_name = project.get_project_name()
+
+        add_project(project_name)
+
+        self.parent.new_project_created_signal.emit(project_name)
+
+    def load_settings(self):
+        """Load default settings into the form"""
+        for name, widget in self.form.widgets.items():
+            value = get_default_setting(name)
+            self.form.set_widget_value(widget, value)
+
+
+class PugdebugProjectsBrowser(QTreeView):
+
+    def __init__(self):
+        super(PugdebugProjectsBrowser, self).__init__()
+
+        self.delete_action = QAction(
+            QIcon.fromTheme('list-remove'),
+            "&Delete",
+            self
+        )
+        self.delete_action.triggered.connect(self.handle_delete_action)
+
+        self.setContextMenuPolicy(Qt.CustomContextMenu)
+        self.customContextMenuRequested.connect(self.show_context_menu)
+
+    def load_projects(self):
+        model = self.model()
+        model.load_projects()
+
+    def show_context_menu(self, point):
+        context_menu = QMenu(self)
+
+        if self.indexAt(point):
+            context_menu.addAction(self.delete_action)
+
+        point = self.mapToGlobal(point)
+        context_menu.popup(point)
+
+    def handle_delete_action(self):
+        for index in self.selectedIndexes():
+            project = self.model().get_project_by_index(index)
+            project.delete()
+
+        self.load_projects()