1998-09-16 02:39:15 +00:00
|
|
|
/* print.h
|
|
|
|
* Definitions for printing packet analysis trees.
|
|
|
|
*
|
2004-07-18 00:24:25 +00:00
|
|
|
* $Id$
|
1998-09-16 03:22:19 +00:00
|
|
|
*
|
2001-11-13 23:55:44 +00:00
|
|
|
* Gilbert Ramirez <gram@alumni.rice.edu>
|
1998-09-16 02:39:15 +00:00
|
|
|
*
|
2006-05-21 05:12:17 +00:00
|
|
|
* Wireshark - Network traffic analyzer
|
|
|
|
* By Gerald Combs <gerald@wireshark.org>
|
1998-09-16 02:39:15 +00:00
|
|
|
* Copyright 1998 Gerald Combs
|
2002-08-28 21:04:11 +00:00
|
|
|
*
|
1998-09-16 02:39:15 +00:00
|
|
|
* This program is free software; you can redistribute it and/or
|
|
|
|
* modify it under the terms of the GNU General Public License
|
|
|
|
* as published by the Free Software Foundation; either version 2
|
|
|
|
* of the License, or (at your option) any later version.
|
2002-08-28 21:04:11 +00:00
|
|
|
*
|
1998-09-16 02:39:15 +00:00
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU General Public License for more details.
|
2002-08-28 21:04:11 +00:00
|
|
|
*
|
1998-09-16 02:39:15 +00:00
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with this program; if not, write to the Free Software
|
|
|
|
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef __PRINT_H__
|
|
|
|
#define __PRINT_H__
|
|
|
|
|
2002-01-21 07:37:49 +00:00
|
|
|
#include <epan/packet.h>
|
2000-08-03 12:44:40 +00:00
|
|
|
|
2004-09-04 20:02:11 +00:00
|
|
|
#include "packet-range.h"
|
|
|
|
|
2004-07-27 20:10:02 +00:00
|
|
|
/*
|
|
|
|
* Print stream code; this provides a "print stream" class with subclasses
|
|
|
|
* of various sorts. Additional subclasses might be implemented elsewhere.
|
|
|
|
*/
|
|
|
|
struct print_stream;
|
|
|
|
|
|
|
|
typedef struct print_stream_ops {
|
|
|
|
gboolean (*print_preamble)(struct print_stream *self, gchar *filename);
|
|
|
|
gboolean (*print_line)(struct print_stream *self, int indent,
|
|
|
|
const char *line);
|
|
|
|
gboolean (*print_bookmark)(struct print_stream *self,
|
|
|
|
const gchar *name, const gchar *title);
|
|
|
|
gboolean (*new_page)(struct print_stream *self);
|
|
|
|
gboolean (*print_finale)(struct print_stream *self);
|
|
|
|
gboolean (*destroy)(struct print_stream *self);
|
|
|
|
} print_stream_ops_t;
|
|
|
|
|
|
|
|
typedef struct print_stream {
|
|
|
|
const print_stream_ops_t *ops;
|
|
|
|
void *data;
|
|
|
|
} print_stream_t;
|
|
|
|
|
|
|
|
extern print_stream_t *print_stream_text_new(int to_file, const char *dest);
|
|
|
|
extern print_stream_t *print_stream_text_stdio_new(FILE *fh);
|
|
|
|
extern print_stream_t *print_stream_ps_new(int to_file, const char *dest);
|
|
|
|
extern print_stream_t *print_stream_ps_stdio_new(FILE *fh);
|
|
|
|
|
|
|
|
extern gboolean print_preamble(print_stream_t *self, gchar *filename);
|
|
|
|
extern gboolean print_line(print_stream_t *self, int indent, const char *line);
|
|
|
|
extern gboolean print_bookmark(print_stream_t *self, const gchar *name,
|
|
|
|
const gchar *title);
|
|
|
|
extern gboolean new_page(print_stream_t *self);
|
|
|
|
extern gboolean print_finale(print_stream_t *self);
|
|
|
|
extern gboolean destroy_print_stream(print_stream_t *self);
|
|
|
|
|
2004-04-24 23:13:46 +00:00
|
|
|
/* print output format */
|
|
|
|
typedef enum {
|
|
|
|
PR_FMT_TEXT, /* plain text */
|
2004-07-23 23:28:08 +00:00
|
|
|
PR_FMT_PS /* postscript */
|
2004-04-24 23:13:46 +00:00
|
|
|
} print_format_e;
|
2000-01-06 07:33:35 +00:00
|
|
|
|
2003-12-09 22:04:57 +00:00
|
|
|
/* print_range, enum which frames should be printed */
|
|
|
|
typedef enum {
|
|
|
|
print_range_selected_only, /* selected frame(s) only (currently only one) */
|
|
|
|
print_range_marked_only, /* marked frames only */
|
|
|
|
print_range_all_displayed, /* all frames currently displayed */
|
|
|
|
print_range_all_captured /* all frames in capture */
|
|
|
|
} print_range_e;
|
|
|
|
|
|
|
|
/* print_dissections, enum how the dissections should be printed */
|
|
|
|
typedef enum {
|
2004-04-15 19:56:15 +00:00
|
|
|
print_dissections_none, /* no dissections at all */
|
2003-12-09 22:04:57 +00:00
|
|
|
print_dissections_collapsed, /* no dissection details */
|
|
|
|
print_dissections_as_displayed, /* details as displayed */
|
|
|
|
print_dissections_expanded /* all dissection details */
|
|
|
|
} print_dissections_e;
|
|
|
|
|
1999-09-29 22:19:24 +00:00
|
|
|
typedef struct {
|
2004-07-27 20:10:02 +00:00
|
|
|
print_stream_t *stream; /* the stream to which we're printing */
|
2004-07-25 08:53:38 +00:00
|
|
|
print_format_e format; /* plain text or PostScript */
|
1999-09-29 22:19:24 +00:00
|
|
|
gboolean to_file; /* TRUE if we're printing to a file */
|
2004-04-25 12:04:08 +00:00
|
|
|
char *file; /* file output pathname */
|
|
|
|
char *cmd; /* print command string (not win32) */
|
2004-01-09 18:11:21 +00:00
|
|
|
packet_range_t range;
|
2003-12-09 22:04:57 +00:00
|
|
|
|
1999-09-29 22:19:24 +00:00
|
|
|
gboolean print_summary; /* TRUE if we should just print summary;
|
|
|
|
FALSE if we should print protocol tree. */
|
2003-12-09 22:04:57 +00:00
|
|
|
print_dissections_e print_dissections;
|
|
|
|
gboolean print_hex; /* TRUE if we should also print hex data;
|
|
|
|
FALSE if we should print only if not dissected. */
|
2004-04-22 17:03:21 +00:00
|
|
|
gboolean print_formfeed; /* TRUE if a formfeed should be printed
|
|
|
|
before each new packet */
|
1999-09-29 22:19:24 +00:00
|
|
|
} print_args_t;
|
|
|
|
|
2007-03-26 20:17:05 +00:00
|
|
|
/*
|
|
|
|
* Print user selected list of fields
|
|
|
|
*/
|
|
|
|
struct _output_fields;
|
|
|
|
typedef struct _output_fields output_fields_t;
|
|
|
|
|
2007-03-28 04:29:00 +00:00
|
|
|
extern output_fields_t* output_fields_new(void);
|
2007-03-26 20:17:05 +00:00
|
|
|
extern void output_fields_free(output_fields_t* info);
|
|
|
|
extern void output_fields_add(output_fields_t* info, const gchar* field);
|
|
|
|
extern gsize output_fields_num_fields(output_fields_t* info);
|
|
|
|
extern gboolean output_fields_set_option(output_fields_t* info, gchar* option);
|
|
|
|
extern void output_fields_list_options(FILE *fh);
|
2004-07-27 20:10:02 +00:00
|
|
|
/*
|
|
|
|
* Higher-level packet-printing code.
|
|
|
|
*/
|
|
|
|
|
|
|
|
extern gboolean proto_tree_print(print_args_t *print_args, epan_dissect_t *edt,
|
|
|
|
print_stream_t *stream);
|
|
|
|
extern gboolean print_hex_data(print_stream_t *stream, epan_dissect_t *edt);
|
1998-09-16 02:39:15 +00:00
|
|
|
|
2004-07-08 10:36:29 +00:00
|
|
|
extern void write_pdml_preamble(FILE *fh);
|
|
|
|
extern void proto_tree_write_pdml(epan_dissect_t *edt, FILE *fh);
|
|
|
|
extern void write_pdml_finale(FILE *fh);
|
2004-07-25 08:53:38 +00:00
|
|
|
|
2004-07-08 10:36:29 +00:00
|
|
|
extern void write_psml_preamble(FILE *fh);
|
|
|
|
extern void proto_tree_write_psml(epan_dissect_t *edt, FILE *fh);
|
|
|
|
extern void write_psml_finale(FILE *fh);
|
2004-07-25 08:53:38 +00:00
|
|
|
|
2005-03-11 20:56:31 +00:00
|
|
|
extern void write_csv_preamble(FILE *fh);
|
|
|
|
extern void proto_tree_write_csv(epan_dissect_t *edt, FILE *fh);
|
|
|
|
extern void write_csv_finale(FILE *fh);
|
|
|
|
|
2008-03-11 18:23:16 +00:00
|
|
|
extern void write_carrays_preamble(FILE *fh);
|
|
|
|
extern void proto_tree_write_carrays(const guint8 *pd, guint32 len, guint32 num, FILE *fh);
|
|
|
|
extern void write_carrays_finale(FILE *fh);
|
|
|
|
|
2007-03-26 20:17:05 +00:00
|
|
|
extern void write_fields_preamble(output_fields_t* fields, FILE *fh);
|
|
|
|
extern void proto_tree_write_fields(output_fields_t* fields, epan_dissect_t *edt, FILE *fh);
|
|
|
|
extern void write_fields_finale(output_fields_t* fields, FILE *fh);
|
|
|
|
|
2009-04-08 18:32:11 +00:00
|
|
|
extern const gchar* get_node_field_value(field_info* fi, epan_dissect_t* edt);
|
|
|
|
|
1998-09-16 02:39:15 +00:00
|
|
|
#endif /* print.h */
|