column.h

Go to the documentation of this file.

 
#pragma once
#include "ws_symbol_export.h"
#include <epan/column-utils.h>
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
#define COLUMN_DISPLAY_VALUES  'U'
#define COLUMN_DISPLAY_STRINGS 'R'
#define COLUMN_DISPLAY_DETAILS 'D'
 
typedef struct _fmt_data {
  char *title;            /* title of the column */
  int fmt;                 /* format of column */
  char *custom_fields;    /* fields names for COL_CUSTOM */
  int custom_occurrence;  /* optional ordinal of occurrence of that field */
  bool visible;            /* if false, hide this column */
  char display;            /* how to display a custom field value */
} fmt_data;
 
WS_DLL_PUBLIC
const char          *col_format_to_string(const int fmt);
 
WS_DLL_PUBLIC
const char          *col_format_desc(const int fmt_num);
 
WS_DLL_PUBLIC
const char          *col_format_abbrev(const int fmt_num);
 
WS_DLL_PUBLIC
int                  get_column_format(const int col);
 
WS_DLL_PUBLIC
void                 set_column_format(const int col, const int fmt);
 
WS_DLL_PUBLIC
void                 get_column_format_matches(bool *fmt_list, const int format);
 
WS_DLL_PUBLIC
int                  get_column_format_from_str(const char *str);
 
WS_DLL_PUBLIC
char                *get_column_title(const int col);
 
WS_DLL_PUBLIC
void                 set_column_title(const int col, const char *title);
 
WS_DLL_PUBLIC
bool                 get_column_visible(const int col);
 
WS_DLL_PUBLIC
void                 set_column_visible(const int col, bool visible);
 
WS_DLL_PUBLIC
char                 get_column_display_format(const int col);
 
WS_DLL_PUBLIC
void                 set_column_display_format(const int col, char display);
 
WS_DLL_PUBLIC
const char          *get_column_custom_fields(const int col);
 
WS_DLL_PUBLIC
void                 set_column_custom_fields(const int col, const char *custom_fields);
 
WS_DLL_PUBLIC
int                  get_column_custom_occurrence(const int col);
 
WS_DLL_PUBLIC
void                 set_column_custom_occurrence(const int col, const int custom_occurrence);
 
WS_DLL_PUBLIC
const char          *get_column_longest_string(const int format);
 
WS_DLL_PUBLIC
const char          *get_column_width_string(const int format, const int col);
 
WS_DLL_PUBLIC
int                  get_column_char_width(const int format);
 
WS_DLL_PUBLIC
char                *get_column_tooltip(const int col);
 
WS_DLL_PUBLIC
const char          *get_column_text(column_info *cinfo, const int col);
 
WS_DLL_PUBLIC
void
col_finalize(column_info *cinfo);
 
WS_DLL_PUBLIC
void
build_column_format_array(column_info *cinfo, const int num_cols, const bool reset_fences);
 
WS_DLL_PUBLIC
void                 column_dump_column_formats(void);
 
WS_DLL_PUBLIC
bool parse_column_format(fmt_data *cfmt, const char *fmt);
 
extern
char * column_fmt_data_to_str(const fmt_data *cfmt);
 
WS_DLL_PUBLIC
void try_convert_to_custom_column(char **fmt);
 
WS_DLL_PUBLIC
const char* try_convert_to_column_field(const char *field);
 
WS_DLL_PUBLIC
void column_register_fields(void);
#ifdef __cplusplus
}
#endif /* __cplusplus */