Wireshark  4.3.0
The Wireshark network protocol analyzer
print.h
Go to the documentation of this file.
1 
13 #ifndef __PRINT_H__
14 #define __PRINT_H__
15 
16 #include <stdio.h>
17 
18 #include <epan/epan.h>
19 #include <epan/packet.h>
20 #include <epan/print_stream.h>
21 
22 #include <wsutil/json_dumper.h>
23 
24 #include "ws_symbol_export.h"
25 
26 #ifdef __cplusplus
27 extern "C" {
28 #endif /* __cplusplus */
29 
30 /* print output format */
31 typedef enum {
32  PR_FMT_TEXT, /* plain text */
33  PR_FMT_PS /* postscript */
34 } print_format_e;
35 
36 /* print_dissections, enum how the dissections should be printed */
37 typedef enum {
38  print_dissections_none, /* no dissections at all */
39  print_dissections_collapsed, /* no dissection details */
40  print_dissections_as_displayed, /* details as displayed */
41  print_dissections_expanded /* all dissection details */
42 } print_dissections_e;
43 
44 
45 typedef enum {
46  FORMAT_CSV, /* CSV */
47  FORMAT_JSON, /* JSON */
48  FORMAT_EK, /* JSON bulk insert to Elasticsearch */
49  FORMAT_XML /* PDML output */
50 } fields_format;
51 
52 typedef enum {
53  PF_NONE = 0x00,
54  PF_INCLUDE_CHILDREN = 0x01
55 } pf_flags;
56 
57 /*
58  * Print user selected list of fields
59  */
60 struct _output_fields;
61 typedef struct _output_fields output_fields_t;
62 
63 typedef GSList* (*proto_node_children_grouper_func)(proto_node *node);
64 
65 WS_DLL_PUBLIC output_fields_t* output_fields_new(void);
66 WS_DLL_PUBLIC void output_fields_free(output_fields_t* info);
67 WS_DLL_PUBLIC void output_fields_add(output_fields_t* info, const gchar* field);
68 WS_DLL_PUBLIC GSList * output_fields_valid(output_fields_t* info);
69 WS_DLL_PUBLIC gsize output_fields_num_fields(output_fields_t* info);
70 WS_DLL_PUBLIC gboolean output_fields_set_option(output_fields_t* info, gchar* option);
71 WS_DLL_PUBLIC void output_fields_list_options(FILE *fh);
72 WS_DLL_PUBLIC bool output_fields_add_protocolfilter(output_fields_t* info, const char* field, pf_flags filter_flags);
73 WS_DLL_PUBLIC gboolean output_fields_has_cols(output_fields_t* info);
74 
75 /*
76  * Higher-level packet-printing code.
77  */
78 
79 WS_DLL_PUBLIC gboolean proto_tree_print(print_dissections_e print_dissections,
80  bool print_hex_data,
81  epan_dissect_t *edt,
82  GHashTable *output_only_tables,
84 
85 /*
86  * Hexdump option for displaying data sources:
87  */
88 
89 #define HEXDUMP_SOURCE_MASK (0x0004U)
90 #define HEXDUMP_SOURCE_OPTION(option) ((option) & HEXDUMP_SOURCE_MASK)
91 
92 #define HEXDUMP_SOURCE_MULTI (0x0000U) /* create hexdumps for all data sources assigned to a frame (legacy tshark behavor) */
93 #define HEXDUMP_SOURCE_PRIMARY (0x0004U) /* create hexdumps for only the frame data */
94 
95 WS_DLL_PUBLIC bool print_hex_data(print_stream_t *stream, epan_dissect_t *edt, guint hexdump_options);
96 
97 WS_DLL_PUBLIC void write_pdml_preamble(FILE *fh, const gchar* filename);
98 WS_DLL_PUBLIC void write_pdml_proto_tree(output_fields_t* fields, epan_dissect_t *edt, column_info *cinfo, FILE *fh, gboolean use_color);
99 WS_DLL_PUBLIC void write_pdml_finale(FILE *fh);
100 
101 // Implementations of proto_node_children_grouper_func
102 // Groups each child separately
103 WS_DLL_PUBLIC GSList *proto_node_group_children_by_unique(proto_node *node);
104 // Groups children by json key (children with the same json key get put in the same group
105 WS_DLL_PUBLIC GSList *proto_node_group_children_by_json_key(proto_node *node);
106 
107 WS_DLL_PUBLIC json_dumper write_json_preamble(FILE *fh);
108 WS_DLL_PUBLIC void write_json_proto_tree(output_fields_t* fields,
109  print_dissections_e print_dissections,
110  bool print_hex_data,
111  epan_dissect_t *edt,
112  column_info *cinfo,
113  proto_node_children_grouper_func node_children_grouper,
114  json_dumper *dumper);
115 WS_DLL_PUBLIC void write_json_finale(json_dumper *dumper);
116 
117 WS_DLL_PUBLIC void write_ek_proto_tree(output_fields_t* fields,
118  bool print_summary,
119  bool print_hex_data,
120  epan_dissect_t *edt,
121  column_info *cinfo, FILE *fh);
122 
123 WS_DLL_PUBLIC void write_psml_preamble(column_info *cinfo, FILE *fh);
124 WS_DLL_PUBLIC void write_psml_columns(epan_dissect_t *edt, FILE *fh, gboolean use_color);
125 WS_DLL_PUBLIC void write_psml_finale(FILE *fh);
126 
127 WS_DLL_PUBLIC void write_csv_column_titles(column_info *cinfo, FILE *fh);
128 WS_DLL_PUBLIC void write_csv_columns(epan_dissect_t *edt, FILE *fh);
129 
130 WS_DLL_PUBLIC void write_carrays_hex_data(guint32 num, FILE *fh, epan_dissect_t *edt);
131 
132 WS_DLL_PUBLIC void write_fields_preamble(output_fields_t* fields, FILE *fh);
133 WS_DLL_PUBLIC void write_fields_proto_tree(output_fields_t* fields, epan_dissect_t *edt, column_info *cinfo, FILE *fh);
134 WS_DLL_PUBLIC void write_fields_finale(output_fields_t* fields, FILE *fh);
135 
136 WS_DLL_PUBLIC gchar* get_node_field_value(field_info* fi, epan_dissect_t* edt);
137 
138 extern void print_cache_field_handles(void);
139 
140 #ifdef __cplusplus
141 }
142 #endif /* __cplusplus */
143 
144 #endif /* print.h */
WS_DLL_PUBLIC GSList * proto_node_group_children_by_unique(proto_node *node)
Definition: print.c:1071
WS_DLL_PUBLIC GSList * proto_node_group_children_by_json_key(proto_node *node)
Definition: print.c:1089
Definition: print.c:72
Definition: proto.h:897
Definition: column-info.h:54
Definition: epan_dissect.h:28
Definition: proto.h:809
Definition: file-pcapng.h:57
Definition: json_dumper.h:57
Definition: print_stream.h:43
Definition: stream.c:41