Wireshark 5.1.0
The Wireshark network protocol analyzer
Loading...
Searching...
No Matches
main_application.h
Go to the documentation of this file.
1
9
10#ifndef MAIN_APPLICATION_H
11#define MAIN_APPLICATION_H
12
13#include <config.h>
14
15#include "wsutil/feature_list.h"
16
17#include "ui/help_url.h"
18
19#include <QApplication>
20#include <QDir>
21#include <QFont>
22#include <QIcon>
23#include <QTimer>
24#include <QTranslator>
25
26#include <functional>
27#include <utility>
28
29#include "capture_event.h"
30
31struct _e_prefs;
32
33class QAction;
34class QSocketNotifier;
35
36class MainWindow;
37
41class MainApplication : public QApplication
42{
43 Q_OBJECT
44public:
50 explicit MainApplication(int &argc, char **argv);
51
56
84
94
112
117 void emitAppSignal(AppSignal signal);
118
138 void queueAppSignal(AppSignal signal) { app_signals_ << signal; }
139
146 void emitStatCommandSignal(const QString &menu_path, const char *arg, void *userdata);
147
154 void emitTapParameterSignal(const QString cfg_abbr, const QString arg, void *userdata);
155
161 void addDynamicMenuGroupItem(int group, QAction *sg_action);
162
168 void appendDynamicMenuGroupItem(int group, QAction *sg_action);
169
175 void removeDynamicMenuGroupItem(int group, QAction *sg_action);
176
182 QList<QAction *> dynamicMenuGroupItems(int group);
183
189 QList<QAction *> addedMenuGroupItems(int group);
190
196 QList<QAction *> removedMenuGroupItems(int group);
197
202
207
211 void allSystemsGo();
212
219 void emitLocalInterfaceEvent(const char *ifname, int added, int up);
220
226 struct _e_prefs * readConfigurationFiles(bool reset);
227
233
238 void setLastOpenDirFromFilename(QString file_name);
239
244 void helpTopicAction(topic_action_e action);
245
246
253 void setConfigurationProfile(const char *profile_name, bool write_recent_file = true, bool reload = false);
254
259
264 bool isInitialized() { return initialized_; }
265
284 template <typename Func>
285 void whenInitialized(const QObject *context, Func &&fn)
286 {
287 if (initialized_) {
288 whenInitializedDispatch(context, std::function<void()>(std::forward<Func>(fn)));
289 } else {
290 connect(this, &MainApplication::appInitialized, context, std::forward<Func>(fn));
291 }
292 }
293
298 void setReloadingLua(bool is_reloading) { is_reloading_lua_ = is_reloading; }
299
304 bool isReloadingLua() { return is_reloading_lua_; }
305
310 const QIcon &normalIcon();
311
316 const QIcon &captureIcon();
317
322 const QString &windowTitleSeparator() const { return window_title_separator_; }
323
329 const QString windowTitleString(QStringList title_parts);
330
336 const QString windowTitleString(QString title_part) { return windowTitleString(QStringList() << title_part); }
337
342
359
361 QTranslator translator;
362
364 QTranslator translatorQt;
365
370 void loadLanguage(const QString language);
371
384 QString translateSystemLocale(const char *context, const char *sourceText, const char *disambiguation = nullptr, int n = -1) const;
385
390 void doTriggerMenuItem(MainMenuItem menuItem);
391
398 void pushStatus(StatusInfo sinfo, const QString &message, const QString &messagetip = QString());
399
404 void popStatus(StatusInfo sinfo);
405
410 void gotoFrame(int frameNum);
411
416 int maxMenuDepth(void) { return 5; }
417
418private:
424 void whenInitializedDispatch(const QObject *context, std::function<void()> fn);
425
426 /* @brief Gets the list of paths that might contain translation .ts files */
427 QStringList getTranslationsPaths() const;
428
430 bool initialized_;
431
433 bool is_reloading_lua_;
434
436 QTimer packet_data_timer_;
437
439 QTimer tap_update_timer_;
440
442 QList<QString> pending_open_files_;
443
445 QSocketNotifier *if_notifier_;
446
448 static QString window_title_separator_;
449
451 QList<AppSignal> app_signals_;
452
454 int active_captures_;
455
459 void storeCustomColorsInRecent();
460
464 void clearDynamicMenuGroupItems();
465
466protected:
472 bool event(QEvent *event) override;
473
477 virtual void initializeIcons() = 0;
478
481
484
485signals:
495 void localInterfaceEvent(const char *ifname, int added, int up);
497 void openCaptureFile(QString cf_path, QString display_filter, unsigned int type);
505 void profileNameChanged(const char *profile_name);
506
508 void freezePacketList(bool changing_profile);
536
538 void openStatCommandDialog(const QString &menu_path, const char *arg, void *userdata);
540 void openTapParameterDialog(const QString cfg_str, const QString arg, void *userdata);
541
543 void captureActive(int);
544
545public slots:
551
558 void flushAppSignals();
559
564
565private slots:
569 void updateTaps();
570
574 void cleanup();
575
579 void ifChangeEventsAvailable();
580
584 void refreshPacketData();
585
586};
587
588extern MainApplication *mainApp;
589
591
599
606#endif // MAIN_APPLICATION_H
Represents an event occurring during a capture or file operation.
Definition capture_event.h:24
Core application class handling global state, signals, and configurations.
Definition main_application.h:42
void openStatCommandDialog(const QString &menu_path, const char *arg, void *userdata)
Signal emitted to open a specific stat command dialog.
void queueAppSignal(AppSignal signal)
Queues an application signal to be emitted later.
Definition main_application.h:138
void clearAddedMenuGroupItems()
Clears the list of tracked added menu group items.
Definition main_application.cpp:611
QTranslator translatorQt
Definition main_application.h:364
void localInterfaceEvent(const char *ifname, int added, int up)
Signal emitted for local interface events (add/remove/up/down).
void packetDissectionChanged()
Signal emitted when packet dissection settings are changed.
AppSignal
Enumeration of application-wide signals.
Definition main_application.h:60
@ PacketDissectionChanged
Packet dissection preferences changed.
Definition main_application.h:74
@ ColumnsChanged
Packet list columns changed.
Definition main_application.h:64
@ FreezePacketList
Freeze the packet list updates.
Definition main_application.h:80
@ FilterExpressionsChanged
Filter expressions changed.
Definition main_application.h:70
@ RecentPreferencesRead
Recent preferences have been read.
Definition main_application.h:78
@ AggregationChanged
Aggregation logic or values changed.
Definition main_application.h:82
@ PreferencesChanged
General preferences changed.
Definition main_application.h:76
@ CaptureFilterListChanged
Capture filter list changed.
Definition main_application.h:62
@ FieldsChanged
Protocol fields changed.
Definition main_application.h:68
@ NameResolutionChanged
Name resolution configuration changed.
Definition main_application.h:72
@ DisplayFilterListChanged
Display filter list changed.
Definition main_application.h:66
const QIcon & normalIcon()
Retrieves the normal application icon.
Definition main_application.cpp:308
void appendDynamicMenuGroupItem(int group, QAction *sg_action)
Appends an action item to a dynamic menu group.
Definition main_application.cpp:553
void helpTopicAction(topic_action_e action)
Executes a help topic action.
Definition main_application.cpp:174
void captureActive(int)
Signals activation and stop of a capture. The value provides the number of active captures.
void reloadLuaPluginsDelayed()
Triggers a delayed reload of Lua plugins.
Definition main_application.cpp:298
QString translateSystemLocale(const char *context, const char *sourceText, const char *disambiguation=nullptr, int n=-1) const
Gets a translation in the system (not necessarily current) locale.
Definition main_application.cpp:862
virtual void initializeIcons()=0
Pure virtual method for initializing application icons.
void preferencesChanged()
Signal emitted when preferences are changed.
void popStatus(StatusInfo sinfo)
Pops the most recent status message of a given type.
Definition main_application.cpp:991
struct _e_prefs * readConfigurationFiles(bool reset)
Reads application configuration files.
Definition main_application.cpp:777
void removeDynamicMenuGroupItem(int group, QAction *sg_action)
Removes an action item from a dynamic menu group.
Definition main_application.cpp:562
void allSystemsGo()
Indicates that initial setup is complete and all systems are operational.
Definition main_application.cpp:752
void doTriggerMenuItem(MainMenuItem menuItem)
Triggers a specific main menu item.
Definition main_application.cpp:894
QTranslator translator
Definition main_application.h:361
void profileNameChanged(const char *profile_name)
Signal emitted when the configuration profile name has changed.
QIcon normal_icon_
Definition main_application.h:480
~MainApplication()
Destroys the MainApplication.
Definition main_application.cpp:466
void emitLocalInterfaceEvent(const char *ifname, int added, int up)
Emits a signal regarding local interface status changes.
Definition main_application.cpp:707
bool event(QEvent *event) override
Core Qt event handler override.
Definition main_application.cpp:371
bool isReloadingLua()
Checks if Lua plugins are currently reloading.
Definition main_application.h:304
void gotoFrame(int frameNum)
Triggers navigation to a specific frame number.
Definition main_application.cpp:1026
void displayFilterListChanged()
Signal emitted when display filters are changed.
void freezePacketList(bool changing_profile)
Signal emitted to freeze or unfreeze packet list updates.
void openTapParameterDialog(const QString cfg_str, const QString arg, void *userdata)
Signal emitted to open a tap parameter dialog.
void interfaceListChanged()
Signal emitted when interface list changes (forwarded from the MainWindow's InterfaceListManager,...
void recentPreferencesRead()
Signal emitted when recent preferences are read.
MainApplication(int &argc, char **argv)
Constructs the MainApplication.
Definition main_application.cpp:401
void reloadDisplayFilterMacros()
Reloads display filter macros.
Definition main_application.cpp:1036
MainWindow * mainWindow()
Retrieves the main window instance.
Definition main_application.cpp:348
void emitAppSignal(AppSignal signal)
Emits a specific application signal.
Definition main_application.cpp:472
void openCaptureOptions()
Signal emitted to open the capture options dialog.
void whenInitialized(const QObject *context, Func &&fn)
Runs fn once the application has finished initialization.
Definition main_application.h:285
void setReloadingLua(bool is_reloading)
Sets the flag indicating if Lua is currently reloading.
Definition main_application.h:298
void columnDataChanged()
Signal emitted when column data definitions change.
void checkDisplayFilter()
Signal emitted to check display filter validity.
const QString windowTitleString(QString title_part)
Generates a window title with a single part.
Definition main_application.h:336
QList< QAction * > addedMenuGroupItems(int group)
Retrieves items recently added to a dynamic menu group.
Definition main_application.cpp:589
bool isInitialized()
Checks if the application is initialized.
Definition main_application.h:264
const QIcon & captureIcon()
Retrieves the capture application icon.
Definition main_application.cpp:316
void emitStatCommandSignal(const QString &menu_path, const char *arg, void *userdata)
Emits a signal to execute a statistics command.
Definition main_application.cpp:534
void clearRemovedMenuGroupItems()
Clears the list of tracked removed menu group items.
Definition main_application.cpp:618
QList< QAction * > dynamicMenuGroupItems(int group)
Retrieves all action items for a dynamic menu group.
Definition main_application.cpp:578
void loadLanguage(const QString language)
Loads a specific UI language.
Definition main_application.cpp:838
QDir openDialogInitialDir()
Retrieves the initial directory for open dialogs.
Definition main_application.cpp:162
const QString windowTitleString(QStringList title_parts)
Generates a window title from parts.
Definition main_application.cpp:324
void setLastOpenDirFromFilename(QString file_name)
Sets the last opened directory from a given filename.
Definition main_application.cpp:166
void reloadLuaPlugins()
Signal emitted to initiate a Lua plugin reload.
StatusInfo
Enumeration for status bar information types.
Definition main_application.h:98
@ FieldStatus
Protocol field status.
Definition main_application.h:102
@ BusyStatus
Application busy status.
Definition main_application.h:106
@ FilterSyntax
Filter syntax status.
Definition main_application.h:100
@ TemporaryStatus
General temporary status message.
Definition main_application.h:110
@ FileStatus
File operations status.
Definition main_application.h:104
@ ByteStatus
Byte loading/processing status.
Definition main_application.h:108
void filterExpressionsChanged()
Signal emitted when filter expressions are changed.
QIcon capture_icon_
Definition main_application.h:483
void captureEventHandler(CaptureEvent ev)
Slot for handling capture events.
Definition main_application.cpp:907
void aggregationChanged()
Signal emitted when aggregation values change.
MainMenuItem
Enumeration for standard main menu items.
Definition main_application.h:88
@ FileOpenDialog
The file open dialog action.
Definition main_application.h:90
@ CaptureOptionsDialog
The capture options dialog action.
Definition main_application.h:92
void emitTapParameterSignal(const QString cfg_abbr, const QString arg, void *userdata)
Emits a signal indicating tap parameters changed.
Definition main_application.cpp:539
void addressResolutionChanged()
Signal emitted when address resolution settings change.
const QString & windowTitleSeparator() const
Retrieves the window title separator string.
Definition main_application.h:322
void appInitialized()
Signal emitted when application is fully initialized.
void addDynamicMenuGroupItem(int group, QAction *sg_action)
Adds an action item to a dynamic menu group.
Definition main_application.cpp:545
void applyCustomColorsFromRecent()
Applies custom colors stored in recent files.
Definition main_application.cpp:335
int maxMenuDepth(void)
Defines the maximum nested depth allowed for menus.
Definition main_application.h:416
void captureFilterListChanged()
Signal emitted when capture filters are changed.
void columnsChanged()
Signal emitted when columns are changed (recreates packet list). XXX This recreates the packet list....
void fieldsChanged()
Signal emitted when protocol fields change.
void pushStatus(StatusInfo sinfo, const QString &message, const QString &messagetip=QString())
Pushes a message to the specified status bar section.
Definition main_application.cpp:956
void setConfigurationProfile(const char *profile_name, bool write_recent_file=true, bool reload=false)
Sets the active configuration profile.
Definition main_application.cpp:183
void profileChanging()
Signal emitted while the configuration profile is changing.
void openCaptureFile(QString cf_path, QString display_filter, unsigned int type)
Signal emitted to open a specific capture file.
QList< QAction * > removedMenuGroupItems(int group)
Retrieves items recently removed from a dynamic menu group.
Definition main_application.cpp:600
void flushAppSignals()
Flushes queued app signals.
Definition main_application.cpp:527
The main window of the application.
Definition main_window.h:52
GList ** feature_list
Semi-opaque handle to a list of features or dependencies.
Definition feature_list.h:33
topic_action_e
Identifies a help topic or navigable destination reachable from the UI help system.
Definition help_url.h:28
void gather_wireshark_runtime_info(feature_list l)
Gather runtime information for Wireshark.
Definition main.cpp:262
void gather_wireshark_qt_compiled_info(feature_list l)
Gather compiled information for Wireshark Qt components.
Definition main.cpp:221
Global Wireshark preferences structure holding all persistent configuration settings.
Definition prefs.h:222