Documentation for the ABC Analysis
[cacao.git] / src / vm / primitive.hpp
1 /* src/vm/primitive.hpp - primitive types
2
3    Copyright (C) 2007, 2008
4    CACAOVM - Verein zur Foerderung der freien virtuellen Maschine CACAO
5
6    This file is part of CACAO.
7
8    This program is free software; you can redistribute it and/or
9    modify it under the terms of the GNU General Public License as
10    published by the Free Software Foundation; either version 2, or (at
11    your option) any later version.
12
13    This program is distributed in the hope that it will be useful, but
14    WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16    General Public License for more details.
17
18    You should have received a copy of the GNU General Public License
19    along with this program; if not, write to the Free Software
20    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
21    02110-1301, USA.
22
23 */
24
25
26 #ifndef _PRIMITIVE_HPP
27 #define _PRIMITIVE_HPP
28
29 #include "config.h"
30
31 #include <stdint.h>
32
33 #include "vm/class.hpp"
34 #include "vm/global.h"
35 #include "vm/linker.hpp"
36 #include "vm/utf8.h"
37
38
39 #ifdef __cplusplus
40
41 class Primitive {
42 public:
43         static void initialize_table();
44         static void post_initialize_table();
45
46         static classinfo*     get_class_by_name(utf *name);
47         static classinfo*     get_class_by_type(int type);
48         static classinfo*     get_class_by_char(char ch);
49         static classinfo*     get_arrayclass_by_name(utf* name);
50         static classinfo*     get_arrayclass_by_type(int type);
51
52         static int            get_type_by_wrapperclass(classinfo *c);
53         static int            get_type_by_primitiveclass(classinfo *c);
54
55         static java_handle_t* box(int type, imm_union value);
56
57         static java_handle_t* box(uint8_t value);
58         static java_handle_t* box(int8_t value);
59         static java_handle_t* box(uint16_t value);
60         static java_handle_t* box(int16_t value);
61         static java_handle_t* box(int32_t value);
62         static java_handle_t* box(int64_t value);
63         static java_handle_t* box(float value);
64         static java_handle_t* box(double value);
65
66         static imm_union      unbox(java_handle_t *o);
67         static bool           unbox_typed(java_handle_t *o, int type, imm_union* value);
68
69         static uint8_t        unbox_boolean(java_handle_t* o);
70         static int8_t         unbox_byte(java_handle_t* o);
71         static uint16_t       unbox_char(java_handle_t* o);
72         static int16_t        unbox_short(java_handle_t* o);
73         static int32_t        unbox_int(java_handle_t* o);
74         static int64_t        unbox_long(java_handle_t* o);
75         static float          unbox_float(java_handle_t* o);
76         static double         unbox_double(java_handle_t* o);
77 };
78
79 #endif
80
81 /* primitive data types *******************************************************/
82
83 /* These values are used in parsed descriptors and in some other
84    places were the different types handled internally as TYPE_INT have
85    to be distinguished. */
86
87 #define PRIMITIVETYPE_COUNT  11  /* number of primitive types (+ dummies)     */
88
89 /* CAUTION: Don't change the numerical values! These constants are
90    used as indices into the primitive type table. */
91
92 #define PRIMITIVETYPE_INT     TYPE_INT
93 #define PRIMITIVETYPE_LONG    TYPE_LNG
94 #define PRIMITIVETYPE_FLOAT   TYPE_FLT
95 #define PRIMITIVETYPE_DOUBLE  TYPE_DBL
96 #define PRIMITIVETYPE_DUMMY1  TYPE_ADR     /* not used! */
97 #define PRIMITIVETYPE_BYTE    5
98 #define PRIMITIVETYPE_CHAR    6
99 #define PRIMITIVETYPE_SHORT   7
100 #define PRIMITIVETYPE_BOOLEAN 8
101 #define PRIMITIVETYPE_DUMMY2  9            /* not used! */
102 #define PRIMITIVETYPE_VOID    TYPE_VOID
103
104
105 /* primitivetypeinfo **********************************************************/
106
107 struct primitivetypeinfo {
108         const char* cname;                   /* char name of primitive class      */
109         utf*        name;                    /* name of primitive class           */
110         classinfo*  class_wrap;              /* class for wrapping primitive type */
111         classinfo*  class_primitive;         /* primitive class                   */
112         const char* wrapname;                /* name of class for wrapping        */
113         const char  typesig;                 /* one character type signature      */
114         const char* arrayname;               /* name of primitive array class     */
115         classinfo*  arrayclass;              /* primitive array class             */
116 };
117
118
119 /* global variables ***********************************************************/
120
121 /* This array can be indexed by the PRIMITIVETYPE_ and ARRAYTYPE_
122    constants (except ARRAYTYPE_OBJECT). */
123
124 extern primitivetypeinfo primitivetype_table[PRIMITIVETYPE_COUNT];
125
126 /* this function is in src/vm/primitivecore.c */
127 void       primitive_init(void);
128 void       primitive_postinit(void);
129
130 #endif // _PRIMITIVE_HPP
131
132
133 /*
134  * These are local overrides for various environment variables in Emacs.
135  * Please do not remove this and leave it at the end of the file, where
136  * Emacs will automagically detect them.
137  * ---------------------------------------------------------------------
138  * Local variables:
139  * mode: c++
140  * indent-tabs-mode: t
141  * c-basic-offset: 4
142  * tab-width: 4
143  * End:
144  * vim:noexpandtab:sw=4:ts=4:
145  */