Future tense -> present tense for the encoding argument to
[obnox/wireshark/wip.git] / doc / README.malloc
index 9b1305641dd0e4fd5c71bc458905ca124f428d33..9224bb15954acd744a0017cf657b7540b745d73f 100644 (file)
@@ -1,9 +1,9 @@
-$Id:$
+$Id$
 
 1. Introduction
 
 In order to make memory management easier and to reduce the probability of
-memory leaks ethereal provides its own memory management API. This API is 
+memory leaks wireshark provides its own memory management API. This API is 
 implemented inside epan/emem.c and provides memory allocation functions 
 where the allocated memory is automatically freed at certain points.
 
@@ -32,7 +32,7 @@ where the data is to still be available in some later packet.
 
 The seasonal functions allocate memory that will stay around a lot longer 
 but will be automatically freed once the current capture is closed and 
-Ethereal opens a new capture (either by reading a new capture file or by 
+Wireshark opens a new capture (either by reading a new capture file or by 
 starting a new capture on some interface). These functions are useful for 
 allocations with longer scope for example if you need some buffers or data to 
 keep state between packets.
@@ -57,9 +57,9 @@ ep_new0(t) : allocate a single element of type t and fill it with 0.
 .._strndup(s,n) : allocate a chunk of size n+1 and copy s into it.
 .._memdup(s,n) : allocate n chunk and copy into it n bytes starting at s.
 
-.._strdup_printf() : will calculate the size of the formated string, allocate 
+.._strdup_printf() : will calculate the size of the formatted string, allocate 
   a chunk for it and format the string.
-.._strdup_vprintf() : will calculate the size of the formated string, 
+.._strdup_vprintf() : will calculate the size of the formatted string, 
   allocate a chunk for it and format the string.
 
 ep_strsplit(): will split a string based on a certain separator returning an 
@@ -72,4 +72,20 @@ ep_stack_push() : pushes an element into the stack.
 ep_stack_pop() : pops an element from the stack.
 ep_stack_peek() : returns the top element of the stack without popping it.
 
+3.4 tvbuff related functions
 
+ep_tvb_memdup(): create an ephemeral duplicate of part of the tvbuff.
+
+3.4 String buffers
+
+The ep_strbuf_... functions create and modify growable strings, similar to GLib's
+GStrings.
+
+ep_strbuf_new(s) : Creates a new strbuf, initialized to s.
+ep_strbuf_new_label(s) : Like ep_strbuf_new, but with a max length suitable for
+  protocol tree items.
+ep_strbuf_sized_new() : Creates a new strbuf with explicit sizes.
+ep_strbuf_append_vprintf() : Appends an argument list to a strbuf.
+ep_strbuf_append_printf() : Appends to a strbuf in the style of printf.
+ep_strbuf_append() : Appends a string to a strbuf.
+ep_strbuf_truncate() : Shortens a strbuf.