Files
create/src/Mod/Import/App/AppImportPy.cpp
wmayer abda1438ad Import: code-refactoring and clean-up
* Add new method ExportOCAF::exportObjects() to avoid code duplication
* Simplify handling of arguments passed to Python handler
* Fix several lint warnings
* Move ImportOCAFExt to the corresponding source files
2023-10-01 22:23:57 +02:00

632 lines
24 KiB
C++

/***************************************************************************
* Copyright (c) 2013 Werner Mayer <wmayer[at]users.sourceforge.net> *
* *
* 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"
#if defined(__MINGW32__)
#define WNT // avoid conflict with GUID
#endif
#ifndef _PreComp_
#include <climits>
#if defined(__clang__)
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wextra-semi"
#endif
#include <Interface_Static.hxx>
#include <OSD_Exception.hxx>
#include <Standard_Version.hxx>
#include <TColStd_IndexedDataMapOfStringString.hxx>
#include <TDocStd_Document.hxx>
#include <Transfer_TransientProcess.hxx>
#include <XCAFApp_Application.hxx>
#include <XCAFDoc_DocumentTool.hxx>
#include <XSControl_TransferReader.hxx>
#include <XSControl_WorkSession.hxx>
#if OCC_VERSION_HEX >= 0x070500
#include <Message_ProgressRange.hxx>
#endif
#if defined(__clang__)
#pragma clang diagnostic pop
#endif
#endif
#include "dxf/ImpExpDxf.h"
#include <App/Application.h>
#include <App/Document.h>
#include <App/DocumentObjectPy.h>
#include <Base/Console.h>
#include <Base/PyWrapParseTupleAndKeywords.h>
#include <Mod/Part/App/ImportIges.h>
#include <Mod/Part/App/ImportStep.h>
#include <Mod/Part/App/Interface.h>
#include <Mod/Part/App/OCAF/ImportExportSettings.h>
#include <Mod/Part/App/PartFeaturePy.h>
#include <Mod/Part/App/ProgressIndicator.h>
#include <Mod/Part/App/TopoShapePy.h>
#include <Mod/Part/App/encodeFilename.h>
#include "ImportOCAF2.h"
#include "ReaderGltf.h"
#include "ReaderIges.h"
#include "ReaderStep.h"
#include "WriterGltf.h"
#include "WriterIges.h"
#include "WriterStep.h"
namespace Import
{
class Module: public Py::ExtensionModule<Module>
{
public:
Module()
: Py::ExtensionModule<Module>("Import")
{
add_keyword_method("open",
&Module::importer,
"open(string) -- Open the file and create a new document.");
add_keyword_method("insert",
&Module::importer,
"insert(string,string) -- Insert the file into the given document.");
add_keyword_method("export",
&Module::exporter,
"export(list,string) -- Export a list of objects into a single file.");
add_varargs_method("readDXF",
&Module::readDXF,
"readDXF(filename,[document,ignore_errors,option_source]): Imports a "
"DXF file into the given document. ignore_errors is True by default.");
add_varargs_method("writeDXFShape",
&Module::writeDXFShape,
"writeDXFShape([shape],filename [version,usePolyline,optionSource]): "
"Exports Shape(s) to a DXF file.");
add_varargs_method(
"writeDXFObject",
&Module::writeDXFObject,
"writeDXFObject([objects],filename [,version,usePolyline,optionSource]): Exports "
"DocumentObject(s) to a DXF file.");
initialize("This module is the Import module."); // register with Python
}
~Module() override = default;
private:
Py::Object importer(const Py::Tuple& args, const Py::Dict& kwds)
{
char* Name = nullptr;
char* DocName = nullptr;
PyObject* importHidden = Py_None;
PyObject* merge = Py_None;
PyObject* useLinkGroup = Py_None;
int mode = -1;
static const std::array<const char*, 7>
kwd_list {"name", "docName", "importHidden", "merge", "useLinkGroup", "mode", nullptr};
if (!Base::Wrapped_ParseTupleAndKeywords(args.ptr(),
kwds.ptr(),
"et|sO!O!O!i",
kwd_list,
"utf-8",
&Name,
&DocName,
&PyBool_Type,
&importHidden,
&PyBool_Type,
&merge,
&PyBool_Type,
&useLinkGroup,
&mode)) {
throw Py::Exception();
}
std::string Utf8Name = std::string(Name);
PyMem_Free(Name);
try {
Base::FileInfo file(Utf8Name.c_str());
App::Document* pcDoc = nullptr;
if (DocName) {
pcDoc = App::GetApplication().getDocument(DocName);
}
if (!pcDoc) {
pcDoc = App::GetApplication().newDocument();
}
Handle(XCAFApp_Application) hApp = XCAFApp_Application::GetApplication();
Handle(TDocStd_Document) hDoc;
hApp->NewDocument(TCollection_ExtendedString("MDTV-CAF"), hDoc);
if (file.hasExtension({"stp", "step"})) {
try {
Import::ReaderStep reader(file);
reader.read(hDoc);
}
catch (OSD_Exception& e) {
Base::Console().Error("%s\n", e.GetMessageString());
Base::Console().Message("Try to load STEP file without colors...\n");
Part::ImportStepParts(pcDoc, Utf8Name.c_str());
pcDoc->recompute();
}
}
else if (file.hasExtension({"igs", "iges"})) {
try {
Import::ReaderIges reader(file);
reader.read(hDoc);
}
catch (OSD_Exception& e) {
Base::Console().Error("%s\n", e.GetMessageString());
Base::Console().Message("Try to load IGES file without colors...\n");
Part::ImportIgesParts(pcDoc, Utf8Name.c_str());
pcDoc->recompute();
}
}
else if (file.hasExtension({"glb", "gltf"})) {
Import::ReaderGltf reader(file);
reader.read(hDoc);
}
else {
throw Py::Exception(PyExc_IOError, "no supported file format");
}
ImportOCAFExt ocaf(hDoc, pcDoc, file.fileNamePure());
ocaf.setImportOptions(ImportOCAFExt::customImportOptions());
if (merge != Py_None) {
ocaf.setMerge(Base::asBoolean(merge));
}
if (importHidden != Py_None) {
ocaf.setImportHiddenObject(Base::asBoolean(importHidden));
}
if (useLinkGroup != Py_None) {
ocaf.setUseLinkGroup(Base::asBoolean(useLinkGroup));
}
if (mode >= 0) {
ocaf.setMode(mode);
}
ocaf.loadShapes();
hApp->Close(hDoc);
if (!ocaf.partColors.empty()) {
Py::List list;
for (auto& it : ocaf.partColors) {
Py::Tuple tuple(2);
tuple.setItem(0, Py::asObject(it.first->getPyObject()));
App::PropertyColorList colors;
colors.setValues(it.second);
tuple.setItem(1, Py::asObject(colors.getPyObject()));
list.append(tuple);
}
return list; // NOLINT
}
}
catch (Standard_Failure& e) {
throw Py::Exception(Base::PyExc_FC_GeneralError, e.GetMessageString());
}
catch (const Base::Exception& e) {
e.setPyException();
throw Py::Exception();
}
return Py::None();
}
Py::Object exporter(const Py::Tuple& args, const Py::Dict& kwds)
{
PyObject* object = nullptr;
char* Name = nullptr;
PyObject* pyexportHidden = Py_None;
PyObject* pylegacy = Py_None;
PyObject* pykeepPlacement = Py_None;
static const std::array<const char*, 6> kwd_list {"obj",
"name",
"exportHidden",
"legacy",
"keepPlacement",
nullptr};
if (!Base::Wrapped_ParseTupleAndKeywords(args.ptr(),
kwds.ptr(),
"Oet|O!O!O!",
kwd_list,
&object,
"utf-8",
&Name,
&PyBool_Type,
&pyexportHidden,
&PyBool_Type,
&pylegacy,
&PyBool_Type,
&pykeepPlacement)) {
throw Py::Exception();
}
std::string Utf8Name = std::string(Name);
PyMem_Free(Name);
// clang-format off
// determine export options
Part::OCAF::ImportExportSettings settings;
bool legacyExport = (pylegacy == Py_None ? settings.getExportLegacy()
: Base::asBoolean(pylegacy));
bool exportHidden = (pyexportHidden == Py_None ? settings.getExportHiddenObject()
: Base::asBoolean(pyexportHidden));
bool keepPlacement = (pykeepPlacement == Py_None ? settings.getExportKeepPlacement()
: Base::asBoolean(pykeepPlacement));
// clang-format on
try {
Py::Sequence list(object);
std::vector<App::DocumentObject*> objs;
for (Py::Sequence::iterator it = list.begin(); it != list.end(); ++it) {
PyObject* item = (*it).ptr();
if (PyObject_TypeCheck(item, &(App::DocumentObjectPy::Type))) {
auto pydoc = static_cast<App::DocumentObjectPy*>(item);
objs.push_back(pydoc->getDocumentObjectPtr());
}
}
Handle(XCAFApp_Application) hApp = XCAFApp_Application::GetApplication();
Handle(TDocStd_Document) hDoc;
hApp->NewDocument(TCollection_ExtendedString("MDTV-CAF"), hDoc);
Import::ExportOCAF2 ocaf(hDoc);
if (!legacyExport || !ocaf.canFallback(objs)) {
ocaf.setExportOptions(ExportOCAF2::customExportOptions());
ocaf.setExportHiddenObject(exportHidden);
ocaf.setKeepPlacement(keepPlacement);
ocaf.exportObjects(objs);
}
else {
bool keepExplicitPlacement = true;
ExportOCAFCmd ocaf(hDoc, keepExplicitPlacement);
ocaf.exportObjects(objs);
}
Base::FileInfo file(Utf8Name.c_str());
if (file.hasExtension({"stp", "step"})) {
Import::WriterStep writer(file);
writer.write(hDoc);
}
else if (file.hasExtension({"igs", "iges"})) {
Import::WriterIges writer(file);
writer.write(hDoc);
}
else if (file.hasExtension({"glb", "gltf"})) {
Import::WriterGltf writer(file);
writer.write(hDoc);
}
hApp->Close(hDoc);
}
catch (Standard_Failure& e) {
throw Py::Exception(Base::PyExc_FC_GeneralError, e.GetMessageString());
}
catch (const Base::Exception& e) {
e.setPyException();
throw Py::Exception();
}
return Py::None();
}
Py::Object readDXF(const Py::Tuple& args)
{
char* Name = nullptr;
const char* DocName = nullptr;
const char* optionSource = nullptr;
std::string defaultOptions = "User parameter:BaseApp/Preferences/Mod/Draft";
bool IgnoreErrors = true;
if (!PyArg_ParseTuple(args.ptr(),
"et|sbs",
"utf-8",
&Name,
&DocName,
&IgnoreErrors,
&optionSource)) {
throw Py::Exception();
}
std::string EncodedName = std::string(Name);
PyMem_Free(Name);
Base::FileInfo file(EncodedName.c_str());
if (!file.exists()) {
throw Py::RuntimeError("File doesn't exist");
}
if (optionSource) {
defaultOptions = optionSource;
}
App::Document* pcDoc = nullptr;
if (DocName) {
pcDoc = App::GetApplication().getDocument(DocName);
}
else {
pcDoc = App::GetApplication().getActiveDocument();
}
if (!pcDoc) {
pcDoc = App::GetApplication().newDocument(DocName);
}
try {
// read the DXF file
ImpExpDxfRead dxf_file(EncodedName, pcDoc);
dxf_file.setOptionSource(defaultOptions);
dxf_file.setOptions();
dxf_file.DoRead(IgnoreErrors);
pcDoc->recompute();
}
catch (const Standard_Failure& e) {
throw Py::RuntimeError(e.GetMessageString());
}
catch (const Base::Exception& e) {
throw Py::RuntimeError(e.what());
}
return Py::None();
}
Py::Object writeDXFShape(const Py::Tuple& args)
{
PyObject* shapeObj = nullptr;
char* fname = nullptr;
std::string filePath;
std::string layerName;
const char* optionSource = nullptr;
std::string defaultOptions = "User parameter:BaseApp/Preferences/Mod/Import";
int versionParm = -1;
bool versionOverride = false;
bool polyOverride = false;
PyObject* usePolyline = Py_False;
// handle list of shapes
if (PyArg_ParseTuple(args.ptr(),
"O!et|iOs",
&(PyList_Type),
&shapeObj,
"utf-8",
&fname,
&versionParm,
&usePolyline,
&optionSource)) {
filePath = std::string(fname);
layerName = "none";
PyMem_Free(fname);
if ((versionParm == 12) || (versionParm == 14)) {
versionOverride = true;
}
if (usePolyline == Py_True) {
polyOverride = true;
}
if (optionSource) {
defaultOptions = optionSource;
}
try {
ImpExpDxfWrite writer(filePath);
writer.setOptionSource(defaultOptions);
writer.setOptions();
if (versionOverride) {
writer.setVersion(versionParm);
}
writer.setPolyOverride(polyOverride);
writer.setLayerName(layerName);
writer.init();
Py::Sequence list(shapeObj);
for (Py::Sequence::iterator it = list.begin(); it != list.end(); ++it) {
if (PyObject_TypeCheck((*it).ptr(), &(Part::TopoShapePy::Type))) {
Part::TopoShape* ts =
static_cast<Part::TopoShapePy*>((*it).ptr())->getTopoShapePtr();
TopoDS_Shape shape = ts->getShape();
writer.exportShape(shape);
}
}
writer.endRun();
return Py::None();
}
catch (const Base::Exception& e) {
throw Py::RuntimeError(e.what());
}
}
PyErr_Clear();
if (PyArg_ParseTuple(args.ptr(),
"O!et|iOs",
&(Part::TopoShapePy::Type),
&shapeObj,
"utf-8",
&fname,
&versionParm,
&usePolyline,
&optionSource)) {
filePath = std::string(fname);
layerName = "none";
PyMem_Free(fname);
if ((versionParm == 12) || (versionParm == 14)) {
versionOverride = true;
}
if (usePolyline == Py_True) {
polyOverride = true;
}
if (optionSource) {
defaultOptions = optionSource;
}
try {
ImpExpDxfWrite writer(filePath);
writer.setOptionSource(defaultOptions);
writer.setOptions();
if (versionOverride) {
writer.setVersion(versionParm);
}
writer.setPolyOverride(polyOverride);
writer.setLayerName(layerName);
writer.init();
Part::TopoShape* obj = static_cast<Part::TopoShapePy*>(shapeObj)->getTopoShapePtr();
TopoDS_Shape shape = obj->getShape();
writer.exportShape(shape);
writer.endRun();
return Py::None();
}
catch (const Base::Exception& e) {
throw Py::RuntimeError(e.what());
}
}
throw Py::TypeError("expected ([Shape],path");
}
Py::Object writeDXFObject(const Py::Tuple& args)
{
PyObject* docObj = nullptr;
char* fname = nullptr;
std::string filePath;
std::string layerName;
const char* optionSource = nullptr;
std::string defaultOptions = "User parameter:BaseApp/Preferences/Mod/Import";
int versionParm = -1;
bool versionOverride = false;
bool polyOverride = false;
PyObject* usePolyline = Py_False;
if (PyArg_ParseTuple(args.ptr(),
"O!et|iOs",
&(PyList_Type),
&docObj,
"utf-8",
&fname,
&versionParm,
&usePolyline,
&optionSource)) {
filePath = std::string(fname);
layerName = "none";
PyMem_Free(fname);
if ((versionParm == 12) || (versionParm == 14)) {
versionOverride = true;
}
if (usePolyline == Py_True) {
polyOverride = true;
}
if (optionSource) {
defaultOptions = optionSource;
}
try {
ImpExpDxfWrite writer(filePath);
writer.setOptionSource(defaultOptions);
writer.setOptions();
if (versionOverride) {
writer.setVersion(versionParm);
}
writer.setPolyOverride(polyOverride);
writer.setLayerName(layerName);
writer.init();
Py::Sequence list(docObj);
for (Py::Sequence::iterator it = list.begin(); it != list.end(); ++it) {
if (PyObject_TypeCheck((*it).ptr(), &(Part::PartFeaturePy::Type))) {
PyObject* item = (*it).ptr();
App::DocumentObject* obj =
static_cast<App::DocumentObjectPy*>(item)->getDocumentObjectPtr();
Part::Feature* part = static_cast<Part::Feature*>(obj);
layerName = part->getNameInDocument();
writer.setLayerName(layerName);
const TopoDS_Shape& shape = part->Shape.getValue();
writer.exportShape(shape);
}
}
writer.endRun();
return Py::None();
}
catch (const Base::Exception& e) {
throw Py::RuntimeError(e.what());
}
}
PyErr_Clear();
if (PyArg_ParseTuple(args.ptr(),
"O!et|iOs",
&(App::DocumentObjectPy::Type),
&docObj,
"utf-8",
&fname,
&versionParm,
&usePolyline,
&optionSource)) {
filePath = std::string(fname);
layerName = "none";
PyMem_Free(fname);
if ((versionParm == 12) || (versionParm == 14)) {
versionOverride = true;
}
if (usePolyline == Py_True) {
polyOverride = true;
}
if (optionSource) {
defaultOptions = optionSource;
}
try {
ImpExpDxfWrite writer(filePath);
writer.setOptionSource(defaultOptions);
writer.setOptions();
if (versionOverride) {
writer.setVersion(versionParm);
}
writer.setPolyOverride(polyOverride);
writer.setLayerName(layerName);
writer.init();
App::DocumentObject* obj =
static_cast<App::DocumentObjectPy*>(docObj)->getDocumentObjectPtr();
Part::Feature* part = static_cast<Part::Feature*>(obj);
layerName = part->getNameInDocument();
writer.setLayerName(layerName);
const TopoDS_Shape& shape = part->Shape.getValue();
writer.exportShape(shape);
writer.endRun();
return Py::None();
}
catch (const Base::Exception& e) {
throw Py::RuntimeError(e.what());
}
}
throw Py::TypeError("expected ([DocObject],path");
}
};
PyObject* initModule()
{
return Base::Interpreter().addModule(new Module);
}
} // namespace Import