An effort at improvements towards const correctness. Tried not to make any changes which might impact existing code. Corrected some little things (misspellings, mostly). Added Q_ASSERT_X to some constructors to ensure that pointers were valid. Added 'CONFIG += warn_on' to project file.

Author: bobhairgrove

.gitignore

@@ -2,3 +2,4 @@
 /**/__pycache__
 /.venv
 /.vscode
+/src/qhexedit.pro.user

src/chunks.cpp

@@ -62,7 +62,7 @@ bool Chunks::setIODevice(QIODevice &ioDevice)
 
 // ***************************************** Getting data out of Chunks
 
-QByteArray Chunks::data(qint64 pos, qint64 maxSize, QByteArray *highlighted)
+QByteArray Chunks::data(qint64 pos, qint64 maxSize, QByteArray *highlighted) const
 {
     qint64 ioDelta = 0;
     int chunkIdx = 0;
@@ -147,7 +147,7 @@ QByteArray Chunks::data(qint64 pos, qint64 maxSize, QByteArray *highlighted)
     return buffer;
 }
 
-bool Chunks::write(QIODevice &iODevice, qint64 pos, qint64 count)
+bool Chunks::write(QIODevice &iODevice, qint64 pos, qint64 count) const
 {
     if (count == -1)
         count = _size;
@@ -176,7 +176,7 @@ void Chunks::setDataChanged(qint64 pos, bool dataChanged)
     _chunks[chunkIdx].dataChanged[(int)posInBa] = char(dataChanged);
 }
 
-bool Chunks::dataChanged(qint64 pos)
+bool Chunks::dataChanged(qint64 pos) const
 {
     foreach (Chunk chunk, _chunks)
     {
@@ -191,7 +191,7 @@ bool Chunks::dataChanged(qint64 pos)
 
 // ***************************************** Search API
 
-qint64 Chunks::indexOf(const QByteArray &ba, qint64 from)
+qint64 Chunks::indexOf(const QByteArray &ba, qint64 from) const
 {
     qint64 result = -1;
     QByteArray buffer;
@@ -206,7 +206,7 @@ qint64 Chunks::indexOf(const QByteArray &ba, qint64 from)
     return result;
 }
 
-qint64 Chunks::lastIndexOf(const QByteArray &ba, qint64 from)
+qint64 Chunks::lastIndexOf(const QByteArray &ba, qint64 from) const
 {
     qint64 result = -1;
     QByteArray buffer;
@@ -276,22 +276,22 @@ bool Chunks::removeAt(qint64 pos)
 
 // ***************************************** Utility functions
 
-char Chunks::operator[](qint64 pos)
+char Chunks::operator[](qint64 pos) const
 {
     return data(pos, 1).at(0);
 }
 
-qint64 Chunks::pos()
+qint64 Chunks::pos() const
 {
     return _pos;
 }
 
-qint64 Chunks::size()
+qint64 Chunks::size() const
 {
     return _size;
 }
 
-int Chunks::getChunkIndex(qint64 absPos)
+int Chunks::getChunkIndex(qint64 absPos) const
 {
     // This routine checks, if there is already a copied chunk available. If os, it
     // returns a reference to it. If there is no copied chunk available, original

src/chunks.h

@@ -49,40 +49,40 @@ class Chunks: public QObject
 Q_OBJECT
 public:
     // Constructors and file settings
-    Chunks(QObject *parent);
-    Chunks(QIODevice &ioDevice, QObject *parent);
+    explicit Chunks(QObject *parent = nullptr);
+    Chunks(QIODevice &ioDevice, QObject *parent = nullptr);
     bool setIODevice(QIODevice &ioDevice);
 
     // Getting data out of Chunks
-    QByteArray data(qint64 pos=0, qint64 count=-1, QByteArray *highlighted=0);
-    bool write(QIODevice &iODevice, qint64 pos=0, qint64 count=-1);
+    QByteArray data(qint64 pos=0, qint64 count=-1, QByteArray *highlighted=nullptr) const;
+    bool write(QIODevice &iODevice, qint64 pos=0, qint64 count=-1) const;
 
     // Set and get highlighting infos
     void setDataChanged(qint64 pos, bool dataChanged);
-    bool dataChanged(qint64 pos);
+    bool dataChanged(qint64 pos) const;
 
     // Search API
-    qint64 indexOf(const QByteArray &ba, qint64 from);
-    qint64 lastIndexOf(const QByteArray &ba, qint64 from);
+    qint64 indexOf(const QByteArray &ba, qint64 from) const;
+    qint64 lastIndexOf(const QByteArray &ba, qint64 from) const;
 
     // Char manipulations
     bool insert(qint64 pos, char b);
     bool overwrite(qint64 pos, char b);
     bool removeAt(qint64 pos);
 
     // Utility functions
-    char operator[](qint64 pos);
-    qint64 pos();
-    qint64 size();
+    char operator[](qint64 pos) const;
+    qint64 pos() const;
+    qint64 size() const;
 
 
 private:
-    int getChunkIndex(qint64 absPos);
+    int getChunkIndex(qint64 absPos) const;
 
     QIODevice * _ioDevice;
     qint64 _pos;
     qint64 _size;
-    QList<Chunk> _chunks;
+    mutable QList<Chunk> _chunks;
 
 #ifdef MODUL_TEST
 public:

src/color_manager.cpp

@@ -47,12 +47,12 @@ ColoredArea::ColoredArea(qint64 posStart, qint64 posEnd, QPen pen, QBrush backgr
     _areaStyle = background;
 }
 
-QPen ColoredArea::fontPen()
+QPen ColoredArea::fontPen() const
 {
     return _fontColor;
 }
 
-QColor ColoredArea::fontColor()
+QColor ColoredArea::fontColor() const
 {
     return _fontColor.color();
 }
@@ -62,12 +62,12 @@ void ColoredArea::setFontColor(QColor color)
     _fontColor = QPen(color);
 }
 
-QColor ColoredArea::areaColor()
+QColor ColoredArea::areaColor() const
 {
     return _areaStyle.color();
 }
 
-QBrush ColoredArea::areaStyle()
+QBrush ColoredArea::areaStyle() const
 {
     return _areaStyle;
 }
@@ -82,21 +82,21 @@ void ColoredArea::setAreaStyle(QBrush backround)
     _areaStyle = backround;
 }
 
-qint64 ColoredArea::posStart()
+qint64 ColoredArea::posStart() const
 {
     return _posStart;
-};
+}
 
-qint64 ColoredArea::posEnd()
+qint64 ColoredArea::posEnd() const
 {
     return _posEnd;
-};
+}
 
 void ColoredArea::setRange(qint64 posStart, qint64 posEnd)
 {
     _posStart = posStart;
     _posEnd = posEnd;
-};
+}
 
 void ColoredArea::clear() 
 {
@@ -111,7 +111,7 @@ ColorManager::ColorManager()
 {
     QPalette palette = qApp->palette();
     setPalette(palette);
-};
+}
 
 void ColorManager::setPalette(const QPalette &palette)
 {
@@ -123,7 +123,7 @@ void ColorManager::setPalette(const QPalette &palette)
 }
 
 // read only, copy of relevant ColoredArea is returned: you can't change anything
-ColoredArea ColorManager::markedArea(qint64 pos, Area area, Chunks *chunks)
+ColoredArea ColorManager::markedArea(qint64 pos, Area area, Chunks *chunks) const
 {
     // prio 1 selection
     if (pos >= _selection.posStart() && pos < _selection.posEnd())
@@ -145,9 +145,9 @@ ColoredArea ColorManager::markedArea(qint64 pos, Area area, Chunks *chunks)
     }
     // nothing found -> standard colors
     return this->notMarked(area);
-};
+}
 
-ColoredArea& ColorManager::notMarked(Area area)
+const ColoredArea& ColorManager::notMarked(Area area) const
 {
     switch (area) {
         case Area::Address:
@@ -163,15 +163,25 @@ ColoredArea& ColorManager::notMarked(Area area)
     return _hex; // should never happen
 }
 
-ColoredArea& ColorManager::selection()
+const ColoredArea &ColorManager::selection() const
+{
+    return _selection;
+}
+
+ColoredArea &ColorManager::selection()
 {
     return _selection;
-};
+}
+
+const ColoredArea &ColorManager::highlighting() const
+{
+    return _highlighting;
+}
 
-ColoredArea& ColorManager::highlighting()
+ColoredArea &ColorManager::highlighting()
 {
     return _highlighting;
-};
+}
 
 void ColorManager::addUserArea(qint64 posStart, qint64 posEnd, QColor fontColor, QBrush areaStyle)
 {
@@ -182,4 +192,4 @@ void ColorManager::addUserArea(qint64 posStart, qint64 posEnd, QColor fontColor,
 void ColorManager::clearUserAreas()
 {
     _userAreas.clear();
-}
+}

src/color_manager.h

@@ -47,25 +47,40 @@ enum Area {
 class ColoredArea
 {
 public:
-    // Cunstructors
+    // Constructors
     ColoredArea();
     ColoredArea(QPen pen, QBrush background);
     ColoredArea(qint64 posStart, qint64 posEnd, QPen pen, QBrush background);
+    // needs copy constructor and assignment operator:
+    ColoredArea(const ColoredArea& other)
+        : _posStart (other._posStart)
+        , _posEnd   (other._posEnd)
+        , _fontColor(other._fontColor)
+        , _areaStyle(other._areaStyle) {;}
+    ColoredArea& operator=(const ColoredArea& other) {
+        if (this != &other) {
+            _posStart  = other._posStart ;
+            _posEnd    = other._posEnd   ;
+            _fontColor = other._fontColor;
+            _areaStyle = other._areaStyle;
+        }
+        return *this;
+    }
 
     // Property to set/get font color
-    QColor fontColor();
+    QColor fontColor() const;
     void setFontColor(QColor color);
 
     // Property to set/get area style
-    QColor areaColor();
-    QBrush areaStyle();
+    QColor areaColor() const;
+    QBrush areaStyle() const;
     void setAreaColor(QColor color);
     void setAreaStyle(QBrush background);
 
     // other Methods to acces and set internal data
-    QPen fontPen();
-    qint64 posStart();
-    qint64 posEnd();
+    QPen fontPen() const;
+    qint64 posStart() const;
+    qint64 posEnd() const;
     void setRange(qint64 posStart, qint64 posEnd);
     void clear();
 
@@ -87,15 +102,17 @@ class ColorManager
     void setPalette(const QPalette &palette);
 
     // Method returns color definitions for data at position pos in area area
-    ColoredArea markedArea(qint64 pos, Area area, Chunks *chunks);
+    ColoredArea markedArea(qint64 pos, Area area, Chunks *chunks) const;
 
-    // Method returns standard collors (without marking)
-    ColoredArea& notMarked(Area);
+    // Method returns standard colors (without marking)
+    const ColoredArea &notMarked(Area) const;
 
     // Get the selection color definitions
+    const ColoredArea& selection() const;
     ColoredArea& selection();
 
     // Get the highlighting color definitions
+    const ColoredArea& highlighting() const;
     ColoredArea& highlighting();
 
     // Add a user defined area
@@ -116,4 +133,4 @@ class ColorManager
 
 /** \endcond docNever */
 
-#endif // COLOR_MANAGER_H
+#endif // COLOR_MANAGER_H

src/commands.cpp

@@ -27,7 +27,7 @@ class CharCommand : public QUndoCommand
     enum CCmd {insert, removeAt, overwrite};
 
     CharCommand(Chunks * chunks, CCmd cmd, qint64 charPos, char newChar,
-                       QUndoCommand *parent=0);
+                       QUndoCommand *parent=nullptr);
 
     void undo();
     void redo();
@@ -52,6 +52,7 @@ CharCommand::CharCommand(Chunks * chunks, CCmd cmd, qint64 charPos, char newChar
     , _oldChar('\0')
     , _cmd(cmd)
 {
+    Q_ASSERT_X(chunks, __func__, "The argument 'chunks' was nullptr.");
 }
 
 bool CharCommand::mergeWith(const QUndoCommand *command)
@@ -112,8 +113,8 @@ void CharCommand::redo()
 UndoStack::UndoStack(Chunks * chunks, QObject * parent)
     : QUndoStack(parent)
 {
+    Q_ASSERT_X(chunks, __func__, "The argument 'chunks' was nullptr.");
     _chunks = chunks;
-    _parent = parent;
     this->setUndoLimit(1000);
 }
 

src/commands.h

@@ -48,7 +48,7 @@ class UndoStack : public QUndoStack
     Q_OBJECT
 
 public:
-    UndoStack(Chunks *chunks, QObject * parent=0);
+    UndoStack(Chunks *chunks, QObject * parent=nullptr);
     void insert(qint64 pos, char c);
     void insert(qint64 pos, const QByteArray &ba);
     void removeAt(qint64 pos, qint64 len=1);
@@ -57,7 +57,6 @@ class UndoStack : public QUndoStack
 
 private:
     Chunks * _chunks;
-    QObject * _parent;
 };
 
 /** \endcond docNever */