/***************************************************************************

  String.h

  The String management routines

  (c) 2000-2007 Benoit Minisini <gambas@users.sourceforge.net>

  This program is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 1, or (at your option)
  any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

***************************************************************************/

#ifndef __STRING_H
#define __STRING_H

#include "gbx_value.h"
#include "gbx_subst.h"
#include "gbx_debug.h"

typedef
  struct
  {
    int len;
    int ref;
    char data[0];
  }
  PACKED
  STRING;

#define SC_UNICODE ((char *)-1)

void STRING_init(void);
void STRING_exit(void);

void STRING_new(char **ptr, const char *src, int len);
void STRING_new_temp(char **ptr, const char *src, int len);
void STRING_free(char **ptr);
int STRING_get_free_index(void);

void STRING_extend(char **ptr, int new_len);
void STRING_extend_end(char **ptr);
void STRING_add(char **ptr, const char *src, int len);

void STRING_copy_from_value_temp(char **ptr, VALUE *value);

void STRING_new_temp_value(VALUE *value, const char *src, int len);
void STRING_new_constant_value(VALUE *value, const char *src, int len);

void STRING_char_value(VALUE *value, uchar car);
void STRING_void_value(VALUE *value);

int STRING_comp_value(VALUE *str1, VALUE *str2);
int STRING_comp_value_ignore_case(VALUE *str1, VALUE *str2);

char *STRING_subst(const char *string, int len, SUBST_FUNC get_param);
int STRING_conv(char **result, const char *str, int len, const char *src, const char *dst, bool throw);
char *STRING_conv_file_name(const char *name, int len);
char *STRING_conv_to_UTF8(const char *name, int len);

#define STRING_from_ptr(_ptr) ((STRING *)((_ptr) - offsetof(STRING, data)))
#define STRING_length(_ptr) ((_ptr) == NULL ? 0 : STRING_from_ptr(_ptr)->len)

#if DEBUG_STRING

void STRING_ref(char *ptr);
void STRING_unref(char **ptr);

#else

#define STRING_ref(_p) \
({ \
  char *ptr = _p; \
  if (ptr) \
    STRING_from_ptr(ptr)->ref++; \
})

#define STRING_unref(_p) \
({ \
  char **pptr = _p; \
  char *ptr = *pptr; \
  STRING *str; \
  if (ptr) \
  { \
	  str = STRING_from_ptr(ptr); \
  	if ((--str->ref) <= 0) \
    	STRING_free(pptr); \
  } \
})

#endif

void STRING_unref_keep(char **ptr);

int STRING_search(const char *ps, int ls, const char *pp, int lp, int is, bool right, bool nocase);

#endif