mod-test.c 9.68 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 <emacs-module.h>
24 25 26

int plugin_is_GPL_compatible;

27 28
/* Always return symbol 't'.  */
static emacs_value
29 30
Fmod_test_return_t (emacs_env *env, ptrdiff_t nargs, emacs_value args[],
		    void *data)
31 32 33 34
{
  return env->intern (env, "t");
}

35
/* Expose simple sum function.  */
36 37
static intmax_t
sum (intmax_t a, intmax_t b)
38 39 40 41
{
  return a + b;
}

42
static emacs_value
43
Fmod_test_sum (emacs_env *env, ptrdiff_t nargs, emacs_value args[], void *data)
44
{
45 46
  assert (nargs == 2);

47 48
  intmax_t a = env->extract_integer (env, args[0]);
  intmax_t b = env->extract_integer (env, args[1]);
49

50
  intmax_t r = sum (a, b);
51 52 53 54 55

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


56 57
/* Signal '(error 56).  */
static emacs_value
58 59
Fmod_test_signal (emacs_env *env, ptrdiff_t nargs, emacs_value args[],
		  void *data)
60 61
{
  assert (env->non_local_exit_check (env) == emacs_funcall_exit_return);
62 63
  env->non_local_exit_signal (env, env->intern (env, "error"),
			      env->make_integer (env, 56));
64
  return env->intern (env, "nil");
65 66 67
}


68 69
/* Throw '(tag 65).  */
static emacs_value
70 71
Fmod_test_throw (emacs_env *env, ptrdiff_t nargs, emacs_value args[],
		 void *data)
72 73
{
  assert (env->non_local_exit_check (env) == emacs_funcall_exit_return);
74 75
  env->non_local_exit_throw (env, env->intern (env, "tag"),
			     env->make_integer (env, 65));
76
  return env->intern (env, "nil");
77 78 79
}


80 81 82
/* Call argument function, catch all non-local exists and return
   either normal result or a list describing the non-local exit.  */
static emacs_value
83 84
Fmod_test_non_local_exit_funcall (emacs_env *env, ptrdiff_t nargs,
				  emacs_value args[], void *data)
85 86
{
  assert (nargs == 1);
Paul Eggert's avatar
Paul Eggert committed
87
  emacs_value result = env->funcall (env, args[0], 0, NULL);
88
  emacs_value non_local_exit_symbol, non_local_exit_data;
89 90 91
  enum emacs_funcall_exit code
    = env->non_local_exit_get (env, &non_local_exit_symbol,
			       &non_local_exit_data);
92 93 94 95 96 97 98
  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
99
        emacs_value Flist = env->intern (env, "list");
100 101
        emacs_value list_args[] = {env->intern (env, "signal"),
				   non_local_exit_symbol, non_local_exit_data};
102 103 104 105 106
        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
107
        emacs_value Flist = env->intern (env, "list");
108 109
        emacs_value list_args[] = {env->intern (env, "throw"),
				   non_local_exit_symbol, non_local_exit_data};
110 111 112
        return env->funcall (env, Flist, 3, list_args);
      }
    }
113 114

  /* Never reached.  */
115 116 117 118
  return env->intern (env, "nil");;
}


Paul Eggert's avatar
Paul Eggert committed
119
/* Return a global reference.  */
120
static emacs_value
121
Fmod_test_globref_make (emacs_env *env, ptrdiff_t nargs, emacs_value args[],
122
			void *data)
123
{
124 125
  /* Make a big string and make it global.  */
  char str[26 * 100];
126
  for (int i = 0; i < sizeof str; i++)
127
    str[i] = 'a' + (i % 26);
128

129 130
  /* We don't need to null-terminate str.  */
  emacs_value lisp_str = env->make_string (env, str, sizeof str);
131 132 133 134
  return env->make_global_ref (env, lisp_str);
}


135 136 137
/* Return a copy of the argument string where every 'a' is replaced
   with 'b'.  */
static emacs_value
138
Fmod_test_string_a_to_b (emacs_env *env, ptrdiff_t nargs, emacs_value args[],
139
			 void *data)
140 141
{
  emacs_value lisp_str = args[0];
142
  ptrdiff_t size = 0;
143 144 145 146 147 148
  char * buf = NULL;

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

149
  for (ptrdiff_t i = 0; i + 1 < size; i++)
150 151 152
    if (buf[i] == 'a')
      buf[i] = 'b';

153
  return env->make_string (env, buf, size - 1);
154 155 156
}


157
/* Embedded pointers in lisp objects.  */
158

159
/* C struct (pointer to) that will be embedded.  */
160 161 162 163 164 165
struct super_struct
{
  int amazing_int;
  char large_unused_buffer[512];
};

166 167 168
/* Return a new user-pointer to a super_struct, with amazing_int set
   to the passed parameter.  */
static emacs_value
169
Fmod_test_userptr_make (emacs_env *env, ptrdiff_t nargs, emacs_value args[],
170
			void *data)
171
{
172
  struct super_struct *p = calloc (1, sizeof *p);
173
  p->amazing_int = env->extract_integer (env, args[0]);
174
  return env->make_user_ptr (env, free, p);
175 176
}

177 178
/* Return the amazing_int of a passed 'user-pointer to a super_struct'.  */
static emacs_value
179 180
Fmod_test_userptr_get (emacs_env *env, ptrdiff_t nargs, emacs_value args[],
		       void *data)
181 182 183 184 185 186
{
  struct super_struct *p = env->get_user_ptr (env, args[0]);
  return env->make_integer (env, p->amazing_int);
}


187 188
/* Fill vector in args[0] with value in args[1].  */
static emacs_value
189 190
Fmod_test_vector_fill (emacs_env *env, ptrdiff_t nargs, emacs_value args[],
		       void *data)
191 192 193
{
  emacs_value vec = args[0];
  emacs_value val = args[1];
194 195
  ptrdiff_t size = env->vec_size (env, vec);
  for (ptrdiff_t i = 0; i < size; i++)
196 197 198 199 200
    env->vec_set (env, vec, i, val);
  return env->intern (env, "t");
}


201 202 203
/* Return whether all elements of vector in args[0] are 'eq' to value
   in args[1].  */
static emacs_value
204 205
Fmod_test_vector_eq (emacs_env *env, ptrdiff_t nargs, emacs_value args[],
		     void *data)
206 207 208
{
  emacs_value vec = args[0];
  emacs_value val = args[1];
209 210
  ptrdiff_t size = env->vec_size (env, vec);
  for (ptrdiff_t i = 0; i < size; i++)
211 212 213 214 215
    if (!env->eq (env, env->vec_get (env, vec, i), val))
        return env->intern (env, "nil");
  return env->intern (env, "t");
}

216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
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;
}

238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
/* 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);
}

259

260
/* Lisp utilities for easier readability (simple wrappers).  */
261

262 263 264
/* Provide FEATURE to Emacs.  */
static void
provide (emacs_env *env, const char *feature)
265 266 267 268 269 270 271 272
{
  emacs_value Qfeat = env->intern (env, feature);
  emacs_value Qprovide = env->intern (env, "provide");
  emacs_value args[] = { Qfeat };

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

273 274 275
/* Bind NAME to FUN.  */
static void
bind_function (emacs_env *env, const char *name, emacs_value Sfun)
276 277 278 279 280 281 282 283
{
  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);
}

284 285 286
/* Module init function.  */
int
emacs_module_init (struct emacs_runtime *ert)
287
{
288
  if (ert->size < sizeof *ert)
289 290 291 292 293 294
    {
      fprintf (stderr, "Runtime size of runtime structure (%td bytes) "
               "smaller than compile-time size (%zu bytes)",
               ert->size, sizeof *ert);
      return 1;
    }
295

296 297
  emacs_env *env = ert->get_environment (ert);

Philipp Stephani's avatar
Philipp Stephani committed
298
  if (env->size < sizeof *env)
299 300 301 302 303 304
    {
      fprintf (stderr, "Runtime size of environment structure (%td bytes) "
               "smaller than compile-time size (%zu bytes)",
               env->size, sizeof *env);
      return 2;
    }
305

306
#define DEFUN(lsym, csym, amin, amax, doc, data) \
307 308
  bind_function (env, lsym, \
		 env->make_function (env, amin, amax, csym, doc, data))
309 310

  DEFUN ("mod-test-return-t", Fmod_test_return_t, 1, 1, NULL, NULL);
311
  DEFUN ("mod-test-sum", Fmod_test_sum, 2, 2, "Return A + B\n\n(fn a b)", NULL);
312 313
  DEFUN ("mod-test-signal", Fmod_test_signal, 0, 0, NULL, NULL);
  DEFUN ("mod-test-throw", Fmod_test_throw, 0, 0, NULL, NULL);
314 315
  DEFUN ("mod-test-non-local-exit-funcall", Fmod_test_non_local_exit_funcall,
	 1, 1, NULL, NULL);
316 317 318 319 320 321
  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);
322 323
  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);
324 325
  DEFUN ("mod-test-invalid-finalizer", Fmod_test_invalid_finalizer, 0, 0,
         NULL, NULL);
326 327 328 329 330 331

#undef DEFUN

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