ptvcursor.h

   1 /* ptvcursor.h
   2  *
   3  * Proto Tree TVBuff cursor
   4  * Gilbert Ramirez <gram@alumni.rice.edu>
   5  *
   6  * $Id: ptvcursor.h,v 1.5 2002/01/21 07:36:48 guy Exp $
   7  *
   8  * Ethereal - Network traffic analyzer
   9  * By Gerald Combs <gerald@ethereal.com>
  10  * Copyright 2000 Gerald Combs
  11  *
  12  * This program is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU General Public License
  14  * as published by the Free Software Foundation; either version 2
  15  * of the License, or (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  25  */
  26
  27 #ifndef __PTVCURSOR_H__
  28 #define __PTVCURSOR_H__
  29
  30 #ifdef HAVE_CONFIG_H
  31 # include "config.h"
  32 #endif
  33
  34 #include <glib.h>
  35 #include <epan/packet.h>
  36
  37 typedef struct ptvcursor ptvcursor_t;
  38
  39 #define PTVC_VARIABLE_LENGTH    -1
  40
  41 /* Allocates an initializes a ptvcursor_t with 3 variables:
  42  *      proto_tree, tvbuff, and offset. */
  43 ptvcursor_t*
  44 ptvcursor_new(proto_tree*, tvbuff_t*, gint);
  45
  46 /* Gets data from tvbuff, adds it to proto_tree, increments offset,
  47  * and returns proto_item* */
  48 proto_item*
  49 ptvcursor_add(ptvcursor_t*, int hf, gint length, gboolean endianness);
  50
  51
  52 /* Gets data from tvbuff, adds it to proto_tree, *DOES NOT* increment
  53  * offset, and returns proto_item* */
  54 proto_item*
  55 ptvcursor_add_no_advance(ptvcursor_t*, int hf, gint length, gboolean endianness);
  56
  57 /* Frees memory for ptvcursor_t, but nothing deeper than that. */
  58 void
  59 ptvcursor_free(ptvcursor_t*);
  60
  61 /* Returns tvbuff. */
  62 tvbuff_t*
  63 ptvcursor_tvbuff(ptvcursor_t*);
  64
  65 /* Returns current offset. */
  66 gint
  67 ptvcursor_current_offset(ptvcursor_t*);
  68
  69 #endif /* __PTVCURSOR_H__ */