/*************************************************************************** * Copyright (c) 2013 Jürgen Riegel * * * * This file is part of the FreeCAD CAx development system. * * * * This library is free software; you can redistribute it and/or * * modify it under the terms of the GNU Library General Public * * License as published by the Free Software Foundation; either * * version 2 of the License, or (at your option) any later version. * * * * This library is distributed in the hope that it will be useful, * * but WITHOUT ANY WARRANTY; without even the implied warranty of * * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * * GNU Library General Public License for more details. * * * * You should have received a copy of the GNU Library General Public * * License along with this library; see the file COPYING.LIB. If not, * * write to the Free Software Foundation, Inc., 59 Temple Place, * * Suite 330, Boston, MA 02111-1307, USA * * * ***************************************************************************/ #include "PreCompiled.h" #ifndef _PreComp_ #include #include #include #include #include #include #include #endif #include "Unit.h" // generated out of Quantity.pyi #include "QuantityPy.h" #include "QuantityPy.cpp" #include "UnitPy.h" using Base::Quantity; // returns a string which represents the object e.g. when printed in python std::string QuantityPy::representation() const { std::stringstream ss; // Use Python's implementation to repr() a float Py::Float flt(getQuantityPtr()->getValue()); ss << static_cast(flt.repr()); if (!getQuantityPtr()->isDimensionless()) { ss << " " << getQuantityPtr()->getUnit().getString(); } return ss.str(); } PyObject* QuantityPy::toStr(PyObject* args) const { int prec = getQuantityPtr()->getFormat().precision; if (!PyArg_ParseTuple(args, "|i", &prec)) { return nullptr; } double val = getQuantityPtr()->getValue(); std::stringstream ss; ss.precision(prec); ss.setf(std::ios::fixed, std::ios::floatfield); ss << val; if (!getQuantityPtr()->isDimensionless()) { ss << " " << getQuantityPtr()->getUnit().getString(); } return Py_BuildValue("s", ss.str().c_str()); } PyObject* QuantityPy::PyMake(PyTypeObject* /*unused*/, PyObject* /*unused*/, PyObject* /*unused*/) { // create a new instance of QuantityPy and the Twin object return new QuantityPy(new Quantity); } // constructor method int QuantityPy::PyInit(PyObject* args, PyObject* /*kwd*/) { Quantity* self = getQuantityPtr(); PyErr_Clear(); // set by PyArg_ParseTuple() PyObject* object {}; if (PyArg_ParseTuple(args, "O!", &(QuantityPy::Type), &object)) { *self = *(static_cast(object)->getQuantityPtr()); return 0; } PyErr_Clear(); // set by PyArg_ParseTuple() double f = std::numeric_limits::max(); if (PyArg_ParseTuple(args, "dO!", &f, &(UnitPy::Type), &object)) { *self = Quantity(f, *(static_cast(object)->getUnitPtr())); return 0; } PyErr_Clear(); // set by PyArg_ParseTuple() if (PyArg_ParseTuple(args, "dO!", &f, &(QuantityPy::Type), &object)) { PyErr_SetString(PyExc_TypeError, "Second argument must be a Unit not a Quantity"); return -1; } PyErr_Clear(); // set by PyArg_ParseTuple() int i1 {0}; int i2 {0}; int i3 {0}; int i4 {0}; int i5 {0}; int i6 {0}; int i7 {0}; int i8 {0}; if (PyArg_ParseTuple(args, "|diiiiiiii", &f, &i1, &i2, &i3, &i4, &i5, &i6, &i7, &i8)) { if (f < std::numeric_limits::max()) { *self = Quantity {f, Unit(i1, i2, i3, i4, i5, i6, i7, i8)}; } return 0; } PyErr_Clear(); // set by PyArg_ParseTuple() char* string {}; if (PyArg_ParseTuple(args, "et", "utf-8", &string)) { std::string str(string); PyMem_Free(string); try { *self = Quantity::parse(str); } catch (const ParserError& e) { PyErr_SetString(PyExc_ValueError, e.what()); return -1; } return 0; } PyErr_Clear(); // set by PyArg_ParseTuple() if (PyArg_ParseTuple(args, "det", &f, "utf-8", &string)) { std::string str(string); PyMem_Free(string); try { *self = Quantity(f, str); } catch (const ParserError& e) { PyErr_SetString(PyExc_ValueError, e.what()); return -1; } return 0; } PyErr_SetString(PyExc_TypeError, "Either quantity, float with units or string expected"); return -1; } PyObject* QuantityPy::getUserPreferred(PyObject* /*args*/) const { std::string uus; double factor {}; Py::Tuple res(3); auto uss = getQuantityPtr()->getUserString(factor, uus); res[0] = Py::String(uss, "utf-8"); res[1] = Py::Float(factor); res[2] = Py::String(uus, "utf-8"); return Py::new_reference_to(res); } PyObject* QuantityPy::getValueAs(PyObject* args) const { auto tryQuantity = [&]() -> std::optional { PyObject* object {}; if (!PyArg_ParseTuple(args, "O!", &(QuantityPy::Type), &object)) { return std::nullopt; } return *static_cast(object)->getQuantityPtr(); }; auto tryUnit = [&]() -> std::optional { PyObject* object {}; if (!PyArg_ParseTuple(args, "O!", &(UnitPy::Type), &object)) { return std::nullopt; } return Quantity {1.0, *static_cast(object)->getUnitPtr()}; }; auto tryUnitAndValue = [&]() -> std::optional { PyObject* object {}; double value {}; if (!PyArg_ParseTuple(args, "dO!", &value, &(UnitPy::Type), &object)) { return std::nullopt; } return Quantity {value, *static_cast(object)->getUnitPtr()}; }; auto tryUnitPartsAndValue = [&]() -> std::optional { double f; int i1 {0}; int i2 {0}; int i3 {0}; int i4 {0}; int i5 {0}; int i6 {0}; int i7 {0}; int i8 {0}; if (!PyArg_ParseTuple(args, "d|iiiiiiii", &f, &i1, &i2, &i3, &i4, &i5, &i6, &i7, &i8)) { return std::nullopt; } return Quantity {f, Unit(i1, i2, i3, i4, i5, i6, i7, i8)}; }; auto tryString = [&]() -> std::optional { char* string {}; if (!PyArg_ParseTuple(args, "et", "utf-8", &string)) { return std::nullopt; } const std::string str {string}; PyMem_Free(string); return Quantity::parse(str); }; const std::vector()>> funcs = {tryQuantity, tryUnit, tryUnitAndValue, tryUnitPartsAndValue, tryString}; auto tryFuncs = [&]() -> std::optional { for (const auto& func : funcs) { PyErr_Clear(); if (auto quant = func(); quant.has_value()) { return quant; } } return std::nullopt; }; auto checkQuant = [&](const Quantity& quant) -> bool { auto err = [&](const std::string& str) { PyErr_SetString(PyExc_ValueError, str.c_str()); }; const auto* qPtr = getQuantityPtr(); if (!qPtr) { err("QuantityPtr is null"); return false; } const auto qpUnit = qPtr->getUnit(); if (const auto qUnit = quant.getUnit(); qUnit != qpUnit) { err("Unit mismatch (`" + qUnit.getString() + "` != `" + qpUnit.getString() + "`)"); return false; } return true; }; //---------------------------------------------------------------------------------------------- const auto optQuant = tryFuncs(); if (!optQuant.has_value()) { PyErr_SetString(PyExc_TypeError, "Expected quantity, string, float or unit"); return nullptr; } const auto quant = optQuant.value(); if (!quant.isDimensionless()) { if (!checkQuant(quant)) { return nullptr; } } return new QuantityPy(new Quantity(getQuantityPtr()->getValue() / quant.getValue())); } PyObject* QuantityPy::__round__(PyObject* args) const { double val = getQuantityPtr()->getValue(); Unit unit = getQuantityPtr()->getUnit(); Py::Float flt(val); Py::Callable func(flt.getAttr("__round__")); double rnd = static_cast(Py::Float(func.apply(args))); return new QuantityPy(new Quantity(rnd, unit)); } PyObject* QuantityPy::number_float_handler(PyObject* self) { if (!PyObject_TypeCheck(self, &(QuantityPy::Type))) { PyErr_SetString(PyExc_TypeError, "Arg must be Quantity"); return nullptr; } QuantityPy* q = static_cast(self); return PyFloat_FromDouble(q->getValue()); } PyObject* QuantityPy::number_int_handler(PyObject* self) { if (!PyObject_TypeCheck(self, &(QuantityPy::Type))) { PyErr_SetString(PyExc_TypeError, "Arg must be Quantity"); return nullptr; } QuantityPy* q = static_cast(self); return PyLong_FromLong(long(q->getValue())); } PyObject* QuantityPy::number_negative_handler(PyObject* self) { if (!PyObject_TypeCheck(self, &(QuantityPy::Type))) { PyErr_SetString(PyExc_TypeError, "Arg must be Quantity"); return nullptr; } Quantity* a = static_cast(self)->getQuantityPtr(); double b = -1; return new QuantityPy(new Quantity(*a * b)); } PyObject* QuantityPy::number_positive_handler(PyObject* self) { if (!PyObject_TypeCheck(self, &(QuantityPy::Type))) { PyErr_SetString(PyExc_TypeError, "Arg must be Quantity"); return nullptr; } Quantity* a = static_cast(self)->getQuantityPtr(); return new QuantityPy(new Quantity(*a)); } PyObject* QuantityPy::number_absolute_handler(PyObject* self) { if (!PyObject_TypeCheck(self, &(QuantityPy::Type))) { PyErr_SetString(PyExc_TypeError, "Arg must be Quantity"); return nullptr; } Quantity* a = static_cast(self)->getQuantityPtr(); return new QuantityPy(new Quantity(fabs(a->getValue()), a->getUnit())); } static Quantity& pyToQuantity(Quantity& q, PyObject* pyobj) { if (PyObject_TypeCheck(pyobj, &QuantityPy::Type)) { q = *static_cast(pyobj)->getQuantityPtr(); } else if (PyFloat_Check(pyobj)) { q = Quantity(PyFloat_AsDouble(pyobj)); } else if (PyLong_Check(pyobj)) { q = Quantity(PyLong_AsLong(pyobj)); } else { PyErr_Format(PyExc_TypeError, "Cannot convert %s to Quantity", Py_TYPE(pyobj)->tp_name); throw Py::Exception(); } return q; } PyObject* QuantityPy::number_add_handler(PyObject* self, PyObject* other) { Quantity* pa = nullptr; Quantity* pb = nullptr; Quantity a; Quantity b; PY_TRY { if (PyObject_TypeCheck(self, &(QuantityPy::Type))) { pa = static_cast(self)->getQuantityPtr(); } else { pa = &pyToQuantity(a, self); } if (PyObject_TypeCheck(other, &(QuantityPy::Type))) { pb = static_cast(other)->getQuantityPtr(); } else { pb = &pyToQuantity(b, other); } return new QuantityPy(new Quantity(*pa + *pb)); } PY_CATCH } PyObject* QuantityPy::number_subtract_handler(PyObject* self, PyObject* other) { Quantity* pa = nullptr; Quantity* pb = nullptr; Quantity a; Quantity b; PY_TRY { if (PyObject_TypeCheck(self, &(QuantityPy::Type))) { pa = static_cast(self)->getQuantityPtr(); } else { pa = &pyToQuantity(a, self); } if (PyObject_TypeCheck(other, &(QuantityPy::Type))) { pb = static_cast(other)->getQuantityPtr(); } else { pb = &pyToQuantity(b, other); } return new QuantityPy(new Quantity(*pa - *pb)); } PY_CATCH } PyObject* QuantityPy::number_multiply_handler(PyObject* self, PyObject* other) { Quantity* pa = nullptr; Quantity* pb = nullptr; Quantity a; Quantity b; PY_TRY { if (PyObject_TypeCheck(self, &(QuantityPy::Type))) { pa = static_cast(self)->getQuantityPtr(); } else { pa = &pyToQuantity(a, self); } if (PyObject_TypeCheck(other, &(QuantityPy::Type))) { pb = static_cast(other)->getQuantityPtr(); } else { pb = &pyToQuantity(b, other); } return new QuantityPy(new Quantity(*pa * *pb)); } PY_CATCH } PyObject* QuantityPy::number_divide_handler(PyObject* self, PyObject* other) { Quantity* pa = nullptr; Quantity* pb = nullptr; Quantity a; Quantity b; PY_TRY { if (PyObject_TypeCheck(self, &(QuantityPy::Type))) { pa = static_cast(self)->getQuantityPtr(); } else { pa = &pyToQuantity(a, self); } if (PyObject_TypeCheck(other, &(QuantityPy::Type))) { pb = static_cast(other)->getQuantityPtr(); } else { pb = &pyToQuantity(b, other); } return new QuantityPy(new Quantity(*pa / *pb)); } PY_CATCH } PyObject* QuantityPy::number_remainder_handler(PyObject* self, PyObject* other) { if (!PyObject_TypeCheck(self, &(QuantityPy::Type))) { PyErr_SetString(PyExc_TypeError, "First arg must be Quantity"); return nullptr; } double d1 {}; double d2 {}; Quantity* a = static_cast(self)->getQuantityPtr(); d1 = a->getValue(); if (PyObject_TypeCheck(other, &(QuantityPy::Type))) { Quantity* b = static_cast(other)->getQuantityPtr(); d2 = b->getValue(); } else if (PyFloat_Check(other)) { d2 = PyFloat_AsDouble(other); } else if (PyLong_Check(other)) { d2 = (double)PyLong_AsLong(other); } else { PyErr_SetString(PyExc_TypeError, "Expected quantity or number"); return nullptr; } PyObject* p1 = PyFloat_FromDouble(d1); PyObject* p2 = PyFloat_FromDouble(d2); PyObject* r = PyNumber_Remainder(p1, p2); Py_DECREF(p1); Py_DECREF(p2); if (!r) { return nullptr; } double q = PyFloat_AsDouble(r); Py_DECREF(r); return new QuantityPy(new Quantity(q, a->getUnit())); } PyObject* QuantityPy::number_divmod_handler(PyObject* /*self*/, PyObject* /*other*/) { // PyNumber_Divmod(); PyErr_SetString(PyExc_NotImplementedError, "Not implemented"); return nullptr; } PyObject* QuantityPy::number_power_handler(PyObject* self, PyObject* other, PyObject* /*modulo*/) { if (!PyObject_TypeCheck(self, &(QuantityPy::Type))) { PyErr_SetString(PyExc_TypeError, "First arg must be Quantity"); return nullptr; } PY_TRY { if (PyObject_TypeCheck(other, &(QuantityPy::Type))) { Quantity* a = static_cast(self)->getQuantityPtr(); Quantity* b = static_cast(other)->getQuantityPtr(); Quantity q(a->pow(*b)); // to prevent memory leak in case of exception return new QuantityPy(new Quantity(q)); } if (PyFloat_Check(other)) { Quantity* a = static_cast(self)->getQuantityPtr(); double b = PyFloat_AsDouble(other); return new QuantityPy(new Quantity(a->pow(b))); } if (PyLong_Check(other)) { Quantity* a = static_cast(self)->getQuantityPtr(); double b = (double)PyLong_AsLong(other); return new QuantityPy(new Quantity(a->pow(b))); } PyErr_SetString(PyExc_TypeError, "Expected quantity or number"); return nullptr; } PY_CATCH } int QuantityPy::number_nonzero_handler(PyObject* self) { if (!PyObject_TypeCheck(self, &(QuantityPy::Type))) { return 1; } Quantity* a = static_cast(self)->getQuantityPtr(); return a->getValue() != 0.0; } PyObject* QuantityPy::richCompare(PyObject* v, PyObject* w, int op) { if (PyObject_TypeCheck(v, &(QuantityPy::Type)) && PyObject_TypeCheck(w, &(QuantityPy::Type))) { const Quantity* u1 = static_cast(v)->getQuantityPtr(); const Quantity* u2 = static_cast(w)->getQuantityPtr(); PyObject* res = nullptr; switch (op) { case Py_NE: res = (!(*u1 == *u2)) ? Py_True : Py_False; Py_INCREF(res); return res; case Py_LT: res = (*u1 < *u2) ? Py_True : Py_False; Py_INCREF(res); return res; case Py_LE: res = (*u1 < *u2) || (*u1 == *u2) ? Py_True : Py_False; Py_INCREF(res); return res; case Py_GT: res = (!(*u1 < *u2)) && (!(*u1 == *u2)) ? Py_True : Py_False; Py_INCREF(res); return res; case Py_GE: res = (!(*u1 < *u2)) ? Py_True : Py_False; Py_INCREF(res); return res; case Py_EQ: res = (*u1 == *u2) ? Py_True : Py_False; Py_INCREF(res); return res; } } else if (PyNumber_Check(v) && PyNumber_Check(w)) { // Try to get floating numbers double u1 = PyFloat_AsDouble(v); double u2 = PyFloat_AsDouble(w); PyObject* res = nullptr; switch (op) { case Py_NE: res = (u1 != u2) ? Py_True : Py_False; Py_INCREF(res); return res; case Py_LT: res = (u1 < u2) ? Py_True : Py_False; Py_INCREF(res); return res; case Py_LE: res = (u1 <= u2) ? Py_True : Py_False; Py_INCREF(res); return res; case Py_GT: res = (u1 > u2) ? Py_True : Py_False; Py_INCREF(res); return res; case Py_GE: res = (u1 >= u2) ? Py_True : Py_False; Py_INCREF(res); return res; case Py_EQ: res = (u1 == u2) ? Py_True : Py_False; Py_INCREF(res); return res; } } // This always returns False Py_INCREF(Py_NotImplemented); return Py_NotImplemented; } Py::Float QuantityPy::getValue() const { return Py::Float(getQuantityPtr()->getValue()); } void QuantityPy::setValue(Py::Float arg) { getQuantityPtr()->setValue(arg); } Py::Object QuantityPy::getUnit() const { return Py::asObject(new UnitPy(new Unit(getQuantityPtr()->getUnit()))); } void QuantityPy::setUnit(Py::Object arg) { Py::Type UnitType(getTypeAsObject(&UnitPy::Type)); if (!arg.isType(UnitType)) { throw Py::AttributeError("Not yet implemented"); } getQuantityPtr()->setUnit(*static_cast((*arg))->getUnitPtr()); } Py::String QuantityPy::getUserString() const { return {getQuantityPtr()->getUserString(), "utf-8"}; } Py::Dict QuantityPy::getFormat() const { QuantityFormat fmt = getQuantityPtr()->getFormat(); Py::Dict dict; dict.setItem("Precision", Py::Long(fmt.precision)); dict.setItem("NumberFormat", Py::Char(fmt.toFormat())); dict.setItem("Denominator", Py::Long(fmt.denominator)); return dict; } void QuantityPy::setFormat(Py::Dict arg) { QuantityFormat fmt = getQuantityPtr()->getFormat(); if (arg.hasKey("Precision")) { Py::Long prec(arg.getItem("Precision")); fmt.precision = static_cast(prec); } if (arg.hasKey("NumberFormat")) { Py::Object item = arg.getItem("NumberFormat"); if (item.isNumeric()) { int format = static_cast(Py::Long(item)); if (format < 0 || format > QuantityFormat::Scientific) { throw Py::ValueError("Invalid format value"); } fmt.format = static_cast(format); } else { Py::Char form(item); std::string fmtstr = static_cast(Py::String(form)); if (fmtstr.size() != 1) { throw Py::ValueError("Invalid format character"); } bool ok = false; fmt.format = QuantityFormat::toFormat(fmtstr[0], &ok); if (!ok) { throw Py::ValueError("Invalid format character"); } } } if (arg.hasKey("Denominator")) { Py::Long denom(arg.getItem("Denominator")); int fracInch = static_cast(denom); // check that the value is positive and a power of 2 if (fracInch <= 0) { throw Py::ValueError("Denominator must be higher than zero"); } // bitwise check if (fracInch & (fracInch - 1)) { throw Py::ValueError("Denominator must be a power of two"); } fmt.denominator = fracInch; } getQuantityPtr()->setFormat(fmt); } PyObject* QuantityPy::getCustomAttributes(const char* attr) const { QuantityPy* py = nullptr; if (strcmp(attr, "Torr") == 0) { py = new QuantityPy(new Quantity(Quantity::Torr)); } else if (strcmp(attr, "mTorr") == 0) { py = new QuantityPy(new Quantity(Quantity::mTorr)); } else if (strcmp(attr, "yTorr") == 0) { py = new QuantityPy(new Quantity(Quantity::yTorr)); } else if (strcmp(attr, "PoundForce") == 0) { py = new QuantityPy(new Quantity(Quantity::PoundForce)); } else if (strcmp(attr, "AngularMinute") == 0) { py = new QuantityPy(new Quantity(Quantity::AngMinute)); } else if (strcmp(attr, "AngularSecond") == 0) { py = new QuantityPy(new Quantity(Quantity::AngSecond)); } if (py) { py->setNotTracking(); } return py; } int QuantityPy::setCustomAttributes(const char* /*attr*/, PyObject* /*obj*/) { return 0; } PyObject* QuantityPy::number_invert_handler(PyObject* /*self*/) { PyErr_SetString(PyExc_TypeError, "bad operand type for unary ~"); return nullptr; } PyObject* QuantityPy::number_lshift_handler(PyObject* /*self*/, PyObject* /*other*/) { PyErr_SetString(PyExc_TypeError, "unsupported operand type(s) for <<"); return nullptr; } PyObject* QuantityPy::number_rshift_handler(PyObject* /*self*/, PyObject* /*other*/) { PyErr_SetString(PyExc_TypeError, "unsupported operand type(s) for >>"); return nullptr; } PyObject* QuantityPy::number_and_handler(PyObject* /*self*/, PyObject* /*other*/) { PyErr_SetString(PyExc_TypeError, "unsupported operand type(s) for &"); return nullptr; } PyObject* QuantityPy::number_xor_handler(PyObject* /*self*/, PyObject* /*other*/) { PyErr_SetString(PyExc_TypeError, "unsupported operand type(s) for ^"); return nullptr; } PyObject* QuantityPy::number_or_handler(PyObject* /*self*/, PyObject* /*other*/) { PyErr_SetString(PyExc_TypeError, "unsupported operand type(s) for |"); return nullptr; }