williamr@2: /* GLIB - Library of useful routines for C programming
williamr@2:  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
williamr@2:  * Portions copyright (c) 2006 Nokia Corporation.  All rights reserved.
williamr@2:  *
williamr@2:  * This library is free software; you can redistribute it and/or
williamr@2:  * modify it under the terms of the GNU Lesser General Public
williamr@2:  * License as published by the Free Software Foundation; either
williamr@2:  * version 2 of the License, or (at your option) any later version.
williamr@2:  *
williamr@2:  * This library is distributed in the hope that it will be useful,
williamr@2:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
williamr@2:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU
williamr@2:  * Lesser General Public License for more details.
williamr@2:  *
williamr@2:  * You should have received a copy of the GNU Lesser General Public
williamr@2:  * License along with this library; if not, write to the
williamr@2:  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
williamr@2:  * Boston, MA 02111-1307, USA.
williamr@2:  */
williamr@2: 
williamr@2: /*
williamr@2:  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
williamr@2:  * file for a list of people on the GLib Team.  See the ChangeLog
williamr@2:  * files for a list of changes.  These files are distributed with
williamr@2:  * GLib at ftp://ftp.gtk.org/pub/gtk/. 
williamr@2:  */
williamr@2: 
williamr@2: #ifndef __G_STRING_H__
williamr@2: #define __G_STRING_H__
williamr@2: 
williamr@2: #include <_ansi.h>
williamr@2: #include <glib/gtypes.h>
williamr@2: #include <glib/gunicode.h>
williamr@2: #include <glib/gutils.h>  /* for G_CAN_INLINE */
williamr@2: 
williamr@2: G_BEGIN_DECLS
williamr@2: 
williamr@2: typedef struct _GString		GString;
williamr@2: typedef struct _GStringChunk	GStringChunk;
williamr@2: 
williamr@2: struct _GString
williamr@2: {
williamr@2:   gchar  *str;
williamr@2:   gsize len;    
williamr@2:   gsize allocated_len;
williamr@2: };
williamr@2: 
williamr@2: /* String Chunks
williamr@2:  */
williamr@2: IMPORT_C GStringChunk* g_string_chunk_new	   (gsize size);  
williamr@2: IMPORT_C void	      g_string_chunk_free	   (GStringChunk *chunk);
williamr@2: IMPORT_C gchar*	      g_string_chunk_insert	   (GStringChunk *chunk,
williamr@2: 					    const gchar	 *string);
williamr@2: IMPORT_C gchar*	      g_string_chunk_insert_len	   (GStringChunk *chunk,
williamr@2: 					    const gchar	 *string,
williamr@2: 					    gssize        len);
williamr@2: IMPORT_C gchar*	      g_string_chunk_insert_const  (GStringChunk *chunk,
williamr@2: 					    const gchar	 *string);
williamr@2: 
williamr@2: 
williamr@2: /* Strings
williamr@2:  */
williamr@2: IMPORT_C GString*     g_string_new	        (const gchar	 *init);
williamr@2: IMPORT_C GString*     g_string_new_len           (const gchar     *init,
williamr@2:                                          gssize           len);   
williamr@2: IMPORT_C GString*     g_string_sized_new         (gsize            dfl_size);  
williamr@2: IMPORT_C gchar*	     g_string_free	        (GString	 *string,
williamr@2: 					 gboolean	  free_segment);
williamr@2: IMPORT_C gboolean     g_string_equal             (const GString	 *v,
williamr@2: 					 const GString 	 *v2);
williamr@2: IMPORT_C guint        g_string_hash              (const GString   *str);
williamr@2: IMPORT_C GString*     g_string_assign            (GString	 *string,
williamr@2: 					 const gchar	 *rval);
williamr@2: IMPORT_C GString*     g_string_truncate          (GString	 *string,
williamr@2: 					 gsize		  len);    
williamr@2: IMPORT_C GString*     g_string_set_size          (GString         *string,
williamr@2: 					 gsize            len);
williamr@2: IMPORT_C GString*     g_string_insert_len        (GString         *string,
williamr@2:                                          gssize           pos,   
williamr@2:                                          const gchar     *val,
williamr@2:                                          gssize           len);  
williamr@2: IMPORT_C GString*     g_string_append            (GString	 *string,
williamr@2: 			                 const gchar	 *val);
williamr@2: IMPORT_C GString*     g_string_append_len        (GString	 *string,
williamr@2: 			                 const gchar	 *val,
williamr@2:                                          gssize           len);  
williamr@2: IMPORT_C GString*     g_string_append_c          (GString	 *string,
williamr@2: 					 gchar		  c);
williamr@2: IMPORT_C GString*     g_string_append_unichar    (GString	 *string,
williamr@2: 					 gunichar	  wc);
williamr@2: IMPORT_C GString*     g_string_prepend           (GString	 *string,
williamr@2: 					 const gchar	 *val);
williamr@2: IMPORT_C GString*     g_string_prepend_c         (GString	 *string,
williamr@2: 					 gchar		  c);
williamr@2: IMPORT_C GString*     g_string_prepend_unichar   (GString	 *string,
williamr@2: 					 gunichar	  wc);
williamr@2: IMPORT_C GString*     g_string_prepend_len       (GString	 *string,
williamr@2: 			                 const gchar	 *val,
williamr@2:                                          gssize           len);  
williamr@2: IMPORT_C GString*     g_string_insert            (GString	 *string,
williamr@2: 					 gssize		  pos,    
williamr@2: 					 const gchar	 *val);
williamr@2: IMPORT_C GString*     g_string_insert_c          (GString	 *string,
williamr@2: 					 gssize		  pos,    
williamr@2: 					 gchar		  c);
williamr@2: IMPORT_C GString*     g_string_insert_unichar    (GString	 *string,
williamr@2: 					 gssize		  pos,    
williamr@2: 					 gunichar	  wc);
williamr@2: IMPORT_C GString*     g_string_erase	        (GString	 *string,
williamr@2: 					 gssize		  pos,
williamr@2: 					 gssize		  len);
williamr@2: IMPORT_C GString*     g_string_ascii_down        (GString	 *string);
williamr@2: IMPORT_C GString*     g_string_ascii_up          (GString	 *string);
williamr@2: IMPORT_C void         g_string_printf            (GString	 *string,
williamr@2: 					 const gchar	 *format,
williamr@2: 					 ...) G_GNUC_PRINTF (2, 3);
williamr@2: IMPORT_C void         g_string_append_printf     (GString	 *string,
williamr@2: 					 const gchar	 *format,
williamr@2: 					 ...) G_GNUC_PRINTF (2, 3);
williamr@2: 
williamr@2: /* -- optimize g_strig_append_c --- */
williamr@2: #ifdef G_CAN_INLINE
williamr@2: static inline GString*
williamr@2: g_string_append_c_inline (GString *gstring,
williamr@2:                           gchar    c)
williamr@2: {
williamr@2:   if (gstring->len + 1 < gstring->allocated_len)
williamr@2:     {
williamr@2:       gstring->str[gstring->len++] = c;
williamr@2:       gstring->str[gstring->len] = 0;
williamr@2:     }
williamr@2:   else
williamr@2:     g_string_insert_c (gstring, -1, c);
williamr@2:   return gstring;
williamr@2: }
williamr@2: #define g_string_append_c(gstr,c)       g_string_append_c_inline (gstr, c)
williamr@2: #endif /* G_CAN_INLINE */
williamr@2: 
williamr@2: 
williamr@2: #ifndef G_DISABLE_DEPRECATED
williamr@2: 
williamr@2: /* The following two functions are deprecated and will be removed in
williamr@2:  * the next major release. They use the locale-specific tolower and
williamr@2:  * toupper, which is almost never the right thing.
williamr@2:  */
williamr@2: 
williamr@2: IMPORT_C GString*     g_string_down              (GString	 *string);
williamr@2: IMPORT_C GString*     g_string_up                (GString	 *string);
williamr@2: 
williamr@2: /* These aliases are included for compatibility. */
williamr@2: #define	g_string_sprintf	g_string_printf
williamr@2: #define	g_string_sprintfa	g_string_append_printf
williamr@2: 
williamr@2: #endif /* G_DISABLE_DEPRECATED */
williamr@2: 
williamr@2: G_END_DECLS
williamr@2: 
williamr@2: #endif /* __G_STRING_H__ */
williamr@2: