/****************************************************************************** * $Id: typemaps_ruby.i 9021 2006-01-17 04:41:26Z cfis $ * * Name:     typemaps_ruby.i * Project:  GDAL Ruby Interface * Purpose:  GDAL Core SWIG Interface declarations. * Author:   Charles F. I. Savage * * * $Log$ * Revision 1.9  2006/01/17 04:41:26  cfis * Removed dependency on renames.i - instead use new swig -autorename directive.  Also fix a memory issue with hex_to_binary. * * Revision 1.8  2006/01/16 08:06:23  cfis * Added typemaps to support CPLHexToBinary and CPLHexToBinary * * Revision 1.7  2006/01/14 21:45:26  cfis * Updated type maps that fix issue with returning an array of results. * * Revision 1.6  2006/01/14 19:55:47  cfis * Fixed an error in accessing items in a pointer to an array of doubles. * * Revision 1.5  2006/01/14 02:34:05  cfis * Updated typemaps that compile with SWIG 1.3.28 head. * * Revision 1.4  2005/10/11 14:11:43  kruland * Fix memory bug in typemap(out) char **options.  The returned array of strings * is owned by the dataset. * * Revision 1.3  2005/10/02 19:03:45  cfis * Changed $source (which is deprecated) to $1 in "out" and "ret" typemaps. * * Revision 1.2  2005/10/01 08:09:21  cfis * Added additional gdal typemaps.  Also removed CPLErr 'ret' typemaps since they are not necessary since the Ruby bindings always raises exceptions on errors. * * Revision 1.1  2005/09/26 08:20:19  cfis * Significantly updated typemaps for Ruby - resynced with the Python typemaps file. * * Revision 1.5  2005/09/02 16:19:23  kruland * Major reorganization to accomodate multiple language bindings. * Each language binding can define renames and supplemental code without * having to have a lot of conditionals in the main interface definition files. * * Revision 1.4  2005/08/25 21:00:55  cfis * Added note saying that SWIG 1.3.26 or higher is required because the bindings need the SWIGTYPE *DISOWN  typemap. * * Revision 1.3  2005/08/21 23:52:08  cfis * The Layer each method was not correctly setting the owernship flag for returned objects.  This has now been fixed and commented. * * Revision 1.2  2005/08/20 20:50:13  cfis * Added GetLayer method that maps to either GetLayerByName or GetLayerByIndex.  Also commented out Open and OpenShared as DataSouce class static methods. * * Revision 1.1  2005/08/09 17:40:09  kruland * Added support for ruby. * *//* !NOTE! - The Ruby bindings require SWIG-1.3.26 or above.  Earlier versions   do not work because they did not include support for the WWIGTYPE *DISOWN	typemap which is crucial for supporting the AddGeometryDirectly and 	SetGeometryDirectly methods.	These typemaps  were ported from typemaps_python.i.  For more information	please refer to that file and to the README.typemaps file */%include typemaps.i%include ogr_error_map.i%apply (double *OUTPUT) { double *argout };/* * double *val, int *hasval, is a special contrived typemap used for * the RasterBand GetNoDataValue, GetMinimum, GetMaximum, GetOffset, GetScale methods. * In the Ruby bindings, the variable hasval is tested.  If it is 0 (is, the value * is not set in the raster band) then Py_None is returned.  If is is != 0, then * the value is coerced into a long and returned. */%typemap(in,numinputs=0) (double *val, int *hasval) (double tmpval, int tmphasval) {  /* %typemap(in,numinputs=0) (double *val, int*hasval) */  $1 = &tmpval;  $2 = &tmphasval;}%typemap(argout) (double *val, int *hasval) {  /* %typemap(argout) (double *val, int *hasval) */	VALUE argOut;	  if ( !*$2 ) {    argOut = Qnil;  }  else {    argOut = rb_float_new(*$1);  }    $result = SWIG_AppendOutput($result, argOut);}/* Define a simple return code typemap which checks if the return code from * the wrapped method is non-zero. If non-zero, return None.  Otherwise, * return any argout or None. * * Applied like this: * %apply (IF_ERR_RETURN_NONE) {CPLErr}; * CPLErr function_to_wrap( ); * %clear (CPLErr); */%typemap(out) IF_ERR_RETURN_NONE{  /* %typemap(out) IF_ERR_RETURN_NONE */  /* result = Qnil; */}%typemap(out) IF_FALSE_RETURN_NONE{  /* %typemap(out) IF_FALSE_RETURN_NONE */  if ($1 == 0 ) {    $result = Qnil;  }}/* --------  OGR Error Handling --------------- */%typemap(out) OGRErr{  /* %typemap(out) OGRErr */  if ($1 != 0) {    rb_raise(rb_eRuntimeError, OGRErrMessages(result));  }}%typemap(ret) OGRErr{  /* %typemap(ret) OGRErr */  if (vresult == Qnil) {    vresult = INT2NUM(0);  }}/* -------------  Array  <-> Fixed Length Double Array  ----------------------*/%typemap(in) (double argin[ANY]) (double temp[$dim0]){  /* %typemap(in) (double argin[ANY]) (double temp[$dim0]) */  /* Make sure this is an array. */  Check_Type($input, T_ARRAY);  /* Get the length */  int seq_size = RARRAY($input)->len;    if ( seq_size != $dim0 ) {    rb_raise(rb_eRangeError, "sequence must have length %i.", seq_size);  }  for( int i = 0; i<$dim0; i++ ) {    /* Get the Ruby Object */    VALUE item = rb_ary_entry($input,i);        /* Convert to double and store in array*/    temp[i] = NUM2DBL(item);  }    /* Set argument $1 equal to the temp array */	$1 = temp;}%typemap(in,numinputs=0) (double argout[ANY]) (double argout[$dim0]){  /* %typemap(in,numinputs=0) (double argout[ANY]) */  $1 = argout;}%typemap(argout) (double argout[ANY]){  /* %typemap(argout) (double argout[ANY]) */  VALUE outArr = rb_ary_new();  for(int i=0; i<$dim0; i++)  {    VALUE value = rb_float_new(($1)[i]);    rb_ary_push(outArr, value);  }    /* Add the output to the result */  $result = SWIG_AppendOutput($result, outArr);	}%typemap(in,numinputs=0) (double *argout[ANY]) (double *argout){  /* %typemap(in,numinputs=0) (double *argout[ANY]) */  $1 = &argout;}%typemap(argout) (double *argout[ANY]){  /* %typemap(argout) (double argout[ANY]) */  VALUE outArr = rb_ary_new();  for(int i=0; i<$dim0; i++)  {    /* $1 is a pointer to an array, so first dereference the array,       then specify the index. */    VALUE value = rb_float_new((*$1)[i]);    rb_ary_push(outArr, value);  }    /* Add the output to the result */  $result = SWIG_AppendOutput($result, outArr);	}%typemap(freearg) (double *argout[ANY]){  /* %typemap(freearg) (double *argout[ANY]) */  CPLFree(*$1);}/* -------------  Ruby Array  <-> integer Array  ----------------------*/%typemap(in,numinputs=1) (int nList, int* pList){  /* %typemap(in,numinputs=1) (int nList, int* pList) */  /* Make sure this is an array. */  Check_Type($input, T_ARRAY);  /* Get the length */  $1 = RARRAY($input)->len;    /* Allocate space for the C array. */  $2 = (int*) malloc($1*sizeof(int));    for( int i = 0; i<$1; i++ ) {    /* Get the Ruby Object */    VALUE item = rb_ary_entry($input,i);    /* Conver to an integer */    $2[i] = NUM2INT(item);  }}%typemap(freearg) (int nList, int* pList){  /* %typemap(freearg) (int nList, int* pList) */  if ($2) {    free((void*) $2);  }}/* -------------  Ruby String  <-> char ** with lengths ----------------------*/%typemap(in,numinputs=0) (int *nLen, char **pBuf ) ( int nLen = 0, char *pBuf = 0 ){  /* %typemap(in,numinputs=0) (int *nLen, char **pBuf ) ( int nLen = 0, char *pBuf = 0 ) */  $1 = &nLen;  $2 = &pBuf;}%typemap(argout) (int *nLen, char **pBuf ){  /* %typemap(argout) (int *nLen, char **pBuf ) */  $result = rb_str_new(*$2, *$1);}%typemap(freearg) (int *nLen, char **pBuf ){  /* %typemap(freearg) (int *nLen, char **pBuf ) */  if( *$2 ) {    free( *$2 );  }}/* -------------  Ruby String  <-> char *  ----------------------*/%typemap(in) (int nLen, char *pBuf ) = (int LENGTH, char *STRING);%typemap(typecheck,precedence=SWIG_TYPECHECK_POINTER)        (int nLen, char *pBuf){  /* %typecheck(ruby,typecheck,precedence=SWIG_TYPECHECK_POINTER) (int nLen, char *pBuf) */  $1 = (TYPE($input) == T_STRING) ? 1: 0;}/*  ---------    GDAL_GCP used in Dataset::GetGCPs( ) ----------- */%typemap(in,numinputs=0) (int *nGCPs, GDAL_GCP const **pGCPs ) (int nGCPs=0, GDAL_GCP *pGCPs=0 ){  /* %typemap( in,numinputs=0) (int *nGCPs, GDAL_GCP const **pGCPs ) */  $1 = &nGCPs;  $2 = &pGCPs;}%typemap(argout) (int *nGCPs, GDAL_GCP const **pGCPs ){  /* %typemap( argout) (int *nGCPs, GDAL_GCP const **pGCPs ) *//*  $result = rb_ary_new2(*$1);  for( int i = 0; i < *$1; i++ ) {    GDAL_GCP *o = new_GDAL_GCP( (*$2)[i].dfGCPX,                                (*$2)[i].dfGCPY,                                (*$2)[i].dfGCPZ,                                (*$2)[i].dfGCPPixel,                                (*$2)[i].dfGCPLine,                                (*$2)[i].pszInfo,                                (*$2)[i].pszId );		 rb_ary_store($result, i, 					  SWIG_NewPointerObj((void*)o, SWIGTYPE_p_GDAL_GCP,1));  }*/}%typemap(in,numinputs=1) (int nGCPs, GDAL_GCP const *pGCPs ) ( GDAL_GCP *tmpGCPList ){  /* %typemap( in,numinputs=1) (int nGCPs, GDAL_GCP const *pGCPs ) */  /* Check if is a list */  Check_Type($input, T_ARRAY);  $1 = RARRAY($input)->len;  tmpGCPList = (GDAL_GCP*) malloc($1*sizeof(GDAL_GCP));  $2 = tmpGCPList;  for( int i = 0; i<$1; i++ ) {    VALUE rubyItem = rb_ary_entry($input,i);    GDAL_GCP *item = 0;    SWIG_ConvertPtr( rubyItem, (void**)&item, SWIGTYPE_p_GDAL_GCP, SWIG_POINTER_EXCEPTION | 0 );	 if (!item) {		 rb_raise(rb_eRuntimeError, "GDAL_GCP item cannot be nil");	 }    memcpy( (void*) item, (void*) tmpGCPList, sizeof( GDAL_GCP ) );    ++tmpGCPList;  }}%typemap(freearg) (int nGCPs, GDAL_GCP const *pGCPs ){  /* %typemap( freearg) (int nGCPs, GDAL_GCP const *pGCPs ) */  if ($2) {    free( (void*) $2 );  }}/* ----------- Typemap for GDALColorEntry* <-> tuple -------------- *//*%typemap(out) GDALColorEntry*{*/  /* %typemap( out) GDALColorEntry* */ /* $result = Py_BuildValue( "(hhhh)", (*$1).c1,(*$1).c2,(*$1).c3,(*$1).c4);}%typemap(in) GDALColorEntry* (GDALColorEntry ce){*/  /* %typemap(in) GDALColorEntry* *//*   ce.c4 = 255;   int size = PySequence_Size($input);   if ( size > 4 ) {     PyErr_SetString(PyExc_TypeError, "ColorEntry sequence too long");     SWIG_fail;   }   if ( size < 3 ) {     PyErr_SetString(PyExc_TypeError, "ColorEntry sequence too short");     SWIG_fail;   }   PyArg_ParseTuple( $input,"hhh|h", &ce.c1, &ce.c2, &ce.c3, &ce.c4 );   $1 = &ce;}*/