summaryrefslogtreecommitdiff
path: root/trunk/Lib/typemaps/traits.swg
blob: b39eb3946e146efe40ab8bc2387d91fdd3b5cb05 (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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
//
// Use the following macro with modern STL implementations
//
//#define SWIG_STD_MODERN_STL
//
// Use this to deactive the previous definition, when using gcc-2.95
// or similar old compilers.
//
//#define SWIG_STD_NOMODERN_STL

// Here, we identify compilers we now have problems with STL.
%{
#if defined(__GNUC__)
#  if __GNUC__ == 2 && __GNUC_MINOR <= 96
#     define SWIG_STD_NOMODERN_STL
#  endif
#endif
%}

//
// Common code for supporting the STD C++ namespace
//

%{
#include <string>
#include <stdexcept>
%}

%fragment("Traits","header") 
{
namespace swig {  
  /*
    type categories
  */
  struct pointer_category { };  
  struct value_category { };

  /*
    General traits that provides type_name and type_info
  */
  template <class Type> struct traits { };

  template <class Type>
  inline const char* type_name() {
    return traits<Type>::type_name();
  }

  template <class Type> 
  struct traits_info {
    static swig_type_info *type_query(std::string name) {
      name += " *";
      return SWIG_TypeQuery(name.c_str());
    }    
    static swig_type_info *type_info() {
      static swig_type_info *info = type_query(type_name<Type>());
      return info;
    }
  };

  template <class Type>
  inline swig_type_info *type_info() {
    return traits_info<Type>::type_info();
  }

  /*
    Partial specialization for pointers
  */
  template <class Type> struct traits <Type *> {
    typedef pointer_category category;
    static std::string make_ptr_name(const char* name) {
      std::string ptrname = name;
      ptrname += " *";
      return ptrname;
    }    
    static const char* type_name() {
      static std::string name = make_ptr_name(swig::type_name<Type>());
      return name.c_str();
    }
  };

 
  template <class Type, class Category = typename traits<Type>::category > 
  struct traits_check { };

  /*
    Traits that provides the from method for an unknown type
  */
  template <int flags, class Type> struct traits_from_ptr {
    static SWIG_Object from SWIG_FROM_DECL_ARGS(Type *val) {
      return SWIG_NewPointerObj(val, type_info<Type>(), flags);
    }
  };

  template <class Type> struct traits_from {
    static SWIG_Object from SWIG_FROM_DECL_ARGS(const Type& val) {
      return traits_from_ptr<SWIG_POINTER_OWN, Type>::from(new Type(val));
    }
  };

  template <class Type> struct traits_from<Type *> {
    static SWIG_Object from SWIG_FROM_DECL_ARGS(Type* val) {
      return traits_from_ptr<0, Type>::from(val);
    }
  };

  template <class Type>
  inline SWIG_Object from SWIG_FROM_DECL_ARGS(const Type& val) {
    return traits_from<Type>::from(val);
  }

  /*
    Traits that provides the asptr/asval method for an unknown type
  */
  template <class Type>
  struct traits_asptr {   
    static int asptr SWIG_AS_DECL_ARGS (SWIG_Object obj, Type **val) {
      Type *p;
      int res = SWIG_ConvertPtr(obj, %as_voidptrptr(&p), type_info<Type>(), 0);
      if (SWIG_IsOK(res) && val) *val = p;
      return res;
    }
  }; 

  template <class Type>
  inline int asptr SWIG_AS_DECL_ARGS(SWIG_Object obj, Type **vptr) {
    return traits_asptr<Type>::asptr SWIG_AS_CALL_ARGS(obj, vptr);
  }

  template <class Type> 
  struct traits_asval {
    static int asval SWIG_AS_DECL_ARGS(SWIG_Object obj, Type *val) {
      if (val) {
	Type *p = 0;
	int res = traits_asptr<Type>::asptr SWIG_AS_CALL_ARGS(obj, &p);
	if (SWIG_IsOK(res) && p) {
	  *val = *p;
	  if (SWIG_IsNewObj(res)) {
	    %delete(p);
	    res = SWIG_DelNewMask(res);
	  }
	}
	return res;
      } else {
	return traits_asptr<Type>::asptr SWIG_AS_CALL_ARGS(obj, (Type **)(0));
      }
    }
  };
  
  template <class Type>
  inline int asval SWIG_AS_DECL_ARGS (SWIG_Object obj, Type *val) {
    return traits_asval<Type>::asval SWIG_AS_CALL_ARGS(obj, val);
  }

  /*
    Traits that provides the check method for an unknown type
  */
#define SWIG_CHECK_DECL_ARGS(obj) SWIG_AS_DECL_ARGS(obj, void * = 0)
#define SWIG_CHECK_CALL_ARGS(obj) SWIG_AS_CALL_ARGS(obj, 0)

  template <class Type> 
  struct traits_checkval {
    static int check SWIG_CHECK_DECL_ARGS(SWIG_Object obj) {
      if (obj) {
	int res = asval SWIG_AS_CALL_ARGS(obj, (Type *)(0));
	return SWIG_CheckState(res);
      } else {
	return 0;
      }
    }
  };

  template <class Type> 
  struct traits_checkptr {
    static int check SWIG_CHECK_DECL_ARGS(SWIG_Object obj) {
      if (obj) {
	int res = asptr SWIG_AS_CALL_ARGS(obj, (Type **)(0));
	return SWIG_CheckState(res);
      } else {
	return 0;
      }
    }
  };

  template <class Type> 
  struct traits_check<Type, value_category> : traits_checkval<Type> {
  };

  template <class Type> 
  struct traits_check<Type, pointer_category> : traits_checkptr<Type> {
  };

  template <class Type>
  inline int check SWIG_CHECK_DECL_ARGS(SWIG_Object obj) {
    return traits_check<Type>::check SWIG_CHECK_CALL_ARGS(obj);
  }

}
}
 
/*
  Generate the traits for an unknown SWIGTYPE
*/

%define %traits_swigtype(Type...)
%fragment(SWIG_Traits_frag(Type),"header",fragment="Traits") {
  namespace swig {
    template <>  struct traits<Type > {
      typedef pointer_category category;
      static const char* type_name() { return  #Type; }
    };
  }
}
%enddef


/*
  Generate the traits for a 'value' type, such as 'double',
  for which the SWIG_AsVal and SWIG_From methods are already defined.
*/

%define %traits_value(Type...)
%fragment(SWIG_Traits_frag(Type),"header",
	  fragment=SWIG_AsVal_frag(Type),
	  fragment=SWIG_From_frag(Type),
	  fragment="Traits") {
namespace swig {
  template <> struct traits<Type > {
    typedef value_category category;
    static const char* type_name() { return  #Type; }
  };  

  template <>  struct traits_asval<Type > {   
    typedef Type value_type;
    static int asval SWIG_AS_DECL_ARGS (SWIG_Object obj, value_type *val) {
      return SWIG_AsVal(Type)(obj, val);
    }
  };

  template <>  struct traits_from<Type > {
    typedef Type value_type;
    static SWIG_Object from SWIG_FROM_DECL_ARGS (const value_type& val) {
      return SWIG_From(Type)(val);
    }
  };
}
}
%enddef

/*
  Generate the traits for a 'pointer' type, such as 'std::string',
  for which the SWIG_AsPtr and SWIG_From methods are already defined.
*/

%define %traits_pointer(Type...)
%fragment(SWIG_Traits_frag(Type),"header",
	  fragment=SWIG_AsVal_frag(Type),
	  fragment=SWIG_From_frag(Type),
	  fragment="Traits") {
namespace swig {
  template <> struct traits<Type > {
    typedef pointer_category category;
    static const char* type_name() { return  #Type; }
  };  
    
  template <>  struct traits_asptr<Type > {   
    typedef Type value_type;
    static int asptr SWIG_AS_DECL_ARGS (SWIG_Object obj, value_type **val) {
      return SWIG_AsPtr(Type)(obj, val);
    }
  };

  template <>  struct traits_from<Type > {
    typedef Type value_type;
    static SWIG_Object from SWIG_FROM_DECL_ARGS (const value_type& val) {
      return SWIG_From(Type)(val);
    }
  };
}
}
%enddef

/*
  Generate the typemaps for a class that has 'value' traits
*/

%define %typemap_traits_value(Code,Type...)
  %typemaps_asvalfrom(%arg(Code),
		      %arg(swig::asval),
		      %arg(swig::from),
		      %arg(SWIG_Traits_frag(Type)),
		      %arg(SWIG_Traits_frag(Type)),
		      Type);
%enddef

/*
  Generate the typemaps for a class that has 'pointer' traits
*/

%define %typemap_traits_pointer(Code,Type...)
  %typemaps_asptrfrom(%arg(Code),
		      %arg(swig::asptr),
		      %arg(swig::from),
		      %arg(SWIG_Traits_frag(Type)),
		      %arg(SWIG_Traits_frag(Type)),
		      Type);
%enddef