1 /* GLIB - Library of useful routines for C programming
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GLib Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GLib Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GLib at ftp://ftp.gtk.org/pub/gtk/.
27 #if defined(G_DISABLE_SINGLE_INCLUDES) && !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
28 #error "Only <glib.h> can be included directly."
31 #ifndef __G_STRING_H__
32 #define __G_STRING_H__
34 #include <glib/gtypes.h>
35 #include <glib/gunicode.h>
36 #include <glib/gutils.h> /* for G_CAN_INLINE */
40 typedef struct _GString GString
;
41 typedef struct _GStringChunk GStringChunk
;
52 GStringChunk
* g_string_chunk_new (gsize size
);
53 void g_string_chunk_free (GStringChunk
*chunk
);
54 void g_string_chunk_clear (GStringChunk
*chunk
);
55 gchar
* g_string_chunk_insert (GStringChunk
*chunk
,
57 gchar
* g_string_chunk_insert_len (GStringChunk
*chunk
,
60 gchar
* g_string_chunk_insert_const (GStringChunk
*chunk
,
66 GString
* g_string_new (const gchar
*init
);
67 GString
* g_string_new_len (const gchar
*init
,
69 GString
* g_string_sized_new (gsize dfl_size
);
70 gchar
* g_string_free (GString
*string
,
71 gboolean free_segment
);
72 gboolean
g_string_equal (const GString
*v
,
74 guint
g_string_hash (const GString
*str
);
75 GString
* g_string_assign (GString
*string
,
77 GString
* g_string_truncate (GString
*string
,
79 GString
* g_string_set_size (GString
*string
,
81 GString
* g_string_insert_len (GString
*string
,
85 GString
* g_string_append (GString
*string
,
87 GString
* g_string_append_len (GString
*string
,
90 GString
* g_string_append_c (GString
*string
,
92 GString
* g_string_append_unichar (GString
*string
,
94 GString
* g_string_prepend (GString
*string
,
96 GString
* g_string_prepend_c (GString
*string
,
98 GString
* g_string_prepend_unichar (GString
*string
,
100 GString
* g_string_prepend_len (GString
*string
,
103 GString
* g_string_insert (GString
*string
,
106 GString
* g_string_insert_c (GString
*string
,
109 GString
* g_string_insert_unichar (GString
*string
,
112 GString
* g_string_overwrite (GString
*string
,
115 GString
* g_string_overwrite_len (GString
*string
,
119 GString
* g_string_erase (GString
*string
,
122 GString
* g_string_ascii_down (GString
*string
);
123 GString
* g_string_ascii_up (GString
*string
);
124 void g_string_vprintf (GString
*string
,
127 void g_string_printf (GString
*string
,
129 ...) G_GNUC_PRINTF (2, 3);
130 void g_string_append_vprintf (GString
*string
,
133 void g_string_append_printf (GString
*string
,
135 ...) G_GNUC_PRINTF (2, 3);
136 GString
* g_string_append_uri_escaped(GString
*string
,
137 const char *unescaped
,
138 const char *reserved_chars_allowed
,
139 gboolean allow_utf8
);
141 /* -- optimize g_strig_append_c --- */
143 static inline GString
*
144 g_string_append_c_inline (GString
*gstring
,
147 if (gstring
->len
+ 1 < gstring
->allocated_len
)
149 gstring
->str
[gstring
->len
++] = c
;
150 gstring
->str
[gstring
->len
] = 0;
153 g_string_insert_c (gstring
, -1, c
);
156 #define g_string_append_c(gstr,c) g_string_append_c_inline (gstr, c)
157 #endif /* G_CAN_INLINE */
160 #ifndef G_DISABLE_DEPRECATED
162 /* The following two functions are deprecated and will be removed in
163 * the next major release. They use the locale-specific tolower and
164 * toupper, which is almost never the right thing.
167 GString
* g_string_down (GString
*string
);
168 GString
* g_string_up (GString
*string
);
170 /* These aliases are included for compatibility. */
171 #define g_string_sprintf g_string_printf
172 #define g_string_sprintfa g_string_append_printf
174 #endif /* G_DISABLE_DEPRECATED */
178 #endif /* __G_STRING_H__ */