* Removed all Id tags.
[cacao.git] / src / vmcore / field.h
1 /* src/vmcore/field.h - field functions 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 */
26
27
28 #ifndef _FIELD_H
29 #define _FIELD_H
30
31 /* forward typedefs ***********************************************************/
32
33 typedef struct fieldinfo fieldinfo; 
34
35
36 #include "config.h"
37 #include "vm/types.h"
38
39 #include "vm/global.h"
40
41 #include "vmcore/descriptor.h"
42 #include "vmcore/class.h"
43 #include "vmcore/loader.h"
44 #include "vmcore/references.h"
45 #include "vmcore/utf8.h"
46
47
48 /* fieldinfo ******************************************************************/
49
50 struct fieldinfo {            /* field of a class                                 */
51
52         /* CAUTION: The first field must be a pointer that is never the same      */
53         /*          value as CLASSREF_PSEUDO_VFTBL! This is used to check whether */
54         /*          a constant_FMIref has been resolved.                          */
55
56         classinfo *class;     /* needed by typechecker. Could be optimized        */
57                               /* away by using constant_FMIref instead of         */
58                               /* fieldinfo throughout the compiler.               */
59
60         s4         flags;     /* ACC flags                                        */
61         s4         type;      /* basic data type                                  */
62         utf       *name;      /* name of field                                    */
63         utf       *descriptor;/* JavaVM descriptor string of field                */
64         utf       *signature; /* Signature attribute string                       */
65         typedesc  *parseddesc;/* parsed descriptor                                */
66
67         int32_t    offset;    /* offset from start of object (instance variables) */
68         imm_union *value;     /* storage for static values (class variables)      */
69 };
70
71
72 /* function prototypes ********************************************************/
73
74 bool       field_load(classbuffer *cb, fieldinfo *f, descriptor_pool *descpool);
75 classinfo *field_get_type(fieldinfo *f);
76 void       field_free(fieldinfo *f);
77
78 java_handle_bytearray_t *field_get_annotations(fieldinfo *f);
79
80 #if !defined(NDEBUG)
81 void field_printflags(fieldinfo *f);
82 void field_print(fieldinfo *f);
83 void field_println(fieldinfo *f);
84 void field_fieldref_print(constant_FMIref *fr);
85 void field_fieldref_println(constant_FMIref *fr);
86 #endif
87
88 #endif /* _FIELD_H */
89
90
91 /*
92  * These are local overrides for various environment variables in Emacs.
93  * Please do not remove this and leave it at the end of the file, where
94  * Emacs will automagically detect them.
95  * ---------------------------------------------------------------------
96  * Local variables:
97  * mode: c
98  * indent-tabs-mode: t
99  * c-basic-offset: 4
100  * tab-width: 4
101  * End:
102  */