Clean up PTV cursor documentation.
[metze/wireshark/wip.git] / epan / ptvcursor.h
1 /* ptvcursor.h
2  *
3  * Proto Tree TVBuff cursor
4  * Gilbert Ramirez <gram@alumni.rice.edu>
5  *
6  * $Id$
7  *
8  * Wireshark - Network traffic analyzer
9  * By Gerald Combs <gerald@wireshark.org>
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 #define SUBTREE_UNDEFINED_LENGTH -1
38
39 typedef struct ptvcursor ptvcursor_t;
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* tree, tvbuff_t* tvb, gint offset);
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* ptvc, 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* ptvc, int hf, gint length, gboolean endianness);
56
57 /* Advance the ptvcursor's offset within its tvbuff without
58  * adding anything to the proto_tree. */
59 void
60 ptvcursor_advance(ptvcursor_t* ptvc, gint length);
61
62 /* Frees memory for ptvcursor_t, but nothing deeper than that. */
63 void
64 ptvcursor_free(ptvcursor_t* ptvc);
65
66 /* Returns tvbuff. */
67 tvbuff_t*
68 ptvcursor_tvbuff(ptvcursor_t* ptvc);
69
70 /* Returns current offset. */
71 gint
72 ptvcursor_current_offset(ptvcursor_t* ptvc);
73
74 /* Returns the proto_tree* */
75 proto_tree*
76 ptvcursor_tree(ptvcursor_t* ptvc);
77
78 /* Sets a new proto_tree* for the ptvcursor_t */
79 void
80 ptvcursor_set_tree(ptvcursor_t* ptvc, proto_tree* tree);
81
82 /* push a subtree in the tree stack of the cursor */
83 proto_tree*
84 ptvcursor_push_subtree(ptvcursor_t* ptvc, proto_item* it, gint ett_subtree);
85
86 /* pop a subtree in the tree stack of the cursor */
87 void
88 ptvcursor_pop_subtree(ptvcursor_t* ptvc);
89
90 /* Add an item to the tree and create a subtree
91  * If the length is unknown, length may be defined as SUBTREE_UNDEFINED_LENGTH.
92  * In this case, when the subtree will be closed, the parent item length will
93  * be equal to the advancement of the cursor since the creation of the subtree.
94  */
95 proto_tree*
96 ptvcursor_add_with_subtree(ptvcursor_t* ptvc, int hfindex, gint length,
97     gboolean little_endian, gint ett_subtree);
98
99 /* Add a text node to the tree and create a subtree
100  * If the length is unknown, length may be defined as SUBTREE_UNDEFINED_LENGTH.
101  * In this case, when the subtree will be closed, the item length will be equal
102  * to the advancement of the cursor since the creation of the subtree.
103  */
104 proto_tree*
105 ptvcursor_add_text_with_subtree(ptvcursor_t* ptvc, gint length,
106     gint ett_subtree, const char* format, ...);
107
108 /* Creates a subtree and adds it to the cursor as the working tree but does not
109  * save the old working tree */
110 proto_tree*
111 ptvcursor_set_subtree(ptvcursor_t* ptvc, proto_item* it, gint ett_subtree);
112
113 #endif /* __PTVCURSOR_H__ */