diff options
Diffstat (limited to 'epan/column.h')
| -rw-r--r-- | epan/column.h | 63 |
1 files changed, 59 insertions, 4 deletions
diff --git a/epan/column.h b/epan/column.h index 2a641e8dbb..dd8d546c40 100644 --- a/epan/column.h +++ b/epan/column.h @@ -1,5 +1,8 @@ -/* column.h +/** @file * Definitions for column handling routines + * Column preference and format settings. + * + * For internal Wireshark useonly. Don't include this header in dissectors! * * Wireshark - Network traffic analyzer * By Gerald Combs <gerald@wireshark.org> @@ -12,7 +15,7 @@ #define __COLUMN_H__ #include "ws_symbol_export.h" -#include <epan/column-info.h> +#include <epan/column-utils.h> #ifdef __cplusplus extern "C" { @@ -23,8 +26,8 @@ typedef struct _fmt_data { int fmt; /* format of column */ gchar *custom_fields; /* fields names for COL_CUSTOM */ gint custom_occurrence; /* optional ordinal of occurrence of that field */ - gboolean visible; /* if FALSE, hide this column */ - gboolean resolved; /* if TRUE, show a more human-readable name */ + bool visible; /* if FALSE, hide this column */ + bool resolved; /* if TRUE, show a more human-readable name */ } fmt_data; WS_DLL_PUBLIC @@ -32,6 +35,8 @@ const gchar *col_format_to_string(const gint); WS_DLL_PUBLIC const gchar *col_format_desc(const gint); WS_DLL_PUBLIC +const gchar *col_format_abbrev(const gint); +WS_DLL_PUBLIC gint get_column_format(const gint); WS_DLL_PUBLIC void set_column_format(const gint, const gint); @@ -66,6 +71,19 @@ gint get_column_char_width(const gint format); WS_DLL_PUBLIC gchar *get_column_tooltip(const gint col); +/** Get the text of a column element. The string returned may + * depend on whether the resolved member variable is set. + * For internal Wireshark use, not to be called from dissectors. + * Dissectors use col_get_text() in column-utils.h + * + * @param cinfo the column information + * @param col the column index to use (not the format) + * + * @return the text string + */ +WS_DLL_PUBLIC +const gchar *get_column_text(column_info *cinfo, const gint col); + WS_DLL_PUBLIC void col_finalize(column_info *cinfo); @@ -77,6 +95,43 @@ build_column_format_array(column_info *cinfo, const gint num_cols, const gboolea WS_DLL_PUBLIC void column_dump_column_formats(void); +/** Parse a column format string into a fmt_data struct. + * If the format string possibly can be that of a deprecated column + * that has been migrated to a custom column (e.g., upon first being + * read from a preference file), call try_convert_to_custom_column() first. + * + * @param[out] cfmt The parsed cfmt, still owned by the caller. + * For custom columns, the caller is responsible for freeing + * the custom_fields member as well. + * @param[in] fmt The column format to parse. + * + * @return TRUE if conversion was successful, FALSE if unsuccessful + */ +WS_DLL_PUBLIC +gboolean parse_column_format(fmt_data *cfmt, const char *fmt); + +/** Checks a column format string to see if it is a deprecated column + * that has been migrated to a custom column, and converts the format + * to the corresponding custom column format if so, otherwise leaving + * it unchanged. + * + * @param[in,out] fmt The column format to check and possibly convert. + */ +WS_DLL_PUBLIC +void try_convert_to_custom_column(char **fmt); + +/** Checks a column field string to see if it is a name of a filter + * field created using a default column title (as used in tshark -e), + * and alias it to the new column type based field. + * + * @param[in] field The old title based field, e.g. "_ws.col.Info" + * @return The new field, e.g. "_ws.col.info", or NULL + */ +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 */ |