wireshark/ui/qt/widgets/traffic_tree.h

/** @file
 *
 * Wireshark - Network traffic analyzer
 * By Gerald Combs <gerald@wireshark.org>
 * Copyright 1998 Gerald Combs
 *
 * SPDX-License-Identifier: GPL-2.0-or-later
 */

#ifndef TRAFFIC_TREE_H
#define TRAFFIC_TREE_H

#include "config.h"

#include <glib.h>

#include <ui/recent.h>

#include <ui/qt/models/atap_data_model.h>
#include <ui/qt/filter_action.h>

#include <QTreeView>
#include <QMenu>
#include <QHeaderView>

#include <QWidgetAction>
#include <QLineEdit>
#include <QActionGroup>

class MenuEditAction : public QWidgetAction
{
    Q_OBJECT
public:
    MenuEditAction(QString text, QString hintText, QObject * parent = nullptr);

    QString text() const;

protected:
    virtual QWidget * createWidget(QWidget *parent);
private:
    QString _hintText;
    QString _text;
    QLineEdit * _lineEdit;

private slots:
    void triggerEntry();
};


class TrafficTreeHeaderView : public QHeaderView
{
    Q_OBJECT
public:
    TrafficTreeHeaderView(GList ** recentColumnList, QWidget * parent = nullptr);
    ~TrafficTreeHeaderView();

    void applyRecent();

signals:
    void columnsHaveChanged(QList<int> visible);
    void filterOnColumn(int column, int filterOn, QString filterText);
private:
    GList ** _recentColumnList;
    QActionGroup * _actions;
    QString _filterText;

private slots:
    void headerContextMenu(const QPoint &pos);
    void columnTriggered(bool checked = false);
    void menuActionTriggered(QAction *);
    void filterColumn(bool checked = false);

};


class TrafficDataFilterProxy : public QSortFilterProxyModel
{
    Q_OBJECT
public:

    enum {
        TRAFFIC_DATA_LESS,
        TRAFFIC_DATA_GREATER,
        TRAFFIC_DATA_EQUAL,
    };

    TrafficDataFilterProxy(QObject *parent = nullptr);

    void setColumnVisibility(int column, bool visible);
    bool columnVisible(int column) const;

public slots:
    void filterForColumn(int column, int filterOn, QString filterText);

protected:
    virtual bool filterAcceptsRow(int source_row, const QModelIndex &source_parent) const;
    virtual bool filterAcceptsColumn(int source_column, const QModelIndex &source_parent) const;
    virtual bool lessThan(const QModelIndex &source_left, const QModelIndex &source_right) const;

private:
    QList<int> hideColumns_;

    int _filterColumn;
    int _filterOn;
    QString _filterText;

    int mapToSourceColumn(int proxyColumn) const;

};


class TrafficTree : public QTreeView
{
    Q_OBJECT

public:
    /**
     * @brief Type for the selection of export
     * @see copyToClipboard
     */
    typedef enum {
        CLIPBOARD_CSV,  /* export as CSV */
        CLIPBOARD_YAML, /* export as YAML */
        CLIPBOARD_JSON  /* export as JSON */
    } eTrafficTreeClipboard;

    TrafficTree(QString baseName, GList ** recentColumnList, QWidget *parent = nullptr);

    /**
     * @brief Create a menu containing clipboard copy entries for this tab
     *
     * It will create all entries, including copying the content of the currently selected tab
     * to CSV, YAML and JSON
     *
     * @param parent the parent object or null
     * @return QMenu* the resulting menu or null
     */
    QMenu * createCopyMenu(QWidget * parent = nullptr);

    void applyRecentColumns();

    virtual void setModel(QAbstractItemModel *model) override;

signals:
    void filterAction(QString filter, FilterAction::Action action, FilterAction::ActionType type);
    void columnsHaveChanged(QList<int> columns);

public slots:
    void tapListenerEnabled(bool enable);
    void disableTap();
    void columnsChanged(QList<int> columns);

private:
    bool _tapEnabled;
    int _exportRole;
    bool _saveRaw;
    QString _baseName;

    TrafficTreeHeaderView * _header;

    ATapDataModel * dataModel();

    QMenu * createActionSubMenu(FilterAction::Action cur_action, QModelIndex idx, bool isConversation);
    void copyToClipboard(eTrafficTreeClipboard type);

    friend class TrafficTreeHeaderView;

private slots:
    void customContextMenu(const QPoint &pos);
    void useFilterAction();
    void clipboardAction();
    void resizeAction();
    void toggleSaveRawAction();
};

#endif // TRAFFIC_TREE_H