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 |
||
31 |
BEGIN_DECLS
|
|
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.
|
|
37 |
*
|
|
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 |
||
49 |
||
|
5.2.4
by Gustav Hartvigsson
Finished documenting the SMap and SMapItem interfaces. |
50 |
/*
|
|
5.2.1
by Gustav Hartvigsson
Started work on the Map (SMap) data structure. |
51 |
* Common types of function pointers:
|
52 |
*/
|
|
53 |
||
54 |
||
|
5.2.4
by Gustav Hartvigsson
Finished documenting the SMap and SMapItem interfaces. |
55 |
/**
|
56 |
* Generic function.
|
|
|
22
by Gustav Hartvigsson
* Made code compile |
57 |
*
|
58 |
* It can take any type of function, with any signature
|
|
59 |
*/
|
|
60 |
typedef void (* FuncPointer)(void); |
|
61 |
||
62 |
/**
|
|
|
44
by Gustav Hartvigsson
* Started to structuce the dectumentation a little better. |
63 |
* A generic callback function.
|
|
22
by Gustav Hartvigsson
* Made code compile |
64 |
*
|
|
44
by Gustav Hartvigsson
* Started to structuce the dectumentation a little better. |
65 |
* A callback function can have any signature.
|
|
22
by Gustav Hartvigsson
* Made code compile |
66 |
*/
|
67 |
typedef void (* Callback)(void); |
|
68 |
||
69 |
/**
|
|
70 |
*
|
|
71 |
*/
|
|
|
30
by Gustav Hartvigsson
* Made the code compile using CMake. |
72 |
typedef void (* FreeFunc)(spointer obj); |
73 |
||
|
32
by Gustav Hartvigsson
* Added some compile options to the root CMakeLists.txt |
74 |
|
|
30
by Gustav Hartvigsson
* Made the code compile using CMake. |
75 |
/**
|
|
62
by Gustav Hartvigsson
* General documentation clean up. |
76 |
* @param obj The object that the function should be run on. Generally this
|
77 |
* should be ignored inside the function.
|
|
78 |
* @param item The item that the the function should act on. @newline
|
|
79 |
* This can be printing the data, erasing the it, modifying it,
|
|
80 |
* changing it or what ever.
|
|
81 |
* @param data The data that is passed to the _foreach () function. Often called
|
|
82 |
* the user data. Can also be used as an out parameter.
|
|
|
30
by Gustav Hartvigsson
* Made the code compile using CMake. |
83 |
*/
|
84 |
typedef void (* ForEachFunc)(spointer obj, spointer item, spointer data); |
|
|
22
by Gustav Hartvigsson
* Made code compile |
85 |
|
86 |
#define METHOD(k) ((MethodFunc) k)
|
|
87 |
#define FUNCTION(k) ((FuncPointer) k)
|
|
88 |
#define FREEFUNC(k) ((FreeFunc) k)
|
|
|
62
by Gustav Hartvigsson
* General documentation clean up. |
89 |
#define CALLBACK(k) ((Callback) k)
|
|
30
by Gustav Hartvigsson
* Made the code compile using CMake. |
90 |
|
|
5.2.4
by Gustav Hartvigsson
Finished documenting the SMap and SMapItem interfaces. |
91 |
/**
|
92 |
* A CompFunc represents a standard comparison function.
|
|
93 |
*
|
|
94 |
* @param 1 object to compare
|
|
95 |
* @param 2 object to compare
|
|
96 |
*
|
|
97 |
* compare parameter 1 with parameter 2.
|
|
98 |
*/
|
|
|
46
by Gustav Hartvigsson
* Renamed DynamicArray to SDynamicArray. |
99 |
typedef sboolean (* CompFunc)(void*, void*); |
|
5.2.1
by Gustav Hartvigsson
Started work on the Map (SMap) data structure. |
100 |
|
101 |
typedef char * (* CharFunc)(); |
|
102 |
||
|
46
by Gustav Hartvigsson
* Renamed DynamicArray to SDynamicArray. |
103 |
|
|
22
by Gustav Hartvigsson
* Made code compile |
104 |
END_DECLS
|
105 |
||
|
5.2.1
by Gustav Hartvigsson
Started work on the Map (SMap) data structure. |
106 |
#endif
|