/*
* uat.h
*
- * $Id$
- *
* User Accessible Tables
- * Mantain an array of user accessible data strucures
+ * Maintain an array of user accessible data structures
*
- * (c) 2007, Luis E. Garcia Ontanon <luis.ontanon@gmail.com>
+ * (c) 2007, Luis E. Garcia Ontanon <luis@ontanon.org>
*
* Wireshark - Network traffic analyzer
* By Gerald Combs <gerald@wireshark.org>
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
-#ifndef _UAT_H_
-#define _UAT_H_
+#ifndef __UAT_H__
+#define __UAT_H__
+
+#include <stdlib.h>
+
+#include "ws_symbol_export.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif /* __cplusplus */
/*
- * uat mantains a dynamically allocated table accessible to the user
- * via a file and/or gui tables.
+ * UAT maintains a dynamically allocated table accessible to the user
+ * via a file and/or via GUI preference dialogs.
*
- * the file is located either in userdir(when first read or when writen) or
- * in datadir for defaults (read only , it will be always written to userdir).
+ * The file is read from and written in the personal configuration directory. If
+ * there is no such file, defaults will be loaded from the global data
+ * directory.
*
- * the behaviour of the table is controlled by a series of callbacks
- * the caller must provide.
+ * The behaviour of the table is controlled by a series of callbacks which
+ * the caller (e.g. a dissector) must provide.
*
- * BEWARE that the user can change an uat at (almost) any time,
- * That is pointers to records in an uat are valid only during the call
- * to the function that obtains them (do not store them).
+ * BEWARE that the user can change an UAT at (almost) any time (via the GUI).
+ * That is, pointers to records in an UAT are valid only during the call
+ * to the function that obtains them (do not store pointers to these records).
+ * The records contents are only guaranteed to be valid in the post_update_cb
+ * function. (Implementation detail: currently a race condition is possible
+ * where the UAT consumer (dissector code) tries to use the UAT while the GUI
+ * user frees a record resulting in use-after-free. This is not ideal and might
+ * be fixed later.)
*
- * UATs are meant for short tables of user data (passwords and such) there's
+ * UATs are meant for short tables of user data (passwords and such), there is
* no quick access, you must iterate through them each time to fetch the record
- * you are looking for. Use uat_dup() or uat_se_dup() if necessary.
+ * you are looking for.
*
- * Only users via gui or editing the file can add/remove records your code cannot.
+ * Only users via GUI or editing the file can add/remove records, your
+ * (dissector) code cannot.
*/
/* obscure data type to handle an uat */
-typedef struct _uat_t uat_t;
+typedef struct epan_uat uat_t;
/********************************************
* Callbacks:
* these instruct uat on how to deal with user info and data in records
********************************************/
/********
- * Callbacks for the entire table (these deal with entire records)
+ * Callbacks dealing with the entire table
********/
/*
- * Copy CB
- * used to copy a record
- * optional, memcpy will be used if not given
- * copy(dest,orig,len)
+ * Post-Update CB
+ *
+ * To be called by the GUI code after to the table has being edited.
+ * Will be called once the user clicks the Apply or OK button
+ * optional
*/
-typedef void* (*uat_copy_cb_t)(void*, const void*, unsigned);
+typedef void (*uat_post_update_cb_t)(void);
-/*
+
+/********
+ * Callbacks dealing with records (these deal with entire records)
+ ********/
+
+/**
+ * Copy CB
+ * copy(dest, source, len)
*
+ * Used to duplicate the contents of one record to another.
+ * Optional, memcpy will be used if not given.
+ */
+typedef void* (*uat_copy_cb_t)(void *dest, const void *source, size_t len);
+
+/**
* Free CB
- *
- * destroy a record's child data
- * (do not free the container, it will be handled by uat)
- * it is optional, no child data will be freed if no present
* free(record)
+ *
+ * Destroy the contents of a record, possibly freeing some fields.
+ * Do not free the container itself, this memory is owned by the UAT core.
+ * Optional if the record contains no pointers that need to be freed.
*/
-typedef void (*uat_free_cb_t)(void*);
+typedef void (*uat_free_cb_t)(void *record);
-/*
- * Update CB
+/**
+ * Reset DB
*
- * to be called after all record fields has been updated
- * optional, record will be updated always if not given
+ * Used to free resources associated with a UAT loaded from file (e.g. post_update_cb)
+ * Optional.
+ */
+typedef void (*uat_reset_cb_t)(void);
+
+/**
+ * Update CB
* update(record,&error)
+ *
+ * Validates the contents of the record contents, to be called after any record
+ * fields had been updated (either from file or after modifications in the GUI).
+ *
+ * Optional, the record will be considered valid if the callback is omitted.
+ * It must return TRUE if the contents are considered valid and FALSE otherwise
+ * in which case the failure reason is set in 'error'. The error string will be
+ * freed by g_free.
*/
-typedef void (*uat_update_cb_t)(void* , const char** );
+typedef gboolean (*uat_update_cb_t)(void *record, char **error);
/*******
********/
/*
+ * Check CB
+ * chk(record, ptr, len, chk_data, fld_data, &error)
+ *
* given an input string (ptr, len) checks if the value is OK for a field in the record.
* it will return TRUE if OK or else
- * it will return FALSE and may set *error to inform the user on what's
+ * it will return FALSE and set *error to inform the user on what's
* wrong with the given input
+ * The error string must be allocated with g_malloc() or
+ * a routine that calls it.
* optional, if not given any input is considered OK and the set cb will be called
- * chk(record, ptr, len, chk_data, fld_data, &error)
*/
-typedef gboolean (*uat_fld_chk_cb_t)(void*, const char*, unsigned, void*, void*, const char**);
+typedef gboolean (*uat_fld_chk_cb_t)(void *record, const char *ptr, unsigned len, const void *chk_data, const void *fld_data, char **error);
/*
* Set Field CB
+ * set(record, ptr, len, set_data, fld_data)
*
* given an input string (ptr, len) sets the value of a field in the record,
- * it will return TRUE if OK or else
- * it will return FALSE and may set *error to inform the user on what's
- * wrong with the given input
* it is mandatory
- * set(record, ptr, len, set_data, fld_data)
*/
-typedef void (*uat_fld_set_cb_t)(void*, const char*, unsigned, void*, void*);
+typedef void (*uat_fld_set_cb_t)(void *record, const char *ptr, unsigned len, const void *set_data, const void *fld_data);
/*
+ * Convert-to-string CB
+ * tostr(record, &out_ptr, &out_len, tostr_data, fld_data)
+ *
* given a record returns a string representation of the field
* mandatory
- * tostr(record, &out_ptr, &out_len, tostr_data, fld_data)
*/
-typedef void (*uat_fld_tostr_cb_t)(void*, const char**, unsigned*, void*, void*);
+typedef void (*uat_fld_tostr_cb_t)(void *record, char **out_ptr, unsigned *out_len, const void *tostr_data, const void *fld_data);
/***********
* Text Mode
*
- * used for file and dialog representation of fileds in columns,
+ * used for file and dialog representation of fields in columns,
* when the file is read it modifies the way the value is passed back to the fld_set_cb
* (see definition bellow for description)
***********/
/*
file:
reads:
- ,"\x20\x00\x30", as " \00",3
+ ,"\x20\x00\x30", as " \00",3 ("space nil zero" of length 3)
,"", as "",0
,, as NULL,0
writes:
/*
file:
reads:
- ,A1b2C3d4, as "\001\002\003\004",4
+ ,A1b2C3d4, as "\xa1\xb2\xc3\xd4",4
,, as NULL,0
writes:
,, on NULL, *
- ,a1b2c3d4, on "\001\002\003\004",4
+ ,a1b2c3d4, on "\xa1\xb2\xc3\xd4",4
dialog:
- "a1b2c3d4" as "\001\002\003\004",4
- "a1 b2:c3d4" as "\001\002\003\004",4
+ interprets the following input ... as ...:
+ "a1b2c3d4" as "\xa1\xb2\xc3\xd4",4
+ "a1 b2:c3d4" as "\xa1\xb2\xc3\xd4",4
"" as NULL,0
"invalid" as NULL,3
"a1b" as NULL, 1
*/
- PT_TXTMOD_ENUM
+ PT_TXTMOD_ENUM,
+ /* Read/Writes/displays the string value (not number!) */
+
+ PT_TXTMOD_COLOR,
+ /* Reads/Writes/display color in #RRGGBB format */
+
+ PT_TXTMOD_FILENAME,
+ /* processed like a PT_TXTMOD_STRING, but shows a filename dialog */
+ PT_TXTMOD_DIRECTORYNAME,
+ /* processed like a PT_TXTMOD_STRING, but shows a directory dialog */
+ PT_TXTMOD_DISPLAY_FILTER,
+ /* processed like a PT_TXTMOD_STRING, but verifies display filter */
+ PT_TXTMOD_PROTO_FIELD,
+ /* processed like a PT_TXTMOD_STRING, but verifies protocol field name (e.g tcp.flags.syn) */
+ PT_TXTMOD_BOOL
+ /* Displays a checkbox for value */
} uat_text_mode_t;
/*
*/
typedef struct _uat_field_t {
const char* name;
+ const char* title;
uat_text_mode_t mode;
struct {
} cb;
struct {
- void* chk;
- void* set;
- void* tostr;
+ const void* chk;
+ const void* set;
+ const void* tostr;
} cbdata;
- void* fld_data;
+ const void* fld_data;
const char* desc;
struct _fld_data_t* priv;
} uat_field_t;
#define FLDFILL NULL
-#define UAT_END_FIELDS {0,PT_TXTMOD_NONE,{0,0,0},{0,0,0},0,0,FLDFILL}
-
+#define UAT_END_FIELDS {NULL,NULL,PT_TXTMOD_NONE,{0,0,0},{0,0,0},0,0,FLDFILL}
-#define UAT_CAT_GENERAL "General"
-#define UAT_CAT_PORTS "Port Assignments"
-#define UAT_CAT_CRYPTO "Decryption"
-#define UAT_CAT_FFMT "File Formats"
+/*
+ * Flags to indicate what the settings in this UAT affect.
+ * This is used when UATs are changed interactively, to indicate what needs
+ * to be redone when the UAT is changed.
+ */
+#define UAT_AFFECTS_DISSECTION 0x00000001 /* affects packet dissection */
+#define UAT_AFFECTS_FIELDS 0x00000002 /* affects what named fields exist */
/** Create a new uat
*
* @param name The name of the table
- * @param data_ptr A pointer to a null terminated array of pointers to the data
- * @param default_data A pointer to a struct containing default values
* @param size The size of the structure
* @param filename The filename to be used (either in userdir or datadir)
+ * @param from_profile TRUE if profile directory to be used
+ * @param data_ptr Although a void*, this is really a pointer to a null terminated array of pointers to the data
+ * @param num_items_ptr A pointer with number of items
+ * @param flags flags indicating what this UAT affects
+ * @param help A pointer to help text
* @param copy_cb A function that copies the data in the struct
* @param update_cb Will be called when a record is updated
* @param free_cb Will be called to destroy a struct in the dataset
+ * @param post_update_cb Will be called once the user clicks the Apply or OK button
+ * @param reset_cb Will be called to destroy internal data
+ * @param flds_array A pointer to an array of uat_field_t structs
*
* @return A freshly-allocated and populated uat_t struct.
*/
+WS_DLL_PUBLIC
uat_t* uat_new(const char* name,
size_t size,
const char* filename,
gboolean from_profile,
- void** data_ptr,
- guint* num_items,
- const char* category,
+ void* data_ptr,
+ guint* num_items_ptr,
+ guint flags,
const char* help,
uat_copy_cb_t copy_cb,
uat_update_cb_t update_cb,
uat_free_cb_t free_cb,
+ uat_post_update_cb_t post_update_cb,
+ uat_reset_cb_t reset_cb,
uat_field_t* flds_array);
+/** Cleanup all Uats
+ *
+ */
+void uat_cleanup(void);
+
/** Populate a uat using its file.
*
* @param uat_in Pointer to a uat. Must not be NULL.
*
* @return TRUE on success, FALSE on failure.
*/
+WS_DLL_PUBLIC
gboolean uat_load(uat_t* uat_in, char** err);
/** Create or update a single uat entry using a string.
*/
uat_t *uat_find(gchar *name);
-/*
- * uat_dup()
- * uat_se_dup()
- * make a reliable copy of an uat for internal use,
- * so that pointers to records can be kept through calls.
- * return NULL on zero len.
- */
-void* uat_dup(uat_t*, guint* len_p); /* to be freed */
-void* uat_se_dup(uat_t*, guint* len_p);
+WS_DLL_PUBLIC
uat_t* uat_get_table_by_name(const char* name);
/*
* Some common uat_fld_chk_cbs
*/
-gboolean uat_fld_chk_str(void*, const char*, unsigned, void*,void*, const char** err);
-gboolean uat_fld_chk_proto(void*, const char*, unsigned, void*,void*, const char** err);
-gboolean uat_fld_chk_num_dec(void*, const char*, unsigned, void*, void*, const char** err);
-gboolean uat_fld_chk_num_hex(void*, const char*, unsigned, void*, void*, const char** err);
-gboolean uat_fld_chk_enum(void*, const char*, unsigned, void*, void*, const char**);
-gboolean uat_fld_chk_range(void*, const char*, unsigned, void*, void*, const char**);
-
-#define CHK_STR_IS_DECL(what) \
-gboolean uat_fld_chk_str_ ## what (void*, const char*, unsigned, void*, void*, const char**)
+WS_DLL_PUBLIC
+gboolean uat_fld_chk_str(void*, const char*, unsigned, const void*, const void*, char** err);
+gboolean uat_fld_chk_oid(void*, const char*, unsigned, const void*, const void*, char** err);
+WS_DLL_PUBLIC
+gboolean uat_fld_chk_proto(void*, const char*, unsigned, const void*, const void*, char** err);
+WS_DLL_PUBLIC
+gboolean uat_fld_chk_num_dec(void*, const char*, unsigned, const void*, const void*, char** err);
+WS_DLL_PUBLIC
+gboolean uat_fld_chk_num_hex(void*, const char*, unsigned, const void*, const void*, char** err);
+WS_DLL_PUBLIC
+gboolean uat_fld_chk_bool(void*, const char*, unsigned, const void*, const void*, char** err);
+WS_DLL_PUBLIC
+gboolean uat_fld_chk_enum(void*, const char*, unsigned, const void*, const void*, char**);
+WS_DLL_PUBLIC
+gboolean uat_fld_chk_range(void*, const char*, unsigned, const void*, const void*, char**);
+WS_DLL_PUBLIC
+gboolean uat_fld_chk_color(void*, const char*, unsigned, const void*, const void*, char**);
typedef void (*uat_cb_t)(void* uat,void* user_data);
+WS_DLL_PUBLIC
void uat_foreach_table(uat_cb_t cb,void* user_data);
void uat_unload_all(void);
char* uat_esc(const char* buf, guint len);
/* Some strings entirely made of ... already declared */
-CHK_STR_IS_DECL(isprint);
-CHK_STR_IS_DECL(isalpha);
-CHK_STR_IS_DECL(isalnum);
-CHK_STR_IS_DECL(isdigit);
-CHK_STR_IS_DECL(isxdigit);
-#define CHK_STR_IS_DEF(what) \
-gboolean uat_fld_chk_str_ ## what (void* u1 _U_, const char* strptr, unsigned len, void* u2 _U_, void* u3 _U_, const char** err) { \
- guint i; for (i=0;i<len;i++) { \
- char c = strptr[i]; \
- if (! what((int)c)) { \
- *err = ep_strdup_printf("invalid char pos=%d value=%.2x",i,c); return FALSE; } } \
- *err = NULL; return TRUE; }
+WS_DLL_PUBLIC
+gboolean uat_fld_chk_str_isprint(void*, const char*, unsigned, const void*, const void*, char**);
+
+WS_DLL_PUBLIC
+gboolean uat_fld_chk_str_isalpha(void*, const char*, unsigned, const void*, const void*, char**);
+
+WS_DLL_PUBLIC
+gboolean uat_fld_chk_str_isalnum(void*, const char*, unsigned, const void*, const void*, char**);
+
+WS_DLL_PUBLIC
+gboolean uat_fld_chk_str_isdigit(void*, const char*, unsigned, const void*, const void*, char**);
+
+WS_DLL_PUBLIC
+gboolean uat_fld_chk_str_isxdigit(void*, const char*, unsigned, const void*, const void*, char**);
/*
* for those elements in uat_field_t array
*/
+#ifdef __cplusplus
+#define UNUSED_PARAMETER(n)
+#else
+#define UNUSED_PARAMETER(n) n _U_
+#endif
+
/*
* CSTRING macros,
* a simple c-string contained in (((rec_t*)rec)->(field_name))
*/
#define UAT_CSTRING_CB_DEF(basename,field_name,rec_t) \
-static void basename ## _ ## field_name ## _set_cb(void* rec, const char* buf, unsigned len, void* u1 _U_, void* u2 _U_) {\
+static void basename ## _ ## field_name ## _set_cb(void* rec, const char* buf, guint len, const void* UNUSED_PARAMETER(u1), const void* UNUSED_PARAMETER(u2)) {\
char* new_buf = g_strndup(buf,len); \
- if ((((rec_t*)rec)->field_name)) g_free((((rec_t*)rec)->field_name)); \
+ g_free((((rec_t*)rec)->field_name)); \
(((rec_t*)rec)->field_name) = new_buf; } \
-static void basename ## _ ## field_name ## _tostr_cb(void* rec, const char** out_ptr, unsigned* out_len, void* u1 _U_, void* u2 _U_) {\
+static void basename ## _ ## field_name ## _tostr_cb(void* rec, char** out_ptr, unsigned* out_len, const void* UNUSED_PARAMETER(u1), const void* UNUSED_PARAMETER(u2)) {\
if (((rec_t*)rec)->field_name ) { \
- *out_ptr = (((rec_t*)rec)->field_name); *out_len = strlen((((rec_t*)rec)->field_name)); \
+ *out_ptr = g_strdup((((rec_t*)rec)->field_name)); \
+ *out_len = (unsigned)strlen((((rec_t*)rec)->field_name)); \
} else { \
- *out_ptr = ""; *out_len = 0; } }
+ *out_ptr = g_strdup(""); *out_len = 0; } }
+
+#define UAT_FLD_CSTRING(basename,field_name,title,desc) \
+ {#field_name, title, PT_TXTMOD_STRING,{uat_fld_chk_str,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{0,0,0},0,desc,FLDFILL}
+
+#define UAT_FLD_CSTRING_ISPRINT(basename,field_name,title,desc) \
+ {#field_name, title, PT_TXTMOD_STRING,{uat_fld_chk_str_isprint,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{0,0,0},0,desc,FLDFILL}
+
+#define UAT_FLD_CSTRING_OTHER(basename,field_name,title,chk,desc) \
+ {#field_name, title, PT_TXTMOD_STRING,{ chk ,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{0,0,0},0,desc,FLDFILL}
+
+/*
+ * FILENAME and DIRECTORYNAME,
+ * a simple c-string contained in (((rec_t*)rec)->(field_name))
+ */
+#define UAT_FILENAME_CB_DEF(basename,field_name,rec_t) UAT_CSTRING_CB_DEF(basename,field_name,rec_t)
+
+/* XXX UAT_FLD_FILENAME is currently unused. */
+#define UAT_FLD_FILENAME(basename,field_name,title,desc) \
+ {#field_name, title, PT_TXTMOD_FILENAME,{uat_fld_chk_str,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{0,0,0},0,desc,FLDFILL}
+
+/*
+ * Both the Qt and GTK+ UIs assume that we're opening a preexisting
+ * file. We might want to split the ..._FILENAME defines into
+ * ..._FILE_OPEN and ..._FILE_SAVE if we ever need to specify a
+ * file that we're creating.
+ */
+#define UAT_FLD_FILENAME_OTHER(basename,field_name,title,chk,desc) \
+ {#field_name, title, PT_TXTMOD_FILENAME,{chk,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{0,0,0},0,desc,FLDFILL}
+
+#define UAT_DIRECTORYNAME_CB_DEF(basename,field_name,rec_t) UAT_CSTRING_CB_DEF(basename,field_name,rec_t)
+
+#define UAT_FLD_DIRECTORYNAME(basename,field_name,title,desc) \
+ {#field_name, title, PT_TXTMOD_DIRECTORYNAME,{uat_fld_chk_str,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{0,0,0},0,desc,FLDFILL}
+
+/*
+ * DISPLAY_FILTER,
+ * a simple c-string contained in (((rec_t*)rec)->(field_name))
+ */
+#define UAT_DISPLAY_FILTER_CB_DEF(basename,field_name,rec_t) UAT_CSTRING_CB_DEF(basename,field_name,rec_t)
+
+#define UAT_FLD_DISPLAY_FILTER(basename,field_name,title,desc) \
+ {#field_name, title, PT_TXTMOD_DISPLAY_FILTER, {uat_fld_chk_str,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{0,0,0},0,desc,FLDFILL}
+
+/*
+ * PROTO_FIELD,
+ * a simple c-string contained in (((rec_t*)rec)->(field_name))
+ */
+#define UAT_PROTO_FIELD_CB_DEF(basename,field_name,rec_t) UAT_CSTRING_CB_DEF(basename,field_name,rec_t)
-#define UAT_FLD_CSTRING(basename,field_name,desc) \
- {#field_name, PT_TXTMOD_STRING,{uat_fld_chk_str,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{0,0,0},0,desc,FLDFILL}
+#define UAT_FLD_PROTO_FIELD(basename,field_name,title,desc) \
+ {#field_name, title, PT_TXTMOD_PROTO_FIELD, {uat_fld_chk_str,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{0,0,0},0,desc,FLDFILL}
-#define UAT_FLD_CSTRING_ISPRINT(basename,field_name,desc) \
- {#field_name, PT_TXTMOD_STRING,{uat_fld_chk_str_isprint,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{0,0,0},0,desc,FLDFILL}
+/*
+ * OID - just a CSTRING with a specific check routine
+ */
+#define UAT_FLD_OID(basename,field_name,title,desc) \
+ {#field_name, title, PT_TXTMOD_STRING,{uat_fld_chk_oid,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{0,0,0},0,desc,FLDFILL}
-#define UAT_FLD_CSTRING_OTHER(basename,field_name,chk,desc) \
- {#field_name, PT_TXTMOD_STRING,{ chk ,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{0,0,0},0,desc,FLDFILL}
/*
* LSTRING MACROS
*/
#define UAT_LSTRING_CB_DEF(basename,field_name,rec_t,ptr_element,len_element) \
-static void basename ## _ ## field_name ## _set_cb(void* rec, const char* buf, unsigned len, void* u1 _U_, void* u2 _U_) {\
- const char* new_val = uat_unesc(buf,len,&(((rec_t*)rec)->len_element)); \
- if ((((rec_t*)rec)->ptr_element)) g_free((((rec_t*)rec)->ptr_element)); \
+static void basename ## _ ## field_name ## _set_cb(void* rec, const char* buf, guint len, const void* UNUSED_PARAMETER(u1), const void* UNUSED_PARAMETER(u2)) {\
+ char* new_val = uat_unesc(buf,len,&(((rec_t*)rec)->len_element)); \
+ g_free((((rec_t*)rec)->ptr_element)); \
(((rec_t*)rec)->ptr_element) = new_val; }\
-static void basename ## _ ## field_name ## _tostr_cb(void* rec, const char** out_ptr, unsigned* out_len, void* u1 _U_, void* u2 _U_) {\
+static void basename ## _ ## field_name ## _tostr_cb(void* rec, char** out_ptr, unsigned* out_len, const void* UNUSED_PARAMETER(u1), const void* UNUSED_PARAMETER(u2)) {\
if (((rec_t*)rec)->ptr_element ) { \
*out_ptr = uat_esc(((rec_t*)rec)->ptr_element, (((rec_t*)rec)->len_element)); \
- *out_len = strlen(*out_ptr); \
+ *out_len = (unsigned)strlen(*out_ptr); \
} else { \
- *out_ptr = ""; *out_len = 0; } }
+ *out_ptr = g_strdup(""); \
+ *out_len = 0; \
+ } \
+}
-#define UAT_FLD_LSTRING(basename,field_name,desc) \
-{#field_name, PT_TXTMOD_STRING,{0,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{0,0,0},0,desc,FLDFILL}
+#define UAT_FLD_LSTRING(basename,field_name,title, desc) \
+{#field_name, title, PT_TXTMOD_STRING,{0,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{0,0,0},0,desc,FLDFILL}
/*
* BUFFER macros,
* a buffer_ptr contained in (((rec_t*)rec)->(field_name))
* and its len in (((rec_t*)rec)->(len_name))
- * XXX: UNTESTED and probably BROKEN
*/
#define UAT_BUFFER_CB_DEF(basename,field_name,rec_t,ptr_element,len_element) \
-static void basename ## _ ## field_name ## _set_cb(void* rec, const char* buf, unsigned len, void* u1 _U_, void* u2 _U_) {\
- const char* new_buf = len ? g_memdup(buf,len) : NULL; \
- if ((((rec_t*)rec)->ptr_element) ) g_free((((rec_t*)rec)->ptr_element)); \
- (((rec_t*)rec)->ptr_element) = new_buf; \
- (((rec_t*)rec)->len_element) = len; } \
-static void basename ## _ ## field_name ## _tostr_cb(void* rec, const char** out_ptr, unsigned* out_len, void* u1 _U_, void* u2 _U_) {\
- *out_ptr = ((rec_t*)rec)->ptr_element ? ep_memdup(((rec_t*)rec)->ptr_element,((rec_t*)rec)->len_element) : ""; \
+static void basename ## _ ## field_name ## _set_cb(void* rec, const char* buf, guint len, const void* UNUSED_PARAMETER(u1), const void* UNUSED_PARAMETER(u2)) {\
+ char* new_buf = len ? (char *)g_memdup(buf,len) : NULL; \
+ g_free((((rec_t*)rec)->ptr_element)); \
+ (((rec_t*)rec)->ptr_element) = new_buf; \
+ (((rec_t*)rec)->len_element) = len; } \
+static void basename ## _ ## field_name ## _tostr_cb(void* rec, char** out_ptr, unsigned* out_len, const void* UNUSED_PARAMETER(u1), const void* UNUSED_PARAMETER(u2)) {\
+ *out_ptr = ((rec_t*)rec)->ptr_element ? (char*)g_memdup(((rec_t*)rec)->ptr_element,((rec_t*)rec)->len_element) : g_strdup(""); \
*out_len = ((rec_t*)rec)->len_element; }
-#define UAT_FLD_BUFFER(basename,field_name,desc) \
- {#field_name, PT_TXTMOD_HEXBYTES,{0,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{0,0,0},0,desc,FLDFILL}
+#define UAT_FLD_BUFFER(basename,field_name,title,desc) \
+ {#field_name, title, PT_TXTMOD_HEXBYTES,{0,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{0,0,0},0,desc,FLDFILL}
/*
* a decimal number contained in
*/
#define UAT_DEC_CB_DEF(basename,field_name,rec_t) \
-static void basename ## _ ## field_name ## _set_cb(void* rec, const char* buf, unsigned len, void* u1 _U_, void* u2 _U_) {\
- ((rec_t*)rec)->field_name = strtol(ep_strndup(buf,len),NULL,10); } \
-static void basename ## _ ## field_name ## _tostr_cb(void* rec, const char** out_ptr, unsigned* out_len, void* u1 _U_, void* u2 _U_) {\
- *out_ptr = ep_strdup_printf("%d",((rec_t*)rec)->field_name); \
- *out_len = strlen(*out_ptr); }
+static void basename ## _ ## field_name ## _set_cb(void* rec, const char* buf, guint len, const void* UNUSED_PARAMETER(u1), const void* UNUSED_PARAMETER(u2)) {\
+ char* tmp_str = g_strndup(buf,len); \
+ ((rec_t*)rec)->field_name = (guint)strtol(tmp_str,NULL,10); \
+ g_free(tmp_str); } \
+static void basename ## _ ## field_name ## _tostr_cb(void* rec, char** out_ptr, unsigned* out_len, const void* UNUSED_PARAMETER(u1), const void* UNUSED_PARAMETER(u2)) {\
+ *out_ptr = g_strdup_printf("%d",((rec_t*)rec)->field_name); \
+ *out_len = (unsigned)strlen(*out_ptr); }
-#define UAT_FLD_DEC(basename,field_name,desc) \
- {#field_name, PT_TXTMOD_STRING,{uat_fld_chk_num_dec,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{0,0,0},0,desc,FLDFILL}
+#define UAT_FLD_DEC(basename,field_name,title,desc) \
+ {#field_name, title, PT_TXTMOD_STRING,{uat_fld_chk_num_dec,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{0,0,0},0,desc,FLDFILL}
+
+#define UAT_FLD_NONE(basename,field_name,title,desc) \
+ {#field_name, title, PT_TXTMOD_NONE,{uat_fld_chk_num_dec,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{0,0,0},0,desc,FLDFILL}
/*
* an hexadecimal number contained in
*/
#define UAT_HEX_CB_DEF(basename,field_name,rec_t) \
-static void basename ## _ ## field_name ## _set_cb(void* rec, const char* buf, unsigned len, void* u1 _U_, void* u2 _U_) {\
- ((rec_t*)rec)->field_name = strtol(ep_strndup(buf,len),NULL,16); } \
-static void basename ## _ ## field_name ## _tostr_cb(void* rec, const char** out_ptr, unsigned* out_len, void* u1 _U_, void* u2 _U_) {\
- *out_ptr = ep_strdup_printf("%x",((rec_t*)rec)->field_name); \
- *out_len = strlen(*out_ptr); }
+static void basename ## _ ## field_name ## _set_cb(void* rec, const char* buf, guint len, const void* UNUSED_PARAMETER(u1), const void* UNUSED_PARAMETER(u2)) {\
+ char* tmp_str = g_strndup(buf,len); \
+ ((rec_t*)rec)->field_name = (guint)strtol(tmp_str,NULL,16); \
+ g_free(tmp_str); } \
+static void basename ## _ ## field_name ## _tostr_cb(void* rec, char** out_ptr, unsigned* out_len, const void* UNUSED_PARAMETER(u1), const void* UNUSED_PARAMETER(u2)) {\
+ *out_ptr = g_strdup_printf("%x",((rec_t*)rec)->field_name); \
+ *out_len = (unsigned)strlen(*out_ptr); }
-#define UAT_FLD_HEX(basename,field_name,desc) \
-{#field_name, PT_TXTMOD_STRING,{uat_fld_chk_num_hex,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{0,0,0},0,desc,FLDFILL}
+#define UAT_FLD_HEX(basename,field_name,title,desc) \
+{#field_name, title, PT_TXTMOD_STRING,{uat_fld_chk_num_hex,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{0,0,0},0,desc,FLDFILL}
+/*
+ * BOOL Macros,
+ * an boolean value contained in
+ */
+#define UAT_BOOL_CB_DEF(basename,field_name,rec_t) \
+static void basename ## _ ## field_name ## _set_cb(void* rec, const char* buf, guint len, const void* UNUSED_PARAMETER(u1), const void* UNUSED_PARAMETER(u2)) {\
+ char* tmp_str = g_strndup(buf,len); \
+ if (g_strcmp0(tmp_str, "TRUE") == 0) \
+ ((rec_t*)rec)->field_name = 1; \
+ else \
+ ((rec_t*)rec)->field_name = 0; \
+ g_free(tmp_str); } \
+static void basename ## _ ## field_name ## _tostr_cb(void* rec, char** out_ptr, unsigned* out_len, const void* UNUSED_PARAMETER(u1), const void* UNUSED_PARAMETER(u2)) {\
+ *out_ptr = g_strdup_printf("%s",((rec_t*)rec)->field_name ? "TRUE" : "FALSE"); \
+ *out_len = (unsigned)strlen(*out_ptr); }
+
+#define UAT_FLD_BOOL(basename,field_name,title,desc) \
+{#field_name, title, PT_TXTMOD_BOOL,{uat_fld_chk_bool,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{0,0,0},0,desc,FLDFILL}
/*
* ENUM macros
* rec_t:
* value
*/
-#define UAT_VS_DEF(basename,field_name,rec_t,default_val,default_str) \
-static void basename ## _ ## field_name ## _set_cb(void* rec, const char* buf, unsigned len, void* vs, void* u2 _U_) {\
+#define UAT_VS_DEF(basename,field_name,rec_t,default_t,default_val,default_str) \
+static void basename ## _ ## field_name ## _set_cb(void* rec, const char* buf, guint len, const void* vs, const void* UNUSED_PARAMETER(u2)) {\
guint i; \
- char* str = ep_strndup(buf,len); \
- const char* cstr; ((rec_t*)rec)->field_name = default_val; \
- for(i=0; ( cstr = ((value_string*)vs)[i].strptr ) ;i++) { \
+ char* str = g_strndup(buf,len); \
+ const char* cstr; \
+ ((rec_t*)rec)->field_name = default_val; \
+ for(i=0; ( cstr = ((const value_string*)vs)[i].strptr ) ;i++) { \
if (g_str_equal(cstr,str)) { \
- ((rec_t*)rec)->field_name = ((value_string*)vs)[i].value; return; } } } \
-static void basename ## _ ## field_name ## _tostr_cb(void* rec, const char** out_ptr, unsigned* out_len, void* vs, void* u2 _U_) {\
+ ((rec_t*)rec)->field_name = (default_t)((const value_string*)vs)[i].value; \
+ g_free(str); \
+ return; \
+ } \
+ } \
+ g_free(str); } \
+static void basename ## _ ## field_name ## _tostr_cb(void* rec, char** out_ptr, unsigned* out_len, const void* vs, const void* UNUSED_PARAMETER(u2)) {\
guint i; \
- *out_ptr = ep_strdup(default_str); *out_len = strlen(default_str);\
- for(i=0;((value_string*)vs)[i].strptr;i++) { \
- if ( ((value_string*)vs)[i].value == ((rec_t*)rec)->field_name ) { \
- *out_ptr = ep_strdup(((value_string*)vs)[i].strptr); \
- *out_len = strlen(*out_ptr); return; } } }
+ for(i=0;((const value_string*)vs)[i].strptr;i++) { \
+ if ( ((const value_string*)vs)[i].value == ((rec_t*)rec)->field_name ) { \
+ *out_ptr = g_strdup(((const value_string*)vs)[i].strptr); \
+ *out_len = (unsigned)strlen(*out_ptr); \
+ return; \
+ } \
+ } \
+ *out_ptr = g_strdup(default_str); \
+ *out_len = (unsigned)strlen(default_str); }
+#define UAT_VS_CSTRING_DEF(basename,field_name,rec_t,default_val,default_str) \
+static void basename ## _ ## field_name ## _set_cb(void* rec, const char* buf, guint len, const void* vs, const void* UNUSED_PARAMETER(u2)) {\
+ guint i; \
+ char* str = g_strndup(buf,len); \
+ const char* cstr; \
+ ((rec_t*)rec)->field_name = default_val; \
+ for(i=0; ( cstr = ((const value_string*)vs)[i].strptr ) ;i++) { \
+ if (g_str_equal(cstr,str)) { \
+ ((rec_t*)rec)->field_name = g_strdup(((const value_string*)vs)[i].strptr); \
+ g_free(str); \
+ return; \
+ } \
+ } \
+ g_free(str);} \
+static void basename ## _ ## field_name ## _tostr_cb(void* rec, char** out_ptr, unsigned* out_len, const void* UNUSED_PARAMETER(vs), const void* UNUSED_PARAMETER(u2)) {\
+ if (((rec_t*)rec)->field_name ) { \
+ *out_ptr = g_strdup((((rec_t*)rec)->field_name)); \
+ *out_len = (unsigned)strlen((((rec_t*)rec)->field_name)); \
+ } else { \
+ *out_ptr = g_strdup(""); *out_len = 0; } }
+
+#define UAT_FLD_VS(basename,field_name,title,enum,desc) \
+ {#field_name, title, PT_TXTMOD_ENUM,{uat_fld_chk_enum,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{&(enum),&(enum),&(enum)},&(enum),desc,FLDFILL}
+
+
+/*
+ * Color Macros,
+ * an boolean value contained in
+ */
+#define UAT_COLOR_CB_DEF(basename,field_name,rec_t) \
+static void basename ## _ ## field_name ## _set_cb(void* rec, const char* buf, guint len, const void* UNUSED_PARAMETER(u1), const void* UNUSED_PARAMETER(u2)) {\
+ char* tmp_str = g_strndup(buf+1,len-1); \
+ ((rec_t*)rec)->field_name = (guint)strtol(tmp_str,NULL,16); \
+ g_free(tmp_str); } \
+static void basename ## _ ## field_name ## _tostr_cb(void* rec, char** out_ptr, unsigned* out_len, const void* UNUSED_PARAMETER(u1), const void* UNUSED_PARAMETER(u2)) {\
+ *out_ptr = g_strdup_printf("#%06X",((rec_t*)rec)->field_name); \
+ *out_len = (unsigned)strlen(*out_ptr); }
-#define UAT_FLD_VS(basename,field_name,enum,desc) \
- {#field_name, PT_TXTMOD_ENUM,{uat_fld_chk_enum,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{&(enum),&(enum),&(enum)},&(enum),desc,FLDFILL}
+#define UAT_FLD_COLOR(basename,field_name,title,desc) \
+{#field_name, title, PT_TXTMOD_COLOR,{uat_fld_chk_color,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{0,0,0},0,desc,FLDFILL}
/*
*/
#define UAT_PROTO_DEF(basename, field_name, dissector_field, name_field, rec_t) \
-static void basename ## _ ## field_name ## _set_cb(void* rec, const char* buf, unsigned len, void* u1 _U_, void* u2 _U_) {\
+static void basename ## _ ## field_name ## _set_cb(void* rec, const char* buf, guint len, const void* UNUSED_PARAMETER(u1), const void* UNUSED_PARAMETER(u2)) {\
if (len) { \
- ((rec_t*)rec)->name_field = ep_strndup(buf,len); g_strdown(((rec_t*)rec)->name_field ); g_strchug(((rec_t*)rec)->name_field); \
+ gchar *tmp = g_strndup(buf,len); \
+ ((rec_t*)rec)->name_field = g_ascii_strdown(tmp, -1); \
+ g_free(tmp); \
+ g_strchug(((rec_t*)rec)->name_field); \
((rec_t*)rec)->dissector_field = find_dissector(((rec_t*)rec)->name_field); \
} else { \
((rec_t*)rec)->dissector_field = find_dissector("data"); \
((rec_t*)rec)->name_field = NULL; \
} } \
-static void basename ## _ ## field_name ## _tostr_cb(void* rec, const char** out_ptr, unsigned* out_len, void* u1 _U_, void* u2 _U_) {\
+static void basename ## _ ## field_name ## _tostr_cb(void* rec, char** out_ptr, unsigned* out_len, const void* UNUSED_PARAMETER(u1), const void* UNUSED_PARAMETER(u2)) {\
if ( ((rec_t*)rec)->name_field ) { \
- *out_ptr = (((rec_t*)rec)->name_field); \
- *out_len = strlen(*out_ptr); \
+ *out_ptr = g_strdup((((rec_t*)rec)->name_field)); \
+ *out_len = (unsigned)strlen(*out_ptr); \
} else { \
- *out_ptr = ""; *out_len = 0; } }
+ *out_ptr = g_strdup(""); *out_len = 0; } }
-#define UAT_FLD_PROTO(basename,field_name,desc) \
- {#field_name, PT_TXTMOD_STRING,{uat_fld_chk_proto,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{0,0,0},0,desc,FLDFILL}
+#define UAT_FLD_PROTO(basename,field_name,title,desc) \
+ {#field_name, title, PT_TXTMOD_STRING,{uat_fld_chk_proto,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{0,0,0},0,desc,FLDFILL}
/*
* RANGE macros
*/
#define UAT_RANGE_CB_DEF(basename,field_name,rec_t) \
-static void basename ## _ ## field_name ## _set_cb(void* rec, const char* buf, unsigned len, void* u1 _U_, void* u2) {\
- char* rng = ep_strndup(buf,len);\
- range_convert_str(&(((rec_t*)rec)->field_name), rng,GPOINTER_TO_UINT(u2)); \
+static void basename ## _ ## field_name ## _set_cb(void* rec, const char* buf, guint len, const void* UNUSED_PARAMETER(u1), const void* u2) {\
+ char* rng = g_strndup(buf,len);\
+ range_convert_str(NULL, &(((rec_t*)rec)->field_name), rng,GPOINTER_TO_UINT(u2)); \
+ g_free(rng); \
} \
-static void basename ## _ ## field_name ## _tostr_cb(void* rec, const char** out_ptr, unsigned* out_len, void* u1 _U_, void* u2 _U_) {\
+static void basename ## _ ## field_name ## _tostr_cb(void* rec, char** out_ptr, unsigned* out_len, const void* UNUSED_PARAMETER(u1), const void* UNUSED_PARAMETER(u2)) {\
if ( ((rec_t*)rec)->field_name ) { \
- *out_ptr = range_convert_range(((rec_t*)rec)->field_name); *out_len = strlen(*out_ptr); \
+ *out_ptr = range_convert_range(NULL, ((rec_t*)rec)->field_name); \
+ *out_len = (unsigned)strlen(*out_ptr); \
} else { \
- *out_ptr = ""; *out_len = 0; } }
+ *out_ptr = g_strdup(""); *out_len = 0; } }
-#define UAT_FLD_RANGE(basename,field_name,max,desc) \
- {#field_name, PT_TXTMOD_STRING,{uat_fld_chk_range,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},\
- {GUINT_TO_POINTER(max),GUINT_TO_POINTER(max),GUINT_TO_POINTER(max)},0,desc,FLDFILL}
+#define UAT_FLD_RANGE(basename,field_name,title,max,desc) \
+ {#field_name, title, PT_TXTMOD_STRING,{uat_fld_chk_range,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},\
+ {0,0,0},GUINT_TO_POINTER(max),desc,FLDFILL}
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
-
-
-
-#endif
-
+#endif /* __UAT_H__ */
git.samba.org / metze / wireshark / wip.git / blobdiff