novus/parts/hex/document/qhexmetadata.h

// SPDX-FileCopyrightText: 2014 Dax89
// SPDX-License-Identifier: MIT

#pragma once

#include <QColor>
#include <QHash>
#include <QObject>
#include <QVector>
#include <QtGlobal>
#include <list>

struct QHexMetadataAbsoluteItem {
    qint64 begin;
    qint64 end;
    QColor foreground, background;
    QString comment;
};

struct QHexMetadataItem {
    quint64 line;
    int start, length;
    QColor foreground, background;
    QString comment;
};

typedef std::list<QHexMetadataItem> QHexLineMetadata;

class QHexMetadata : public QObject
{
    Q_OBJECT

public:
    explicit QHexMetadata(QObject *parent = nullptr);
    const QHexLineMetadata &get(quint64 line) const;
    QString comments(quint64 line, int column) const;
    bool hasMetadata(quint64 line) const;

    void clear(quint64 line); // this is transient till next call to setLineWidth()

    void clear();
    void setLineWidth(quint8 width);

public:
    // new interface with begin, end
    void metadata(qint64 begin, qint64 end, const QColor &fgcolor, const QColor &bgcolor, const QString &comment);

    // old interface with line, start, length
    void metadata(quint64 line, int start, int length, const QColor &fgcolor, const QColor &bgcolor, const QString &comment);
    void color(quint64 line, int start, int length, const QColor &fgcolor, const QColor &bgcolor);
    void foreground(quint64 line, int start, int length, const QColor &fgcolor);
    void background(quint64 line, int start, int length, const QColor &bgcolor);
    void comment(quint64 line, int start, int length, const QString &comment);

private:
    void setMetadata(const QHexMetadataItem &mi);
    void setAbsoluteMetadata(const QHexMetadataAbsoluteItem &mi);

Q_SIGNALS:
    void metadataChanged(quint64 line);
    void metadataCleared();

private:
    quint8 m_lineWidth;
    QHash<quint64, QHexLineMetadata> m_metadata;
    QVector<QHexMetadataAbsoluteItem> m_absoluteMetadata;
};