main_window.h

Go to the documentation of this file.

 
#ifndef MAINWINDOW_H
#define MAINWINDOW_H
 
#include <epan/prefs.h>
#include <epan/stat_groups.h>
#include <epan/frame_data.h>
 
// frame_data also available with this include in the original wireshark_main_window code
//#include "follow_stream_dialog.h"
 
 
#include "capture_file.h"
#include "filter_action.h"
#include "io_graph_action.h"
 
#include <QMainWindow>
#include <QSplitter>
 
class QAction;
class QMenu;
class QSplitter;
class QStackedWidget;
 
class DataSourceTab;
class DisplayFilterEntry;
class FieldInformation;
class FunnelAction;
class InterfaceListManager;
class MainStatusBar;
class PacketDiagram;
class PacketList;
class ProfileSwitcher;
class ProtoTree;
class WelcomePage;
 
typedef struct _capture_file capture_file;

class MainWindow : public QMainWindow
{
    Q_OBJECT
public:
    explicit MainWindow(QWidget *parent = nullptr);

    ~MainWindow();

    void setMainWindowTitle(QString title = QString());

    bool hasSelection();

    bool hasUniqueSelection();

    QList<int> selectedRows(bool useFrameNum = false);

    void insertColumn(QString name, QString abbrev, int pos = -1);

    void gotoFrame(int packet_num);

    frame_data* frameDataForRow(int row) const;

    QString getFilter();

    MainStatusBar *statusBar();

    InterfaceListManager *interfaceListManager() const;
 
    // Used for managing custom packet menus

    void appendPacketMenu(FunnelAction *funnel_action);

    QList<QAction*> getPacketMenuActions();

    void clearAddedPacketMenus();

    bool addPacketMenus(QMenu * ctx_menu, GPtrArray *finfo_array);
 
public slots:
    void setDisplayFilter(QString filter, FilterAction::Action action, FilterAction::ActionType filterType);

    void filterPackets(QString new_filter = QString(), bool force = true);

    virtual void showPreferencesDialog(QString module_name) = 0;

    virtual void showIOGraphDialog(io_graph_item_unit_t value_units, QString yfield) = 0;

    virtual void showPlotDialog(const QString& y_field, bool filtered) = 0;

    void layoutPanes();

    void applyRecentPaneGeometry();

    void updateForUnsavedChanges();

    void cyclePane(bool reverse = false);
 
protected:
    enum CopySelected {
        CopyAllVisibleItems,
        CopyAllVisibleSelectedTreeItems,
        CopySelectedDescription,
        CopySelectedFieldName,
        CopySelectedValue,
        CopyListAsText,
        CopyListAsCSV,
        CopyListAsYAML,
        CopyListAsHTML,
    };

    enum FileCloseContext {
        Default,
        Quit,
        Restart,
        Reload,
        Update,
        Export
    };

    void showWelcome();

    void showCapture();

    void setTitlebarForCaptureInProgress();

    void setIconForCaptureInProgress(bool capture_in_progress);

    virtual void setMenusForCaptureFile(bool force_disable = false) = 0;

    CaptureFile capture_file_;

    QList<register_stat_group_t> menu_groups_;

    QWidget* getLayoutWidget(layout_pane_content_e type);

    QStackedWidget *main_stack_;

    WelcomePage *welcome_page_;

    QSplitter master_split_;

    QSplitter extra_split_;

    QWidget empty_pane_;

    QVector<unsigned> cur_layout_;

    PacketList *packet_list_;

    ProtoTree *proto_tree_;

    DataSourceTab *data_source_tab_;

    PacketDiagram *packet_diagram_;

    DisplayFilterEntry *df_combo_box_;

    MainStatusBar *main_status_bar_;

    ProfileSwitcher *profile_switcher_;

    InterfaceListManager *interface_list_manager_;

    bool use_capturing_title_;

    QMap<QString, const char *> text_codec_map_;
 
    // Recent captures menu support - set by subclasses

    QMenu *recent_captures_menu_;

    QAction *no_recent_files_action_;
#if defined(Q_OS_MAC)
    QMenu *dock_menu_;
#endif

    void populateRecentCapturesMenu();

    void retranslateUiElements();

    virtual void openRecentCaptureFile(const QString &filename) = 0;

    virtual bool tryClosingCaptureFile(QString before_what, FileCloseContext context = Default) = 0;
 
protected slots:
    void addDisplayFilterTranslationActions(QMenu *copy_menu);

    void updateDisplayFilterTranslationActions(const QString &df_text);

    void updateTitlebar();

    virtual void applyFilter(QString new_filter, bool force) = 0;
 
private:
    QString replaceWindowTitleVariables(QString title);

    void findTextCodecs();

    QVector<QAction *> df_translate_actions_;

    static const char *translator_;

    static const char *translated_filter_;
 
private slots:
    void copyDisplayFilterTranslation(void);
 
signals:
    void setCaptureFile(capture_file *cf);

    void captureActive(int active);

    void fieldSelected(FieldInformation *finfo);

    void fieldHighlight(FieldInformation *finfo);

    void framesSelected(QList<int> frames);

    void filterAction(QString filter, FilterAction::Action action, FilterAction::ActionType type);

    void displayFilterSuccess(bool success);
};
 
#endif // MAINWINDOW_H