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 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576
|
/*
* SPDX-FileCopyrightText: All Contributors to the PyTango project
*
* SPDX-License-Identifier: LGPL-3.0-or-later
*/
#include "precompiled_header.hpp"
#include "defs.h"
#include "pytgutils.h"
#include "pipe.h"
#include "fast_from_py.h"
#include <boost/python.hpp>
#include "device_pipe.h"
#define __AUX_DECL_CALL_PIPE_METHOD \
PyDeviceImplBase *__dev_ptr = dynamic_cast<PyDeviceImplBase *>(dev); \
AutoPythonGIL __py_lock;
#define __AUX_CATCH_PY_EXCEPTION \
catch(bopy::error_already_set & eas) \
{ \
handle_python_exception(eas); \
}
#define CALL_PIPE_METHOD(dev, name) \
__AUX_DECL_CALL_PIPE_METHOD \
try \
{ \
bopy::call_method<void>(__dev_ptr->the_self, name); \
} \
__AUX_CATCH_PY_EXCEPTION
#define CALL_PIPE_METHOD_VARGS(dev, name, ...) \
__AUX_DECL_CALL_PIPE_METHOD \
try \
{ \
bopy::call_method<void>(__dev_ptr->the_self, name, __VA_ARGS__); \
} \
__AUX_CATCH_PY_EXCEPTION
#define CALL_PIPE_METHOD_RET(retType, ret, dev, name) \
__AUX_DECL_CALL_PIPE_METHOD \
try \
{ \
ret = bopy::call_method<retType>(__dev_ptr->the_self, name); \
} \
__AUX_CATCH_PY_EXCEPTION
#define CALL_PIPE_METHOD_VARGS_RET(retType, ret, dev, name, ...) \
__AUX_DECL_CALL_PIPE_METHOD \
try \
{ \
ret = bopy::call_method<retType>(__dev_ptr->the_self, name, __VA_ARGS__); \
} \
__AUX_CATCH_PY_EXCEPTION
#define RET_CALL_PIPE_METHOD(retType, dev, name) \
__AUX_DECL_CALL_PIPE_METHOD \
try \
{ \
return bopy::call_method<retType>(__dev_ptr->the_self, name); \
} \
__AUX_CATCH_PY_EXCEPTION
#define RET_CALL_PIPE_METHOD_VARGS(retType, dev, name, ...) \
__AUX_DECL_CALL_PIPE_METHOD \
try \
{ \
return bopy::call_method<retType>(__dev_ptr->the_self, name, __VA_ARGS__); \
} \
__AUX_CATCH_PY_EXCEPTION
namespace PyTango
{
namespace Pipe
{
void _Pipe::read(Tango::DeviceImpl *dev, Tango::Pipe &pipe)
{
if(!_is_method(dev, read_name))
{
TangoSys_OMemStream o;
o << read_name << " method "
<< " not found for " << pipe.get_name();
Tango::Except::throw_exception("PyTango_ReadPipeMethodNotFound", o.str(), "PyTango::Pipe::read");
}
CALL_PIPE_METHOD_VARGS(dev, read_name.c_str(), boost::ref(pipe))
}
void _Pipe::write(Tango::DeviceImpl *dev, Tango::WPipe &pipe)
{
if(!_is_method(dev, write_name))
{
TangoSys_OMemStream o;
o << write_name << " method not found for " << pipe.get_name();
Tango::Except::throw_exception("PyTango_WritePipeMethodNotFound", o.str(), "PyTango::Pipe::write");
}
PyDeviceImplBase *__dev_ptr = dynamic_cast<PyDeviceImplBase *>(dev);
AutoPythonGIL __py_lock;
try
{
bopy::call_method<bopy::object>(__dev_ptr->the_self, write_name.c_str(), boost::ref(pipe));
}
catch(bopy::error_already_set &eas)
{
handle_python_exception(eas);
}
}
bool _Pipe::is_allowed(Tango::DeviceImpl *dev, Tango::PipeReqType ty)
{
if(_is_method(dev, py_allowed_name))
{
RET_CALL_PIPE_METHOD_VARGS(bool, dev, py_allowed_name.c_str(), ty)
}
// keep compiler quiet
return true;
}
bool _Pipe::_is_method(Tango::DeviceImpl *dev, const std::string &name)
{
AutoPythonGIL __py_lock;
PyDeviceImplBase *__dev_ptr = dynamic_cast<PyDeviceImplBase *>(dev);
PyObject *__dev_py = __dev_ptr->the_self;
return is_method_defined(__dev_py, name);
}
static void throw_wrong_python_data_type(const std::string &name, const char *method)
{
TangoSys_OMemStream o;
o << "Wrong Python type for pipe " << name << std::ends;
Tango::Except::throw_exception("PyDs_WrongPythonDataTypeForPipe", o.str(), method);
}
template <typename T>
void append_scalar_encoded(T &obj, const std::string &name, bopy::object &py_value)
{
bopy::object p0 = py_value[0];
bopy::object p1 = py_value[1];
const char *encoded_format = bopy::extract<const char *>(p0.ptr());
PyObject *data_ptr = p1.ptr();
Py_buffer view;
if(PyObject_GetBuffer(data_ptr, &view, PyBUF_FULL_RO) < 0)
{
throw_wrong_python_data_type(obj.get_name(), "append_scalar_encoded");
}
CORBA::ULong nb = static_cast<CORBA::ULong>(view.len);
Tango::DevVarCharArray arr(nb, nb, (CORBA::Octet *) view.buf, false);
Tango::DevEncoded value;
value.encoded_format = CORBA::string_dup(encoded_format);
value.encoded_data = arr;
obj << value;
PyBuffer_Release(&view);
}
template <typename T, long tangoTypeConst>
void __append_scalar(T &obj, const std::string &name, bopy::object &py_value)
{
typedef typename TANGO_const2type(tangoTypeConst) TangoScalarType;
TangoScalarType tg_value;
from_py<tangoTypeConst>::convert(py_value, tg_value);
Tango::DataElement<TangoScalarType> data_elt(name, tg_value);
obj << data_elt;
}
template <long tangoTypeConst>
void append_scalar(Tango::Pipe &pipe, const std::string &name, bopy::object &py_value)
{
__append_scalar<Tango::Pipe, tangoTypeConst>(pipe, name, py_value);
}
template <>
void append_scalar<Tango::DEV_VOID>(Tango::Pipe &pipe, const std::string &name, bopy::object &py_value)
{
throw_wrong_python_data_type(pipe.get_name(), "append_scalar");
}
template <>
void append_scalar<Tango::DEV_PIPE_BLOB>(Tango::Pipe &pipe, const std::string &name, bopy::object &py_value)
{
throw_wrong_python_data_type(pipe.get_name(), "append_scalar");
}
template <>
void append_scalar<Tango::DEV_ENCODED>(Tango::Pipe &pipe, const std::string &name, bopy::object &py_value)
{
append_scalar_encoded<Tango::Pipe>(pipe, name, py_value);
}
template <long tangoTypeConst>
void append_scalar(Tango::DevicePipeBlob &blob, const std::string &name, bopy::object &py_value)
{
__append_scalar<Tango::DevicePipeBlob, tangoTypeConst>(blob, name, py_value);
}
template <>
void append_scalar<Tango::DEV_VOID>(Tango::DevicePipeBlob &blob, const std::string &name, bopy::object &py_value)
{
throw_wrong_python_data_type(blob.get_name(), "append_scalar");
}
template <>
void append_scalar<Tango::DEV_PIPE_BLOB>(Tango::DevicePipeBlob &blob, const std::string &name, bopy::object &py_value)
{
throw_wrong_python_data_type(blob.get_name(), "append_scalar");
}
template <>
void append_scalar<Tango::DEV_ENCODED>(Tango::DevicePipeBlob &blob, const std::string &name, bopy::object &py_value)
{
append_scalar_encoded<Tango::DevicePipeBlob>(blob, name, py_value);
}
// -------------
// Array version
// -------------
template <typename T, long tangoArrayTypeConst>
void __append_array(T &obj, const std::string &name, bopy::object &py_value)
{
typedef typename TANGO_const2type(tangoArrayTypeConst) TangoArrayType;
TangoArrayType *value = fast_convert2array<tangoArrayTypeConst>(py_value);
obj << value;
}
template <long tangoArrayTypeConst>
void append_array(Tango::Pipe &pipe, const std::string &name, bopy::object &py_value)
{
__append_array<Tango::Pipe, tangoArrayTypeConst>(pipe, name, py_value);
}
template <>
void append_array<Tango::DEV_VOID>(Tango::Pipe &pipe, const std::string &name, bopy::object &py_value)
{
throw_wrong_python_data_type(pipe.get_name(), "append_array");
}
template <>
void append_array<Tango::DEV_PIPE_BLOB>(Tango::Pipe &pipe, const std::string &name, bopy::object &py_value)
{
throw_wrong_python_data_type(pipe.get_name(), "append_array");
}
template <>
void append_array<Tango::DEVVAR_LONGSTRINGARRAY>(Tango::Pipe &pipe, const std::string &name, bopy::object &py_value)
{
throw_wrong_python_data_type(pipe.get_name(), "append_array");
}
template <>
void append_array<Tango::DEVVAR_DOUBLESTRINGARRAY>(Tango::Pipe &pipe, const std::string &name, bopy::object &py_value)
{
throw_wrong_python_data_type(pipe.get_name(), "append_array");
}
template <long tangoArrayTypeConst>
void append_array(Tango::DevicePipeBlob &blob, const std::string &name, bopy::object &py_value)
{
__append_array<Tango::DevicePipeBlob, tangoArrayTypeConst>(blob, name, py_value);
}
template <>
void append_array<Tango::DEV_VOID>(Tango::DevicePipeBlob &blob, const std::string &name, bopy::object &py_value)
{
throw_wrong_python_data_type(blob.get_name(), "append_array");
}
template <>
void append_array<Tango::DEV_PIPE_BLOB>(Tango::DevicePipeBlob &blob, const std::string &name, bopy::object &py_value)
{
throw_wrong_python_data_type(blob.get_name(), "append_array");
}
template <>
void append_array<Tango::DEVVAR_LONGSTRINGARRAY>(Tango::DevicePipeBlob &blob,
const std::string &name,
bopy::object &py_value)
{
throw_wrong_python_data_type(blob.get_name(), "append_array");
}
template <>
void append_array<Tango::DEVVAR_DOUBLESTRINGARRAY>(Tango::DevicePipeBlob &blob,
const std::string &name,
bopy::object &py_value)
{
throw_wrong_python_data_type(blob.get_name(), "append_array");
}
template <typename T>
void __append(T &obj, const std::string &name, bopy::object &py_value, const Tango::CmdArgType dtype)
{
TANGO_DO_ON_DEVICE_DATA_TYPE_ID(dtype, append_scalar<tangoTypeConst>(obj, name, py_value);
, append_array<tangoTypeConst>(obj, name, py_value););
}
/*
template<typename T>
void __set_value(T& obj, bopy::object& py_value)
{
bopy::object items = py_value.attr("items")();
Py_ssize_t size = bopy::len(items);
obj.set_data_elt_nb(size);
for(size_t i = 0; i < size; ++i)
{
std::string item_name = bopy::extract<std::string>(items[i][0]);
bopy::object py_item_data = items[i][1];
if (PyDict_Check(py_item_data.ptr())) // data element
{
bopy::object py_item_value = py_item_data["value"];
bopy::object py_item_dtype = py_item_data["dtype"];
Tango::CmdArgType item_dtype = bopy::extract<Tango::CmdArgType>(py_item_dtype);
__append(obj, item_name, py_item_value, item_dtype);
}
else
{
std::string blob_name = bopy::extract<std::string>(py_item_data[0]);
bopy::object py_blob_data = py_item_data[1];
Tango::DevicePipeBlob blob(blob_name);
__set_value(blob, py_blob_data);
obj << blob;
}
}
}
*/
/*
template<typename T>
void __set_value(T& obj, bopy::object& py_value)
{
bopy::str name_key("name");
Py_ssize_t size = bopy::len(py_value);
std::vector<std::string> elem_names;
for(size_t i = 0; i < size; ++i)
{
elem_names.push_back(bopy::extract<std::string>(py_value[i][0]));
}
obj.set_data_elt_names(elem_names);
for(size_t i = 0; i < size; ++i)
{
std::string item_name = bopy::extract<std::string>(py_value[i][0]);
bopy::dict py_item_data = bopy::extract<bopy::dict>(py_value[i][1]);
if (py_item_data.has_key(name_key)) // a sub-blob
{
std::string blob_name = bopy::extract<std::string>(py_item_data["name"]);
bopy::object py_blob_data = py_item_data["data"];
Tango::DevicePipeBlob blob(blob_name);
__set_value(blob, py_blob_data);
obj << blob;
}
else
{
bopy::object py_item_value = py_item_data["value"];
bopy::object py_item_dtype = py_item_data["dtype"];
Tango::CmdArgType item_dtype = bopy::extract<Tango::CmdArgType>(py_item_dtype);
__append(obj, item_name, py_item_value, item_dtype);
}
}
}
*/
template <typename T>
void __set_value(T &obj, bopy::object &py_value)
{
// need to fill item names first because in case it is a sub-blob,
// the Tango C++ API doesnt't provide a way to do it
Py_ssize_t size = bopy::len(py_value);
std::vector<std::string> elem_names;
for(Py_ssize_t i = 0; i < size; ++i)
{
elem_names.push_back(bopy::extract<std::string>(py_value[i]["name"]));
}
obj.set_data_elt_names(elem_names);
for(Py_ssize_t i = 0; i < size; ++i)
{
bopy::object item = py_value[i];
std::string item_name = bopy::extract<std::string>(item["name"]);
bopy::object py_item_data = item["value"];
Tango::CmdArgType item_dtype = bopy::extract<Tango::CmdArgType>(item["dtype"]);
if(item_dtype == Tango::DEV_PIPE_BLOB) // a sub-blob
{
std::string blob_name = bopy::extract<std::string>(py_item_data[0]);
bopy::object py_blob_data = py_item_data[1];
Tango::DevicePipeBlob blob(blob_name);
__set_value(blob, py_blob_data);
obj << blob;
}
else
{
__append(obj, item_name, py_item_data, item_dtype);
}
}
}
void set_value(Tango::Pipe &pipe, bopy::object &py_value)
{
__set_value<Tango::Pipe>(pipe, py_value);
}
bopy::object get_value(Tango::WPipe &pipe)
{
bopy::object py_value;
Tango::DevicePipeBlob blob = pipe.get_blob();
py_value = PyTango::DevicePipe::extract(blob);
return py_value;
}
} // namespace Pipe
} // namespace PyTango
void export_pipe()
{
bopy::class_<Tango::Pipe, boost::noncopyable>(
"Pipe", bopy::init<const std::string &, const Tango::DispLevel, bopy::optional<Tango::PipeWriteType>>())
.def("get_name", &Tango::Pipe::get_name, bopy::return_value_policy<bopy::copy_non_const_reference>())
.def("set_name", &Tango::Pipe::set_name)
.def("set_default_properties", &Tango::Pipe::set_default_properties)
.def("get_root_blob_name",
&Tango::Pipe::get_root_blob_name,
bopy::return_value_policy<bopy::copy_const_reference>())
.def("set_root_blob_name", &Tango::Pipe::set_root_blob_name)
.def("get_desc", &Tango::Pipe::get_desc, bopy::return_value_policy<bopy::copy_non_const_reference>())
.def("get_label", &Tango::Pipe::get_label, bopy::return_value_policy<bopy::copy_non_const_reference>())
.def("get_disp_level", &Tango::Pipe::get_disp_level)
.def("get_writable", &Tango::Pipe::get_writable)
.def("get_pipe_serial_model", &Tango::Pipe::get_pipe_serial_model)
.def("set_pipe_serial_model", &Tango::Pipe::set_pipe_serial_model)
.def("has_failed", &Tango::Pipe::has_failed)
.def("_set_value", (void (*)(Tango::Pipe &, bopy::object &)) & PyTango::Pipe::set_value)
.def("get_value", (bopy::object(*)(Tango::WPipe &)) & PyTango::Pipe::get_value);
bopy::class_<Tango::WPipe, bopy::bases<Tango::Pipe>, boost::noncopyable>(
"WPipe", bopy::init<const std::string &, const Tango::DispLevel>());
}
namespace PyDevicePipe
{
static void throw_wrong_python_data_type(const std::string &name, const char *method)
{
TangoSys_OMemStream o;
o << "Wrong Python type for pipe " << name << std::ends;
Tango::Except::throw_exception("PyDs_WrongPythonDataTypeForPipe", o.str(), method);
}
template <typename T, long tangoTypeConst>
void __append_scalar(T &obj, const std::string &name, bopy::object &py_value)
{
typedef typename TANGO_const2type(tangoTypeConst) TangoScalarType;
TangoScalarType tg_value;
from_py<tangoTypeConst>::convert(py_value, tg_value);
Tango::DataElement<TangoScalarType> data_elt(name, tg_value);
obj << data_elt;
}
template <typename T, long tangoArrayTypeConst>
void __append_array(T &obj, const std::string &name, bopy::object &py_value)
{
typedef typename TANGO_const2type(tangoArrayTypeConst) TangoArrayType;
TangoArrayType *value = fast_convert2array<tangoArrayTypeConst>(py_value);
obj << value;
}
template <typename T>
bool __check_type(const bopy::object &value)
{
bopy::extract<T> item(value);
return item.check();
}
template <typename T>
bool __convert(const bopy::object &value, T &py_item_data)
{
bopy::extract<T> item(value);
if(item.check())
{
py_item_data = item();
return true;
}
return false;
}
void __append(Tango::DevicePipeBlob &dpb, const std::string &name, bopy::object &value)
{
if(__check_type<std::string>(value))
{
__append_scalar<Tango::DevicePipeBlob, Tango::DEV_STRING>(dpb, name, value);
}
else if(__check_type<int>(value))
{
__append_scalar<Tango::DevicePipeBlob, Tango::DEV_LONG64>(dpb, name, value);
}
else if(__check_type<double>(value))
{
__append_scalar<Tango::DevicePipeBlob, Tango::DEV_DOUBLE>(dpb, name, value);
}
else if(__check_type<bool>(value))
{
__append_scalar<Tango::DevicePipeBlob, Tango::DEV_BOOLEAN>(dpb, name, value);
}
else if(__check_type<bopy::list>(value))
{
if(__check_type<std::string>(value[0]))
{
__append_array<Tango::DevicePipeBlob, Tango::DEVVAR_STRINGARRAY>(dpb, name, value);
}
else if(__check_type<int>(value[0]))
{
__append_array<Tango::DevicePipeBlob, Tango::DEVVAR_LONG64ARRAY>(dpb, name, value);
}
else if(__check_type<double>(value[0]))
{
__append_array<Tango::DevicePipeBlob, Tango::DEVVAR_DOUBLEARRAY>(dpb, name, value);
}
else
{
throw_wrong_python_data_type(name, "__append");
}
}
else
{
throw_wrong_python_data_type(name, "__append");
}
}
void __set_value(Tango::DevicePipeBlob &dpb, bopy::dict &dict)
{
int nitems = len(dict);
std::vector<std::string> elem_names;
for(int i = 0; i < nitems; i++)
{
elem_names.push_back(bopy::extract<std::string>(dict.keys()[i]));
}
dpb.set_data_elt_names(elem_names);
bopy::list values = dict.values();
for(int i = 0; i < nitems; ++i)
{
bopy::object item = values[i];
// Check if the value is an inner blob
bopy::tuple ptuple;
std::string blob_name;
bopy::dict pdict;
if(__convert(item, ptuple) && __convert(ptuple[0], blob_name) && __convert(ptuple[1], pdict))
{
Tango::DevicePipeBlob inner_blob(blob_name);
__set_value(inner_blob, pdict);
dpb << inner_blob;
}
else
{
__append(dpb, elem_names[i], item);
}
}
}
void set_value(Tango::DevicePipeBlob &dpb, bopy::object &py_data)
{
std::string name = bopy::extract<std::string>(py_data[0]);
dpb.set_name(name);
bopy::dict data = bopy::extract<bopy::dict>(py_data[1]);
__set_value(dpb, data);
}
} // namespace PyDevicePipe
|