-
Notifications
You must be signed in to change notification settings - Fork 0
/
VdmClass.h
194 lines (161 loc) · 6.66 KB
/
VdmClass.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
/*
* #%~
* The VDM to C Code Generator
* %%
* Copyright (C) 2015 - 2016 Overture
* %%
* 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 3 of the
* License, 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, see
* <http://www.gnu.org/licenses/gpl-3.0.html>.
* #~%
*/
/*
* VdmClass.h
*
* Created on: Dec 14, 2015
* Author: kel
*/
#ifndef LIB_VDMCLASS_H_
#define LIB_VDMCLASS_H_
#include "TypedValue.h"
#include<stddef.h>
typedef void (*freeVdmClassFunction)(void*);
typedef TVP (*VirtualFunctionPointer)(void * self, ...);
//typedef void (*VirtualFunctionPointer)(void * self, ...);
/*
VTable structure used by the compiler to keep
track of the virtual functions associated with a class.
There is one instance of a VTable for every class
containing virtual functions. All instances of
a given class point to the same VTable.
*/
struct VTable
{
/*
d and i fields are used when multiple inheritance and virtual
base classes are involved. We will be ignoring them for this
discussion.
*/
int d;
int i;
/*
A function pointer to the virtual function to be called is
stored here.
*/
VirtualFunctionPointer pFunc;
};
/*
* Base class definitions
* 1. VTable
* 2. class id
* 3. reference count for smart pointer
* */
#define VDM_CLASS_BASE_DEFINITIONS(className) struct VTable * _##className##_pVTable;\
int _##className##_id;\
unsigned int _##className##_refs
#define VDM_CLASS_FIELD_DEFINITION(className, name) TVP m_##className##_##name
/*-------------------------------------------------
*
* VDM encapsulation
*
* ------------------------------------------------
*/
struct ClassType
{
void* value;
int classId;
unsigned int* refs;
freeVdmClassFunction freeClass;//TODO move to global map
};
struct ClassType* newClassValue(int id, unsigned int* refs, freeVdmClassFunction freeClass, void* value);
/*---------------------------------------------------
*
* CLASS access function macros
*
* - Class handling macros for calling functions and obtaining fields
* --------------------------------------------------
*/
// ############ PUBLIC CLASS VALUE ACCESS #####################
/*
* Class Value unwrap macro - TODO: How to assert inline
*/
#define TO_CLASS_PTR(tv,type) ((struct type *) ( ((struct ClassType*)tv->value.ptr)->value))
/*
* Cast to class pointer by moving it forward to the class specific VTable
* Note that we only adjust the pointer if a subtype is given (i.e. not the type of it self)
*/
#define CLASS_CAST(ptr,from,to) (((unsigned char*)ptr) + (SAME_ARGS(from,to)?0: offsetof(struct from, _##to##_pVTable)))
/*
* Down-casting a super class pointer to the concrete class. i.e if A extends B and we have a 'b' pointer we can downcast it to an 'a'
*/
#define CLASS_DOWNCAST(thisClassName, upCastClassName, ptr) (\
(struct upCastClassName *)\
(\
((unsigned char*)ptr) - offsetof(struct upCastClassName, _##thisClassName##_pVTable)\
)\
)
/*
* Macro to obtain the (sub-)class specific field from a class struct
*/
#define GET_STRUCT_FIELD(tname,ptr,fieldtype,fieldname) (*( (fieldtype*) ( ((unsigned char*)ptr) + offsetof(struct tname, fieldname) ) ))
/*
* Macro to set the (sub-)class specific field from a class struct
*/
#define SET_STRUCT_FIELD(tname,ptr,fieldtype,fieldname,newValue) (*( (fieldtype*) ( ((unsigned char*)ptr) + offsetof(struct tname, fieldname) ) )=vdmClone(newValue))
/*
* Macro to obtain the (sub-)class specific VTable from a class struct
*/
#define GET_VTABLE_FUNC(thisTypeName,funcTname,ptr,id) GET_STRUCT_FIELD(thisTypeName,ptr,struct VTable*,_##funcTname##_pVTable)[id].pFunc
/*
* Macro to obtain a function from a (sub-)class specific VTable from a class struct
*/
#define CALL_FUNC(thisTypeName,funcTname,classValue,id, args... ) GET_VTABLE_FUNC( thisTypeName,funcTname,TO_CLASS_PTR(classValue,thisTypeName),id)(CLASS_CAST(TO_CLASS_PTR(classValue,thisTypeName),thisTypeName,funcTname), ## args)
/*
* Macro to obtain a field from a (sub-)class specific class struct. We clone to preserve value semantics and the rule of freeing
*/
#define GET_FIELD(thisTypeName,fieldTypeName,classValue,fieldName) vdmClone(GET_STRUCT_FIELD(fieldTypeName,CLASS_CAST(TO_CLASS_PTR(classValue,thisTypeName),thisTypeName,fieldTypeName) ,struct TypedValue*,m_##fieldTypeName##_##fieldName))
/*
* Macro to set a field from a (sub-)class specific class struct. We clone to preserve value semantics and the rule of freeing
*/
#define SET_FIELD(thisTypeName,fieldTypeName,classValue,fieldName,newValue) SET_FIELD_PTR(thisTypeName,\
fieldTypeName,\
TO_CLASS_PTR(classValue,thisTypeName),\
fieldName,\
newValue)
// old stuff
//Call function from VTable and change ptr to the correct offset. With obtional arguments
//#define CCCALL(thisTypeName,funcTname,ptr,id,...) GET_VTABLE_FUNC( thisTypeName,funcTname,ptr,id)(CLASS_CAST(ptr,thisTypeName,funcTname), ## __VA_ARGS__)
// ############ PRIVATE CLASS POINTER ACCESS #####################
/*
* Macro to obtain a field from a (sub-)class specific class struct. We clone to preserve value semantics and the rule of freeing
*/
#define GET_FIELD_PTR(thisTypeName,fieldTypeName,ptr,fieldName) vdmClone(GET_STRUCT_FIELD(fieldTypeName,CLASS_CAST(ptr,thisTypeName,fieldTypeName) ,struct TypedValue*,m_##fieldTypeName##_##fieldName))
/*
* Macro to set a field from a (sub-)class specific class struct.
*/
#define SET_FIELD_PTR(thisTypeName,fieldTypeName,ptr,fieldName,newValue) SET_STRUCT_FIELD(fieldTypeName,\
CLASS_CAST(ptr,thisTypeName,fieldTypeName) ,\
struct TypedValue*,\
m_##fieldTypeName##_##fieldName,\
newValue)
/*
* Macro to obtain a function from a (sub-)class specific VTable from a class struct
*/
#define CALL_FUNC_PTR(thisTypeName,funcTname,ptr,id, args... ) GET_VTABLE_FUNC( thisTypeName,funcTname,ptr,id)(CLASS_CAST(ptr,thisTypeName,funcTname), ## args)
// ############ UTILITIES #####################
/*
* compare arguments. Techinically we wated: typeid(from)==typeid(to)
* but this is not valid C. However it can be ifdeed for C++. But the name compare if ok
*/
#define SAME_ARGS(x,y) #x==#y
#endif /* LIB_VDMCLASS_H_ */