Wireshark  4.3.0
The Wireshark network protocol analyzer
column-info.h
Go to the documentation of this file.
1 /* column-info.h
2  * Definitions for internal column structures and routines
3  *
4  * For internal Wireshark use only. Don't include this header in dissectors!
5  *
6  * Wireshark - Network traffic analyzer
7  * By Gerald Combs <gerald@wireshark.org>
8  * Copyright 1998 Gerald Combs
9  *
10  * SPDX-License-Identifier: GPL-2.0-or-later
11  */
12 
13 #ifndef __COLUMN_INFO_H__
14 #define __COLUMN_INFO_H__
15 
16 #include <glib.h>
17 #include <epan/column-utils.h>
18 
19 #ifdef __cplusplus
20 extern "C" {
21 #endif /* __cplusplus */
22 
27 typedef struct _proto_node proto_tree;
28 
29 #define COLUMN_FIELD_FILTER "_ws.col."
30 
32 typedef struct {
33  const gchar **col_expr;
34  gchar **col_expr_val;
35 } col_expr_t;
36 
38 typedef struct {
39  gint col_fmt;
40  gboolean *fmt_matx;
41  gchar *col_title;
46  const gchar *col_data;
47  gchar *col_buf;
48  int col_fence;
49  gboolean writable;
50  int hf_id;
51 } col_item_t;
52 
55  const struct epan_session *epan;
56  gint num_cols;
58  gint *col_first;
59  gint *col_last;
61  gboolean writable;
62  GRegex *prime_regex;
63 };
64 
68 WS_DLL_PUBLIC void col_setup(column_info *cinfo, const gint num_cols);
69 
73 WS_DLL_PUBLIC void col_cleanup(column_info *cinfo);
74 
77 extern void col_init(column_info *cinfo, const struct epan_session *epan);
78 
81 WS_DLL_PUBLIC void col_fill_in_frame_data(const frame_data *fd, column_info *cinfo, const gint col, gboolean const fill_col_exprs);
82 
85 WS_DLL_PUBLIC void col_fill_in(packet_info *pinfo, const gboolean fill_col_exprs, const gboolean fill_fd_colums);
86 
91 WS_DLL_PUBLIC void col_fill_in_error(column_info *cinfo, frame_data *fdata, const gboolean fill_col_exprs, const gboolean fill_fd_colums);
92 
95 WS_DLL_PUBLIC gboolean col_data_changed(void);
96 
97 void col_custom_set_edt(struct epan_dissect *edt, column_info *cinfo);
98 
99 WS_DLL_PUBLIC
100 void col_custom_prime_edt(struct epan_dissect *edt, column_info *cinfo);
101 
104 WS_DLL_PUBLIC
105 char* col_custom_get_filter(struct epan_dissect *edt, column_info *cinfo, const gint col);
106 
107 WS_DLL_PUBLIC
108 gboolean have_custom_cols(column_info *cinfo);
109 
110 WS_DLL_PUBLIC
111 gboolean have_field_extractors(void);
112 
113 WS_DLL_PUBLIC
114 gboolean col_has_time_fmt(column_info *cinfo, const gint col);
115 
116 WS_DLL_PUBLIC
117 gboolean col_based_on_frame_data(column_info *cinfo, const gint col);
118 
119 void
120 col_register_protocol(void);
121 
122 extern
123 void col_dissect(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree);
124 
125 #ifdef __cplusplus
126 }
127 #endif /* __cplusplus */
128 
129 #endif /* __COLUMN_INFO_H__ */
void col_init(column_info *cinfo, const struct epan_session *epan)
Definition: column-utils.c:135
WS_DLL_PUBLIC char * col_custom_get_filter(struct epan_dissect *edt, column_info *cinfo, const gint col)
Definition: column-utils.c:420
WS_DLL_PUBLIC void col_fill_in(packet_info *pinfo, const gboolean fill_col_exprs, const gboolean fill_fd_colums)
Definition: column-utils.c:1883
WS_DLL_PUBLIC void col_fill_in_error(column_info *cinfo, frame_data *fdata, const gboolean fill_col_exprs, const gboolean fill_fd_colums)
Definition: column-utils.c:2001
WS_DLL_PUBLIC gboolean col_data_changed(void)
Definition: column-utils.c:2031
WS_DLL_PUBLIC void col_fill_in_frame_data(const frame_data *fd, column_info *cinfo, const gint col, gboolean const fill_col_exprs)
Definition: column-utils.c:1809
WS_DLL_PUBLIC void col_setup(column_info *cinfo, const gint num_cols)
Definition: column-utils.c:61
WS_DLL_PUBLIC void col_cleanup(column_info *cinfo)
Definition: column-utils.c:97
Definition: packet_info.h:44
Definition: proto.h:897
Definition: column-info.h:32
const gchar ** col_expr
Definition: column-info.h:33
gchar ** col_expr_val
Definition: column-info.h:34
Definition: column-info.h:38
gint col_custom_occurrence
Definition: column-info.h:43
const gchar * col_data
Definition: column-info.h:46
struct epan_dfilter * col_custom_dfilter
Definition: column-info.h:45
gint col_fmt
Definition: column-info.h:39
GSList * col_custom_fields_ids
Definition: column-info.h:44
gboolean writable
Definition: column-info.h:49
int col_fence
Definition: column-info.h:48
gchar * col_custom_fields
Definition: column-info.h:42
gchar * col_buf
Definition: column-info.h:47
gchar * col_title
Definition: column-info.h:41
gboolean * fmt_matx
Definition: column-info.h:40
Definition: column-info.h:54
gboolean writable
Definition: column-info.h:61
gint * col_first
Definition: column-info.h:58
gint * col_last
Definition: column-info.h:59
GRegex * prime_regex
Definition: column-info.h:62
gint num_cols
Definition: column-info.h:56
col_expr_t col_expr
Definition: column-info.h:60
col_item_t * columns
Definition: column-info.h:57
Definition: dfilter-int.h:35
Definition: epan_dissect.h:28
Definition: epan.c:460
Definition: tvbuff-int.h:35