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
|
/*
emacs_module.h - Module API
Copyright (C) 2015 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 <http://www.gnu.org/licenses/>.
*/
#ifndef EMACS_MODULE_H
#define EMACS_MODULE_H
#include <stdint.h>
#include <stdlib.h>
#include <stdbool.h>
/* Current environment */
typedef struct emacs_env_25 emacs_env;
/* The size of emacs_value must match EMACS_INT:
32 bit system: 32 bits
32 bit system with --with-wide-int: 64 bits
64 bit system: 64 bits.
When compiling modules, define the macro EMACS_VALUE_TYPE by the
result of `module-emacs_value-type'. */
typedef EMACS_VALUE_TYPE emacs_value;
/* Struct passed to a module init function (emacs_module_init) */
struct emacs_runtime {
size_t size;
emacs_env* (*get_environment)(struct emacs_runtime *ert);
};
/* Function prototype for the module init function */
typedef int (*emacs_init_function)(struct emacs_runtime *ert);
/* Function prototype for the module Lisp functions */
typedef emacs_value (*emacs_subr)(emacs_env *env,
int nargs,
emacs_value args[]);
struct emacs_env_25 {
/*
* Structure size (for version checking)
*/
size_t size;
/*
* Constants
*/
emacs_value Qt_value;
emacs_value Qnil_value;
/*
* Memory management
*/
emacs_value (*make_global_reference)(emacs_env *env,
emacs_value any_reference);
void (*free_global_reference)(emacs_env *env,
emacs_value global_reference);
/*
* Error handling
*/
bool (*error_check)(emacs_env *env);
void (*clear_error)(emacs_env *env);
bool (*get_error)(emacs_env *env,
emacs_value *error_symbol_out,
emacs_value *error_data_out);
void (*signal_error)(emacs_env *env,
const char* msg,
emacs_value error_data);
/*
* Function registration
*/
emacs_value (*make_function)(emacs_env *env,
int min_arity,
int max_arity,
emacs_subr function);
emacs_value (*funcall)(emacs_env *env,
emacs_value function,
int nargs,
emacs_value args[]);
emacs_value (*intern)(emacs_env *env,
const char *symbol_name);
emacs_value (*intern_soft)(emacs_env *env,
const char *symbol_name);
void (*bind_function) (emacs_env *env,
const char *name,
emacs_value definition);
/*
* Type conversion
*/
emacs_value (*type_of)(emacs_env *env,
emacs_value value);
int64_t (*fixnum_to_int)(emacs_env *env,
emacs_value value);
emacs_value (*make_fixnum)(emacs_env *env,
int64_t value);
double (*float_to_c_double)(emacs_env *env,
emacs_value value);
emacs_value (*make_float)(emacs_env *env,
double value);
bool (*copy_string_contents)(emacs_env *env,
emacs_value value,
char *buffer,
size_t* length_inout);
size_t (*buffer_byte_length)(emacs_env *env,
emacs_value start,
emacs_value end);
/* Return the size in bytes of the buffer substring in the current
buffer from START to END */
void (*copy_buffer_substring)(emacs_env *env,
emacs_value start,
emacs_value end,
char *buffer,
size_t* length_inout);
/* Copy buffer string from current buffer, BEG to END (integers or
markers), to BUFFER. On call, LENGTH_INOUT is the size in bytes
of BUFFER; on return, it is the size in bytes of the copied
string.
If BUFFER is too small, signals an error. Use buffer_byte_length
to ensure BUFFER is not too small. */
emacs_value (*make_string)(emacs_env *env,
const char *contents);
/*
* miscellaneous
*/
void (*message)(emacs_env *env,
emacs_value msg);
/* msg must be already formatted */
emacs_value (*symbol_value)(emacs_env *env,
emacs_value symbol);
};
#endif /* EMACS_MODULE_H */
|
