1998-09-16 02:39:15 +00:00
|
|
|
/* print.h
|
|
|
|
* Definitions for printing packet analysis trees.
|
|
|
|
*
|
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
|
2012-06-28 22:56:06 +00:00
|
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
1998-09-16 02:39:15 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef __PRINT_H__
|
|
|
|
#define __PRINT_H__
|
|
|
|
|
2009-08-26 23:24:22 +00:00
|
|
|
#include <stdio.h>
|
|
|
|
|
2013-12-03 23:49:51 +00:00
|
|
|
#include <epan/epan.h>
|
2002-01-21 07:37:49 +00:00
|
|
|
#include <epan/packet.h>
|
2000-08-03 12:44:40 +00:00
|
|
|
|
2014-11-22 03:22:54 +00:00
|
|
|
#include <epan/print_stream.h>
|
|
|
|
|
2013-07-11 23:57:11 +00:00
|
|
|
#include <epan/packet-range.h>
|
2004-09-04 20:02:11 +00:00
|
|
|
|
2014-11-22 03:22:54 +00:00
|
|
|
#include "ws_symbol_export.h"
|
|
|
|
|
2012-10-12 23:40:29 +00:00
|
|
|
#ifdef __cplusplus
|
|
|
|
extern "C" {
|
|
|
|
#endif /* __cplusplus */
|
|
|
|
|
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 {
|
2013-06-19 15:22:56 +00:00
|
|
|
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 *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
|
|
|
|
2013-06-19 15:22:56 +00:00
|
|
|
gboolean print_summary; /* TRUE if we should print summary line. */
|
|
|
|
gboolean print_col_headings; /* TRUE if we should print column headings */
|
|
|
|
print_dissections_e print_dissections;
|
|
|
|
gboolean print_hex; /* TRUE if we should print hex data;
|
|
|
|
* FALSE if we should print only if not dissected. */
|
|
|
|
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;
|
|
|
|
|
2013-07-12 03:50:50 +00:00
|
|
|
WS_DLL_PUBLIC output_fields_t* output_fields_new(void);
|
|
|
|
WS_DLL_PUBLIC void output_fields_free(output_fields_t* info);
|
|
|
|
WS_DLL_PUBLIC void output_fields_add(output_fields_t* info, const gchar* field);
|
2014-06-25 19:37:36 +00:00
|
|
|
WS_DLL_PUBLIC gboolean output_fields_valid(output_fields_t* info);
|
2013-07-12 03:50:50 +00:00
|
|
|
WS_DLL_PUBLIC gsize output_fields_num_fields(output_fields_t* info);
|
|
|
|
WS_DLL_PUBLIC gboolean output_fields_set_option(output_fields_t* info, gchar* option);
|
|
|
|
WS_DLL_PUBLIC void output_fields_list_options(FILE *fh);
|
|
|
|
WS_DLL_PUBLIC gboolean output_fields_has_cols(output_fields_t* info);
|
2011-04-29 06:53:29 +00:00
|
|
|
|
2004-07-27 20:10:02 +00:00
|
|
|
/*
|
|
|
|
* Higher-level packet-printing code.
|
|
|
|
*/
|
|
|
|
|
2014-11-22 09:07:13 +00:00
|
|
|
WS_DLL_PUBLIC gboolean proto_tree_print(print_args_t *print_args,
|
|
|
|
epan_dissect_t *edt,
|
|
|
|
GHashTable *output_only_tables,
|
|
|
|
print_stream_t *stream);
|
2013-07-12 03:50:50 +00:00
|
|
|
WS_DLL_PUBLIC gboolean print_hex_data(print_stream_t *stream, epan_dissect_t *edt);
|
1998-09-16 02:39:15 +00:00
|
|
|
|
2013-07-12 03:50:50 +00:00
|
|
|
WS_DLL_PUBLIC void write_pdml_preamble(FILE *fh, const gchar* filename);
|
2014-11-29 22:43:22 +00:00
|
|
|
WS_DLL_PUBLIC void write_pdml_proto_tree(epan_dissect_t *edt, FILE *fh);
|
2013-07-12 03:50:50 +00:00
|
|
|
WS_DLL_PUBLIC void write_pdml_finale(FILE *fh);
|
2004-07-25 08:53:38 +00:00
|
|
|
|
2014-11-29 22:43:22 +00:00
|
|
|
WS_DLL_PUBLIC void write_psml_preamble(column_info *cinfo, FILE *fh);
|
|
|
|
WS_DLL_PUBLIC void write_psml_columns(epan_dissect_t *edt, FILE *fh);
|
2013-07-12 03:50:50 +00:00
|
|
|
WS_DLL_PUBLIC void write_psml_finale(FILE *fh);
|
2004-07-25 08:53:38 +00:00
|
|
|
|
2014-11-29 22:43:22 +00:00
|
|
|
WS_DLL_PUBLIC void write_csv_column_titles(column_info *cinfo, FILE *fh);
|
|
|
|
WS_DLL_PUBLIC void write_csv_columns(epan_dissect_t *edt, FILE *fh);
|
2005-03-11 20:56:31 +00:00
|
|
|
|
2014-11-29 22:43:22 +00:00
|
|
|
WS_DLL_PUBLIC void write_carrays_hex_data(guint32 num, FILE *fh, epan_dissect_t *edt);
|
2008-03-11 18:23:16 +00:00
|
|
|
|
2013-07-12 03:50:50 +00:00
|
|
|
WS_DLL_PUBLIC void write_fields_preamble(output_fields_t* fields, FILE *fh);
|
2014-11-29 22:43:22 +00:00
|
|
|
WS_DLL_PUBLIC void write_fields_proto_tree(output_fields_t* fields, epan_dissect_t *edt, column_info *cinfo, FILE *fh);
|
2013-07-12 03:50:50 +00:00
|
|
|
WS_DLL_PUBLIC void write_fields_finale(output_fields_t* fields, FILE *fh);
|
2007-03-26 20:17:05 +00:00
|
|
|
|
2014-05-18 18:21:31 +00:00
|
|
|
WS_DLL_PUBLIC gchar* get_node_field_value(field_info* fi, epan_dissect_t* edt);
|
2009-04-08 18:32:11 +00:00
|
|
|
|
2012-10-12 23:40:29 +00:00
|
|
|
#ifdef __cplusplus
|
|
|
|
}
|
|
|
|
#endif /* __cplusplus */
|
|
|
|
|
1998-09-16 02:39:15 +00:00
|
|
|
#endif /* print.h */
|