/* 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

   This file is part of CACAO.

   This program is free software; you can redistribute it and/or
   modify it under the terms of the GNU General Public License as
   published by the Free Software Foundation; either version 2, or (at
   your option) any later version.

   This program is distributed in the hope that it will be useful, but
   WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   General Public License for more details.

   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.

   Contact: cacao@complang.tuwien.ac.at

   Authors: Reinhard Grafl

   $Id: loader.h 833 2004-01-04 22:10:24Z jowenn $
*/


#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


/************************ prototypes ******************************************/

/* initialize laoder, load important systemclasses */
void loader_init();

void suck_init(char *cpath);

/* free resources */
void loader_close();

/* load a class and all referenced classes */
classinfo *loader_load(utf *topname);

/* initializes all loaded classes */
void loader_initclasses();

void loader_compute_subclasses();

/* retrieve constantpool element */
voidptr class_getconstant(classinfo *class, u4 pos, u4 ctype);

/* determine type of a constantpool element */
u4 class_constanttype(classinfo *class, u4 pos);

s4 class_findmethodIndex(classinfo *c, utf *name, utf *desc);

/* search class for a field */
fieldinfo *class_findfield(classinfo *c, utf *name, utf *desc);

/* 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_resolvemethod(classinfo *c, utf *name, utf *dest);

/* 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);

bool class_issubclass(classinfo *sub, classinfo *super);

/* call initializer of class */
void class_init(classinfo *c);

void class_showconstanti(classinfo *c, int ii);

/* 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);

/* 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);


/* 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);

/* (used by class_new, don't use directly) */
void class_new_array(classinfo *c);

void class_link(classinfo *c);

void field_display(fieldinfo *f);

void method_display(methodinfo *m);

utf* clinit_desc();
utf* clinit_name();


/******************************** CLASSPATH handling *******************/
#define CLASSPATH_MAXFILENAME 1000                /* maximum length of a filename           */
#define CLASSPATH_PATH 0
#define CLASSPATH_ARCHIVE 1

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;

#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
 * Emacs will automagically detect them.
 * ---------------------------------------------------------------------
 * Local variables:
 * mode: c
 * indent-tabs-mode: t
 * c-basic-offset: 4
 * tab-width: 4
 * End:
 */