/simpletypesystem/trunk

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/simpletypesystem/trunk
5.2.4 by Gustav Hartvigsson
Finished documenting the SMap and SMapItem interfaces.
1
/*
5.2.7 by Gustav Hartvigsson
* Switched licence to a more permisive one.
2
Copyright (c) 2013-2014 Gustav Hartvigsson
3
4
Permission is hereby granted, free of charge, to any person obtaining a copy
5
of this software and associated documentation files (the "Software"), to deal
6
in the Software without restriction, including without limitation the rights
7
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8
copies of the Software, and to permit persons to whom the Software is
9
furnished to do so, subject to the following conditions:
10
11
The above copyright notice and this permission notice shall be included in
12
all copies or substantial portions of the Software.
13
14
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20
THE SOFTWARE.
5.2.4 by Gustav Hartvigsson
Finished documenting the SMap and SMapItem interfaces.
21
*/
22
23
5.2.1 by Gustav Hartvigsson
Started work on the Map (SMap) data structure.
24
#ifndef __H_FUNC__
25
#define __H_FUNC__
5.2.4 by Gustav Hartvigsson
Finished documenting the SMap and SMapItem interfaces.
26
27
32 by Gustav Hartvigsson
* Added some compile options to the root CMakeLists.txt
28
#include "defs.h"
29
#include "utils.h"
30
110 by Gustav Hartvigsson
* added S_ prifix to my macros. I should not be a scrub.
31
S_BEGIN_DECLS
32 by Gustav Hartvigsson
* Added some compile options to the root CMakeLists.txt
32
44 by Gustav Hartvigsson
* Started to structuce the dectumentation a little better.
33
34
/** @file
35
 * Generic function pointer definitions and data stuctures to do with
36
 * functions.
109.1.1 by Gustav Hartvigsson
* SMap seems to be broken... Or could it be SObject's Callback stuff? Or SLinkedList?
37
 *
44 by Gustav Hartvigsson
* Started to structuce the dectumentation a little better.
38
 * @todo create an object type that can hold functions and be able to run them.
39
 */
40
41
5.2.4 by Gustav Hartvigsson
Finished documenting the SMap and SMapItem interfaces.
42
/*
5.2.1 by Gustav Hartvigsson
Started work on the Map (SMap) data structure.
43
 * This data structure holds a pointer to a function.
44
 *
45
 * A Func object must hold a pointer to a function and can hold a string,
46
 * representing its name.
47
 */
48
89 by Gustav Hartvigsson
* Started working on Threads
49
#define METHOD(k) ((MethodFunc) k)
50
#define FUNCTION(k) ((FuncPointer) k)
51
#define FREEFUNC(k) ((FreeFunc) k)
52
#define CALLBACK(k) ((Callback) k)
53
#define FOREACHFUNC(k) ((ForEachFunc) k)
109.1.1 by Gustav Hartvigsson
* SMap seems to be broken... Or could it be SObject's Callback stuff? Or SLinkedList?
54
#define COMPFUNC(k) ((CompFunc) k)
116.1.1 by Gustav Hartvigsson
* Implemented the SMainLoop
55
#define RUNFUNC(k) ((RunFunc) k)
109.1.1 by Gustav Hartvigsson
* SMap seems to be broken... Or could it be SObject's Callback stuff? Or SLinkedList?
56
5.2.1 by Gustav Hartvigsson
Started work on the Map (SMap) data structure.
57
5.2.4 by Gustav Hartvigsson
Finished documenting the SMap and SMapItem interfaces.
58
/*
5.2.1 by Gustav Hartvigsson
Started work on the Map (SMap) data structure.
59
 * Common types of function pointers:
60
 */
61
62
5.2.4 by Gustav Hartvigsson
Finished documenting the SMap and SMapItem interfaces.
63
/**
64
 * Generic function.
22 by Gustav Hartvigsson
* Made code compile
65
 *
66
 * It can take any type of function, with any signature
67
 */
68
typedef void (* FuncPointer)(void);
69
70
/**
44 by Gustav Hartvigsson
* Started to structuce the dectumentation a little better.
71
 * A generic callback function.
22 by Gustav Hartvigsson
* Made code compile
72
 *
109.1.1 by Gustav Hartvigsson
* SMap seems to be broken... Or could it be SObject's Callback stuff? Or SLinkedList?
73
 * @param obj The object to perform the callback on.
74
 * @param user_data The user data to be passed to the function.
22 by Gustav Hartvigsson
* Made code compile
75
 */
109.1.1 by Gustav Hartvigsson
* SMap seems to be broken... Or could it be SObject's Callback stuff? Or SLinkedList?
76
typedef spointer (* Callback)(spointer obj, spointer user_data);
22 by Gustav Hartvigsson
* Made code compile
77
78
/**
79
 *
80
 */
30 by Gustav Hartvigsson
* Made the code compile using CMake.
81
typedef void (* FreeFunc)(spointer obj);
82
89 by Gustav Hartvigsson
* Started working on Threads
83
typedef spointer (* RunFunc)(spointer user_data);
32 by Gustav Hartvigsson
* Added some compile options to the root CMakeLists.txt
84
30 by Gustav Hartvigsson
* Made the code compile using CMake.
85
/**
62 by Gustav Hartvigsson
* General documentation clean up.
86
 * @param obj The object that the function should be run on. Generally this
87
 *            should be ignored inside the function.
88
 * @param item The item that the the function should act on. @newline
89
 *             This can be printing the data, erasing the it, modifying it,
90
 *             changing it or what ever.
91
 * @param data The data that is passed to the _foreach () function. Often called
92
 *             the user data. Can also be used as an out parameter.
30 by Gustav Hartvigsson
* Made the code compile using CMake.
93
 */
94
typedef void (* ForEachFunc)(spointer obj, spointer item, spointer data);
22 by Gustav Hartvigsson
* Made code compile
95
30 by Gustav Hartvigsson
* Made the code compile using CMake.
96
5.2.4 by Gustav Hartvigsson
Finished documenting the SMap and SMapItem interfaces.
97
/**
98
 * A CompFunc represents a standard comparison function.
109.1.1 by Gustav Hartvigsson
* SMap seems to be broken... Or could it be SObject's Callback stuff? Or SLinkedList?
99
 *
5.2.4 by Gustav Hartvigsson
Finished documenting the SMap and SMapItem interfaces.
100
 * @param 1 object to compare
101
 * @param 2 object to compare
109.1.1 by Gustav Hartvigsson
* SMap seems to be broken... Or could it be SObject's Callback stuff? Or SLinkedList?
102
 *
5.2.4 by Gustav Hartvigsson
Finished documenting the SMap and SMapItem interfaces.
103
 * compare parameter 1 with parameter 2.
104
 */
46 by Gustav Hartvigsson
* Renamed DynamicArray to SDynamicArray.
105
typedef sboolean (* CompFunc)(void*, void*);
5.2.1 by Gustav Hartvigsson
Started work on the Map (SMap) data structure.
106
107
typedef char * (* CharFunc)();
108
46 by Gustav Hartvigsson
* Renamed DynamicArray to SDynamicArray.
109
110 by Gustav Hartvigsson
* added S_ prifix to my macros. I should not be a scrub.
110
S_END_DECLS
22 by Gustav Hartvigsson
* Made code compile
111
5.2.1 by Gustav Hartvigsson
Started work on the Map (SMap) data structure.
112
#endif