tag_rules.h

Go to the documentation of this file.

/* tag_rules.h
 * Definitions for tagging rules
 * Copyright 2026, Mark Stout <[email protected]>
 *
 * Wireshark - Network traffic analyzer
 * By Gerald Combs <[email protected]>
 * Copyright 1998 Gerald Combs
 *
 * SPDX-License-Identifier: GPL-2.0-or-later
 */
#pragma once
#include <glib.h>
 
#include "ws_symbol_export.h"
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
struct epan_dfilter;
struct epan_dissect;
 
#define TAGRULES_FILE_NAME         "tagrules.jsonc"   


typedef enum {
    TAG_LINK_CLICK_SINGLE = 0, 
    TAG_LINK_CLICK_CTRL,       
    TAG_LINK_CLICK_NONE        
} tag_link_click_mode_t;

typedef struct _tag_prefs {
    char                  separator;    
    int                   emoji_size;   
    tag_link_click_mode_t link_click;   
} tag_prefs_t;

typedef struct _tag_rule {
    char     *rule_name;              /* Name — also the frame.tag value for filtering */
    char     *filter_text;            /* Display filter expression */
    char     *tag_content;            /* Visual content shown in COL_TAG column (emoji / text) */
    char     *tag_url;                /* Optional URL opened when cell is clicked */
    char     *comment;                /* Optional reference comment */
    bool      disabled;
    struct epan_dfilter *c_tagfilter; /* compiled dfilter, NULL if disabled or invalid */
} tag_rule_t;

typedef void (*tag_rule_add_cb_func)(tag_rule_t *rule, void *user_data);

WS_DLL_PUBLIC void tag_rules_init(void);

WS_DLL_PUBLIC void tag_rules_reload(void);

WS_DLL_PUBLIC bool tag_rules_write(void);

WS_DLL_PUBLIC tag_rule_t *tag_rule_new(const char *name, const char *filter,
                                       const char *tag_content,
                                       const char *tag_url,
                                       const char *comment);

WS_DLL_PUBLIC void tag_rule_delete(tag_rule_t *rule);

WS_DLL_PUBLIC void tag_rules_clone(tag_rule_add_cb_func cb, void *user_data);

WS_DLL_PUBLIC void tag_rules_apply(GSList *new_list);

WS_DLL_PUBLIC const GSList *tag_rules_get_list(void);

WS_DLL_PUBLIC void tag_rules_prime_edt(struct epan_dissect *edt);

WS_DLL_PUBLIC bool tag_rules_used(void);

WS_DLL_PUBLIC tag_prefs_t tag_rules_get_prefs(void);

WS_DLL_PUBLIC void tag_rules_set_prefs(const tag_prefs_t *prefs);

WS_DLL_PUBLIC GSList *tag_rules_read_path(const char *path, char **err_msg);

WS_DLL_PUBLIC bool tag_rules_write_path(GSList *list, const char *path,
                                        const tag_prefs_t *prefs,
                                        char **err_msg);
 

WS_DLL_PUBLIC bool tag_rules_export_list(GSList *list, const char *path, char **err_msg);

WS_DLL_PUBLIC void tag_rule_list_free(GSList *list);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
/*
 * Editor modelines  -  https://www.wireshark.org/tools/modelines.html
 *
 * Local variables:
 * c-basic-offset: 4
 * tab-width: 8
 * indent-tabs-mode: nil
 * End:
 *
 * vi: set shiftwidth=4 tabstop=8 expandtab:
 * :indentSize=4:tabSize=8:noTabs=true:
 */