summaryrefslogtreecommitdiff
path: root/libguile/foreign.c
blob: 4a4b2181a11477c0c2c2db954f7ace2c67a04c11 (plain)
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
/* Copyright (C) 2010  Free Software Foundation, Inc.
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 3 of
 * the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301 USA
 */

#if HAVE_CONFIG_H
#  include <config.h>
#endif

#include <string.h>
#include "libguile/_scm.h"
#include "libguile/foreign.h"



static size_t
sizeof_type (scm_t_foreign_type type)
{
  switch (type)
    {
    case SCM_FOREIGN_TYPE_VOID:    abort ();
    case SCM_FOREIGN_TYPE_FLOAT:   return sizeof(float);
    case SCM_FOREIGN_TYPE_DOUBLE:  return sizeof(double);
    case SCM_FOREIGN_TYPE_UINT8:   return sizeof(scm_t_uint8);
    case SCM_FOREIGN_TYPE_INT8:    return sizeof(scm_t_int8);
    case SCM_FOREIGN_TYPE_UINT16:  return sizeof(scm_t_uint16);
    case SCM_FOREIGN_TYPE_INT16:   return sizeof(scm_t_int16);
    case SCM_FOREIGN_TYPE_UINT32:  return sizeof(scm_t_uint32);
    case SCM_FOREIGN_TYPE_INT32:   return sizeof(scm_t_int32);
    case SCM_FOREIGN_TYPE_UINT64:  return sizeof(scm_t_uint64);
    case SCM_FOREIGN_TYPE_INT64:   return sizeof(scm_t_int64);
    case SCM_FOREIGN_TYPE_STRUCT:  abort ();
    case SCM_FOREIGN_TYPE_POINTER: return sizeof(void*);
    default:                       abort ();
    }
}


static void
foreign_finalizer_trampoline (GC_PTR ptr, GC_PTR data)
{
  scm_t_foreign_finalizer finalizer = data;
  finalizer (SCM_FOREIGN_OBJECT (PTR2SCM (ptr), void*));
}

SCM
scm_c_from_foreign (scm_t_foreign_type type, void *val, size_t size,
                    scm_t_foreign_finalizer finalizer)
{
  SCM ret;
  if (!size)
    size = sizeof_type (type);
    
  ret = PTR2SCM (scm_gc_malloc_pointerless (sizeof (scm_t_bits) * 2 + size,
                                            "foreign"));
  SCM_SET_CELL_WORD_0 (ret, (scm_t_bits)(scm_tc7_foreign | (type<<8)));

  /* set SCM_FOREIGN_OBJECT to point to the third word of the object, which will
     be 8-byte aligned. Then copy *val into that space. */
  SCM_SET_CELL_WORD_1 (ret, (scm_t_bits)SCM_CELL_OBJECT_LOC (ret, 2));
  memcpy (SCM_FOREIGN_OBJECT (ret, void), val, size);

  if (finalizer)
    {
      /* Register a finalizer for the newly created instance.  */
      GC_finalization_proc prev_finalizer;
      GC_PTR prev_finalizer_data;
      GC_REGISTER_FINALIZER_NO_ORDER (SCM2PTR (ret),
                                      foreign_finalizer_trampoline,
                                      finalizer,
                                      &prev_finalizer,
                                      &prev_finalizer_data);
    }

  return ret;
}

SCM
scm_c_take_foreign (scm_t_foreign_type type, void *val,
                    scm_t_foreign_finalizer finalizer)
{
  SCM ret;
    
  ret = PTR2SCM (scm_gc_malloc_pointerless (sizeof (scm_t_bits) * 2,
                                            "foreign"));
  SCM_SET_CELL_WORD_0 (ret, (scm_t_bits)(scm_tc7_foreign | (type<<8)));
  /* Set SCM_FOREIGN_OBJECT to the given pointer. */
  SCM_SET_CELL_WORD_1 (ret, (scm_t_bits)val);

  if (finalizer)
    {
      /* Register a finalizer for the newly created instance.  */
      GC_finalization_proc prev_finalizer;
      GC_PTR prev_finalizer_data;
      GC_REGISTER_FINALIZER_NO_ORDER (SCM2PTR (ret),
                                      foreign_finalizer_trampoline,
                                      finalizer,
                                      &prev_finalizer,
                                      &prev_finalizer_data);
    }

  return ret;
}

SCM_DEFINE (scm_foreign_ref, "foreign-ref", 1, 0, 0,
	    (SCM foreign),
	    "Reference the foreign value wrapped by @var{foreign}.\n\n"
            "Note that only \"simple\" types may be referenced by this\n"
            "function. See @code{foreign-struct-ref} or @code{foreign-pointer-ref}\n"
            "for structs or pointers, respectively.")
#define FUNC_NAME s_scm_foreign_ref
{
  SCM_VALIDATE_FOREIGN_SIMPLE (1, foreign);

  switch (SCM_FOREIGN_TYPE (foreign))
    {
    case SCM_FOREIGN_TYPE_FLOAT:
      return scm_from_double (SCM_FOREIGN_OBJECT_REF (foreign, float));
    case SCM_FOREIGN_TYPE_DOUBLE:
      return scm_from_double (SCM_FOREIGN_OBJECT_REF (foreign, double));
    case SCM_FOREIGN_TYPE_UINT8:
      return scm_from_uint8 (SCM_FOREIGN_OBJECT_REF (foreign, scm_t_uint8));
    case SCM_FOREIGN_TYPE_INT8:
      return scm_from_int8 (SCM_FOREIGN_OBJECT_REF (foreign, scm_t_int8));
    case SCM_FOREIGN_TYPE_UINT16:
      return scm_from_uint16 (SCM_FOREIGN_OBJECT_REF (foreign, scm_t_uint16));
    case SCM_FOREIGN_TYPE_INT16:
      return scm_from_int16 (SCM_FOREIGN_OBJECT_REF (foreign, scm_t_int16));
    case SCM_FOREIGN_TYPE_UINT32:
      return scm_from_uint32 (SCM_FOREIGN_OBJECT_REF (foreign, scm_t_uint32));
    case SCM_FOREIGN_TYPE_INT32:
      return scm_from_int32 (SCM_FOREIGN_OBJECT_REF (foreign, scm_t_int32));
    case SCM_FOREIGN_TYPE_UINT64:
      return scm_from_uint64 (SCM_FOREIGN_OBJECT_REF (foreign, scm_t_uint64));
    case SCM_FOREIGN_TYPE_INT64:
      return scm_from_int64 (SCM_FOREIGN_OBJECT_REF (foreign, scm_t_int64));
    case SCM_FOREIGN_TYPE_VOID:
    case SCM_FOREIGN_TYPE_STRUCT:
    case SCM_FOREIGN_TYPE_POINTER:
    default:
      /* other cases should have been caught by the FOREIGN_SIMPLE check */
      abort ();
    }
}
#undef FUNC_NAME

SCM_DEFINE (scm_foreign_set_x, "foreign-set!", 2, 0, 0,
	    (SCM foreign, SCM val),
	    "Set the foreign value wrapped by @var{foreign}.\n\n"
            "Note that only \"simple\" types may be set by this function.\n"
            "See @code{foreign-struct-ref} or @code{foreign-pointer-ref} for\n"
            "structs or pointers, respectively.")
#define FUNC_NAME s_scm_foreign_set_x
{
  SCM_VALIDATE_FOREIGN_SIMPLE (1, foreign);

  switch (SCM_FOREIGN_TYPE (foreign))
    {
    case SCM_FOREIGN_TYPE_FLOAT:
      SCM_FOREIGN_OBJECT_SET (foreign, float, scm_to_double (val));
      break;
    case SCM_FOREIGN_TYPE_DOUBLE:
      SCM_FOREIGN_OBJECT_SET (foreign, double, scm_to_double (val));
      break;
    case SCM_FOREIGN_TYPE_UINT8:
      SCM_FOREIGN_OBJECT_SET (foreign, scm_t_uint8, scm_to_uint8 (val));
      break;
    case SCM_FOREIGN_TYPE_INT8:
      SCM_FOREIGN_OBJECT_SET (foreign, scm_t_int8, scm_to_int8 (val));
      break;
    case SCM_FOREIGN_TYPE_UINT16:
      SCM_FOREIGN_OBJECT_SET (foreign, scm_t_uint16, scm_to_uint16 (val));
      break;
    case SCM_FOREIGN_TYPE_INT16:
      SCM_FOREIGN_OBJECT_SET (foreign, scm_t_int16, scm_to_int16 (val));
      break;
    case SCM_FOREIGN_TYPE_UINT32:
      SCM_FOREIGN_OBJECT_SET (foreign, scm_t_uint32, scm_to_uint32 (val));
      break;
    case SCM_FOREIGN_TYPE_INT32:
      SCM_FOREIGN_OBJECT_SET (foreign, scm_t_int32, scm_to_int32 (val));
      break;
    case SCM_FOREIGN_TYPE_UINT64:
      SCM_FOREIGN_OBJECT_SET (foreign, scm_t_uint64, scm_to_uint64 (val));
      break;
    case SCM_FOREIGN_TYPE_INT64:
      SCM_FOREIGN_OBJECT_SET (foreign, scm_t_int64, scm_to_int64 (val));
      break;
    case SCM_FOREIGN_TYPE_VOID:
    case SCM_FOREIGN_TYPE_STRUCT:
    case SCM_FOREIGN_TYPE_POINTER:
    default:
      /* other cases should have been caught by the FOREIGN_SIMPLE check */
      abort ();
    }
  return SCM_UNSPECIFIED;
}
#undef FUNC_NAME

void
scm_i_foreign_print (SCM foreign, SCM port, scm_print_state *pstate)
{
  scm_puts ("#<foreign ", port);
  switch (SCM_FOREIGN_TYPE (foreign))
    {
    case SCM_FOREIGN_TYPE_VOID:
      abort ();
    case SCM_FOREIGN_TYPE_FLOAT:
      scm_puts ("float ", port);
      scm_display (scm_foreign_ref (foreign), port);
      break;
    case SCM_FOREIGN_TYPE_DOUBLE:
      scm_puts ("double ", port);
      scm_display (scm_foreign_ref (foreign), port);
      break;
    case SCM_FOREIGN_TYPE_UINT8:
      scm_puts ("uint8 ", port);
      scm_display (scm_foreign_ref (foreign), port);
      break;
    case SCM_FOREIGN_TYPE_INT8:
      scm_puts ("int8 ", port);
      scm_display (scm_foreign_ref (foreign), port);
      break;
    case SCM_FOREIGN_TYPE_UINT16:
      scm_puts ("uint16 ", port);
      scm_display (scm_foreign_ref (foreign), port);
      break;
    case SCM_FOREIGN_TYPE_INT16:
      scm_puts ("int16 ", port);
      scm_display (scm_foreign_ref (foreign), port);
      break;
    case SCM_FOREIGN_TYPE_UINT32:
      scm_puts ("uint32 ", port);
      scm_display (scm_foreign_ref (foreign), port);
      break;
    case SCM_FOREIGN_TYPE_INT32:
      scm_puts ("int32 ", port);
      scm_display (scm_foreign_ref (foreign), port);
      break;
    case SCM_FOREIGN_TYPE_UINT64:
      scm_puts ("uint64 ", port);
      scm_display (scm_foreign_ref (foreign), port);
      break;
    case SCM_FOREIGN_TYPE_INT64:
      scm_puts ("int64 ", port);
      scm_display (scm_foreign_ref (foreign), port);
      break;
    case SCM_FOREIGN_TYPE_STRUCT:
      scm_puts ("struct at 0x", port);
      scm_uintprint (SCM_CELL_WORD_1 (foreign), 16, port);
      break;
    case SCM_FOREIGN_TYPE_POINTER:
      scm_puts ("pointer 0x", port);
      scm_uintprint (SCM_FOREIGN_OBJECT_REF (foreign, scm_t_bits), 16, port);
      break;
    default:
      abort ();
    }
  scm_putc ('>', port);
}



void
scm_init_foreign (void)
{
#ifndef SCM_MAGIC_SNARFER
#include "libguile/foreign.x"
#endif
}

/*
  Local Variables:
  c-file-style: "gnu"
  End:
*/