epan/print.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_H__
  26 #define __PRINT_H__
  27
  28 #include <stdio.h>
  29
  30 #include <epan/epan.h>
  31 #include <epan/packet.h>
  32
  33 #include <epan/print_stream.h>
  34
  35 #include <epan/packet-range.h>
  36
  37 #include "ws_symbol_export.h"
  38
  39 #ifdef __cplusplus
  40 extern "C" {
  41 #endif /* __cplusplus */
  42
  43 /* print output format */
  44 typedef enum {
  45   PR_FMT_TEXT,    /* plain text */
  46   PR_FMT_PS       /* postscript */
  47 } print_format_e;
  48
  49 /* print_range, enum which frames should be printed */
  50 typedef enum {
  51   print_range_selected_only,    /* selected frame(s) only (currently only one) */
  52   print_range_marked_only,      /* marked frames only */
  53   print_range_all_displayed,    /* all frames currently displayed */
  54   print_range_all_captured      /* all frames in capture */
  55 } print_range_e;
  56
  57 /* print_dissections, enum how the dissections should be printed */
  58 typedef enum {
  59   print_dissections_none,         /* no dissections at all */
  60   print_dissections_collapsed,    /* no dissection details */
  61   print_dissections_as_displayed, /* details as displayed */
  62   print_dissections_expanded      /* all dissection details */
  63 } print_dissections_e;
  64
  65 typedef struct {
  66   print_stream_t *stream;       /* the stream to which we're printing */
  67   print_format_e format;        /* plain text or PostScript */
  68   gboolean to_file;             /* TRUE if we're printing to a file */
  69   char *file;                   /* file output pathname */
  70   char *cmd;                    /* print command string (not win32) */
  71   packet_range_t range;
  72
  73   gboolean print_summary;       /* TRUE if we should print summary line. */
  74   gboolean print_col_headings;  /* TRUE if we should print column headings */
  75   print_dissections_e print_dissections;
  76   gboolean print_hex;           /* TRUE if we should print hex data;
  77                                  * FALSE if we should print only if not dissected. */
  78   gboolean print_formfeed;      /* TRUE if a formfeed should be printed before
  79                                  * each new packet */
  80 } print_args_t;
  81
  82 /*
  83  * Print user selected list of fields
  84  */
  85 struct _output_fields;
  86 typedef struct _output_fields output_fields_t;
  87
  88 WS_DLL_PUBLIC output_fields_t* output_fields_new(void);
  89 WS_DLL_PUBLIC void output_fields_free(output_fields_t* info);
  90 WS_DLL_PUBLIC void output_fields_add(output_fields_t* info, const gchar* field);
  91 WS_DLL_PUBLIC GSList * output_fields_valid(output_fields_t* info);
  92 WS_DLL_PUBLIC gsize output_fields_num_fields(output_fields_t* info);
  93 WS_DLL_PUBLIC gboolean output_fields_set_option(output_fields_t* info, gchar* option);
  94 WS_DLL_PUBLIC void output_fields_list_options(FILE *fh);
  95 WS_DLL_PUBLIC gboolean output_fields_has_cols(output_fields_t* info);
  96
  97 /*
  98  * Higher-level packet-printing code.
  99  */
 100
 101 WS_DLL_PUBLIC gboolean proto_tree_print(print_args_t *print_args,
 102                                         epan_dissect_t *edt,
 103                                         GHashTable *output_only_tables,
 104                                         print_stream_t *stream);
 105 WS_DLL_PUBLIC gboolean print_hex_data(print_stream_t *stream, epan_dissect_t *edt);
 106
 107 WS_DLL_PUBLIC void write_pdml_preamble(FILE *fh, const gchar* filename);
 108 WS_DLL_PUBLIC void write_pdml_proto_tree(epan_dissect_t *edt, FILE *fh);
 109 WS_DLL_PUBLIC void write_pdml_finale(FILE *fh);
 110
 111 WS_DLL_PUBLIC void write_psml_preamble(column_info *cinfo, FILE *fh);
 112 WS_DLL_PUBLIC void write_psml_columns(epan_dissect_t *edt, FILE *fh);
 113 WS_DLL_PUBLIC void write_psml_finale(FILE *fh);
 114
 115 WS_DLL_PUBLIC void write_csv_column_titles(column_info *cinfo, FILE *fh);
 116 WS_DLL_PUBLIC void write_csv_columns(epan_dissect_t *edt, FILE *fh);
 117
 118 WS_DLL_PUBLIC void write_carrays_hex_data(guint32 num, FILE *fh, epan_dissect_t *edt);
 119
 120 WS_DLL_PUBLIC void write_fields_preamble(output_fields_t* fields, FILE *fh);
 121 WS_DLL_PUBLIC void write_fields_proto_tree(output_fields_t* fields, epan_dissect_t *edt, column_info *cinfo, FILE *fh);
 122 WS_DLL_PUBLIC void write_fields_finale(output_fields_t* fields, FILE *fh);
 123
 124 WS_DLL_PUBLIC gchar* get_node_field_value(field_info* fi, epan_dissect_t* edt);
 125
 126 extern void print_cache_field_handles(void);
 127
 128 #ifdef __cplusplus
 129 }
 130 #endif /* __cplusplus */
 131
 132 #endif /* print.h */