recent.h

Go to the documentation of this file.

 
#ifndef __RECENT_H__
#define __RECENT_H__
 
#include <glib.h>
 
#include <stdio.h>
#include "epan/timestamp.h"
#include "ui/ws_ui_util.h"
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
#define RECENT_KEY_CAPTURE_FILE         "recent.capture_file"
 
#define RECENT_KEY_DISPLAY_FILTER       "recent.display_filter"
 
#define RECENT_KEY_COL_WIDTH            "column.width"
 
#define RECENT_KEY_CAPTURE_FILTER       "recent.capture_filter"
 
#define RECENT_KEY_REMOTE_HOST          "recent.remote_host"
 
typedef struct _col_width_data {
    int    width;
    char   xalign;
} col_width_data;
 
#define COLUMN_XALIGN_DEFAULT  0
#define COLUMN_XALIGN_LEFT    'L'
#define COLUMN_XALIGN_CENTER  'C'
#define COLUMN_XALIGN_RIGHT   'R'
 
typedef enum {
    BYTES_HEX, 
    BYTES_BITS, 
    BYTES_DEC,  
    BYTES_OCT   
} bytes_view_type;
 
 
typedef enum {
    BYTES_ENC_FROM_PACKET, 
    BYTES_ENC_ASCII,       
    BYTES_ENC_EBCDIC       
} bytes_encoding_type;
 
 
typedef enum {
    SEARCH_IN_PACKET_LIST,    
    SEARCH_IN_PACKET_DETAILS, 
    SEARCH_IN_PACKET_BYTES    
} search_in_type;
 
 
typedef enum {
    SEARCH_CHAR_SET_NARROW_AND_WIDE, 
    SEARCH_CHAR_SET_NARROW,          
    SEARCH_CHAR_SET_WIDE             
} search_char_set_type;
 
 
typedef enum {
    SEARCH_TYPE_DISPLAY_FILTER, 
    SEARCH_TYPE_HEX_VALUE,      
    SEARCH_TYPE_STRING,         
    SEARCH_TYPE_REGEX           
} search_type_type;
 
 
typedef enum {
    SHOW_ASCII,         
    SHOW_ASCII_CONTROL, 
    SHOW_CARRAY,        
    SHOW_EBCDIC,        
    SHOW_HEXDUMP,       
    SHOW_HTML,          
    SHOW_IMAGE,         
    SHOW_JSON,          
    SHOW_RAW,           
    SHOW_RUSTARRAY,     
    SHOW_CODEC,         
    SHOW_YAML           
} bytes_show_type;
 
 
typedef enum {
    FOLLOW_DELTA_NONE, 
    FOLLOW_DELTA_TURN, 
    FOLLOW_DELTA_ALL   
} follow_delta_type;
 
 
typedef enum {
    DecodeAsNone,             
    DecodeAsBASE64,           
    DecodeAsCompressed,       
    DecodeAsHexDigits,        
    DecodeAsPercentEncoding,  
    DecodeAsQuotedPrintable,  
    DecodeAsROT13             
} bytes_decode_type;
 
 
typedef struct recent_settings_tag {
 
    /* --- Toolbar and pane visibility --- */
    bool main_toolbar_show;          
    bool filter_toolbar_show;        
    bool wireless_toolbar_show;      
    bool packet_list_show;           
    bool tree_view_show;             
    bool byte_view_show;             
    bool packet_diagram_show;        
    bool statusbar_show;             
    /* --- Packet list behaviour --- */
    bool packet_list_colorize;       
    bool capture_auto_scroll;        
    bool aggregation_view;           
    /* --- Time display --- */
    ts_type         gui_time_format;    
    int             gui_time_precision; 
    ts_seconds_type gui_seconds_format; 
    /* --- Zoom and bytes display --- */
    int                 gui_zoom_level;                    
    bytes_view_type     gui_bytes_view;                    
    bytes_encoding_type gui_bytes_encoding;                
    bool                gui_packet_diagram_field_values;   
    bool                gui_allow_hover_selection;         
    /* --- Find Packet settings --- */
    search_in_type       gui_search_in;              
    search_char_set_type gui_search_char_set;         
    bool                 gui_search_case_sensitive;   
    bool                 gui_search_reverse_dir;      
    bool                 gui_search_multiple_occurs;  
    search_type_type     gui_search_type;             
    /* --- Follow Stream settings --- */
    bytes_show_type   gui_follow_show;    
    follow_delta_type gui_follow_delta;   
    /* --- Show Packet Bytes settings --- */
    bytes_decode_type gui_show_bytes_decode; 
    bytes_show_type   gui_show_bytes_show;   
    /* --- Main window geometry --- */
    int  gui_geometry_main_x;          
    int  gui_geometry_main_y;          
    int  gui_geometry_main_width;      
    int  gui_geometry_main_height;     
    bool gui_geometry_main_maximized;  
    bool gui_geometry_leftalign_actions; 
    /* --- Splitter positions --- */
    int   gui_geometry_main_upper_pane;      
    int   gui_geometry_main_lower_pane;      
    char *gui_geometry_main;                 
    char *gui_geometry_main_master_split;    
    char *gui_geometry_main_extra_split;     
    /* --- Privilege and system warnings --- */
    bool privs_warn_if_elevated;   
    bool sys_warn_if_no_capture;   
    /* --- Column and dialog tab state --- */
    GList *col_width_list;              
    GList *conversation_tabs;           
    GList *conversation_tabs_columns;   
    GList *endpoint_tabs;               
    GList *endpoint_tabs_columns;       
    /* --- Miscellaneous --- */
    int   gui_profile_switch_check_count;  
    char *gui_fileopen_remembered_dir;     
    bool  gui_rlc_use_pdus_from_mac;       
    GList *custom_colors;                  
    GList *gui_additional_toolbars;        
    GList *interface_toolbars;             
    /* --- TCP Stream Graph dialog --- */
    bool   gui_tsgd_throughput_show;   
    bool   gui_tsgd_goodput_show;      
    double gui_tsgd_ma_window_size;    
    /* --- Welcome page sidebar / banner slides --- */
    bool     gui_welcome_page_sidebar_learn_visible;       
    bool     gui_welcome_page_sidebar_tips_visible;        
    bool     gui_welcome_page_sidebar_tips_events;         
    bool     gui_welcome_page_sidebar_tips_sponsorship;    
    bool     gui_welcome_page_sidebar_tips_tips;           
    bool     gui_welcome_page_sidebar_tips_auto_advance;   
    unsigned gui_welcome_page_sidebar_tips_interval;       
    char       *gui_theme_name;
    bool     gui_welcome_page_sidebar_tips_slides_test;    
} recent_settings_t;
 
extern recent_settings_t recent;
 
extern void recent_init(void);
 
extern void recent_cleanup(void);
 
extern bool write_recent(void);
 
extern bool write_profile_recent(void);
 
extern bool recent_read_static(char **rf_path_return, int *rf_errno_return);
 
extern bool recent_read_profile_static(char **rf_path_return, int *rf_errno_return);
 
extern bool recent_read_dynamic(char **rf_path_return, int *rf_errno_return);
 
extern int recent_set_arg(char *prefarg);
 
extern void recent_free_column_width_info(recent_settings_t *rs);
 
extern void recent_insert_column(int col);
 
extern void recent_remove_column(int col);
 
extern int recent_get_column_width(int col);
 
extern void recent_set_column_width(int col, int width);
 
extern char recent_get_column_xalign(int col);
 
extern void recent_set_column_xalign(int col, char xalign);
 
extern void window_geom_save(const char *name, window_geometry_t *geom);
 
extern bool window_geom_load(const char *name, window_geometry_t *geom);
 
extern void window_splitter_save(const char *name, const char *splitter_state);
 
extern const char * window_splitter_load(const char *name);
 
extern GList *recent_get_cfilter_list(const char *ifname);
 
extern void recent_add_cfilter(const char *ifname, const char *s);
 
extern struct remote_host *recent_get_remote_host(const char *host);
 
extern int recent_get_remote_host_list_size(void);
 
extern void recent_remote_host_list_foreach(GFunc func, void *user_data);
 
extern void recent_free_remote_host_list(void);
 
extern void recent_add_remote_host(char *host, struct remote_host *rh);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* recent.h */