epan/proto.h

   1 /* proto.h
   2  * Definitions for protocol display
   3  *
   4  * $Id: proto.h,v 1.65 2004/05/10 14:02:17 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 for bitfield strings */
  53 #define TFS(x)  (const struct true_false_string*)(x)
  54
  55 struct _protocol;
  56 typedef struct _protocol protocol_t;
  57
  58 /* check protocol activation */
  59 #define CHECK_DISPLAY_AS_X(x_handle,index, tvb, pinfo, tree) {  \
  60         if (!proto_is_protocol_enabled(find_protocol_by_id(index))) {   \
  61                 call_dissector(x_handle,tvb, pinfo, tree);              \
  62                 return;                                                 \
  63         }                                                               \
  64   }
  65
  66 /* values for header_field_info.display */
  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;      /* full name of this field */
  80         char                            *abbrev;    /* abbreviated name of this field */
  81         enum ftenum                     type;       /* field type, one of FT_ (from ftypes.h) */
  82         int                                     display;        /* one of BASE_, or number of field bits for FT_BOOLEAN */
  83         const void                      *strings;       /* val_string or true_false_string for FT_BOOLEAN, typically VALS() or TFS() */
  84         guint32                         bitmask;    /* FT_BOOLEAN: bitmask of interesting bits */
  85         char                            *blurb;         /* Brief description of field. */
  86
  87         /* ------- set by proto routines (prefilled by HFILL macro, see below) ------ */
  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 /* string representation, if one of the proto_tree_add_..._format() functions used */
 110 typedef struct _item_label_t {
 111         char representation[ITEM_LABEL_LENGTH];
 112 } item_label_t;
 113
 114
 115 /* Contains the field information for the proto_item. */
 116 typedef struct field_info {
 117         header_field_info       *hfinfo;    /* pointer to registered field information */
 118         gint                            start;      /* current start of data */
 119         gint                            length;     /* current data length of item */
 120         gint                            tree_type;  /* ETT_ */
 121         item_label_t            *rep;       /* string for GUI tree */
 122         int                                     flags;      /* one of FI_ */
 123         tvbuff_t                        *ds_tvb;    /* data source tvbuff */
 124         fvalue_t                        value;
 125 } field_info;
 126
 127
 128 /* flags for field_info.flags (must be or'ed together) */
 129 #define FI_HIDDEN       0x0001
 130 #define FI_GENERATED    0x0002
 131
 132 /* convenience macros to manipulate flags field */
 133 #define FI_GET_FLAG(fi, flag) (fi->flags & flag)
 134 #define FI_SET_FLAG(fi, flag) (fi->flags = fi->flags | flag)
 135
 136
 137
 138 /* One of these exists for the entire protocol tree. Each proto_node
 139  * in the protocol tree points to the same copy. */
 140 typedef struct {
 141     GHashTable  *interesting_hfids;
 142     gboolean    visible;
 143 } tree_data_t;
 144
 145 /* Each proto_tree, proto_item is one of these. */
 146 typedef struct _proto_node {
 147         struct _proto_node *first_child;
 148         struct _proto_node *last_child;
 149         struct _proto_node *next;
 150         struct _proto_node *parent;
 151         field_info  *finfo;
 152         tree_data_t *tree_data;
 153 } proto_node;
 154
 155 typedef proto_node proto_tree;
 156 typedef proto_node proto_item;
 157
 158
 159 /* indicate that this field should not be shown by Ethereal (used for filtering only) */
 160 #define PROTO_ITEM_IS_HIDDEN(proto_item)        \
 161         ((proto_item) ? FI_GET_FLAG(proto_item->finfo, FI_HIDDEN) : 0)
 162 #define PROTO_ITEM_SET_HIDDEN(proto_item)       \
 163         ((proto_item) ? FI_SET_FLAG(proto_item->finfo, FI_HIDDEN) : 0)
 164 /* indicate that this field is generated by Ethereal (and not inside the packet data) */
 165 #define PROTO_ITEM_IS_GENERATED(proto_item)     \
 166         ((proto_item) ? FI_GET_FLAG(proto_item->finfo, FI_GENERATED) : 0)
 167 #define PROTO_ITEM_SET_GENERATED(proto_item)    \
 168         ((proto_item) ? FI_SET_FLAG(proto_item->finfo, FI_GENERATED) : 0)
 169
 170
 171 typedef void (*proto_tree_foreach_func)(proto_node *, gpointer);
 172
 173 extern void proto_tree_children_foreach(proto_tree *tree,
 174     proto_tree_foreach_func func, gpointer data);
 175
 176 /* Retrieve the field_info from a proto_item */
 177 #define PITEM_FINFO(proto_item)  ((proto_item)->finfo)
 178
 179 /* Retrieve the tree_data_t from a proto_tree */
 180 #define PTREE_DATA(proto_tree)   ((proto_tree)->tree_data)
 181
 182 /* Sets up memory used by proto routines. Called at program startup */
 183 extern void proto_init(const char *plugin_dir,
 184     void (register_all_protocols)(void), void (register_all_handoffs)(void));
 185
 186 /* Frees memory used by proto routines. Called at program shutdown */
 187 extern void proto_cleanup(void);
 188
 189
 190
 191 /* Create a subtree under an existing item; returns tree pointer */
 192 extern proto_tree* proto_item_add_subtree(proto_item *ti, gint idx);
 193
 194 /* Get a subtree under an item; returns tree pointer */
 195 extern proto_tree* proto_item_get_subtree(proto_item *ti);
 196
 197 /* Get a parent item; returns item pointer */
 198 extern proto_item* proto_item_get_parent(proto_item *ti);
 199
 200 /* Get Nth generation parent item; returns item pointer */
 201 extern proto_item* proto_item_get_parent_nth(proto_item *ti, int gen);
 202
 203 /* Set text of proto_item after having already been created. */
 204 #if __GNUC__ >= 2
 205 extern void proto_item_set_text(proto_item *ti, const char *format, ...)
 206         __attribute__((format (printf, 2, 3)));
 207 #else
 208 extern void proto_item_set_text(proto_item *ti, const char *format, ...);
 209 #endif
 210
 211 /* Append to text of proto_item after having already been created. */
 212 #if __GNUC__ >= 2
 213 extern void proto_item_append_text(proto_item *ti, const char *format, ...)
 214         __attribute__((format (printf, 2, 3)));
 215 #else
 216 extern void proto_item_append_text(proto_item *ti, const char *format, ...);
 217 #endif
 218
 219 /* Set length of proto_item after having already been created. */
 220 extern void proto_item_set_len(proto_item *ti, gint length);
 221
 222 /*
 223  * Sets the length of the item based on its start and on the specified
 224  * offset, which is the offset past the end of the item; as the start
 225  * in the item is relative to the beginning of the data source tvbuff,
 226  * we need to pass in a tvbuff - the end offset is relative to the beginning
 227  * of that tvbuff.
 228  */
 229 extern void proto_item_set_end(proto_item *pi, tvbuff_t *tvb, gint end);
 230
 231 /* Get length of proto_item. Useful after using proto_tree_add_item()
 232  * to add a variable-length field (e.g., FT_NSTRING_UINT8) */
 233 extern int proto_item_get_len(proto_item *ti);
 234
 235
 236
 237 /* Creates new proto_tree root */
 238 extern proto_tree* proto_tree_create_root(void);
 239
 240 /* Clear memory for entry proto_tree. Clears proto_tree struct also. */
 241 extern void proto_tree_free(proto_tree *tree);
 242
 243 extern void
 244 proto_tree_set_visible(proto_tree *tree, gboolean visible);
 245
 246 /* Mark a field/protocol ID as "interesting". */
 247 extern void
 248 proto_tree_prime_hfid(proto_tree *tree, int hfid);
 249
 250 /* Get a parent item of subtree; returns item pointer */
 251 extern proto_item* proto_tree_get_parent(proto_tree *tree);
 252
 253
 254 /* GNUC has the ability to check format strings that follow the syntax used in printf and others. */
 255 /* Hide the differences between different compilers in this GNUC_FORMAT_CHECK macro. */
 256 /* XXX - as this check is also done at some other places too, move this macro to a more central place? */
 257 #if __GNUC__ >= 2
 258         #define GNUC_FORMAT_CHECK(archetype, string_index, first_to_check) __attribute__((format (archetype, string_index, first_to_check)))
 259 #else
 260         #define GNUC_FORMAT_CHECK(archetype, string_index, first_to_check)
 261 #endif
 262
 263
 264 /* Add an item to a proto_tree, using the text label registered to that item;
 265    the item is extracted from the tvbuff handed to it. */
 266 extern proto_item *
 267 proto_tree_add_item(proto_tree *tree, int hfindex, tvbuff_t *tvb,
 268     gint start, gint length, gboolean little_endian);
 269
 270 extern proto_item *
 271 proto_tree_add_item_hidden(proto_tree *tree, int hfindex, tvbuff_t *tvb,
 272     gint start, gint length, gboolean little_endian);
 273
 274 /* Add a FT_NONE to a proto_tree */
 275 extern proto_item *
 276 proto_tree_add_none_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 277         gint length, const char *format, ...) GNUC_FORMAT_CHECK(printf,6,7);
 278
 279 /* Add a FT_PROTOCOL to a proto_tree */
 280 extern proto_item *
 281 proto_tree_add_protocol_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 282         gint length, const char *format, ...) GNUC_FORMAT_CHECK(printf,6,7);
 283
 284 /* Add a FT_BYTES to a proto_tree */
 285 extern proto_item *
 286 proto_tree_add_bytes(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 287         gint length, const guint8* start_ptr);
 288
 289 extern proto_item *
 290 proto_tree_add_bytes_hidden(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 291         gint length, const guint8* start_ptr);
 292
 293 extern proto_item *
 294 proto_tree_add_bytes_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 295         gint length, const guint8* start_ptr, const char *format, ...) GNUC_FORMAT_CHECK(printf,7,8);
 296
 297 /* Add a FT_*TIME to a proto_tree */
 298 extern proto_item *
 299 proto_tree_add_time(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 300         gint length, nstime_t* value_ptr);
 301
 302 extern proto_item *
 303 proto_tree_add_time_hidden(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 304         gint length, nstime_t* value_ptr);
 305
 306 extern proto_item *
 307 proto_tree_add_time_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 308         gint length, nstime_t* value_ptr, const char *format, ...) GNUC_FORMAT_CHECK(printf,7,8);
 309
 310 /* Add a FT_IPXNET to a proto_tree */
 311 extern proto_item *
 312 proto_tree_add_ipxnet(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 313         gint length, guint32 value);
 314
 315 extern proto_item *
 316 proto_tree_add_ipxnet_hidden(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 317         gint length, guint32 value);
 318
 319 extern proto_item *
 320 proto_tree_add_ipxnet_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 321         gint length, guint32 value, const char *format, ...) GNUC_FORMAT_CHECK(printf,7,8);
 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 extern proto_item *
 333 proto_tree_add_ipv4_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 334         gint length, guint32 value, const char *format, ...) GNUC_FORMAT_CHECK(printf,7,8);
 335
 336 /* Add a FT_IPv6 to a proto_tree */
 337 extern proto_item *
 338 proto_tree_add_ipv6(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 339         gint length, const guint8* value_ptr);
 340
 341 extern proto_item *
 342 proto_tree_add_ipv6_hidden(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 343         gint length, const guint8* value_ptr);
 344
 345 extern proto_item *
 346 proto_tree_add_ipv6_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 347         gint length, const guint8* value_ptr, const char *format, ...) GNUC_FORMAT_CHECK(printf,7,8);
 348
 349 /* Add a FT_ETHER to a proto_tree */
 350 extern proto_item *
 351 proto_tree_add_ether(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 352         gint length, const guint8* value);
 353
 354 extern proto_item *
 355 proto_tree_add_ether_hidden(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 356         gint length, const guint8* value);
 357
 358 extern proto_item *
 359 proto_tree_add_ether_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 360         gint length, const guint8* value, const char *format, ...) GNUC_FORMAT_CHECK(printf,7,8);
 361
 362 /* Add a FT_STRING to a proto_tree */
 363 extern proto_item *
 364 proto_tree_add_string(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 365         gint length, const char* value);
 366
 367 extern proto_item *
 368 proto_tree_add_string_hidden(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 369         gint length, const char* value);
 370
 371 extern proto_item *
 372 proto_tree_add_string_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 373         gint length, const char* value, const char *format, ...) GNUC_FORMAT_CHECK(printf,7,8);
 374
 375 extern void
 376 proto_item_append_string(proto_item *pi, const char *str);
 377
 378 /* Add a FT_BOOLEAN to a proto_tree */
 379 extern proto_item *
 380 proto_tree_add_boolean(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 381         gint length, guint32 value);
 382
 383 extern proto_item *
 384 proto_tree_add_boolean_hidden(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 385         gint length, guint32 value);
 386
 387 extern proto_item *
 388 proto_tree_add_boolean_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 389         gint length, guint32 value, const char *format, ...) GNUC_FORMAT_CHECK(printf,7,8);
 390
 391 /* Add a FT_FLOAT to a proto_tree */
 392 extern proto_item *
 393 proto_tree_add_float(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 394         gint length, float value);
 395
 396 extern proto_item *
 397 proto_tree_add_float_hidden(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 398         gint length, float value);
 399
 400 extern proto_item *
 401 proto_tree_add_float_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 402         gint length, float value, const char *format, ...) GNUC_FORMAT_CHECK(printf,7,8);
 403
 404 /* Add a FT_DOUBLE to a proto_tree */
 405 extern proto_item *
 406 proto_tree_add_double(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 407         gint length, double value);
 408
 409 extern proto_item *
 410 proto_tree_add_double_hidden(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 411         gint length, double value);
 412
 413 extern proto_item *
 414 proto_tree_add_double_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 415         gint length, double value, const char *format, ...) GNUC_FORMAT_CHECK(printf,7,8);
 416
 417 /* Add any FT_UINT* to a proto_tree */
 418 extern proto_item *
 419 proto_tree_add_uint(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 420         gint length, guint32 value);
 421
 422 extern proto_item *
 423 proto_tree_add_uint_hidden(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 424         gint length, guint32 value);
 425
 426 extern proto_item *
 427 proto_tree_add_uint_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 428         gint length, guint32 value, const char *format, ...) GNUC_FORMAT_CHECK(printf,7,8);
 429
 430 /* Add any FT_INT* to a proto_tree */
 431 extern proto_item *
 432 proto_tree_add_int(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 433         gint length, gint32 value);
 434
 435 extern proto_item *
 436 proto_tree_add_int_hidden(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 437         gint length, gint32 value);
 438
 439 extern proto_item *
 440 proto_tree_add_int_format(proto_tree *tree, int hfindex, tvbuff_t *tvb, gint start,
 441         gint length, gint32 value, const char *format, ...) GNUC_FORMAT_CHECK(printf,7,8);
 442
 443 /* Add a text-only node to the proto_tree */
 444 extern proto_item *
 445 proto_tree_add_text(proto_tree *tree, tvbuff_t *tvb, gint start, gint length, const char *format,
 446         ...) GNUC_FORMAT_CHECK(printf,5,6);
 447
 448 extern proto_item *
 449 proto_tree_add_text_valist(proto_tree *tree, tvbuff_t *tvb, gint start,
 450         gint length, const char *format, va_list ap);
 451
 452
 453 /* Useful for quick debugging. Also sends string to STDOUT, so don't
 454  * leave call to this function in production code. */
 455 extern proto_item *
 456 proto_tree_add_debug_text(proto_tree *tree, const char *format,
 457         ...) GNUC_FORMAT_CHECK(printf,2,3);
 458
 459
 460 extern void
 461 proto_item_fill_label(field_info *fi, gchar *label_str);
 462
 463
 464
 465 extern int
 466 proto_register_protocol(char *name, char *short_name, char *filter_name);
 467
 468 extern void
 469 proto_register_field_array(int parent, hf_register_info *hf, int num_records);
 470
 471 extern void
 472 proto_register_subtree_array(gint **indices, int num_indices);
 473
 474 /* Returns number of items (protocols or header fields) registered. */
 475 extern int proto_registrar_n(void);
 476
 477 /* Returns char* to name for item # n (0-indexed) */
 478 extern char* proto_registrar_get_name(int n);
 479
 480 /* Returns char* to abbrev for item # n (0-indexed) */
 481 extern char* proto_registrar_get_abbrev(int n);
 482
 483 /* get the header field information based upon a field or protocol id */
 484 extern header_field_info* proto_registrar_get_nth(guint hfindex);
 485
 486 /* get the header field information based upon a field name */
 487 extern header_field_info* proto_registrar_get_byname(char *field_name);
 488
 489 /* Returns enum ftenum for item # n */
 490 extern int proto_registrar_get_ftype(int n);
 491
 492 /* Returns parent protocol for item # n.
 493  * Returns -1 if item _is_ a protocol */
 494 extern int proto_registrar_get_parent(int n);
 495
 496 /* Is item #n a protocol? */
 497 extern gboolean proto_registrar_is_protocol(int n);
 498
 499 /* Is protocol's decoding enabled ? */
 500 extern gboolean proto_is_protocol_enabled(protocol_t *protocol);
 501
 502 /* Can item #n decoding be disabled? */
 503 extern gboolean proto_can_toggle_protocol(int proto_id);
 504
 505 /* Routines to use to iterate over the protocols and their fields;
 506  * they return the item number of the protocol in question or the
 507  * appropriate hfinfo pointer, and keep state in "*cookie". */
 508 extern int proto_get_first_protocol(void **cookie);
 509 extern int proto_get_next_protocol(void **cookie);
 510 extern header_field_info *proto_get_first_protocol_field(int proto_id, void **cookle);
 511 extern header_field_info *proto_get_next_protocol_field(void **cookle);
 512
 513 /* Given a protocol's "protocol_t", return its proto_id */
 514 extern int proto_get_id(protocol_t *protocol);
 515
 516 /* Given a protocol's filter_name, return its proto_id */
 517 extern int proto_get_id_by_filter_name(gchar* filter_name);
 518
 519 /* Given a protocol's item number, find the "protocol_t" structure for it */
 520 extern protocol_t *find_protocol_by_id(int proto_id);
 521
 522 /* Given a protocol's item number, return its name. */
 523 extern char *proto_get_protocol_name(int n);
 524
 525 /* Given a protocol's "protocol_t", return its short name. */
 526 extern char *proto_get_protocol_short_name(protocol_t *protocol);
 527
 528 /* Given a protocol's item number, return its filter name. */
 529 extern char *proto_get_protocol_filter_name(int proto_id);
 530
 531 /* Enable / Disable protocol */
 532 extern void proto_set_decoding(int proto_id, gboolean enabled);
 533
 534 /* Disable disabling/enabling of protocol */
 535 extern void proto_set_cant_toggle(int proto_id);
 536
 537 /* Get length of registered field according to field type.
 538  * 0 means undeterminable at registration time.
 539  * -1 means unknown field */
 540 extern gint proto_registrar_get_length(int n);
 541
 542 /* Checks for existence any protocol or field within a tree.
 543  * "Protocols" are assumed to be a child of the [empty] root node.
 544  * TRUE = found, FALSE = not found */
 545 extern gboolean proto_check_for_protocol_or_field(proto_tree* tree, int id);
 546
 547 /* Return GPtrArray* of field_info pointers for all hfindex that appear in
 548  * tree. Only works with primed trees, and is fast. */
 549 extern GPtrArray* proto_get_finfo_ptr_array(proto_tree *tree, int hfindex);
 550
 551 /* Return GPtrArray* of field_info pointers for all hfindex that appear in
 552  * tree. Works with any tree, primed or unprimed, and is slower than
 553  * proto_get_finfo_ptr_array because it has to search through the tree. */
 554 extern GPtrArray* proto_find_finfo(proto_tree *tree, int hfindex);
 555
 556 /* Dumps a glossary of the protocol registrations to STDOUT */
 557 extern void proto_registrar_dump_protocols(void);
 558
 559 /* Dumps a glossary of the protocol and field registrations to STDOUT */
 560 extern void proto_registrar_dump_fields(void);
 561
 562
 563
 564 /* Points to the first element of an array of Booleans, indexed by
 565    a subtree item type; that array element is TRUE if subtrees of
 566    an item of that type are to be expanded. With MSVC and a
 567    libethereal.dll, we need a special declaration.
 568  */
 569 ETH_VAR_IMPORT gboolean      *tree_is_expanded;
 570
 571 /* Number of elements in that array. With MSVC and a
 572  * libethereal.dll, we need a special declaration.
 573  */
 574 ETH_VAR_IMPORT int           num_tree_types;
 575
 576 /* glib doesn't have g_ptr_array_len of all things!*/
 577 #ifndef g_ptr_array_len
 578 #define g_ptr_array_len(a)      ((a)->len)
 579 #endif
 580
 581 extern int
 582 hfinfo_bitwidth(header_field_info *hfinfo);
 583
 584
 585
 586
 587 #include "epan.h"
 588
 589 /*
 590  * Returns TRUE if we can do a "match selected" on the field, FALSE
 591  * otherwise.
 592  */
 593 extern gboolean
 594 proto_can_match_selected(field_info *finfo, epan_dissect_t *edt);
 595
 596 extern char*
 597 proto_construct_dfilter_string(field_info *finfo, epan_dissect_t *edt);
 598
 599 extern field_info*
 600 proto_find_field_from_offset(proto_tree *tree, guint offset, tvbuff_t *tvb);
 601
 602 #endif /* proto.h */