2 * Definitions for printing packet analysis trees.
6 * Gilbert Ramirez <gram@alumni.rice.edu>
8 * Wireshark - Network traffic analyzer
9 * By Gerald Combs <gerald@wireshark.org>
10 * Copyright 1998 Gerald Combs
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation; either version 2
15 * of the License, or (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
32 #include <epan/packet.h>
34 #include "packet-range.h"
37 * Print stream code; this provides a "print stream" class with subclasses
38 * of various sorts. Additional subclasses might be implemented elsewhere.
42 typedef struct print_stream_ops {
43 gboolean (*print_preamble)(struct print_stream *self, gchar *filename);
44 gboolean (*print_line)(struct print_stream *self, int indent,
46 gboolean (*print_bookmark)(struct print_stream *self,
47 const gchar *name, const gchar *title);
48 gboolean (*new_page)(struct print_stream *self);
49 gboolean (*print_finale)(struct print_stream *self);
50 gboolean (*destroy)(struct print_stream *self);
53 typedef struct print_stream {
54 const print_stream_ops_t *ops;
58 extern print_stream_t *print_stream_text_new(int to_file, const char *dest);
59 extern print_stream_t *print_stream_text_stdio_new(FILE *fh);
60 extern print_stream_t *print_stream_ps_new(int to_file, const char *dest);
61 extern print_stream_t *print_stream_ps_stdio_new(FILE *fh);
63 extern gboolean print_preamble(print_stream_t *self, gchar *filename);
64 extern gboolean print_line(print_stream_t *self, int indent, const char *line);
65 extern gboolean print_bookmark(print_stream_t *self, const gchar *name,
67 extern gboolean new_page(print_stream_t *self);
68 extern gboolean print_finale(print_stream_t *self);
69 extern gboolean destroy_print_stream(print_stream_t *self);
71 /* print output format */
73 PR_FMT_TEXT, /* plain text */
74 PR_FMT_PS /* postscript */
77 /* print_range, enum which frames should be printed */
79 print_range_selected_only, /* selected frame(s) only (currently only one) */
80 print_range_marked_only, /* marked frames only */
81 print_range_all_displayed, /* all frames currently displayed */
82 print_range_all_captured /* all frames in capture */
85 /* print_dissections, enum how the dissections should be printed */
87 print_dissections_none, /* no dissections at all */
88 print_dissections_collapsed, /* no dissection details */
89 print_dissections_as_displayed, /* details as displayed */
90 print_dissections_expanded /* all dissection details */
91 } print_dissections_e;
94 print_stream_t *stream; /* the stream to which we're printing */
95 print_format_e format; /* plain text or PostScript */
96 gboolean to_file; /* TRUE if we're printing to a file */
97 char *file; /* file output pathname */
98 char *cmd; /* print command string (not win32) */
101 gboolean print_summary; /* TRUE if we should just print summary;
102 FALSE if we should print protocol tree. */
103 print_dissections_e print_dissections;
104 gboolean print_hex; /* TRUE if we should also print hex data;
105 FALSE if we should print only if not dissected. */
106 gboolean print_formfeed; /* TRUE if a formfeed should be printed
107 before each new packet */
111 * Print user selected list of fields
113 struct _output_fields;
114 typedef struct _output_fields output_fields_t;
116 extern output_fields_t* output_fields_new(void);
117 extern void output_fields_free(output_fields_t* info);
118 extern void output_fields_add(output_fields_t* info, const gchar* field);
119 extern gsize output_fields_num_fields(output_fields_t* info);
120 extern gboolean output_fields_set_option(output_fields_t* info, gchar* option);
121 extern void output_fields_list_options(FILE *fh);
123 * Higher-level packet-printing code.
126 extern gboolean proto_tree_print(print_args_t *print_args, epan_dissect_t *edt,
127 print_stream_t *stream);
128 extern gboolean print_hex_data(print_stream_t *stream, epan_dissect_t *edt);
130 extern void write_pdml_preamble(FILE *fh);
131 extern void proto_tree_write_pdml(epan_dissect_t *edt, FILE *fh);
132 extern void write_pdml_finale(FILE *fh);
134 extern void write_psml_preamble(FILE *fh);
135 extern void proto_tree_write_psml(epan_dissect_t *edt, FILE *fh);
136 extern void write_psml_finale(FILE *fh);
138 extern void write_csv_preamble(FILE *fh);
139 extern void proto_tree_write_csv(epan_dissect_t *edt, FILE *fh);
140 extern void write_csv_finale(FILE *fh);
142 extern void write_carrays_preamble(FILE *fh);
143 extern void proto_tree_write_carrays(const guint8 *pd, guint32 len, guint32 num, FILE *fh);
144 extern void write_carrays_finale(FILE *fh);
146 extern void write_fields_preamble(output_fields_t* fields, FILE *fh);
147 extern void proto_tree_write_fields(output_fields_t* fields, epan_dissect_t *edt, FILE *fh);
148 extern void write_fields_finale(output_fields_t* fields, FILE *fh);
150 extern const gchar* get_node_field_value(field_info* fi, epan_dissect_t* edt);