aboutsummaryrefslogtreecommitdiff
path: root/Lib/guile/typemaps.i
diff options
context:
space:
mode:
Diffstat (limited to 'Lib/guile/typemaps.i')
-rw-r--r--Lib/guile/typemaps.i367
1 files changed, 334 insertions, 33 deletions
diff --git a/Lib/guile/typemaps.i b/Lib/guile/typemaps.i
index 21d6150db..5ca39fb3c 100644
--- a/Lib/guile/typemaps.i
+++ b/Lib/guile/typemaps.i
@@ -3,39 +3,235 @@
$Header$ */
-/* Unlike other SWIG language modules, the Guile module handles all
- non-pointer types uniformly via typemaps. Here are the
- definitions.
+/* (11/24/2001) Note to Matthias:
- The SIMPLE_MAP macro below defines the whole set of typemaps needed
- for simple types. */
+ I've replaced all of the documentation related typemaps (indoc, varindoc, outdoc, argoutdoc, ...)
+ with a typemap parameter of "doc". For example:
+
+ %typemap(in, doc="<integer>") int {
+ ...
+ }
+
+ This is somewhat more sane to handle when multi-argument typemaps are used. For example:
+
+ %typemap(in, doc="<buffer>") (char *data, int len) {
+ ...
+ }
+
+ See guile.cxx for details of how the typemap parameters actually get accessed.
+
+ Also, it's no longer necessary to specify typemaps for 'const' qualifiers. They
+ now get matched against non-const versions.
+
+ Feel free to delete this comment after you've read it.
+
+ --- Dave
+*/
+
+/* Pointers */
+
+%typemap(in) SWIGTYPE * {
+ if (SWIG_Guile_GetPtr($input, (void **) &$1, $descriptor))
+ scm_wrong_type_arg(FUNC_NAME, $argnum, $input);
+}
+
+%typemap(in) void * {
+ if (SWIG_Guile_GetPtr($input, (void **) &$1, NULL))
+ scm_wrong_type_arg(FUNC_NAME, $argnum, $input);
+}
+
+%typemap(varin) SWIGTYPE * {
+ if (SWIG_Guile_GetPtr($input, (void **) &$1, $descriptor))
+ scm_wrong_type_arg(FUNC_NAME, 1, $input);
+}
+
+%typemap(varin) void * {
+ if (SWIG_Guile_GetPtr($input, (void **) &$1, NULL))
+ scm_wrong_type_arg(FUNC_NAME, 1, $input);
+}
+
+%typemap(out) SWIGTYPE * {
+ $result = SWIG_Guile_MakePtr ($1, $descriptor);
+}
+
+%typemap(out) SWIGTYPE *DYNAMIC {
+ swig_type_info *ty = SWIG_TypeDynamicCast($1_descriptor,(void **) &$1);
+ $result = SWIG_Guile_MakePtr ($1, ty);
+}
+
+%typemap(varout) SWIGTYPE * {
+ $result = SWIG_Guile_MakePtr ($1, $descriptor);
+}
+
+/* Pass-by-value */
+
+%typemap(in) SWIGTYPE($&1_ltype argp) {
+ if (SWIG_Guile_GetPtr($input, (void **) &argp, $&1_descriptor))
+ scm_wrong_type_arg(FUNC_NAME,$argnum,$input);
+ $1 = *argp;
+}
+
+%typemap(varin) SWIGTYPE {
+ $&1_ltype argp;
+ if (SWIG_Guile_GetPtr($input, (void **) &argp, $&1_descriptor))
+ scm_wrong_type_arg(FUNC_NAME,1,$input);
+ $1 = *argp;
+}
+
+%typemap(out) SWIGTYPE
+#ifdef __cplusplus
+{
+ $&1_ltype resultptr;
+ resultptr = new $1_ltype(($1_ltype &) $1);
+ $result = SWIG_Guile_MakePtr (resultptr, $&1_descriptor);
+}
+#else
+{
+ $&1_ltype resultptr;
+ resultptr = ($&1_ltype) malloc(sizeof($1_type));
+ memmove(resultptr, &$1, sizeof($1_type));
+ $result = SWIG_Guile_MakePtr(resultptr, $&1_descriptor);
+}
+#endif
+
+%typemap(varout) SWIGTYPE
+#ifdef __cplusplus
+{
+ $&1_ltype resultptr;
+ resultptr = new $1_ltype(($1_ltype&) $1);
+ $result = SWIG_Guile_MakePtr (resultptr, $&1_descriptor);
+}
+#else
+{
+ $&1_ltype resultptr;
+ resultptr = ($&1_ltype) malloc(sizeof($1_type));
+ memmove(resultptr, &$1, sizeof($1_type));
+ $result = SWIG_Guile_MakePtr(resultptr, $&1_descriptor);
+}
+#endif
+
+/* C++ References */
+
+#ifdef __cplusplus
+
+%typemap(in) SWIGTYPE &, const SWIGTYPE & {
+ if (SWIG_Guile_GetPtr($input, (void **) &$1, $descriptor)!=0 || $1 == NULL)
+ scm_wrong_type_arg(FUNC_NAME, $argnum, $input);
+}
+
+%typemap(out) SWIGTYPE &, const SWIGTYPE & {
+ $result = SWIG_Guile_MakePtr ($1, $descriptor);
+}
+
+%typemap(out) SWIGTYPE &DYNAMIC {
+ swig_type_info *ty = SWIG_TypeDynamicCast($1_descriptor,(void **) &$1);
+ $result = SWIG_Guile_MakePtr ($1, ty);
+}
+
+#endif
+
+/* Arrays */
+
+%typemap(in) SWIGTYPE[] {
+ if (SWIG_Guile_GetPtr($input, (void **) &$1, $descriptor)!=0)
+ scm_wrong_type_arg(FUNC_NAME, $argnum, $input);
+}
+
+%typemap(out) SWIGTYPE[] {
+ $result = SWIG_Guile_MakePtr ($1, $descriptor);
+}
+
+/* Enums */
+
+%typemap(in) enum SWIGTYPE "$1 = gh_scm2int($input);";
+%typemap(varin) enum SWIGTYPE "$1 = ($1_type) gh_scm2int($input);";
+%typemap(out) enum SWIGTYPE "$result = gh_int2scm($1);";
+%typemap(varout) enum SWIGTYPE "$result = gh_int2scm($1);";
+
+/* The SIMPLE_MAP_WITH_EXPR macro below defines the whole set of
+ typemaps needed for simple types.
+ -- SCM_TO_C_EXPR is a C expression that translates the Scheme value
+ "swig_scm_value" to a C value.
+ -- C_TO_SCM_EXPR is a C expression that translates the C value
+ "swig_c_value" to a Scheme value. */
+
+%define SIMPLE_MAP_WITH_EXPR(C_NAME, SCM_TO_C_EXPR, C_TO_SCM_EXPR, SCM_NAME)
+ %typemap (in, doc="$NAME is of type <" #SCM_NAME ">") C_NAME
+ { SCM swig_scm_value = $input;
+ $1 = SCM_TO_C_EXPR; }
+ %typemap (varin, doc="NEW-VALUE is of type <" #SCM_NAME ">") C_NAME
+ { SCM swig_scm_value = $input;
+ $1 = SCM_TO_C_EXPR; }
+ %typemap (out, doc="<" #SCM_NAME ">") C_NAME
+ { C_NAME swig_c_value = $1;
+ $result = C_TO_SCM_EXPR; }
+ %typemap (varout, doc="<" #SCM_NAME ">") C_NAME
+ { C_NAME swig_c_value = $1;
+ $result = C_TO_SCM_EXPR; }
+ /* INPUT and OUTPUT */
+ %typemap (in, doc="$NAME is of type <" #SCM_NAME ">)")
+ C_NAME *INPUT(C_NAME temp) {
+ SCM swig_scm_value = $input;
+ temp = (C_NAME) SCM_TO_C_EXPR; $1 = &temp; }
+ %typemap (in,numinputs=0) C_NAME *OUTPUT (C_NAME temp)
+ {$1 = &temp;}
+ %typemap (argout,doc="$name (of type <" #SCM_NAME ">)") C_NAME *OUTPUT
+ { C_NAME swig_c_value = *$1;
+ SWIG_APPEND_VALUE(C_TO_SCM_EXPR); }
+ %typemap (in) C_NAME *BOTH = C_NAME *INPUT;
+ %typemap (argout) C_NAME *BOTH = C_NAME *OUTPUT;
+ %typemap (in) C_NAME *INOUT = C_NAME *INPUT;
+ %typemap (argout) C_NAME *INOUT = C_NAME *OUTPUT;
+ /* Const primitive references. Passed by value */
+ %typemap(in, doc="$NAME is of type <" #SCM_NAME ">") const C_NAME & (C_NAME temp)
+ { SCM swig_scm_value = $input;
+ temp = SCM_TO_C_EXPR;
+ $1 = &temp; }
+ %typemap(out, doc="<" #SCM_NAME ">") const C_NAME &
+ { C_NAME swig_c_value = *$1;
+ $result = C_TO_SCM_EXPR; }
+%enddef
+
+/* The SIMPLE_MAP macro below defines the whole set of typemaps needed
+ for simple types. It generates slightly simpler code than the
+ macro above, but it is only suitable for very simple conversion
+ expressions. */
%define SIMPLE_MAP(C_NAME, SCM_TO_C, C_TO_SCM, SCM_NAME)
- %typemap (guile, in) C_NAME "$target = SCM_TO_C($source);";
- %typemap (guile, varin) C_NAME "$target = SCM_TO_C($source);";
- %typemap (guile, out) C_NAME "$target = C_TO_SCM($source);";
- %typemap (guile, varout) C_NAME "$target = C_TO_SCM($source);";
- %typemap (guile, indoc) C_NAME "($arg <SCM_NAME>)";
- %typemap (guile, varindoc) C_NAME "($arg <SCM_NAME>)";
- %typemap (guile, outdoc) C_NAME "<SCM_NAME>";
- %typemap (guile, varoutdoc) C_NAME "<SCM_NAME>";
- %typemap (guile, in) C_NAME *INPUT (C_NAME temp)
- "temp = (C_NAME) C_TO_SCM($source); $target = &temp;"
- %typemap (guile, indoc) C_NAME *INPUT "($arg <SCM_NAME>)";
- %typemap (guile, ignore) C_NAME *OUTPUT (C_NAME temp)
- "$target = &temp;"
- %typemap (guile, argout) C_NAME *OUTPUT
- "GUILE_APPEND_RESULT(C_TO_SCM(*$target));";
- %typemap (guile, argoutdoc) C_NAME *OUTPUT "($arg <SCM_NAME>)";
- %typemap (guile, in) C_NAME *BOTH = C_NAME *INPUT;
- %typemap (guile, indoc) C_NAME *BOTH = C_NAME *INPUT;
- %typemap (guile, argout) C_NAME *BOTH = C_NAME *OUTPUT;
- %typemap (guile, argoutdoc) C_NAME *BOTH = C_NAME *OUTPUT;
+ %typemap (in, doc="$NAME is of type <" #SCM_NAME ">")
+ C_NAME {$1 = SCM_TO_C($input);}
+ %typemap (varin, doc="NEW-VALUE is of type <" #SCM_NAME ">")
+ C_NAME {$1 = SCM_TO_C($input);}
+ %typemap (out, doc="<" #SCM_NAME ">")
+ C_NAME {$result = C_TO_SCM($1);}
+ %typemap (varout, doc="<" #SCM_NAME ">")
+ C_NAME {$result = C_TO_SCM($1);}
+ /* INPUT and OUTPUT */
+ %typemap (in, doc="$NAME is of type <" #SCM_NAME ">)")
+ C_NAME *INPUT(C_NAME temp) {
+ temp = (C_NAME) SCM_TO_C($input); $1 = &temp;
+ }
+ %typemap (in,numinputs=0) C_NAME *OUTPUT (C_NAME temp)
+ {$1 = &temp;}
+ %typemap (argout,doc="$name (of type <" #SCM_NAME ">)") C_NAME *OUTPUT
+ {SWIG_APPEND_VALUE(C_TO_SCM(*$1));}
+ %typemap (in) C_NAME *BOTH = C_NAME *INPUT;
+ %typemap (argout) C_NAME *BOTH = C_NAME *OUTPUT;
+ %typemap (in) C_NAME *INOUT = C_NAME *INPUT;
+ %typemap (argout) C_NAME *INOUT = C_NAME *OUTPUT;
+ /* Const primitive references. Passed by value */
+ %typemap(in, doc="$NAME is of type <" #SCM_NAME ">") const C_NAME & (C_NAME temp) {
+ temp = SCM_TO_C($input);
+ $1 = &temp;
+ }
+ %typemap(out, doc="<" #SCM_NAME ">") const C_NAME & {
+ $result = C_TO_SCM(*$1);
+ }
%enddef
-
+
SIMPLE_MAP(bool, gh_scm2bool, gh_bool2scm, boolean);
- SIMPLE_MAP(char, GSWIG_scm2char, gh_char2scm, char);
- SIMPLE_MAP(unsigned char, GSWIG_scm2char, gh_char2scm, char);
+ SIMPLE_MAP(char, gh_scm2char, gh_char2scm, char);
+ SIMPLE_MAP(unsigned char, gh_scm2char, gh_char2scm, char);
SIMPLE_MAP(int, gh_scm2int, gh_int2scm, integer);
SIMPLE_MAP(short, gh_scm2int, gh_int2scm, integer);
SIMPLE_MAP(long, gh_scm2long, gh_long2scm, integer);
@@ -46,17 +242,122 @@
SIMPLE_MAP(size_t, gh_scm2ulong, gh_ulong2scm, integer);
SIMPLE_MAP(float, gh_scm2double, gh_double2scm, real);
SIMPLE_MAP(double, gh_scm2double, gh_double2scm, real);
- SIMPLE_MAP(char *, GSWIG_scm2str, gh_str02scm, string);
- SIMPLE_MAP(const char *, GSWIG_scm2str, gh_str02scm, string);
+// SIMPLE_MAP(char *, SWIG_scm2str, gh_str02scm, string);
+// SIMPLE_MAP(const char *, SWIG_scm2str, gh_str02scm, string);
+
+/* Strings */
+
+ %typemap (in, doc="$NAME is a string") char *(int must_free = 0) {
+ $1 = SWIG_scm2str($input);
+ must_free = 1;
+ }
+ %typemap (varin, doc="NEW-VALUE is a string") char * {$1 = SWIG_scm2str($input);}
+ %typemap (out, doc="<string>") char * {$result = gh_str02scm($1);}
+ %typemap (varout, doc="<string>") char * {$result = gh_str02scm($1);}
+ %typemap (in, doc="$NAME is a string") char * *INPUT(char * temp, int must_free = 0) {
+ temp = (char *) SWIG_scm2str($input); $1 = &temp;
+ must_free = 1;
+ }
+ %typemap (in,numinputs=0) char * *OUTPUT (char * temp)
+ {$1 = &temp;}
+ %typemap (argout,doc="$NAME (a string)") char * *OUTPUT
+ {SWIG_APPEND_VALUE(gh_str02scm(*$1));}
+ %typemap (in) char * *BOTH = char * *INPUT;
+ %typemap (argout) char * *BOTH = char * *OUTPUT;
+ %typemap (in) char * *INOUT = char * *INPUT;
+ %typemap (argout) char * *INOUT = char * *OUTPUT;
/* GSWIG_scm2str makes a malloc'ed copy of the string, so get rid of it after
the function call. */
-%typemap (guile, freearg) char *, const char * "if ($target) scm_must_free($target);";
+%typemap (freearg) char * "if (must_free$argnum && $1) scm_must_free($1);";
+%typemap (freearg) char **INPUT, char **BOTH "if (must_free$argnum && (*$1)) scm_must_free(*$1);"
+%typemap (freearg) char **OUTPUT "scm_must_free(*$1);"
+
+/* But this shall not apply if we try to pass a single char by
+ reference. */
+
+%typemap (freearg) char *OUTPUT, char *BOTH "";
+
+/* If we set a string variable, delete the old result first. */
+
+%typemap (varin) char * {
+ if ($1) free($1);
+ $1 = SWIG_scm2str($input);
+}
/* Void */
-%typemap (guile, out) void "gswig_result = GH_UNSPECIFIED;";
-%typemap (guile, outdoc) void "";
+%typemap (out,doc="") void "gswig_result = GH_UNSPECIFIED;";
+
+/* SCM is passed through */
+
+typedef unsigned long SCM;
+%typemap (in) SCM "$1=$input;";
+%typemap (out) SCM "$result=$1;";
+
+/* Some ANSI C typemaps */
+
+%apply long { size_t };
+
+/* ------------------------------------------------------------
+ * String & length
+ * ------------------------------------------------------------ */
+
+%typemap(in) (char *STRING, int LENGTH) {
+ size_t temp;
+ $1 = ($1_ltype) gh_scm2newstr($input, &temp);
+ $2 = ($2_ltype) temp;
+}
+
+/* ------------------------------------------------------------
+ * Typechecking rules
+ * ------------------------------------------------------------ */
+
+/* adapted from python.swg */
+
+%typecheck(SWIG_TYPECHECK_INTEGER)
+ int, short, long,
+ unsigned int, unsigned short, unsigned long,
+ signed char, unsigned char,
+ long long, unsigned long long,
+ const int &, const short &, const long &,
+ const unsigned int &, const unsigned short &, const unsigned long &,
+ const long long &, const unsigned long long &,
+ enum SWIGTYPE,
+ bool, const bool &
+{
+ $1 = SCM_NFALSEP(scm_integer_p($input)) ? 1 : 0;
+}
+
+%typecheck(SWIG_TYPECHECK_DOUBLE)
+ float, double,
+ const float &, const double &
+{
+ $1 = SCM_NFALSEP(scm_real_p($input)) ? 1 : 0;
+}
+
+%typecheck(SWIG_TYPECHECK_CHAR) char {
+ $1 = SCM_CHARP($input) ? 1 : 0;
+}
+
+%typecheck(SWIG_TYPECHECK_STRING) char * {
+ $1 = SCM_STRINGP($input) ? 1 : 0;
+}
+
+%typecheck(SWIG_TYPECHECK_POINTER) SWIGTYPE *, SWIGTYPE &, SWIGTYPE [] {
+ void *ptr;
+ $1 = !SWIG_Guile_GetPtr($input, &ptr, $1_descriptor);
+}
+
+%typecheck(SWIG_TYPECHECK_VOIDPTR) void * {
+ void *ptr;
+ $1 = !SWIG_Guile_GetPtr($input, &ptr, 0);
+}
/* typemaps.i ends here */
+
+
+
+
+
generated by cgit v1.2.3 (git 2.25.1) at 2024-06-21 17:26:52 +0000