1#ifndef stringrp_h
2#define stringrp_h
3/*
4 * Copyright (c) 2000, 2001, 2002, 2003, 2004 by Martin C. Shepherd.
5 *
6 * All rights reserved.
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a
9 * copy of this software and associated documentation files (the
10 * "Software"), to deal in the Software without restriction, including
11 * without limitation the rights to use, copy, modify, merge, publish,
12 * distribute, and/or sell copies of the Software, and to permit persons
13 * to whom the Software is furnished to do so, provided that the above
14 * copyright notice(s) and this permission notice appear in all copies of
15 * the Software and that both the above copyright notice(s) and this
16 * permission notice appear in supporting documentation.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
21 * OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
22 * HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL
23 * INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING
24 * FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
25 * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
26 * WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
27 *
28 * Except as contained in this notice, the name of a copyright holder
29 * shall not be used in advertising or otherwise to promote the sale, use
30 * or other dealings in this Software without prior written authorization
31 * of the copyright holder.
32 */
33
34#pragma ident	"%Z%%M%	%I%	%E% SMI"
35
36/*
37 * StringGroup objects provide memory for modules that need to
38 * allocate lots of small strings without needing to free any of them
39 * individually, but rather is happy to free them all at the same
40 * time. Taking advantage of these properties, StringGroup objects
41 * avoid the heap fragmentation that tends to occur when lots of small
42 * strings are allocated directly from the heap and later free'd. They
43 * do this by allocating a list of large character arrays in each of
44 * which multiple strings are stored. Thus instead of allocating lots
45 * of small strings, a few large character arrays are allocated. When
46 * the strings are free'd on mass, this list of character arrays is
47 * maintained, ready for subsequent use in recording another set of
48 * strings.
49 */
50typedef struct StringGroup StringGroup;
51
52/*
53 * The following constructor allocates a string-allocation object.
54 * The segment_size argument specifies how long each string segment
55 * array should be. This should be at least 10 times the length of
56 * the average string to be recorded in the string group, and
57 * sets the length of the longest string that can be stored.
58 */
59StringGroup *_new_StringGroup(int segment_size);
60
61/*
62 * Delete all of the strings that are currently stored by a specified
63 * StringGroup object.
64 */
65void _clr_StringGroup(StringGroup *sg);
66
67/*
68 * Make a copy of the specified string, returning a pointer to
69 * the copy, or NULL if there was insufficient memory. If the
70 * remove_escapes argument is non-zero, backslashes that escape
71 * other characters will be removed.
72 */
73char *_sg_store_string(StringGroup *sg, const char *string, int remove_escapes);
74
75/*
76 * Allocate memory for a string of a given length.
77 */
78char *_sg_alloc_string(StringGroup *sg, int length);
79
80/*
81 * Delete a StringGroup object (and all of the strings that it
82 * contains).
83 */
84StringGroup *_del_StringGroup(StringGroup *sg);
85
86#endif
87