-
Notifications
You must be signed in to change notification settings - Fork 128
Expand file tree
/
Copy pathCompoundDataBinding.cpp
More file actions
543 lines (483 loc) · 15.1 KB
/
Copy pathCompoundDataBinding.cpp
File metadata and controls
543 lines (483 loc) · 15.1 KB
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
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
//////////////////////////////////////////////////////////////////////////
//
// Copyright (c) 2007-2012, Image Engine Design Inc. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// * Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// * Neither the name of Image Engine Design nor the names of any
// other contributors to this software may be used to endorse or
// promote products derived from this software without specific prior
// written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
// IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
// THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
//////////////////////////////////////////////////////////////////////////
#include "boost/python.hpp"
#include "IECorePython/CompoundDataBinding.h"
#include "IECorePython/RunTimeTypedBinding.h"
#include "IECore/CompoundData.h"
#include "boost/python/call_method.hpp"
#include "boost/python/dict.hpp"
#include "boost/python/list.hpp"
#include "boost/python/make_constructor.hpp"
#include "boost/python/tuple.hpp"
#include <sstream>
using std::string;
using namespace boost;
using namespace boost::python;
using namespace IECore;
// Module declaration
namespace IECorePython
{
class CompoundDataFromPythonDict
{
public :
CompoundDataFromPythonDict()
{
converter::registry::push_back(
&convertible,
&construct,
type_id<CompoundDataPtr> ()
);
}
private :
static void *convertible( PyObject *obj_ptr )
{
if ( !PyDict_Check( obj_ptr ) )
{
return nullptr;
}
return obj_ptr;
}
static void construct(
PyObject *obj_ptr,
converter::rvalue_from_python_stage1_data *data )
{
assert( obj_ptr );
assert( PyDict_Check( obj_ptr ) );
handle<> h( borrowed(obj_ptr) );
dict d( h );
void *storage = (( converter::rvalue_from_python_storage<CompoundDataPtr>* ) data )->storage.bytes;
new( storage ) CompoundDataPtr( compoundDataFromDict( d ) );
data->convertible = storage;
}
static CompoundDataPtr compoundDataFromDict( const dict &v )
{
CompoundDataPtr x = new CompoundData();
list values = v.values();
list keys = v.keys();
for (int i = 0; i < keys.attr("__len__")(); i++)
{
object key( keys[i] );
object value( values[i] );
extract<const char *> keyElem( key );
if( !keyElem.check() )
{
PyErr_SetString( PyExc_TypeError, "Incompatible key type. Only strings accepted." );
throw_error_already_set();
}
extract<DataPtr> valueElem( value );
if( valueElem.check() )
{
x->writable()[keyElem()] = valueElem();
continue;
}
extract<dict> dictValueE( value );
if( dictValueE.check() )
{
CompoundDataPtr sub = compoundDataFromDict( dictValueE() );
x->writable()[keyElem()] = sub;
continue;
}
else
{
PyErr_SetString( PyExc_TypeError, "Incompatible value type - must be Data or dict." );
throw_error_already_set();
}
}
return x;
}
};
class CompoundDataFunctions
{
public:
IE_CORE_DECLAREMEMBERPTR( CompoundData );
typedef const char * key_type;
typedef CompoundDataMap::value_type::second_type data_type;
typedef CompoundDataMap::size_type size_type;
typedef CompoundDataMap::iterator iterator;
typedef CompoundDataMap::const_iterator const_iterator;
/// constructor that receives a python map object
static CompoundDataPtr dataMapConstructor( dict v )
{
CompoundDataPtr d = extract<CompoundDataPtr>( v );
return d;
}
/// binding for __getitem__ function
static data_type getItem( CompoundData &x, PyObject *i )
{
key_type key = convertKey( x, i );
const CompoundDataMap &xData = x.readable();
CompoundDataMap::const_iterator value = xData.find( key );
if ( value != xData.end() )
{
return value->second;
}
else
{
PyErr_SetString( PyExc_KeyError, key );
throw_error_already_set();
}
return data_type();
}
/// binding for __setitem__ function
static void setItem( CompoundData &x, PyObject *i, data_type v )
{
key_type key = convertKey( x, i );
CompoundDataMap &xData = x.writable();
if ( !v )
{
// prevent python users to set value as "None"
PyErr_SetString(PyExc_TypeError, "Setting None to CompoundData items is not supported.");
throw_error_already_set();
}
xData[key] = v;
}
/// binding for __delitem__ function
static void delItem( CompoundData &x, PyObject *i )
{
key_type key = convertKey( x, i );
CompoundDataMap &xData = x.writable();
CompoundDataMap::iterator value = xData.find( key );
if ( value != xData.end() )
{
xData.erase( value );
}
else
{
PyErr_SetString( PyExc_KeyError, key );
throw_error_already_set();
}
}
/// binding for __len__ function
static size_type len( CompoundData &x )
{
return x.readable().size();
}
/// binding for any unsupported binary operator
CompoundDataPtr invalidOperator( CompoundData &x, PyObject* y )
{
PyErr_SetString( PyExc_SyntaxError, "Binary operator not supported for this class." );
throw_error_already_set();
assert( false );
return nullptr;
}
/// binding for map clear method
static void
clear( CompoundData &x )
{
CompoundDataMap &xData = x.writable();
xData.clear();
}
/// binding for has_key method
static bool
has_key( CompoundData &x, PyObject *i )
{
key_type key = convertKey( x, i );
const CompoundDataMap &xData = x.readable();
CompoundDataMap::const_iterator value = xData.find( key );
return ( value != xData.end() );
}
/// binding for items method
static list
items( CompoundData &x )
{
list newList;
const CompoundDataMap &xData = x.readable();
CompoundDataMap::const_iterator iterX = xData.begin();
while ( iterX != xData.end() )
{
newList.append( boost::python::make_tuple( iterX->first.value(), iterX->second ) );
iterX++;
}
return newList;
}
/// binding for keys method
static list
keys( CompoundData &x )
{
list newList;
const CompoundDataMap &xData = x.readable();
CompoundDataMap::const_iterator iterX = xData.begin();
while ( iterX != xData.end() )
{
newList.append( iterX->first.value() );
iterX++;
}
return newList;
}
/// binding for update method
static void
update( CompoundData &x, ConstCompoundDataPtr y )
{
CompoundDataMap &xData = x.writable();
const CompoundDataMap &yData = y->readable();
CompoundDataMap::const_iterator iterY = yData.begin();
for ( ; iterY != yData.end(); iterY++ )
{
xData[iterY->first] = iterY->second;
}
}
/// binding for values method
static list
values( CompoundData &x )
{
list newList;
const CompoundDataMap &xData = x.readable();
CompoundDataMap::const_iterator iterX = xData.begin();
while ( iterX != xData.end() )
{
newList.append( iterX->second );
iterX++;
}
return newList;
}
/// binding for get method
static data_type
get( CompoundData &x, PyObject *i, PyObject *v )
{
key_type key = convertKey( x, i );
const CompoundDataMap &xData = x.readable();
CompoundDataMap::const_iterator value = xData.find( key );
if ( value == xData.end() )
{
extract<data_type> elem( v );
if ( elem.check() )
{
return elem();
}
else
{
PyErr_SetString( PyExc_TypeError, "Invalid parameter" );
throw_error_already_set();
}
return data_type();
}
// return the value from the map
return value->second;
}
/// binding for setdefault method
static data_type
setdefault2( CompoundData &x, PyObject *i )
{
return setdefault( x, i, Py_None );
}
/// binding for setdefault method
static data_type
setdefault( CompoundData &x, PyObject *i, PyObject *v )
{
key_type key = convertKey( x, i );
const CompoundDataMap &xData = x.readable();
CompoundDataMap::const_iterator value = xData.find( key );
if ( value == xData.end() )
{
// the key is not there...
if ( v == Py_None )
{
PyErr_SetString( PyExc_KeyError, key );
throw_error_already_set();
}
// get the default value from the parameter
extract<data_type> elem( v );
if ( elem.check() )
{
// include the value on the map
CompoundDataMap &writableX = x.writable();
writableX[key] = elem();
return elem();
}
else
{
PyErr_SetString( PyExc_TypeError, "Invalid parameter" );
throw_error_already_set();
}
return data_type();
}
// return the value from the map.
return value->second;
}
/// binding for pop method
static data_type
pop2( CompoundData &x, PyObject *i )
{
return pop( x, i, Py_None );
}
/// binding for pop method
static data_type
pop( CompoundData &x, PyObject *i, PyObject *v )
{
key_type key = convertKey( x, i );
const CompoundDataMap &xData = x.readable();
CompoundDataMap::const_iterator value = xData.find( key );
if ( value == xData.end() )
{
if ( v == Py_None )
{
PyErr_SetString( PyExc_KeyError, key );
throw_error_already_set();
}
extract<data_type> elem( v );
if ( elem.check() )
{
return elem();
}
else
{
PyErr_SetString( PyExc_TypeError, "Invalid parameter" );
throw_error_already_set();
}
return data_type();
}
// save the returning value.
data_type ret( value->second );
// delete it from the map
CompoundDataMap &writableX = x.writable();
CompoundDataMap::iterator writableValue = writableX.find( key );
writableX.erase( writableValue );
return ret;
}
/// binding for popitem method
static boost::python::tuple
popitem( CompoundData &x )
{
boost::python::tuple newTuple;
CompoundDataMap &xData = x.writable();
CompoundDataMap::iterator iterX = xData.begin();
if ( iterX != xData.end() )
{
newTuple = boost::python::make_tuple( iterX->first.value(), iterX->second );
xData.erase( iterX );
}
else
{
PyErr_SetString( PyExc_KeyError, "CompoundData is empty" );
throw_error_already_set();
}
return newTuple;
}
/// \todo Move outside template so that it specialises the repr() in IECoreBinding.h
static std::string repr( CompoundData &x )
{
std::stringstream s;
s << "IECore." << x.typeName() << "(";
bool added = false;
for (
CompoundDataMap::const_iterator it = x.readable().begin();
it != x.readable().end();
++it )
{
const std::string &key = it->first;
object item( it->second );
if ( item.attr( "__repr__" ) != object() )
{
std::string v = call_method< std::string >( item.ptr(), "__repr__" );
if ( !added )
{
added = true;
s << "{";
}
else
{
s << ",";
}
s << "'";
s << key;
s << "':";
s << v;
}
}
if ( added )
{
s << "}";
}
s << ")";
return s.str();
}
protected:
/*
* Utility functions
*/
static key_type
convertKey( CompoundData & container, PyObject *key_ )
{
extract<key_type> key( key_ );
if ( key.check() )
{
return key();
}
PyErr_SetString( PyExc_TypeError, "Invalid key type" );
throw_error_already_set();
return key_type();
}
};
void bindCompoundData()
{
RunTimeTypedClass<CompoundDataBase>();
RunTimeTypedClass<CompoundData>(
"This class behaves like the native python dict, except that it only accepts objects derived from Data class.\n"
"The copy constructor accepts another instance of this class or a python dict containing Data objects\n"
"it has the most important dict methods: has_key, items, keys, values, get, pop, etc.\n"
)
.def( init<>() )
.def( "__init__", make_constructor( &CompoundDataFunctions::dataMapConstructor ), "Copy constructor: accepts a python dict containing Data objects." )
.def( "__getitem__", &CompoundDataFunctions::getItem, "indexing operator.\nAccepts only string keys." )
.def( "__setitem__", &CompoundDataFunctions::setItem, "index assignment operator.\nWorks exactly like on python dicts but only accepts Data objects as the new value." )
.def( "__delitem__", &CompoundDataFunctions::delItem, "index deletion operator.\nWorks exactly like on python dicts." )
.def( "__len__", &CompoundDataFunctions::len, "Length operator." )
.def( "__contains__", &CompoundDataFunctions::has_key, "In operator.\nWorks exactly like on python dicts." )
.def( "size", &CompoundDataFunctions::len, "m.size()\nReturns the number of elements on m. Same result as the len operator." )
.def( "__cmp__", &CompoundDataFunctions::invalidOperator, "Raises an exception. CompoundData does not support comparison operators." )
.def( "__repr__", &CompoundDataFunctions::repr )
// python map methods.
.def( "clear", &CompoundDataFunctions::clear, "m.clear()\nRemoves all items from m." )
.def( "has_key", &CompoundDataFunctions::has_key, "m.has_key(k)\nReturns True if m has key k; otherwise, returns False." )
.def( "items", &CompoundDataFunctions::items, "m.items()\nReturns a list of (key, value) pairs." )
.def( "keys", &CompoundDataFunctions::keys, "m.keys()\nReturns a list of key values." )
.def( "update", &CompoundDataFunctions::update, "m.update(b)\nAdds all objects from b to m. b can be a CompoundData or a python dict." )
.def( "values", &CompoundDataFunctions::values, "m.values()\nReturns a list of all values in m." )
.def( "get", &CompoundDataFunctions::get, "m.get(k [, v])\nReturns m[k] if found; otherwise, returns v.",
(
boost::python::arg( "self" ),
boost::python::arg( "key" ),
boost::python::arg( "defaultValue" ) = object()
)
)
.def( "setdefault", &CompoundDataFunctions::setdefault, "m.setdefault(k [, v])\nReturns m[k] if found; otherwise, returns v and sets m[k] = v." )
.def( "setdefault", &CompoundDataFunctions::setdefault2 )
.def( "pop", &CompoundDataFunctions::pop, "m.pop(k [,default])\nReturns m[k] if found and removes it from m; otherwise, returns default if supplied or raises KeyError if not." )
.def( "pop", &CompoundDataFunctions::pop2 )
.def( "popitem", &CompoundDataFunctions::popitem, "m.popitem()\nRemvoes a random (key,value) pair from m and returns it as a tuple." )
.def( "hasBase", &CompoundData::hasBase ).staticmethod( "hasBase" )
;
CompoundDataFromPythonDict();
}
} // namespace IECorePython