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  * Ethereal - Network traffic analyzer
   9  * By Gerald Combs <gerald@ethereal.com>
  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 /* print output format */
  33 typedef enum {
  34   PR_FMT_TEXT,    /* plain text */
  35   PR_FMT_PS       /* postscript */
  36 } print_format_e;
  37
  38 /* print_range, enum which frames should be printed */
  39 typedef enum {
  40   print_range_selected_only,    /* selected frame(s) only (currently only one) */
  41   print_range_marked_only,      /* marked frames only */
  42   print_range_all_displayed,    /* all frames currently displayed */
  43   print_range_all_captured      /* all frames in capture */
  44 } print_range_e;
  45
  46 /* print_dissections, enum how the dissections should be printed */
  47 typedef enum {
  48   print_dissections_none,         /* no dissections at all */
  49   print_dissections_collapsed,    /* no dissection details */
  50   print_dissections_as_displayed, /* details as displayed */
  51   print_dissections_expanded      /* all dissection details */
  52 } print_dissections_e;
  53
  54 typedef struct {
  55   print_format_e format;        /* plain text or PostScript */
  56   gboolean      to_file;        /* TRUE if we're printing to a file */
  57   char          *file;          /* file output pathname */
  58   char          *cmd;           /* print command string (not win32) */
  59   packet_range_t range;
  60
  61   gboolean      print_summary;  /* TRUE if we should just print summary;
  62                                    FALSE if we should print protocol tree. */
  63   print_dissections_e   print_dissections;
  64   gboolean      print_hex;      /* TRUE if we should also print hex data;
  65                                    FALSE if we should print only if not dissected. */
  66   gboolean      print_formfeed; /* TRUE if a formfeed should be printed
  67                    before each new packet */
  68 } print_args_t;
  69
  70 /* Functions in print.h */
  71
  72 extern void write_pdml_preamble(FILE *fh);
  73 extern void proto_tree_write_pdml(epan_dissect_t *edt, FILE *fh);
  74 extern void write_pdml_finale(FILE *fh);
  75
  76 extern void write_psml_preamble(FILE *fh);
  77 extern void proto_tree_write_psml(epan_dissect_t *edt, FILE *fh);
  78 extern void write_psml_finale(FILE *fh);
  79
  80 struct print_stream;
  81
  82 typedef struct print_stream_ops {
  83         gboolean (*print_preamble)(struct print_stream *self, gchar *filename);
  84         gboolean (*print_line)(struct print_stream *self, int indent,
  85             const char *line);
  86         gboolean (*print_bookmark)(struct print_stream *self,
  87             const gchar *name, const gchar *title);
  88         gboolean (*new_page)(struct print_stream *self);
  89         gboolean (*print_finale)(struct print_stream *self);
  90         gboolean (*destroy)(struct print_stream *self);
  91 } print_stream_ops_t;
  92
  93 typedef struct print_stream {
  94         const print_stream_ops_t *ops;
  95         void *data;
  96 } print_stream_t;
  97
  98 extern gboolean proto_tree_print(print_args_t *print_args, epan_dissect_t *edt,
  99      print_stream_t *stream);
 100 extern gboolean print_hex_data(print_stream_t *stream, epan_dissect_t *edt);
 101 extern void print_packet_header(FILE *fh, print_format_e format, guint32 number, gchar *summary);
 102
 103 extern print_stream_t *print_stream_text_new(int to_file, const char *dest);
 104 extern print_stream_t *print_stream_text_stdio_new(FILE *fh);
 105 extern print_stream_t *print_stream_ps_new(int to_file, const char *dest);
 106 extern print_stream_t *print_stream_ps_stdio_new(FILE *fh);
 107
 108 extern gboolean print_preamble(print_stream_t *self, gchar *filename);
 109 extern gboolean print_line(print_stream_t *self, int indent, const char *line);
 110 extern gboolean print_bookmark(print_stream_t *self, const gchar *name,
 111     const gchar *title);
 112 extern gboolean new_page(print_stream_t *self);
 113 extern gboolean print_finale(print_stream_t *self);
 114 extern gboolean destroy_print_stream(print_stream_t *self);
 115
 116 #endif /* print.h */