* Updated header: Added 2006. Changed address of FSF. Changed email
[cacao.git] / src / vm / loader.h
index 43ad783804acd9524f3a7a14b5744e338e627489..bc1544c2737caa754194f94dc6469083369669c3 100644 (file)
@@ -1,9 +1,9 @@
-/* loader.h - class loader header
+/* src/vm/loader.h - class loader header
 
-   Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003
-   R. Grafl, A. Krall, C. Kruegel, C. Oates, R. Obermaisser,
-   M. Probst, S. Ring, E. Steiner, C. Thalinger, D. Thuernbeck,
-   P. Tomsich, J. Wenninger
+   Copyright (C) 1996-2005, 2006 R. Grafl, A. Krall, C. Kruegel,
+   C. Oates, R. Obermaisser, M. Platter, M. Probst, S. Ring,
+   E. Steiner, C. Thalinger, D. Thuernbeck, P. Tomsich, C. Ullrich,
+   J. Wenninger, Institut f. Computersprachen - TU Wien
 
    This file is part of CACAO.
 
 
    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
-   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
-   02111-1307, USA.
+   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+   02110-1301, USA.
 
-   Contact: cacao@complang.tuwien.ac.at
+   Contact: cacao@cacaojvm.org
 
    Authors: Reinhard Grafl
 
-   $Id: loader.h 1008 2004-03-31 20:13:14Z edwin $
+   Changes: Christian Thalinger
+
+   $Id: loader.h 4357 2006-01-22 23:33:38Z twisti $
 */
 
 
 #ifndef _LOADER_H
 #define _LOADER_H
 
-#include <stdio.h>
-
-#ifdef USE_ZLIB
-#include "unzip.h"
-#endif
-
-/* export variables */
-
-extern list unloadedclasses;     /* list of all referenced but not loaded classes */
-extern list unlinkedclasses;     /* List containing all unlinked classes */
-extern list linkedclasses;       /* List containing all linked classes */
-
-#ifdef USE_THREADS
-extern int blockInts;
-#endif
+#include "config.h"
 
+#include <stdio.h>
 
-/************************ prototypes ******************************************/
+#include "vm/types.h"
 
-/* initialize laoder, load important systemclasses */
-void loader_init();
 
-void suck_init(char *cpath);
+/* forward typedefs ***********************************************************/
 
-/* free resources */
-void loader_close();
+typedef struct classbuffer classbuffer;
 
-/* load a class and all referenced classes */
-classinfo *loader_load(utf *topname);
 
-/* initializes all loaded classes */
-void loader_initclasses();
+#include "vm/class.h"
+#include "vm/descriptor.h"
+#include "vm/global.h"
+#include "vm/references.h"
+#include "vm/method.h"
+#include "vm/utf8.h"
 
-void loader_compute_subclasses();
 
-/* retrieve constantpool element */
-voidptr class_getconstant(classinfo *class, u4 pos, u4 ctype);
+/* constant pool entries *******************************************************
 
-/* determine type of a constantpool element */
-u4 class_constanttype(classinfo *class, u4 pos);
+       All constant pool entries need a data structure which contain the entrys
+       value. In some cases this structure exist already, in the remaining cases
+       this structure must be generated:
 
-s4 class_findmethodIndex(classinfo *c, utf *name, utf *desc);
+               kind                      structure                     generated?
+       ----------------------------------------------------------------------
+    CONSTANT_Class               classinfo                           no   XXX this will change
+    CONSTANT_Fieldref            constant_FMIref                    yes
+    CONSTANT_Methodref           constant_FMIref                    yes
+    CONSTANT_InterfaceMethodref  constant_FMIref                    yes
+    CONSTANT_String              unicode                             no
+    CONSTANT_Integer             constant_integer                   yes
+    CONSTANT_Float               constant_float                     yes
+    CONSTANT_Long                constant_long                      yes
+    CONSTANT_Double              constant_double                    yes
+    CONSTANT_NameAndType         constant_nameandtype               yes
+    CONSTANT_Utf8                unicode                             no
+    CONSTANT_UNUSED              -
 
-/* search class for a field */
-fieldinfo *class_findfield(classinfo *c, utf *name, utf *desc);
-fieldinfo *class_resolvefield(classinfo *c, utf *name, utf *desc, classinfo *referer, bool except);
+*******************************************************************************/
 
-/* search for a method with a specified name and descriptor */
-methodinfo *class_findmethod(classinfo *c, utf *name, utf *desc);
-methodinfo *class_fetchmethod(classinfo *c, utf *name, utf *desc);
-methodinfo *class_findmethod_w(classinfo *c, utf *name, utf *desc, char*);
-methodinfo *class_resolvemethod(classinfo *c, utf *name, utf *dest);
-methodinfo *class_resolveclassmethod(classinfo *c, utf *name, utf *dest, classinfo *referer, bool except);
-methodinfo *class_resolveinterfacemethod(classinfo *c, utf *name, utf *dest, classinfo *referer, bool except);
+typedef struct {            /* Integer                                        */
+       s4 value;
+} constant_integer;
 
-/* search for a method with specified name and arguments (returntype ignored) */
-methodinfo *class_findmethod_approx(classinfo *c, utf *name, utf *desc);
-methodinfo *class_resolvemethod_approx(classinfo *c, utf *name, utf *dest);
+       
+typedef struct {            /* Float                                          */
+       float value;
+} constant_float;
 
-bool class_issubclass(classinfo *sub, classinfo *super);
 
-/* call initializer of class */
-void class_init(classinfo *c);
+typedef struct {            /* Long                                           */
+       s8 value;
+} constant_long;
+       
 
-void class_showconstanti(classinfo *c, int ii);
+typedef struct {            /* Double                                         */
+       double value;
+} constant_double;
 
-/* debug purposes */
-void class_showmethods(classinfo *c);
-void class_showconstantpool(classinfo *c);
-void print_arraydescriptor(FILE *file, arraydescriptor *desc);
 
-classinfo *loader_load(utf *topname);
-classinfo *loader_load_sysclass(classinfo **top,utf *topname);
+typedef struct {            /* NameAndType (Field or Method)                  */
+       utf *name;              /* field/method name                              */
+       utf *descriptor;        /* field/method type descriptor string            */
+} constant_nameandtype;
 
-/* set buffer for reading classdata */
-void classload_buffer(u1 *buf, int len);
 
-/* return the primitive class inidicated by the given signature character */
-classinfo *class_primitive_from_sig(char sig);
+/* classbuffer ****************************************************************/
 
+struct classbuffer {
+       classinfo *class;                   /* pointer to classinfo structure     */
+       u1        *data;                    /* pointer to byte code               */
+       s4         size;                    /* size of the byte code              */
+       u1        *pos;                     /* current read position              */
+       char      *path;                    /* path to file (for debugging)       */
+};
 
-/* return the class indicated by the given descriptor */
-/* (see loader.c for documentation) */
-#define CLASSLOAD_NEW           0      /* default */
-#define CLASSLOAD_LOAD          0x0001
-#define CLASSLOAD_SKIP          0x0002
-#define CLASSLOAD_PANIC         0      /* default */
-#define CLASSLOAD_NOPANIC       0x0010
-#define CLASSLOAD_PRIMITIVE     0      /* default */
-#define CLASSLOAD_NULLPRIMITIVE 0x0020
-#define CLASSLOAD_VOID          0      /* default */
-#define CLASSLOAD_NOVOID        0x0040
-#define CLASSLOAD_NOCHECKEND    0      /* default */
-#define CLASSLOAD_CHECKEND      0x1000
 
-classinfo *class_from_descriptor(char *utf_ptr,char *end_ptr,char **next,int mode);
-int type_from_descriptor(classinfo **cls,char *utf_ptr,char *end_ptr,char **next,int mode);
+/* export variables ***********************************************************/
 
-/* (used by class_new, don't use directly) */
-void class_new_array(classinfo *c);
+#if defined(USE_THREADS)
+extern int blockInts;
+#endif
 
-void class_link(classinfo *c);
 
-void field_display(fieldinfo *f);
+/* function prototypes ********************************************************/
 
-void method_display(methodinfo *m);
+/* initialize loader, load important systemclasses */
+bool loader_init(u1 *stackbottom);
 
-utf* clinit_desc();
-utf* clinit_name();
+void loader_load_all_classes(void);
 
+/* free resources */
+void loader_close(void);
 
-/******************************** CLASSPATH handling *******************/
-#define CLASSPATH_MAXFILENAME 1000                /* maximum length of a filename           */
-#define CLASSPATH_PATH 0
-#define CLASSPATH_ARCHIVE 1
+/* class loading functions */
+classinfo *load_class_from_sysloader(utf *name);
+classinfo *load_class_from_classloader(utf *name, java_objectheader *cl);
+classinfo *load_class_bootstrap(utf *name);
 
-typedef union classpath_info {
-       struct {
-               int type;
-               union classpath_info *next;
-               char *filename;
-               int pathlen; } filepath;
-#ifdef USE_ZLIB
-       struct {
-               int type;
-               union classpath_info *next;
-               unzFile uf;
-       } archive;
-#endif 
-} classpath_info;
+/* (don't use the following directly) */
+classinfo *load_class_from_classbuffer(classbuffer *cb);
+classinfo *load_newly_created_array(classinfo *c,java_objectheader *loader);
 
 #endif /* _LOADER_H */
 
-
 /*
  * These are local overrides for various environment variables in Emacs.
  * Please do not remove this and leave it at the end of the file, where