231e78a3dc23bd8c61df26178d2c55974dfb477f
[cacao.git] / src / vmcore / loader.h
1 /* src/vmcore/loader.h - class loader header
2
3    Copyright (C) 1996-2005, 2006, 2007 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    $Id: loader.h 8295 2007-08-11 17:57:24Z michi $
26 */
27
28
29 #ifndef _LOADER_H
30 #define _LOADER_H
31
32 /* forward typedefs ***********************************************************/
33
34 typedef struct classbuffer classbuffer;
35
36
37 #include "config.h"
38
39 #include <stdio.h>
40
41 #include "vm/types.h"
42
43 #include "vm/global.h"
44
45 #include "vmcore/descriptor.h"
46 #include "vmcore/class.h"
47 #include "vmcore/method.h"
48 #include "vmcore/references.h"
49 #include "vmcore/utf8.h"
50
51
52 /* constant pool entries *******************************************************
53
54         All constant pool entries need a data structure which contain the entrys
55         value. In some cases this structure exist already, in the remaining cases
56         this structure must be generated:
57
58                 kind                      structure                     generated?
59         ----------------------------------------------------------------------
60     CONSTANT_Class               constant_classref                  yes
61     CONSTANT_Fieldref            constant_FMIref                    yes
62     CONSTANT_Methodref           constant_FMIref                    yes
63     CONSTANT_InterfaceMethodref  constant_FMIref                    yes
64     CONSTANT_String              unicode                             no
65     CONSTANT_Integer             constant_integer                   yes
66     CONSTANT_Float               constant_float                     yes
67     CONSTANT_Long                constant_long                      yes
68     CONSTANT_Double              constant_double                    yes
69     CONSTANT_NameAndType         constant_nameandtype               yes
70     CONSTANT_Utf8                unicode                             no
71     CONSTANT_UNUSED              -
72
73 *******************************************************************************/
74
75 typedef struct {            /* Integer                                        */
76         s4 value;
77 } constant_integer;
78
79         
80 typedef struct {            /* Float                                          */
81         float value;
82 } constant_float;
83
84
85 typedef struct {            /* Long                                           */
86         s8 value;
87 } constant_long;
88         
89
90 typedef struct {            /* Double                                         */
91         double value;
92 } constant_double;
93
94
95 typedef struct {            /* NameAndType (Field or Method)                  */
96         utf *name;              /* field/method name                              */
97         utf *descriptor;        /* field/method type descriptor string            */
98 } constant_nameandtype;
99
100
101 /* classbuffer ****************************************************************/
102
103 struct classbuffer {
104         classinfo *class;                   /* pointer to classinfo structure     */
105         u1        *data;                    /* pointer to byte code               */
106         s4         size;                    /* size of the byte code              */
107         u1        *pos;                     /* current read position              */
108         char      *path;                    /* path to file (for debugging)       */
109 };
110
111
112 /* classloader ****************************************************************/
113
114 typedef java_object_t classloader;
115
116
117 /* function prototypes ********************************************************/
118
119 /* initialize loader, load important systemclasses */
120 bool loader_init(void);
121
122 void loader_load_all_classes(void);
123
124 bool loader_skip_attribute_body(classbuffer *cb);
125
126 #if defined(ENABLE_JAVASE)
127 bool loader_load_attribute_signature(classbuffer *cb, utf **signature);
128 #endif
129
130 /* free resources */
131 void loader_close(void);
132
133 /* class loading functions */
134 classinfo *load_class_from_sysloader(utf *name);
135 classinfo *load_class_from_classloader(utf *name, classloader *cl);
136 classinfo *load_class_bootstrap(utf *name);
137
138 /* (don't use the following directly) */
139 classinfo *load_class_from_classbuffer(classbuffer *cb);
140 classinfo *load_newly_created_array(classinfo *c, classloader *loader);
141
142 #endif /* _LOADER_H */
143
144 /*
145  * These are local overrides for various environment variables in Emacs.
146  * Please do not remove this and leave it at the end of the file, where
147  * Emacs will automagically detect them.
148  * ---------------------------------------------------------------------
149  * Local variables:
150  * mode: c
151  * indent-tabs-mode: t
152  * c-basic-offset: 4
153  * tab-width: 4
154  * End:
155  * vim:noexpandtab:sw=4:ts=4:
156  */