Merge pull request #20 from sandbox-science/refactor

Refactor Codebase for Modularity, Correctness, and Maintainability

Author: chrisdedman

CMakeLists.txt

@@ -60,6 +60,7 @@ add_executable(${TARGET_NAME}
     include/CodeEditor.h
     include/Syntax.h
     include/Tree.h
+    include/LineNumberArea.h
 )
 
 qt_add_resources(APP_RESOURCES resources.qrc)

README.md

@@ -27,9 +27,9 @@ Please, check the [wiki](https://github.com/sandbox-science/CodeAstra/wiki) for
 - [x] Basic text editing
   - [x] Open a file
   - [x] Save file
-  - [ ] Create a new file
-- [ ] File tree navigation
-- [ ] Syntax highlighting
+  - [ ] Create a new file ~ in progress
+- [x] File tree navigation
+- [ ] Syntax highlighting ~ in progress
 - [ ] Plugin system
 
 ## To-Do

include/CodeEditor.h

@@ -1,5 +1,4 @@
-#ifndef CODEEDITOR_H
-#define CODEEDITOR_H
+#pragma once
 
 #include <QPlainTextEdit>
 #include <QKeyEvent>
@@ -20,6 +19,9 @@ class CodeEditor : public QPlainTextEdit
     void lineNumberAreaPaintEvent(QPaintEvent *event);
     int lineNumberAreaWidth();
 
+signals:
+    void statusMessageChanged(const QString &message);
+
 protected:
     void keyPressEvent(QKeyEvent *event) override;
     void resizeEvent(QResizeEvent *event) override;
@@ -30,7 +32,5 @@ private slots:
     void updateLineNumberArea(const QRect &rect, int dy);
 
 private:
-    QWidget *lineNumberArea;
-};
-
-#endif // CODEEDITOR_H
+    QWidget *m_lineNumberArea;
+};

include/LineNumberArea.h

@@ -1,5 +1,4 @@
-#ifndef LINENUMBER_H
-#define LINENUMBER_H
+#pragma once
 
 #include "CodeEditor.h"
 
@@ -10,21 +9,19 @@
 class LineNumberArea : public QWidget
 {
 public:
-  LineNumberArea(CodeEditor *editor) : QWidget(editor), codeEditor(editor) {}
+    LineNumberArea(CodeEditor *editor) : QWidget(editor), codeEditor(editor) {}
 
-  QSize sizeHint() const override
-  {
-    return QSize(codeEditor->lineNumberAreaWidth(), 0);
-  }
+    QSize sizeHint() const override
+    {
+        return QSize(codeEditor->lineNumberAreaWidth(), 0);
+    }
 
 protected:
-  void paintEvent(QPaintEvent *event) override
-  {
-    codeEditor->lineNumberAreaPaintEvent(event);
-  }
+    void paintEvent(QPaintEvent *event) override
+    {
+        codeEditor->lineNumberAreaPaintEvent(event);
+    }
 
 private:
-  CodeEditor *codeEditor;
-};
-
-#endif // LINENUMBER_H
+    CodeEditor *codeEditor;
+};

include/MainWindow.h

@@ -1,45 +1,46 @@
-#ifndef MAINWINDOW_H
-#define MAINWINDOW_H
-
-#include "CodeEditor.h"
-#include "Syntax.h"
-#include "Tree.h"
-
-#include <QMainWindow>
-#include <QMenu>
-#include <QAction>
-#include <QIcon>
-#include <QKeySequence>
-#include <QDesktopServices>
-
-class MainWindow : public QMainWindow
-{
-    Q_OBJECT
-
-public:
-    explicit MainWindow(QWidget *parent = nullptr);
-    virtual ~MainWindow();
-    void loadFileInEditor(const QString &filePath);
-
-private slots:
-    void newFile();
-    void openFile();
-    void saveFile();
-    void saveFileAs();
-    void showAbout();
-
-private:
-    void createMenuBar();
-    void createFileActions(QMenu *fileMenu);
-    void createHelpActions(QMenu *helpMenu);
-    void createAppActions(QMenu *appMenu);
-    QAction *createAction(const QIcon &icon, const QString &text,
-                          const QKeySequence &shortcut, const QString &statusTip,
-                          void (MainWindow::*slot)());
-    CodeEditor *editor;
-    QString currentFileName;
-    Syntax *syntax;
-    Tree *tree;
-};
-
-#endif // MAINWINDOW_H
+#pragma once
+
+#include <QMainWindow>
+#include <QMenu>
+#include <QAction>
+#include <QIcon>
+#include <QKeySequence>
+#include <memory>
+#include <QFile>
+
+class CodeEditor;
+class Syntax;
+class Tree;
+
+class MainWindow : public QMainWindow
+{
+    Q_OBJECT
+
+public:
+    explicit MainWindow(QWidget *parent = nullptr);
+    virtual ~MainWindow();
+    void loadFileInEditor(const QString &filePath);
+    // Initialize the file tree view and set it as the central widget
+    // of the main window, alongside the code editor
+    void initTree();
+
+private slots:
+    void newFile();
+    void openFile();
+    void saveFile();
+    void saveFileAs();
+    void showAbout();
+
+private:
+    void createMenuBar();
+    void createFileActions(QMenu *fileMenu);
+    void createHelpActions(QMenu *helpMenu);
+    void createAppActions(QMenu *appMenu);
+    QAction *createAction(const QIcon &icon, const QString &text,
+                          const QKeySequence &shortcut, const QString &statusTip,
+                          void (MainWindow::*slot)());
+    std::unique_ptr<CodeEditor> m_editor;
+    std::unique_ptr<Syntax> m_syntax;
+    std::unique_ptr<Tree> m_tree;
+    QString m_currentFileName;
+};

include/Syntax.h

@@ -1,5 +1,4 @@
-#ifndef SYNTAX_H
-#define SYNTAX_H
+#pragma once
 
 #include <QTextCharFormat>
 #include <QRegularExpression>
@@ -19,19 +18,26 @@ class Syntax : public QSyntaxHighlighter
 private:
     struct SyntaxRule
     {
-        QRegularExpression pattern;
-        QTextCharFormat format;
+        QRegularExpression m_pattern;
+        QTextCharFormat m_format;
     };
-    QList<SyntaxRule> syntaxRules;
+    QVector<SyntaxRule> m_syntaxRules;
 
-    QTextCharFormat keywordFormat;
-    QTextCharFormat singleLineCommentFormat;
-    QTextCharFormat quotationMark;
-    QTextCharFormat functionFormat;
-    QTextCharFormat parenthesisFormat;
-    QTextCharFormat charFormat;
+    QTextCharFormat m_keywordFormat;
+    QTextCharFormat m_singleLineCommentFormat;
+    QTextCharFormat m_quotationMark;
+    QTextCharFormat m_functionFormat;
+    QTextCharFormat m_parenthesisFormat;
+    QTextCharFormat m_charFormat;
+    QTextCharFormat m_iterationFormat;
 
     void addPattern(const QString &pattern, const QTextCharFormat &format);
-};
 
-#endif // SYNTAX_H
+    // Initialization functions for different syntax highlighting rules
+    void initKeywordRules();
+    void initCommentRules();
+    void initFunctionRules();
+    void initParenthesisRules();
+    void initCharRules();
+    void initQuotationRules();
+};

include/Tree.h

@@ -1,31 +1,33 @@
-#ifndef TREE_H
-#define TREE_H
+#pragma once
 
 #include <QSplitter>
-#include <QTreeView>
-#include <QFileSystemModel>
 #include <QObject>
+#include <memory>
 
-class MainWindow; // Forward declaration
+// Forward declarations
+class MainWindow;
+class QTreeView;
+class QFileSystemModel;
+class QFileIconProvider;
 
 class Tree : public QObject
 {
     Q_OBJECT
 
 public:
-    Tree(QSplitter *splitter, MainWindow *mainWindow);
+    explicit Tree(QSplitter *splitter, MainWindow *mainWindow);
     ~Tree();
 
 private:
     void showContextMenu(const QPoint &pos);
     void setupModel();
     void setupTree();
     void openFile(const QModelIndex &index);
-    QString getDirectoryPath();
+    QString getDirectoryPath() const;
 
-    QFileSystemModel *model;
-    QTreeView *tree;
-    MainWindow *mainWindow;
-};
+    std::unique_ptr<QFileIconProvider> m_iconProvider;
+    std::unique_ptr<QFileSystemModel> m_model;
+    std::unique_ptr<QTreeView> m_tree;
 
-#endif // TREE_H
+    MainWindow *m_mainWindow;
+};

src/CodeEditor.cpp

@@ -4,11 +4,12 @@
 
 #include <QPainter>
 #include <QTextBlock>
+#include <QStatusBar>
 
-CodeEditor::CodeEditor(QWidget *parent) : QPlainTextEdit(parent)
+CodeEditor::CodeEditor(QWidget *parent)
+    : QPlainTextEdit(parent),
+      m_lineNumberArea(new LineNumberArea(this))
 {
-    lineNumberArea = new LineNumberArea(this);
-
     connect(this, &CodeEditor::blockCountChanged, this, &CodeEditor::updateLineNumberAreaWidth);
     connect(this, &CodeEditor::updateRequest, this, &CodeEditor::updateLineNumberArea);
     connect(this, &CodeEditor::cursorPositionChanged, this, &CodeEditor::highlightCurrentLine);
@@ -33,6 +34,7 @@ void CodeEditor::keyPressEvent(QKeyEvent *event)
         {
         case Qt::Key_I:
             mode = INSERT;
+            emit statusMessageChanged("Insert mode activated");
             break;
         case Qt::Key_A:
             moveCursor(QTextCursor::Left);
@@ -46,14 +48,22 @@ void CodeEditor::keyPressEvent(QKeyEvent *event)
         case Qt::Key_W:
             moveCursor(QTextCursor::Up);
             break;
-        case Qt::Key_Escape:
-            mode = NORMAL;
+        default:
+            emit statusMessageChanged("Insert mode is not active. Press 'i' to enter insert mode.");
             break;
         }
     }
-    else
+    else if (mode == INSERT)
     {
-        QPlainTextEdit::keyPressEvent(event);
+        if (event->key() == Qt::Key_Escape)
+        {
+            mode = NORMAL;
+            emit statusMessageChanged("Normal mode activated. Press 'escape' to return to normal mode.");
+        }
+        else
+        {
+            QPlainTextEdit::keyPressEvent(event);
+        }
     }
 }
 
@@ -82,11 +92,11 @@ void CodeEditor::updateLineNumberArea(const QRect &rect, int dy)
 {
     if (dy)
     {
-        lineNumberArea->scroll(0, dy);
+        m_lineNumberArea->scroll(0, dy);
     }
     else
     {
-        lineNumberArea->update(0, rect.y(), lineNumberArea->width(), rect.height());
+        m_lineNumberArea->update(0, rect.y(), m_lineNumberArea->width(), rect.height());
     }
 
     if (rect.contains(viewport()->rect()))
@@ -100,7 +110,7 @@ void CodeEditor::resizeEvent(QResizeEvent *e)
     QPlainTextEdit::resizeEvent(e);
 
     QRect cr = contentsRect();
-    lineNumberArea->setGeometry(QRect(cr.left(), cr.top(), lineNumberAreaWidth(), cr.height()));
+    m_lineNumberArea->setGeometry(QRect(cr.left(), cr.top(), lineNumberAreaWidth(), cr.height()));
 }
 
 void CodeEditor::highlightCurrentLine()
@@ -128,13 +138,13 @@ void CodeEditor::highlightCurrentLine()
 
 void CodeEditor::lineNumberAreaPaintEvent(QPaintEvent *event)
 {
-    QPainter painter(lineNumberArea);
+    QPainter painter(m_lineNumberArea);
 
     // Match the background color of the editor
     painter.fillRect(event->rect(), palette().color(QPalette::Base));
 
     // Draw a separating line between the number area and the text editor
-    int separatorX = lineNumberArea->width() - 4;
+    int separatorX = m_lineNumberArea->width() - 4;
     painter.drawLine(separatorX, event->rect().top(), separatorX, event->rect().bottom());
 
     QTextBlock block = firstVisibleBlock();
@@ -152,7 +162,7 @@ void CodeEditor::lineNumberAreaPaintEvent(QPaintEvent *event)
             QString number = QString::number(blockNumber + 1);
             painter.setPen(Qt::darkGray);
 
-            painter.drawText(0, top + padding, lineNumberArea->width(), lineHeight,
+            painter.drawText(0, top + padding, m_lineNumberArea->width(), lineHeight,
                              Qt::AlignCenter, number);
         }