2 * Definitions for printing packet analysis trees.
4 * Gilbert Ramirez <gram@alumni.rice.edu>
6 * Wireshark - Network traffic analyzer
7 * By Gerald Combs <gerald@wireshark.org>
8 * Copyright 1998 Gerald Combs
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License
12 * as published by the Free Software Foundation; either version 2
13 * of the License, or (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
30 #include <epan/epan.h>
31 #include <epan/packet.h>
33 #include <epan/packet-range.h>
37 #endif /* __cplusplus */
40 * Print stream code; this provides a "print stream" class with subclasses
41 * of various sorts. Additional subclasses might be implemented elsewhere.
45 typedef struct print_stream_ops {
46 gboolean (*print_preamble)(struct print_stream *self, gchar *filename, const char *version_string);
47 gboolean (*print_line)(struct print_stream *self, int indent,
49 gboolean (*print_bookmark)(struct print_stream *self,
50 const gchar *name, const gchar *title);
51 gboolean (*new_page)(struct print_stream *self);
52 gboolean (*print_finale)(struct print_stream *self);
53 gboolean (*destroy)(struct print_stream *self);
56 typedef struct print_stream {
57 const print_stream_ops_t *ops;
61 WS_DLL_PUBLIC print_stream_t *print_stream_text_new(gboolean to_file, const char *dest);
62 WS_DLL_PUBLIC print_stream_t *print_stream_text_stdio_new(FILE *fh);
63 WS_DLL_PUBLIC print_stream_t *print_stream_ps_new(gboolean to_file, const char *dest);
64 WS_DLL_PUBLIC print_stream_t *print_stream_ps_stdio_new(FILE *fh);
66 WS_DLL_PUBLIC gboolean print_preamble(print_stream_t *self, gchar *filename, const char *version_string);
67 WS_DLL_PUBLIC gboolean print_line(print_stream_t *self, int indent, const char *line);
68 WS_DLL_PUBLIC gboolean print_bookmark(print_stream_t *self, const gchar *name,
70 WS_DLL_PUBLIC gboolean new_page(print_stream_t *self);
71 WS_DLL_PUBLIC gboolean print_finale(print_stream_t *self);
72 WS_DLL_PUBLIC gboolean destroy_print_stream(print_stream_t *self);
74 /* print output format */
76 PR_FMT_TEXT, /* plain text */
77 PR_FMT_PS /* postscript */
80 /* print_range, enum which frames should be printed */
82 print_range_selected_only, /* selected frame(s) only (currently only one) */
83 print_range_marked_only, /* marked frames only */
84 print_range_all_displayed, /* all frames currently displayed */
85 print_range_all_captured /* all frames in capture */
88 /* print_dissections, enum how the dissections should be printed */
90 print_dissections_none, /* no dissections at all */
91 print_dissections_collapsed, /* no dissection details */
92 print_dissections_as_displayed, /* details as displayed */
93 print_dissections_expanded /* all dissection details */
94 } print_dissections_e;
97 print_stream_t *stream; /* the stream to which we're printing */
98 print_format_e format; /* plain text or PostScript */
99 gboolean to_file; /* TRUE if we're printing to a file */
100 char *file; /* file output pathname */
101 char *cmd; /* print command string (not win32) */
102 packet_range_t range;
104 gboolean print_summary; /* TRUE if we should print summary line. */
105 gboolean print_col_headings; /* TRUE if we should print column headings */
106 print_dissections_e print_dissections;
107 gboolean print_hex; /* TRUE if we should print hex data;
108 * FALSE if we should print only if not dissected. */
109 gboolean print_formfeed; /* TRUE if a formfeed should be printed before
114 * Print user selected list of fields
116 struct _output_fields;
117 typedef struct _output_fields output_fields_t;
119 WS_DLL_PUBLIC output_fields_t* output_fields_new(void);
120 WS_DLL_PUBLIC void output_fields_free(output_fields_t* info);
121 WS_DLL_PUBLIC void output_fields_add(output_fields_t* info, const gchar* field);
122 WS_DLL_PUBLIC gsize output_fields_num_fields(output_fields_t* info);
123 WS_DLL_PUBLIC gboolean output_fields_set_option(output_fields_t* info, gchar* option);
124 WS_DLL_PUBLIC void output_fields_list_options(FILE *fh);
125 WS_DLL_PUBLIC gboolean output_fields_has_cols(output_fields_t* info);
128 * Output only these protocols
130 WS_DLL_PUBLIC GHashTable *output_only_tables;
133 * Higher-level packet-printing code.
136 WS_DLL_PUBLIC gboolean proto_tree_print(print_args_t *print_args, epan_dissect_t *edt,
137 print_stream_t *stream);
138 WS_DLL_PUBLIC gboolean print_hex_data(print_stream_t *stream, epan_dissect_t *edt);
140 WS_DLL_PUBLIC void write_pdml_preamble(FILE *fh, const gchar* filename);
141 WS_DLL_PUBLIC void proto_tree_write_pdml(epan_dissect_t *edt, FILE *fh);
142 WS_DLL_PUBLIC void write_pdml_finale(FILE *fh);
144 WS_DLL_PUBLIC void write_psml_preamble(FILE *fh);
145 WS_DLL_PUBLIC void proto_tree_write_psml(epan_dissect_t *edt, FILE *fh);
146 WS_DLL_PUBLIC void write_psml_finale(FILE *fh);
148 WS_DLL_PUBLIC void write_csv_preamble(FILE *fh);
149 WS_DLL_PUBLIC void proto_tree_write_csv(epan_dissect_t *edt, FILE *fh);
150 WS_DLL_PUBLIC void write_csv_finale(FILE *fh);
152 WS_DLL_PUBLIC void write_carrays_preamble(FILE *fh);
153 WS_DLL_PUBLIC void proto_tree_write_carrays(guint32 num, FILE *fh, epan_dissect_t *edt);
154 WS_DLL_PUBLIC void write_carrays_finale(FILE *fh);
156 WS_DLL_PUBLIC void write_fields_preamble(output_fields_t* fields, FILE *fh);
157 WS_DLL_PUBLIC void proto_tree_write_fields(output_fields_t* fields, epan_dissect_t *edt, column_info *cinfo, FILE *fh);
158 WS_DLL_PUBLIC void write_fields_finale(output_fields_t* fields, FILE *fh);
160 WS_DLL_PUBLIC gchar* get_node_field_value(field_info* fi, epan_dissect_t* edt);
164 #endif /* __cplusplus */