forked from osmocom/wireshark
![Guy Harris](/assets/img/avatar_default.png)
Packet ranges are used only in the UI; move the packet range stuff into libui. Don't pass a print_args_t structure to libwireshark packet-printing routines, just pass the few parameters they need. Move the declaration of print_args_t into file.h. Change-Id: Icff5991eea7d7d56f33b4716105895263d275bcf Reviewed-on: https://code.wireshark.org/review/21308 Petri-Dish: Guy Harris <guy@alum.mit.edu> Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org> Reviewed-by: Guy Harris <guy@alum.mit.edu>
135 lines
5 KiB
C
135 lines
5 KiB
C
/* print.h
|
|
* Definitions for printing packet analysis trees.
|
|
*
|
|
* Gilbert Ramirez <gram@alumni.rice.edu>
|
|
*
|
|
* 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
*/
|
|
|
|
#ifndef __PRINT_H__
|
|
#define __PRINT_H__
|
|
|
|
#include <stdio.h>
|
|
|
|
#include <epan/epan.h>
|
|
#include <epan/packet.h>
|
|
|
|
#include <epan/print_stream.h>
|
|
|
|
#include "ws_symbol_export.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif /* __cplusplus */
|
|
|
|
/* print output format */
|
|
typedef enum {
|
|
PR_FMT_TEXT, /* plain text */
|
|
PR_FMT_PS /* postscript */
|
|
} print_format_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 enum {
|
|
FORMAT_CSV, /* CSV */
|
|
FORMAT_JSON, /* JSON */
|
|
FORMAT_EK, /* JSON bulk insert to Elasticsearch */
|
|
FORMAT_XML /* PDML output */
|
|
} fields_format;
|
|
|
|
typedef enum {
|
|
PF_NONE = 0x00,
|
|
PF_INCLUDE_CHILDREN = 0x01
|
|
} pf_flags;
|
|
|
|
/*
|
|
* Print user selected list of fields
|
|
*/
|
|
struct _output_fields;
|
|
typedef struct _output_fields output_fields_t;
|
|
|
|
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);
|
|
WS_DLL_PUBLIC GSList * output_fields_valid(output_fields_t* info);
|
|
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);
|
|
|
|
/*
|
|
* Higher-level packet-printing code.
|
|
*/
|
|
|
|
WS_DLL_PUBLIC gboolean proto_tree_print(print_dissections_e print_dissections,
|
|
gboolean print_hex_data,
|
|
epan_dissect_t *edt,
|
|
GHashTable *output_only_tables,
|
|
print_stream_t *stream);
|
|
WS_DLL_PUBLIC gboolean print_hex_data(print_stream_t *stream, epan_dissect_t *edt);
|
|
|
|
WS_DLL_PUBLIC void write_pdml_preamble(FILE *fh, const gchar* filename);
|
|
WS_DLL_PUBLIC void write_pdml_proto_tree(output_fields_t* fields, gchar **protocolfilter, pf_flags protocolfilter_flags, epan_dissect_t *edt, FILE *fh);
|
|
WS_DLL_PUBLIC void write_pdml_finale(FILE *fh);
|
|
|
|
WS_DLL_PUBLIC void write_json_preamble(FILE *fh);
|
|
WS_DLL_PUBLIC void write_json_proto_tree(output_fields_t* fields,
|
|
print_dissections_e print_dissections,
|
|
gboolean print_hex_data,
|
|
gchar **protocolfilter,
|
|
pf_flags protocolfilter_flags,
|
|
epan_dissect_t *edt, FILE *fh);
|
|
WS_DLL_PUBLIC void write_json_finale(FILE *fh);
|
|
|
|
WS_DLL_PUBLIC void write_ek_proto_tree(output_fields_t* fields,
|
|
gboolean print_hex_data,
|
|
gchar **protocolfilter,
|
|
pf_flags protocolfilter_flags,
|
|
epan_dissect_t *edt, FILE *fh);
|
|
|
|
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);
|
|
WS_DLL_PUBLIC void write_psml_finale(FILE *fh);
|
|
|
|
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);
|
|
|
|
WS_DLL_PUBLIC void write_carrays_hex_data(guint32 num, FILE *fh, epan_dissect_t *edt);
|
|
|
|
WS_DLL_PUBLIC void write_fields_preamble(output_fields_t* fields, FILE *fh);
|
|
WS_DLL_PUBLIC void write_fields_proto_tree(output_fields_t* fields, epan_dissect_t *edt, column_info *cinfo, FILE *fh);
|
|
WS_DLL_PUBLIC void write_fields_finale(output_fields_t* fields, FILE *fh);
|
|
|
|
WS_DLL_PUBLIC gchar* get_node_field_value(field_info* fi, epan_dissect_t* edt);
|
|
|
|
extern void print_cache_field_handles(void);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif /* __cplusplus */
|
|
|
|
#endif /* print.h */
|