summaryrefslogtreecommitdiff
path: root/Lib/objc/typemaps.i
blob: 3a261d7745615c21af7028adec2959b909502255 (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
/* -----------------------------------------------------------------------------
 * typemaps.i
 *
 * Pointer and reference handling typemap library
 *
 * These mappings provide support for input/output arguments and common
 * uses for C/C++ pointers and C++ references.
 * ----------------------------------------------------------------------------- */

/*
INPUT typemaps
--------------

These typemaps remap a C pointer or C++ reference to be an "INPUT" value which is
passed by value instead of reference.

The following typemaps can be applied to turn a pointer or reference into a simple
input value.  That is, instead of passing a pointer or reference to an object,
you would use a real value instead.

        bool               *INPUT, bool               &INPUT
        signed char        *INPUT, signed char        &INPUT
        unsigned char      *INPUT, unsigned char      &INPUT
        short              *INPUT, short              &INPUT
        unsigned short     *INPUT, unsigned short     &INPUT
        int                *INPUT, int                &INPUT
        unsigned int       *INPUT, unsigned int       &INPUT
        long               *INPUT, long               &INPUT
        unsigned long      *INPUT, unsigned long      &INPUT
        long long          *INPUT, long long          &INPUT
        unsigned long long *INPUT, unsigned long long &INPUT
        float              *INPUT, float              &INPUT
        double             *INPUT, double             &INPUT
         
To use these, suppose you had a C function like this :

        double fadd(double *a, double *b) {
               return *a+*b;
        }

You could wrap it with SWIG as follows :
        
        %include <typemaps.i>
        double fadd(double *INPUT, double *INPUT);

or you can use the %apply directive :

        %include <typemaps.i>
        %apply double *INPUT { double *a, double *b };
        double fadd(double *a, double *b);

In ObjectiveC you could then use it like this:
        answer = fadd(10.0, 20.0)
*/

%define INPUT_TYPEMAP(TYPE, IMTYPE, OBJCTYPE)
%typemap(imtype) TYPE *INPUT, TYPE &INPUT "IMTYPE"
%typemap(objctype) TYPE *INPUT, TYPE &INPUT "OBJCTYPE"
%typemap(objcin) TYPE *INPUT, TYPE &INPUT "$objcinput"

%typemap(in) TYPE *INPUT,TYPE &INPUT
%{ $1 = ($1_ltype)&$input; %}

%typemap(out) TYPE *INPUT, TYPE &INPUT ""

%enddef

INPUT_TYPEMAP(bool,                 BOOL,                   BOOL);
INPUT_TYPEMAP(signed char,          signed char,            signed char);
INPUT_TYPEMAP(char,                 char,                   char);
INPUT_TYPEMAP(unsigned char,        unsigned char,          unsigned char);
INPUT_TYPEMAP(short,                short,                  short);
INPUT_TYPEMAP(unsigned short,       unsigned short,         unsigned short);
INPUT_TYPEMAP(int,                  int,                    int);
INPUT_TYPEMAP(unsigned int,         unsigned int,           unsigned int);
INPUT_TYPEMAP(long,                 long,                   long);
INPUT_TYPEMAP(unsigned long,        unsigned long,          unsigned long);
INPUT_TYPEMAP(long long,            long long,              long long);
INPUT_TYPEMAP(unsigned long long,   unsigned long long,     unsigned long long);
INPUT_TYPEMAP(float,                float,                  float);
INPUT_TYPEMAP(double,               double,                 double);

/* Override typemaps in the INPUT_TYPEMAP macro for bool represented as BOOL in ObjectiveC */
%typemap(in) bool *INPUT (bool temp), bool &INPUT (bool temp) %{
  temp = ($input) ? true : false;
  $1 = &temp;
%}

#undef INPUT_TYPEMAP

/*
OUTPUT typemaps
---------------

These typemaps are used for parameters that are output only and are mapped to an 
ObjectiveC output parameter.  

The following typemaps can be applied to turn a pointer or reference
into an "output" value.  When calling a function, no input value would be given for
a parameter, but an output value would be returned. 

        bool               *OUTPUT, bool               &OUTPUT
        signed char        *OUTPUT, signed char        &OUTPUT
        unsigned char      *OUTPUT, unsigned char      &OUTPUT
        short              *OUTPUT, short              &OUTPUT
        unsigned short     *OUTPUT, unsigned short     &OUTPUT
        int                *OUTPUT, int                &OUTPUT
        unsigned int       *OUTPUT, unsigned int       &OUTPUT
        long               *OUTPUT, long               &OUTPUT
        unsigned long      *OUTPUT, unsigned long      &OUTPUT
        long long          *OUTPUT, long long          &OUTPUT
        unsigned long long *OUTPUT, unsigned long long &OUTPUT
        float              *OUTPUT, float              &OUTPUT
        double             *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):

        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 ObjectiveC output of the function would be the function return value and the 
value returned in the second output parameter. In ObjectiveC you would use it like this:

    double *dptr;
    double fraction = modf(5, dptr);
*/

%define OUTPUT_TYPEMAP(TYPE, IMTYPE, OBJCTYPE)
%typemap(imtype) TYPE *OUTPUT, TYPE &OUTPUT "IMTYPE*"
%typemap(objctype) TYPE *OUTPUT, TYPE &OUTPUT "OBJCTYPE*"
%typemap(objcin) TYPE *OUTPUT, TYPE &OUTPUT "$objcinput"

%typemap(in) TYPE *OUTPUT, TYPE &OUTPUT
%{ $1 = ($1_ltype)$input; %}

%enddef

OUTPUT_TYPEMAP(bool,               BOOL,                   BOOL);
OUTPUT_TYPEMAP(signed char,          signed char,            signed char);
OUTPUT_TYPEMAP(char,                 char,                   char);
OUTPUT_TYPEMAP(unsigned char,        unsigned char,          unsigned char);
OUTPUT_TYPEMAP(short,                short,                  short);
OUTPUT_TYPEMAP(unsigned short,       unsigned short,         unsigned short);
OUTPUT_TYPEMAP(int,                  int,                    int);
OUTPUT_TYPEMAP(unsigned int,         unsigned int,           unsigned int);
OUTPUT_TYPEMAP(long,                 long,                   long);
OUTPUT_TYPEMAP(unsigned long,        unsigned long,          unsigned long);
OUTPUT_TYPEMAP(long long,            long long,              long long);
OUTPUT_TYPEMAP(unsigned long long,   unsigned long long,     unsigned long long);
OUTPUT_TYPEMAP(float,                float,                  float);
OUTPUT_TYPEMAP(double,               double,                 double);

#undef OUTPUT_TYPEMAP

/*
 INOUT typemaps
 --------------
 
 These typemaps are for pointer/reference parameters that are both input and
 output and are mapped to a C# reference parameter.
 
 The following typemaps can be applied to turn a pointer or reference into a
 reference parameters, that is the parameter is both an input and an output.
 In C#, the 'ref' keyword is used for reference parameters.
 
 bool               *INOUT, bool               &INOUT
 signed char        *INOUT, signed char        &INOUT
 unsigned char      *INOUT, unsigned char      &INOUT
 short              *INOUT, short              &INOUT
 unsigned short     *INOUT, unsigned short     &INOUT
 int                *INOUT, int                &INOUT
 unsigned int       *INOUT, unsigned int       &INOUT
 long               *INOUT, long               &INOUT
 unsigned long      *INOUT, unsigned long      &INOUT
 long long          *INOUT, long long          &INOUT
 unsigned long long *INOUT, unsigned long long &INOUT
 float              *INOUT, float              &INOUT
 double             *INOUT, double             &INOUT
 
 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 *INOUT);
 
 or you can use the %apply directive :
 
 %include <typemaps.i>
 %apply double *INOUT { double *x };
 void neg(double *x);
 
 The C# output of the function would be the new value returned by the 
 reference parameter. In C# you would use it like this:
 
 
 double x = 5.0;
 neg(ref x);
 
 The implementation of the OUTPUT and INOUT typemaps is different to the scripting
 languages in that the scripting languages will return the output value as part 
 of the function return value.
 
 */

%define INOUT_TYPEMAP(TYPE, IMTYPE, OBJCTYPE)
%typemap(imtype) TYPE *INOUT, TYPE &INOUT "IMTYPE *"
%typemap(objctype) TYPE *INOUT, TYPE &INOUT "OBJCTYPE *"
%typemap(objcin) TYPE *INOUT, TYPE &INOUT "$objcinput"

%typemap(in) TYPE *INOUT {
  $1 = ($1_ltype) $input;
}

%typemap(in) TYPE &INOUT {
  $1 = ($1_ltype) $input;
}

%enddef

INOUT_TYPEMAP(bool,               BOOL,                   BOOL);
INOUT_TYPEMAP(signed char,          signed char,            signed char);
INOUT_TYPEMAP(char,                 char,                   char);
INOUT_TYPEMAP(unsigned char,        unsigned char,          unsigned char);
INOUT_TYPEMAP(short,                short,                  short);
INOUT_TYPEMAP(unsigned short,       unsigned short,         unsigned short);
INOUT_TYPEMAP(int,                  int,                    int);
INOUT_TYPEMAP(unsigned int,         unsigned int,           unsigned int);
INOUT_TYPEMAP(long,                 long,                   long);
INOUT_TYPEMAP(unsigned long,        unsigned long,          unsigned long);
INOUT_TYPEMAP(long long,            long long,              long long);
INOUT_TYPEMAP(unsigned long long,   unsigned long long,     unsigned long long);
INOUT_TYPEMAP(float,                float,                  float);
INOUT_TYPEMAP(double,               double,                 double);

/* Override typemaps in the INOUT_TYPEMAP macro for bool represented as BOOL in ObjectiveC */
%typemap(in) bool *INOUT (bool temp), bool &INOUT (bool temp) {
  temp = ($input) ? true : false;
  $1 = &temp;
}

#undef INOUT_TYPEMAP