checkAPIs.pl: support for new-style dissectors in check_hf_entries
[metze/wireshark/wip.git] / epan / ptvcursor.h
index d90d8dd8f90c88358068416251d7537a0f9001b5..46c5685b9e797239d8299e03bab2ee0c3809f0a8 100644 (file)
@@ -3,36 +3,19 @@
  * Proto Tree TVBuff cursor
  * Gilbert Ramirez <gram@alumni.rice.edu>
  *
- * $Id$
- *
  * Wireshark - Network traffic analyzer
  * By Gerald Combs <gerald@wireshark.org>
  * Copyright 2000 Gerald Combs
  *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version 2
- * of the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+ * SPDX-License-Identifier: GPL-2.0-or-later
  */
 
 #ifndef __PTVCURSOR_H__
 #define __PTVCURSOR_H__
 
-#ifdef HAVE_CONFIG_H
-# include "config.h"
-#endif
-
 #include <glib.h>
 #include <epan/packet.h>
+#include "ws_symbol_export.h"
 
 #define SUBTREE_UNDEFINED_LENGTH -1
 
@@ -40,50 +23,84 @@ typedef struct ptvcursor ptvcursor_t;
 
 /* Allocates an initializes a ptvcursor_t with 3 variables:
  * proto_tree, tvbuff, and offset. */
+WS_DLL_PUBLIC
 ptvcursor_t*
 ptvcursor_new(proto_tree* tree, tvbuff_t* tvb, gint offset);
 
 /* Gets data from tvbuff, adds it to proto_tree, increments offset,
  * and returns proto_item* */
+WS_DLL_PUBLIC
 proto_item*
-ptvcursor_add(ptvcursor_t* ptvc, int hf, gint length, gboolean endianness);
+ptvcursor_add(ptvcursor_t* ptvc, int hf, gint length, const guint encoding);
 
+/* Gets data from tvbuff, adds it to proto_tree, increments offset,
+ * and returns proto_item* and uint value retreived*/
+WS_DLL_PUBLIC
+proto_item*
+ptvcursor_add_ret_uint(ptvcursor_t* ptvc, int hf, gint length, const guint encoding, guint32 *retval);
+
+/* Gets data from tvbuff, adds it to proto_tree, increments offset,
+ * and returns proto_item* and int value retreived */
+WS_DLL_PUBLIC
+proto_item*
+ptvcursor_add_ret_int(ptvcursor_t* ptvc, int hf, gint length, const guint encoding, gint32 *retval);
+
+/* Gets data from tvbuff, adds it to proto_tree, increments offset,
+ * and returns proto_item* and string value retreived */
+WS_DLL_PUBLIC
+proto_item*
+ptvcursor_add_ret_string(ptvcursor_t* ptvc, int hf, gint length, const guint encoding, wmem_allocator_t *scope, const guint8 **retval);
+
+/* Gets data from tvbuff, adds it to proto_tree, increments offset,
+ * and returns proto_item* and boolean value retreived */
+WS_DLL_PUBLIC
+proto_item*
+ptvcursor_add_ret_boolean(ptvcursor_t* ptvc, int hf, gint length, const guint encoding, gboolean *retval);
 
 /* Gets data from tvbuff, adds it to proto_tree, *DOES NOT* increment
  * offset, and returns proto_item* */
+WS_DLL_PUBLIC
 proto_item*
-ptvcursor_add_no_advance(ptvcursor_t* ptvc, int hf, gint length, gboolean endianness);
+ptvcursor_add_no_advance(ptvcursor_t* ptvc, int hf, gint length, const guint encoding);
 
 /* Advance the ptvcursor's offset within its tvbuff without
  * adding anything to the proto_tree. */
+WS_DLL_PUBLIC
 void
 ptvcursor_advance(ptvcursor_t* ptvc, gint length);
 
 /* Frees memory for ptvcursor_t, but nothing deeper than that. */
+WS_DLL_PUBLIC
 void
 ptvcursor_free(ptvcursor_t* ptvc);
 
 /* Returns tvbuff. */
+WS_DLL_PUBLIC
 tvbuff_t*
 ptvcursor_tvbuff(ptvcursor_t* ptvc);
 
 /* Returns current offset. */
+WS_DLL_PUBLIC
 gint
 ptvcursor_current_offset(ptvcursor_t* ptvc);
 
 /* Returns the proto_tree* */
+WS_DLL_PUBLIC
 proto_tree*
 ptvcursor_tree(ptvcursor_t* ptvc);
 
 /* Sets a new proto_tree* for the ptvcursor_t */
+WS_DLL_PUBLIC
 void
 ptvcursor_set_tree(ptvcursor_t* ptvc, proto_tree* tree);
 
 /* push a subtree in the tree stack of the cursor */
+WS_DLL_PUBLIC
 proto_tree*
 ptvcursor_push_subtree(ptvcursor_t* ptvc, proto_item* it, gint ett_subtree);
 
 /* pop a subtree in the tree stack of the cursor */
+WS_DLL_PUBLIC
 void
 ptvcursor_pop_subtree(ptvcursor_t* ptvc);
 
@@ -92,21 +109,25 @@ ptvcursor_pop_subtree(ptvcursor_t* ptvc);
  * In this case, when the subtree will be closed, the parent item length will
  * be equal to the advancement of the cursor since the creation of the subtree.
  */
+WS_DLL_PUBLIC
 proto_tree*
 ptvcursor_add_with_subtree(ptvcursor_t* ptvc, int hfindex, gint length,
-    gboolean little_endian, gint ett_subtree);
+    const guint encoding, gint ett_subtree);
 
 /* Add a text node to the tree and create a subtree
  * If the length is unknown, length may be defined as SUBTREE_UNDEFINED_LENGTH.
  * In this case, when the subtree will be closed, the item length will be equal
  * to the advancement of the cursor since the creation of the subtree.
  */
+WS_DLL_PUBLIC
 proto_tree*
 ptvcursor_add_text_with_subtree(ptvcursor_t* ptvc, gint length,
-    gint ett_subtree, const char* format, ...);
+    gint ett_subtree, const char* format, ...)
+    G_GNUC_PRINTF(4, 5);
 
 /* Creates a subtree and adds it to the cursor as the working tree but does not
  * save the old working tree */
+WS_DLL_PUBLIC
 proto_tree*
 ptvcursor_set_subtree(ptvcursor_t* ptvc, proto_item* it, gint ett_subtree);