/*************************************************************************** * Copyright (c) 2007 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" #include #include #include "DocumentObject.h" #include "Document.h" #include "ExpressionParser.h" #include "GeoFeature.h" #include "GeoFeatureGroupExtension.h" #include "GroupExtension.h" // inclusion of the generated files (generated out of DocumentObjectPy.xml) #include #include using namespace App; // returns a string which represent the object e.g. when printed in python std::string DocumentObjectPy::representation(void) const { DocumentObject* object = this->getDocumentObjectPtr(); std::stringstream str; str << "<" << object->getTypeId().getName() << " object>"; return str.str(); } Py::String DocumentObjectPy::getName(void) const { DocumentObject* object = this->getDocumentObjectPtr(); const char* internal = object->getNameInDocument(); if (!internal) { throw Py::RuntimeError(std::string("This object is currently not part of a document")); } return Py::String(std::string(internal)); } Py::String DocumentObjectPy::getFullName(void) const { return Py::String(getDocumentObjectPtr()->getFullName()); } Py::Object DocumentObjectPy::getDocument(void) const { DocumentObject* object = this->getDocumentObjectPtr(); Document* doc = object->getDocument(); if (!doc) { return Py::None(); } else { return Py::Object(doc->getPyObject(), true); } } PyObject* DocumentObjectPy::addProperty(PyObject *args) { char *sType,*sName=nullptr,*sGroup=nullptr,*sDoc=nullptr; short attr=0; std::string sDocStr; PyObject *ro = Py_False, *hd = Py_False; if (!PyArg_ParseTuple(args, "s|ssethO!O!", &sType,&sName,&sGroup,"utf-8",&sDoc,&attr, &PyBool_Type, &ro, &PyBool_Type, &hd)) return nullptr; if (sDoc) { sDocStr = sDoc; PyMem_Free(sDoc); } getDocumentObjectPtr()->addDynamicProperty(sType,sName,sGroup,sDocStr.c_str(),attr, PyObject_IsTrue(ro) ? true : false, PyObject_IsTrue(hd) ? true : false); return Py::new_reference_to(this); } PyObject* DocumentObjectPy::removeProperty(PyObject *args) { char *sName; if (!PyArg_ParseTuple(args, "s", &sName)) return nullptr; bool ok = getDocumentObjectPtr()->removeDynamicProperty(sName); return Py_BuildValue("O", (ok ? Py_True : Py_False)); } PyObject* DocumentObjectPy::supportedProperties(PyObject *args) { if (!PyArg_ParseTuple(args, "")) return nullptr; std::vector ary; Base::Type::getAllDerivedFrom(App::Property::getClassTypeId(), ary); Py::List res; for (std::vector::iterator it = ary.begin(); it != ary.end(); ++it) { Base::BaseClass *data = static_cast(it->createInstance()); if (data) { delete data; res.append(Py::String(it->getName())); } } return Py::new_reference_to(res); } PyObject* DocumentObjectPy::touch(PyObject * args) { char *propName = nullptr; if (!PyArg_ParseTuple(args, "|s",&propName)) return nullptr; if(propName) { if(!propName[0]) { getDocumentObjectPtr()->touch(true); Py_Return; } auto prop = getDocumentObjectPtr()->getPropertyByName(propName); if(!prop) throw Py::RuntimeError("Property not found"); prop->touch(); Py_Return; } getDocumentObjectPtr()->touch(); Py_Return; } PyObject* DocumentObjectPy::purgeTouched(PyObject * args) { if (!PyArg_ParseTuple(args, "")) return nullptr; getDocumentObjectPtr()->purgeTouched(); Py_Return; } PyObject* DocumentObjectPy::enforceRecompute(PyObject * args) { if (!PyArg_ParseTuple(args, "")) return nullptr; getDocumentObjectPtr()->enforceRecompute(); Py_Return; } Py::List DocumentObjectPy::getState(void) const { DocumentObject* object = this->getDocumentObjectPtr(); Py::List list; bool uptodate = true; if (object->isTouched()) { uptodate = false; list.append(Py::String("Touched")); } if (object->isError()) { uptodate = false; list.append(Py::String("Invalid")); } if (object->isRecomputing()) { uptodate = false; list.append(Py::String("Recompute")); } if (object->testStatus(App::Recompute2)) { list.append(Py::String("Recompute2")); } if (object->isRestoring()) { uptodate = false; list.append(Py::String("Restore")); } if (object->testStatus(App::Expand)){ list.append(Py::String("Expanded")); } if (object->testStatus(App::PartialObject)){ list.append(Py::String("Partial")); } if (object->testStatus(App::ObjImporting)){ list.append(Py::String("Importing")); } if (uptodate) { list.append(Py::String("Up-to-date")); } return list; } Py::Object DocumentObjectPy::getViewObject(void) const { try { PyObject *dict = PySys_GetObject("modules"); if (!dict) { return Py::None(); } // check if the FreeCADGui module is already loaded, if not then don't try to load it Py::Dict sysmod(dict); if (!sysmod.hasKey("FreeCADGui")) { return Py::None(); } // double-check that the module doesn't have a null pointer Py::Module module(PyImport_ImportModule("FreeCADGui"),true); if (module.isNull() || !module.hasAttr("getDocument")) { // in v0.14+, the GUI module can be loaded in console mode (but doesn't have all its document methods) return Py::None(); } if(!getDocumentObjectPtr()->getDocument()) { throw Py::RuntimeError("Object has no document"); } const char* internalName = getDocumentObjectPtr()->getNameInDocument(); if (!internalName) { throw Py::RuntimeError("Object has been removed from document"); } Py::Callable method(module.getAttr("getDocument")); Py::Tuple arg(1); arg.setItem(0, Py::String(getDocumentObjectPtr()->getDocument()->getName())); Py::Object doc = method.apply(arg); method = doc.getAttr("getObject"); arg.setItem(0, Py::String(internalName)); Py::Object obj = method.apply(arg); return obj; } catch (Py::Exception& e) { if (PyErr_ExceptionMatches(PyExc_ImportError)) { // the GUI is not up, hence None is returned e.clear(); return Py::None(); } // FreeCADGui is loaded, so there must be wrong something else throw; // re-throw } } Py::List DocumentObjectPy::getInList(void) const { Py::List ret; std::vector list = getDocumentObjectPtr()->getInList(); for (std::vector::iterator It=list.begin();It!=list.end();++It) ret.append(Py::Object((*It)->getPyObject(), true)); return ret; } Py::List DocumentObjectPy::getInListRecursive(void) const { Py::List ret; try { std::vector list = getDocumentObjectPtr()->getInListRecursive(); for (std::vector::iterator It = list.begin(); It != list.end(); ++It) ret.append(Py::Object((*It)->getPyObject(), true)); } catch (const Base::Exception& e) { throw Py::IndexError(e.what()); } return ret; } Py::List DocumentObjectPy::getOutList(void) const { Py::List ret; std::vector list = getDocumentObjectPtr()->getOutList(); for (std::vector::iterator It=list.begin();It!=list.end();++It) ret.append(Py::Object((*It)->getPyObject(), true)); return ret; } Py::List DocumentObjectPy::getOutListRecursive(void) const { Py::List ret; try { std::vector list = getDocumentObjectPtr()->getOutListRecursive(); // create the python list for the output for (std::vector::iterator It = list.begin(); It != list.end(); ++It) ret.append(Py::Object((*It)->getPyObject(), true)); } catch (const Base::Exception& e) { throw Py::IndexError(e.what()); } return ret; } PyObject* DocumentObjectPy::setExpression(PyObject * args) { char * path = nullptr; PyObject * expr; char * comment = nullptr; if (!PyArg_ParseTuple(args, "sO|s", &path, &expr, &comment)) return nullptr; App::ObjectIdentifier p(ObjectIdentifier::parse(getDocumentObjectPtr(), path)); if (Py::Object(expr).isNone()) { getDocumentObjectPtr()->clearExpression(p); Py_Return; } else if (PyUnicode_Check(expr)) { const char * exprStr = PyUnicode_AsUTF8(expr); std::shared_ptr shared_expr(Expression::parse(getDocumentObjectPtr(), exprStr)); if (shared_expr && comment) shared_expr->comment = comment; getDocumentObjectPtr()->setExpression(p, shared_expr); Py_Return; } throw Py::TypeError("String or None expected."); } PyObject* DocumentObjectPy::clearExpression(PyObject * args) { char * path = nullptr; if (!PyArg_ParseTuple(args, "s", &path)) return nullptr; App::ObjectIdentifier p(ObjectIdentifier::parse(getDocumentObjectPtr(), path)); getDocumentObjectPtr()->clearExpression(p); Py_Return; } PyObject* DocumentObjectPy::evalExpression(PyObject *self, PyObject * args) { const char *expr; if (!PyArg_ParseTuple(args, "s", &expr)) return nullptr; // HINT: // The standard behaviour of Python for class methods is to always pass the class // object as first argument. // For FreeCAD-specific types the behaviour is a bit different: // When calling this method for an instance then this is passed as first argument // and otherwise the class object is passed. // This behaviour is achieved by the function _getattr() that passed 'this' to // PyCFunction_New(). // // evalExpression() is a class method and thus 'self' can either be an instance of // DocumentObjectPy or a type object. App::DocumentObject* obj = nullptr; if (self && PyObject_TypeCheck(self, &DocumentObjectPy::Type)) { obj = static_cast(self)->getDocumentObjectPtr(); } PY_TRY { std::shared_ptr shared_expr(Expression::parse(obj, expr)); if (shared_expr) return Py::new_reference_to(shared_expr->getPyValue()); Py_Return; } PY_CATCH } PyObject* DocumentObjectPy::recompute(PyObject *args) { PyObject *recursive=Py_False; if (!PyArg_ParseTuple(args, "|O",&recursive)) return nullptr; try { bool ok = getDocumentObjectPtr()->recomputeFeature(PyObject_IsTrue(recursive)); return Py_BuildValue("O", (ok ? Py_True : Py_False)); } catch (const Base::Exception& e) { throw Py::RuntimeError(e.what()); } } PyObject* DocumentObjectPy::isValid(PyObject *args) { if (!PyArg_ParseTuple(args, "")) return nullptr; try { bool ok = getDocumentObjectPtr()->isValid(); return Py_BuildValue("O", (ok ? Py_True : Py_False)); } catch (const Base::Exception& e) { throw Py::RuntimeError(e.what()); } } PyObject* DocumentObjectPy::getStatusString(PyObject *args) { if (!PyArg_ParseTuple(args, "")) return nullptr; try { Py::String text(getDocumentObjectPtr()->getStatusString()); return Py::new_reference_to(text); } catch (const Base::Exception& e) { throw Py::RuntimeError(e.what()); } } PyObject* DocumentObjectPy::getSubObject(PyObject *args, PyObject *keywds) { enum class ReturnType { PyObject = 0, DocObject = 1, DocAndPyObject = 2, Placement = 3, Matrix = 4, LinkAndPlacement = 5, LinkAndMatrix = 6 }; PyObject *obj; short retType = 0; PyObject *pyMat = nullptr; PyObject *doTransform = Py_True; short depth = 0; static char *kwlist[] = {"subname", "retType", "matrix", "transform", "depth", nullptr}; if (!PyArg_ParseTupleAndKeywords(args, keywds, "O|hO!Oh", kwlist, &obj, &retType, &Base::MatrixPy::Type, &pyMat, &doTransform, &depth)) return nullptr; if (retType < 0 || retType > 6) { PyErr_SetString(PyExc_ValueError, "invalid retType, can only be integer 0~6"); return nullptr; } ReturnType retEnum = ReturnType(retType); std::vector subs; bool single = true; if (PyUnicode_Check(obj)) { subs.push_back(PyUnicode_AsUTF8(obj)); } else if (PySequence_Check(obj)) { single = false; Py::Sequence shapeSeq(obj); for (Py::Sequence::iterator it = shapeSeq.begin(); it != shapeSeq.end(); ++it) { PyObject* item = (*it).ptr(); if (PyUnicode_Check(item)) { subs.push_back(PyUnicode_AsUTF8(item)); } else { PyErr_SetString(PyExc_TypeError, "non-string object in sequence"); return nullptr; } } } else { PyErr_SetString(PyExc_TypeError, "subname must be either a string or sequence of string"); return nullptr; } bool transform = PyObject_IsTrue(doTransform); struct SubInfo { App::DocumentObject *sobj; Py::Object obj; Py::Object pyObj; Base::Matrix4D mat; SubInfo(const Base::Matrix4D &mat) : sobj(nullptr), mat(mat){} }; Base::Matrix4D mat; if (pyMat) { mat = *static_cast(pyMat)->getMatrixPtr(); } PY_TRY { std::vector ret; for(const auto &sub : subs) { ret.emplace_back(mat); auto &info = ret.back(); PyObject *pyObj = nullptr; info.sobj = getDocumentObjectPtr()->getSubObject(sub.c_str(), retEnum != ReturnType::PyObject && retEnum != ReturnType::DocAndPyObject ? nullptr : &pyObj, &info.mat, transform, depth); if (pyObj) info.pyObj = Py::asObject(pyObj); if (info.sobj) info.obj = Py::asObject(info.sobj->getPyObject()); } if (ret.empty()) Py_Return; auto getReturnValue = [retEnum, pyMat](SubInfo& ret) -> Py::Object { if (retEnum == ReturnType::PyObject) return ret.pyObj; else if (retEnum == ReturnType::DocObject && !pyMat) return ret.obj; else if (!ret.sobj) return Py::None(); else if (retEnum == ReturnType::Placement) return Py::Placement(Base::Placement(ret.mat)); else if (retEnum == ReturnType::Matrix) return Py::Matrix(ret.mat); else if (retEnum == ReturnType::LinkAndPlacement || retEnum == ReturnType::LinkAndMatrix) { ret.sobj->getLinkedObject(true, &ret.mat, false); if (retEnum == ReturnType::LinkAndPlacement) return Py::Placement(Base::Placement(ret.mat)); else return Py::Matrix(ret.mat); } else { Py::Tuple rret(retEnum == ReturnType::DocObject ? 2 : 3); rret.setItem(0, ret.obj); rret.setItem(1, Py::asObject(new Base::MatrixPy(ret.mat))); if (retEnum != ReturnType::DocObject) rret.setItem(2, ret.pyObj); return rret; } }; if (single) { return Py::new_reference_to(getReturnValue(ret[0])); } Py::Tuple tuple(ret.size()); for(size_t i=0; igetSubObjectList(subname)) res.append(Py::asObject(o->getPyObject())); return Py::new_reference_to(res); }PY_CATCH } PyObject* DocumentObjectPy::getSubObjects(PyObject *args) { int reason = 0; if (!PyArg_ParseTuple(args, "|i", &reason)) return nullptr; PY_TRY { auto names = getDocumentObjectPtr()->getSubObjects(reason); Py::Tuple pyObjs(names.size()); for(size_t i=0;i(pyMat)->getMatrixPtr(); mat = &_mat; } PY_TRY { auto linked = getDocumentObjectPtr()->getLinkedObject( PyObject_IsTrue(recursive), mat, PyObject_IsTrue(transform),depth); if(!linked) linked = getDocumentObjectPtr(); auto pyObj = Py::Object(linked->getPyObject(),true); if(mat) { Py::Tuple ret(2); ret.setItem(0,pyObj); ret.setItem(1,Py::asObject(new Base::MatrixPy(*mat))); return Py::new_reference_to(ret); } return Py::new_reference_to(pyObj); } PY_CATCH; } PyObject* DocumentObjectPy::isElementVisible(PyObject *args) { char *element = nullptr; if (!PyArg_ParseTuple(args, "s", &element)) return nullptr; PY_TRY { return Py_BuildValue("h", getDocumentObjectPtr()->isElementVisible(element)); } PY_CATCH; } PyObject* DocumentObjectPy::setElementVisible(PyObject *args) { char *element = nullptr; PyObject *visible = Py_True; if (!PyArg_ParseTuple(args, "s|O", &element,&visible)) return nullptr; PY_TRY { return Py_BuildValue("h", getDocumentObjectPtr()->setElementVisible(element,PyObject_IsTrue(visible))); } PY_CATCH; } PyObject* DocumentObjectPy::hasChildElement(PyObject *args) { if (!PyArg_ParseTuple(args, "")) return nullptr; PY_TRY { return Py_BuildValue("O", getDocumentObjectPtr()->hasChildElement()?Py_True:Py_False); } PY_CATCH; } PyObject* DocumentObjectPy::getParentGroup(PyObject *args) { if (!PyArg_ParseTuple(args, "")) return nullptr; try { auto grp = GroupExtension::getGroupOfObject(getDocumentObjectPtr()); if(!grp) { Py_INCREF(Py_None); return Py_None; } return grp->getPyObject(); } catch (const Base::Exception& e) { throw Py::RuntimeError(e.what()); } } PyObject* DocumentObjectPy::getParentGeoFeatureGroup(PyObject *args) { if (!PyArg_ParseTuple(args, "")) return nullptr; try { auto grp = GeoFeatureGroupExtension::getGroupOfObject(getDocumentObjectPtr()); if(!grp) { Py_INCREF(Py_None); return Py_None; } return grp->getPyObject(); } catch (const Base::Exception& e) { throw Py::RuntimeError(e.what()); } } Py::Boolean DocumentObjectPy::getMustExecute() const { try { return Py::Boolean(getDocumentObjectPtr()->mustExecute()?true:false); } catch (const Base::Exception& e) { throw Py::RuntimeError(e.what()); } } PyObject* DocumentObjectPy::getPathsByOutList(PyObject *args) { PyObject* o; if (!PyArg_ParseTuple(args, "O!", &DocumentObjectPy::Type, &o)) return nullptr; try { DocumentObject* target = static_cast (o)->getDocumentObjectPtr(); auto array = getDocumentObjectPtr()->getPathsByOutList(target); Py::List list; for (auto it : array) { Py::List path; for (auto jt : it) { path.append(Py::asObject(jt->getPyObject())); } list.append(path); } return Py::new_reference_to(list); } catch (const Base::Exception& e) { throw Py::RuntimeError(e.what()); } } PyObject *DocumentObjectPy::getCustomAttributes(const char* attr) const { // Dynamic property is now directly supported in PropertyContainer. So we // can comment out here and let PropertyContainerPy handle it. #if 1 (void)attr; #else // search for dynamic property Property* prop = getDocumentObjectPtr()->getDynamicPropertyByName(attr); if (prop) return prop->getPyObject(); else #endif return nullptr; } int DocumentObjectPy::setCustomAttributes(const char* attr, PyObject *obj) { // The following code is practically the same as in PropertyContainerPy, // especially since now dynamic property is directly supported in // PropertyContainer. So we can comment out here and let PropertyContainerPy // handle it. #if 1 (void)attr; (void)obj; #else // explicitly search for dynamic property try { Property* prop = getDocumentObjectPtr()->getDynamicPropertyByName(attr); if (prop) { if(prop->testStatus(Property::Immutable)) { std::stringstream s; s << "'DocumentObject' attribute '" << attr << "' is read-only"; throw Py::AttributeError(s.str()); } prop->setPyObject(obj); return 1; } } catch (Base::ValueError &exc) { std::stringstream s; s << "Property '" << attr << "': " << exc.what(); throw Py::ValueError(s.str()); } catch (Base::Exception &exc) { std::stringstream s; s << "Attribute (Name: " << attr << ") error: '" << exc.what() << "' "; throw Py::AttributeError(s.str()); } catch (Py::AttributeError &) { throw; }catch (...) { std::stringstream s; s << "Unknown error in attribute " << attr; throw Py::AttributeError(s.str()); } // search in PropertyList Property *prop = getDocumentObjectPtr()->getPropertyByName(attr); if (prop) { // Read-only attributes must not be set over its Python interface if(prop->testStatus(Property::Immutable) || (getDocumentObjectPtr()->getPropertyType(prop) & Prop_ReadOnly)) { std::stringstream s; s << "'DocumentObject' attribute '" << attr << "' is read-only"; throw Py::AttributeError(s.str()); } try { prop->setPyObject(obj); } catch (const Base::TypeError& e) { std::stringstream s; s << "Property '" << prop->getName() << "': " << e.what(); throw Py::TypeError(s.str()); } return 1; } #endif return 0; } Py::Int DocumentObjectPy::getID() const { return Py::Int(getDocumentObjectPtr()->getID()); } Py::Boolean DocumentObjectPy::getRemoving() const { return Py::Boolean(getDocumentObjectPtr()->testStatus(ObjectStatus::Remove)); } PyObject *DocumentObjectPy::resolve(PyObject *args) { const char *subname; if (!PyArg_ParseTuple(args, "s",&subname)) return nullptr; PY_TRY { std::string elementName; const char *subElement = nullptr; App::DocumentObject *parent = nullptr; auto obj = getDocumentObjectPtr()->resolve(subname,&parent,&elementName,&subElement); Py::Tuple ret(4); ret.setItem(0,obj?Py::Object(obj->getPyObject(),true):Py::None()); ret.setItem(1,parent?Py::Object(parent->getPyObject(),true):Py::None()); ret.setItem(2,Py::String(elementName.c_str())); ret.setItem(3,Py::String(subElement?subElement:"")); return Py::new_reference_to(ret); } PY_CATCH; Py_Return; } PyObject *DocumentObjectPy::resolveSubElement(PyObject *args) { const char *subname; PyObject *append = Py_False; int type = 0; if (!PyArg_ParseTuple(args, "s|Oi",&subname,&append,&type)) return nullptr; PY_TRY { std::pair elementName; auto obj = GeoFeature::resolveElement(getDocumentObjectPtr(), subname,elementName, PyObject_IsTrue(append),(GeoFeature::ElementNameType)type); Py::Tuple ret(3); ret.setItem(0,obj?Py::Object(obj->getPyObject(),true):Py::None()); ret.setItem(1,Py::String(elementName.first)); ret.setItem(2,Py::String(elementName.second)); return Py::new_reference_to(ret); } PY_CATCH; Py_Return; } Py::List DocumentObjectPy::getParents() const { Py::List ret; for(auto &v : getDocumentObjectPtr()->getParents()) ret.append(Py::TupleN(Py::Object(v.first->getPyObject(),true),Py::String(v.second))); return ret; } PyObject *DocumentObjectPy::adjustRelativeLinks(PyObject *args) { PyObject *pyobj; PyObject *recursive = Py_True; if (!PyArg_ParseTuple(args, "O!|O",&DocumentObjectPy::Type,&pyobj,&recursive)) return nullptr; PY_TRY { auto obj = static_cast(pyobj)->getDocumentObjectPtr(); auto inList = obj->getInListEx(true); inList.insert(obj); std::set visited; return Py::new_reference_to(Py::Boolean( getDocumentObjectPtr()->adjustRelativeLinks(inList, PyObject_IsTrue(recursive)?&visited:nullptr))); }PY_CATCH } Py::String DocumentObjectPy::getOldLabel() const { return Py::String(getDocumentObjectPtr()->getOldLabel()); } Py::Boolean DocumentObjectPy::getNoTouch() const { return Py::Boolean(getDocumentObjectPtr()->testStatus(ObjectStatus::NoTouch)); } void DocumentObjectPy::setNoTouch(Py::Boolean value) { getDocumentObjectPtr()->setStatus(ObjectStatus::NoTouch,value.isTrue()); }