Move tvb_new_octet_aligned() to tvbuff.c and use it.
[obnox/wireshark/wip.git] / epan / tvbuff.h
1 /* tvbuff.h
2  *
3  * Testy, Virtual(-izable) Buffer of guint8*'s
4  *
5  * "Testy" -- the buffer gets mad when an attempt is made to access data
6  *              beyond the bounds of the buffer. An exception is thrown.
7  *
8  * "Virtual" -- the buffer can have its own data, can use a subset of
9  *              the data of a backing tvbuff, or can be a composite of
10  *              other tvbuffs.
11  *
12  * $Id$
13  *
14  * Copyright (c) 2000 by Gilbert Ramirez <gram@alumni.rice.edu>
15  *
16  * Wireshark - Network traffic analyzer
17  * By Gerald Combs <gerald@wireshark.org>
18  * Copyright 1998 Gerald Combs
19  *
20  * This program is free software; you can redistribute it and/or
21  * modify it under the terms of the GNU General Public License
22  * as published by the Free Software Foundation; either version 2
23  * of the License, or (at your option) any later version.
24  *
25  * This program is distributed in the hope that it will be useful,
26  * but WITHOUT ANY WARRANTY; without even the implied warranty of
27  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
28  * GNU General Public License for more details.
29  *
30  * You should have received a copy of the GNU General Public License
31  * along with this program; if not, write to the Free Software
32  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
33  */
34
35 #ifndef __TVBUFF_H__
36 #define __TVBUFF_H__
37
38 #include <glib.h>
39 #include <epan/ipv6-utils.h>
40 #include <epan/guid-utils.h>
41 #include "exceptions.h"
42
43 /** @file
44  * "testy, virtual(-izable) buffer".  They are testy in that they get mad when
45  * an attempt is made to access data beyond the bounds of their array. In that
46  * case, they throw an exception.
47  *
48  * They are virtualizable in that new tvbuff's can be made from other tvbuffs,
49  * while only the original tvbuff may have data. That is, the new tvbuff has
50  * virtual data.
51  */
52
53
54 /** The different types of tvbuff's */
55 typedef enum {
56         TVBUFF_REAL_DATA,
57         TVBUFF_SUBSET,
58         TVBUFF_COMPOSITE
59 } tvbuff_type;
60
61 struct tvbuff;
62 typedef struct tvbuff tvbuff_t;
63
64 /** TVBUFF_REAL_DATA contains a guint8* that points to real data.
65  * The data is allocated and contiguous.
66  *
67  * TVBUFF_SUBSET has a backing tvbuff. The TVBUFF_SUBSET is a "window"
68  * through which the program sees only a portion of the backing tvbuff.
69  *
70  * TVBUFF_COMPOSITE combines multiple tvbuffs sequentually to produce
71  * a larger byte array.
72  *
73  * tvbuff's of any type can be used as the backing-tvbuff of a
74  * TVBUFF_SUBSET or as the member of a TVBUFF_COMPOSITE.
75  * TVBUFF_COMPOSITEs can have member-tvbuffs of different types.
76  *
77  * Once a tvbuff is create/initialized/finalized, the tvbuff is read-only.
78  * That is, it cannot point to any other data. A new tvbuff must be created if
79  * you want a tvbuff that points to other data.
80  */
81
82 typedef void (*tvbuff_free_cb_t)(void*);
83
84 /** Returns a pointer to a newly initialized tvbuff. Note that
85  * tvbuff's of types TVBUFF_SUBSET and TVBUFF_COMPOSITE
86  * require further initialization via the appropriate functions */
87 extern tvbuff_t* tvb_new(tvbuff_type);
88
89 /** Extracs from bit offset number of bits and 
90  * Returns a pointer to a newly initialized tvbuff. with the bits
91  * octet aligned.
92  */
93 extern tvbuff_t* tvb_new_octet_aligned(tvbuff_t *tvb, guint32 bit_offset, gint32 no_of_bits);
94
95
96 /** Marks a tvbuff for freeing. The guint8* data of a TVBUFF_REAL_DATA
97  * is *never* freed by the tvbuff routines. The tvbuff itself is actually freed
98  * once its usage count drops to 0.
99  *
100  * Usage counts increment for any time the tvbuff is
101  * used as a member of another tvbuff, i.e., as the backing buffer for
102  * a TVBUFF_SUBSET or as a member of a TVBUFF_COMPOSITE.
103  *
104  * Although you may call tvb_free(), the tvbuff may still be in use
105  * by other tvbuff's (TVBUFF_SUBSET or TVBUFF_COMPOSITE), so it is not
106  * safe, unless you know otherwise, to free your guint8* data. If you
107  * cannot be sure that your TVBUFF_REAL_DATA is not in use by another
108  * tvbuff, register a callback with tvb_set_free_cb(); when your tvbuff
109  * is _really_ freed, then your callback will be called, and at that time
110  * you can free your original data.
111  *
112  * The caller can artificially increment/decrement the usage count
113  * with tvbuff_increment_usage_count()/tvbuff_decrement_usage_count().
114  */
115 extern void tvb_free(tvbuff_t*);
116
117 /** Free the tvbuff_t and all tvbuff's created from it. */
118 extern void tvb_free_chain(tvbuff_t*);
119
120 /** Both return the new usage count, after the increment or decrement */
121 extern guint tvb_increment_usage_count(tvbuff_t*, const guint count);
122
123 /** If a decrement causes the usage count to drop to 0, a the tvbuff
124  * is immediately freed. Be sure you know exactly what you're doing
125  * if you decide to use this function, as another tvbuff could
126  * still have a pointer to the just-freed tvbuff, causing corrupted data
127  * or a segfault in the future */
128 extern guint tvb_decrement_usage_count(tvbuff_t*, const guint count);
129
130 /** Set a callback function to call when a tvbuff is actually freed
131  * (once the usage count drops to 0). One argument is passed to
132  * that callback --- a void* that points to the real data.
133  * Obviously, this only applies to a TVBUFF_REAL_DATA tvbuff. */
134 extern void tvb_set_free_cb(tvbuff_t*, const tvbuff_free_cb_t);
135
136
137 /** Attach a TVBUFF_REAL_DATA tvbuff to a parent tvbuff. This connection
138  * is used during a tvb_free_chain()... the "child" TVBUFF_REAL_DATA acts
139  * as if is part of the chain-of-creation of the parent tvbuff, although it
140  * isn't. This is useful if you need to take the data from some tvbuff,
141  * run some operation on it, like decryption or decompression, and make a new
142  * tvbuff from it, yet want the new tvbuff to be part of the chain. The reality
143  * is that the new tvbuff *is* part of the "chain of creation", but in a way
144  * that these tvbuff routines is ignorant of. Use this function to make
145  * the tvbuff routines knowledgable of this fact. */
146 extern void tvb_set_child_real_data_tvbuff(tvbuff_t* parent, tvbuff_t* child);
147
148 extern tvbuff_t* tvb_new_child_real_data(tvbuff_t* parent, const guint8* data, const guint length,
149     const gint reported_length);
150
151 /**Sets parameters for TVBUFF_REAL_DATA. Can throw ReportedBoundsError. */
152 extern void tvb_set_real_data(tvbuff_t*, const guint8* data, const guint length,
153     const gint reported_length);
154
155 /** Combination of tvb_new() and tvb_set_real_data(). Can throw ReportedBoundsError. */
156 extern tvbuff_t* tvb_new_real_data(const guint8* data, const guint length,
157     const gint reported_length);
158
159
160 /** Define the subset of the backing buffer to use.
161  *
162  * 'backing_offset' can be negative, to indicate bytes from
163  * the end of the backing buffer.
164  *
165  * 'backing_length' can be 0, although the usefulness of the buffer would
166  * be rather limited.
167  *
168  * 'backing_length' of -1 means "to the end of the backing buffer"
169  *
170  * Will throw BoundsError if 'backing_offset'/'length'
171  * is beyond the bounds of the backing tvbuff.
172  * Can throw ReportedBoundsError. */
173 extern void tvb_set_subset(tvbuff_t* tvb, tvbuff_t* backing,
174                 const gint backing_offset, const gint backing_length, const gint reported_length);
175
176 /** Combination of tvb_new() and tvb_set_subset()
177  * Can throw ReportedBoundsError. */
178 extern tvbuff_t* tvb_new_subset(tvbuff_t* backing,
179                 const gint backing_offset, const gint backing_length, const gint reported_length);
180
181 /** Similar to tvb_new_subset() but with backing_length and reported_length set to -1.
182  * Can throw ReportedBoundsError. */
183 extern tvbuff_t* tvb_new_subset_remaining(tvbuff_t* backing,
184                 const gint backing_offset);
185
186 /** Both tvb_composite_append and tvb_composite_prepend can throw
187  * BoundsError if member_offset/member_length goes beyond bounds of
188  * the 'member' tvbuff. */
189
190 /** Append to the list of tvbuffs that make up this composite tvbuff */
191 extern void tvb_composite_append(tvbuff_t* tvb, tvbuff_t* member);
192
193 /** Prepend to the list of tvbuffs that make up this composite tvbuff */
194 extern void tvb_composite_prepend(tvbuff_t* tvb, tvbuff_t* member);
195
196 /** Helper function that calls tvb_new(TVBUFF_COMPOSITE).
197  * Provided only to maintain symmetry with other constructors */
198 extern tvbuff_t* tvb_new_composite(void);
199
200 /** Mark a composite tvbuff as initialized. No further appends or prepends
201  * occur, data access can finally happen after this finalization. */
202 extern void tvb_composite_finalize(tvbuff_t* tvb);
203
204
205 /* Get total length of buffer */
206 extern guint tvb_length(const tvbuff_t*);
207
208 /** Computes bytes to end of buffer, from offset (which can be negative,
209  * to indicate bytes from end of buffer). Function returns -1 to
210  * indicate that offset is out of bounds. No exception is thrown. */
211 extern gint tvb_length_remaining(const tvbuff_t*, const gint offset);
212
213 /** Same as above, but throws an exception if the offset is out of bounds. */
214 extern guint tvb_ensure_length_remaining(const tvbuff_t*, const gint offset);
215
216 /* Checks (w/o throwing exception) that the bytes referred to by
217  * 'offset'/'length' actually exist in the buffer */
218 extern gboolean tvb_bytes_exist(const tvbuff_t*, const gint offset, const gint length);
219
220 /** Checks that the bytes referred to by 'offset'/'length' actually exist
221  * in the buffer, and throws an exception if they aren't. */
222 extern void tvb_ensure_bytes_exist(const tvbuff_t *tvb, const gint offset, const gint length);
223
224 /* Checks (w/o throwing exception) that offset exists in buffer */
225 extern gboolean tvb_offset_exists(const tvbuff_t*, const gint offset);
226
227 /* Get reported length of buffer */
228 extern guint tvb_reported_length(const tvbuff_t*);
229
230 /** Computes bytes of reported packet data to end of buffer, from offset
231  * (which can be negative, to indicate bytes from end of buffer). Function
232  * returns -1 to indicate that offset is out of bounds. No exception is
233  * thrown. */
234 extern gint tvb_reported_length_remaining(const tvbuff_t *tvb, const gint offset);
235
236 /** Set the reported length of a tvbuff to a given value; used for protocols
237    whose headers contain an explicit length and where the calling
238    dissector's payload may include padding as well as the packet for
239    this protocol.
240
241    Also adjusts the data length. */
242 extern void tvb_set_reported_length(tvbuff_t*, const guint);
243
244 extern guint tvb_offset_from_real_beginning(const tvbuff_t *tvb);
245
246 /* Returns the offset from the first byte of real data. */
247 extern gint tvb_raw_offset(tvbuff_t *tvb);
248
249 /************** START OF ACCESSORS ****************/
250 /* All accessors will throw an exception if appropriate */
251
252 extern guint8  tvb_get_guint8(tvbuff_t*, const gint offset);
253
254 extern guint16 tvb_get_ntohs(tvbuff_t*, const gint offset);
255 extern guint32 tvb_get_ntoh24(tvbuff_t*, const gint offset);
256 extern guint32 tvb_get_ntohl(tvbuff_t*, const gint offset);
257 extern guint64 tvb_get_ntoh40(tvbuff_t*, const gint offset);
258 extern guint64 tvb_get_ntoh48(tvbuff_t*, const gint offset);
259 extern guint64 tvb_get_ntoh56(tvbuff_t*, const gint offset);
260 extern guint64 tvb_get_ntoh64(tvbuff_t*, const gint offset);
261 extern gfloat tvb_get_ntohieee_float(tvbuff_t*, const gint offset);
262 extern gdouble tvb_get_ntohieee_double(tvbuff_t*, const gint offset);
263
264 extern guint16 tvb_get_letohs(tvbuff_t*, const gint offset);
265 extern guint32 tvb_get_letoh24(tvbuff_t*, const gint offset);
266 extern guint32 tvb_get_letohl(tvbuff_t*, const gint offset);
267 extern guint64 tvb_get_letoh40(tvbuff_t*, const gint offset);
268 extern guint64 tvb_get_letoh48(tvbuff_t*, const gint offset);
269 extern guint64 tvb_get_letoh56(tvbuff_t*, const gint offset);
270 extern guint64 tvb_get_letoh64(tvbuff_t*, const gint offset);
271 extern gfloat tvb_get_letohieee_float(tvbuff_t*, const gint offset);
272 extern gdouble tvb_get_letohieee_double(tvbuff_t*, const gint offset);
273
274 /**
275  * Fetch an IPv4 address, in network byte order.
276  * We do *not* convert it to host byte order; we leave it in
277  * network byte order, as that's what its callers expect. */
278 extern guint32 tvb_get_ipv4(tvbuff_t*, const gint offset);
279
280 /* Fetch an IPv6 address. */
281 extern void tvb_get_ipv6(tvbuff_t*, const gint offset, struct e_in6_addr *addr);
282
283 /* Fetch a GUID. */
284 extern void tvb_get_ntohguid(tvbuff_t *tvb, const gint offset, e_guid_t *guid);
285 extern void tvb_get_letohguid(tvbuff_t *tvb, const gint offset, e_guid_t *guid);
286 extern void tvb_get_guid(tvbuff_t *tvb, const gint offset, e_guid_t *guid, const guint representation);
287
288 /* Fetch a specified number of bits from bit offset in a tvb */
289 extern guint8 tvb_get_bits8(tvbuff_t *tvb, gint bit_offset, const gint no_of_bits);
290 extern guint16 tvb_get_bits16(tvbuff_t *tvb, gint bit_offset, const gint no_of_bits, const gboolean little_endian);
291 extern guint32 tvb_get_bits32(tvbuff_t *tvb, gint bit_offset, const gint no_of_bits, const gboolean little_endian);
292 extern guint64 tvb_get_bits64(tvbuff_t *tvb, gint bit_offset, const gint no_of_bits, const gboolean little_endian);
293
294 /* Fetch a specified number of bits from bit offset in a tvb, but allow number
295  * of bits to range between 1 and 32. If the requested number of bits is known
296  * beforehand, or its range can be handled by a single function of the group
297  * above, use one of them instead.
298  */
299 extern guint32 tvb_get_bits(tvbuff_t *tvb, const gint bit_offset, const gint no_of_bits, const gboolean little_endian);
300
301 void tvb_get_bits_buf(tvbuff_t *tvb, gint bit_offset, gint no_of_bits, guint8 *buf, gboolean lsb0);
302 guint8 *ep_tvb_get_bits(tvbuff_t *tvb, gint bit_offset, gint no_of_bits, gboolean lsb0);
303
304 /** Returns target for convenience. Does not suffer from possible
305  * expense of tvb_get_ptr(), since this routine is smart enough
306  * to copy data in chunks if the request range actually exists in
307  * different TVBUFF_REAL_DATA tvbuffs. This function assumes that the
308  * target memory is already allocated; it does not allocate or free the
309  * target memory. */
310 extern void* tvb_memcpy(tvbuff_t*, void* target, const gint offset, size_t length);
311
312 /** It is the user's responsibility to g_free() the memory allocated by
313  * tvb_memdup(). Calls tvb_memcpy() */
314 extern void* tvb_memdup(tvbuff_t*, const gint offset, size_t length);
315
316 /* Same as above but the buffer returned from this function does not have to
317 * be freed. It will be automatically freed after the packet is dissected.
318 * Buffers allocated by this function are NOT persistent.
319 */
320 extern void* ep_tvb_memdup(tvbuff_t *tvb, const gint offset, size_t length);
321
322 /** WARNING! This function is possibly expensive, temporarily allocating
323  * another copy of the packet data. Furthermore, it's dangerous because once
324  * this pointer is given to the user, there's no guarantee that the user will
325  * honor the 'length' and not overstep the boundaries of the buffer.
326  *
327  * If you're thinking of using tvb_get_ptr, STOP WHAT YOU ARE DOING
328  * IMMEDIATELY. Go take a break. Consider that tvb_get_ptr hands you
329  * a raw, unprotected pointer that you can easily use to create a
330  * security vulnerability or otherwise crash Wireshark. Then consider
331  * that you can probably find a function elsewhere in this file that
332  * does exactly what you want in a much more safe and robust manner.
333  *
334  * The returned pointer is data that is internal to the tvbuff, so do not
335  * attempt to free it. Don't modify the data, either, because another tvbuff
336  * that might be using this tvbuff may have already copied that portion of
337  * the data (sometimes tvbuff's need to make copies of data, but that's the
338  * internal implementation that you need not worry about). Assume that the
339  * guint8* points to read-only data that the tvbuff manages.
340  *
341  * Return a pointer into our buffer if the data asked for via 'offset'/'length'
342  * is contiguous (which might not be the case for TVBUFF_COMPOSITE). If the
343  * data is not contiguous, a tvb_memdup() is called for the entire buffer
344  * and the pointer to the newly-contiguous data is returned. This dynamically-
345  * allocated memory will be freed when the tvbuff is freed, after the
346  * tvbuff_free_cb_t() is called, if any. */
347 extern const guint8* tvb_get_ptr(tvbuff_t*, const gint offset, const gint length);
348
349 /** Find first occurence of any of the needles in tvbuff, starting at offset.
350  * Searches at most maxlength number of bytes; if maxlength is -1, searches
351  * to end of tvbuff.
352  * Returns the offset of the found needle, or -1 if not found.
353  * Will not throw an exception, even if maxlength exceeds boundary of tvbuff;
354  * in that case, -1 will be returned if the boundary is reached before
355  * finding needle. */
356 extern gint tvb_find_guint8(tvbuff_t*, const gint offset, const gint maxlength,
357     const guint8 needle);
358
359 /** Find first occurence of any of the needles in tvbuff, starting at offset.
360  * Searches at most maxlength number of bytes. Returns the offset of the
361  * found needle, or -1 if not found and the found needle.
362  * Will not throw an exception, even if
363  * maxlength exceeds boundary of tvbuff; in that case, -1 will be returned if
364  * the boundary is reached before finding needle. */
365 extern gint tvb_pbrk_guint8(tvbuff_t *, const gint offset, const gint maxlength,
366     const guint8 *needles, guchar *found_needle);
367
368 /** Find size of stringz (NUL-terminated string) by looking for terminating
369  * NUL.  The size of the string includes the terminating NUL.
370  *
371  * If the NUL isn't found, it throws the appropriate exception.
372  */
373 extern guint tvb_strsize(tvbuff_t *tvb, const gint offset);
374
375 /** Find length of string by looking for end of zero terminated string, up to
376  * 'maxlength' characters'; if 'maxlength' is -1, searches to end
377  * of tvbuff.
378  * Returns -1 if 'maxlength' reached before finding EOS. */
379 extern gint tvb_strnlen(tvbuff_t*, const gint offset, const guint maxlength);
380
381 /** Convert a string from Unicode to ASCII.  At the moment we fake it by
382  * assuming all characters are ASCII  )-:  The len parameter is the number
383  * of guint16's to convert from Unicode.
384  *
385  * XXX - These functions have been superceded by tvb_get_unicode_string()
386  *       and tvb_get_ephemeral_unicode_string()
387  *
388  * tvb_fake_unicode() returns a buffer allocated by g_malloc() and must
389  *                    be g_free() by the caller.
390  * tvb_get_ephemeral_faked_unicode() returns a buffer that does not need
391  *                    to be explicitely freed. Instead this buffer is
392  *                    automatically freed when wireshark starts dissecting
393  *                    the next packet.
394  */
395 extern char *tvb_fake_unicode(tvbuff_t *tvb, int offset, const int len,
396                               const gboolean little_endian);
397 extern char *tvb_get_ephemeral_faked_unicode(tvbuff_t *tvb, int offset, const int len,
398                               const gboolean little_endian);
399
400 /**
401  * Format the data in the tvb from offset for size ...
402  */
403 extern gchar * tvb_format_text(tvbuff_t *tvb, const gint offset, const gint size);
404
405 /**
406  * Like "tvb_format_text()", but for 'wsp'; don't show
407  * the characters as C-style escapes.
408  */
409 extern gchar * tvb_format_text_wsp(tvbuff_t *tvb, const gint offset, const gint size);
410
411 /**
412  * Like "tvb_format_text()", but for null-padded strings; don't show
413  * the null padding characters as "\000".
414  */
415 extern gchar *tvb_format_stringzpad(tvbuff_t *tvb, const gint offset, const gint size);
416
417 /**
418  * Like "tvb_format_text_wsp()", but for null-padded strings; don't show
419  * the null padding characters as "\000".
420  */
421 extern gchar *tvb_format_stringzpad_wsp(tvbuff_t *tvb, const gint offset, const gint size);
422
423
424 /**
425  * Given a tvbuff, an offset, and a length, allocate a buffer big enough
426  * to hold a non-null-terminated string of that length at that offset,
427  * plus a trailing zero, copy the string into it, and return a pointer
428  * to the string.
429  *
430  * Throws an exception if the tvbuff ends before the string does.
431  *
432  * tvb_get_string()  returns a string allocated by g_malloc() and therefore
433  *                   MUST be g_free() by the caller in order not to leak
434  *                   memory.
435  *
436  * tvb_get_unicode_string() Unicode (UTF-16) version of above
437  *
438  * tvb_get_ephemeral_string() returns a string that does not need to be freed,
439  *                   instead it will automatically be freed once the next
440  *                   packet is dissected.
441  *
442  * tvb_get_ephemeral_string_enc() takes a string encoding as well, and
443  *                   converts to UTF-8 from the encoding (only UTF-8 and
444  *                   EBCDIC supported)
445  *
446  * tvb_get_ephemeral_unicode_string() Unicode (UTF-16) version of above
447  *
448  * tvb_get_seasonal_string() returns a string that does not need to be freed,
449  *                   instead it will automatically be freed when a new capture
450  *                   or file is opened.
451  */
452 extern guint8 *tvb_get_string(tvbuff_t *tvb, const gint offset, const gint length);
453 extern gchar  *tvb_get_unicode_string(tvbuff_t *tvb, const gint offset, gint length, const guint encoding);
454 extern guint8 *tvb_get_ephemeral_string(tvbuff_t *tvb, const gint offset, const gint length);
455 extern guint8 *tvb_get_ephemeral_string_enc(tvbuff_t *tvb, const gint offset,
456     const gint length, const gint encoding);
457 extern gchar  *tvb_get_ephemeral_unicode_string(tvbuff_t *tvb, const gint offset, gint length, const guint encoding);
458 extern guint8 *tvb_get_seasonal_string(tvbuff_t *tvb, const gint offset, const gint length);
459
460
461 /**
462  * Given a tvbuff and an offset, with the offset assumed to refer to
463  * a null-terminated string, find the length of that string (and throw
464  * an exception if the tvbuff ends before we find the null), allocate
465  * a buffer big enough to hold the string, copy the string into it,
466  * and return a pointer to the string.  Also return the length of the
467  * string (including the terminating null) through a pointer.
468  *
469  * tvb_get_stringz() returns a string allocated by g_malloc() and therefore
470  *                   MUST be g_free() by the caller in order not to leak
471  *                   memory.
472  *
473  * tvb_get_stringz_enc() takes a string encoding as well, and converts to
474  *                   UTF-8 from the encoding (only UTF-8 and EBCDIC supported)
475  *
476  * tvb_get_const_stringz() returns a constant (unmodifiable) string that does
477  *                   not need to be freed, instead it will automatically be
478  *                   freed once the next packet is dissected.  It is slightly
479  *                   more efficient than the other routines.
480  *
481  * tvb_get_ephemeral_stringz() returns a string that does not need to be freed,
482  *                   instead it will automatically be freed once the next
483  *                   packet is dissected.
484  *
485  * tvb_get_ephemeral_stringz_enc() takes a string encoding as well, and
486  *                   converts to UTF-8 from the encoding (only UTF-8 and
487  *                   EBCDIC supported)
488  *                   packet is dissected.
489  *
490  * tvb_get_ephemeral_unicode_stringz() Unicode (UTF-16) version of above
491  *
492  * tvb_get_seasonal_stringz() returns a string that does not need to be freed,
493  *                   instead it will automatically be freed when a new capture
494  *                   or file is opened.
495  */
496 extern guint8 *tvb_get_stringz(tvbuff_t *tvb, const gint offset, gint *lengthp);
497 extern guint8 *tvb_get_stringz_enc(tvbuff_t *tvb, const gint offset, gint *lengthp, gint encoding);
498 extern const guint8 *tvb_get_const_stringz(tvbuff_t *tvb, const gint offset, gint *lengthp);
499 extern guint8 *tvb_get_ephemeral_stringz(tvbuff_t *tvb, const gint offset, gint *lengthp);
500 extern guint8 *tvb_get_ephemeral_stringz_enc(tvbuff_t *tvb, const gint offset, gint *lengthp, gint encoding);
501 extern gchar  *tvb_get_ephemeral_unicode_stringz(tvbuff_t *tvb, const gint offset, gint *lengthp, const guint encoding);
502 extern guint8 *tvb_get_seasonal_stringz(tvbuff_t *tvb, const gint offset, gint *lengthp);
503
504 /** Looks for a stringz (NUL-terminated string) in tvbuff and copies
505  * no more than bufsize number of bytes, including terminating NUL, to buffer.
506  * Returns length of string (not including terminating NUL), or -1 if the string was
507  * truncated in the buffer due to not having reached the terminating NUL.
508  * In this way, it acts like g_snprintf().
509  *
510  * When processing a packet where the remaining number of bytes is less
511  * than bufsize, an exception is not thrown if the end of the packet
512  * is reached before the NUL is found. If no NUL is found before reaching
513  * the end of the short packet, -1 is still returned, and the string
514  * is truncated with a NUL, albeit not at buffer[bufsize - 1], but
515  * at the correct spot, terminating the string.
516  */
517 extern gint tvb_get_nstringz(tvbuff_t *tvb, const gint offset, const guint bufsize,
518     guint8* buffer);
519
520 /** Like tvb_get_nstringz(), but never returns -1. The string is guaranteed to
521  * have a terminating NUL. If the string was truncated when copied into buffer,
522  * a NUL is placed at the end of buffer to terminate it.
523  *
524  * bufsize MUST be greater than 0.
525  */
526 extern gint tvb_get_nstringz0(tvbuff_t *tvb, const gint offset, const guint bufsize,
527     guint8* buffer);
528
529 /**
530  * Given a tvbuff, an offset into the tvbuff, and a length that starts
531  * at that offset (which may be -1 for "all the way to the end of the
532  * tvbuff"), find the end of the (putative) line that starts at the
533  * specified offset in the tvbuff, going no further than the specified
534  * length.
535  *
536  * Return the length of the line (not counting the line terminator at
537  * the end), or, if we don't find a line terminator:
538  *
539  *      if "deseg" is true, return -1;
540  *
541  *      if "deseg" is false, return the amount of data remaining in
542  *      the buffer.
543  *
544  * Set "*next_offset" to the offset of the character past the line
545  * terminator, or past the end of the buffer if we don't find a line
546  * terminator.  (It's not set if we return -1.)
547  */
548 extern gint tvb_find_line_end(tvbuff_t *tvb, const gint offset, int len,
549     gint *next_offset, const gboolean desegment);
550
551 /**
552  * Given a tvbuff, an offset into the tvbuff, and a length that starts
553  * at that offset (which may be -1 for "all the way to the end of the
554  * tvbuff"), find the end of the (putative) line that starts at the
555  * specified offset in the tvbuff, going no further than the specified
556  * length.
557  *
558  * However, treat quoted strings inside the buffer specially - don't
559  * treat newlines in quoted strings as line terminators.
560  *
561  * Return the length of the line (not counting the line terminator at
562  * the end), or the amount of data remaining in the buffer if we don't
563  * find a line terminator.
564  *
565  * Set "*next_offset" to the offset of the character past the line
566  * terminator, or past the end of the buffer if we don't find a line
567  * terminator.
568  */
569 extern gint tvb_find_line_end_unquoted(tvbuff_t *tvb, const gint offset, int len,
570     gint *next_offset);
571
572 /**
573  * Copied from the mgcp dissector. (This function should be moved to /epan )
574  * tvb_skip_wsp - Returns the position in tvb of the first non-whitespace
575  *                character following offset or offset + maxlength -1 whichever
576  *                is smaller.
577  *
578  * Parameters:
579  * tvb - The tvbuff in which we are skipping whitespace.
580  * offset - The offset in tvb from which we begin trying to skip whitespace.
581  * maxlength - The maximum distance from offset that we may try to skip
582  * whitespace.
583  *
584  * Returns: The position in tvb of the first non-whitespace
585  *          character following offset or offset + maxlength -1 whichever
586  *          is smaller.
587  */
588
589 extern gint tvb_skip_wsp(tvbuff_t* tvb, const gint offset, const gint maxlength);
590
591 extern gint tvb_skip_wsp_return(tvbuff_t* tvb, const gint offset);
592
593 /**
594  * Call strncmp after checking if enough chars left, returning 0 if
595  * it returns 0 (meaning "equal") and -1 otherwise, otherwise return -1.
596  */
597 extern gint tvb_strneql(tvbuff_t *tvb, const gint offset, const gchar *str,
598     const size_t size);
599
600 /**
601  * Call g_ascii_strncasecmp after checking if enough chars left, returning
602  * 0 if it returns 0 (meaning "equal") and -1 otherwise, otherwise return -1.
603  */
604 extern gint tvb_strncaseeql(tvbuff_t *tvb, const gint offset, const gchar *str,
605     const size_t size);
606
607 /**
608  * Call memcmp after checking if enough chars left, returning 0 if
609  * it returns 0 (meaning "equal") and -1 otherwise, otherwise return -1.
610  */
611 extern gint tvb_memeql(tvbuff_t *tvb, const gint offset, const guint8 *str,
612     size_t size);
613
614 /**
615  * Format a bunch of data from a tvbuff as bytes, returning a pointer
616  * to the string with the formatted data, with "punct" as a byte
617  * separator.
618  */
619 extern gchar *tvb_bytes_to_str_punct(tvbuff_t *tvb, const gint offset, const gint len,
620     const gchar punct);
621
622 /**
623  * Format a bunch of data from a tvbuff as bytes, returning a pointer
624  * to the string with the formatted data.
625  */
626 extern gchar *tvb_bytes_to_str(tvbuff_t *tvb, const gint offset, const gint len);
627
628 /**
629  * Given a tvbuff, an offset into the tvbuff, and a length that starts
630  * at that offset (which may be -1 for "all the way to the end of the
631  * tvbuff"), fetch BCD encoded digits from a tvbuff starting from either
632  * the low or high half byte, formating the digits according to an input digit set,
633  * if NUll a default digit set of 0-9 returning "?" for overdecadic digits will be used.
634  * A pointer to the EP allocated string will be returned.
635  * Note a tvbuff content of 0xf is considered a 'filler' and will end the conversion.
636  */
637 typedef struct dgt_set_t
638 {
639         const unsigned char out[15];
640 }
641 dgt_set_t;
642
643 extern const gchar *tvb_bcd_dig_to_ep_str(tvbuff_t *tvb, const gint offset, const gint len, dgt_set_t *dgt, gboolean skip_first);
644
645 struct tvbuff *tvb_get_ds_tvb(tvbuff_t *tvb);
646
647 /** Locate a sub-tvbuff within another tvbuff, starting at position
648  * 'haystack_offset'. Returns the index of the beginning of 'needle' within
649  * 'haystack', or -1 if 'needle' is not found. The index is relative
650  * to the start of 'haystack', not 'haystack_offset'. */
651 extern gint tvb_find_tvb(tvbuff_t *haystack_tvb, tvbuff_t *needle_tvb,
652         const gint haystack_offset);
653
654 /**
655  * Uncompresses a zlib compressed packet inside a tvbuff at offset with
656  * length comprlen.  Returns an uncompressed tvbuffer if uncompression
657  * succeeded or NULL if uncompression failed.
658  */
659 extern tvbuff_t* tvb_uncompress(tvbuff_t *tvb, const int offset,  int comprlen);
660
661 /**
662  * Uncompresses a zlib compressed packet inside a tvbuff at offset with
663  * length comprlen.  Returns an uncompressed tvbuffer attached to tvb if uncompression
664  * succeeded or NULL if uncompression failed.
665  */
666 extern tvbuff_t* tvb_child_uncompress(tvbuff_t *parent, tvbuff_t *tvb, const int offset, int comprlen);
667
668 /************** END OF ACCESSORS ****************/
669
670 #endif /* __TVBUFF_H__ */