3a326c45e8dc9ba9a82a9dfcd6dba7938e15ec5f
[metze/wireshark/wip.git] / epan / print_stream.h
1 /* print.h
2  * Definitions for printing packet analysis trees.
3  *
4  * Gilbert Ramirez <gram@alumni.rice.edu>
5  *
6  * Wireshark - Network traffic analyzer
7  * By Gerald Combs <gerald@wireshark.org>
8  * Copyright 1998 Gerald Combs
9  *
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.
14  *
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.
19  *
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.
23  */
24
25 #ifndef __PRINT_STREAM_H__
26 #define __PRINT_STREAM_H__
27
28 #include "ws_symbol_export.h"
29
30 #ifdef __cplusplus
31 extern "C" {
32 #endif /* __cplusplus */
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, const char *version_string);
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 WS_DLL_PUBLIC print_stream_t *print_stream_text_new(gboolean to_file, const char *dest);
57 WS_DLL_PUBLIC print_stream_t *print_stream_text_stdio_new(FILE *fh);
58 WS_DLL_PUBLIC print_stream_t *print_stream_ps_new(gboolean to_file, const char *dest);
59 WS_DLL_PUBLIC print_stream_t *print_stream_ps_stdio_new(FILE *fh);
60
61 WS_DLL_PUBLIC gboolean print_preamble(print_stream_t *self, gchar *filename, const char *version_string);
62 WS_DLL_PUBLIC gboolean print_line(print_stream_t *self, int indent, const char *line);
63 WS_DLL_PUBLIC gboolean print_bookmark(print_stream_t *self, const gchar *name,
64     const gchar *title);
65 WS_DLL_PUBLIC gboolean new_page(print_stream_t *self);
66 WS_DLL_PUBLIC gboolean print_finale(print_stream_t *self);
67 WS_DLL_PUBLIC gboolean destroy_print_stream(print_stream_t *self);
68
69 #ifdef __cplusplus
70 }
71 #endif /* __cplusplus */
72
73 #endif /* print_stream.h */