epan/uat.h

   1 /*
   2  *  uat.h
   3  *
   4  *  $Id$
   5  *
   6  *  User Accessible Tables
   7  *  Mantain an array of user accessible data strucures
   8  *
   9  * (c) 2007, Luis E. Garcia Ontanon <luis.ontanon@gmail.com>
  10  *
  11  * Wireshark - Network traffic analyzer
  12  * By Gerald Combs <gerald@wireshark.org>
  13  * Copyright 2001 Gerald Combs
  14  *
  15  * This program is free software; you can redistribute it and/or
  16  * modify it under the terms of the GNU General Public License
  17  * as published by the Free Software Foundation; either version 2
  18  * of the License, or (at your option) any later version.
  19  *
  20  * This program is distributed in the hope that it will be useful,
  21  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  22  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  23  * GNU General Public License for more details.
  24  *
  25  * You should have received a copy of the GNU General Public License
  26  * along with this program; if not, write to the Free Software
  27  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  28  */
  29
  30 #ifndef _UAT_H_
  31 #define _UAT_H_
  32
  33 /*
  34  * uat mantains a dynamically allocated table accessible to the user
  35  * via a file and/or gui tables.
  36  *
  37  * the file is located either in userdir(when first read or when writen) or
  38  * in datadir for defaults (read only , it will be always written to userdir).
  39  *
  40  * the behaviour of the table is controlled by a series of callbacks
  41  * the caller must provide.
  42  *
  43  * BEWARE that the user can change an uat at (almost) any time,
  44  * That is pointers to records in an uat are valid only during the call
  45  * to the function that obtains them (do not store them).
  46  *
  47  * UATs are meant for short tables of user data (passwords and such) there's
  48  * no quick access, you must iterate through them each time to fetch the record
  49  * you are looking for. Use uat_dup() or uat_se_dup() if necessary.
  50  *
  51  * Only users via gui or editing the file can add/remove records your code cannot.
  52  */
  53
  54 /* obscure data type to handle an uat */
  55 typedef struct _uat_t uat_t;
  56 /********************************************
  57  * Callbacks:
  58  * these instruct uat on how to deal with user info and data in records
  59  ********************************************/
  60
  61 /********
  62  * Callbacks for the entire table (these deal with entire records)
  63  ********/
  64
  65 /*
  66  * Copy CB
  67  * used to copy a record
  68  * optional, memcpy will be used if not given
  69  * copy(dest,orig,len)
  70  */
  71 typedef void* (*uat_copy_cb_t)(void*, const void*, unsigned);
  72
  73 /*
  74  *
  75  * Free CB
  76  *
  77  * destroy a record's child data
  78  * (do not free the container, it will be handled by uat)
  79  * it is optional, no child data will be freed if no present
  80  * free(record)
  81  */
  82 typedef void (*uat_free_cb_t)(void*);
  83
  84 /*
  85  * Update CB
  86  *
  87  * to be called after all record fields has been updated
  88  * optional, record will be updated always if not given
  89  * update(record,&error)
  90  */
  91 typedef void (*uat_update_cb_t)(void* , char** );
  92
  93
  94 /*******
  95  * Callbacks for single fields (these deal with single values)
  96  * the caller should provide one of these for every field!
  97  ********/
  98
  99 /*
 100  * given an input string (ptr, len) checks if the value is OK for a field in the record.
 101  * it will return TRUE if OK or else
 102  * it will return FALSE and may set *error to inform the user on what's
 103  * wrong with the given input
 104  * optional, if not given any input is considered OK and the set cb will be called
 105  * chk(record, ptr, len, chk_data, fld_data, &error)
 106  */
 107 typedef gboolean (*uat_fld_chk_cb_t)(void*, const char*, unsigned, void*, void*, char**);
 108
 109 /*
 110  * Set Field CB
 111  *
 112  * given an input string (ptr, len) sets the value of a field in the record,
 113  * it will return TRUE if OK or else
 114  * it will return FALSE and may set *error to inform the user on what's
 115  * wrong with the given input
 116  * it is mandatory
 117  * set(record, ptr, len, set_data, fld_data)
 118  */
 119 typedef void (*uat_fld_set_cb_t)(void*, const char*, unsigned, void*, void*);
 120
 121 /*
 122  * given a record returns a string representation of the field
 123  * mandatory
 124  * tostr(record, &out_ptr, &out_len, tostr_data, fld_data)
 125  */
 126 typedef void (*uat_fld_tostr_cb_t)(void*, char**, unsigned*, void*, void*);
 127
 128 /***********
 129  * Text Mode
 130  *
 131  * used for file and dialog representation of fileds in columns,
 132  * when the file is read it modifies the way the value is passed back to the fld_set_cb
 133  * (see definition bellow for description)
 134  ***********/
 135
 136 typedef enum _uat_text_mode_t {
 137         PT_TXTMOD_NONE,
 138         /* not used */
 139
 140         PT_TXTMOD_STRING,
 141         /*
 142          file:
 143                  reads:
 144                          ,"\x20\x00\x30", as " \00",3
 145                          ,"", as "",0
 146                          ,, as NULL,0
 147                  writes:
 148                          ,"\x20\x30\x00\x20", for " 0\0 ",4
 149                          ,"", for *, 0
 150                          ,, for NULL, *
 151          dialog:
 152                  accepts \x?? and other escapes
 153                  gets "",0 on empty string
 154          */
 155         PT_TXTMOD_HEXBYTES,
 156         /*
 157          file:
 158                  reads:
 159                          ,A1b2C3d4, as "\001\002\003\004",4
 160                          ,, as NULL,0
 161                  writes:
 162                          ,, on NULL, *
 163                          ,a1b2c3d4, on "\001\002\003\004",4
 164          dialog:
 165                  "a1b2c3d4" as "\001\002\003\004",4
 166                  "a1 b2:c3d4" as "\001\002\003\004",4
 167                  "" as NULL,0
 168                  "invalid" as NULL,3
 169                  "a1b" as NULL, 1
 170          */
 171         PT_TXTMOD_ENUM
 172 } uat_text_mode_t;
 173
 174 /*
 175  * Fields
 176  *
 177  *
 178  */
 179 typedef struct _uat_field_t {
 180         const char* name;
 181         uat_text_mode_t mode;
 182
 183         struct {
 184                 uat_fld_chk_cb_t chk;
 185                 uat_fld_set_cb_t set;
 186                 uat_fld_tostr_cb_t tostr;
 187         } cb;
 188
 189         struct {
 190                 void* chk;
 191                 void* set;
 192                 void* tostr;
 193         } cbdata;
 194
 195         void* fld_data;
 196
 197         struct _fld_data_t* priv;
 198 } uat_field_t;
 199
 200 #define FLDFILL NULL
 201 #define UAT_END_FIELDS {0,PT_TXTMOD_NONE,{0,0,0},{0,0,0},0,FLDFILL}
 202
 203
 204
 205 /*
 206  * uat_new()
 207  *
 208  * creates a new uat
 209  *
 210  * name: the name of the table
 211  *
 212  * data_ptr: a pointer to a null terminated array of pointers to the data
 213  *
 214  * default_data: a pinter to a struct containing default values
 215  *
 216  * size: the size of the structure
 217  *
 218  * filename: the filename to be used (either in userdir or datadir)
 219  *
 220  * copy_cb: a function that copies the data in the struct
 221  *
 222  * update_cb: will be called when a record is updated
 223  *
 224  * free_cb: will be called to destroy a struct in the dataset
 225  *
 226  *
 227  */
 228 uat_t* uat_new(const char* name,
 229                            size_t size,
 230                            char* filename,
 231                            void** data_ptr,
 232                            guint* num_items,
 233                            char* help,
 234                            uat_copy_cb_t copy_cb,
 235                            uat_update_cb_t update_cb,
 236                            uat_free_cb_t free_cb,
 237                            uat_field_t* flds_array);
 238
 239
 240 /*
 241  * uat_dup()
 242  * uat_se_dup()
 243  * make a reliable copy of an uat for internal use,
 244  * so that pointers to records can be kept through calls.
 245  * return NULL on zero len.
 246  */
 247 void* uat_dup(uat_t*, guint* len_p); /* to be freed */
 248 void* uat_se_dup(uat_t*, guint* len_p);
 249
 250 /*
 251  * Some common uat_fld_chk_cbs
 252  */
 253 gboolean uat_fld_chk_str(void*, const char*, unsigned, void*,void*, char** err);
 254 gboolean uat_fld_chk_proto(void*, const char*, unsigned, void*,void*, char** err);
 255 gboolean uat_fld_chk_num_dec(void*, const char*, unsigned, void*, void*, char** err);
 256 gboolean uat_fld_chk_num_hex(void*, const char*, unsigned, void*, void*, char** err);
 257 gboolean uat_fld_chk_enum(void*, const char*, unsigned, void*, void*, char**);
 258
 259 #define CHK_STR_IS_DECL(what) \
 260 gboolean uat_fld_chk_str_ ## what (void*, const char*, unsigned, void*, void*, char**)
 261
 262 /* Some strings entirely made of ... already declared */
 263 CHK_STR_IS_DECL(isprint);
 264 CHK_STR_IS_DECL(isalpha);
 265 CHK_STR_IS_DECL(isalnum);
 266 CHK_STR_IS_DECL(isdigit);
 267 CHK_STR_IS_DECL(isxdigit);
 268
 269 #define CHK_STR_IS_DEF(what) \
 270 gboolean uat_fld_chk_str_ ## what (void* u1 _U_, const char* strptr, unsigned len, void* u2 _U_, void* u3 _U_, char** err) { \
 271         guint i; for (i=0;i<len;i++) { \
 272                 char c = strptr[i]; \
 273                         if (! what(c)) { \
 274                                 *err = ep_strdup_printf("invalid char pos=%d value=%.2x",i,c); return FALSE;  } } \
 275                 *err = NULL; return TRUE; }
 276
 277
 278 /*
 279  * Macros
 280  *   to define basic uat_fld_set_cbs, uat_fld_tostr_cbs
 281  *   for those elements in uat_field_t array
 282  */
 283
 284 /*
 285  * CSTRING macros,
 286  *    a simple c-string contained in (((rec_t*)rec)->(field_name))
 287  */
 288 #define UAT_CSTRING_CB_DEF(basename,field_name,rec_t) \
 289 static void basename ## _ ## field_name ## _set_cb(void* rec, const char* buf, unsigned len, void* u1 _U_, void* u2 _U_) {\
 290         if ((((rec_t*)rec)->field_name)) g_free((((rec_t*)rec)->field_name)); \
 291         (((rec_t*)rec)->field_name) = g_strndup(buf,len); } \
 292 static void basename ## _ ## field_name ## _tostr_cb(void* rec, char** out_ptr, unsigned* out_len, void* u1 _U_, void* u2 _U_) {\
 293                 if (((rec_t*)rec)->field_name ) { \
 294                         *out_ptr = (((rec_t*)rec)->field_name); *out_len = strlen((((rec_t*)rec)->field_name)); \
 295                 } else { \
 296                         *out_ptr = ""; *out_len = 0; } }
 297
 298 #define UAT_FLD_CSTRING(basename,field_name) \
 299         {#field_name, PT_TXTMOD_STRING,{uat_fld_chk_str,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{NULL,NULL,NULL},NULL,FLDFILL}
 300
 301 #define UAT_FLD_CSTRING_ISPRINT(basename,field_name) \
 302         {#field_name, PT_TXTMOD_STRING,{uat_fld_chk_str_isprint,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{NULL,NULL,NULL},NULL,FLDFILL}
 303
 304 #define UAT_FLD_CSTRING_OTHER(basename,field_name,chk) \
 305         {#field_name, PT_TXTMOD_STRING,{ chk ,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{NULL,NULL,NULL},NULL,FLDFILL}
 306
 307 /*
 308  * LSTRING MACROS
 309  */
 310 #define UAT_LSTRING_CB_DEF(basename,field_name,rec_t,ptr_element,len_element) \
 311 static void basename ## _ ## field_name ## _set_cb(void* rec, const char* buf, unsigned len, void* u1 _U_, void* u2 _U_) {\
 312         if ((((rec_t*)rec)->ptr_element)) g_free((((rec_t*)rec)->ptr_element)); \
 313         (((rec_t*)rec)->ptr_element) = g_strndup(buf,len); \
 314         (((rec_t*)rec)->len_element) = len; } \
 315 static void basename ## _ ## field_name ## _tostr_cb(void* rec, char** out_ptr, unsigned* out_len, void* u1 _U_, void* u2 _U_) {\
 316         if (((rec_t*)rec)->ptr_element ) { \
 317                 *out_ptr = (((rec_t*)rec)->ptr_element); *out_len = (((rec_t*)rec)->len_element); \
 318         } else { \
 319                 *out_ptr = ""; *out_len = 0; } }
 320
 321 #define UAT_FLD_LSTRING(basename,field_name) \
 322 {#field_name, PT_TXTMOD_STRING,{NULL,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{NULL,NULL,NULL},NULL,FLDFILL}
 323
 324
 325 /*
 326  * BUFFER macros,
 327  *    a buffer_ptr contained in (((rec_t*)rec)->(field_name))
 328  *    and its len in (((rec_t*)rec)->(len_name))
 329  *  XXX: UNTESTED
 330  */
 331 #define UAT_BUFFER_CB_DEF(basename,field_name,rec_t,ptr_element,len_element) \
 332 static void basename ## _ ## field_name ## _set_cb(void* rec, const char* buf, unsigned len, void* u1 _U_, void* u2 _U_) {\
 333                 if ((((rec_t*)rec)->ptr_element) ) g_free((((rec_t*)rec)->ptr_element)); \
 334                         (((rec_t*)rec)->ptr_element) = len ? g_memdup(buf,len) : NULL; \
 335                         (((rec_t*)rec)->len_element) = len; } \
 336 static void basename ## _ ## field_name ## _tostr_cb(void* rec, char** out_ptr, unsigned* out_len, void* u1 _U_, void* u2 _U_) {\
 337         *out_ptr = ((rec_t*)rec)->ptr_element ? ep_memdup(((rec_t*)rec)->ptr_element,((rec_t*)rec)->len_element) : ""; \
 338         *out_len = ((rec_t*)rec)->len_element; }
 339
 340 #define UAT_FLD_BUFFER(basename,field_name) \
 341         {#field_name, PT_TXTMOD_HEXBYTES,{NULL,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{NULL,NULL,NULL},NULL,FLDFILL}
 342
 343
 344 /*
 345  * DEC Macros,
 346  *   a decimal number contained in
 347  */
 348 #define UAT_DEC_CB_DEF(basename,field_name,rec_t) \
 349 static void basename ## _ ## field_name ## _set_cb(void* rec, const char* buf, unsigned len, void* u1 _U_, void* u2 _U_) {\
 350         ((rec_t*)rec)->(field_name) = strtol(buf,end,10); } \
 351 static void basename ## _ ## field_name ## _tostr_cb(void* rec, char** out_ptr, unsigned* out_len, void* u1 _U_, void* u2 _U_) {\
 352         *out_ptr = ep_strdup_printf("%d",((rec_t*)rec)->(field_name)); \
 353         *out_len = strlen(*out_ptr); }
 354
 355 #define UAT_FLD_DEC(basename,field_name) \
 356         {#field_name, PT_TXTMOD_STRING,{uat_fld_chk_num_dec,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{NULL,NULL,NULL},NULL,FLDFILL}
 357
 358
 359 /*
 360  * HEX Macros,
 361  *   an hexadecimal number contained in
 362  */
 363 #define UAT_HEX_CB_DEF(basename,field_name,rec_t) \
 364 static void basename ## _ ## field_name ## _set_cb(void* rec, const char* buf, unsigned len, void* u1 _U_, void* u2 _U_) {\
 365         ((rec_t*)rec)->(field_name) = strtol(buf,end,16); } \
 366 static void basename ## _ ## field_name ## _tostr_cb(void* rec, char** out_ptr, unsigned* out_len, void* u1 _U_, void* u2 _U_) {\
 367         *out_ptr = ep_strdup_printf("%x",((rec_t*)rec)->(field_name)); \
 368         *out_len = strlen(*out_ptr); }
 369
 370 #define UAT_FLD_HEX(basename,field_name) \
 371 {#field_name, PT_TXTMOD_STRING,{uat_fld_chk_num_hex,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{NULL,NULL,NULL},NULL,FLDFILL}
 372
 373
 374 /*
 375  * ENUM macros
 376  *  enum_t: name = ((enum_t*)ptr)->strptr
 377  *          value = ((enum_t*)ptr)->value
 378  *  rec_t:
 379  *        value
 380  */
 381 #define UAT_VS_DEF(basename,field_name,rec_t,default_val,default_str) \
 382 static void basename ## _ ## field_name ## _set_cb(void* rec, const char* buf, unsigned len, void* vs, void* u2 _U_) {\
 383         guint i; ((rec_t*)rec)->field_name = default_val; \
 384         char* str = ep_strndup(buf,len); \
 385         char* cstr;\
 386         for(i=0; ( cstr = ((value_string*)vs)[i].strptr ) ;i++) { \
 387                 if (g_str_equal(cstr,str)) { \
 388                         ((rec_t*)rec)->field_name = ((value_string*)vs)[i].value; return; } } } \
 389 static void basename ## _ ## field_name ## _tostr_cb(void* rec, char** out_ptr, unsigned* out_len, void* vs, void* u2 _U_) {\
 390         guint i; \
 391         *out_ptr = default_str; *out_len = strlen(default_str);\
 392         for(i=0;((value_string*)vs)[i].strptr;i++) { \
 393                 if ( ((value_string*)vs)[i].value == ((rec_t*)rec)->field_name ) { \
 394                         *out_ptr = ep_strdup(((value_string*)vs)[i].strptr); \
 395                         *out_len = strlen(*out_ptr); return; } } }
 396
 397
 398 #define UAT_FLD_VS(basename,field_name,enum) \
 399         {#field_name, PT_TXTMOD_ENUM,{uat_fld_chk_enum,basename ## _ ## field_name ## _set_cb,basename ## _ ## field_name ## _tostr_cb},{&(enum),&(enum),&(enum)},&(enum),FLDFILL}
 400
 401
 402
 403
 404
 405
 406
 407 #endif
 408