/* print.h
* Definitions for printing packet analysis trees.
*
- * $Id: print.h,v 1.19 2000/08/03 12:44:21 gram Exp $
+ * $Id$
*
- * Gilbert Ramirez <gram@xiexie.org>
+ * Gilbert Ramirez <gram@alumni.rice.edu>
*
- * Ethereal - Network traffic analyzer
- * By Gerald Combs <gerald@zing.org>
+ * Wireshark - Network traffic analyzer
+ * By Gerald Combs <gerald@wireshark.org>
* Copyright 1998 Gerald Combs
*
- *
* 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.
- *
+ *
* 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.
- *
+ *
* 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__
-#ifndef __PACKET_H__
-#include "packet.h"
-#endif
+#include <stdio.h>
+
+#include <epan/packet.h>
+
+#include "packet-range.h"
+
+/*
+ * 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;
-#define PR_FMT_TEXT 0
-#define PR_FMT_PS 1
+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);
+
+/* print output format */
+typedef enum {
+ PR_FMT_TEXT, /* plain text */
+ PR_FMT_PS /* postscript */
+} print_format_e;
+
+/* 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 {
+ print_dissections_none, /* no dissections at all */
+ print_dissections_collapsed, /* no dissection details */
+ print_dissections_as_displayed, /* details as displayed */
+ print_dissections_expanded /* all dissection details */
+} print_dissections_e;
typedef struct {
+ print_stream_t *stream; /* the stream to which we're printing */
+ print_format_e format; /* plain text or PostScript */
gboolean to_file; /* TRUE if we're printing to a file */
- char *dest; /* if printing to file, pathname;
- if not, command string */
- gint format; /* text or PostScript */
+ char *file; /* file output pathname */
+ char *cmd; /* print command string (not win32) */
+ packet_range_t range;
+
gboolean print_summary; /* TRUE if we should just print summary;
FALSE if we should print protocol tree. */
+ 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. */
- gboolean expand_all; /* TRUE if we should expand all levels;
- FALSE if we should expand as displayed. */
+ gboolean print_formfeed; /* TRUE if a formfeed should be printed
+ before each new packet */
} print_args_t;
-/* Functions in print.h */
-
-FILE *open_print_dest(int to_file, const char *dest);
-void close_print_dest(int to_file, FILE *fh);
-void print_preamble(FILE *fh, gint format);
-void print_finale(FILE *fh, gint format);
-void proto_tree_print(gboolean print_one_packet, print_args_t *print_args,
- GNode *protocol_tree, const u_char *pd, frame_data *fd, FILE *fh);
-void print_hex_data(FILE *fh, gint format, register const u_char *cp,
- register u_int length, char_enc encoding);
-void print_line(FILE *fh, gint format, char *line);
+/*
+ * Print user selected list of fields
+ */
+struct _output_fields;
+typedef struct _output_fields output_fields_t;
+
+extern output_fields_t* output_fields_new(void);
+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);
+
+/*
+ * Output only these protocols
+ */
+extern GHashTable *output_only_tables;
+
+/*
+ * 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);
+
+extern void write_pdml_preamble(FILE *fh, const gchar* filename);
+extern void proto_tree_write_pdml(epan_dissect_t *edt, FILE *fh);
+extern void write_pdml_finale(FILE *fh);
+
+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);
+
+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);
+
+extern void write_carrays_preamble(FILE *fh);
+extern void proto_tree_write_carrays(guint32 num, FILE *fh, epan_dissect_t *edt);
+extern void write_carrays_finale(FILE *fh);
+
+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);
+
+extern const gchar* get_node_field_value(field_info* fi, epan_dissect_t* edt);
#endif /* print.h */
git.samba.org / obnox / wireshark / wip.git / blobdiff