gcc/java/jcf.h

   1 /* Utility macros to read Java(TM) .class files and byte codes.
   2    Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003
   3    Free Software Foundation, Inc.
   4
   5 This file is part of GCC.
   6
   7 GCC is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 2, or (at your option)
  10 any later version.
  11
  12 GCC is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GCC; see the file COPYING.  If not, write to
  19 the Free Software Foundation, 59 Temple Place - Suite 330,
  20 Boston, MA 02111-1307, USA.
  21
  22 Java and all Java-based marks are trademarks or registered trademarks
  23 of Sun Microsystems, Inc. in the United States and other countries.
  24 The Free Software Foundation is independent of Sun Microsystems, Inc.  */
  25
  26 /* Written by Per Bothner <bothner@cygnus.com>, February 1996. */
  27
  28 #ifndef GCC_JCF_H
  29 #define GCC_JCF_H
  30 #include "javaop.h"
  31 #ifndef DEFUN
  32 #if defined (__STDC__)
  33 #define AND             ,
  34 #define PTR             void *
  35 #define DEFUN(name, arglist, args)      name(args)
  36 #else
  37 #define PTR             char *
  38 #define AND             ;
  39 #define DEFUN(name, arglist, args)      name arglist args;
  40 #endif
  41 #endif /* !DEFUN */
  42
  43 #ifndef PARAMS
  44 #if defined (__STDC__)
  45 #define PARAMS (paramlist)    paramlist
  46 #else
  47 #define PARAMS (paramlist)    ()
  48 #endif
  49 #endif
  50
  51 #ifndef JCF_u4
  52 #define JCF_u4 unsigned long
  53 #endif
  54 #ifndef JCF_u2
  55 #define JCF_u2 unsigned short
  56 #endif
  57
  58 #define ALLOC xmalloc
  59 #define REALLOC xrealloc
  60 #ifndef FREE
  61 #define FREE(PTR) free(PTR)
  62 #endif
  63
  64 #ifdef JCF_word
  65 #define JCF_word JCF_u4
  66 #endif
  67
  68 /* If we have both "scandir" and "alphasort", we can cache directory
  69    listings to reduce the time taken to search the classpath.  */
  70 #if defined(HAVE_SCANDIR) && defined(HAVE_ALPHASORT)
  71 #define JCF_USE_SCANDIR 1
  72 #else
  73 #define JCF_USE_SCANDIR 0
  74 #endif
  75
  76 struct JCF;
  77 typedef int (*jcf_filbuf_t) PARAMS ((struct JCF*, int needed));
  78
  79 typedef struct CPool {
  80   /* Available number of elements in the constants array, before it
  81      must be re-allocated. */
  82   int capacity;
  83
  84   /* The constant_pool_count. */
  85   int           count;
  86
  87   uint8*        tags;
  88
  89   jword*        data;
  90 } CPool;
  91
  92 struct ZipDirectory;
  93
  94 /* JCF encapsulates the state of reading a Java Class File. */
  95
  96 typedef struct JCF {
  97   unsigned char *buffer;
  98   unsigned char *buffer_end;
  99   unsigned char *read_ptr;
 100   unsigned char *read_end;
 101   int java_source : 1;
 102   int right_zip : 1;
 103   int finished : 1;
 104   jcf_filbuf_t filbuf;
 105   void *read_state;
 106   const char *filename;
 107   const char *classname;
 108   struct ZipDirectory *zipd;    /* Directory entry where it was found */
 109   JCF_u2 access_flags, this_class, super_class;
 110   CPool cpool;
 111 } JCF;
 112 /*typedef JCF*  JCF_FILE;*/
 113
 114 #define JCF_SEEN_IN_ZIP(JCF) ((JCF)->zipd != NULL)
 115
 116 /* The CPOOL macros take a (pointer to a) CPool.
 117    The JPOOL macros take a (pointer to a) JCF.
 118    Some of the latter should perhaps be deprecated or removed. */
 119
 120 #define CPOOL_COUNT(CPOOL) ((CPOOL)->count)
 121 #define JPOOL_SIZE(JCF) CPOOL_COUNT(&(JCF)->cpool)
 122 #define JPOOL_TAG(JCF, INDEX) ((JCF)->cpool.tags[INDEX])
 123 /* The INDEX'th constant pool entry as a JCF_u4. */
 124 #define CPOOL_UINT(CPOOL, INDEX) ((CPOOL)->data[INDEX])
 125 #define JPOOL_UINT(JCF, INDEX) CPOOL_UINT(&(JCF)->cpool, INDEX) /*deprecated*/
 126 /* The first uint16 of the INDEX'th constant pool entry. */
 127 #define CPOOL_USHORT1(CPOOL, INDEX) ((CPOOL)->data[INDEX] & 0xFFFF)
 128 #define JPOOL_USHORT1(JCF, INDEX) CPOOL_USHORT1(&(JCF)->cpool, INDEX)
 129 /* The second uint16 of the INDEX'th constant pool entry. */
 130 #define CPOOL_USHORT2(CPOOL, INDEX) ((CPOOL)->data[INDEX] >> 16)
 131 #define JPOOL_USHORT2(JCF, INDEX) CPOOL_USHORT2(&(JCF)->cpool, INDEX)
 132 #define JPOOL_LONG(JCF, INDEX) \
 133   WORDS_TO_LONG (JPOOL_UINT(JCF, INDEX), JPOOL_UINT(JCF, (INDEX)+1))
 134 #define JPOOL_DOUBLE(JCF, INDEX) \
 135   WORDS_TO_DOUBLE  (JPOOL_UINT(JCF, INDEX), JPOOL_UINT(JCF, (INDEX)+1))
 136 #ifndef JPOOL_UTF_LENGTH
 137 #define JPOOL_UTF_LENGTH(JCF, INDEX) \
 138   GET_u2 ((JCF)->buffer+JPOOL_UINT(JCF, INDEX))
 139 #endif
 140 #ifndef JPOOL_UTF_DATA
 141 #define JPOOL_UTF_DATA(JCF, INDEX) \
 142   ((JCF)->buffer+JPOOL_UINT(JCF, INDEX)+2)
 143 #endif
 144 #define JPOOL_INT(JCF, INDEX) (WORD_TO_INT(JPOOL_UINT (JCF, INDEX)))
 145 #define JPOOL_FLOAT(JCF, INDEX) WORD_TO_FLOAT (JPOOL_UINT (JCF, INDEX))
 146
 147 #define CPOOL_INDEX_IN_RANGE(CPOOL, INDEX) \
 148  ((INDEX) > 0 && (INDEX) < CPOOL_COUNT(CPOOL))
 149
 150 #define CPOOL_FINISH(CPOOL) { \
 151   if ((CPOOL)->tags) FREE ((CPOOL)->tags); \
 152   if ((CPOOL)->data) FREE ((CPOOL)->data); }
 153
 154 #define JCF_FINISH(JCF) { \
 155   CPOOL_FINISH(&(JCF)->cpool); \
 156   if ((JCF)->buffer) FREE ((JCF)->buffer); \
 157   if ((JCF)->filename) FREE ((char *) (JCF)->filename); \
 158   if ((JCF)->classname) FREE ((char *) (JCF)->classname); \
 159   (JCF)->finished = 1; }
 160
 161 #define CPOOL_INIT(CPOOL) \
 162   ((CPOOL)->capacity = 0, (CPOOL)->count = 0, (CPOOL)->tags = 0, (CPOOL)->data = 0)
 163
 164 #define CPOOL_REINIT(CPOOL) ((CPOOL)->count = 0)
 165
 166 #define JCF_ZERO(JCF)  \
 167   ((JCF)->buffer = (JCF)->buffer_end = (JCF)->read_ptr = (JCF)->read_end = 0,\
 168    (JCF)->read_state = 0, (JCF)->filename = (JCF)->classname = 0, \
 169    CPOOL_INIT(&(JCF)->cpool), (JCF)->java_source = 0, (JCF)->zipd = 0, \
 170    (JCF)->finished = 0)
 171
 172 /* Given that PTR points to a 2-byte unsigned integer in network
 173    (big-endian) byte-order, return that integer. */
 174 #define GET_u2(PTR) (((PTR)[0] << 8) | ((PTR)[1]))
 175 /* Like GET_u2, but for little-endian format. */
 176 #define GET_u2_le(PTR) (((PTR)[1] << 8) | ((PTR)[0]))
 177
 178 /* Given that PTR points to a 4-byte unsigned integer in network
 179    (big-endian) byte-order, return that integer. */
 180 #define GET_u4(PTR) (((JCF_u4)(PTR)[0] << 24) | ((JCF_u4)(PTR)[1] << 16) \
 181   | ((JCF_u4)(PTR)[2] << 8) | ((JCF_u4)(PTR)[3]))
 182 /* Like GET_u4, but for little-endian order. */
 183 #define GET_u4_le(PTR) (((JCF_u4)(PTR)[3] << 24) | ((JCF_u4)(PTR)[2] << 16) \
 184   | ((JCF_u4)(PTR)[1] << 8) | ((JCF_u4)(PTR)[0]))
 185
 186 /* Make sure there are COUNT bytes readable. */
 187 #define JCF_FILL(JCF, COUNT) \
 188   ((JCF)->read_end-(JCF)->read_ptr >= (COUNT) ? 0 : (*(JCF)->filbuf)(JCF, COUNT))
 189 #define JCF_GETC(JCF) (JCF_FILL(JCF, 1) ? -1 : *(JCF)->read_ptr++)
 190 #define JCF_READ(JCF, BUFFER, N) \
 191     (memcpy (BUFFER, (JCF)->read_ptr, N), (JCF)->read_ptr += (N))
 192 #define JCF_SKIP(JCF,N) ((JCF)->read_ptr += (N))
 193 #define JCF_readu(JCF) (*(JCF)->read_ptr++)
 194
 195 /* Reads an unsigned 2-byte integer in network (big-endian) byte-order
 196    from JCF.  Returns that integer.
 197    Does not check for EOF (make sure to call JCF_FILL before-hand). */
 198 #define JCF_readu2(JCF) ((JCF)->read_ptr += 2, GET_u2 ((JCF)->read_ptr-2))
 199 #define JCF_readu2_le(JCF) ((JCF)->read_ptr += 2, GET_u2_le((JCF)->read_ptr-2))
 200
 201 /* Like JCF_readu2, but read a 4-byte unsigned integer. */
 202 #define JCF_readu4(JCF) ((JCF)->read_ptr += 4, GET_u4 ((JCF)->read_ptr-4))
 203 #define JCF_readu4_le(JCF) ((JCF)->read_ptr += 4, GET_u4_le((JCF)->read_ptr-4))
 204
 205 #define JCF_TELL(JCF) ((JCF)->read_ptr - (JCF)->buffer)
 206 #define JCF_SEEK(JCF, POS) ((JCF)->read_ptr = (JCF)->buffer + (POS))
 207
 208 #define ACC_PUBLIC 0x0001
 209 #define ACC_PRIVATE 0x0002
 210 #define ACC_PROTECTED 0x0004
 211 #define ACC_STATIC 0x0008
 212 #define ACC_FINAL 0x0010
 213 #define ACC_SYNCHRONIZED 0x0020
 214 #define ACC_SUPER 0x0020
 215 #define ACC_VOLATILE 0x0040
 216 #define ACC_TRANSIENT 0x0080
 217 #define ACC_NATIVE 0x0100
 218 #define ACC_INTERFACE 0x0200
 219 #define ACC_ABSTRACT 0x0400
 220 #define ACC_STRICT 0x0800
 221
 222 #define ACC_VISIBILITY (ACC_PUBLIC | ACC_PRIVATE | ACC_PROTECTED)
 223
 224 #define CONSTANT_Class 7
 225 #define CONSTANT_Fieldref 9
 226 #define CONSTANT_Methodref 10
 227 #define CONSTANT_InterfaceMethodref 11
 228 #define CONSTANT_String 8
 229 #define CONSTANT_Integer 3
 230 #define CONSTANT_Float 4
 231 #define CONSTANT_Long 5
 232 #define CONSTANT_Double 6
 233 #define CONSTANT_NameAndType 12
 234 #define CONSTANT_Utf8 1
 235 #define CONSTANT_Unicode 2
 236
 237 #define DEFAULT_CLASS_PATH "."
 238
 239 extern const char *find_class PARAMS ((const char *, int, JCF*, int));
 240 extern const char *find_classfile PARAMS ((char *, JCF*, const char *));
 241 extern int jcf_filbuf_from_stdio PARAMS ((JCF *jcf, int count));
 242 extern int jcf_unexpected_eof PARAMS ((JCF*, int)) ATTRIBUTE_NORETURN;
 243
 244 /* Extract a character from a Java-style Utf8 string.
 245  * PTR points to the current character.
 246  * LIMIT points to the end of the Utf8 string.
 247  * PTR is incremented to point after the character that gets returned.
 248  * On an error, -1 is returned. */
 249 #define UTF8_GET(PTR, LIMIT) \
 250   ((PTR) >= (LIMIT) ? -1 \
 251    : *(PTR) < 128 ? *(PTR)++ \
 252    : (*(PTR)&0xE0) == 0xC0 && ((PTR)+=2)<=(LIMIT) && ((PTR)[-1]&0xC0) == 0x80 \
 253    ? (((PTR)[-2] & 0x1F) << 6) + ((PTR)[-1] & 0x3F) \
 254    : (*(PTR) & 0xF0) == 0xE0 && ((PTR) += 3) <= (LIMIT) \
 255    && ((PTR)[-2] & 0xC0) == 0x80 && ((PTR)[-1] & 0xC0) == 0x80 \
 256    ? (((PTR)[-3]&0x0F) << 12) + (((PTR)[-2]&0x3F) << 6) + ((PTR)[-1]&0x3F) \
 257    : ((PTR)++, -1))
 258
 259 extern char *jcf_write_base_directory;
 260
 261 /* Debug macros, for the front end */
 262
 263 extern int quiet_flag;
 264 #ifdef VERBOSE_SKELETON
 265 #undef SOURCE_FRONTEND_DEBUG
 266 #define SOURCE_FRONTEND_DEBUG(X)                                \
 267   {if (!quiet_flag) {printf ("* "); printf X; putchar ('\n');} }
 268 #else
 269 #define SOURCE_FRONTEND_DEBUG(X)
 270 #endif
 271
 272 /* Declarations for dependency code.  */
 273 extern void jcf_dependency_reset PARAMS ((void));
 274 extern void jcf_dependency_set_target PARAMS ((const char *));
 275 extern void jcf_dependency_add_target PARAMS ((const char *));
 276 extern void jcf_dependency_set_dep_file PARAMS ((const char *));
 277 extern void jcf_dependency_add_file PARAMS ((const char *, int));
 278 extern void jcf_dependency_write PARAMS ((void));
 279 extern void jcf_dependency_init PARAMS ((int));
 280 extern void jcf_dependency_print_dummies PARAMS ((void));
 281
 282 /* Declarations for path handling code.  */
 283 extern void jcf_path_init PARAMS ((void));
 284 extern void jcf_path_classpath_arg PARAMS ((const char *));
 285 extern void jcf_path_bootclasspath_arg PARAMS ((const char *));
 286 extern void jcf_path_extdirs_arg PARAMS ((const char *));
 287 extern void jcf_path_include_arg PARAMS ((const char *));
 288 extern void jcf_path_seal PARAMS ((int));
 289 extern void *jcf_path_start PARAMS ((void));
 290 extern void *jcf_path_next PARAMS ((void *));
 291 extern char *jcf_path_name PARAMS ((void *));
 292 extern int jcf_path_is_zipfile PARAMS ((void *));
 293 extern int jcf_path_is_system PARAMS ((void *));
 294 extern int jcf_path_max_len PARAMS ((void));
 295
 296 #endif /* ! GCC_JCF_H */