tagging_rules_model.h

/* tagging_rules_model.h
 *
 * Model for the Tagging Rules dialog
 * Copyright 2026, Mark Stout <[email protected]>
 *
 * Wireshark - Network traffic analyzer
 * By Gerald Combs <[email protected]>
 * Copyright 1998 Gerald Combs
 *
 * SPDX-License-Identifier: GPL-2.0-or-later
 */
 
#ifndef TAGGING_RULES_MODEL_H
#define TAGGING_RULES_MODEL_H
 
#include <config.h>
 
#include <epan/tag_rules.h>
 
#include <ui/qt/models/tree_model_helpers.h>
 
#include <QList>
#include <QAbstractItemModel>

class TaggingRuleItem : public ModelHelperTreeItem<TaggingRuleItem>
{
public:
    TaggingRuleItem(bool disabled, QString name, QString filter,
                    QString tag_content, QString tag_url, QString comment,
                    TaggingRuleItem *parent);

    TaggingRuleItem(tag_rule_t *rule, TaggingRuleItem *parent);

    TaggingRuleItem(const TaggingRuleItem &item);

    virtual ~TaggingRuleItem();

    TaggingRuleItem &operator=(TaggingRuleItem &rhs);

    bool disabled_;

    QString name_;

    QString filter_;

    QString tag_content_;

    QString tag_url_;

    QString comment_;
};

class TaggingRulesModel : public QAbstractItemModel
{
    Q_OBJECT
 
public:
    explicit TaggingRulesModel(QObject *parent);

    virtual ~TaggingRulesModel();

    enum TaggingRulesColumn {
        colName    = 0, 
        colFilter  = 1, 
        colTag     = 2, 
        colLink    = 3, 
        colComment = 4, 
        colCount        
    };

    enum TaggingRulesRole {
        TagContentRole  = Qt::UserRole + 1, 
        TagUrlRole      = Qt::UserRole + 2  
    };

    void addRule(bool disabled, const QString &name, const QString &filter,
                 const QString &tag_content, const QString &tag_url,
                 const QString &comment);

    void addRule(tag_rule_t *rule);

    bool loadFromPath(const QString &path, QString &err);

    bool writeToPath(const QString &path, const tag_prefs_t *prefs, QString &err);

    bool importRules(const QString &path, QString &err);

    bool exportRules(const QString &path, QString &err);

    bool writeTags();

    Qt::ItemFlags flags(const QModelIndex &index) const override;

    QVariant data(const QModelIndex &index, int role) const override;

    bool setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole) override;

    QVariant headerData(int section, Qt::Orientation orientation,
                        int role = Qt::DisplayRole) const override;

    QModelIndex index(int row, int column,
                      const QModelIndex &parent = QModelIndex()) const override;

    QModelIndex parent(const QModelIndex &indexItem) const override;

    int rowCount(const QModelIndex &parent = QModelIndex()) const override;

    int columnCount(const QModelIndex &parent = QModelIndex()) const override;

    bool insertRows(int row, int count, const QModelIndex &parent = QModelIndex()) override;

    bool removeRows(int row, int count, const QModelIndex &parent = QModelIndex()) override;

    bool moveRows(const QModelIndex &sourceParent, int sourceRow, int count,
                  const QModelIndex &destinationParent, int destinationChild) override;
 
    // Drag-and-drop functionality

    Qt::DropActions supportedDropActions() const override;

    QStringList mimeTypes() const override;

    QMimeData *mimeData(const QModelIndexList &indexes) const override;

    bool dropMimeData(const QMimeData *data, Qt::DropAction action, int row, int column,
                      const QModelIndex &parent) override;
 
private:
    GSList *createTagRuleList();

    TaggingRuleItem *root_;

};
 
#endif // TAGGING_RULES_MODEL_H