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