wireshark_dialog.h

Go to the documentation of this file.

 
#ifndef WIRESHARK_DIALOG_H
#define WIRESHARK_DIALOG_H
 
/*
 * @file General dialog base class
 *
 * Base class which provides convenience methods for dialogs that handle
 * capture files.
 *
 * This class attempts to destroy itself when closed. Doing this safely and
 * properly can be a bit tricky while scanning and tapping packets since
 */
 
// "General" is a misnomer but we already have a class named
// "CaptureFileDialog". Suggestions for a better name from
// https://code.wireshark.org/review/#/c/9739/:
// BaseCaptureDialog, CaptureHelperDialog (or rename CaptureFileDialog to something else - WiresharkFileDialog).
// TapDialog might make sense as well.
 
#include <epan/tap.h>
 
#include "capture_file.h"
#include "geometry_state_dialog.h"

class WiresharkDialog : public GeometryStateDialog
{
    Q_OBJECT
 
public:
    // XXX Unlike the entire QWidget API, parent is mandatory here.
    explicit WiresharkDialog(QWidget &parent, CaptureFile &capture_file);

    bool fileClosed() const { return file_closed_; }
 
protected:
    virtual void keyPressEvent(QKeyEvent *event) override { QDialog::keyPressEvent(event); }

    virtual void accept() override;

    virtual void reject() override;

    virtual void beginRetapPackets();

    virtual void endRetapPackets();

    void setWindowSubtitle(const QString &subtitle);

    const QString &windowSubtitle() { return subtitle_; }

    virtual void updateWidgets();
 
    // Capture file and tapping
    CaptureFile &cap_file_;

    bool registerTapListener(const char *tap_name, void *tap_data,
                        const char *filter, unsigned flags,
                        tap_reset_cb tap_reset,
                        tap_packet_cb tap_packet,
                        tap_draw_cb tap_draw);

    virtual void removeTapListeners();
 
    // XXX - Move this to private, have subclasses use the getter?
    bool file_closed_;
 
    bool listening() const { return !tap_listeners_.isEmpty(); }

    bool dialogClosed() const { return dialog_closed_; }

    int retapDepth() const { return retap_depth_; }

    virtual void captureFileClosing();

    virtual void captureFileClosed();
 
protected slots:
    void captureEvent(CaptureEvent e);
 
private:
    void dialogCleanup(bool closeDialog = false);

    QString subtitle_;

    QList<void *> tap_listeners_;

    int retap_depth_;

    bool dialog_closed_;
 
private slots:
};
 
#endif // WIRESHARK_DIALOG_H