color_filters.h

Go to the documentation of this file.

/* color_filters.h
 * Definitions for color filters
 *
 * Wireshark - Network traffic analyzer
 * By Gerald Combs <gerald@wireshark.org>
 * Copyright 1998 Gerald Combs
 *
 * SPDX-License-Identifier: GPL-2.0-or-later
 */
#pragma once
#include <glib.h>
#include <string.h>
 
#include "ws_symbol_export.h"
 
#include <wsutil/color.h>
#include <wsutil/wmem/wmem_list.h>
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
struct epan_dissect;
 
#define COLORING_RULES_FILE_NAME "coloring_rules.jsonc"
/* Legacy name */
#define COLORFILTERS_FILE_NAME "colorfilters"
 
#define CONVERSATION_COLOR_PREFIX       "___conversation_color_filter___"

typedef struct _color_filter {
    char      *filter_name;         /* name of the filter */
    char      *filter_text;         /* text of the filter expression */
    color_t    bg_color;            /* background color for packets that match */
    color_t    fg_color;            /* foreground color for packets that match */
    bool       enabled;             /* set if the filter is enabled */
 
                                    /* only used inside of color_filters.c */
    struct epan_dfilter *c_colorfilter;  /* compiled filter expression */
 
                                    /* only used outside of color_filters.c (beside init) */
} color_filter_t;

static inline bool
color_filter_is_tmp(const color_filter_t *colorf)
{
    return strncmp(colorf->filter_name, CONVERSATION_COLOR_PREFIX,
                   strlen(CONVERSATION_COLOR_PREFIX)) == 0;
}

typedef void (*color_filter_add_cb_func)(color_filter_t *colorf, void *user_data);

WS_DLL_PUBLIC bool color_filters_init(char** err_msg, color_filter_add_cb_func add_cb, const char* app_env_var_prefix);

WS_DLL_PUBLIC bool color_filters_reload(char** err_msg, color_filter_add_cb_func add_cb, const char* app_env_var_prefix);

WS_DLL_PUBLIC void color_filters_cleanup(void);

WS_DLL_PUBLIC bool color_filters_used(void);

WS_DLL_PUBLIC bool tmp_color_filters_used(void);

WS_DLL_PUBLIC char*
color_filters_get_tmp(uint8_t filt_nr);

WS_DLL_PUBLIC bool
color_filters_set_tmp(uint8_t filt_nr, const char *filter, bool disabled, char **err_msg);

WS_DLL_PUBLIC const color_filter_t *
color_filters_tmp_color(uint8_t filter_num);

WS_DLL_PUBLIC bool
color_filters_reset_tmp(char **err_msg);

WS_DLL_PUBLIC void color_filters_prime_edt(struct epan_dissect *edt);

WS_DLL_PUBLIC bool
color_filters_use_hfid(int hfid);

WS_DLL_PUBLIC bool
color_filters_use_proto(int proto_id);

WS_DLL_PUBLIC const color_filter_t *
color_filters_colorize_packet_all(struct epan_dissect *edt,
        wmem_allocator_t *scope, wmem_list_t **matches, bool include_disabled);

WS_DLL_PUBLIC void color_filters_clone(void *user_data, color_filter_add_cb_func add_cb);

WS_DLL_PUBLIC bool color_filters_import(const char *path, void *user_data, char **err_msg, color_filter_add_cb_func add_cb);

WS_DLL_PUBLIC bool color_filters_read_globals(void *user_data, char** err_msg, color_filter_add_cb_func add_cb, const char* app_env_var_prefix);
 

WS_DLL_PUBLIC bool color_filters_apply(GSList *tmp_cfl, GSList *edit_cfl, char** err_msg);

WS_DLL_PUBLIC bool color_filters_write(GSList *cfl, const char* app_name, const char* app_env_var_prefix, char** err_msg);

WS_DLL_PUBLIC bool color_filters_export(const char *path, GSList *cfl, bool only_selected, const char* app_name, char** err_msg);

WS_DLL_PUBLIC color_filter_t *color_filter_new(
    const char *name, const char *filter_string,
    color_t *bg_color, color_t *fg_color, bool enabled);

WS_DLL_PUBLIC void color_filter_delete(color_filter_t *colorf);

WS_DLL_PUBLIC void color_filter_list_delete(GSList **cfl);
 
#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:
 */