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.1 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, see <http://www.gnu.org/licenses/>.
19 * Modified by the GLib Team and others 1997-2000. See the AUTHORS
20 * file for a list of people on the GLib Team. See the ChangeLog
21 * files for a list of changes. These files are distributed with
22 * GLib at ftp://ftp.gtk.org/pub/gtk/.
25 #ifndef __G_STRING_H__
26 #define __G_STRING_H__
28 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
29 #error "Only <glib.h> can be included directly."
32 #include <glib/gtypes.h>
33 #include <glib/gunicode.h>
34 #include <glib/gbytes.h>
35 #include <glib/gutils.h> /* for G_CAN_INLINE */
39 typedef struct _GString GString;
49 GString* g_string_new (const gchar *init);
51 GString* g_string_new_len (const gchar *init,
54 GString* g_string_sized_new (gsize dfl_size);
56 gchar* g_string_free (GString *string,
57 gboolean free_segment);
58 GLIB_AVAILABLE_IN_2_34
59 GBytes* g_string_free_to_bytes (GString *string);
61 gboolean g_string_equal (const GString *v,
64 guint g_string_hash (const GString *str);
66 GString* g_string_assign (GString *string,
69 GString* g_string_truncate (GString *string,
72 GString* g_string_set_size (GString *string,
75 GString* g_string_insert_len (GString *string,
80 GString* g_string_append (GString *string,
83 GString* g_string_append_len (GString *string,
87 GString* g_string_append_c (GString *string,
90 GString* g_string_append_unichar (GString *string,
93 GString* g_string_prepend (GString *string,
96 GString* g_string_prepend_c (GString *string,
99 GString* g_string_prepend_unichar (GString *string,
101 GLIB_AVAILABLE_IN_ALL
102 GString* g_string_prepend_len (GString *string,
105 GLIB_AVAILABLE_IN_ALL
106 GString* g_string_insert (GString *string,
109 GLIB_AVAILABLE_IN_ALL
110 GString* g_string_insert_c (GString *string,
113 GLIB_AVAILABLE_IN_ALL
114 GString* g_string_insert_unichar (GString *string,
117 GLIB_AVAILABLE_IN_ALL
118 GString* g_string_overwrite (GString *string,
121 GLIB_AVAILABLE_IN_ALL
122 GString* g_string_overwrite_len (GString *string,
126 GLIB_AVAILABLE_IN_ALL
127 GString* g_string_erase (GString *string,
130 GLIB_AVAILABLE_IN_2_68
131 guint g_string_replace (GString *string,
133 const gchar *replace,
135 GLIB_AVAILABLE_IN_ALL
136 GString* g_string_ascii_down (GString *string);
137 GLIB_AVAILABLE_IN_ALL
138 GString* g_string_ascii_up (GString *string);
139 GLIB_AVAILABLE_IN_ALL
140 void g_string_vprintf (GString *string,
144 GLIB_AVAILABLE_IN_ALL
145 void g_string_printf (GString *string,
147 ...) G_GNUC_PRINTF (2, 3);
148 GLIB_AVAILABLE_IN_ALL
149 void g_string_append_vprintf (GString *string,
153 GLIB_AVAILABLE_IN_ALL
154 void g_string_append_printf (GString *string,
156 ...) G_GNUC_PRINTF (2, 3);
157 GLIB_AVAILABLE_IN_ALL
158 GString* g_string_append_uri_escaped (GString *string,
159 const gchar *unescaped,
160 const gchar *reserved_chars_allowed,
161 gboolean allow_utf8);
163 /* -- optimize g_strig_append_c --- */
165 static inline GString*
166 g_string_append_c_inline (GString *gstring,
169 if (gstring->len + 1 < gstring->allocated_len)
171 gstring->str[gstring->len++] = c;
172 gstring->str[gstring->len] = 0;
175 g_string_insert_c (gstring, -1, c);
178 #define g_string_append_c(gstr,c) g_string_append_c_inline (gstr, c)
179 #endif /* G_CAN_INLINE */
183 GString *g_string_down (GString *string);
185 GString *g_string_up (GString *string);
187 #define g_string_sprintf g_string_printf GLIB_DEPRECATED_MACRO_IN_2_26_FOR(g_string_printf)
188 #define g_string_sprintfa g_string_append_printf GLIB_DEPRECATED_MACRO_IN_2_26_FOR(g_string_append_printf)
192 #endif /* __G_STRING_H__ */