minor documentation corrections

[cacao.git] / global.h

diff --git a/global.h b/global.h
index 9a57af85ab853067f1d156c19df516dc8451ffa6..038016f7b0bfe91efae1b1dc70700f76834a2481 100644 (file)
--- a/global.h
+++ b/global.h
@@ -31,7 +31,7 @@
             Philipp Tomsich
                        Edwin Steiner
 
-   $Id: global.h 723 2003-12-08 19:51:32Z edwin $
+   $Id: global.h 888 2004-01-19 12:16:11Z edwin $
 
 */
 
@@ -39,12 +39,15 @@
 #ifndef _GLOBAL_H
 #define _GLOBAL_H
 
+#define _GNU_SOURCE
+
 #include "config.h"
 #include "types.h"
 #include "toolbox/list.h"
 
-
-#define _GNU_SOURCE
+#if defined(USE_THREADS) && defined(NATIVE_THREADS)
+#include <pthread.h>
+#endif
 
 #define STATISTICS          /* if enabled collects program statistics         */
 
@@ -59,9 +62,17 @@
  */
 #define CACAO_TYPECHECK
 
+/*
+ * TYPECHECK_STACK_COMPCAT activates full checking of computational
+ * categories for stack manipulations (POP,POP2,SWAP,DUP,DUP2,DUP_X1,
+ * DUP2_X1,DUP_X2,DUP2_X2).
+ */
+/* #define TYPECHECK_STACK_COMPCAT */
+
 /*
  * Macros for configuration of the typechecking code
  *
+ * TYPECHECK_STATISTICS activates gathering statistical information.
  * TYPEINFO_DEBUG activates debug checks and debug helpers in typeinfo.c
  * TYPECHECK_DEBUG activates debug checks in typecheck.c
  * TYPEINFO_DEBUG_TEST activates the typeinfo test at startup.
@@ -69,10 +80,11 @@
  * TYPECHECK_VERBOSE activates all debug messages
  */
 #ifdef CACAO_TYPECHECK
-#define TYPEINFO_DEBUG
-#define TYPECHECK_DEBUG
+/*#define TYPECHECK_STATISTICS*/
+/*#define TYPEINFO_DEBUG*/
+/*#define TYPECHECK_DEBUG*/
 /*#define TYPEINFO_DEBUG_TEST*/
-#define TYPECHECK_VERBOSE
+/*#define TYPECHECK_VERBOSE*/
 /*#define TYPECHECK_VERBOSE_IMPORTANT*/
 #if defined(TYPECHECK_VERBOSE) || defined(TYPECHECK_VERBOSE_IMPORTANT)
 #define TYPECHECK_VERBOSE_OPT
@@ -164,6 +176,7 @@ void cacao_shutdown(s4 status);
 #define ACC_PROTECTED             0x0004
 #define ACC_STATIC                0x0008
 #define ACC_FINAL                 0x0010
+#define ACC_SUPER                 0x0020
 #define ACC_SYNCHRONIZED          0x0020
 #define ACC_VOLATILE              0x0040
 #define ACC_TRANSIENT             0x0080
@@ -465,6 +478,10 @@ struct fieldinfo {       /* field of a class                                 */
        s4  offset;           /* offset from start of object (instance variables) */
 
        imm_union value;      /* storage for static values (class variables)      */
+
+       classinfo *class;     /* needed by typechecker. Could be optimized        */
+                             /* away by using constant_FMIref instead of         */
+                             /* fieldinfo throughout the compiler.               */
        
        xtafldinfo *xta;
 };
@@ -582,7 +599,7 @@ struct classinfo {                /* class structure                          */
        struct gnu_classpath_RawData* vmData; /* gnu classpath */
 
        s4          flags;            /* ACC flags                                */
-       utf        *name;             /* class name                               */ 
+       utf        *name;             /* class name                               */
 
        s4          cpcount;          /* number of entries in constant pool       */
        u1         *cptags;           /* constant pool tags                       */
@@ -627,10 +644,11 @@ struct classinfo {                /* class structure                          */
        s4          classUsed;        /* 0= not used 1 = used   CO-RT             */
 
        classSetNode *impldBy;        /* implemented by class set                 */
+       utf        *packagename;      /* full name of the package                 */
 };
 
 /* check if class is an array class. Only use for linked classes! */
-#define CLASS_IS_ARRAY(clsinfo)  (clsinfo->vftbl->arraydesc != NULL)
+#define CLASS_IS_ARRAY(clsinfo)  ((clsinfo)->vftbl->arraydesc != NULL)
 
 
 /* virtual function table ******************************************************
@@ -727,7 +745,7 @@ struct arraydescriptor {
        short  dimension;        /* dimension of the array (always >= 1)          */
     s4     dataoffset;       /* offset of the array data from object pointer  */
        s4     componentsize;    /* size of a component in bytes                  */
-       short  elementtype;      /* ARRAYTYPE_* constant (XXX optimize away?)     */
+       short  elementtype;      /* ARRAYTYPE_* constant                          */
 };
 
 
@@ -746,11 +764,37 @@ extern classinfo *class_java_lang_OutOfMemoryError;
 extern classinfo *class_java_lang_ArithmeticException;
 extern classinfo *class_java_lang_ArrayStoreException;
 extern classinfo *class_java_lang_ThreadDeath;
+
+/* pseudo classes for the type checker ****************************************/
+
+/*
+ * pseudo_class_Arraystub
+ *     (extends Object implements Cloneable, java.io.Serializable)
+ *
+ *     If two arrays of incompatible component types are merged,
+ *     the resulting reference has no accessible components.
+ *     The result does, however, implement the interfaces Cloneable
+ *     and java.io.Serializable. This pseudo class is used internally
+ *     to represent such results. (They are *not* considered arrays!)
+ *
+ * pseudo_class_Null
+ *
+ *     This pseudo class is used internally to represent the
+ *     null type.
+ *
+ * pseudo_class_New
+ *
+ *     This pseudo class is used internally to represent the
+ *     the 'uninitialized object' type.
+ */
+
 extern classinfo *pseudo_class_Arraystub;
 extern classinfo *pseudo_class_Null;
 extern classinfo *pseudo_class_New;
 extern vftbl *pseudo_class_Arraystub_vftbl;
 
+extern utf *array_packagename;
+
 
 /* instances of some system classes *******************************************/
 
@@ -772,16 +816,17 @@ extern bool verbose;
 extern bool opt_rt;             /* Rapid Type Analysis for better inlining CO-RT*/
 extern bool opt_xta;            /* X Type Analysis for better inlining    CO-XTA*/
 extern bool opt_vta;            /* Variable Type Analysis for better inlining    CO-VTA*/
+extern bool opt_verify;         /* true if classfiles should be verified      */
 #ifdef TYPECHECK_VERBOSE_OPT
 extern bool typecheckverbose;
 #endif
 
-//extern int pClassHeir;
-//extern int pCallgraph;
-//extern int pOpcodes;
-//extern int pStats;
+/*extern int pClassHeir;*/
+/*extern int pCallgraph;*/
+/*extern int pOpcodes;*/
+/*extern int pStats;*/
 
-//extern void RT_jit_parse(methodinfo *m);
+/*extern void RT_jit_parse(methodinfo *m);*/
 
 
 /* statistic variables ********************************************************/
@@ -846,6 +891,18 @@ extern primitivetypeinfo primitivetype_table[PRIMITIVETYPE_COUNT];
                                if ((utf_ptr)[-1] != ';')                                                               \
                                        (errorflag) = true; }} while(0)
 
+
+/* Synchronization ************************************************************/
+
+#if defined(USE_THREADS) && defined(NATIVE_THREADS)
+extern pthread_mutex_t compiler_mutex;
+extern int cast_counter;
+
+void cast_lock();
+void cast_lock2();
+void cast_unlock();
+#endif
+
 #endif /* _GLOBAL_H */