PA-PK-AS-REP-Win2k ::= PaPkAsRep
[metze/wireshark/wip.git] / epan / print.h
index b152ac5f7abd63f5b0e19274ce5c280eba33bc46..ad96942dbc5d7521ccec7f32680fac1a64faf8e6 100644 (file)
@@ -7,19 +7,7 @@
  * 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.
+ * SPDX-License-Identifier: GPL-2.0-or-later
  */
 
 #ifndef __PRINT_H__
@@ -32,8 +20,6 @@
 
 #include <epan/print_stream.h>
 
-#include <epan/packet-range.h>
-
 #include "ws_symbol_export.h"
 
 #ifdef __cplusplus
@@ -46,14 +32,6 @@ typedef enum {
   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 */
@@ -62,22 +40,18 @@ typedef enum {
   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 *file;                   /* file output pathname */
-  char *cmd;                    /* print command string (not win32) */
-  packet_range_t range;
-
-  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 */
-} print_args_t;
+
+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
@@ -85,6 +59,8 @@ typedef struct {
 struct _output_fields;
 typedef struct _output_fields output_fields_t;
 
+typedef GSList* (*proto_node_children_grouper_func)(proto_node *node);
+
 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);
@@ -98,24 +74,45 @@ 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_args_t *print_args,
+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(epan_dissect_t *edt, FILE *fh);
+WS_DLL_PUBLIC void write_pdml_proto_tree(output_fields_t* fields, gchar **protocolfilter, pf_flags protocolfilter_flags, epan_dissect_t *edt, column_info *cinfo, FILE *fh, gboolean use_color);
 WS_DLL_PUBLIC void write_pdml_finale(FILE *fh);
 
+// Implementations of proto_node_children_grouper_func
+// Groups each child separately
+WS_DLL_PUBLIC GSList *proto_node_group_children_by_unique(proto_node *node);
+// Groups children by json key (children with the same json key get put in the same group
+WS_DLL_PUBLIC GSList *proto_node_group_children_by_json_key(proto_node *node);
+
 WS_DLL_PUBLIC void write_json_preamble(FILE *fh);
-WS_DLL_PUBLIC void write_json_proto_tree(print_args_t *print_args, gchar *jsonfilter, epan_dissect_t *edt, 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,
+                                         column_info *cinfo,
+                                         proto_node_children_grouper_func node_children_grouper,
+                                         FILE *fh);
 WS_DLL_PUBLIC void write_json_finale(FILE *fh);
 
-WS_DLL_PUBLIC void write_ek_proto_tree(print_args_t *print_args, gchar *jsonfilter, epan_dissect_t *edt, FILE *fh);
+WS_DLL_PUBLIC void write_ek_proto_tree(output_fields_t* fields,
+                                       gboolean print_summary,
+                                       gboolean print_hex_data,
+                                       gchar **protocolfilter,
+                                       pf_flags protocolfilter_flags,
+                                       epan_dissect_t *edt,
+                                       column_info *cinfo, 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_columns(epan_dissect_t *edt, FILE *fh, gboolean use_color);
 WS_DLL_PUBLIC void write_psml_finale(FILE *fh);
 
 WS_DLL_PUBLIC void write_csv_column_titles(column_info *cinfo, FILE *fh);