column-utils.h

Go to the documentation of this file.

 
#ifndef __COLUMN_UTILS_H__
#define __COLUMN_UTILS_H__
 
#include "packet_info.h"
#include "ws_symbol_export.h"
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
#define COL_MAX_LEN 2048
#define COL_MAX_INFO_LEN 4096
 
/* A regex to split possibly multifield custom columns into components
 *
 * Split on operator "||" (with optional space around it) and on "or"
 * (which must have space around it to avoid matching in the middle of
 * a word, field in the "synphasor" protocol, etc. This is somewhat too
 * strict, as "or" adjacent to parentheses ought to be fine so long
 * as the filter matches the grammar, like "(tcp.port)or(udp.port)",
 * but that's the cost of using regex instead of the real parser.)
 * Also split on space at the beginning or end of the expression (in
 * lieu of always stripping whitespace at the beginning and end, but it
 * does mean that we have to ignore any empty tokens in the result.)
 *
 * Use negative lookahead to avoid matching "||" or "or" that are contained
 * within parentheses. Don't match if a close parenthesis comes before an
 * open parenthesis. The regex doesn't help with unmatched parentheses, but
 * such an expression already won't satisfy the grammar and won't compile.
 */
#define COL_CUSTOM_PRIME_REGEX "(?:^ *| *\\|\\| *| +or +| *$)(?![^(]*\\))"
 
struct epan_dissect;
 
struct epan_column_info;
typedef struct epan_column_info column_info;
 
enum {
  COL_ABS_YMD_TIME,   
  COL_ABS_YDOY_TIME,  
  COL_ABS_TIME,       
  COL_CUMULATIVE_BYTES, 
  COL_CUSTOM,         
  COL_DELTA_TIME,     
  COL_DELTA_TIME_DIS, 
  COL_RES_DST,        
  COL_UNRES_DST,      
  COL_RES_DST_PORT,   
  COL_UNRES_DST_PORT, 
  COL_DEF_DST,        
  COL_DEF_DST_PORT,   
  COL_EXPERT,         
  COL_IF_DIR,         
  COL_FREQ_CHAN,      
  COL_DEF_DL_DST,     
  COL_DEF_DL_SRC,     
  COL_RES_DL_DST,     
  COL_UNRES_DL_DST,   
  COL_RES_DL_SRC,     
  COL_UNRES_DL_SRC,   
  COL_RSSI,           
  COL_TX_RATE,        
  COL_DSCP_VALUE,     
  COL_INFO,           
  COL_RES_NET_DST,    
  COL_UNRES_NET_DST,  
  COL_RES_NET_SRC,    
  COL_UNRES_NET_SRC,  
  COL_DEF_NET_DST,    
  COL_DEF_NET_SRC,    
  COL_NUMBER,         
  COL_NUMBER_DIS,     
  COL_PACKET_LENGTH,  
  COL_PROTOCOL,       
  COL_REL_TIME,       
  COL_REL_CAP_TIME,   
  COL_DEF_SRC,        
  COL_DEF_SRC_PORT,   
  COL_RES_SRC,        
  COL_UNRES_SRC,      
  COL_RES_SRC_PORT,   
  COL_UNRES_SRC_PORT, 
  COL_UTC_YMD_TIME,   
  COL_UTC_YDOY_TIME,  
  COL_UTC_TIME,       
  COL_CLS_TIME,       
  NUM_COL_FMTS        
};
 
WS_DLL_PUBLIC bool col_get_writable(column_info *cinfo, const int col);
 
WS_DLL_PUBLIC void col_set_writable(column_info *cinfo, const int col, const bool writable);
 
WS_DLL_PUBLIC void col_set_fence(column_info *cinfo, const int col);
 
WS_DLL_PUBLIC void col_clear_fence(column_info *cinfo, const int col);
 
WS_DLL_PUBLIC const char *col_get_text(column_info *cinfo, const int col);
 
WS_DLL_PUBLIC void col_clear(column_info *cinfo, const int col);
 
WS_DLL_PUBLIC void col_set_str(column_info *cinfo, const int col, const char * str);
 
WS_DLL_PUBLIC void col_add_str(column_info *cinfo, const int col, const char *str);
 
/* terminator argument for col_add_lstr() function */
#define COL_ADD_LSTR_TERMINATOR (const char *) -1
 
WS_DLL_PUBLIC void col_add_lstr(column_info *cinfo, const int el, const char *str, ...);
 
WS_DLL_PUBLIC void col_add_fstr(column_info *cinfo, const int col, const char *format, ...)
    G_GNUC_PRINTF(3, 4);
 
WS_DLL_PUBLIC void col_append_str(column_info *cinfo, const int col, const char *str);
 
WS_DLL_PUBLIC void col_append_str_uint(column_info *cinfo, const int col, const char *abbrev, uint32_t val, const char *sep);
 
WS_DLL_PUBLIC void col_append_ports(column_info *cinfo, const int col, port_type typ, uint16_t src, uint16_t dst);
 
WS_DLL_PUBLIC void col_append_frame_number(packet_info *pinfo, const int col, const char *fmt_str, unsigned frame_num);
 
/* Append the given strings (terminated by COL_ADD_LSTR_TERMINATOR) to a column element,
 *
 * Same result as col_append_str() called for every string element.
 */
WS_DLL_PUBLIC void col_append_lstr(column_info *cinfo, const int el, const char *str, ...);
 
WS_DLL_PUBLIC void col_append_fstr(column_info *cinfo, const int col, const char *format, ...)
    G_GNUC_PRINTF(3, 4);
 
WS_DLL_PUBLIC void col_prepend_fstr(column_info *cinfo, const int col, const char *format, ...)
    G_GNUC_PRINTF(3, 4);
 
WS_DLL_PUBLIC void col_prepend_fence_fstr(column_info *cinfo, const int col, const char *format, ...)
    G_GNUC_PRINTF(3, 4);
 
WS_DLL_PUBLIC void col_append_sep_str(column_info *cinfo, const int col, const char *sep,
        const char *str);
 
WS_DLL_PUBLIC void col_append_sep_fstr(column_info *cinfo, const int col, const char *sep,
        const char *format, ...)
    G_GNUC_PRINTF(4, 5);
 
WS_DLL_PUBLIC void col_set_time(column_info *cinfo, const int col,
            const nstime_t *ts, const char *fieldname);
 
WS_DLL_PUBLIC void set_fd_time(const struct epan_session *epan, frame_data *fd, char *buf);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* __COLUMN_UTILS_H__ */