strcasecmp(), strncasecmp(), g_strcasecmp(), and g_strncasecmp() delenda
[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 #ifdef NEED_G_ASCII_STRCASECMP_H
44 #include "g_ascii_strcasecmp.h"
45 #endif
46
47 /** @file
48  * "testy, virtual(-izable) buffer".  They are testy in that they get mad when
49  * an attempt is made to access data beyond the bounds of their array. In that
50  * case, they throw an exception.
51  * 
52  * They are virtualizable in that new tvbuff's can be made from other tvbuffs, 
53  * while only the original tvbuff may have data. That is, the new tvbuff has 
54  * virtual data.
55  */
56
57
58 /** The different types of tvbuff's */
59 typedef enum {
60         TVBUFF_REAL_DATA,
61         TVBUFF_SUBSET,
62         TVBUFF_COMPOSITE
63 } tvbuff_type;
64
65 typedef struct {
66         /* The backing tvbuff_t */
67         struct tvbuff   *tvb;
68
69         /* The offset/length of 'tvb' to which I'm privy */
70         guint           offset;
71         guint           length;
72
73 } tvb_backing_t;
74
75 typedef struct {
76         GSList          *tvbs;
77
78         /* Used for quick testing to see if this
79          * is the tvbuff that a COMPOSITE is
80          * interested in. */
81         guint           *start_offsets;
82         guint           *end_offsets;
83
84 } tvb_comp_t;
85
86 typedef void (*tvbuff_free_cb_t)(void*);
87
88 typedef struct tvbuff {
89         /* Record-keeping */
90         tvbuff_type             type;
91         gboolean                initialized;
92         guint                   usage_count;
93         struct tvbuff           *ds_tvb;  /* data source top-level tvbuff */
94
95         /* The tvbuffs in which this tvbuff is a member
96          * (that is, a backing tvbuff for a TVBUFF_SUBSET
97          * or a member for a TVB_COMPOSITE) */
98         GSList                  *used_in;
99
100         /* TVBUFF_SUBSET and TVBUFF_COMPOSITE keep track
101          * of the other tvbuff's they use */
102         union {
103                 tvb_backing_t   subset;
104                 tvb_comp_t      composite;
105         } tvbuffs;
106
107         /* We're either a TVBUFF_REAL_DATA or a
108          * TVBUFF_SUBSET that has a backing buffer that
109          * has real_data != NULL, or a TVBUFF_COMPOSITE
110          * which has flattened its data due to a call
111          * to tvb_get_ptr().
112          */
113         const guint8            *real_data;
114
115         /* Length of virtual buffer (and/or real_data). */
116         guint                   length;
117
118         /* Reported length. */
119         guint                   reported_length;
120
121         /* Offset from beginning of first TVBUFF_REAL. */
122         gint                    raw_offset;
123
124         /* Func to call when actually freed */
125         tvbuff_free_cb_t        free_cb;
126 } tvbuff_t;
127
128
129
130 /** TVBUFF_REAL_DATA contains a guint8* that points to real data.
131  * The data is allocated and contiguous.
132  *
133  * TVBUFF_SUBSET has a backing tvbuff. The TVBUFF_SUBSET is a "window"
134  * through which the program sees only a portion of the backing tvbuff.
135  *
136  * TVBUFF_COMPOSITE combines multiple tvbuffs sequentually to produce
137  * a larger byte array.
138  *
139  * tvbuff's of any type can be used as the backing-tvbuff of a
140  * TVBUFF_SUBSET or as the member of a TVBUFF_COMPOSITE.
141  * TVBUFF_COMPOSITEs can have member-tvbuffs of different types.
142  *
143  * Once a tvbuff is create/initialized/finalized, the tvbuff is read-only.
144  * That is, it cannot point to any other data. A new tvbuff must be created if
145  * you want a tvbuff that points to other data.
146  */
147
148
149 /** "class" initialization. Called once during execution of program
150  * so that tvbuff.c can initialize its data. */
151 extern void tvbuff_init(void);
152
153 /** "class" cleanup. Called once during execution of program
154  * so that tvbuff.c can clean up its data. */
155 extern void tvbuff_cleanup(void);
156
157
158 /** Returns a pointer to a newly initialized tvbuff. Note that
159  * tvbuff's of types TVBUFF_SUBSET and TVBUFF_COMPOSITE
160  * require further initialization via the appropriate functions */
161 extern tvbuff_t* tvb_new(tvbuff_type);
162
163 /** Marks a tvbuff for freeing. The guint8* data of a TVBUFF_REAL_DATA
164  * is *never* freed by the tvbuff routines. The tvbuff itself is actually freed
165  * once its usage count drops to 0.
166  *
167  * Usage counts increment for any time the tvbuff is
168  * used as a member of another tvbuff, i.e., as the backing buffer for
169  * a TVBUFF_SUBSET or as a member of a TVBUFF_COMPOSITE.
170  *
171  * Although you may call tvb_free(), the tvbuff may still be in use
172  * by other tvbuff's (TVBUFF_SUBSET or TVBUFF_COMPOSITE), so it is not
173  * safe, unless you know otherwise, to free your guint8* data. If you
174  * cannot be sure that your TVBUFF_REAL_DATA is not in use by another
175  * tvbuff, register a callback with tvb_set_free_cb(); when your tvbuff
176  * is _really_ freed, then your callback will be called, and at that time
177  * you can free your original data.
178  *
179  * The caller can artificially increment/decrement the usage count
180  * with tvbuff_increment_usage_count()/tvbuff_decrement_usage_count().
181  */
182 extern void tvb_free(tvbuff_t*);
183
184 /** Free the tvbuff_t and all tvbuff's created from it. */
185 extern void tvb_free_chain(tvbuff_t*);
186
187 /** Both return the new usage count, after the increment or decrement */
188 extern guint tvb_increment_usage_count(tvbuff_t*, guint count);
189
190 /** If a decrement causes the usage count to drop to 0, a the tvbuff
191  * is immediately freed. Be sure you know exactly what you're doing
192  * if you decide to use this function, as another tvbuff could
193  * still have a pointer to the just-freed tvbuff, causing corrupted data
194  * or a segfault in the future */
195 extern guint tvb_decrement_usage_count(tvbuff_t*, guint count);
196
197 /** Set a callback function to call when a tvbuff is actually freed
198  * (once the usage count drops to 0). One argument is passed to
199  * that callback --- a void* that points to the real data.
200  * Obviously, this only applies to a TVBUFF_REAL_DATA tvbuff. */
201 extern void tvb_set_free_cb(tvbuff_t*, tvbuff_free_cb_t);
202
203
204 /** Attach a TVBUFF_REAL_DATA tvbuff to a parent tvbuff. This connection
205  * is used during a tvb_free_chain()... the "child" TVBUFF_REAL_DATA acts
206  * as if is part of the chain-of-creation of the parent tvbuff, although it
207  * isn't. This is useful if you need to take the data from some tvbuff,
208  * run some operation on it, like decryption or decompression, and make a new
209  * tvbuff from it, yet want the new tvbuff to be part of the chain. The reality
210  * is that the new tvbuff *is* part of the "chain of creation", but in a way
211  * that these tvbuff routines is ignorant of. Use this function to make
212  * the tvbuff routines knowledgable of this fact. */
213 extern void tvb_set_child_real_data_tvbuff(tvbuff_t* parent, tvbuff_t* child);
214
215 /**Sets parameters for TVBUFF_REAL_DATA. Can throw ReportedBoundsError. */
216 extern void tvb_set_real_data(tvbuff_t*, const guint8* data, guint length,
217     gint reported_length);
218
219 /** Combination of tvb_new() and tvb_set_real_data(). Can throw ReportedBoundsError. */
220 extern tvbuff_t* tvb_new_real_data(const guint8* data, guint length,
221     gint reported_length);
222
223
224 /** Define the subset of the backing buffer to use.
225  *
226  * 'backing_offset' can be negative, to indicate bytes from
227  * the end of the backing buffer.
228  *
229  * 'backing_length' can be 0, although the usefulness of the buffer would
230  * be rather limited.
231  *
232  * 'backing_length' of -1 means "to the end of the backing buffer"
233  *
234  * Will throw BoundsError if 'backing_offset'/'length'
235  * is beyond the bounds of the backing tvbuff.
236  * Can throw ReportedBoundsError. */
237 extern void tvb_set_subset(tvbuff_t* tvb, tvbuff_t* backing,
238                 gint backing_offset, gint backing_length, gint reported_length);
239
240 /** Combination of tvb_new() and tvb_set_subset()
241  * Can throw ReportedBoundsError. */
242 extern tvbuff_t* tvb_new_subset(tvbuff_t* backing,
243                 gint backing_offset, gint backing_length, gint reported_length);
244
245
246 /** Both tvb_composite_append and tvb_composite_prepend can throw
247  * BoundsError if member_offset/member_length goes beyond bounds of
248  * the 'member' tvbuff. */
249
250 /** Append to the list of tvbuffs that make up this composite tvbuff */
251 extern void tvb_composite_append(tvbuff_t* tvb, tvbuff_t* member);
252
253 /** Prepend to the list of tvbuffs that make up this composite tvbuff */
254 extern void tvb_composite_prepend(tvbuff_t* tvb, tvbuff_t* member);
255
256 /** Helper function that calls tvb_new(TVBUFF_COMPOSITE).
257  * Provided only to maintain symmetry with other constructors */
258 extern tvbuff_t* tvb_new_composite(void);
259
260 /** Mark a composite tvbuff as initialized. No further appends or prepends
261  * occur, data access can finally happen after this finalization. */
262 extern void tvb_composite_finalize(tvbuff_t* tvb);
263
264
265 /* Get total length of buffer */
266 extern guint tvb_length(tvbuff_t*);
267
268 /** Computes bytes to end of buffer, from offset (which can be negative,
269  * to indicate bytes from end of buffer). Function returns -1 to
270  * indicate that offset is out of bounds. No exception is thrown. */
271 extern gint tvb_length_remaining(tvbuff_t*, gint offset);
272
273 /** Same as above, but throws an exception if the offset is out of bounds. */
274 extern guint tvb_ensure_length_remaining(tvbuff_t*, gint offset);
275
276 /* Checks (w/o throwing exception) that the bytes referred to by
277  * 'offset'/'length' actually exist in the buffer */
278 extern gboolean tvb_bytes_exist(tvbuff_t*, gint offset, gint length);
279
280 /** Checks that the bytes referred to by 'offset'/'length' actually exist
281  * in the buffer, and throws an exception if they aren't. */
282 extern void tvb_ensure_bytes_exist(tvbuff_t *tvb, gint offset, gint length);
283
284 /* Checks (w/o throwing exception) that offset exists in buffer */
285 extern gboolean tvb_offset_exists(tvbuff_t*, gint offset);
286
287 /* Get reported length of buffer */
288 extern guint tvb_reported_length(tvbuff_t*);
289
290 /** Computes bytes of reported packet data to end of buffer, from offset
291  * (which can be negative, to indicate bytes from end of buffer). Function
292  * returns -1 to indicate that offset is out of bounds. No exception is
293  * thrown. */
294 extern gint tvb_reported_length_remaining(tvbuff_t *tvb, gint offset);
295
296 /** Set the reported length of a tvbuff to a given value; used for protocols
297    whose headers contain an explicit length and where the calling
298    dissector's payload may include padding as well as the packet for
299    this protocol.
300
301    Also adjusts the data length. */
302 extern void tvb_set_reported_length(tvbuff_t*, guint);
303
304 extern int offset_from_real_beginning(tvbuff_t *tvb, int counter);
305
306 /* Returns the offset from the first byte of real data. */
307 #define TVB_RAW_OFFSET(tvb)                     \
308         ((tvb->raw_offset==-1)?(tvb->raw_offset = offset_from_real_beginning(tvb, 0)):tvb->raw_offset)
309
310 /************** START OF ACCESSORS ****************/
311 /* All accessors will throw an exception if appropriate */
312
313 extern guint8  tvb_get_guint8(tvbuff_t*, gint offset);
314
315 extern guint16 tvb_get_ntohs(tvbuff_t*, gint offset);
316 extern guint32 tvb_get_ntoh24(tvbuff_t*, gint offset);
317 extern guint32 tvb_get_ntohl(tvbuff_t*, gint offset);
318 extern guint64 tvb_get_ntoh64(tvbuff_t*, gint offset);
319 extern gfloat tvb_get_ntohieee_float(tvbuff_t*, gint offset);
320 extern gdouble tvb_get_ntohieee_double(tvbuff_t*, gint offset);
321
322 extern guint16 tvb_get_letohs(tvbuff_t*, gint offset);
323 extern guint32 tvb_get_letoh24(tvbuff_t*, gint offset);
324 extern guint32 tvb_get_letohl(tvbuff_t*, gint offset);
325 extern guint64 tvb_get_letoh64(tvbuff_t*, gint offset);
326 extern gfloat tvb_get_letohieee_float(tvbuff_t*, gint offset);
327 extern gdouble tvb_get_letohieee_double(tvbuff_t*, gint offset);
328
329 /**
330  * Fetch an IPv4 address, in network byte order.
331  * We do *not* convert it to host byte order; we leave it in
332  * network byte order, as that's what its callers expect. */
333 extern guint32 tvb_get_ipv4(tvbuff_t*, gint offset);
334
335 /* Fetch an IPv6 address. */
336 extern void tvb_get_ipv6(tvbuff_t*, gint offset, struct e_in6_addr *addr);
337
338 /* Fetch a GUID. */
339 extern void tvb_get_ntohguid(tvbuff_t *tvb, gint offset, e_guid_t *guid);
340 extern void tvb_get_letohguid(tvbuff_t *tvb, gint offset, e_guid_t *guid);
341 extern void tvb_get_guid(tvbuff_t *tvb, gint offset, e_guid_t *guid, gboolean little_endian);
342
343 /* Fetch a specified number of bits from bit offset in a tvb */
344 extern guint8 tvb_get_bits8(tvbuff_t *tvb, gint bit_offset, gint no_of_bits);
345 extern guint16 tvb_get_bits16(tvbuff_t *tvb, gint bit_offset, gint no_of_bits, gboolean little_endian);
346 extern guint32 tvb_get_bits32(tvbuff_t *tvb, gint bit_offset, gint no_of_bits, gboolean little_endian);
347 extern guint64 tvb_get_bits64(tvbuff_t *tvb, gint bit_offset, gint no_of_bits, gboolean little_endian);
348
349 /** Returns target for convenience. Does not suffer from possible
350  * expense of tvb_get_ptr(), since this routine is smart enough
351  * to copy data in chunks if the request range actually exists in
352  * different TVBUFF_REAL_DATA tvbuffs. This function assumes that the
353  * target memory is already allocated; it does not allocate or free the
354  * target memory. */
355 extern void* tvb_memcpy(tvbuff_t*, void* target, gint offset, gint length);
356
357 /** It is the user's responsibility to g_free() the memory allocated by
358  * tvb_memdup(). Calls tvb_memcpy() */
359 extern void* tvb_memdup(tvbuff_t*, gint offset, gint length);
360
361 /* Same as above but the buffer returned from this function does not have to
362 * be freed. It will be automatically freed after the packet is dissected.
363 * Buffers allocated by this function are NOT persistent.
364 */
365 extern void* ep_tvb_memdup(tvbuff_t *tvb, gint offset, gint length);
366
367 /** WARNING! This function is possibly expensive, temporarily allocating
368  * another copy of the packet data. Furthermore, it's dangerous because once
369  * this pointer is given to the user, there's no guarantee that the user will
370  * honor the 'length' and not overstep the boundaries of the buffer.
371  *
372  * The returned pointer is data that is internal to the tvbuff, so do not
373  * attempt to free it. Don't modify the data, either, because another tvbuff
374  * that might be using this tvbuff may have already copied that portion of
375  * the data (sometimes tvbuff's need to make copies of data, but that's the
376  * internal implementation that you need not worry about). Assume that the
377  * guint8* points to read-only data that the tvbuff manages.
378  *
379  * Return a pointer into our buffer if the data asked for via 'offset'/'length'
380  * is contiguous (which might not be the case for TVBUFF_COMPOSITE). If the
381  * data is not contiguous, a tvb_memdup() is called for the entire buffer
382  * and the pointer to the newly-contiguous data is returned. This dynamically-
383  * allocated memory will be freed when the tvbuff is freed, after the
384  * tvbuff_free_cb_t() is called, if any. */
385 extern const guint8* tvb_get_ptr(tvbuff_t*, gint offset, gint length);
386
387 /** Find first occurence of any of the needles in tvbuff, starting at offset.
388  * Searches at most maxlength number of bytes; if maxlength is -1, searches
389  * to end of tvbuff.
390  * Returns the offset of the found needle, or -1 if not found.
391  * Will not throw an exception, even if maxlength exceeds boundary of tvbuff;
392  * in that case, -1 will be returned if the boundary is reached before
393  * finding needle. */
394 extern gint tvb_find_guint8(tvbuff_t*, gint offset, gint maxlength,
395     guint8 needle);
396
397 /** Find first occurence of any of the needles in tvbuff, starting at offset.
398  * Searches at most maxlength number of bytes. Returns the offset of the
399  * found needle, or -1 if not found. Will not throw an exception, even if
400  * maxlength exceeds boundary of tvbuff; in that case, -1 will be returned if
401  * the boundary is reached before finding needle. */
402 extern gint tvb_pbrk_guint8(tvbuff_t *, gint offset, gint maxlength,
403     const guint8 *needles);
404
405 /** Find size of stringz (NUL-terminated string) by looking for terminating
406  * NUL.  The size of the string includes the terminating NUL.
407  *
408  * If the NUL isn't found, it throws the appropriate exception.
409  */
410 extern guint tvb_strsize(tvbuff_t *tvb, gint offset);
411
412 /** Find length of string by looking for end of zero terminated string, up to
413  * 'maxlength' characters'; if 'maxlength' is -1, searches to end
414  * of tvbuff.
415  * Returns -1 if 'maxlength' reached before finding EOS. */
416 extern gint tvb_strnlen(tvbuff_t*, gint offset, guint maxlength);
417
418 /** Convert a string from Unicode to ASCII.  At the moment we fake it by
419  * assuming all characters are ASCII  )-:  The len parameter is the number 
420  * of guint16's to convert from Unicode. 
421  *
422  * tvb_fake_unicode() returns a buffer allocated by g_malloc() and must
423  *                    be g_free() by the caller.
424  * tvb_get_ephemeral_faked_unicode() returns a buffer that does not need
425  *                    to be explicitely freed. Instead this buffer is
426  *                    automatically freed when wireshark starts dissecting
427  *                    the next packet.
428  */
429 extern char *tvb_fake_unicode(tvbuff_t *tvb, int offset, int len,
430                               gboolean little_endian);
431 extern char *tvb_get_ephemeral_faked_unicode(tvbuff_t *tvb, int offset, int len,
432                               gboolean little_endian);
433
434 /**
435  * Format the data in the tvb from offset for size ...
436  */
437 extern gchar * tvb_format_text(tvbuff_t *tvb, gint offset, gint size);
438
439 /**
440  * Like "tvb_format_text()", but for 'wsp'; don't show
441  * the characters as C-style escapes.
442  */
443 extern gchar * tvb_format_text_wsp(tvbuff_t *tvb, gint offset, gint size);
444
445 /**
446  * Like "tvb_format_text()", but for null-padded strings; don't show
447  * the null padding characters as "\000".
448  */
449 extern gchar *tvb_format_stringzpad(tvbuff_t *tvb, gint offset, gint size);
450
451
452 /**
453  * Given a tvbuff, an offset, and a length, allocate a buffer big enough
454  * to hold a non-null-terminated string of that length at that offset,
455  * plus a trailing zero, copy the string into it, and return a pointer
456  * to the string.
457  *
458  * Throws an exception if the tvbuff ends before the string does.
459  *
460  * tvb_get_string()  returns a string allocated by g_malloc() and therefore
461  *                   MUST be g_free() by the caller in order not to leak
462  *                   memory.
463  *
464  * tvb_get_ephemeral_string() returns a string that does not need to be freed,
465  *                   instead it will automatically be freed once the next
466  *                   packet is dissected.
467  */
468 extern guint8 *tvb_get_string(tvbuff_t *tvb, gint offset, gint length);
469 extern guint8 *tvb_get_ephemeral_string(tvbuff_t *tvb, gint offset, gint length);
470
471
472 /**
473  * Given a tvbuff and an offset, with the offset assumed to refer to
474  * a null-terminated string, find the length of that string (and throw
475  * an exception if the tvbuff ends before we find the null), allocate
476  * a buffer big enough to hold the string, copy the string into it,
477  * and return a pointer to the string.  Also return the length of the
478  * string (including the terminating null) through a pointer.
479  *
480  * tvb_get_stringz() returns a string allocated by g_malloc() and therefore
481  *                   MUST be g_free() by the caller in order not to leak
482  *                   memory.
483  *
484  * tvb_get_ephemeral_stringz() returns a string that does not need to be freed,
485  *                   instead it will automatically be freed once the next
486  *                   packet is dissected.
487  */
488 extern guint8 *tvb_get_stringz(tvbuff_t *tvb, gint offset, gint *lengthp);
489 extern guint8 *tvb_get_ephemeral_stringz(tvbuff_t *tvb, gint offset, gint *lengthp);
490
491 /** Looks for a stringz (NUL-terminated string) in tvbuff and copies
492  * no more than bufsize number of bytes, including terminating NUL, to buffer.
493  * Returns length of string (not including terminating NUL), or -1 if the string was
494  * truncated in the buffer due to not having reached the terminating NUL.
495  * In this way, it acts like g_snprintf().
496  *
497  * When processing a packet where the remaining number of bytes is less
498  * than bufsize, an exception is not thrown if the end of the packet
499  * is reached before the NUL is found. If no NUL is found before reaching
500  * the end of the short packet, -1 is still returned, and the string
501  * is truncated with a NUL, albeit not at buffer[bufsize - 1], but
502  * at the correct spot, terminating the string.
503  */
504 extern gint tvb_get_nstringz(tvbuff_t *tvb, gint offset, guint bufsize,
505     guint8* buffer);
506
507 /** Like tvb_get_nstringz(), but never returns -1. The string is guaranteed to
508  * have a terminating NUL. If the string was truncated when copied into buffer,
509  * a NUL is placed at the end of buffer to terminate it.
510  *
511  * bufsize MUST be greater than 0.
512  */
513 extern gint tvb_get_nstringz0(tvbuff_t *tvb, gint offset, guint bufsize,
514     guint8* buffer);
515
516 /**
517  * Given a tvbuff, an offset into the tvbuff, and a length that starts
518  * at that offset (which may be -1 for "all the way to the end of the
519  * tvbuff"), find the end of the (putative) line that starts at the
520  * specified offset in the tvbuff, going no further than the specified
521  * length.
522  *
523  * Return the length of the line (not counting the line terminator at
524  * the end), or, if we don't find a line terminator:
525  *
526  *      if "deseg" is true, return -1;
527  *
528  *      if "deseg" is false, return the amount of data remaining in
529  *      the buffer.
530  *
531  * Set "*next_offset" to the offset of the character past the line
532  * terminator, or past the end of the buffer if we don't find a line
533  * terminator.  (It's not set if we return -1.)
534  */
535 extern gint tvb_find_line_end(tvbuff_t *tvb, gint offset, int len,
536     gint *next_offset, gboolean desegment);
537
538 /**
539  * Given a tvbuff, an offset into the tvbuff, and a length that starts
540  * at that offset (which may be -1 for "all the way to the end of the
541  * tvbuff"), find the end of the (putative) line that starts at the
542  * specified offset in the tvbuff, going no further than the specified
543  * length.
544  *
545  * However, treat quoted strings inside the buffer specially - don't
546  * treat newlines in quoted strings as line terminators.
547  *
548  * Return the length of the line (not counting the line terminator at
549  * the end), or the amount of data remaining in the buffer if we don't
550  * find a line terminator.
551  *
552  * Set "*next_offset" to the offset of the character past the line
553  * terminator, or past the end of the buffer if we don't find a line
554  * terminator.
555  */
556 extern gint tvb_find_line_end_unquoted(tvbuff_t *tvb, gint offset, int len,
557     gint *next_offset);
558
559 /**
560  * Call strncmp after checking if enough chars left, returning 0 if
561  * it returns 0 (meaning "equal") and -1 otherwise, otherwise return -1.
562  */
563 extern gint tvb_strneql(tvbuff_t *tvb, gint offset, const gchar *str,
564     gint size);
565
566 /**
567  * Call g_ascii_strncasecmp after checking if enough chars left, returning
568  * 0 if it returns 0 (meaning "equal") and -1 otherwise, otherwise return -1.
569  */
570 extern gint tvb_strncaseeql(tvbuff_t *tvb, gint offset, const gchar *str,
571     gint size);
572
573 /**
574  * Call memcmp after checking if enough chars left, returning 0 if
575  * it returns 0 (meaning "equal") and -1 otherwise, otherwise return -1.
576  */
577 extern gint tvb_memeql(tvbuff_t *tvb, gint offset, const guint8 *str,
578     gint size);
579
580 /**
581  * Format a bunch of data from a tvbuff as bytes, returning a pointer
582  * to the string with the formatted data, with "punct" as a byte
583  * separator.
584  */
585 extern gchar *tvb_bytes_to_str_punct(tvbuff_t *tvb, gint offset, gint len,
586     gchar punct);
587
588 /*
589  * Format a bunch of data from a tvbuff as bytes, returning a pointer
590  * to the string with the formatted data.
591  */
592 extern gchar *tvb_bytes_to_str(tvbuff_t *tvb, gint offset, gint len);
593
594 #define TVB_GET_DS_TVB(tvb)             \
595         (tvb->ds_tvb)
596
597 /** Locate a sub-tvbuff within another tvbuff, starting at position
598  * 'haystack_offset'. Returns the index of the beginning of 'needle' within
599  * 'haystack', or -1 if 'needle' is not found. The index is relative
600  * to the start of 'haystack', not 'haystack_offset'. */
601 extern gint tvb_find_tvb(tvbuff_t *haystack_tvb, tvbuff_t *needle_tvb,
602         gint haystack_offset);
603
604 /**
605  * Uncompresses a zlib compressed packet inside a tvbuff at offset with
606  * length comprlen.  Returns an uncompressed tvbuffer if uncompression
607  * succeeded or NULL if uncompression failed.
608  */
609 extern tvbuff_t* tvb_uncompress(tvbuff_t *tvb, int offset, int comprlen);
610
611 /************** END OF ACCESSORS ****************/
612
613 #endif /* __TVBUFF_H__ */