first import of old cilux linux platform code
[cilux] / src / include / kernelapi.h
1 #ifndef KERNEL_H
2 #define KERNEL_H
3
4 /* 
5    This API is the equivalent of a system call API and thereby
6    insulates its user from a GPL implementation.
7 */
8
9 #include <platform.h>
10
11 /* -------------------------------------------------------------------------- */
12
13 PUBLIC CONSOLE k_console;
14 PUBLIC char*   k_version;
15 PUBLIC char*   k_ciux;
16 PUBLIC void  (*k_terminate)(void);
17
18 /* -------------------------------------------------------------------------- */
19
20 #define NAME_OF_MODULE_LOADED_FN "_module_loaded"
21
22 typedef int (*k_module_loaded_fn)(void);
23
24 /* -------------------------------------------------------------------------- */
25
26 #define NAME_OF_MODULE_TICK_FN "_module_tick"
27
28 typedef void (*k_module_tick_fn)(void);
29
30 /* -------------------------------------------------------------------------- */
31
32 #define NAME_OF_MODULE_EVENT_FN  "_module_event"
33
34 typedef int (*k_module_event_fn)(void* data);
35
36 PUBLIC int k_event_post(char* module, void* data);
37
38 /* -------------------------------------------------------------------------- */
39
40 typedef void (*k_gl_reshape_event)(int width, int height);
41 typedef void (*k_gl_draw_event)(void);
42 typedef void (*k_gl_key_event)(unsigned char k, int down);
43 PUBLIC  void   k_gl_register_reshape(k_gl_reshape_event);
44 PUBLIC  void   k_gl_register_draw(   k_gl_draw_event);
45 PUBLIC  void   k_gl_register_key(    k_gl_key_event);
46 PUBLIC  void gluxSwapBuffers(void);
47
48 /* -------------------------------------------------------------------------- */
49
50 #define CRLF "\015\012"
51 #define CHAN_LISTEN 1
52 #define CHAN_ESTABL 2
53 #define CHAN_ANY    3
54
55 typedef struct k_channel      k_channel;
56 typedef struct k_channel_priv k_channel_priv;
57
58 typedef int (*k_channel_event)(k_channel* chan,
59                                int        bufpos, 
60                                int        size);
61
62 struct k_channel{ struct k_channel* next;
63
64         char*           name;
65         char*           listenhost;
66         int             listenport;
67         char*           banner;
68         k_channel_event rdcallback;
69         k_channel_event wrcallback;
70         void*           context;
71         int             type;
72         struct in_addr  clientip;
73         int             linger;
74         k_channel_priv* priv;
75 };
76
77 PUBLIC char*      k_channel_name(char* type, char* ip, int port, char* other);
78 PUBLIC k_channel* k_channel_connect_name(char*           chanm,
79                                          k_channel_event rdcallback,
80                                          k_channel_event wrcallback);
81 PUBLIC k_channel* k_channel_get_name(char* chanm);
82 PUBLIC void       k_channel_show_all(void);
83
84 PUBLIC k_channel* k_channel_listen(char*           name,
85                                    int             listenport,
86                                    char*           banner,
87                                    k_channel_event rdcallback,
88                                    k_channel_event wrcallback,
89                                    void*           context);
90
91 PUBLIC k_channel* k_channel_connect(char*           name,
92                                     char*           listenhost,
93                                     int             listenport,
94                                     k_channel_event rdcallback,
95                                     k_channel_event wrcallback,
96                                     void*           context);
97
98 #define FREE_ON_SENT 1
99 PUBLIC k_channel* k_channel_send(k_channel*  chan,
100                                  char*       base,
101                                  size_t      size,
102                                  int         free);
103
104 #define BUFFER_ALREADY_SET -1
105 #define BUFFER_FILLED       1
106 #define BUFFER_SET          0
107 PUBLIC char* k_channel_chop_div( k_channel* chan, char*  divider);
108 PUBLIC char* k_channel_chop_len( k_channel* chan, size_t size);
109 PUBLIC int   k_channel_setbuf(   k_channel* chan, char*  rdbuffer, size_t size);
110 PUBLIC char* k_channel_getbuf(   k_channel* chan);
111
112 PUBLIC void k_channel_close(k_channel* chan);
113
114 /* -------------------------------------------------------------------------- */
115
116 #define STAT_F 0100000
117 #define STAT_D 0040000
118 #define STAT_L 0120000
119 #define MAX_FILESIZE (1024*1024*1024)
120 #define USE_MMAP 0
121 #define USE_MALL MAX_FILESIZE
122
123 typedef struct k_stat{
124         int    type;
125         size_t size;
126         time_t time;
127         mode_t perm;
128 } k_stat;
129
130 typedef void (*k_file_event)(char*  basedir,
131                              char*  filename,
132                              char*  data,
133                              int    usedmmap,
134                              k_stat stat,
135                              void*  context);
136
137 PUBLIC void k_file_stat( char* basedir, char* filename,
138                                           k_file_event callback, void* context);
139 PUBLIC void k_file_read( char* basedir, char* filename, size_t msz, size_t size,
140                                           k_file_event callback, void* context);
141 PUBLIC void k_file_write(char* basedir, char* filename, char* data, size_t size,
142                                           k_file_event callback, void* context);
143 PUBLIC void k_dir_list(  char* basedir, char* dirname,
144                          char* pattern[], char* format[],  
145                                           k_file_event callback, void* context);
146 PUBLIC int  k_file_sync(char* data, size_t size);
147
148 /* -------------------------------------------------------------------------- */
149
150 typedef struct k_hashtable{ struct k_hashtable* next; } k_hashtable;
151
152 typedef void (*k_hashtable_apply_fn)(void* arg, char* key, void* val);
153
154 PUBLIC k_hashtable* k_hashtable_new(char* name, int ignorecase);
155 PUBLIC k_hashtable* k_hashtable_dup( k_hashtable* tab);
156 PUBLIC k_hashtable* k_hashtable_deep(k_hashtable* tab);
157 PUBLIC k_hashtable* k_hashtable_dip( k_hashtable* tab, char* includes[]);
158 PUBLIC void  k_hashtable_merge(  k_hashtable* tab, k_hashtable* tam);
159 PUBLIC void  k_hashtable_set(    k_hashtable* tab, char* key, void* val);
160 PUBLIC void  k_hashtable_put(    k_hashtable* tab, char* key, void* val);
161 PUBLIC void  k_hashtable_put_dup(k_hashtable* tab, char* key, char* val);
162 PUBLIC void  k_hashtable_put_int(k_hashtable* tab, char* key, int   val);
163 PUBLIC void  k_hashtable_sub(    k_hashtable* tab, char* key, k_hashtable* sub);
164 PUBLIC void* k_hashtable_get(    k_hashtable* tab, char* key);
165 PUBLIC char* k_hashtable_get_dup(k_hashtable* tab, char* key);
166 PUBLIC int   k_hashtable_get_int(k_hashtable* tab, char* key);
167 PUBLIC int   k_hashtable_is(     k_hashtable* tab, char* key, char* val);
168 PUBLIC int   k_hashtable_isi(    k_hashtable* tab, char* key, char* val);
169 PUBLIC int   k_hashtable_isn(    k_hashtable* tab, char* key, char* val,size_t);
170 PUBLIC void  k_hashtable_remove( k_hashtable* tab, char* key);
171 PUBLIC void* k_hashtable_extract(k_hashtable* tab, char* key);
172 PUBLIC void  k_hashtable_apply(  k_hashtable* tab, k_hashtable_apply_fn, void*);
173 PUBLIC void  k_hashtable_show(      k_hashtable* tab);
174 PUBLIC void  k_hashtable_show_chars(k_hashtable* tab);
175 PUBLIC int   k_hashtable_snprintf(  k_hashtable* tab, char* buf, size_t size);
176 PUBLIC int   k_hashtable_snprintf_i(k_hashtable* tab, char* buf, size_t size,
177                                                             char* includes[]);
178 PUBLIC int   k_hashtable_snprintf_x(k_hashtable* tab, char* buf, size_t size,
179                                                             char* excludes[]);
180 PUBLIC void  k_hashtable_delete(k_hashtable* tab);
181
182 /* -------------------------------------------------------------------------- */
183
184 PUBLIC int  k_string_matches_pattern(char* string, char* pattern);
185 PUBLIC int  k_string_ends_with(      char* string, char* postfix);
186 PUBLIC void k_string_url_decode(     char* string);
187
188 /* -------------------------------------------------------------------------- */
189
190 PUBLIC char*  k_time_to_rfc(time_t t);
191 PUBLIC char*  k_time_to_rfc_relative(int plus);
192 PUBLIC time_t k_time_from_rfc(char* s);
193 PUBLIC void   k_time_get_now(char* buf, size_t size, char* format);
194
195 /* -------------------------------------------------------------------------- */
196
197 PUBLIC void k_random_bytes(char* buf, size_t size);
198
199 /* -------------------------------------------------------------------------- */
200
201 PUBLIC void* k_malloc(size_t size);
202 PUBLIC void* k_realloc(void* o, size_t size);
203 PUBLIC char* k_strdup(char* s);
204 PUBLIC void* k_memdup(void* s, size_t size);
205 PUBLIC void  k_free(void* o);
206
207 /* -------------------------------------------------------------------------- */
208
209 PUBLIC void k_log_out(char* format, ...);
210 PUBLIC void k_log_err(char* format, ...);
211 PUBLIC void k_fatal(  char* format, ...);
212
213 /* -------------------------------------------------------------------------- */
214
215
216 #endif
217
218