Clean up.
git-svn-id: https://swig.svn.sourceforge.net/svnroot/swig/trunk@203 626c5289-ae23-0410-ae9c-e8d60b6d4f22
This commit is contained in:
Dave Beazley
parent
cad299389b
commit
4e2c722503
1 changed files with 136 additions and 325 deletions
|
|
@ -1,13 +1,12 @@
|
|||
//
|
||||
// SWIG Typemap library
|
||||
// Dave Beazley
|
||||
// May 4, 1997
|
||||
//
|
||||
// Tcl implementation
|
||||
//
|
||||
// This library provides standard typemaps for modifying SWIG's behavior.
|
||||
// With enough entries in this file, I hope that very few people actually
|
||||
// ever need to write a typemap.
|
||||
/* -----------------------------------------------------------------------------
|
||||
* typemaps.i
|
||||
*
|
||||
* Swig typemap library for Tcl8. This file contains various sorts
|
||||
* of typemaps for modifying Swig's code generation.
|
||||
*
|
||||
* Author: David Beazley (beazley@cs.uchicago.edu)
|
||||
*
|
||||
* ----------------------------------------------------------------------------- */
|
||||
|
||||
#ifdef AUTODOC
|
||||
%section "Typemap Library (Tcl)",info,after,pre,nosort,skip=1,chop_left=3,chop_right=0,chop_top=0,chop_bottom=0
|
||||
|
|
@ -72,318 +71,6 @@ or you can use the %apply directive :
|
|||
%}
|
||||
#endif
|
||||
|
||||
|
||||
%typemap(tcl,in) double *INPUT(double temp)
|
||||
{
|
||||
if (Tcl_GetDouble(interp,$source,&temp) == TCL_ERROR) {
|
||||
return TCL_ERROR;
|
||||
}
|
||||
$target = &temp;
|
||||
}
|
||||
|
||||
%typemap(tcl,in) float *INPUT(double dvalue, float temp)
|
||||
{
|
||||
if (Tcl_GetDouble(interp,$source,&dvalue) == TCL_ERROR) {
|
||||
return TCL_ERROR;
|
||||
}
|
||||
temp = (float) dvalue;
|
||||
$target = &temp;
|
||||
}
|
||||
|
||||
%typemap(tcl,in) int *INPUT(int temp)
|
||||
{
|
||||
if (Tcl_GetInt(interp,$source,&temp) == TCL_ERROR) {
|
||||
return TCL_ERROR;
|
||||
}
|
||||
$target = &temp;
|
||||
}
|
||||
|
||||
%typemap(tcl,in) short *INPUT(int ivalue, short temp)
|
||||
{
|
||||
if (Tcl_GetInt(interp,$source,&ivalue) == TCL_ERROR) {
|
||||
return TCL_ERROR;
|
||||
}
|
||||
temp = (short) ivalue;
|
||||
$target = &temp;
|
||||
}
|
||||
|
||||
%typemap(tcl,in) long *INPUT(int ivalue, long temp)
|
||||
{
|
||||
if (Tcl_GetInt(interp,$source,&ivalue) == TCL_ERROR) {
|
||||
return TCL_ERROR;
|
||||
}
|
||||
temp = (long) ivalue;
|
||||
$target = &temp;
|
||||
}
|
||||
|
||||
%typemap(tcl,in) unsigned int *INPUT(int ivalue, unsigned int temp)
|
||||
{
|
||||
if (Tcl_GetInt(interp,$source,&ivalue) == TCL_ERROR) {
|
||||
return TCL_ERROR;
|
||||
}
|
||||
temp = (unsigned int) ivalue;
|
||||
$target = &temp;
|
||||
}
|
||||
|
||||
%typemap(tcl,in) unsigned short *INPUT(int ivalue, unsigned short temp)
|
||||
{
|
||||
if (Tcl_GetInt(interp,$source,&ivalue) == TCL_ERROR) {
|
||||
return TCL_ERROR;
|
||||
}
|
||||
temp = (unsigned short) ivalue;
|
||||
$target = &temp;
|
||||
}
|
||||
|
||||
%typemap(tcl,in) unsigned long *INPUT(int ivalue, unsigned long temp)
|
||||
{
|
||||
if (Tcl_GetInt(interp,$source,&ivalue) == TCL_ERROR) {
|
||||
return TCL_ERROR;
|
||||
}
|
||||
temp = (unsigned long) ivalue;
|
||||
$target = &temp;
|
||||
}
|
||||
|
||||
%typemap(tcl,in) unsigned char *INPUT(int ivalue, unsigned char temp)
|
||||
{
|
||||
if (Tcl_GetInt(interp,$source,&ivalue) == TCL_ERROR) {
|
||||
return TCL_ERROR;
|
||||
}
|
||||
temp = (unsigned char) ivalue;
|
||||
$target = &temp;
|
||||
}
|
||||
|
||||
|
||||
|
||||
// OUTPUT typemaps. These typemaps are used for parameters that
|
||||
// are output only. The output value is appended to the result as
|
||||
// a list element.
|
||||
|
||||
|
||||
#ifdef AUTODOC
|
||||
%subsection "Output Methods"
|
||||
|
||||
%text %{
|
||||
The following methods can be applied to turn a pointer into an "output"
|
||||
value. When calling a function, no input value would be given for
|
||||
a parameter, but an output value would be returned. In the case of
|
||||
multiple output values, they are returned in the form of a Tcl list.
|
||||
|
||||
int *OUTPUT
|
||||
short *OUTPUT
|
||||
long *OUTPUT
|
||||
unsigned int *OUTPUT
|
||||
unsigned short *OUTPUT
|
||||
unsigned long *OUTPUT
|
||||
unsigned char *OUTPUT
|
||||
float *OUTPUT
|
||||
double *OUTPUT
|
||||
|
||||
For example, suppose you were trying to wrap the modf() function in the
|
||||
C math library which splits x into integral and fractional parts (and
|
||||
returns the integer part in one of its parameters).K:
|
||||
|
||||
double modf(double x, double *ip);
|
||||
|
||||
You could wrap it with SWIG as follows :
|
||||
|
||||
%include typemaps.i
|
||||
double modf(double x, double *OUTPUT);
|
||||
|
||||
or you can use the %apply directive :
|
||||
|
||||
%include typemaps.i
|
||||
%apply double *OUTPUT { double *ip };
|
||||
double modf(double x, double *ip);
|
||||
|
||||
The Tcl output of the function would be a list containing both
|
||||
output values.
|
||||
|
||||
%}
|
||||
|
||||
#endif
|
||||
|
||||
// Force the argument to be ignored.
|
||||
|
||||
%typemap(tcl,ignore) int *OUTPUT(int temp),
|
||||
short *OUTPUT(short temp),
|
||||
long *OUTPUT(long temp),
|
||||
unsigned int *OUTPUT(unsigned int temp),
|
||||
unsigned short *OUTPUT(unsigned short temp),
|
||||
unsigned long *OUTPUT(unsigned long temp),
|
||||
unsigned char *OUTPUT(unsigned char temp),
|
||||
float *OUTPUT(float temp),
|
||||
double *OUTPUT(double temp)
|
||||
{
|
||||
$target = &temp;
|
||||
}
|
||||
|
||||
%typemap(tcl,argout) int *OUTPUT,
|
||||
short *OUTPUT,
|
||||
long *OUTPUT
|
||||
{
|
||||
char dtemp[64];
|
||||
sprintf(dtemp,"%ld",(long) *($source));
|
||||
Tcl_AppendElement(interp,dtemp);
|
||||
}
|
||||
|
||||
%typemap(tcl,argout) unsigned int *OUTPUT,
|
||||
unsigned short *OUTPUT,
|
||||
unsigned long *OUTPUT,
|
||||
unsigned char *OUTPUT
|
||||
{
|
||||
char dtemp[64];
|
||||
sprintf(dtemp,"%lu", (unsigned long) *($source));
|
||||
Tcl_AppendElement(interp,dtemp);
|
||||
}
|
||||
|
||||
%typemap(tcl,argout) float *OUTPUT,
|
||||
double *OUTPUT
|
||||
{
|
||||
char dtemp[TCL_DOUBLE_SPACE];
|
||||
Tcl_PrintDouble(interp, (double) *($source), dtemp);
|
||||
Tcl_AppendElement(interp,dtemp);
|
||||
}
|
||||
|
||||
// BOTH
|
||||
// Mappings for an argument that is both an input and output
|
||||
// parameter
|
||||
|
||||
#ifdef AUTODOC
|
||||
%subsection "Input/Output Methods"
|
||||
|
||||
%text %{
|
||||
The following methods can be applied to make a function parameter both
|
||||
an input and output value. This combines the behavior of both the
|
||||
"INPUT" and "OUTPUT" methods described earlier. Output values are
|
||||
returned in the form of a Tcl list.
|
||||
|
||||
int *BOTH
|
||||
short *BOTH
|
||||
long *BOTH
|
||||
unsigned int *BOTH
|
||||
unsigned short *BOTH
|
||||
unsigned long *BOTH
|
||||
unsigned char *BOTH
|
||||
float *BOTH
|
||||
double *BOTH
|
||||
|
||||
For example, suppose you were trying to wrap the following function :
|
||||
|
||||
void neg(double *x) {
|
||||
*x = -(*x);
|
||||
}
|
||||
|
||||
You could wrap it with SWIG as follows :
|
||||
|
||||
%include typemaps.i
|
||||
void neg(double *BOTH);
|
||||
|
||||
or you can use the %apply directive :
|
||||
|
||||
%include typemaps.i
|
||||
%apply double *BOTH { double *x };
|
||||
void neg(double *x);
|
||||
|
||||
Unlike C, this mapping does not directly modify the input value (since
|
||||
this makes no sense in Tcl). Rather, the modified input value shows
|
||||
up as the return value of the function. Thus, to apply this function
|
||||
to a Tcl variable you might do this :
|
||||
|
||||
set x [neg $x]
|
||||
|
||||
%}
|
||||
|
||||
#endif
|
||||
|
||||
%typemap(tcl,in) int *BOTH = int *INPUT;
|
||||
%typemap(tcl,in) short *BOTH = short *INPUT;
|
||||
%typemap(tcl,in) long *BOTH = long *INPUT;
|
||||
%typemap(tcl,in) unsigned int *BOTH = unsigned int *INPUT;
|
||||
%typemap(tcl,in) unsigned short *BOTH = unsigned short *INPUT;
|
||||
%typemap(tcl,in) unsigned long *BOTH = unsigned long *INPUT;
|
||||
%typemap(tcl,in) unsigned char *BOTH = unsigned char *INPUT;
|
||||
%typemap(tcl,in) float *BOTH = float *INPUT;
|
||||
%typemap(tcl,in) double *BOTH = double *INPUT;
|
||||
|
||||
%typemap(tcl,argout) int *BOTH = int *OUTPUT;
|
||||
%typemap(tcl,argout) short *BOTH = short *OUTPUT;
|
||||
%typemap(tcl,argout) long *BOTH = long *OUTPUT;
|
||||
%typemap(tcl,argout) unsigned int *BOTH = unsigned int *OUTPUT;
|
||||
%typemap(tcl,argout) unsigned short *BOTH = unsigned short *OUTPUT;
|
||||
%typemap(tcl,argout) unsigned long *BOTH = unsigned long *OUTPUT;
|
||||
%typemap(tcl,argout) unsigned char *BOTH = unsigned char *OUTPUT;
|
||||
%typemap(tcl,argout) float *BOTH = float *OUTPUT;
|
||||
%typemap(tcl,argout) double *BOTH = double *OUTPUT;
|
||||
|
||||
// --------------------------------------------------------------------
|
||||
// Special types
|
||||
//
|
||||
// --------------------------------------------------------------------
|
||||
|
||||
// If interp * appears as a function argument, we ignore it and get
|
||||
// it from the wrapper function.
|
||||
|
||||
#ifdef AUTODOC
|
||||
%subsection "Special Methods"
|
||||
|
||||
%text %{
|
||||
The typemaps.i library also provides the following mappings :
|
||||
|
||||
Tcl_Interp *interp
|
||||
|
||||
Passes the current Tcl_Interp value directly to a C function.
|
||||
This can be used to work with existing wrapper functions or
|
||||
if you just need the interp value for some reason. When used,
|
||||
the 'interp' parameter becomes hidden in the Tcl interface--that
|
||||
is, you don't specify it explicitly. SWIG fills in its value
|
||||
automatically.
|
||||
|
||||
int Tcl_Result
|
||||
|
||||
Makes the integer return code of a function the return value
|
||||
of a SWIG generated wrapper function. For example :
|
||||
|
||||
int foo() {
|
||||
... do stuff ...
|
||||
return TCL_OK;
|
||||
}
|
||||
|
||||
could be wrapped as follows :
|
||||
|
||||
%include typemaps.i
|
||||
%apply int Tcl_Result { int foo };
|
||||
int foo();
|
||||
|
||||
%}
|
||||
|
||||
#endif
|
||||
|
||||
%typemap(tcl,ignore) Tcl_Interp *interp {
|
||||
$target = interp;
|
||||
}
|
||||
|
||||
// If return code is a Tcl_Result, simply pass it on
|
||||
|
||||
%typemap(tcl,out) int Tcl_Result {
|
||||
interp->result = "";
|
||||
return $source;
|
||||
}
|
||||
|
||||
/***************************************************************************
|
||||
* Tcl 8.0 typemaps
|
||||
***************************************************************************/
|
||||
|
||||
// ------------------------------------------------------------------------
|
||||
// Pointer handling
|
||||
//
|
||||
// These mappings provide support for input/output arguments and common
|
||||
// uses for C/C++ pointers.
|
||||
// ------------------------------------------------------------------------
|
||||
|
||||
// INPUT typemaps.
|
||||
// These remap a C pointer to be an "INPUT" value which is passed by value
|
||||
// instead of reference.
|
||||
|
||||
%typemap(tcl8,in) double *INPUT(double temp)
|
||||
{
|
||||
if (Tcl_GetDoubleFromObj(interp,$source,&temp) == TCL_ERROR) {
|
||||
|
|
@ -463,12 +150,54 @@ int Tcl_Result
|
|||
$target = &temp;
|
||||
}
|
||||
|
||||
|
||||
// OUTPUT typemaps. These typemaps are used for parameters that
|
||||
// are output only. The output value is appended to the result as
|
||||
// a list element.
|
||||
|
||||
// Force the argument to be ignored.
|
||||
|
||||
#ifdef AUTODOC
|
||||
%subsection "Output Methods"
|
||||
|
||||
%text %{
|
||||
The following methods can be applied to turn a pointer into an "output"
|
||||
value. When calling a function, no input value would be given for
|
||||
a parameter, but an output value would be returned. In the case of
|
||||
multiple output values, they are returned in the form of a Tcl list.
|
||||
|
||||
int *OUTPUT
|
||||
short *OUTPUT
|
||||
long *OUTPUT
|
||||
unsigned int *OUTPUT
|
||||
unsigned short *OUTPUT
|
||||
unsigned long *OUTPUT
|
||||
unsigned char *OUTPUT
|
||||
float *OUTPUT
|
||||
double *OUTPUT
|
||||
|
||||
For example, suppose you were trying to wrap the modf() function in the
|
||||
C math library which splits x into integral and fractional parts (and
|
||||
returns the integer part in one of its parameters).K:
|
||||
|
||||
double modf(double x, double *ip);
|
||||
|
||||
You could wrap it with SWIG as follows :
|
||||
|
||||
%include typemaps.i
|
||||
double modf(double x, double *OUTPUT);
|
||||
|
||||
or you can use the %apply directive :
|
||||
|
||||
%include typemaps.i
|
||||
%apply double *OUTPUT { double *ip };
|
||||
double modf(double x, double *ip);
|
||||
|
||||
The Tcl output of the function would be a list containing both
|
||||
output values.
|
||||
|
||||
%}
|
||||
|
||||
#endif
|
||||
|
||||
|
||||
%typemap(tcl8,ignore) int *OUTPUT(int temp),
|
||||
short *OUTPUT(short temp),
|
||||
|
|
@ -508,6 +237,54 @@ int Tcl_Result
|
|||
// Mappings for an argument that is both an input and output
|
||||
// parameter
|
||||
|
||||
#ifdef AUTODOC
|
||||
%subsection "Input/Output Methods"
|
||||
|
||||
%text %{
|
||||
The following methods can be applied to make a function parameter both
|
||||
an input and output value. This combines the behavior of both the
|
||||
"INPUT" and "OUTPUT" methods described earlier. Output values are
|
||||
returned in the form of a Tcl list.
|
||||
|
||||
int *BOTH
|
||||
short *BOTH
|
||||
long *BOTH
|
||||
unsigned int *BOTH
|
||||
unsigned short *BOTH
|
||||
unsigned long *BOTH
|
||||
unsigned char *BOTH
|
||||
float *BOTH
|
||||
double *BOTH
|
||||
|
||||
For example, suppose you were trying to wrap the following function :
|
||||
|
||||
void neg(double *x) {
|
||||
*x = -(*x);
|
||||
}
|
||||
|
||||
You could wrap it with SWIG as follows :
|
||||
|
||||
%include typemaps.i
|
||||
void neg(double *BOTH);
|
||||
|
||||
or you can use the %apply directive :
|
||||
|
||||
%include typemaps.i
|
||||
%apply double *BOTH { double *x };
|
||||
void neg(double *x);
|
||||
|
||||
Unlike C, this mapping does not directly modify the input value (since
|
||||
this makes no sense in Tcl). Rather, the modified input value shows
|
||||
up as the return value of the function. Thus, to apply this function
|
||||
to a Tcl variable you might do this :
|
||||
|
||||
set x [neg $x]
|
||||
|
||||
%}
|
||||
|
||||
#endif
|
||||
|
||||
|
||||
%typemap(tcl8,in) int *BOTH = int *INPUT;
|
||||
%typemap(tcl8,in) short *BOTH = short *INPUT;
|
||||
%typemap(tcl8,in) long *BOTH = long *INPUT;
|
||||
|
|
@ -530,12 +307,46 @@ int Tcl_Result
|
|||
|
||||
// --------------------------------------------------------------------
|
||||
// Special types
|
||||
//
|
||||
// --------------------------------------------------------------------
|
||||
|
||||
// If interp * appears as a function argument, we ignore it and get
|
||||
// it from the wrapper function.
|
||||
|
||||
#ifdef AUTODOC
|
||||
%subsection "Special Methods"
|
||||
|
||||
%text %{
|
||||
The typemaps.i library also provides the following mappings :
|
||||
|
||||
Tcl_Interp *interp
|
||||
|
||||
Passes the current Tcl_Interp value directly to a C function.
|
||||
This can be used to work with existing wrapper functions or
|
||||
if you just need the interp value for some reason. When used,
|
||||
the 'interp' parameter becomes hidden in the Tcl interface--that
|
||||
is, you don't specify it explicitly. SWIG fills in its value
|
||||
automatically.
|
||||
|
||||
int Tcl_Result
|
||||
|
||||
Makes the integer return code of a function the return value
|
||||
of a SWIG generated wrapper function. For example :
|
||||
|
||||
int foo() {
|
||||
... do stuff ...
|
||||
return TCL_OK;
|
||||
}
|
||||
|
||||
could be wrapped as follows :
|
||||
|
||||
%include typemaps.i
|
||||
%apply int Tcl_Result { int foo };
|
||||
int foo();
|
||||
|
||||
%}
|
||||
|
||||
#endif
|
||||
|
||||
%typemap(tcl8,ignore) Tcl_Interp *interp {
|
||||
$target = interp;
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue