epan/proto.h

   1 /* proto.h
   2  * Definitions for protocol display
   3  *
   4  * $Id: proto.h,v 1.58 2004/04/30 06:56:15 ulfl Exp $
   5  *
   6  * Ethereal - Network traffic analyzer
   7  * By Gerald Combs <gerald@ethereal.com>
   8  * Copyright 1998 Gerald Combs
   9  *
  10  * This program is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU General Public License
  12  * as published by the Free Software Foundation; either version 2
  13  * of the License, or (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  23  */
  24
  25 #ifndef __PROTO_H__
  26 #define __PROTO_H__
  27
  28 #ifdef HAVE_STDARG_H
  29 # include <stdarg.h>
  30 #else
  31 # include <varargs.h>
  32 #endif
  33
  34 #include <glib.h>
  35
  36 #include "ipv4.h"
  37 #include "nstime.h"
  38 #include "tvbuff.h"
  39 #include "ftypes/ftypes.h"
  40
  41 /* The header-field index for the special text pseudo-field */
  42 extern int hf_text_only;
  43
  44 struct _value_string;
  45
  46 #define ITEM_LABEL_LENGTH       240
  47
  48 /* In order to make a const value_string[] look like a value_string*, I
  49  * need this macro */
  50 #define VALS(x) (const struct _value_string*)(x)
  51
  52 /* ... and similarly, */
  53 #define TFS(x)  (const struct true_false_string*)(x)
  54
  55 struct _protocol;
  56
  57 typedef struct _protocol protocol_t;
  58
  59 /* check protocol activation */
  60 #define CHECK_DISPLAY_AS_X(x_handle,index, tvb, pinfo, tree) {  \
  61         if (!proto_is_protocol_enabled(find_protocol_by_id(index))) {   \
  62                 call_dissector(x_handle,tvb, pinfo, tree);              \
  63                 return;                                                 \
  64         }                                                               \
  65   }
  66
  67 enum {
  68         BASE_NONE,
  69         BASE_DEC,
  70         BASE_HEX,
  71         BASE_OCT
  72 };
  73
  74 typedef struct _header_field_info header_field_info;
  75
  76 /* information describing a header field */
  77 struct _header_field_info {
  78         /* ---------- set by dissector --------- */
  79         char                            *name;
  80         char                            *abbrev;
  81         enum ftenum                     type;
  82         int                             display;        /* for integers only, so far. Base */
  83         const void                      *strings;       /* val_string or true_false_string */
  84         guint32                         bitmask;
  85         char                            *blurb;         /* Brief description of field. */
  86
  87         /* ---------- set by proto routines --------- */
  88         int                             id;             /* Field ID */
  89         int                             parent;         /* parent protocol */
  90         int                             bitshift;       /* bits to shift */
  91         header_field_info               *same_name_next; /* Link to next hfinfo with same abbrev*/
  92         header_field_info               *same_name_prev; /* Link to previous hfinfo with same abbrev*/
  93 };
  94
  95 /*
  96  * HFILL initializes all the "set by proto routines" fields in a
  97  * "header_field_info"; if new fields are added or removed, it should
  98  * be changed as necessary.
  99  */
 100 #define HFILL 0, 0, 0, NULL, NULL
 101
 102 /* Used when registering many fields at once */
 103 typedef struct hf_register_info {
 104         int                     *p_id;  /* pointer to int; written to by register() function */
 105         header_field_info       hfinfo;
 106 } hf_register_info;
 107
 108
 109 typedef struct _item_label_t {
 110         char representation[ITEM_LABEL_LENGTH];
 111 } item_label_t;
 112
 113 /* Contains the field information for the proto_item. */
 114 typedef struct field_info {
 115         header_field_info               *hfinfo;
 116         gint                            start;
 117         gint                            length;
 118         gint                            tree_type; /* ETT_* */
 119         item_label_t                    *rep; /* string for GUI tree */
 120         int                             visible;
 121         tvbuff_t                        *ds_tvb;  /* data source tvbuff */
 122         fvalue_t                        value;
 123 } field_info;
 124
 125 /* One of these exists for the entire protocol tree. Each proto_node
 126  * in the protocol tree points to the same copy. */
 127 typedef struct {
 128     GHashTable  *interesting_hfids;
 129     gboolean    visible;
 130 } tree_data_t;
 131
 132 /* Each proto_tree, proto_item is one of these. */
 133 typedef struct _proto_node {
 134         struct _proto_node *first_child;
 135         struct _proto_node *last_child;
 136         struct _proto_node *next;
 137         struct _proto_node *parent;
 138         field_info  *finfo;
 139         tree_data_t *tree_data;
 140 } proto_node;
 141
 142 typedef proto_node proto_tree;
 143 typedef proto_node proto_item;
 144
 145 typedef void (*proto_tree_foreach_func)(proto_node *, gpointer);
 146
 147 extern void proto_tree_children_foreach(proto_tree *tree,
 148     proto_tree_foreach_func func, gpointer data);
 149
 150 /* Retrieve the field_info from a proto_item */
 151 #define PITEM_FINFO(t)  ((t)->finfo)
 152
 153 /* Retrieve the tree_data_t from a proto_tree */
 154 #define PTREE_DATA(t)   ((t)->tree_data)
 155
 156 /* Sets up memory used by proto routines. Called at program startup */
 157 extern void proto_init(const char *plugin_dir,
 158     void (register_all_protocols)(void), void (register_all_handoffs)(void));
 159
 160 /* Frees memory used by proto routines. Called at program shutdown */
 161 extern void proto_cleanup(void);
 162
 163 /* Set text of proto_item after having already been created. */
 164 #if __GNUC__ >= 2
 165 extern void proto_item_set_text(proto_item *ti, const char *format, ...)
 166         __attribute__((format (printf, 2, 3)));
 167 #else
 168 extern void proto_item_set_text(proto_item *ti, const char *format, ...);
 169 #endif
 170
 171 /* Append to text of proto_item after having already been created. */
 172 #if __GNUC__ >= 2
 173 extern void proto_item_append_text(proto_item *ti, const char *format, ...)
 174         __attribute__((format (printf, 2, 3)));
 175 #else
 176 extern void proto_item_append_text(proto_item *ti, const char *format, ...);
 177 #endif
 178
 179 /* Set length of proto_item after having already been created. */
 180 extern void proto_item_set_len(proto_item *ti, gint length);
 181
 182 /*
 183  * Sets the length of the item based on its start and on the specified
 184  * offset, which is the offset past the end of the item; as the start
 185  * in the item is relative to the beginning of the data source tvbuff,
 186  * we need to pass in a tvbuff - the end offset is relative to the beginning
 187  * of that tvbuff.
 188  */
 189 extern void proto_item_set_end(proto_item *pi, tvbuff_t *tvb, gint end);
 190
 191 /* Get length of proto_item. Useful after using proto_tree_add_item()
 192  * to add a variable-length field (e.g., FT_NSTRING_UINT8) */
 193 extern int proto_item_get_len(proto_item *ti);
 194
 195 /* Creates new proto_tree root */
 196 extern proto_tree* proto_tree_create_root(void);
 197
 198 /* Mark a field/protocol ID as "interesting". */
 199 extern void
 200 proto_tree_prime_hfid(proto_tree *tree, int hfid);
 201
 202 /* Clear memory for entry proto_tree. Clears proto_tree struct also. */
 203 extern void proto_tree_free(proto_tree *tree);
 204
 205 /* Create a subtree under an existing item; returns tree pointer */
 206 extern proto_tree* proto_item_add_subtree(proto_item *ti, gint idx);
 207
 208 /* Get a subtree under an item; returns tree pointer */
 209 extern proto_tree* proto_item_get_subtree(proto_item *ti);
 210
 211 /* Get a parent item; returns item pointer */
 212 extern proto_item* proto_item_get_parent(proto_item *ti);
 213
 214 /* Get Nth generation parent item; returns item pointer */
 215 extern proto_item* proto_item_get_parent_nth(proto_item *ti, int gen);
 216
 217 /* Get a parent item of subtree; returns item pointer */
 218 extern proto_item* proto_tree_get_parent(proto_tree *tree);
 219
 220 extern int
 221 proto_register_protocol(char *name, char *short_name, char *filter_name);
 222
 223 extern void
 224 proto_register_field_array(int parent, hf_register_info *hf, int num_records);
 225
 226 extern void
 227 proto_register_subtree_array(gint **indices, int num_indices);
 228
 229 /* Add an item to a proto_tree, using the text label registered to that item;
 230    the item is extracted from the tvbuff handed to it. */
 231 extern proto_item *
 232 proto_tree_add_item(proto_tree *tree, int hfindex, tvbuff_t *tvb,
 233     gint start, gint length, gboolean little_endian);
 234
 235 extern proto_item *
 236 proto_tree_add_item_hidden(proto_tree *tree, int hfindex, tvbuff_t *tvb,
 237     gint start, gint length, gboolean little_endian);
 238
 239 /* Add a FT_NONE to a proto_tree */
 240 #if __GNUC__ >= 2
 241 extern proto_item *
 242 proto_tree_add_none_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 243         gint length, const char *format, ...)
 244         __attribute__((format (printf, 6, 7)));
 245 #else
 246 extern proto_item *
 247 proto_tree_add_none_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 248         gint length, const char *format, ...);
 249 #endif
 250
 251 /* Add a FT_PROTOCOL to a proto_tree */
 252 #if __GNUC__ >= 2
 253 extern proto_item *
 254 proto_tree_add_protocol_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 255         gint length, const char *format, ...)
 256         __attribute__((format (printf, 6, 7)));
 257 #else
 258 extern proto_item *
 259 proto_tree_add_protocol_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 260         gint length, const char *format, ...);
 261 #endif
 262
 263 /* Add a FT_BYTES to a proto_tree */
 264 extern proto_item *
 265 proto_tree_add_bytes(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 266         gint length, const guint8* start_ptr);
 267
 268 extern proto_item *
 269 proto_tree_add_bytes_hidden(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 270         gint length, const guint8* start_ptr);
 271
 272 #if __GNUC__ >= 2
 273 extern proto_item *
 274 proto_tree_add_bytes_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 275         gint length, const guint8* start_ptr, const char *format, ...)
 276         __attribute__((format (printf, 7, 8)));
 277 #else
 278 extern proto_item *
 279 proto_tree_add_bytes_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 280         gint length, const guint8* start_ptr, const char *format, ...);
 281 #endif
 282
 283 /* Add a FT_*TIME to a proto_tree */
 284 extern proto_item *
 285 proto_tree_add_time(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 286         gint length, nstime_t* value_ptr);
 287
 288 extern proto_item *
 289 proto_tree_add_time_hidden(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 290         gint length, nstime_t* value_ptr);
 291
 292 #if __GNUC__ >= 2
 293 extern proto_item *
 294 proto_tree_add_time_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 295         gint length, nstime_t* value_ptr, const char *format, ...)
 296         __attribute__((format (printf, 7, 8)));
 297 #else
 298 extern proto_item *
 299 proto_tree_add_time_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 300         gint length, nstime_t* value_ptr, const char *format, ...);
 301 #endif
 302
 303 /* Add a FT_IPXNET to a proto_tree */
 304 extern proto_item *
 305 proto_tree_add_ipxnet(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 306         gint length, guint32 value);
 307
 308 extern proto_item *
 309 proto_tree_add_ipxnet_hidden(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 310         gint length, guint32 value);
 311
 312 #if __GNUC__ >= 2
 313 extern proto_item *
 314 proto_tree_add_ipxnet_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 315         gint length, guint32 value, const char *format, ...)
 316         __attribute__((format (printf, 7, 8)));
 317 #else
 318 extern proto_item *
 319 proto_tree_add_ipxnet_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 320         gint length, guint32 value, const char *format, ...);
 321 #endif
 322
 323 /* Add a FT_IPv4 to a proto_tree */
 324 extern proto_item *
 325 proto_tree_add_ipv4(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 326         gint length, guint32 value);
 327
 328 extern proto_item *
 329 proto_tree_add_ipv4_hidden(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 330         gint length, guint32 value);
 331
 332 #if __GNUC__ >= 2
 333 extern proto_item *
 334 proto_tree_add_ipv4_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 335         gint length, guint32 value, const char *format, ...)
 336         __attribute__((format (printf, 7, 8)));
 337 #else
 338 extern proto_item *
 339 proto_tree_add_ipv4_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 340         gint length, guint32 value, const char *format, ...);
 341 #endif
 342
 343 /* Add a FT_IPv6 to a proto_tree */
 344 extern proto_item *
 345 proto_tree_add_ipv6(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 346         gint length, const guint8* value_ptr);
 347
 348 extern proto_item *
 349 proto_tree_add_ipv6_hidden(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 350         gint length, const guint8* value_ptr);
 351
 352 #if __GNUC__ >= 2
 353 extern proto_item *
 354 proto_tree_add_ipv6_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 355         gint length, const guint8* value_ptr, const char *format, ...)
 356         __attribute__((format (printf, 7, 8)));
 357 #else
 358 extern proto_item *
 359 proto_tree_add_ipv6_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 360         gint length, const guint8* value_ptr, const char *format, ...);
 361 #endif
 362
 363 /* Add a FT_ETHER to a proto_tree */
 364 extern proto_item *
 365 proto_tree_add_ether(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 366         gint length, const guint8* value);
 367
 368 extern proto_item *
 369 proto_tree_add_ether_hidden(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 370         gint length, const guint8* value);
 371
 372 #if __GNUC__ >= 2
 373 extern proto_item *
 374 proto_tree_add_ether_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 375         gint length, const guint8* value, const char *format, ...)
 376         __attribute__((format (printf, 7, 8)));
 377 #else
 378 extern proto_item *
 379 proto_tree_add_ether_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 380         gint length, const guint8* value, const char *format, ...);
 381 #endif
 382
 383 /* Add a FT_STRING to a proto_tree */
 384 extern proto_item *
 385 proto_tree_add_string(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 386         gint length, const char* value);
 387
 388 extern proto_item *
 389 proto_tree_add_string_hidden(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 390         gint length, const char* value);
 391
 392 #if __GNUC__ >= 2
 393 extern proto_item *
 394 proto_tree_add_string_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 395         gint length, const char* value, const char *format, ...)
 396         __attribute__((format (printf, 7, 8)));
 397 #else
 398 extern proto_item *
 399 proto_tree_add_string_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 400         gint length, const char* value, const char *format, ...);
 401 #endif
 402
 403 extern void
 404 proto_item_append_string(proto_item *pi, const char *str);
 405
 406 /* Add a FT_BOOLEAN to a proto_tree */
 407 extern proto_item *
 408 proto_tree_add_boolean(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 409         gint length, guint32 value);
 410
 411 extern proto_item *
 412 proto_tree_add_boolean_hidden(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 413         gint length, guint32 value);
 414
 415 #if __GNUC__ >= 2
 416 extern proto_item *
 417 proto_tree_add_boolean_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 418         gint length, guint32 value, const char *format, ...)
 419         __attribute__((format (printf, 7, 8)));
 420 #else
 421 extern proto_item *
 422 proto_tree_add_boolean_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 423         gint length, guint32 value, const char *format, ...);
 424 #endif
 425
 426 /* Add a FT_FLOAT to a proto_tree */
 427 extern proto_item *
 428 proto_tree_add_float(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 429         gint length, float value);
 430
 431 extern proto_item *
 432 proto_tree_add_float_hidden(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 433         gint length, float value);
 434
 435 #if __GNUC__ >= 2
 436 extern proto_item *
 437 proto_tree_add_float_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 438         gint length, float value, const char *format, ...)
 439         __attribute__((format (printf, 7, 8)));
 440 #else
 441 extern proto_item *
 442 proto_tree_add_float_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 443         gint length, float value, const char *format, ...);
 444 #endif
 445
 446 /* Add a FT_DOUBLE to a proto_tree */
 447 extern proto_item *
 448 proto_tree_add_double(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 449         gint length, double value);
 450
 451 extern proto_item *
 452 proto_tree_add_double_hidden(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 453         gint length, double value);
 454
 455 #if __GNUC__ >= 2
 456 extern proto_item *
 457 proto_tree_add_double_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 458         gint length, double value, const char *format, ...)
 459         __attribute__((format (printf, 7, 8)));
 460 #else
 461 extern proto_item *
 462 proto_tree_add_double_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 463         gint length, double value, const char *format, ...);
 464 #endif
 465
 466 /* Add any FT_UINT* to a proto_tree */
 467 extern proto_item *
 468 proto_tree_add_uint(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 469         gint length, guint32 value);
 470
 471 extern proto_item *
 472 proto_tree_add_uint_hidden(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 473         gint length, guint32 value);
 474
 475 #if __GNUC__ >= 2
 476 extern proto_item *
 477 proto_tree_add_uint_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 478         gint length, guint32 value, const char *format, ...)
 479         __attribute__((format (printf, 7, 8)));
 480 #else
 481 extern proto_item *
 482 proto_tree_add_uint_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 483         gint length, guint32 value, const char *format, ...);
 484 #endif
 485
 486 /* Add any FT_INT* to a proto_tree */
 487 extern proto_item *
 488 proto_tree_add_int(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 489         gint length, gint32 value);
 490
 491 extern proto_item *
 492 proto_tree_add_int_hidden(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 493         gint length, gint32 value);
 494
 495 #if __GNUC__ >= 2
 496 extern proto_item *
 497 proto_tree_add_int_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 498         gint length, gint32 value, const char *format, ...)
 499         __attribute__((format (printf, 7, 8)));
 500 #else
 501 extern proto_item *
 502 proto_tree_add_int_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 503         gint length, gint32 value, const char *format, ...);
 504 #endif
 505
 506
 507 /* Add a text-only node to the proto_tree */
 508 #if __GNUC__ >= 2
 509 extern proto_item *
 510 proto_tree_add_text(proto_tree *tree, tvbuff_t *tvb, gint start, gint length, const char *,
 511         ...) __attribute__((format (printf, 5, 6)));
 512 #else
 513 extern proto_item *
 514 proto_tree_add_text(proto_tree *tree, tvbuff_t *tvb, gint start, gint length, const char *,
 515         ...);
 516 #endif
 517
 518 extern proto_item *
 519 proto_tree_add_text_valist(proto_tree *tree, tvbuff_t *tvb, gint start,
 520         gint length, const char *format, va_list ap);
 521
 522
 523 /* Useful for quick debugging. Also sends string to STDOUT, so don't
 524  * leave call to this function in production code. */
 525 #if __GNUC__ >= 2
 526 extern proto_item *
 527 proto_tree_add_debug_text(proto_tree *tree, const char *format, ...)
 528         __attribute__((format (printf, 2, 3)));
 529 #else
 530 extern proto_item *
 531 proto_tree_add_debug_text(proto_tree *tree, const char *format, ...);
 532 #endif
 533
 534 extern void
 535 proto_item_fill_label(field_info *fi, gchar *label_str);
 536
 537 extern void
 538 proto_tree_set_visible(proto_tree *tree, gboolean visible);
 539
 540 /* Returns number of items (protocols or header fields) registered. */
 541 extern int proto_registrar_n(void);
 542
 543 /* Returns char* to name for item # n (0-indexed) */
 544 extern char* proto_registrar_get_name(int n);
 545
 546 /* Returns char* to abbrev for item # n (0-indexed) */
 547 extern char* proto_registrar_get_abbrev(int n);
 548
 549 /* get the header field information based upon a field or protocol id */
 550 extern header_field_info* proto_registrar_get_nth(guint hfindex);
 551
 552 /* get the header field information based upon a field name */
 553 extern header_field_info* proto_registrar_get_byname(char *field_name);
 554
 555 /* Returns enum ftenum for item # n */
 556 extern int proto_registrar_get_ftype(int n);
 557
 558 /* Returns parent protocol for item # n.
 559  * Returns -1 if item _is_ a protocol */
 560 extern int proto_registrar_get_parent(int n);
 561
 562 /* Is item #n a protocol? */
 563 extern gboolean proto_registrar_is_protocol(int n);
 564
 565 /* Is protocol's decoding enabled ? */
 566 extern gboolean proto_is_protocol_enabled(protocol_t *protocol);
 567
 568 /* Can item #n decoding be disabled? */
 569 extern gboolean proto_can_toggle_protocol(int proto_id);
 570
 571 /* Routines to use to iterate over the protocols and their fields;
 572  * they return the item number of the protocol in question or the
 573  * appropriate hfinfo pointer, and keep state in "*cookie". */
 574 extern int proto_get_first_protocol(void **cookie);
 575 extern int proto_get_next_protocol(void **cookie);
 576 extern header_field_info *proto_get_first_protocol_field(int proto_id, void **cookle);
 577 extern header_field_info *proto_get_next_protocol_field(void **cookle);
 578
 579 /* Given a protocol's "protocol_t", return its proto_id */
 580 extern int proto_get_id(protocol_t *protocol);
 581
 582 /* Given a protocol's filter_name, return its proto_id */
 583 extern int proto_get_id_by_filter_name(gchar* filter_name);
 584
 585 /* Given a protocol's item number, find the "protocol_t" structure for it */
 586 extern protocol_t *find_protocol_by_id(int proto_id);
 587
 588 /* Given a protocol's item number, return its name. */
 589 extern char *proto_get_protocol_name(int n);
 590
 591 /* Given a protocol's "protocol_t", return its short name. */
 592 extern char *proto_get_protocol_short_name(protocol_t *protocol);
 593
 594 /* Given a protocol's item number, return its filter name. */
 595 extern char *proto_get_protocol_filter_name(int proto_id);
 596
 597 /* Enable / Disable protocol */
 598 extern void proto_set_decoding(int proto_id, gboolean enabled);
 599
 600 /* Disable disabling/enabling of protocol */
 601 extern void proto_set_cant_toggle(int proto_id);
 602
 603 /* Get length of registered field according to field type.
 604  * 0 means undeterminable at registration time.
 605  * -1 means unknown field */
 606 extern gint proto_registrar_get_length(int n);
 607
 608 /* Checks for existence any protocol or field within a tree.
 609  * "Protocols" are assumed to be a child of the [empty] root node.
 610  * TRUE = found, FALSE = not found */
 611 extern gboolean proto_check_for_protocol_or_field(proto_tree* tree, int id);
 612
 613 /* Return GPtrArray* of field_info pointers for all hfindex that appear in
 614  * tree. Only works with primed trees, and is fast. */
 615 extern GPtrArray* proto_get_finfo_ptr_array(proto_tree *tree, int hfindex);
 616
 617 /* Return GPtrArray* of field_info pointers for all hfindex that appear in
 618  * tree. Works with any tree, primed or unprimed, and is slower than
 619  * proto_get_finfo_ptr_array because it has to search through the tree. */
 620 extern GPtrArray* proto_find_finfo(proto_tree *tree, int hfindex);
 621
 622 /* Dumps a glossary of the protocol registrations to STDOUT */
 623 extern void proto_registrar_dump_protocols(void);
 624
 625 /* Dumps a glossary of the protocol and field registrations to STDOUT */
 626 extern void proto_registrar_dump_fields(void);
 627
 628 /* Points to the first element of an array of Booleans, indexed by
 629    a subtree item type; that array element is TRUE if subtrees of
 630    an item of that type are to be expanded. */
 631 extern gboolean      *tree_is_expanded;
 632
 633 /* Number of elements in that array. */
 634 extern int           num_tree_types;
 635
 636 /* glib doesn't have g_ptr_array_len of all things!*/
 637 #ifndef g_ptr_array_len
 638 #define g_ptr_array_len(a)      ((a)->len)
 639 #endif
 640
 641 extern int
 642 hfinfo_bitwidth(header_field_info *hfinfo);
 643
 644 #include "epan.h"
 645
 646 /*
 647  * Returns TRUE if we can do a "match selected" on the field, FALSE
 648  * otherwise.
 649  */
 650 extern gboolean
 651 proto_can_match_selected(field_info *finfo, epan_dissect_t *edt);
 652
 653 extern char*
 654 proto_construct_dfilter_string(field_info *finfo, epan_dissect_t *edt);
 655
 656 extern field_info*
 657 proto_find_field_from_offset(proto_tree *tree, guint offset, tvbuff_t *tvb);
 658
 659 #endif /* proto.h */