1 /* src/vmcore/utf8.h - utf8 string functions
3 Copyright (C) 1996-2005, 2006, 2007, 2008
4 CACAOVM - Verein zur Foerderung der freien virtuellen Maschine CACAO
6 This file is part of CACAO.
8 This program is free software; you can redistribute it and/or
9 modify it under the terms of the GNU General Public License as
10 published by the Free Software Foundation; either version 2, or (at
11 your option) any later version.
13 This program is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
29 /* forward typedefs ***********************************************************/
31 typedef struct utf utf;
39 #include "vm/global.h"
42 /* data structure for utf8 symbols ********************************************/
45 utf *hashlink; /* link for external hash chain */
46 s4 blength; /* text length in bytes */
47 char *text; /* pointer to text */
50 /* to determine the end of utf strings */
52 #define UTF_END(u) ((char *) u->text + u->blength)
55 /* utf-symbols for pointer comparison of frequently used strings **************/
57 extern utf *utf_java_lang_Object;
59 extern utf *utf_java_lang_Class;
60 extern utf *utf_java_lang_ClassLoader;
61 extern utf *utf_java_lang_Cloneable;
62 extern utf *utf_java_lang_SecurityManager;
63 extern utf *utf_java_lang_String;
64 extern utf *utf_java_lang_ThreadGroup;
65 extern utf *utf_java_lang_ref_SoftReference;
66 extern utf *utf_java_lang_ref_WeakReference;
67 extern utf *utf_java_lang_ref_PhantomReference;
68 extern utf *utf_java_io_Serializable;
70 extern utf *utf_java_lang_Throwable;
71 extern utf *utf_java_lang_Error;
73 extern utf *utf_java_lang_AbstractMethodError;
74 extern utf *utf_java_lang_ClassCircularityError;
75 extern utf *utf_java_lang_ClassFormatError;
76 extern utf *utf_java_lang_ExceptionInInitializerError;
77 extern utf *utf_java_lang_IncompatibleClassChangeError;
78 extern utf *utf_java_lang_InstantiationError;
79 extern utf *utf_java_lang_InternalError;
80 extern utf *utf_java_lang_LinkageError;
81 extern utf *utf_java_lang_NoClassDefFoundError;
82 extern utf *utf_java_lang_NoSuchFieldError;
83 extern utf *utf_java_lang_NoSuchMethodError;
84 extern utf *utf_java_lang_OutOfMemoryError;
85 extern utf *utf_java_lang_UnsatisfiedLinkError;
86 extern utf *utf_java_lang_UnsupportedClassVersionError;
87 extern utf *utf_java_lang_VerifyError;
88 extern utf *utf_java_lang_VirtualMachineError;
90 extern utf *utf_java_lang_Exception;
92 extern utf *utf_java_lang_ArithmeticException;
93 extern utf *utf_java_lang_ArrayIndexOutOfBoundsException;
94 extern utf *utf_java_lang_ArrayStoreException;
95 extern utf *utf_java_lang_ClassCastException;
96 extern utf *utf_java_lang_ClassNotFoundException;
97 extern utf *utf_java_lang_CloneNotSupportedException;
98 extern utf *utf_java_lang_IllegalAccessException;
99 extern utf *utf_java_lang_IllegalArgumentException;
100 extern utf *utf_java_lang_IllegalMonitorStateException;
101 extern utf *utf_java_lang_InstantiationException;
102 extern utf *utf_java_lang_InterruptedException;
103 extern utf *utf_java_lang_NegativeArraySizeException;
104 extern utf *utf_java_lang_NullPointerException;
105 extern utf *utf_java_lang_RuntimeException;
106 extern utf *utf_java_lang_StringIndexOutOfBoundsException;
108 extern utf *utf_java_lang_reflect_InvocationTargetException;
110 extern utf *utf_java_security_PrivilegedActionException;
112 #if defined(ENABLE_JAVASE)
113 extern utf* utf_java_lang_Void;
116 extern utf* utf_java_lang_Boolean;
117 extern utf* utf_java_lang_Byte;
118 extern utf* utf_java_lang_Character;
119 extern utf* utf_java_lang_Short;
120 extern utf* utf_java_lang_Integer;
121 extern utf* utf_java_lang_Long;
122 extern utf* utf_java_lang_Float;
123 extern utf* utf_java_lang_Double;
125 #if defined(ENABLE_JAVASE)
126 extern utf *utf_java_lang_StackTraceElement;
127 extern utf *utf_java_lang_reflect_Constructor;
128 extern utf *utf_java_lang_reflect_Field;
129 extern utf *utf_java_lang_reflect_Method;
131 # if defined(WITH_JAVA_RUNTIME_LIBRARY_GNU_CLASSPATH)
132 extern utf *utf_java_lang_reflect_VMConstructor;
133 extern utf *utf_java_lang_reflect_VMField;
134 extern utf *utf_java_lang_reflect_VMMethod;
137 extern utf *utf_java_util_Vector;
140 extern utf *utf_InnerClasses;
141 extern utf *utf_ConstantValue;
142 extern utf *utf_Code;
143 extern utf *utf_Exceptions;
144 extern utf *utf_LineNumberTable;
145 extern utf *utf_SourceFile;
147 #if defined(ENABLE_JAVASE)
148 extern utf *utf_EnclosingMethod;
149 extern utf *utf_Signature;
150 extern utf *utf_StackMapTable;
152 #if defined(ENABLE_ANNOTATIONS)
153 extern utf *utf_RuntimeVisibleAnnotations;
154 extern utf *utf_RuntimeInvisibleAnnotations;
155 extern utf *utf_RuntimeVisibleParameterAnnotations;
156 extern utf *utf_RuntimeInvisibleParameterAnnotations;
157 extern utf *utf_AnnotationDefault;
161 extern utf *utf_init;
162 extern utf *utf_clinit;
163 extern utf *utf_clone;
164 extern utf *utf_finalize;
165 extern utf *utf_invoke;
166 extern utf *utf_main;
170 extern utf *utf_remove;
171 extern utf *utf_addThread;
172 extern utf *utf_removeThread;
175 extern utf *utf_uncaughtException;
176 extern utf *utf_value;
178 extern utf *utf_fillInStackTrace;
179 extern utf *utf_findNative;
180 extern utf *utf_getSystemClassLoader;
181 extern utf *utf_initCause;
182 extern utf *utf_loadClass;
183 extern utf *utf_loadClassInternal;
184 extern utf *utf_printStackTrace;
186 extern utf *utf_division_by_zero;
197 extern utf *utf_void__void;
198 extern utf *utf_boolean__void;
199 extern utf *utf_byte__void;
200 extern utf *utf_char__void;
201 extern utf *utf_short__void;
202 extern utf *utf_int__void;
203 extern utf *utf_long__void;
204 extern utf *utf_float__void;
205 extern utf *utf_double__void;
207 extern utf *utf_void__java_lang_ClassLoader;
208 extern utf *utf_void__java_lang_Object;
209 extern utf *utf_void__java_lang_Throwable;
210 extern utf *utf_java_lang_ClassLoader_java_lang_String__J;
211 extern utf *utf_java_lang_Exception__V;
212 extern utf *utf_java_lang_Object__java_lang_Object;
213 extern utf *utf_java_lang_String__void;
214 extern utf *utf_java_lang_String__java_lang_Class;
215 extern utf *utf_java_lang_Thread__V;
216 extern utf *utf_java_lang_Thread_java_lang_Throwable__V;
217 extern utf *utf_Ljava_lang_ThreadGroup_Ljava_lang_String__V;
218 extern utf *utf_java_lang_Throwable__void;
219 extern utf *utf_java_lang_Throwable__java_lang_Throwable;
221 extern utf *utf_not_named_yet;
222 extern utf *utf_null;
223 extern utf *array_packagename;
226 /* function prototypes ********************************************************/
228 /* initialize the utf8 subsystem */
229 void utf8_init(void);
231 u4 utf_hashkey(const char *text, u4 length);
232 u4 utf_full_hashkey(const char *text, u4 length);
234 /* determine hashkey of a unicode-symbol */
235 u4 unicode_hashkey(u2 *text, u2 length);
237 /* create new utf-symbol */
238 utf *utf_new(const char *text, u2 length);
240 /* make utf symbol from u2 array */
241 utf *utf_new_u2(u2 *unicodedata, u4 unicodelength, bool isclassname);
243 utf *utf_new_char(const char *text);
244 utf *utf_new_char_classname(const char *text);
246 /* get number of bytes */
247 u4 utf_bytes(utf *u);
249 /* get next unicode character of a utf-string */
250 u2 utf_nextu2(char **utf);
252 /* get (number of) unicode characters of a utf string (safe) */
253 s4 utf8_safe_number_of_u2s(const char *text, s4 nbytes);
254 void utf8_safe_convert_to_u2s(const char *text, s4 nbytes, u2 *buffer);
256 /* get (number of) unicode characters of a utf string (UNSAFE!) */
257 u4 utf_get_number_of_u2s(utf *u);
258 u4 utf_get_number_of_u2s_for_buffer(const char *buffer, u4 blength);
260 /* determine utf length in bytes of a u2 array */
261 u4 u2_utflength(u2 *text, u4 u2_length);
263 void utf_copy(char *buffer, utf *u);
264 void utf_cat(char *buffer, utf *u);
265 void utf_copy_classname(char *buffer, utf *u);
266 void utf_cat_classname(char *buffer, utf *u);
268 /* write utf symbol to file/buffer */
269 void utf_display_printable_ascii(utf *u);
270 void utf_display_printable_ascii_classname(utf *u);
272 void utf_sprint_convert_to_latin1(char *buffer, utf *u);
273 void utf_sprint_convert_to_latin1_classname(char *buffer, utf *u);
275 void utf_strcat_convert_to_latin1(char *buffer, utf *u);
276 void utf_strcat_convert_to_latin1_classname(char *buffer, utf *u);
278 void utf_fprint_printable_ascii(FILE *file, utf *u);
279 void utf_fprint_printable_ascii_classname(FILE *file, utf *u);
281 /* check if a UTF-8 string is valid */
282 bool is_valid_utf(char *utf_ptr, char *end_pos);
284 /* check if a UTF-8 string may be used as a class/field/method name */
285 bool is_valid_name(char *utf_ptr, char *end_pos);
286 bool is_valid_name_utf(utf *u);
295 * These are local overrides for various environment variables in Emacs.
296 * Please do not remove this and leave it at the end of the file, where
297 * Emacs will automagically detect them.
298 * ---------------------------------------------------------------------
301 * indent-tabs-mode: t
305 * vim:noexpandtab:sw=4:ts=4: