[Refactor] Consistently prefix member variables with 'm_' in CodeEditor, LineNumberArea, MainWindow, and Syntax classes for improved readability

Author: chrisdedman

include/CodeEditor.h

@@ -29,5 +29,5 @@ private slots:
     void updateLineNumberArea(const QRect &rect, int dy);
 
 private:
-    QWidget *lineNumberArea;
+    QWidget *m_lineNumberArea;
 };

include/LineNumberArea.h

@@ -9,19 +9,19 @@
 class LineNumberArea : public QWidget
 {
 public:
-    LineNumberArea(CodeEditor *editor) : QWidget(editor), m_codeEditor(editor) {}
+    LineNumberArea(CodeEditor *editor) : QWidget(editor), codeEditor(editor) {}
 
     QSize sizeHint() const override
     {
-        return QSize(m_codeEditor->lineNumberAreaWidth(), 0);
+        return QSize(codeEditor->lineNumberAreaWidth(), 0);
     }
 
 protected:
     void paintEvent(QPaintEvent *event) override
     {
-        m_codeEditor->lineNumberAreaPaintEvent(event);
+        codeEditor->lineNumberAreaPaintEvent(event);
     }
 
 private:
-    CodeEditor *m_codeEditor;
+    CodeEditor *codeEditor;
 };

include/MainWindow.h

@@ -39,8 +39,8 @@ private slots:
     QAction *createAction(const QIcon &icon, const QString &text,
                           const QKeySequence &shortcut, const QString &statusTip,
                           void (MainWindow::*slot)());
-    std::unique_ptr<CodeEditor> editor;
-    QString currentFileName;
-    std::unique_ptr<Syntax> syntax;
-    std::unique_ptr<Tree> tree;
+    std::unique_ptr<CodeEditor> m_editor;
+    std::unique_ptr<Syntax> m_syntax;
+    std::unique_ptr<Tree> m_tree;
+    QString m_currentFileName;
 };

include/Syntax.h

@@ -18,18 +18,18 @@ class Syntax : public QSyntaxHighlighter
 private:
     struct SyntaxRule
     {
-        QRegularExpression pattern;
-        QTextCharFormat format;
+        QRegularExpression m_pattern;
+        QTextCharFormat m_format;
     };
-    QVector<SyntaxRule> syntaxRules;
-
-    QTextCharFormat keywordFormat;
-    QTextCharFormat singleLineCommentFormat;
-    QTextCharFormat quotationMark;
-    QTextCharFormat functionFormat;
-    QTextCharFormat parenthesisFormat;
-    QTextCharFormat charFormat;
-    QTextCharFormat iterationFormat;
+    QVector<SyntaxRule> m_syntaxRules;
+
+    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);
 

src/CodeEditor.cpp

@@ -7,7 +7,7 @@
 
 CodeEditor::CodeEditor(QWidget *parent)
     : QPlainTextEdit(parent),
-      lineNumberArea(new LineNumberArea(this))
+      m_lineNumberArea(new LineNumberArea(this))
 {
     connect(this, &CodeEditor::blockCountChanged, this, &CodeEditor::updateLineNumberAreaWidth);
     connect(this, &CodeEditor::updateRequest, this, &CodeEditor::updateLineNumberArea);
@@ -82,11 +82,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 +100,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 +128,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 +152,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);
         }
 

src/MainWindow.cpp

@@ -15,17 +15,17 @@
 
 MainWindow::MainWindow(QWidget *parent)
     : QMainWindow(parent),
-      editor(std::make_unique<CodeEditor>(this)),
-      syntax(std::make_unique<Syntax>(editor->document())),
-      tree(nullptr)
+      m_editor(std::make_unique<CodeEditor>(this)),
+      m_syntax(std::make_unique<Syntax>(m_editor->document())),
+      m_tree(nullptr)
 {
     setWindowTitle("CodeAstra ~ Code Editor");
 
     // Set tab width to 4 spaces
-    QFontMetrics metrics(editor->font());
+    QFontMetrics metrics(m_editor->font());
     int spaceWidth = metrics.horizontalAdvance(" ");
-    editor->setTabStopDistance(spaceWidth * 4);
-    editor->setLineWrapMode(QPlainTextEdit::NoWrap);
+    m_editor->setTabStopDistance(spaceWidth * 4);
+    m_editor->setLineWrapMode(QPlainTextEdit::NoWrap);
 
     initTree();
     createMenuBar();
@@ -39,9 +39,9 @@ void MainWindow::initTree()
     QSplitter *splitter = new QSplitter(Qt::Horizontal, this);
     setCentralWidget(splitter);
 
-    tree = std::make_unique<Tree>(splitter, this);
+    m_tree = std::make_unique<Tree>(splitter, this);
 
-    splitter->addWidget(editor.get());
+    splitter->addWidget(m_editor.get());
     splitter->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Expanding);
     splitter->setHandleWidth(5);
     splitter->setSizes(QList<int>() << 150 << 800);
@@ -164,23 +164,23 @@ void MainWindow::openFile()
 
 void MainWindow::saveFile()
 {
-    if (currentFileName.isEmpty())
+    if (m_currentFileName.isEmpty())
     {
         saveFileAs();
         return;
     }
 
-    QFile file(currentFileName);
+    QFile file(m_currentFileName);
     if (!file.open(QFile::WriteOnly | QFile::Text))
     {
         QMessageBox::warning(this, "Error", "Cannot save file: " + file.errorString());
         return;
     }
 
     QTextStream out(&file);
-    if (editor)
+    if (m_editor)
     {
-        out << editor->toPlainText();
+        out << m_editor->toPlainText();
     }
     else
     {
@@ -199,7 +199,7 @@ void MainWindow::saveFileAs()
 
     if (!fileName.isEmpty())
     {
-        currentFileName = fileName;
+        m_currentFileName = fileName;
         saveFile();
     }
 }
@@ -214,9 +214,9 @@ void MainWindow::loadFileInEditor(const QString &filePath)
     }
 
     QTextStream in(&file);
-    if (editor)
+    if (m_editor)
     {
-        editor->setPlainText(in.readAll());
+        m_editor->setPlainText(in.readAll());
     }
     else
     {
@@ -225,6 +225,6 @@ void MainWindow::loadFileInEditor(const QString &filePath)
     }
     file.close();
 
-    currentFileName = filePath;
+    m_currentFileName = filePath;
     setWindowTitle("CodeAstra ~ " + QFileInfo(filePath).fileName());
 }

src/Syntax.cpp

@@ -19,8 +19,8 @@ Syntax::Syntax(QTextDocument *parent)
 void Syntax::initKeywordRules()
 {
     // Keyword format
-    keywordFormat.setForeground(Qt::blue);
-    keywordFormat.setFontWeight(QFont::Bold);
+    m_keywordFormat.setForeground(Qt::blue);
+    m_keywordFormat.setFontWeight(QFont::Bold);
 
     QStringList keywordPatterns = {
         "\\bchar\\b", "\\bclass\\b", "\\bconst\\b",
@@ -36,77 +36,76 @@ void Syntax::initKeywordRules()
 
     for (const QString &pattern : keywordPatterns)
     {
-        addPattern(pattern, keywordFormat);
+        addPattern(pattern, m_keywordFormat);
     }
 
-    iterationFormat.setForeground(Qt::darkMagenta);
-    iterationFormat.setFontWeight(QFont::Bold);
-    QStringList iterationPatterns = {
-        "\\bfor\\b", "\\bwhile\\b", "\\bdo\\b", "\\bif\\b", "\\belse\\b"};
+    m_iterationFormat.setForeground(Qt::darkMagenta);
+    m_iterationFormat.setFontWeight(QFont::Bold);
+    QStringList iterationPatterns = {"\\bfor\\b", "\\bwhile\\b", "\\bdo\\b", "\\bif\\b", "\\belse\\b"};
     for (const QString &pattern : iterationPatterns)
     {
-        addPattern(pattern, iterationFormat);
+        addPattern(pattern, m_iterationFormat);
     }
 }
 
 void Syntax::initCommentRules()
 {
     // Single line comment format expression
-    singleLineCommentFormat.setForeground(Qt::darkGray);
-    addPattern("//[^\n]*", singleLineCommentFormat);
+    m_singleLineCommentFormat.setForeground(Qt::darkGray);
+    addPattern("//[^\n]*", m_singleLineCommentFormat);
 
     // TO-DO: Add multi-line comment support
 }
 
 void Syntax::initQuotationRules()
 {
     // Double quotation mark for string
-    quotationMark.setForeground(Qt::darkGreen);
-    addPattern("\"(\\\\.|[^\"\\\\])*\"", quotationMark);
+    m_quotationMark.setForeground(Qt::darkGreen);
+    addPattern("\"(\\\\.|[^\"\\\\])*\"", m_quotationMark);
 
     //  TO-DO: Add single quotation mark for character
 }
 
 void Syntax::initFunctionRules()
 {
     // Function format expression
-    functionFormat.setFontItalic(true);
-    functionFormat.setForeground(Qt::darkYellow);
-    addPattern("\\b(?!for\\b|if\\b|else\\b|while\\b|do\\b)[a-zA-Z_][a-zA-Z0-9_]*(?=\\s*\\()", functionFormat);
+    m_functionFormat.setFontItalic(true);
+    m_functionFormat.setForeground(Qt::darkYellow);
+    addPattern("\\b(?!for\\b|if\\b|else\\b|while\\b|do\\b)[a-zA-Z_][a-zA-Z0-9_]*(?=\\s*\\()", m_functionFormat);
 }
 
 void Syntax::initParenthesisRules()
 {
     // Color pattern for parenthesis
     QColor parenthesisColor("#6495ED");
-    parenthesisFormat.setForeground(parenthesisColor);
-    addPattern("[()]", parenthesisFormat);
+    m_parenthesisFormat.setForeground(parenthesisColor);
+    addPattern("[()]", m_parenthesisFormat);
 }
 
 // Regex for single character format 'a', '\n', etc.
 void Syntax::initCharRules()
 {
-    charFormat.setForeground(Qt::darkCyan);
-    addPattern("'(\\\\.|[^'])'", charFormat);
+    m_charFormat.setForeground(Qt::darkCyan);
+    addPattern("'(\\\\.|[^'])'", m_charFormat);
 }
 
 void Syntax::addPattern(const QString &pattern, const QTextCharFormat &format)
 {
     SyntaxRule rule;
-    rule.pattern = QRegularExpression(pattern);
-    rule.format  = format;
-    syntaxRules.append(rule);
+    rule.m_pattern = QRegularExpression(pattern);
+    rule.m_format  = format;
+    m_syntaxRules.append(rule);
 }
 
 void Syntax::highlightBlock(const QString &text)
 {
-    for (const SyntaxRule &rule : syntaxRules)
+    for (const SyntaxRule &rule : m_syntaxRules)
     {
-        QRegularExpressionMatchIterator matchIterator = rule.pattern.globalMatch(text);
+        QRegularExpressionMatchIterator matchIterator = rule.m_pattern.globalMatch(text);
         while (matchIterator.hasNext())
         {
             QRegularExpressionMatch match = matchIterator.next();
-            setFormat(match.capturedStart(), match.capturedLength(), rule.format);
+            setFormat(match.capturedStart(), match.capturedLength(), rule.m_format);
         }
     }
 }