mod-test.c 10.2 KB
Newer Older
1 2
/* Test GNU Emacs modules.

Paul Eggert's avatar
Paul Eggert committed
3
Copyright 2015-2018 Free Software Foundation, Inc.
4 5 6 7 8

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
9 10
the Free Software Foundation, either version 3 of the License, or (at
your option) any later version.
11 12 13 14 15 16 17

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
18
along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.  */
19

20 21
#include <assert.h>
#include <stdio.h>
22
#include <stdlib.h>
23
#include <limits.h>
24
#include <emacs-module.h>
25 26 27

int plugin_is_GPL_compatible;

28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51
#if INTPTR_MAX <= 0
# error "INTPTR_MAX misconfigured"
#elif INTPTR_MAX <= INT_MAX || INTPTR_MAX <= LONG_MAX
# define pT "ld"
# define pZ "lu"
# define T_TYPE long
# define Z_TYPE unsigned long
#elif INTPTR_MAX <= INT64_MAX
# ifdef __MINGW32__
#  define pT "lld"
#  define pZ "llu"
#  define T_TYPE long long
#  define Z_TYPE unsigned long long
# else
#  define pT "ld"
#  define pZ "lu"
#  define T_TYPE long
#  define Z_TYPE unsigned long
# endif
#else
# error "INTPTR_MAX too large"
#endif


52 53
/* Always return symbol 't'.  */
static emacs_value
54 55
Fmod_test_return_t (emacs_env *env, ptrdiff_t nargs, emacs_value args[],
		    void *data)
56 57 58 59
{
  return env->intern (env, "t");
}

60
/* Expose simple sum function.  */
61 62
static intmax_t
sum (intmax_t a, intmax_t b)
63 64 65 66
{
  return a + b;
}

67
static emacs_value
68
Fmod_test_sum (emacs_env *env, ptrdiff_t nargs, emacs_value args[], void *data)
69
{
70 71
  assert (nargs == 2);

72 73
  intmax_t a = env->extract_integer (env, args[0]);
  intmax_t b = env->extract_integer (env, args[1]);
74

75
  intmax_t r = sum (a, b);
76 77 78 79 80

  return env->make_integer (env, r);
}


81 82
/* Signal '(error 56).  */
static emacs_value
83 84
Fmod_test_signal (emacs_env *env, ptrdiff_t nargs, emacs_value args[],
		  void *data)
85 86
{
  assert (env->non_local_exit_check (env) == emacs_funcall_exit_return);
87 88
  env->non_local_exit_signal (env, env->intern (env, "error"),
			      env->make_integer (env, 56));
89
  return env->intern (env, "nil");
90 91 92
}


93 94
/* Throw '(tag 65).  */
static emacs_value
95 96
Fmod_test_throw (emacs_env *env, ptrdiff_t nargs, emacs_value args[],
		 void *data)
97 98
{
  assert (env->non_local_exit_check (env) == emacs_funcall_exit_return);
99 100
  env->non_local_exit_throw (env, env->intern (env, "tag"),
			     env->make_integer (env, 65));
101
  return env->intern (env, "nil");
102 103 104
}


105 106 107
/* Call argument function, catch all non-local exists and return
   either normal result or a list describing the non-local exit.  */
static emacs_value
108 109
Fmod_test_non_local_exit_funcall (emacs_env *env, ptrdiff_t nargs,
				  emacs_value args[], void *data)
110 111
{
  assert (nargs == 1);
Paul Eggert's avatar
Paul Eggert committed
112
  emacs_value result = env->funcall (env, args[0], 0, NULL);
113
  emacs_value non_local_exit_symbol, non_local_exit_data;
114 115 116
  enum emacs_funcall_exit code
    = env->non_local_exit_get (env, &non_local_exit_symbol,
			       &non_local_exit_data);
117 118 119 120 121 122 123
  switch (code)
    {
    case emacs_funcall_exit_return:
      return result;
    case emacs_funcall_exit_signal:
      {
        env->non_local_exit_clear (env);
Paul Eggert's avatar
Paul Eggert committed
124
        emacs_value Flist = env->intern (env, "list");
125 126
        emacs_value list_args[] = {env->intern (env, "signal"),
				   non_local_exit_symbol, non_local_exit_data};
127 128 129 130 131
        return env->funcall (env, Flist, 3, list_args);
      }
    case emacs_funcall_exit_throw:
      {
        env->non_local_exit_clear (env);
Paul Eggert's avatar
Paul Eggert committed
132
        emacs_value Flist = env->intern (env, "list");
133 134
        emacs_value list_args[] = {env->intern (env, "throw"),
				   non_local_exit_symbol, non_local_exit_data};
135 136 137
        return env->funcall (env, Flist, 3, list_args);
      }
    }
138 139

  /* Never reached.  */
140 141 142 143
  return env->intern (env, "nil");;
}


Paul Eggert's avatar
Paul Eggert committed
144
/* Return a global reference.  */
145
static emacs_value
146
Fmod_test_globref_make (emacs_env *env, ptrdiff_t nargs, emacs_value args[],
147
			void *data)
148
{
149 150
  /* Make a big string and make it global.  */
  char str[26 * 100];
151
  for (int i = 0; i < sizeof str; i++)
152
    str[i] = 'a' + (i % 26);
153

154 155
  /* We don't need to null-terminate str.  */
  emacs_value lisp_str = env->make_string (env, str, sizeof str);
156 157 158 159
  return env->make_global_ref (env, lisp_str);
}


160 161 162
/* Return a copy of the argument string where every 'a' is replaced
   with 'b'.  */
static emacs_value
163
Fmod_test_string_a_to_b (emacs_env *env, ptrdiff_t nargs, emacs_value args[],
164
			 void *data)
165 166
{
  emacs_value lisp_str = args[0];
167
  ptrdiff_t size = 0;
168 169 170 171 172 173
  char * buf = NULL;

  env->copy_string_contents (env, lisp_str, buf, &size);
  buf = malloc (size);
  env->copy_string_contents (env, lisp_str, buf, &size);

174
  for (ptrdiff_t i = 0; i + 1 < size; i++)
175 176 177
    if (buf[i] == 'a')
      buf[i] = 'b';

178
  return env->make_string (env, buf, size - 1);
179 180 181
}


182
/* Embedded pointers in lisp objects.  */
183

184
/* C struct (pointer to) that will be embedded.  */
185 186 187 188 189 190
struct super_struct
{
  int amazing_int;
  char large_unused_buffer[512];
};

191 192 193
/* Return a new user-pointer to a super_struct, with amazing_int set
   to the passed parameter.  */
static emacs_value
194
Fmod_test_userptr_make (emacs_env *env, ptrdiff_t nargs, emacs_value args[],
195
			void *data)
196
{
197
  struct super_struct *p = calloc (1, sizeof *p);
198
  p->amazing_int = env->extract_integer (env, args[0]);
199
  return env->make_user_ptr (env, free, p);
200 201
}

202 203
/* Return the amazing_int of a passed 'user-pointer to a super_struct'.  */
static emacs_value
204 205
Fmod_test_userptr_get (emacs_env *env, ptrdiff_t nargs, emacs_value args[],
		       void *data)
206 207 208 209 210 211
{
  struct super_struct *p = env->get_user_ptr (env, args[0]);
  return env->make_integer (env, p->amazing_int);
}


212 213
/* Fill vector in args[0] with value in args[1].  */
static emacs_value
214 215
Fmod_test_vector_fill (emacs_env *env, ptrdiff_t nargs, emacs_value args[],
		       void *data)
216 217 218
{
  emacs_value vec = args[0];
  emacs_value val = args[1];
219 220
  ptrdiff_t size = env->vec_size (env, vec);
  for (ptrdiff_t i = 0; i < size; i++)
221 222 223 224 225
    env->vec_set (env, vec, i, val);
  return env->intern (env, "t");
}


226 227 228
/* Return whether all elements of vector in args[0] are 'eq' to value
   in args[1].  */
static emacs_value
229 230
Fmod_test_vector_eq (emacs_env *env, ptrdiff_t nargs, emacs_value args[],
		     void *data)
231 232 233
{
  emacs_value vec = args[0];
  emacs_value val = args[1];
234 235
  ptrdiff_t size = env->vec_size (env, vec);
  for (ptrdiff_t i = 0; i < size; i++)
236 237 238 239 240
    if (!env->eq (env, env->vec_get (env, vec, i), val))
        return env->intern (env, "nil");
  return env->intern (env, "t");
}

241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
static emacs_value invalid_stored_value;

/* The next two functions perform a possibly-invalid operation: they
   store a value in a static variable and load it.  This causes
   undefined behavior if the environment that the value was created
   from is no longer live.  The module assertions check for this
   error.  */

static emacs_value
Fmod_test_invalid_store (emacs_env *env, ptrdiff_t nargs, emacs_value *args,
                         void *data)
{
  return invalid_stored_value = env->make_integer (env, 123);
}

static emacs_value
Fmod_test_invalid_load (emacs_env *env, ptrdiff_t nargs, emacs_value *args,
                        void *data)
{
  return invalid_stored_value;
}

263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
/* An invalid finalizer: Finalizers are run during garbage collection,
   where Lisp code can’t be executed.  -module-assertions tests for
   this case.  */

static emacs_env *current_env;

static void
invalid_finalizer (void *ptr)
{
  current_env->intern (current_env, "nil");
}

static emacs_value
Fmod_test_invalid_finalizer (emacs_env *env, ptrdiff_t nargs, emacs_value *args,
                             void *data)
{
  current_env = env;
  env->make_user_ptr (env, invalid_finalizer, NULL);
  return env->funcall (env, env->intern (env, "garbage-collect"), 0, NULL);
}

284

285
/* Lisp utilities for easier readability (simple wrappers).  */
286

287 288 289
/* Provide FEATURE to Emacs.  */
static void
provide (emacs_env *env, const char *feature)
290 291 292 293 294 295 296 297
{
  emacs_value Qfeat = env->intern (env, feature);
  emacs_value Qprovide = env->intern (env, "provide");
  emacs_value args[] = { Qfeat };

  env->funcall (env, Qprovide, 1, args);
}

298 299 300
/* Bind NAME to FUN.  */
static void
bind_function (emacs_env *env, const char *name, emacs_value Sfun)
301 302 303 304 305 306 307 308
{
  emacs_value Qfset = env->intern (env, "fset");
  emacs_value Qsym = env->intern (env, name);
  emacs_value args[] = { Qsym, Sfun };

  env->funcall (env, Qfset, 2, args);
}

309 310 311
/* Module init function.  */
int
emacs_module_init (struct emacs_runtime *ert)
312
{
313
  if (ert->size < sizeof *ert)
314
    {
315 316 317
      fprintf (stderr, "Runtime size of runtime structure (%"pT" bytes) "
               "smaller than compile-time size (%"pZ" bytes)",
               (T_TYPE) ert->size, (Z_TYPE) sizeof (*ert));
318 319
      return 1;
    }
320

321 322
  emacs_env *env = ert->get_environment (ert);

Philipp Stephani's avatar
Philipp Stephani committed
323
  if (env->size < sizeof *env)
324
    {
325 326 327
      fprintf (stderr, "Runtime size of environment structure (%"pT" bytes) "
               "smaller than compile-time size (%"pZ" bytes)",
               (T_TYPE) env->size, (Z_TYPE) sizeof (*env));
328 329
      return 2;
    }
330

331
#define DEFUN(lsym, csym, amin, amax, doc, data) \
332 333
  bind_function (env, lsym, \
		 env->make_function (env, amin, amax, csym, doc, data))
334 335

  DEFUN ("mod-test-return-t", Fmod_test_return_t, 1, 1, NULL, NULL);
336
  DEFUN ("mod-test-sum", Fmod_test_sum, 2, 2, "Return A + B\n\n(fn a b)", NULL);
337 338
  DEFUN ("mod-test-signal", Fmod_test_signal, 0, 0, NULL, NULL);
  DEFUN ("mod-test-throw", Fmod_test_throw, 0, 0, NULL, NULL);
339 340
  DEFUN ("mod-test-non-local-exit-funcall", Fmod_test_non_local_exit_funcall,
	 1, 1, NULL, NULL);
341 342 343 344 345 346
  DEFUN ("mod-test-globref-make", Fmod_test_globref_make, 0, 0, NULL, NULL);
  DEFUN ("mod-test-string-a-to-b", Fmod_test_string_a_to_b, 1, 1, NULL, NULL);
  DEFUN ("mod-test-userptr-make", Fmod_test_userptr_make, 1, 1, NULL, NULL);
  DEFUN ("mod-test-userptr-get", Fmod_test_userptr_get, 1, 1, NULL, NULL);
  DEFUN ("mod-test-vector-fill", Fmod_test_vector_fill, 2, 2, NULL, NULL);
  DEFUN ("mod-test-vector-eq", Fmod_test_vector_eq, 2, 2, NULL, NULL);
347 348
  DEFUN ("mod-test-invalid-store", Fmod_test_invalid_store, 0, 0, NULL, NULL);
  DEFUN ("mod-test-invalid-load", Fmod_test_invalid_load, 0, 0, NULL, NULL);
349 350
  DEFUN ("mod-test-invalid-finalizer", Fmod_test_invalid_finalizer, 0, 0,
         NULL, NULL);
351 352 353 354 355 356

#undef DEFUN

  provide (env, "mod-test");
  return 0;
}