print_stream: add a new print_line_color() method
[metze/wireshark/wip.git] / epan / print_stream.h
1 /* print_stream.h
2  * Definitions for print streams.
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 #include <wsutil/color.h>
31
32 #ifdef __cplusplus
33 extern "C" {
34 #endif /* __cplusplus */
35
36 /*
37  * Print stream code; this provides a "print stream" class with subclasses
38  * of various sorts.  Additional subclasses might be implemented elsewhere.
39  */
40 struct print_stream;
41
42 typedef struct print_stream_ops {
43         gboolean (*print_preamble)(struct print_stream *self, gchar *filename, const char *version_string);
44         gboolean (*print_line)(struct print_stream *self, int indent,
45             const char *line);
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);
51         gboolean (*print_line_color)(struct print_stream *self, int indent, const char *line, const color_t *fg, const color_t *bg);
52 } print_stream_ops_t;
53
54 typedef struct print_stream {
55         const print_stream_ops_t *ops;
56         gboolean isatty;
57         const char *to_codeset;
58         void *data;
59 } print_stream_t;
60
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);
65
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,
69     const gchar *title);
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);
73
74 /*
75  * equivalent to print_line(), but if the stream supports text coloring then
76  * the output text will also be colored with the given foreground and
77  * background
78  *
79  * returns TRUE if the print was successful, FALSE otherwise
80  */
81 WS_DLL_PUBLIC gboolean print_line_color(print_stream_t *self, int indent, const char *line, const color_t *fg, const color_t *bg);
82
83 #ifdef __cplusplus
84 }
85 #endif /* __cplusplus */
86
87 #endif /* print_stream.h */