osmith
/
wireshark
forked from osmocom/wireshark
1
0
Fork 0
Code Pull Requests Releases Wiki Activity

decode_as: Update the documentation a bit. 

Change-Id: I725e4cb0b075c5c763cf47fb6c7531f01139d54c
Reviewed-on: https://code.wireshark.org/review/36763
Petri-Dish: Anders Broman <a.broman58@gmail.com>
Reviewed-by: Anders Broman <a.broman58@gmail.com>
This commit is contained in:
Anders Broman 2020-04-09 11:03:08 +02:00 committed by Anders Broman
parent a0600e02a9
commit ee61578682
1 changed files with 28 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
epan/decode_as.h
View File

@ -48,24 +48,38 @@ typedef gboolean (*decode_as_reset_func)(const gchar *name, gconstpointer patter
/** callback function definition: Apply value to dissector table */
typedef gboolean (*decode_as_change_func)(const gchar *name, gconstpointer pattern, gconstpointer handle, const gchar *list_name);
/**
Contains all of the function pointers (typically just 1) that
provide the text explaining the name and use of the value field that will
be passed to the dissector table to change the dissection output.
*/
typedef struct decode_as_value_s {
build_label_func label_func;
guint num_values;
build_valid_func* build_values;
build_label_func label_func; /**< function pointer to the function used to create the label*/
guint num_values; /**< Number of values */
build_valid_func* build_values; /**< Function used to build the value to go into the table. Retreive from current frame */
} decode_as_value_t;
/**
Pulls everything together including the dissector (protocol) name, the
"layer type" of the dissector, the dissector table name, the function pointer
values as well as handlers for populating, applying and reseting the changes
to the dissector table through Decode As GUI functionality. For dissector
tables that are an integer or string type, the provided "default" handling
functions should suffice.
*/
typedef struct decode_as_s {
const char *name;
const gchar *table_name;
guint num_items;
guint default_index_value;
decode_as_value_t* values;
const char* pre_value_str;
const char* post_value_str;
decode_as_populate_list_func populate_list;
decode_as_reset_func reset_value;
decode_as_change_func change_value;
decode_as_free_func free_func;
const char *name; /**< Protocol name */
const gchar *table_name; /**< Disector table name */
guint num_items; /**< Number of index in the decode_as_value_t struct */
guint default_index_value; /**< Which display function to use first, set to zero if only one function*/
decode_as_value_t* values; /**< The array of function pointers, see decode_as_value_t */
const char* pre_value_str; /**< String to prepend the value, NULL if none */
const char* post_value_str; /**< String to append the value, NULL if none */
decode_as_populate_list_func populate_list; /**< function pointer to the function used to populate the list, NULL if none */
decode_as_reset_func reset_value; /**< function pointer to the function used resetting the value, NULL if none */
decode_as_change_func change_value; /**< function pointer to the function used resetting the value, NULL if none */
decode_as_free_func free_func; /**< function pointer to the function used freeing the entry, NULL if none */
} decode_as_t;