lua_debugger_breakpoints.h

Go to the documentation of this file.

/* lua_debugger_breakpoints.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_BREAKPOINTS_H
#define LUA_DEBUGGER_BREAKPOINTS_H
 
#include <QIcon>
#include <QLineEdit>
#include <QList>
#include <QObject>
#include <QSet>
#include <QString>
#include <QStyledItemDelegate>
#include <QVariantMap>
#include <QVector>
 
#include "lua_debugger_utils.h"
 
class LuaDebuggerCodeView;
class LuaDebuggerDialog;
class QAbstractItemModel;
class QAction;
class QComboBox;
class QEvent;
class QModelIndex;
class QObject;
class QPalette;
class QPaintEvent;
class QPoint;
class QResizeEvent;
class QShowEvent;
class QStandardItem;
class QStandardItemModel;
class QStyleOptionViewItem;
class QToolButton;
class QTreeView;
class QWidget;
 
namespace BreakpointColumn
{
constexpr int Active = 0;
constexpr int Hits = 1;
constexpr int Line = 2;
constexpr int Location = 3;
constexpr int Count = 4;
} // namespace BreakpointColumn
 
/* ===== breakpoint_modes ===== */
 
namespace LuaDbgBreakpointModes
{
 
enum class Mode : int
{
    Expression = 0, 
    HitCount   = 1, 
    LogMessage = 2, 
};
 
struct ModeSpec
{
    Mode mode;
    const char *label;
    const char *placeholder;
    const char *valueTooltip;
};
 
constexpr int kModeCount = 3;
 
extern const ModeSpec kBreakpointEditModes[kModeCount];
 
QString translatedLabel(const ModeSpec &spec);
 
const char *draftPropertyName(Mode m);
 
QComboBox *editorHitModeCombo(QWidget *editor);
 
QToolButton *editorPauseToggle(QWidget *editor);
 
void applyEditorMode(QWidget *editor, int modeIndex);
 
QIcon makePauseIcon(const QPalette &palette);
 
QString pauseToggleStyleSheet();
 
} // namespace LuaDbgBreakpointModes
 
/* ===== breakpoint_inline_editor ===== */
 
class BreakpointInlineLineEdit : public QLineEdit
{
  public:
    explicit BreakpointInlineLineEdit(QWidget *parent = nullptr);
 
    void setEmbeddedWidgets(QComboBox *modeCombo, QComboBox *hitModeCombo, QToolButton *pauseButton);
 
    void relayout();
 
  protected:
    void resizeEvent(QResizeEvent *e) override;
    void showEvent(QShowEvent *e) override;
    void paintEvent(QPaintEvent *e) override;
 
  private:
    QComboBox *modeCombo_ = nullptr;
    QComboBox *hitModeCombo_ = nullptr;
    QToolButton *pauseButton_ = nullptr;
};
 
/* ===== breakpoint_delegate ===== */
 
class LuaDbgBreakpointConditionDelegate : public QStyledItemDelegate
{
public:
    explicit LuaDbgBreakpointConditionDelegate(LuaDebuggerDialog *dialog);
 
    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;
 
    void updateEditorGeometry(QWidget *editor, const QStyleOptionViewItem &option,
                              const QModelIndex &index) const override;
 
    QSize sizeHint(const QStyleOptionViewItem &option,
                   const QModelIndex &index) const override;
 
protected:
    bool eventFilter(QObject *watched, QEvent *event) override;
 
private:
    int preferredEditorHeight() const;
 
    mutable int cachedPreferredHeight_ = 0;
};
 
/* ===== breakpoints_controller ===== */
 
class LuaDebuggerBreakpointsController : public QObject
{
    Q_OBJECT
 
  public:
    explicit LuaDebuggerBreakpointsController(LuaDebuggerDialog *host);
 
    void attach(QTreeView *tree, QStandardItemModel *model);
 
    void attachHeaderButtons(QToolButton *breakOnError, QToolButton *toggleAll, QToolButton *remove,
                             QToolButton *removeAll, QToolButton *edit, QAction *removeAllAction);
 
    void configureColumns() const;
 
    void startInlineEdit(int row);
 
    void serializeTo(QVariantMap &settingsMap) const;
 
    void restoreFrom(const QVariantMap &settingsMap);
 
    void refreshFromEngine();
 
    void clearAll();
 
    void toggleAtLine(const QString &file, qint32 line);
 
    void toggleOnCodeViewLine(LuaDebuggerCodeView *codeView, qint32 line);
 
    void shiftToggleAtLine(const QString &file, qint32 line);
 
    void setActiveFromUser(const QString &file, qint32 line, bool active);
 
    void removeAtLine(const QString &file, qint32 line);
 
    void moveAtLine(const QString &file, qint32 fromLine, qint32 toLine);
 
    void toggleAllActive();
 
    void updateHeaderButtonState();
 
    bool removeRows(const QList<int> &rows);
 
    bool removeSelected();
 
  public slots:
    void onItemDoubleClicked(const QModelIndex &index);
 
    void showContextMenu(const QPoint &pos);
    void onItemChanged(QStandardItem *item);
    void onModelDataChanged(const QModelIndex &topLeft, const QModelIndex &bottomRight, const QVector<int> &roles);
    void showGutterMenu(const QString &filename, qint32 line, const QPoint &globalPos);
 
  private:
    void refreshAllOpenTabMarkers() const;
    void refreshOpenTabMarkers(const QSet<QString> &files) const;
 
    LuaDebuggerDialog *host_ = nullptr;
    QTreeView *tree_ = nullptr;
    QStandardItemModel *model_ = nullptr;
 
    QToolButton *breakOnErrorButton_ = nullptr;
    QToolButton *toggleAllButton_ = nullptr;
    QToolButton *removeButton_ = nullptr;
    QToolButton *removeAllButton_ = nullptr;
    QToolButton *editButton_ = nullptr;
    QAction *removeAllAction_ = nullptr;
 
    QIcon headerIconCache_[3];
    QString headerIconCacheKey_;
 
    bool tabsPrimed_ = false;
 
    bool suppressItemChanged_ = false;
};
 
#endif