Name

GString

typedef struct {
  gchar  *str;
  gsize len;    
  gsize allocated_len;
} GString;

The GString struct contains the public fields of a GString. The str field points to the character data. It may move as text is added. The len field contains the length of the string, not including the terminating nul byte.

The str field is nul-terminated and so can be used as an ordinary C string. But it may be moved when text is appended or inserted into the string.

g_string_new ()

GString*    g_string_new                    (const gchar *init);

Creates a new GString, initialized with the given string.

g_string_new_len ()

GString*    g_string_new_len                (const gchar *init, gssize len);

Creates a new GString with len bytes of the init buffer. Because a length is provided, init need not be nul-terminated, and can contain embedded nul bytes.

g_string_sized_new ()

GString*    g_string_sized_new              (gsize dfl_size);

Creates a new GString, with enough space for dfl_size bytes. This is useful to add a lot of text to the string and do not want it to be reallocated too often.

g_string_assign ()

GString*    g_string_assign                 (GString *string, const gchar *rval);

Copies the bytes from a string into a GString, destroying any previous contents. It is rather like the standard strcpy() function, except that there is no need to worry about having enough space to copy the string.

g_string_sprintf

#define     g_string_sprintf

Writes a formatted string into a GString. This is similar to the standard sprintf() function, except that the GString buffer automatically expands to contain the results. The previous contents of the GString are destroyed.

Warning: g_string_sprintf is deprecated and should not be used in newly-written code. This function has been renamed to g_string_printf().

g_string_sprintfa

#define     g_string_sprintfa

Appends a formatted string onto the end of a GString. This function is similar to g_string_sprintf() except that the text is appended to the GString.

Warning: g_string_sprintfa is deprecated and should not be used in newly-written code. This function has been renamed to g_string_append_printf().

g_string_printf ()

void        g_string_printf                 (GString *string, const gchar *format, ...);

Writes a formatted string into a GString. This is similar to the standard sprintf() function, except that the GString buffer automatically expands to contain the results. The previous contents of the GString are destroyed.

g_string_append_printf ()

void        g_string_append_printf          (GString *string, const gchar *format, ...);

Appends a formatted string onto the end of a GString. This function is similar to g_string_printf() except that the text is appended to the GString.

g_string_append ()

GString*    g_string_append                 (GString *string, const gchar *val);

Adds a string onto the end of a GString, expanding it if necessary.

g_string_append_c ()

GString*    g_string_append_c               (GString *string, gchar c);

Adds a byte onto the end of a GString, expanding it if necessary.

g_string_append_unichar ()

GString*    g_string_append_unichar         (GString *string, gunichar wc);

Converts a Unicode character into UTF-8, and appends it to the string.

g_string_append_len ()

GString*    g_string_append_len             (GString *string, const gchar *val, gssize len);

Appends len bytes of val to string. Because len is provided, val may contain embedded nulls and need not be nul-terminated.

g_string_prepend ()

GString*    g_string_prepend                (GString *string, const gchar *val);

Adds a string on to the start of a GString, expanding it if necessary.

g_string_prepend_c ()

GString*    g_string_prepend_c              (GString *string, gchar c);

Adds a byte onto the start of a GString, expanding it if necessary.

g_string_prepend_unichar ()

GString*    g_string_prepend_unichar        (GString *string, gunichar wc);

Converts a Unicode character into UTF-8, and prepends it to the string.

g_string_prepend_len ()

GString*    g_string_prepend_len            (GString *string,  const gchar *val, gssize len);

Prepends len bytes of val to string. Because len is provided, val may contain embedded nulls and need not be nul-terminated.

g_string_insert ()

GString*    g_string_insert        (GString *string, gssize pos, const gchar *val);

Inserts a copy of a string into a GString, expanding it if necessary.

g_string_insert_c ()

GString*    g_string_insert_c       (GString *string, gssize pos, gchar c);

Inserts a byte into a GString, expanding it if necessary.

g_string_insert_unichar ()

GString*    g_string_insert_unichar         (GString *string, gssize pos, gunichar wc);

Converts a Unicode character into UTF-8, and insert it into the string at the given position.

g_string_insert_len ()

GString*    g_string_insert_len             (GString *string, gssize pos, const gchar *val, gssize len);

Inserts len bytes of val into string at pos. Because len is provided, val may contain embedded nulls and need not be nul-terminated. If pos is -1, bytes are inserted at the end of the string.

g_string_erase ()

GString*    g_string_erase          (GString *string, gssize pos, gssize len);

Removes len bytes from a GString, starting at position pos. The rest of the GString is shifted down to fill the gap.

g_string_truncate ()

GString*    g_string_truncate          (GString *string, gsize len);

Cuts off the end of the GString, leaving the first len bytes.

g_string_set_size ()

GString*    g_string_set_size        (GString *string, gsize len);

Sets the length of a GString. If the length is less than the current length, the string will be truncated. If the length is greater than the current length, the contents of the newly added area are undefined. (However, as always, string->str[string->len] will be a nul byte.)

g_string_free ()

gchar*      g_string_free        (GString *string, gboolean free_segment);

Frees the memory allocated for the GString. If free_segment is TRUE it also frees the character data.

g_string_up ()

GString*    g_string_up           (GString *string);

Converts a GString to uppercase.

Warning: g_string_up has been deprecated since version 2.2 and should not be used in newly-written code. This function uses the locale-specific toupper() function, which is almost never the right thing. Use g_string_ascii_up() or g_utf8_strup() instead.

g_string_down ()

GString*    g_string_down          (GString *string);

Converts a GString to lowercase.

Warning: g_string_down has been deprecated since version 2.2 and should not be used in newly-written code. This function uses the locale-specific tolower() function, which is almost never the right thing. Use g_string_ascii_down() or g_utf8_strdown() instead.

g_string_hash ()

guint       g_string_hash        (const GString *str);

Creates a hash code for str; for use with GHashTable.

g_string_equal ()

gboolean    g_string_equal           (const GString *v, const GString *v2);

Compares two strings for equality, returning TRUE if they are equal. For use with GHashTable.