/* src/vm/stringlocal.h - string header

   Copyright (C) 1996-2005, 2006 R. Grafl, A. Krall, C. Kruegel,
   C. Oates, R. Obermaisser, M. Platter, M. Probst, S. Ring,
   E. Steiner, C. Thalinger, D. Thuernbeck, P. Tomsich, C. Ullrich,
   J. Wenninger, Institut f. Computersprachen - TU Wien

   This file is part of CACAO.

   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 2, 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., 51 Franklin Street, Fifth Floor, Boston, MA
   02110-1301, USA.

   Contact: cacao@cacaojvm.org

   Authors: Christian Thalinger

   Changes: Edwin Steiner

   $Id: stringlocal.h 4876 2006-05-05 15:26:04Z edwin $

*/


#ifndef _STRINGLOCAL_H
#define _STRINGLOCAL_H

typedef struct literalstring literalstring;


#include "config.h"
#include "vm/types.h"

#include "vm/global.h"                  /* required before java_lang_String.h */
#include "native/include/java_lang_String.h"

#include "vm/hashtable.h"
#include "vm/utf8.h"


/* data structure of internal javastrings stored in global hashtable **********/

struct literalstring {
	literalstring     *hashlink;        /* link for external hash chain       */
	java_objectheader *string;  
};


/* javastring-hashtable */
extern hashtable hashtable_string;


/* global string definitions **************************************************/

/* exception/error super class */

extern const char *string_java_lang_Throwable;
extern const char *string_java_lang_VMThrowable;


/* specify some exception strings for code generation */

extern const char *string_java_lang_ArithmeticException;
extern const char *string_java_lang_ArithmeticException_message;
extern const char *string_java_lang_ArrayIndexOutOfBoundsException;
extern const char *string_java_lang_ArrayStoreException;
extern const char *string_java_lang_ClassCastException;
extern const char *string_java_lang_ClassNotFoundException;
extern const char *string_java_lang_CloneNotSupportedException;
extern const char *string_java_lang_Exception;
extern const char *string_java_lang_IllegalAccessException;
extern const char *string_java_lang_IllegalArgumentException;
extern const char *string_java_lang_IllegalMonitorStateException;
extern const char *string_java_lang_IndexOutOfBoundsException;
extern const char *string_java_lang_InstantiationException;
extern const char *string_java_lang_InterruptedException;
extern const char *string_java_lang_NegativeArraySizeException;
extern const char *string_java_lang_NoSuchFieldException;
extern const char *string_java_lang_NoSuchMethodException;
extern const char *string_java_lang_NullPointerException;
extern const char *string_java_lang_StringIndexOutOfBoundsException;
extern const char *string_java_lang_reflect_InvocationTargetException;


/* specify some error strings for code generation */

extern const char *string_java_lang_AbstractMethodError;
extern const char *string_java_lang_ClassCircularityError;
extern const char *string_java_lang_ClassFormatError;
extern const char *string_java_lang_Error;
extern const char *string_java_lang_ExceptionInInitializerError;
extern const char *string_java_lang_IncompatibleClassChangeError;
extern const char *string_java_lang_InternalError;
extern const char *string_java_lang_InstantiationError;
extern const char *string_java_lang_LinkageError;
extern const char *string_java_lang_NoClassDefFoundError;
extern const char *string_java_lang_NoSuchFieldError;
extern const char *string_java_lang_NoSuchMethodError;
extern const char *string_java_lang_OutOfMemoryError;
extern const char *string_java_lang_UnsatisfiedLinkError;
extern const char *string_java_lang_UnsupportedClassVersionError;
extern const char *string_java_lang_VerifyError;
extern const char *string_java_lang_VirtualMachineError;


/* function prototypes ********************************************************/

/* initialize string subsystem */
bool string_init(void);

void stringtable_update(void);

/* creates a new object of type java/lang/String from a utf-text */
java_lang_String *javastring_new(utf *text);

/* creates a new object of type java/lang/String from a utf-text, changes slashes to dots */
java_lang_String *javastring_new_slash_to_dot(utf *text);

/* creates a new object of type java/lang/String from an ASCII c-string */
java_lang_String *javastring_new_from_ascii(const char *text);

/* creates a new object of type java/lang/String from UTF-8 */
java_lang_String *javastring_new_from_utf_buffer(const char *buffer, u4 blength);
java_lang_String *javastring_new_from_utf_string(const char *utfstr);

/* make c-string from a javastring (debugging) */
char *javastring_tochar(java_objectheader *s);

/* make utf symbol from javastring */
utf *javastring_toutf(java_lang_String *string, bool isclassname);

/* returns length of javastring */
s4 javastring_strlen(java_lang_String *s);

/* creates a new javastring with the text of the u2-array */
java_objectheader *literalstring_u2(java_chararray *a, u4 length, u4 offset,
									bool copymode);

/* creates a new javastring with the text of the utf-symbol */
java_objectheader *literalstring_new(utf *u);

/* dispose a javastring */
void literalstring_free(java_objectheader*);

#endif /* _STRINGLOCAL_H */


/*
 * These are local overrides for various environment variables in Emacs.
 * Please do not remove this and leave it at the end of the file, where
 * Emacs will automagically detect them.
 * ---------------------------------------------------------------------
 * Local variables:
 * mode: c
 * indent-tabs-mode: t
 * c-basic-offset: 4
 * tab-width: 4
 * End:
 * vim:noexpandtab:sw=4:ts=4:
 */