lua_debugger_watch.h

Go to the documentation of this file.

/* lua_debugger_watch.h
 *
 * Wireshark - Network traffic analyzer
 * By Gerald Combs <gerald@wireshark.org>
 * Copyright 1998 Gerald Combs
 *
 * SPDX-License-Identifier: GPL-2.0-or-later
 */
 
#ifndef LUA_DEBUGGER_WATCH_H
#define LUA_DEBUGGER_WATCH_H
 
#include <QHash>
#include <QList>
#include <QModelIndex>
#include <QObject>
#include <QStandardItemModel>
#include <QString>
#include <QStringList>
#include <QStyledItemDelegate>
#include <QTreeView>
#include <QVariantMap>
 
#include <functional>
 
#include "lua_debugger_utils.h"
 
class LuaDebuggerChangeHighlightTracker;
class LuaDebuggerDialog;
class LuaDebuggerFontPolicy;
class QKeyEvent;
class QListView;
class QMouseEvent;
class QPoint;
class QStandardItem;
class QStandardItemModel;
class QToolButton;
class QTreeView;
 
namespace WatchColumn
{
constexpr int Spec = 0;
constexpr int Value = 1;
constexpr int Count = 2;
} // namespace WatchColumn
 
/* ===== watch_widgets ===== */
 
class LuaDbgWatchItemModel : public QStandardItemModel
{
    Q_OBJECT
 
public:
    using QStandardItemModel::QStandardItemModel;
 
protected:
    bool dropMimeData(const QMimeData *data, Qt::DropAction action, int row, int column,
                      const QModelIndex &parent) override;
};
 
class LuaDbgWatchTreeWidget : public QTreeView
{
    Q_OBJECT
 
public:
    LuaDbgWatchTreeWidget(LuaDebuggerFontPolicy *fontPolicy, QWidget *parent);
 
signals:
    void requestNewRow();
 
    void requestRemoveAll();
 
    void requestCopyValue(QStandardItem *item, const QModelIndex &index);
 
    void requestDuplicateRoot(QStandardItem *item);
 
    void requestDeleteRows(const QList<QStandardItem *> &items);
 
protected:
    void startDrag(Qt::DropActions supportedActions) override;
 
    void dragMoveEvent(QDragMoveEvent *event) override;
 
    void dropEvent(QDropEvent *event) override;
 
    void mouseDoubleClickEvent(QMouseEvent *event) override;
 
    void keyPressEvent(QKeyEvent *event) override;
 
private:
    LuaDebuggerFontPolicy *fontPolicy_;
};
 
class LuaDbgVariablesReadOnlyDelegate : public QStyledItemDelegate
{
    Q_OBJECT
 
  public:
    using QStyledItemDelegate::QStyledItemDelegate;
 
    QWidget *createEditor(QWidget *parent, const QStyleOptionViewItem &option, const QModelIndex &index) const override;
};
 
class LuaDbgWatchValueColumnDelegate : public QStyledItemDelegate
{
    Q_OBJECT
 
  public:
    using QStyledItemDelegate::QStyledItemDelegate;
 
    void paint(QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const override;
 
    QWidget *createEditor(QWidget *parent, const QStyleOptionViewItem &option, const QModelIndex &index) const override;
};
 
class LuaDbgWatchRootDelegate : public QStyledItemDelegate
{
    Q_OBJECT
 
  public:
    using CommitFn = std::function<void(QStandardItem *item, const QString &text)>;
 
    LuaDbgWatchRootDelegate(QTreeView *tree, CommitFn commit, QObject *parent = nullptr);
 
    QWidget *createEditor(QWidget *parent, const QStyleOptionViewItem &option, const QModelIndex &index) const override;
 
    void setEditorData(QWidget *editor, const QModelIndex &index) const override;
 
    void setModelData(QWidget *editor, QAbstractItemModel *model, const QModelIndex &index) const override;
 
  private:
    QTreeView *tree_; 
    CommitFn commit_; 
};
 
/* ===== watch_row_presenter ===== */
 
class LuaDebuggerWatchRowPresenter : public QObject
{
    Q_OBJECT
 
  public:
    LuaDebuggerWatchRowPresenter(QObject *parent, QTreeView *tree, QStandardItemModel *model,
                                 LuaDebuggerChangeHighlightTracker &tracker);
 
    void applyEmpty(QStandardItem *item, const QString &muted, const QString &watchTipExtra);
 
    void applyNoLiveContext(QStandardItem *item, const QString &muted, const QString &watchTipExtra);
 
    void applyError(QStandardItem *item, const QString &errStr, const QString &watchTipExtra);
 
    void applySuccess(QStandardItem *item, const QString &spec, const char *val, const char *typ, bool can_expand,
                      const QString &watchTipExtra, int stackLevel, bool changeHighlightAllowed);
 
    void applyExpression(QStandardItem *item, const QString &spec, const char *val, const char *typ, bool can_expand,
                         const QString &watchTipExtra, int stackLevel, bool changeHighlightAllowed);
 
  private:
    QTreeView *tree_ = nullptr;
    QStandardItemModel *model_ = nullptr;
    LuaDebuggerChangeHighlightTracker *tracker_ = nullptr;
};
 
/* ===== watch_controller ===== */
 
class LuaDebuggerWatchController : public QObject
{
    Q_OBJECT
 
public:
    explicit LuaDebuggerWatchController(LuaDebuggerDialog *host);
 
    void attach(QTreeView *tree, QStandardItemModel *model);
 
    void attachHeaderButtons(QToolButton *remove, QToolButton *removeAll);
 
    void configureColumns() const;
 
    void pruneExpansionMap();
 
    void restoreExpansionState();
 
    QStringList expandedSubpathsForSpec(const QString &rootSpec) const;
 
    void refillChildren(QStandardItem *item);
 
    void refreshDisplay();
 
    void refreshBranch(QStandardItem *item);
 
    void applyItemState(QStandardItem *item, bool liveContext, const QString &muted);
 
    void insertNewRow(const QString &initialSpec = QString(), bool openEditor = true);
 
    void commitWatchRootSpec(QStandardItem *item, const QString &text);
 
    void deleteRows(const QList<QStandardItem *> &items);
 
    void removeAllTopLevelItems();
 
    void copyValueForItem(QStandardItem *item, const QModelIndex &ix);
 
    void duplicateRootItem(QStandardItem *item);
 
    QList<QStandardItem *> selectedRootItemsForRemove() const;
 
    void serializeTo(QVariantMap &settingsMap);
 
    void restoreFrom(const QVariantMap &settingsMap);
 
    void scheduleDeferredPlaceholder();
 
    void invalidatePlaceholder();
 
public slots:
    void onExpanded(const QModelIndex &index);
 
    void onCollapsed(const QModelIndex &index);
 
    void showContextMenu(const QPoint &pos);
 
private:
    void fillPathChildren(QStandardItem *parent, const QString &path);
 
    void fillExprChildren(QStandardItem *parent, const QString &rootSpec, const QString &subpath);
 
    void updateHeaderButtonState();
 
    LuaDebuggerDialog *host_ = nullptr;
 
    QTreeView *tree_ = nullptr;
 
    QStandardItemModel *model_ = nullptr;
 
    QToolButton *removeButton_ = nullptr;
 
    QToolButton *removeAllButton_ = nullptr;
 
    LuaDebuggerWatchRowPresenter *rowPresenter_ = nullptr;
 
    QHash<QString, LuaDbgTreeSectionExpansionState> expansion_;
 
    qint32 placeholderEpoch_ = 0;
};
 
#endif