From Francesco Fondelli (bug 2349):
[obnox/wireshark/wip.git] / print.h
1 /* print.h
2  * Definitions for printing packet analysis trees.
3  *
4  * $Id$
5  *
6  * Gilbert Ramirez <gram@alumni.rice.edu>
7  *
8  * Wireshark - Network traffic analyzer
9  * By Gerald Combs <gerald@wireshark.org>
10  * Copyright 1998 Gerald Combs
11  *
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.
16  *
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.
21  *
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.
25  */
26
27 #ifndef __PRINT_H__
28 #define __PRINT_H__
29
30 #include <epan/packet.h>
31
32 #include "packet-range.h"
33
34 /*
35  * Print stream code; this provides a "print stream" class with subclasses
36  * of various sorts.  Additional subclasses might be implemented elsewhere.
37  */
38 struct print_stream;
39
40 typedef struct print_stream_ops {
41         gboolean (*print_preamble)(struct print_stream *self, gchar *filename);
42         gboolean (*print_line)(struct print_stream *self, int indent,
43             const char *line);
44         gboolean (*print_bookmark)(struct print_stream *self,
45             const gchar *name, const gchar *title);
46         gboolean (*new_page)(struct print_stream *self);
47         gboolean (*print_finale)(struct print_stream *self);
48         gboolean (*destroy)(struct print_stream *self);
49 } print_stream_ops_t;
50
51 typedef struct print_stream {
52         const print_stream_ops_t *ops;
53         void *data;
54 } print_stream_t;
55
56 extern print_stream_t *print_stream_text_new(int to_file, const char *dest);
57 extern print_stream_t *print_stream_text_stdio_new(FILE *fh);
58 extern print_stream_t *print_stream_ps_new(int to_file, const char *dest);
59 extern print_stream_t *print_stream_ps_stdio_new(FILE *fh);
60
61 extern gboolean print_preamble(print_stream_t *self, gchar *filename);
62 extern gboolean print_line(print_stream_t *self, int indent, const char *line);
63 extern gboolean print_bookmark(print_stream_t *self, const gchar *name,
64     const gchar *title);
65 extern gboolean new_page(print_stream_t *self);
66 extern gboolean print_finale(print_stream_t *self);
67 extern gboolean destroy_print_stream(print_stream_t *self);
68
69 /* print output format */
70 typedef enum {
71   PR_FMT_TEXT,    /* plain text */
72   PR_FMT_PS       /* postscript */
73 } print_format_e;
74
75 /* print_range, enum which frames should be printed */
76 typedef enum {
77   print_range_selected_only,    /* selected frame(s) only (currently only one) */
78   print_range_marked_only,      /* marked frames only */
79   print_range_all_displayed,    /* all frames currently displayed */
80   print_range_all_captured      /* all frames in capture */
81 } print_range_e;
82
83 /* print_dissections, enum how the dissections should be printed */
84 typedef enum {
85   print_dissections_none,         /* no dissections at all */
86   print_dissections_collapsed,    /* no dissection details */
87   print_dissections_as_displayed, /* details as displayed */
88   print_dissections_expanded      /* all dissection details */
89 } print_dissections_e;
90
91 typedef struct {
92   print_stream_t *stream;       /* the stream to which we're printing */
93   print_format_e format;        /* plain text or PostScript */
94   gboolean      to_file;        /* TRUE if we're printing to a file */
95   char          *file;          /* file output pathname */
96   char          *cmd;           /* print command string (not win32) */
97   packet_range_t range;
98
99   gboolean      print_summary;  /* TRUE if we should just print summary;
100                                    FALSE if we should print protocol tree. */
101   print_dissections_e   print_dissections;
102   gboolean      print_hex;      /* TRUE if we should also print hex data;
103                                    FALSE if we should print only if not dissected. */
104   gboolean      print_formfeed; /* TRUE if a formfeed should be printed 
105                    before each new packet */
106 } print_args_t;
107
108 /*
109  * Print user selected list of fields
110  */
111 struct _output_fields;
112 typedef struct _output_fields output_fields_t;
113
114 extern output_fields_t* output_fields_new(void);
115 extern void output_fields_free(output_fields_t* info);
116 extern void output_fields_add(output_fields_t* info, const gchar* field);
117 extern gsize output_fields_num_fields(output_fields_t* info);
118 extern gboolean output_fields_set_option(output_fields_t* info, gchar* option);
119 extern void output_fields_list_options(FILE *fh);
120 /*
121  * Higher-level packet-printing code.
122  */
123
124 extern gboolean proto_tree_print(print_args_t *print_args, epan_dissect_t *edt,
125      print_stream_t *stream);
126 extern gboolean print_hex_data(print_stream_t *stream, epan_dissect_t *edt);
127
128 extern void write_pdml_preamble(FILE *fh);
129 extern void proto_tree_write_pdml(epan_dissect_t *edt, FILE *fh);
130 extern void write_pdml_finale(FILE *fh);
131
132 extern void write_psml_preamble(FILE *fh);
133 extern void proto_tree_write_psml(epan_dissect_t *edt, FILE *fh);
134 extern void write_psml_finale(FILE *fh);
135
136 extern void write_csv_preamble(FILE *fh);
137 extern void proto_tree_write_csv(epan_dissect_t *edt, FILE *fh);
138 extern void write_csv_finale(FILE *fh);
139
140 extern void write_carrays_preamble(FILE *fh);
141 extern void proto_tree_write_carrays(const guint8 *pd, guint32 len, guint32 num, FILE *fh);
142 extern void write_carrays_finale(FILE *fh);
143
144 extern void write_fields_preamble(output_fields_t* fields, FILE *fh);
145 extern void proto_tree_write_fields(output_fields_t* fields, epan_dissect_t *edt, FILE *fh);
146 extern void write_fields_finale(output_fields_t* fields, FILE *fh);
147
148 #endif /* print.h */