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