src/vm/utf8.h

   1 /* src/vm/utf8.h - utf8 string functions
   2
   3    Copyright (C) 1996-2005, 2006 R. Grafl, A. Krall, C. Kruegel,
   4    C. Oates, R. Obermaisser, M. Platter, M. Probst, S. Ring,
   5    E. Steiner, C. Thalinger, D. Thuernbeck, P. Tomsich, C. Ullrich,
   6    J. Wenninger, Institut f. Computersprachen - TU Wien
   7
   8    This file is part of CACAO.
   9
  10    This program is free software; you can redistribute it and/or
  11    modify it under the terms of the GNU General Public License as
  12    published by the Free Software Foundation; either version 2, or (at
  13    your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful, but
  16    WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18    General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program; if not, write to the Free Software
  22    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  23    02110-1301, USA.
  24
  25    Contact: cacao@cacaojvm.org
  26
  27    Authors: Christian Thalinger
  28             Edwin Steiner
  29
  30    $Id: utf8.h 6216 2006-12-18 18:21:37Z twisti $
  31
  32 */
  33
  34
  35 #ifndef _UTF_H
  36 #define _UTF_H
  37
  38 #include "config.h"
  39
  40 #include <stdio.h>
  41
  42 /* forward typedefs ***********************************************************/
  43
  44 typedef struct utf utf;
  45
  46 #include "vm/types.h"
  47 #include "vm/global.h"
  48
  49
  50 /* data structure for utf8 symbols ********************************************/
  51
  52 struct utf {
  53         utf  *hashlink;                     /* link for external hash chain       */
  54         s4    blength;                      /* text length in bytes               */
  55         char *text;                         /* pointer to text                    */
  56 };
  57
  58 /* to determine the end of utf strings */
  59
  60 #define UTF_END(u)    ((char *) u->text + u->blength)
  61
  62
  63 /* utf-symbols for pointer comparison of frequently used strings **************/
  64
  65 extern utf *utf_java_lang_Object;
  66
  67 extern utf *utf_java_lang_Class;
  68 extern utf *utf_java_lang_ClassLoader;
  69 extern utf *utf_java_lang_Cloneable;
  70 extern utf *utf_java_lang_SecurityManager;
  71 extern utf *utf_java_lang_String;
  72 extern utf *utf_java_lang_System;
  73 extern utf *utf_java_lang_ThreadGroup;
  74 extern utf *utf_java_io_Serializable;
  75
  76 extern utf *utf_java_lang_Throwable;
  77 extern utf *utf_java_lang_VMThrowable;
  78 extern utf *utf_java_lang_Error;
  79 extern utf *utf_java_lang_AbstractMethodError;
  80 extern utf *utf_java_lang_LinkageError;
  81 extern utf *utf_java_lang_NoClassDefFoundError;
  82 extern utf *utf_java_lang_NoSuchMethodError;
  83 extern utf *utf_java_lang_OutOfMemoryError;
  84
  85 extern utf *utf_java_lang_Exception;
  86 extern utf *utf_java_lang_ClassCastException;
  87 extern utf *utf_java_lang_ClassNotFoundException;
  88 extern utf *utf_java_lang_IllegalArgumentException;
  89 extern utf *utf_java_lang_IllegalMonitorStateException;
  90
  91 extern utf *utf_java_lang_NullPointerException;
  92
  93 extern utf* utf_java_lang_Void;
  94 extern utf* utf_java_lang_Boolean;
  95 extern utf* utf_java_lang_Byte;
  96 extern utf* utf_java_lang_Character;
  97 extern utf* utf_java_lang_Short;
  98 extern utf* utf_java_lang_Integer;
  99 extern utf* utf_java_lang_Long;
 100 extern utf* utf_java_lang_Float;
 101 extern utf* utf_java_lang_Double;
 102
 103 extern utf *utf_java_lang_StackTraceElement;
 104 extern utf *utf_java_lang_reflect_Constructor;
 105 extern utf *utf_java_lang_reflect_Field;
 106 extern utf *utf_java_lang_reflect_Method;
 107 extern utf *utf_java_util_Vector;
 108
 109
 110 extern utf *utf_InnerClasses;
 111 extern utf *utf_ConstantValue;
 112 extern utf *utf_Code;
 113 extern utf *utf_Exceptions;
 114 extern utf *utf_LineNumberTable;
 115 extern utf *utf_SourceFile;
 116
 117 #if defined(ENABLE_JAVASE)
 118 extern utf *utf_EnclosingMethod;
 119 extern utf *utf_Signature;
 120 extern utf *utf_RuntimeVisibleAnnotations;
 121 extern utf *utf_StackMapTable;
 122 #endif
 123
 124 extern utf *utf_init;
 125 extern utf *utf_clinit;
 126 extern utf *utf_clone;
 127 extern utf *utf_finalize;
 128 extern utf *utf_run;
 129
 130 extern utf *utf_add;
 131 extern utf *utf_remove;
 132 extern utf *utf_removeThread;
 133 extern utf *utf_put;
 134 extern utf *utf_get;
 135 extern utf *utf_value;
 136
 137 extern utf *utf_fillInStackTrace;
 138 extern utf *utf_getSystemClassLoader;
 139 extern utf *utf_loadClass;
 140 extern utf *utf_printStackTrace;
 141
 142 extern utf *utf_Z;
 143 extern utf *utf_B;
 144 extern utf *utf_C;
 145 extern utf *utf_S;
 146 extern utf *utf_I;
 147 extern utf *utf_J;
 148 extern utf *utf_F;
 149 extern utf *utf_D;
 150
 151 extern utf *utf_void__void;
 152 extern utf *utf_boolean__void;
 153 extern utf *utf_byte__void;
 154 extern utf *utf_char__void;
 155 extern utf *utf_short__void;
 156 extern utf *utf_int__void;
 157 extern utf *utf_long__void;
 158 extern utf *utf_float__void;
 159 extern utf *utf_double__void;
 160
 161 extern utf *utf_void__java_lang_ClassLoader;
 162 extern utf *utf_void__java_lang_Object;
 163 extern utf *utf_void__java_lang_Throwable;
 164 extern utf *utf_java_lang_Object__java_lang_Object;
 165 extern utf *utf_java_lang_String__void;
 166 extern utf *utf_java_lang_String__java_lang_Class;
 167 extern utf *utf_java_lang_Thread__V;
 168 extern utf *utf_java_lang_Throwable__void;
 169
 170 extern utf *utf_not_named_yet;
 171 extern utf *utf_null;
 172 extern utf *array_packagename;
 173
 174
 175 /* function prototypes ********************************************************/
 176
 177 /* initialize the utf8 subsystem */
 178 bool utf8_init(void);
 179
 180 u4 utf_hashkey(const char *text, u4 length);
 181 u4 utf_full_hashkey(const char *text, u4 length);
 182
 183 /* determine hashkey of a unicode-symbol */
 184 u4 unicode_hashkey(u2 *text, u2 length);
 185
 186 /* create new utf-symbol */
 187 utf *utf_new(const char *text, u2 length);
 188
 189 /* make utf symbol from u2 array */
 190 utf *utf_new_u2(u2 *unicodedata, u4 unicodelength, bool isclassname);
 191
 192 utf *utf_new_char(const char *text);
 193 utf *utf_new_char_classname(const char *text);
 194
 195 /* get number of bytes */
 196 u4 utf_bytes(utf *u);
 197
 198 /* get next unicode character of a utf-string */
 199 u2 utf_nextu2(char **utf);
 200
 201 /* get (number of) unicode characters of a utf string (safe) */
 202 s4 utf8_safe_number_of_u2s(const char *text, s4 nbytes);
 203 void utf8_safe_convert_to_u2s(const char *text, s4 nbytes, u2 *buffer);
 204
 205 /* get (number of) unicode characters of a utf string (UNSAFE!) */
 206 u4 utf_get_number_of_u2s(utf *u);
 207 u4 utf_get_number_of_u2s_for_buffer(const char *buffer, u4 blength);
 208
 209 /* determine utf length in bytes of a u2 array */
 210 u4 u2_utflength(u2 *text, u4 u2_length);
 211
 212 void utf_copy(char *buffer, utf *u);
 213 void utf_cat(char *buffer, utf *u);
 214 void utf_copy_classname(char *buffer, utf *u);
 215 void utf_cat_classname(char *buffer, utf *u);
 216
 217 /* write utf symbol to file/buffer */
 218 void utf_display_printable_ascii(utf *u);
 219 void utf_display_printable_ascii_classname(utf *u);
 220
 221 void utf_sprint_convert_to_latin1(char *buffer, utf *u);
 222 void utf_sprint_convert_to_latin1_classname(char *buffer, utf *u);
 223
 224 void utf_strcat_convert_to_latin1(char *buffer, utf *u);
 225 void utf_strcat_convert_to_latin1_classname(char *buffer, utf *u);
 226
 227 void utf_fprint_printable_ascii(FILE *file, utf *u);
 228 void utf_fprint_printable_ascii_classname(FILE *file, utf *u);
 229
 230 /* check if a UTF-8 string is valid */
 231 bool is_valid_utf(char *utf_ptr, char *end_pos);
 232
 233 /* check if a UTF-8 string may be used as a class/field/method name */
 234 bool is_valid_name(char *utf_ptr, char *end_pos);
 235 bool is_valid_name_utf(utf *u);
 236
 237 /* show utf-table */
 238 void utf_show(void);
 239
 240 #endif /* _UTF_H */
 241
 242
 243 /*
 244  * These are local overrides for various environment variables in Emacs.
 245  * Please do not remove this and leave it at the end of the file, where
 246  * Emacs will automagically detect them.
 247  * ---------------------------------------------------------------------
 248  * Local variables:
 249  * mode: c
 250  * indent-tabs-mode: t
 251  * c-basic-offset: 4
 252  * tab-width: 4
 253  * End:
 254  * vim:noexpandtab:sw=4:ts=4:
 255  */