forked from osmocom/wireshark
![Moshe Kaplan](/assets/img/avatar_default.png)
Add @file markers for UI header files so that Doxygen will generate documentation for them.
238 lines
7.5 KiB
C++
238 lines
7.5 KiB
C++
/** @file
|
|
*
|
|
* Wireshark - Network traffic analyzer
|
|
* By Gerald Combs <gerald@wireshark.org>
|
|
* Copyright 1998 Gerald Combs
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later
|
|
*/
|
|
|
|
#ifndef WIRESHARK_APPLICATION_H
|
|
#define WIRESHARK_APPLICATION_H
|
|
|
|
#include <config.h>
|
|
|
|
#include <glib.h>
|
|
|
|
#include "epan/register.h"
|
|
|
|
#include "ui/help_url.h"
|
|
|
|
#include <QApplication>
|
|
#include <QDir>
|
|
#include <QFont>
|
|
#include <QIcon>
|
|
#include <QTimer>
|
|
#include <QTranslator>
|
|
|
|
#include "capture_event.h"
|
|
|
|
struct _e_prefs;
|
|
|
|
class QAction;
|
|
class QSocketNotifier;
|
|
|
|
// Recent items:
|
|
// - Read from prefs
|
|
// - Add from open file
|
|
// - Check current list
|
|
// - Signal updated item
|
|
// -
|
|
typedef struct _recent_item_status {
|
|
QString filename;
|
|
qint64 size;
|
|
bool accessible;
|
|
bool in_thread;
|
|
} recent_item_status;
|
|
|
|
class WiresharkApplication : public QApplication
|
|
{
|
|
Q_OBJECT
|
|
public:
|
|
explicit WiresharkApplication(int &argc, char **argv);
|
|
~WiresharkApplication();
|
|
|
|
enum AppSignal {
|
|
CaptureFilterListChanged,
|
|
ColumnsChanged,
|
|
DisplayFilterListChanged,
|
|
FieldsChanged,
|
|
FilterExpressionsChanged,
|
|
LocalInterfacesChanged,
|
|
NameResolutionChanged,
|
|
PacketDissectionChanged,
|
|
PreferencesChanged,
|
|
ProfileChanging,
|
|
RecentCapturesChanged,
|
|
RecentPreferencesRead
|
|
};
|
|
|
|
enum MainMenuItem {
|
|
FileOpenDialog,
|
|
CaptureOptionsDialog
|
|
};
|
|
|
|
enum StatusInfo {
|
|
FilterSyntax,
|
|
FieldStatus,
|
|
FileStatus,
|
|
BusyStatus,
|
|
ByteStatus,
|
|
TemporaryStatus
|
|
};
|
|
|
|
void registerUpdate(register_action_e action, const char *message);
|
|
void emitAppSignal(AppSignal signal);
|
|
// Emitting app signals (PacketDissectionChanged in particular) from
|
|
// dialogs on macOS can be problematic. Dialogs should call queueAppSignal
|
|
// instead.
|
|
void queueAppSignal(AppSignal signal) { app_signals_ << signal; }
|
|
void emitStatCommandSignal(const QString &menu_path, const char *arg, void *userdata);
|
|
void emitTapParameterSignal(const QString cfg_abbr, const QString arg, void *userdata);
|
|
void addDynamicMenuGroupItem(int group, QAction *sg_action);
|
|
void appendDynamicMenuGroupItem(int group, QAction *sg_action);
|
|
void removeDynamicMenuGroupItem(int group, QAction *sg_action);
|
|
QList<QAction *> dynamicMenuGroupItems(int group);
|
|
QList<QAction *> addedMenuGroupItems(int group);
|
|
QList<QAction *> removedMenuGroupItems(int group);
|
|
void clearAddedMenuGroupItems();
|
|
void clearRemovedMenuGroupItems();
|
|
|
|
void allSystemsGo();
|
|
void emitLocalInterfaceEvent(const char *ifname, int added, int up);
|
|
void refreshLocalInterfaces();
|
|
struct _e_prefs * readConfigurationFiles(bool reset);
|
|
QList<recent_item_status *> recentItems() const;
|
|
void addRecentItem(const QString filename, qint64 size, bool accessible);
|
|
void removeRecentItem(const QString &filename);
|
|
QDir lastOpenDir();
|
|
void setLastOpenDir(const char *dir_name);
|
|
void setLastOpenDirFromFilename(QString file_name);
|
|
void helpTopicAction(topic_action_e action);
|
|
const QFont monospaceFont(bool zoomed = false) const;
|
|
void setMonospaceFont(const char *font_string);
|
|
int monospaceTextSize(const char *str);
|
|
void setConfigurationProfile(const gchar *profile_name, bool write_recent_file = true);
|
|
void reloadLuaPluginsDelayed();
|
|
bool isInitialized() { return initialized_; }
|
|
void setReloadingLua(bool is_reloading) { is_reloading_lua_ = is_reloading; }
|
|
bool isReloadingLua() { return is_reloading_lua_; }
|
|
const QIcon &normalIcon();
|
|
const QIcon &captureIcon();
|
|
const QString &windowTitleSeparator() const { return window_title_separator_; }
|
|
const QString windowTitleString(QStringList title_parts);
|
|
const QString windowTitleString(QString title_part) { return windowTitleString(QStringList() << title_part); }
|
|
void applyCustomColorsFromRecent();
|
|
#if defined(HAVE_SOFTWARE_UPDATE) && defined(Q_OS_WIN)
|
|
void rejectSoftwareUpdate() { software_update_ok_ = false; }
|
|
bool softwareUpdateCanShutdown();
|
|
void softwareUpdateShutdownRequest();
|
|
#endif
|
|
QWidget *mainWindow();
|
|
|
|
QTranslator translator;
|
|
QTranslator translatorQt;
|
|
void loadLanguage(const QString language);
|
|
|
|
void doTriggerMenuItem(MainMenuItem menuItem);
|
|
|
|
void zoomTextFont(int zoomLevel);
|
|
|
|
void pushStatus(StatusInfo sinfo, const QString &message, const QString &messagetip = QString());
|
|
void popStatus(StatusInfo sinfo);
|
|
|
|
void gotoFrame(int frameNum);
|
|
|
|
private:
|
|
bool initialized_;
|
|
bool is_reloading_lua_;
|
|
QFont mono_font_;
|
|
QFont zoomed_font_;
|
|
QTimer recent_timer_;
|
|
QTimer packet_data_timer_;
|
|
QTimer tap_update_timer_;
|
|
QList<QString> pending_open_files_;
|
|
QSocketNotifier *if_notifier_;
|
|
QIcon normal_icon_;
|
|
QIcon capture_icon_;
|
|
static QString window_title_separator_;
|
|
QList<AppSignal> app_signals_;
|
|
int active_captures_;
|
|
#if defined(HAVE_SOFTWARE_UPDATE) && defined(Q_OS_WIN)
|
|
bool software_update_ok_;
|
|
#endif
|
|
|
|
void storeCustomColorsInRecent();
|
|
void clearDynamicMenuGroupItems();
|
|
void initializeIcons();
|
|
|
|
protected:
|
|
bool event(QEvent *event);
|
|
|
|
signals:
|
|
void appInitialized();
|
|
void localInterfaceEvent(const char *ifname, int added, int up);
|
|
void localInterfaceListChanged();
|
|
void openCaptureFile(QString cf_path, QString display_filter, unsigned int type);
|
|
void openCaptureOptions();
|
|
void recentPreferencesRead();
|
|
void updateRecentCaptureStatus(const QString &filename, qint64 size, bool accessible);
|
|
void splashUpdate(register_action_e action, const char *message);
|
|
void profileChanging();
|
|
void profileNameChanged(const gchar *profile_name);
|
|
|
|
void columnsChanged(); // XXX This recreates the packet list. We might want to rename it accordingly.
|
|
void captureFilterListChanged();
|
|
void displayFilterListChanged();
|
|
void filterExpressionsChanged();
|
|
void packetDissectionChanged();
|
|
void preferencesChanged();
|
|
void addressResolutionChanged();
|
|
void columnDataChanged();
|
|
void checkDisplayFilter();
|
|
void fieldsChanged();
|
|
void reloadLuaPlugins();
|
|
#if defined(HAVE_SOFTWARE_UPDATE) && defined(Q_OS_WIN)
|
|
// Each of these are called from a separate thread.
|
|
void softwareUpdateRequested();
|
|
void softwareUpdateClose();
|
|
void softwareUpdateQuit();
|
|
#endif
|
|
|
|
void openStatCommandDialog(const QString &menu_path, const char *arg, void *userdata);
|
|
void openTapParameterDialog(const QString cfg_str, const QString arg, void *userdata);
|
|
|
|
/* Signals activation and stop of a capture. The value provides the number of active captures */
|
|
void captureActive(int);
|
|
|
|
void zoomRegularFont(const QFont & font);
|
|
void zoomMonospaceFont(const QFont & font);
|
|
|
|
public slots:
|
|
void clearRecentCaptures();
|
|
void refreshRecentCaptures();
|
|
|
|
void captureEventHandler(CaptureEvent);
|
|
|
|
// Flush queued app signals. Should be called from the main window after
|
|
// each dialog that calls queueAppSignal closes.
|
|
void flushAppSignals();
|
|
|
|
private slots:
|
|
void updateTaps();
|
|
|
|
void cleanup();
|
|
void ifChangeEventsAvailable();
|
|
void itemStatusFinished(const QString filename = "", qint64 size = 0, bool accessible = false);
|
|
void refreshPacketData();
|
|
};
|
|
|
|
extern WiresharkApplication *wsApp;
|
|
|
|
/** Global compile time version string */
|
|
extern void get_wireshark_qt_compiled_info(GString *str);
|
|
extern void get_gui_compiled_info(GString *str);
|
|
/** Global runtime version string */
|
|
extern void get_wireshark_runtime_info(GString *str);
|
|
#endif // WIRESHARK_APPLICATION_H
|