column-info.h

Go to the documentation of this file.

/* column-info.h
 * Definitions for internal column structures and routines
 *
 * For internal Wireshark use only. Don't include this header in dissectors!
 *
 * Wireshark - Network traffic analyzer
 * By Gerald Combs <gerald@wireshark.org>
 * Copyright 1998 Gerald Combs
 *
 * SPDX-License-Identifier: GPL-2.0-or-later
 */
#pragma once
#include <epan/column-utils.h>
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
typedef struct _proto_node proto_tree;
 
#define COLUMN_FIELD_FILTER  "_ws.col."
 
typedef struct {
  const char **col_expr;      
  char       **col_expr_val;  
} col_expr_t;
 
typedef struct {
  char                *dftext;         
  struct epan_dfilter *dfilter;        
  int                  field_id;       
} col_custom_t;
 
typedef struct {
  int                 col_fmt;              
  bool               *fmt_matx;             
  char               *col_title;            
  char               *col_custom_fields;    
  int                 col_custom_occurrence;
  GSList             *col_custom_fields_ids;
  struct epan_dfilter *col_custom_dfilter;  
  const char         *col_data;             
  char               *col_buf;              
  int                 col_fence;            
  bool                writable;             
  int                 hf_id;
} col_item_t;
 
struct epan_column_info {
  const struct epan_session *epan;
  unsigned            num_cols;             
  col_item_t         *columns;              
  int                *col_first;            
  int                *col_last;             
  col_expr_t          col_expr;             
  bool                writable;             
  GRegex             *prime_regex;          
};
 
WS_DLL_PUBLIC void col_setup(column_info *cinfo, const int num_cols);
 
WS_DLL_PUBLIC void col_cleanup(column_info *cinfo);
 
extern void col_init(column_info *cinfo, const struct epan_session *epan);
 
WS_DLL_PUBLIC void col_fill_in_frame_data(const frame_data *fd, column_info *cinfo, const int col, bool const fill_col_exprs);
 
WS_DLL_PUBLIC void col_fill_in(packet_info *pinfo, const bool fill_col_exprs, const bool fill_fd_colums);
 
WS_DLL_PUBLIC void col_fill_in_error(column_info *cinfo, frame_data *fdata, const bool fill_col_exprs, const bool fill_fd_colums);
 
WS_DLL_PUBLIC bool      col_data_changed(void);
 
void col_custom_set_edt(struct epan_dissect *edt, column_info *cinfo);
 
WS_DLL_PUBLIC
void col_custom_prime_edt(struct epan_dissect *edt, column_info *cinfo);
 
WS_DLL_PUBLIC
char* col_custom_get_filter(struct epan_dissect *edt, column_info *cinfo, const unsigned col);
 
WS_DLL_PUBLIC
bool have_custom_cols(column_info *cinfo);
 
WS_DLL_PUBLIC
bool have_field_extractors(void);
 
WS_DLL_PUBLIC
bool col_has_time_fmt(column_info *cinfo, const unsigned col);
 
WS_DLL_PUBLIC
bool col_based_on_frame_data(column_info *cinfo, const unsigned col);
 
void
col_register_protocol(void);
 
extern
void col_dissect(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */