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
|
/*
(C) Gustav Hartvigsson, 2013.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as
published by the Free Software Foundation, either version 3 of the
License.
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/>.
*/
/** @file */
#ifndef __H_BASE_OBJECT__
#define __H_BASE_OBJECT__
/** @file
* An SBaseObjectInstance represents the base of the Super Simple Type System.
*
* Almost all other data structures in this library are children to this object
* type.
*
* All objects that inherent from SBaseObjectInstance get the ability to have
* reference counting of objects via built in functions.
*/
/* ---------------------------------------------------
* This is just a test of creating a small typesystem.
* It will include refrence counting.
* ---------------------------------------------------
*/
typedef struct _SBaseObjectClass SBaseObjectClass;
typedef struct _SBaseObjectInstance SBaseObjectInstance;
/**
* The class holds all the "virtual" functions, also knows as methods
* that are to be used with the object.
*
*/
struct _SBaseObjectClass {
// SBaseObjectInstance * (* initize)(SBaseObjectInstance *);
void (*deinitize)(SBaseObjectInstance *);
int (*ref)(SBaseObjectInstance *);
int (*unref)(SBaseObjectInstance *);
int (*get_refcount)(SBaseObjectInstance *);
char * (*to_string)(SBaseObjectInstance *);
};
/**
* The instance holds the data that is associated with the object.
* it also holds a pointer to the class of the object.
*
*/
struct _SBaseObjectInstance {
SBaseObjectClass * base_class;
unsigned int refcount;
};
/* -----------------
* Helper functions...
* -----------------
*/
/*
* This function is used to set the method to initialize a new instance of an
* object.
*
* This has no use, rely...(?)
*/
// void s_base_object_set_init_method (SBaseObjectInstance * self, SBaseObjectInstance * (* method)(* SBaseObjectInstance));
/**
* This function is used to set the method to deinitialize an object.
*
* set it to a method that deinitialize your object.
*/
void s_base_object_set_deinit_method (SBaseObjectInstance * self, void (* method)(SBaseObjectInstance *));
/**
* This function is used to set the ref method.
*
* DO NOT USE THIS UNLESS YOU KNOW WHAT YOU ARE DOING.
*/
void s_base_object_set_ref_method (SBaseObjectInstance * self, int (* method)(SBaseObjectInstance *));
/**
* This function is used to set the unref method.
*
* DO NOT USE THIS UNLESS YOU KNOW WHAT YOU ARE DOING.
*/
void s_base_object_set_unref_method (SBaseObjectInstance * self, int (* method)(SBaseObjectInstance *));
/**!
* This function is used to set the get_refcount method.
*
* DO NOT USE THIS UNLESS YOU KNOW WHAT YOU ARE DOING.
*/
void s_base_object_set_get_refcount_method (SBaseObjectInstance * self, int (* method)(SBaseObjectInstance *));
/**!
* This function is used to set the to_string method.
*/
void s_base_object_set_to_string_method (SBaseObjectInstance * self, char * (* method)(SBaseObjectInstance *));
/*
* concrete functions are defined in the C file.
*/
/* ----------------------
* Base object functions.
* ----------------------
*/
/** @brief
* Initializes an SBaseObjectInstance
*
* @param self The object to initialize.
*
* This function initializes an instance of the SBaseObjectInstance, it also sets
* the methods to be used with the object and sets the reference count to one.
*/
void s_base_object_initize (SBaseObjectInstance * self);
/** @brief
* This function creates a new base object.
*
*
*
* @return a new SBaseObjectInstance
*/
SBaseObjectInstance * s_base_object_new ();
/**
* This function desensitizes/frees an object even if it is still referenced.
* This is usually a bad idea, use s_base_object_unref () instead.
*/
void s_base_object_free (SBaseObjectInstance * self);
/**
* This function gets the class (which hold the object methods).
*/
void * s_base_object_get_class (SBaseObjectInstance * self);
/**
* This function sets the instance class of an object.
*/
void s_base_object_set_class (SBaseObjectInstance * self, SBaseObjectClass * klass);
/**
* This function is used to decrese the reference count of an object.
* When an object reaches zero, it will deinitialize the object using the
* objects deinitialize method.
*
* It returns the current (after change) reference count.
*/
int s_base_object_unref (SBaseObjectInstance * self);
/**
* This function is used to increase the reference count of an object.
*
* Returns the current (after change) reference count.
*/
int s_base_object_ref (SBaseObjectInstance * self);
/**
* This function returns the current reference count without changing it.
*/
int s_base_object_get_refcount (SBaseObjectInstance * self);
/**
* This function returns a textual (string) that represents the object.
* The method can be set using s_base_object_set_to_string_method.
*
* Note: The string that is returned must be freed.
*/
char * s_base_object_to_string (SBaseObjectInstance * self);
#endif
|