-#ifndef SCM_FOREIGN_H
-#define SCM_FOREIGN_H
-
-/* 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
- */
-
-#include "libguile/__scm.h"
-
-/* A foreign value is some value that exists outside of Guile. It is represented
- by a cell whose second word is a pointer. The first word has the
- scm_tc7_foreign typecode and type of the aliased (pointed-to) value in its
- lower 16 bits.
-
- There are numeric types, like uint32 and float, and there is a "generic
- pointer" type, void. Void pointers also have a length associated with them,
- in the high bits of the first word of the SCM object, but since they really
- are pointers out into the wild wooly world of C, perhaps we don't actually
- know how much memory they take up. In that, most general case, the "len"
- will be stored as 0.
-
- The basic idea is that we can help the programmer to avoid cutting herself,
- but we won't take away her knives.
-*/
-typedef enum
- {
- SCM_FOREIGN_TYPE_VOID, /* a pointer out into the wilderness */
- SCM_FOREIGN_TYPE_FLOAT,
- SCM_FOREIGN_TYPE_DOUBLE,
- SCM_FOREIGN_TYPE_UINT8,
- SCM_FOREIGN_TYPE_INT8,
- SCM_FOREIGN_TYPE_UINT16,
- SCM_FOREIGN_TYPE_INT16,
- SCM_FOREIGN_TYPE_UINT32,
- SCM_FOREIGN_TYPE_INT32,
- SCM_FOREIGN_TYPE_UINT64,
- SCM_FOREIGN_TYPE_INT64,
- SCM_FOREIGN_TYPE_LAST = SCM_FOREIGN_TYPE_INT64
- } scm_t_foreign_type;
-
-
-typedef void (*scm_t_foreign_finalizer) (void *);
-
-#define SCM_FOREIGN_P(x) \
- (!SCM_IMP (x) && SCM_TYP7(x) == scm_tc7_foreign)
-#define SCM_VALIDATE_FOREIGN(pos, x) \
- SCM_MAKE_VALIDATE (pos, x, FOREIGN_P)
-#define SCM_FOREIGN_TYPE(x) \
- ((scm_t_foreign_type)((SCM_CELL_WORD_0 (x) >> 8)&0xff))
-#define SCM_FOREIGN_POINTER(x, ctype) \
- ((ctype*)SCM_CELL_WORD_1 (x))
-#define SCM_FOREIGN_VALUE_REF(x, ctype) \
- (*SCM_FOREIGN_POINTER (x, ctype))
-#define SCM_FOREIGN_VALUE_SET(x, ctype, val) \
- (*SCM_FOREIGN_POINTER (x, ctype) = (val))
-#define SCM_FOREIGN_HAS_FINALIZER(x) \
- ((SCM_CELL_WORD_0 (x) >> 16) & 0x1)
-#define SCM_FOREIGN_LEN(x) \
- ((size_t)(SCM_CELL_WORD_0 (x) >> 17))
-
-#define SCM_FOREIGN_TYPED_P(x, type) \
- (SCM_FOREIGN_P (x) && SCM_FOREIGN_TYPE (x) == SCM_FOREIGN_TYPE_##type)
-#define SCM_VALIDATE_FOREIGN_TYPED(pos, x, type) \
- do { \
- SCM_ASSERT_TYPE (SCM_FOREIGN_TYPED_P (x, type), x, pos, FUNC_NAME, \
- "FOREIGN_"#type"_P"); \
- } while (0)
-
-#define SCM_FOREIGN_VALUE_P(x) \
- (SCM_FOREIGN_P (x) && SCM_FOREIGN_TYPE (x) != SCM_FOREIGN_TYPE_VOID)
-#define SCM_VALIDATE_FOREIGN_VALUE(pos, x) \
- SCM_MAKE_VALIDATE (pos, x, FOREIGN_VALUE_P)
-
-SCM_API SCM scm_take_foreign_pointer (scm_t_foreign_type type, void *ptr,
- size_t len,
- scm_t_foreign_finalizer finalizer);
-
-SCM_API SCM scm_alignof (SCM type);
-SCM_API SCM scm_sizeof (SCM type);
-SCM_API SCM scm_foreign_type (SCM foreign);
-SCM_API SCM scm_foreign_ref (SCM foreign);
-SCM_API SCM scm_foreign_set_x (SCM foreign, SCM val);
-SCM_API SCM scm_foreign_to_bytevector (SCM foreign, SCM type,
- SCM offset, SCM len);
-SCM_API SCM scm_foreign_set_finalizer_x (SCM foreign, SCM finalizer);
-SCM_API SCM scm_bytevector_to_foreign (SCM bv, SCM offset, SCM len);
-
-SCM_INTERNAL void scm_i_foreign_print (SCM foreign, SCM port,
- scm_print_state *pstate);
-
-\f
-
-/* Foreign functions */
-
-/* The goal is to make it so that calling a foreign function doesn't cause any
- heap allocation. That means we need native Scheme formats for all kinds of
- arguments.
-
- For "value" types like s64 or f32, we just use native Scheme value types.
- (Note that in both these cases, allocation is possible / likely, as the
- value might need to be boxed, but perhaps we won't worry about that. Hmm.)
-
- For everything else, we use foreign pointers. This includes arrays, pointer
- arguments and return vals, struct args and return vals, and out and in/out
- arguments.
- */
-
-SCM_API SCM scm_make_foreign_function (SCM return_type, SCM func_ptr,
- SCM arg_types);
-SCM_INTERNAL SCM scm_i_foreign_call (SCM foreign, SCM *argv);
-
-\f
-
-SCM_INTERNAL void scm_register_foreign (void);
-
-
-#endif /* SCM_FOREIGN_H */
+#ifndef SCM_FOREIGN_H
+#define SCM_FOREIGN_H
+
+/* Copyright (C) 2010, 2011, 2012 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
+ */
+
+#include "libguile/__scm.h"
+
+/* A "foreign pointer" is a wrapped C pointer. It is represented by a
+ cell whose second word is a pointer. The first word has the
+ `scm_tc7_pointer' type code.
+
+ The basic idea is that we can help the programmer to avoid cutting herself,
+ but we won't take away her knives. */
+
+enum scm_t_foreign_type
+ {
+ SCM_FOREIGN_TYPE_VOID,
+ SCM_FOREIGN_TYPE_FLOAT,
+ SCM_FOREIGN_TYPE_DOUBLE,
+ SCM_FOREIGN_TYPE_UINT8,
+ SCM_FOREIGN_TYPE_INT8,
+ SCM_FOREIGN_TYPE_UINT16,
+ SCM_FOREIGN_TYPE_INT16,
+ SCM_FOREIGN_TYPE_UINT32,
+ SCM_FOREIGN_TYPE_INT32,
+ SCM_FOREIGN_TYPE_UINT64,
+ SCM_FOREIGN_TYPE_INT64,
+ SCM_FOREIGN_TYPE_LAST = SCM_FOREIGN_TYPE_INT64
+ };
+
+typedef enum scm_t_foreign_type scm_t_foreign_type;
+
+typedef void (*scm_t_pointer_finalizer) (void *);
+
+#define SCM_POINTER_P(x) (SCM_HAS_TYP7 (x, scm_tc7_pointer))
+#define SCM_VALIDATE_POINTER(pos, x) \
+ SCM_MAKE_VALIDATE (pos, x, POINTER_P)
+#define SCM_POINTER_VALUE(x) \
+ ((void *) SCM_CELL_WORD_1 (x))
+
+SCM_API void *scm_to_pointer (SCM pointer);
+SCM_API SCM scm_from_pointer (void *, scm_t_pointer_finalizer);
+
+SCM_API SCM scm_alignof (SCM type);
+SCM_API SCM scm_sizeof (SCM type);
+SCM_API SCM scm_pointer_address (SCM pointer);
+SCM_API SCM scm_pointer_to_bytevector (SCM pointer, SCM type,
+ SCM offset, SCM len);
+SCM_API SCM scm_set_pointer_finalizer_x (SCM pointer, SCM finalizer);
+SCM_API SCM scm_bytevector_to_pointer (SCM bv, SCM offset);
+
+SCM_INTERNAL SCM scm_pointer_p (SCM obj);
+SCM_INTERNAL SCM scm_make_pointer (SCM address, SCM finalizer);
+SCM_INTERNAL void scm_i_pointer_print (SCM pointer, SCM port,
+ scm_print_state *pstate);
+
+SCM_INTERNAL SCM scm_dereference_pointer (SCM pointer);
+SCM_INTERNAL SCM scm_string_to_pointer (SCM string, SCM encoding);
+SCM_INTERNAL SCM scm_pointer_to_string (SCM pointer, SCM length, SCM encoding);
+
+\f
+
+/* Foreign functions */
+
+/* The goal is to make it so that calling a foreign function doesn't cause any
+ heap allocation. That means we need native Scheme formats for all kinds of
+ arguments.
+
+ For "value" types like s64 or f32, we just use native Scheme value types.
+ (Note that in both these cases, allocation is possible / likely, as the
+ value might need to be boxed, but perhaps we won't worry about that. Hmm.)
+
+ For everything else, we use foreign pointers. This includes arrays, pointer
+ arguments and return vals, struct args and return vals, and out and in/out
+ arguments.
+ */
+
+SCM_API SCM scm_pointer_to_procedure (SCM return_type, SCM func_ptr,
+ SCM arg_types);
+SCM_API SCM scm_procedure_to_pointer (SCM return_type, SCM func_ptr,
+ SCM arg_types);
+SCM_INTERNAL SCM scm_i_foreign_call (SCM foreign, const SCM *argv);
+
+\f
+
+SCM_INTERNAL void scm_register_foreign (void);
+
+
+#endif /* SCM_FOREIGN_H */
HCoop / bpt / guile.git / blobdiff