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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
|
/* emacs-module.h - GNU Emacs module API.
Copyright (C) 2015-2018 Free Software Foundation, Inc.
This file is part of GNU Emacs.
GNU Emacs is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or (at
your option) any later version.
GNU Emacs 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 GNU Emacs. If not, see <https://www.gnu.org/licenses/>. */
#ifndef EMACS_MODULE_H
#define EMACS_MODULE_H
#include <stddef.h>
#include <stdint.h>
#ifndef __cplusplus
#include <stdbool.h>
#endif
#if defined __cplusplus && __cplusplus >= 201103L
#define EMACS_NOEXCEPT noexcept
#else
#define EMACS_NOEXCEPT
#endif
#ifdef __has_attribute
#if __has_attribute(__nonnull__)
#define EMACS_ATTRIBUTE_NONNULL(...) __attribute__((__nonnull__(__VA_ARGS__)))
#endif
#endif
#ifndef EMACS_ATTRIBUTE_NONNULL
#define EMACS_ATTRIBUTE_NONNULL(...)
#endif
#ifdef __cplusplus
extern "C" {
#endif
/* Current environment. */
typedef struct emacs_env_25 emacs_env;
/* Opaque pointer representing an Emacs Lisp value.
BEWARE: Do not assume NULL is a valid value! */
typedef struct emacs_value_tag *emacs_value;
enum { emacs_variadic_function = -2 };
/* Struct passed to a module init function (emacs_module_init). */
struct emacs_runtime {
/* Structure size (for version checking). */
ptrdiff_t size;
/* Private data; users should not touch this. */
struct emacs_runtime_private *private_members;
/* Return an environment pointer. */
emacs_env *(*get_environment)(struct emacs_runtime *ert)
EMACS_ATTRIBUTE_NONNULL(1);
};
/* Possible Emacs function call outcomes. */
enum emacs_funcall_exit {
/* Function has returned normally. */
emacs_funcall_exit_return = 0,
/* Function has signaled an error using `signal'. */
emacs_funcall_exit_signal = 1,
/* Function has exit using `throw'. */
emacs_funcall_exit_throw = 2
};
struct emacs_env_25 {
/* Structure size (for version checking). */
ptrdiff_t size;
/* Private data; users should not touch this. */
struct emacs_env_private *private_members;
/* Memory management. */
emacs_value (*make_global_ref)(emacs_env *env, emacs_value any_reference)
EMACS_ATTRIBUTE_NONNULL(1);
void (*free_global_ref)(emacs_env *env, emacs_value global_reference)
EMACS_ATTRIBUTE_NONNULL(1);
/* Non-local exit handling. */
enum emacs_funcall_exit (*non_local_exit_check)(emacs_env *env)
EMACS_ATTRIBUTE_NONNULL(1);
void (*non_local_exit_clear)(emacs_env *env) EMACS_ATTRIBUTE_NONNULL(1);
enum emacs_funcall_exit (*non_local_exit_get)(
emacs_env *env, emacs_value *non_local_exit_symbol_out,
emacs_value *non_local_exit_data_out) EMACS_ATTRIBUTE_NONNULL(1, 2, 3);
void (*non_local_exit_signal)(emacs_env *env,
emacs_value non_local_exit_symbol,
emacs_value non_local_exit_data)
EMACS_ATTRIBUTE_NONNULL(1);
void (*non_local_exit_throw)(emacs_env *env, emacs_value tag,
emacs_value value) EMACS_ATTRIBUTE_NONNULL(1);
/* Function registration. */
emacs_value (*make_function)(
emacs_env *env, ptrdiff_t min_arity, ptrdiff_t max_arity,
emacs_value (*function)(emacs_env *env, ptrdiff_t nargs,
emacs_value args[], void *)
EMACS_NOEXCEPT EMACS_ATTRIBUTE_NONNULL(1),
const char *documentation, void *data) EMACS_ATTRIBUTE_NONNULL(1, 4);
emacs_value (*funcall)(emacs_env *env, emacs_value function, ptrdiff_t nargs,
emacs_value args[]) EMACS_ATTRIBUTE_NONNULL(1);
emacs_value (*intern)(emacs_env *env, const char *symbol_name)
EMACS_ATTRIBUTE_NONNULL(1, 2);
/* Type conversion. */
emacs_value (*type_of)(emacs_env *env, emacs_value value)
EMACS_ATTRIBUTE_NONNULL(1);
bool (*is_not_nil)(emacs_env *env, emacs_value value)
EMACS_ATTRIBUTE_NONNULL(1);
bool (*eq)(emacs_env *env, emacs_value a, emacs_value b)
EMACS_ATTRIBUTE_NONNULL(1);
intmax_t (*extract_integer)(emacs_env *env, emacs_value value)
EMACS_ATTRIBUTE_NONNULL(1);
emacs_value (*make_integer)(emacs_env *env, intmax_t value)
EMACS_ATTRIBUTE_NONNULL(1);
double (*extract_float)(emacs_env *env, emacs_value value)
EMACS_ATTRIBUTE_NONNULL(1);
emacs_value (*make_float)(emacs_env *env, double value)
EMACS_ATTRIBUTE_NONNULL(1);
/* Copy the content of the Lisp string VALUE to BUFFER as an utf8
null-terminated string.
SIZE must point to the total size of the buffer. If BUFFER is
NULL or if SIZE is not big enough, write the required buffer size
to SIZE and return true.
Note that SIZE must include the last null byte (e.g. "abc" needs
a buffer of size 4).
Return true if the string was successfully copied. */
bool (*copy_string_contents)(emacs_env *env, emacs_value value, char *buffer,
ptrdiff_t *size_inout)
EMACS_ATTRIBUTE_NONNULL(1, 4);
/* Create a Lisp string from a utf8 encoded string. */
emacs_value (*make_string)(emacs_env *env, const char *contents,
ptrdiff_t length) EMACS_ATTRIBUTE_NONNULL(1, 2);
/* Embedded pointer type. */
emacs_value (*make_user_ptr)(emacs_env *env,
void (*fin)(void *) EMACS_NOEXCEPT, void *ptr)
EMACS_ATTRIBUTE_NONNULL(1);
void *(*get_user_ptr)(emacs_env *env,
emacs_value uptr)EMACS_ATTRIBUTE_NONNULL(1);
void (*set_user_ptr)(emacs_env *env, emacs_value uptr, void *ptr)
EMACS_ATTRIBUTE_NONNULL(1);
void (*(*get_user_finalizer)(emacs_env *env,
emacs_value uptr))(void *) EMACS_NOEXCEPT
EMACS_ATTRIBUTE_NONNULL(1);
void (*set_user_finalizer)(emacs_env *env, emacs_value uptr,
void (*fin)(void *) EMACS_NOEXCEPT)
EMACS_ATTRIBUTE_NONNULL(1);
/* Vector functions. */
emacs_value (*vec_get)(emacs_env *env, emacs_value vec, ptrdiff_t i)
EMACS_ATTRIBUTE_NONNULL(1);
void (*vec_set)(emacs_env *env, emacs_value vec, ptrdiff_t i, emacs_value val)
EMACS_ATTRIBUTE_NONNULL(1);
ptrdiff_t (*vec_size)(emacs_env *env, emacs_value vec)
EMACS_ATTRIBUTE_NONNULL(1);
};
struct emacs_env_26 {
/* Structure size (for version checking). */
ptrdiff_t size;
/* Private data; users should not touch this. */
struct emacs_env_private *private_members;
/* Memory management. */
emacs_value (*make_global_ref)(emacs_env *env, emacs_value any_reference)
EMACS_ATTRIBUTE_NONNULL(1);
void (*free_global_ref)(emacs_env *env, emacs_value global_reference)
EMACS_ATTRIBUTE_NONNULL(1);
/* Non-local exit handling. */
enum emacs_funcall_exit (*non_local_exit_check)(emacs_env *env)
EMACS_ATTRIBUTE_NONNULL(1);
void (*non_local_exit_clear)(emacs_env *env) EMACS_ATTRIBUTE_NONNULL(1);
enum emacs_funcall_exit (*non_local_exit_get)(
emacs_env *env, emacs_value *non_local_exit_symbol_out,
emacs_value *non_local_exit_data_out) EMACS_ATTRIBUTE_NONNULL(1, 2, 3);
void (*non_local_exit_signal)(emacs_env *env,
emacs_value non_local_exit_symbol,
emacs_value non_local_exit_data)
EMACS_ATTRIBUTE_NONNULL(1);
void (*non_local_exit_throw)(emacs_env *env, emacs_value tag,
emacs_value value) EMACS_ATTRIBUTE_NONNULL(1);
/* Function registration. */
emacs_value (*make_function)(
emacs_env *env, ptrdiff_t min_arity, ptrdiff_t max_arity,
emacs_value (*function)(emacs_env *env, ptrdiff_t nargs,
emacs_value args[], void *)
EMACS_NOEXCEPT EMACS_ATTRIBUTE_NONNULL(1),
const char *documentation, void *data) EMACS_ATTRIBUTE_NONNULL(1, 4);
emacs_value (*funcall)(emacs_env *env, emacs_value function, ptrdiff_t nargs,
emacs_value args[]) EMACS_ATTRIBUTE_NONNULL(1);
emacs_value (*intern)(emacs_env *env, const char *symbol_name)
EMACS_ATTRIBUTE_NONNULL(1, 2);
/* Type conversion. */
emacs_value (*type_of)(emacs_env *env, emacs_value value)
EMACS_ATTRIBUTE_NONNULL(1);
bool (*is_not_nil)(emacs_env *env, emacs_value value)
EMACS_ATTRIBUTE_NONNULL(1);
bool (*eq)(emacs_env *env, emacs_value a, emacs_value b)
EMACS_ATTRIBUTE_NONNULL(1);
intmax_t (*extract_integer)(emacs_env *env, emacs_value value)
EMACS_ATTRIBUTE_NONNULL(1);
emacs_value (*make_integer)(emacs_env *env, intmax_t value)
EMACS_ATTRIBUTE_NONNULL(1);
double (*extract_float)(emacs_env *env, emacs_value value)
EMACS_ATTRIBUTE_NONNULL(1);
emacs_value (*make_float)(emacs_env *env, double value)
EMACS_ATTRIBUTE_NONNULL(1);
/* Copy the content of the Lisp string VALUE to BUFFER as an utf8
null-terminated string.
SIZE must point to the total size of the buffer. If BUFFER is
NULL or if SIZE is not big enough, write the required buffer size
to SIZE and return true.
Note that SIZE must include the last null byte (e.g. "abc" needs
a buffer of size 4).
Return true if the string was successfully copied. */
bool (*copy_string_contents)(emacs_env *env, emacs_value value, char *buffer,
ptrdiff_t *size_inout)
EMACS_ATTRIBUTE_NONNULL(1, 4);
/* Create a Lisp string from a utf8 encoded string. */
emacs_value (*make_string)(emacs_env *env, const char *contents,
ptrdiff_t length) EMACS_ATTRIBUTE_NONNULL(1, 2);
/* Embedded pointer type. */
emacs_value (*make_user_ptr)(emacs_env *env,
void (*fin)(void *) EMACS_NOEXCEPT, void *ptr)
EMACS_ATTRIBUTE_NONNULL(1);
void *(*get_user_ptr)(emacs_env *env,
emacs_value uptr)EMACS_ATTRIBUTE_NONNULL(1);
void (*set_user_ptr)(emacs_env *env, emacs_value uptr, void *ptr)
EMACS_ATTRIBUTE_NONNULL(1);
void (*(*get_user_finalizer)(emacs_env *env,
emacs_value uptr))(void *) EMACS_NOEXCEPT
EMACS_ATTRIBUTE_NONNULL(1);
void (*set_user_finalizer)(emacs_env *env, emacs_value uptr,
void (*fin)(void *) EMACS_NOEXCEPT)
EMACS_ATTRIBUTE_NONNULL(1);
/* Vector functions. */
emacs_value (*vec_get)(emacs_env *env, emacs_value vec, ptrdiff_t i)
EMACS_ATTRIBUTE_NONNULL(1);
void (*vec_set)(emacs_env *env, emacs_value vec, ptrdiff_t i, emacs_value val)
EMACS_ATTRIBUTE_NONNULL(1);
ptrdiff_t (*vec_size)(emacs_env *env, emacs_value vec)
EMACS_ATTRIBUTE_NONNULL(1);
/* Returns whether a quit is pending. */
bool (*should_quit)(emacs_env *env) EMACS_ATTRIBUTE_NONNULL(1);
};
/* Every module should define a function as follows. */
extern int emacs_module_init(struct emacs_runtime *ert) EMACS_NOEXCEPT
EMACS_ATTRIBUTE_NONNULL(1);
#ifdef __cplusplus
}
#endif
#endif /* EMACS_MODULE_H */
|
