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
|
/*
Copyright (c) 2013-2014 Gustav Hartvigsson
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/
#ifndef __H_FUNC__
#define __H_FUNC__
#include "defs.h"
#include "utils.h"
BEGIN_DECLS
/** @file
* Generic function pointer definitions and data stuctures to do with
* functions.
*
* @todo create an object type that can hold functions and be able to run them.
*/
/*
* This data structure holds a pointer to a function.
*
* A Func object must hold a pointer to a function and can hold a string,
* representing its name.
*/
#define METHOD(k) ((MethodFunc) k)
#define FUNCTION(k) ((FuncPointer) k)
#define FREEFUNC(k) ((FreeFunc) k)
#define CALLBACK(k) ((Callback) k)
#define FOREACHFUNC(k) ((ForEachFunc) k)
#define COMPFUNC(k) ((CompFunc) k)
/*
* Common types of function pointers:
*/
/**
* Generic function.
*
* It can take any type of function, with any signature
*/
typedef void (* FuncPointer)(void);
/**
* A generic callback function.
*
* @param obj The object to perform the callback on.
* @param user_data The user data to be passed to the function.
*/
typedef spointer (* Callback)(spointer obj, spointer user_data);
/**
*
*/
typedef void (* FreeFunc)(spointer obj);
typedef spointer (* RunFunc)(spointer user_data);
/**
* @param obj The object that the function should be run on. Generally this
* should be ignored inside the function.
* @param item The item that the the function should act on. @newline
* This can be printing the data, erasing the it, modifying it,
* changing it or what ever.
* @param data The data that is passed to the _foreach () function. Often called
* the user data. Can also be used as an out parameter.
*/
typedef void (* ForEachFunc)(spointer obj, spointer item, spointer data);
/**
* A CompFunc represents a standard comparison function.
*
* @param 1 object to compare
* @param 2 object to compare
*
* compare parameter 1 with parameter 2.
*/
typedef sboolean (* CompFunc)(void*, void*);
typedef char * (* CharFunc)();
END_DECLS
#endif
|