From d5f01377a5240150392d9e6acc0a9ac02e1473f5 Mon Sep 17 00:00:00 2001 From: David Carter Date: Mon, 31 Mar 2025 22:46:12 -0400 Subject: [PATCH 01/63] Material: Interface with an external module The ExternalManager class calls python functions in an external module to create, read, update, and delete material definitions. The API provided by the modules must conform to that defined in the MaterialManagerExternal.py file. All communications with the external module is routed through this class. --- src/Mod/Material/App/CMakeLists.txt | 26 + src/Mod/Material/App/ExternalManager.cpp | 788 ++++++++++++++++++ src/Mod/Material/App/ExternalManager.h | 108 +++ src/Mod/Material/App/Library.cpp | 10 + src/Mod/Material/App/Library.h | 15 +- .../MaterialAPI/MaterialManagerExternal.py | 246 ++++++ src/Mod/Material/App/MaterialAPI/__init__.py | 0 src/Mod/Material/App/MaterialManagerLocal.cpp | 12 +- 8 files changed, 1198 insertions(+), 7 deletions(-) create mode 100644 src/Mod/Material/App/ExternalManager.cpp create mode 100644 src/Mod/Material/App/ExternalManager.h create mode 100644 src/Mod/Material/App/MaterialAPI/MaterialManagerExternal.py create mode 100644 src/Mod/Material/App/MaterialAPI/__init__.py diff --git a/src/Mod/Material/App/CMakeLists.txt b/src/Mod/Material/App/CMakeLists.txt index 825242fce7..bc976d7293 100644 --- a/src/Mod/Material/App/CMakeLists.txt +++ b/src/Mod/Material/App/CMakeLists.txt @@ -6,6 +6,10 @@ endif(MSVC) add_definitions(-DYAML_CPP_STATIC_DEFINE) +if(BUILD_MATERIAL_EXTERNAL) + add_definitions(-DBUILD_MATERIAL_EXTERNAL) +endif(BUILD_MATERIAL_EXTERNAL) + include_directories( ${CMAKE_BINARY_DIR} ${CMAKE_BINARY_DIR}/src @@ -55,6 +59,11 @@ generate_from_py(MaterialProperty) generate_from_py(Model) generate_from_py(UUIDs) +SET(MaterialsAPI_Files + MaterialAPI/__init__.py + MaterialAPI/MaterialManagerExternal.py +) + SET(Python_SRCS Exceptions.h Array2D.pyi @@ -126,6 +135,12 @@ SET(Materials_SRCS PyVariants.h trim.h ) +if(BUILD_MATERIAL_EXTERNAL) + list(APPEND Materials_SRCS + ExternalManager.cpp + ExternalManager.h + ) +endif(BUILD_MATERIAL_EXTERNAL) if(FREECAD_USE_PCH) add_definitions(-D_PreComp_) @@ -143,3 +158,14 @@ SET_BIN_DIR(Materials Materials /Mod/Material) SET_PYTHON_PREFIX_SUFFIX(Materials) INSTALL(TARGETS Materials DESTINATION ${CMAKE_INSTALL_LIBDIR}) + +ADD_CUSTOM_TARGET(MaterialsAPILib ALL + SOURCES ${MaterialsAPI_Files} ${Material_QRC_SRCS} +) + +fc_target_copy_resource(MaterialsAPILib + ${CMAKE_CURRENT_SOURCE_DIR} + ${CMAKE_BINARY_DIR}/Mod/Material + ${MaterialsAPI_Files}) + +INSTALL(FILES ${MaterialsAPI_Files} DESTINATION Mod/Material/MaterialAPI) diff --git a/src/Mod/Material/App/ExternalManager.cpp b/src/Mod/Material/App/ExternalManager.cpp new file mode 100644 index 0000000000..249e049234 --- /dev/null +++ b/src/Mod/Material/App/ExternalManager.cpp @@ -0,0 +1,788 @@ +/*************************************************************************** + * Copyright (c) 2024 David Carter * + * * + * This file is part of FreeCAD. * + * * + * FreeCAD is free software: you can redistribute it and/or modify it * + * under the terms of the GNU Lesser General Public License as * + * published by the Free Software Foundation, either version 2.1 of the * + * License, or (at your option) any later version. * + * * + * FreeCAD 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 * + * Lesser General Public License for more details. * + * * + * You should have received a copy of the GNU Lesser General Public * + * License along with FreeCAD. If not, see * + * . * + * * + **************************************************************************/ + +#include "PreCompiled.h" +#ifndef _PreComp_ +#endif + +#include +#include +#include + +#include +#include +#include +#include + +#include "Exceptions.h" +#include "ExternalManager.h" +#include "MaterialLibrary.h" +#include "MaterialLibraryPy.h" +#include "MaterialPy.h" +#include "ModelLibrary.h" +#include "ModelPy.h" +#include "MaterialFilterPy.h" +#include "MaterialFilterOptionsPy.h" + + +using namespace Materials; + +/* TRANSLATOR Material::Materials */ + +ExternalManager* ExternalManager::_manager = nullptr; +QMutex ExternalManager::_mutex; + +ExternalManager::ExternalManager() + : _instantiated(false) +{ + _hGrp = App::GetApplication().GetParameterGroupByPath( + "User parameter:BaseApp/Preferences/Mod/Material/ExternalInterface"); + _hGrp->Attach(this); + + getConfiguration(); +} + +ExternalManager::~ExternalManager() +{ + _hGrp->Detach(this); +} + +void ExternalManager::OnChange(ParameterGrp::SubjectType& rCaller, ParameterGrp::MessageType Reason) +{ + const ParameterGrp& rGrp = static_cast(rCaller); + if (std::strncmp(Reason, "Current", 7) == 0) { + if (_instantiated) { + // The old manager object will be deleted when reconnecting + _instantiated = false; + } + getConfiguration(); + } +} + +void ExternalManager::getConfiguration() +{ + // _hGrp = App::GetApplication().GetParameterGroupByPath( + // "User parameter:BaseApp/Preferences/Mod/Material/ExternalInterface"); + auto current = _hGrp->GetASCII("Current", "None"); + if (current == "None") { + _moduleName = ""; + _className = ""; + } + else { + auto groupName = + "User parameter:BaseApp/Preferences/Mod/Material/ExternalInterface/Interfaces/" + + current; + auto hGrp = App::GetApplication().GetParameterGroupByPath(groupName.c_str()); + _moduleName = hGrp->GetASCII("Module", ""); + _className = hGrp->GetASCII("Class", ""); + } +} + +void ExternalManager::instantiate() +{ + _instantiated = false; + Base::Console().Log("Loading external manager...\n"); + + if (_moduleName.empty() || _className.empty()) { + Base::Console().Log("External module not defined\n"); + return; + } + + try { + Base::PyGILStateLocker lock; + Py::Module mod(PyImport_ImportModule(_moduleName.c_str()), true); + + if (mod.isNull()) { + Base::Console().Log(" failed\n"); + return; + } + + Py::Callable managerClass(mod.getAttr(_className)); + _managerObject = managerClass.apply(); + if (_managerObject.hasAttr("APIVersion")) { + _instantiated = true; + } + + if (_instantiated) { + Base::Console().Log("done\n"); + } + else { + Base::Console().Log("failed\n"); + } + } + catch (Py::Exception& e) { + Base::Console().Log("failed\n"); + e.clear(); + } +} + +void ExternalManager::connect() +{ + if (!_instantiated) { + instantiate(); + + if (!_instantiated) { + throw ConnectionError(); + } + } +} + +void ExternalManager::initManager() +{ + QMutexLocker locker(&_mutex); + + if (!_manager) { + _manager = new ExternalManager(); + } +} + +ExternalManager* ExternalManager::getManager() +{ + initManager(); + + return _manager; +} + +//===== +// +// Library management +// +//===== + +std::shared_ptr +ExternalManager::libraryFromTuple(const Py::Tuple& entry) +{ + auto pyName = entry.getItem(0); + QString libraryName; + if (!pyName.isNone()) { + libraryName = QString::fromStdString(pyName.as_string()); + } + auto pyIcon = entry.getItem(1); + QString icon; + if (!pyIcon.isNone()) { + icon = QString::fromStdString(pyIcon.as_string()); + } + auto pyReadOnly = entry.getItem(2); + bool readOnly = pyReadOnly.as_bool(); + auto pyTimestamp = entry.getItem(3); + QString timestamp; + if (!pyTimestamp.isNone()) { + timestamp = QString::fromStdString(pyTimestamp.as_string()); + } + + Base::Console().Log("Library name '%s', Icon '%s', readOnly %s, timestamp '%s'\n", + libraryName.toStdString().c_str(), + icon.toStdString().c_str(), + readOnly ? "true" : "false", + timestamp.toStdString().c_str()); + auto library = std::make_shared(libraryName, icon, readOnly, timestamp); + return library; +} + +std::shared_ptr>> +ExternalManager::libraries() +{ + auto libList = std::make_shared>>(); + + connect(); + + Base::PyGILStateLocker lock; + try { + if (_managerObject.hasAttr("libraries")) { + Py::Callable libraries(_managerObject.getAttr("libraries")); + Py::List list(libraries.apply()); + for (auto lib : list) { + auto library = libraryFromTuple(Py::Tuple(lib)); + libList->push_back(library); + } + } + else { + Base::Console().Log("\tlibraries() not found\n"); + throw ConnectionError(); + } + } + catch (Py::Exception& e) { + Base::PyException e1; // extract the Python error text + throw LibraryNotFound(e1.what()); + } + + return libList; +} + +std::shared_ptr>> ExternalManager::modelLibraries() +{ + auto libList = std::make_shared>>(); + + connect(); + + Base::PyGILStateLocker lock; + try { + if (_managerObject.hasAttr("modelLibraries")) { + Py::Callable libraries(_managerObject.getAttr("modelLibraries")); + Py::List list(libraries.apply()); + for (auto lib : list) { + auto library = libraryFromTuple(Py::Tuple(lib)); + libList->push_back(library); + } + } + else { + Base::Console().Log("\tmodelLibraries() not found\n"); + throw ConnectionError(); + } + } + catch (Py::Exception& e) { + Base::PyException e1; // extract the Python error text + throw LibraryNotFound(e1.what()); + } + + return libList; +} + +std::shared_ptr>> ExternalManager::materialLibraries() +{ + auto libList = std::make_shared>>(); + + connect(); + + Base::PyGILStateLocker lock; + try { + if (_managerObject.hasAttr("materialLibraries")) { + Py::Callable libraries(_managerObject.getAttr("materialLibraries")); + Py::List list(libraries.apply()); + for (auto lib : list) { + auto library = libraryFromTuple(Py::Tuple(lib)); + libList->push_back(library); + } + } + else { + Base::Console().Log("\tmaterialLibraries() not found\n"); + throw ConnectionError(); + } + } + catch (Py::Exception& e) { + Base::PyException e1; // extract the Python error text + throw LibraryNotFound(e1.what()); + } + + return libList; +} + +std::shared_ptr ExternalManager::getLibrary(const QString& name) +{ + // throw LibraryNotFound("Not yet implemented"); + connect(); + + Base::PyGILStateLocker lock; + try { + if (_managerObject.hasAttr("getLibrary")) { + Py::Callable libraries(_managerObject.getAttr("getLibrary")); + Py::Tuple args(1); + args.setItem(0, Py::String(name.toStdString())); + Py::Tuple result(libraries.apply(args)); + + Py::Object libObject = result.getItem(0); + auto lib = libraryFromTuple(Py::Tuple(libObject)); + return std::make_shared(*lib); + } + else { + Base::Console().Log("\tgetLibrary() not found\n"); + throw ConnectionError(); + } + } + catch (Py::Exception& e) { + Base::PyException e1; // extract the Python error text + throw CreationError(e1.what()); + } +} + +void ExternalManager::createLibrary(const QString& libraryName, const QString& icon, bool readOnly) +{ + connect(); + + Base::PyGILStateLocker lock; + try { + if (_managerObject.hasAttr("createLibrary")) { + Py::Callable libraries(_managerObject.getAttr("createLibrary")); + Py::Tuple args(3); + args.setItem(0, Py::String(libraryName.toStdString())); + args.setItem(1, Py::String(icon.toStdString())); + args.setItem(2, Py::Boolean(readOnly)); + libraries.apply(args); // No return expected + } + else { + Base::Console().Log("\tcreateLibrary() not found\n"); + throw ConnectionError(); + } + } + catch (Py::Exception& e) { + Base::PyException e1; // extract the Python error text + throw CreationError(e1.what()); + } +} + +void ExternalManager::renameLibrary(const QString& libraryName, const QString& newName) +{ + connect(); + + Base::PyGILStateLocker lock; + try { + if (_managerObject.hasAttr("renameLibrary")) { + Py::Callable libraries(_managerObject.getAttr("renameLibrary")); + Py::Tuple args(2); + args.setItem(0, Py::String(libraryName.toStdString())); + args.setItem(1, Py::String(newName.toStdString())); + libraries.apply(args); // No return expected + } + else { + Base::Console().Log("\trenameLibrary() not found\n"); + throw ConnectionError(); + } + } + catch (Py::Exception& e) { + Base::PyException e1; // extract the Python error text + throw RenameError(e1.what()); + } +} + +void ExternalManager::changeIcon(const QString& libraryName, const QString& icon) +{ + connect(); + + Base::PyGILStateLocker lock; + try { + if (_managerObject.hasAttr("changeIcon")) { + Py::Callable libraries(_managerObject.getAttr("changeIcon")); + Py::Tuple args(2); + args.setItem(0, Py::String(libraryName.toStdString())); + args.setItem(1, Py::String(icon.toStdString())); + libraries.apply(args); // No return expected + } + else { + Base::Console().Log("\tchangeIcon() not found\n"); + throw ConnectionError(); + } + } + catch (Py::Exception& e) { + Base::PyException e1; // extract the Python error text + throw ReplacementError(e1.what()); + } +} + +void ExternalManager::removeLibrary(const QString& libraryName) +{ + connect(); + + Base::PyGILStateLocker lock; + try { + if (_managerObject.hasAttr("removeLibrary")) { + Py::Callable libraries(_managerObject.getAttr("removeLibrary")); + Py::Tuple args(1); + args.setItem(0, Py::String(libraryName.toStdString())); + libraries.apply(args); // No return expected + } + else { + Base::Console().Log("\tremoveLibrary() not found\n"); + throw ConnectionError(); + } + } + catch (Py::Exception& e) { + Base::PyException e1; // extract the Python error text + throw DeleteError(e1.what()); + } +} + +std::shared_ptr>> +ExternalManager::libraryModels(const QString& libraryName) +{ + auto modelList = std::make_shared>>(); + + connect(); + + Base::PyGILStateLocker lock; + try { + if (_managerObject.hasAttr("libraryModels")) { + Py::Callable libraries(_managerObject.getAttr("libraryModels")); + Py::Tuple args(1); + args.setItem(0, Py::String(libraryName.toStdString())); + Py::List list(libraries.apply(args)); + for (auto library : list) { + auto entry = Py::Tuple(library); + + auto pyUUID = entry.getItem(0); + QString uuid; + if (!pyUUID.isNone()) { + uuid = QString::fromStdString(pyUUID.as_string()); + } + auto pyPath = entry.getItem(1); + QString path; + if (!pyPath.isNone()) { + path = QString::fromStdString(pyPath.as_string()); + } + auto pyName = entry.getItem(2); + QString name; + if (!pyName.isNone()) { + name = QString::fromStdString(pyName.as_string()); + } + + modelList->push_back(std::tuple(uuid, path, name)); + } + } + else { + Base::Console().Log("\tlibraryModels() not found\n"); + throw ConnectionError(); + } + } + catch (Py::Exception& e) { + Base::PyException e1; // extract the Python error text + throw LibraryNotFound(e1.what()); + } + + return modelList; +} + +std::shared_ptr>> +ExternalManager::libraryMaterials(const QString& libraryName) +{ + auto materialList = std::make_shared>>(); + + connect(); + + Base::PyGILStateLocker lock; + try { + if (_managerObject.hasAttr("libraryMaterials")) { + Py::Callable libraries(_managerObject.getAttr("libraryMaterials")); + Py::Tuple args(1); + args.setItem(0, Py::String(libraryName.toStdString())); + Py::List list(libraries.apply(args)); + for (auto library : list) { + auto entry = Py::Tuple(library); + + auto pyUUID = entry.getItem(0); + QString uuid; + if (!pyUUID.isNone()) { + uuid = QString::fromStdString(pyUUID.as_string()); + } + auto pyPath = entry.getItem(1); + QString path; + if (!pyPath.isNone()) { + path = QString::fromStdString(pyPath.as_string()); + } + auto pyName = entry.getItem(2); + QString name; + if (!pyName.isNone()) { + name = QString::fromStdString(pyName.as_string()); + } + + materialList->push_back(std::tuple(uuid, path, name)); + } + } + else { + Base::Console().Log("\tlibraryMaterials() not found\n"); + throw ConnectionError(); + } + } + catch (Py::Exception& e) { + Base::PyException e1; // extract the Python error text + throw LibraryNotFound(e1.what()); + } + + return materialList; +} + +std::shared_ptr>> +ExternalManager::libraryMaterials(const QString& libraryName, + const std::shared_ptr& filter, + const MaterialFilterOptions& options) +{ + auto materialList = std::make_shared>>(); + + connect(); + + Base::PyGILStateLocker lock; + try { + if (_managerObject.hasAttr("libraryMaterials")) { + Py::Callable libraries(_managerObject.getAttr("libraryMaterials")); + Py::Tuple args(3); + args.setItem(0, Py::String(libraryName.toStdString())); + if (filter) { + args.setItem(1, + Py::Object(new MaterialFilterPy(new MaterialFilter(*filter)), true)); + } + else { + args.setItem(1, Py::None()); + } + args.setItem( + 2, + Py::Object(new MaterialFilterOptionsPy(new MaterialFilterOptions(options)), true)); + Py::List list(libraries.apply(args)); + for (auto library : list) { + auto entry = Py::Tuple(library); + + auto pyUUID = entry.getItem(0); + QString uuid; + if (!pyUUID.isNone()) { + uuid = QString::fromStdString(pyUUID.as_string()); + } + auto pyPath = entry.getItem(1); + QString path; + if (!pyPath.isNone()) { + path = QString::fromStdString(pyPath.as_string()); + } + auto pyName = entry.getItem(2); + QString name; + if (!pyName.isNone()) { + name = QString::fromStdString(pyName.as_string()); + } + + materialList->push_back(std::tuple(uuid, path, name)); + } + } + else { + Base::Console().Log("\tlibraryMaterials() not found\n"); + throw ConnectionError(); + } + } + catch (Py::Exception& e) { + Base::PyException e1; // extract the Python error text + throw LibraryNotFound(e1.what()); + } + + return materialList; +} + +//===== +// +// Model management +// +//===== + +std::shared_ptr ExternalManager::getModel(const QString& uuid) +{ + connect(); + + Base::PyGILStateLocker lock; + try { + if (_managerObject.hasAttr("getModel")) { + Py::Callable libraries(_managerObject.getAttr("getModel")); + Py::Tuple args(1); + args.setItem(0, Py::String(uuid.toStdString())); + Py::Tuple result(libraries.apply(args)); // ignore return for now + + Py::Object uuidObject = result.getItem(0); + Py::Tuple libraryObject(result.getItem(1)); + Py::Object modelObject = result.getItem(2); + + Py::Object pyName = libraryObject.getItem(0); + Py::Object pyIcon = libraryObject.getItem(1); + Py::Object readOnly = libraryObject.getItem(2); + + QString name; + if (!pyName.isNone()) { + name = QString::fromStdString(pyName.as_string()); + } + QString icon; + if (!pyIcon.isNone()) { + icon = QString::fromStdString(pyIcon.as_string()); + } + auto library = + std::make_shared(name, QString(), icon, readOnly.as_bool()); + + Model* model = static_cast(*modelObject)->getModelPtr(); + model->setUUID(uuid); + model->setLibrary(library); + auto shared = std::make_shared(*model); + + return shared; + } + else { + Base::Console().Log("\tgetModel() not found\n"); + throw ConnectionError(); + } + } + catch (Py::Exception& e) { + Base::PyException e1; // extract the Python error text + throw ModelNotFound(e1.what()); + } +} + +void ExternalManager::addModel(const QString& libraryName, + const QString& path, + const std::shared_ptr& model) +{ + connect(); + + Base::PyGILStateLocker lock; + try { + if (_managerObject.hasAttr("addModel")) { + Py::Callable libraries(_managerObject.getAttr("addModel")); + Py::Tuple args(3); + args.setItem(0, Py::String(libraryName.toStdString())); + args.setItem(1, Py::String(path.toStdString())); + args.setItem(2, Py::Object(new ModelPy(new Model(*model)), true)); + libraries.apply(args); // No return expected + } + else { + Base::Console().Log("\taddModel() not found\n"); + throw ConnectionError(); + } + } + catch (Py::Exception& e) { + Base::PyException e1; // extract the Python error text + throw CreationError(e1.what()); + } +} + +void ExternalManager::migrateModel(const QString& libraryName, + const QString& path, + const std::shared_ptr& model) +{ + connect(); + + Base::PyGILStateLocker lock; + try { + if (_managerObject.hasAttr("migrateModel")) { + Py::Callable libraries(_managerObject.getAttr("migrateModel")); + Py::Tuple args(3); + args.setItem(0, Py::String(libraryName.toStdString())); + args.setItem(1, Py::String(path.toStdString())); + args.setItem(2, Py::Object(new ModelPy(new Model(*model)), true)); + libraries.apply(args); // No return expected + } + else { + Base::Console().Log("\tmigrateModel() not found\n"); + throw ConnectionError(); + } + } + catch (Py::Exception& e) { + Base::PyException e1; // extract the Python error text + throw CreationError(e1.what()); + } +} + +//===== +// +// Material management +// +//===== + +std::shared_ptr ExternalManager::getMaterial(const QString& uuid) +{ + connect(); + + Base::PyGILStateLocker lock; + try { + if (_managerObject.hasAttr("getMaterial")) { + Py::Callable libraries(_managerObject.getAttr("getMaterial")); + Py::Tuple args(1); + args.setItem(0, Py::String(uuid.toStdString())); + Py::Tuple result(libraries.apply(args)); + + Py::Object uuidObject = result.getItem(0); + Py::Tuple libraryObject(result.getItem(1)); + Py::Object materialObject = result.getItem(2); + + Py::Object pyName = libraryObject.getItem(0); + Py::Object pyIcon = libraryObject.getItem(1); + Py::Object readOnly = libraryObject.getItem(2); + + QString name; + if (!pyName.isNone()) { + name = QString::fromStdString(pyName.as_string()); + } + QString icon; + if (!pyIcon.isNone()) { + icon = QString::fromStdString(pyIcon.as_string()); + } + auto library = + std::make_shared(name, QString(), icon, readOnly.as_bool()); + + Material* material = static_cast(*materialObject)->getMaterialPtr(); + material->setUUID(uuid); + material->setLibrary(library); + auto shared = std::make_shared(*material); + + return shared; + } + else { + Base::Console().Log("\tgetMaterial() not found\n"); + throw ConnectionError(); + } + } + catch (Py::Exception& e) { + Base::PyException e1; // extract the Python error text + throw MaterialNotFound(e1.what()); + } +} + +void ExternalManager::addMaterial(const QString& libraryName, + const QString& path, + const std::shared_ptr& material) +{ + connect(); + + Base::PyGILStateLocker lock; + try { + if (_managerObject.hasAttr("addMaterial")) { + Py::Callable libraries(_managerObject.getAttr("addMaterial")); + Py::Tuple args(3); + args.setItem(0, Py::String(libraryName.toStdString())); + args.setItem(1, Py::String(path.toStdString())); + args.setItem(2, Py::Object(new MaterialPy(new Material(*material)), true)); + libraries.apply(args); // No return expected + } + else { + Base::Console().Log("\taddMaterial() not found\n"); + throw ConnectionError(); + } + } + catch (Py::Exception& e) { + Base::PyException e1; // extract the Python error text + throw CreationError(e1.what()); + } +} + +void ExternalManager::migrateMaterial(const QString& libraryName, + const QString& path, + const std::shared_ptr& material) +{ + connect(); + + Base::PyGILStateLocker lock; + try { + if (_managerObject.hasAttr("migrateMaterial")) { + Py::Callable libraries(_managerObject.getAttr("migrateMaterial")); + Py::Tuple args(3); + args.setItem(0, Py::String(libraryName.toStdString())); + args.setItem(1, Py::String(path.toStdString())); + auto mat = new Material(*material); + args.setItem(2, Py::Object(new MaterialPy(mat), true)); + libraries.apply(args); // No return expected + } + else { + Base::Console().Log("\tmigrateMaterial() not found\n"); + throw ConnectionError(); + } + } + catch (Py::Exception& e) { + Base::PyException e1; // extract the Python error text + throw CreationError(e1.what()); + } +} diff --git a/src/Mod/Material/App/ExternalManager.h b/src/Mod/Material/App/ExternalManager.h new file mode 100644 index 0000000000..56c4ae2a62 --- /dev/null +++ b/src/Mod/Material/App/ExternalManager.h @@ -0,0 +1,108 @@ +/*************************************************************************** + * Copyright (c) 2024 David Carter * + * * + * This file is part of FreeCAD. * + * * + * FreeCAD is free software: you can redistribute it and/or modify it * + * under the terms of the GNU Lesser General Public License as * + * published by the Free Software Foundation, either version 2.1 of the * + * License, or (at your option) any later version. * + * * + * FreeCAD 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 * + * Lesser General Public License for more details. * + * * + * You should have received a copy of the GNU Lesser General Public * + * License along with FreeCAD. If not, see * + * . * + * * + **************************************************************************/ + +#ifndef MATERIAL_EXTERNALMANAGER_H +#define MATERIAL_EXTERNALMANAGER_H + +#include +#include + +#include + +class QMutex; + +namespace Materials +{ + +class Library; +class Material; +class Model; +class MaterialFilter; +class MaterialFilterOptions; + +class MaterialsExport ExternalManager: public ParameterGrp::ObserverType +{ +public: + + static ExternalManager* getManager(); + + /// Observer message from the ParameterGrp + void OnChange(ParameterGrp::SubjectType& rCaller, ParameterGrp::MessageType Reason) override; + + // Library management + std::shared_ptr>> libraries(); + std::shared_ptr>> modelLibraries(); + std::shared_ptr>> materialLibraries(); + std::shared_ptr getLibrary(const QString& name); + void createLibrary(const QString& libraryName, const QString& icon, bool readOnly = true); + void renameLibrary(const QString& libraryName, const QString& newName); + void changeIcon(const QString& libraryName, const QString& icon); + void removeLibrary(const QString& libraryName); + std::shared_ptr>> + libraryModels(const QString& libraryName); + std::shared_ptr>> + libraryMaterials(const QString& libraryName); + std::shared_ptr>> + libraryMaterials(const QString& libraryName, + const std::shared_ptr& filter, + const MaterialFilterOptions& options); + + // Model management + std::shared_ptr getModel(const QString& uuid); + void + addModel(const QString& libraryName, const QString& path, const std::shared_ptr& model); + void + migrateModel(const QString& libraryName, const QString& path, const std::shared_ptr& model); + + // Material management + std::shared_ptr getMaterial(const QString& uuid); + void addMaterial(const QString& libraryName, + const QString& path, + const std::shared_ptr& material); + void migrateMaterial(const QString& libraryName, + const QString& path, + const std::shared_ptr& material); + +private: + ExternalManager(); + ~ExternalManager(); + + static void initManager(); + void getConfiguration(); + void instantiate(); + void connect(); + std::shared_ptr libraryFromTuple(const Py::Tuple& entry); + + static ExternalManager* _manager; + static QMutex _mutex; + + // COnfiguration + ParameterGrp::handle _hGrp; + std::string _moduleName; + std::string _className; + bool _instantiated; + + Py::Object _managerObject; +}; + +} // namespace Materials + +#endif // MATERIAL_EXTERNALMANAGER_H \ No newline at end of file diff --git a/src/Mod/Material/App/Library.cpp b/src/Mod/Material/App/Library.cpp index 57bbd50480..7e87310375 100644 --- a/src/Mod/Material/App/Library.cpp +++ b/src/Mod/Material/App/Library.cpp @@ -40,6 +40,16 @@ Library::Library(const QString& libraryName, const QString& icon, bool readOnly) , _readOnly(readOnly) {} +Library::Library(const QString& libraryName, + const QString& icon, + bool readOnly, + const QString& timestamp) + : _name(libraryName) + , _iconPath(icon) + , _readOnly(readOnly) + , _timestamp(timestamp) +{} + Library::Library(const QString& libraryName, const QString& dir, const QString& icon, bool readOnly) : _name(libraryName) , _directory(QDir::cleanPath(dir)) diff --git a/src/Mod/Material/App/Library.h b/src/Mod/Material/App/Library.h index b2249a91a8..5d773218d5 100644 --- a/src/Mod/Material/App/Library.h +++ b/src/Mod/Material/App/Library.h @@ -39,6 +39,10 @@ class MaterialsExport Library: public Base::BaseClass public: Library() = default; Library(const QString& libraryName, const QString& icon, bool readOnly = true); + Library(const QString& libraryName, + const QString& icon, + bool readOnly, + const QString& timestamp); Library(const QString& libraryName, const QString& dir, const QString& icon, @@ -53,7 +57,7 @@ public: { _name = newName; } - bool sameName(const QString& name) + bool isName(const QString& name) { return (_name == name); } @@ -87,6 +91,14 @@ public: { return QDir(_directory).absolutePath(); } + QString getTimestamp() const + { + return _timestamp; + } + void setTimestamp(const QString& timestamp) + { + _timestamp = timestamp; + } bool operator==(const Library& library) const; bool operator!=(const Library& library) const @@ -107,6 +119,7 @@ private: QString _directory; QString _iconPath; bool _readOnly; + QString _timestamp; }; } // namespace Materials diff --git a/src/Mod/Material/App/MaterialAPI/MaterialManagerExternal.py b/src/Mod/Material/App/MaterialAPI/MaterialManagerExternal.py new file mode 100644 index 0000000000..2f9db88722 --- /dev/null +++ b/src/Mod/Material/App/MaterialAPI/MaterialManagerExternal.py @@ -0,0 +1,246 @@ +# *************************************************************************** +# * Copyright (c) 2024 David Carter * +# * * +# * This program is free software; you can redistribute it and/or modify * +# * it under the terms of the GNU Lesser General Public License (LGPL) * +# * as published by the Free Software Foundation; either version 2 of * +# * the License, or (at your option) any later version. * +# * for detail see the LICENCE text file. * +# * * +# * This program 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 program; if not, write to the Free Software * +# * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 * +# * USA * +# * * +# *************************************************************************** + +__author__ = "David Carter" +__url__ = "https://www.davesrocketshop.com" + +from abc import ABC, abstractmethod +# from typing import Tuple + +import Materials + +# This requires Python 3.12 or later. This isn't available on all platforms yet +# type MaterialName = str +# type MaterialIcon = str +# type MaterialReadOnly = bool +# type MaterialTimestamp = str +# type MaterialUUID = str +# type MaterialPath = str +# type MaterialLibraryType = Tuple[MaterialName, MaterialIcon, MaterialReadOnly, MaterialTimestamp] +# type MaterialLibraryObjectType = Tuple[MaterialUUID, MaterialPath, MaterialName] + +class MaterialManagerExternal(ABC): + """Abstract base class for all external material managers + + Any external interface should be derivedfrom this base class.""" + + @classmethod + def APIVersion(cls) -> tuple: + """Returns a tuple of 3 integers describing the API version + + The version returned should be the latest supported version. This method + allows the interface to use older modules.""" + return (1, 0, 0) + + # + # Library methods + # + + @abstractmethod + def libraries(self) -> list: #[MaterialLibraryType]: + """Returns a list of libraries managed by this interface + + The list contains a series of tuples describing all libraries managed by + this module. Each tuple containes the library name, icon, a boolean to indicate + if it is a read only library, and a timestamp that indicates when it was last + modified.""" + pass + + @abstractmethod + def modelLibraries(self) -> list: #[MaterialLibraryType]: + """Returns a list of libraries managed by this interface + + The list contains a series of tuples describing all libraries managed by + this module. Each tuple containes the library name, icon, and a boolean to indicate + if it is a read only library, and a timestamp that indicates when it was last + modified. + + This differs from the libraries() function in that it only returns libraries + containing model objects.""" + pass + + @abstractmethod + def materialLibraries(self) -> list: #[MaterialLibraryType]: + """Returns a list of libraries managed by this interface + + The list contains a series of tuples describing all libraries managed by + this module. Each tuple containes the library name, icon, and a boolean to indicate + if it is a read only library, and a timestamp that indicates when it was last + modified. + + This differs from the libraries() function in that it only returns libraries + containing material objects.""" + pass + + @abstractmethod + def getLibrary(self, name: str) -> tuple: + """Get the library + + Retrieve the library with the given name""" + pass + + @abstractmethod + def createLibrary(self, name: str, icon: str, readOnly: bool) -> None: + """Create a new library + + Create a new library with the given name""" + pass + + @abstractmethod + def renameLibrary(self, oldName: str, newName: str) -> None: + """Rename an existing library + + Change the name of an existing library""" + pass + + @abstractmethod + def changeIcon(self, name: str, icon: str) -> None: + """Change the library icon + + Change the library icon""" + pass + + @abstractmethod + def removeLibrary(self, library: str) -> None: + """Delete a library and its contents + + Deletes the library and any models or materials it contains""" + pass + + @abstractmethod + def libraryModels(self, library: str) -> list: #[MaterialLibraryObjectType]: + """Returns a list of models managed by this library + + Each list entry is a tuple containing the UUID, path, and name of the model""" + pass + + @abstractmethod + def libraryMaterials(self, library: str, + filter: Materials.MaterialFilter = None, + options: Materials.MaterialFilterOptions = None) -> list: #[MaterialLibraryObjectType]: + """Returns a list of materials managed by this library + + Each list entry is a tuple containing the UUID, path, and name of the material""" + pass + + # + # Model methods + # + + @abstractmethod + def getModel(self, uuid: str) -> Materials.Model: + """Retrieve a model given its UUID""" + pass + + @abstractmethod + def addModel(self, library: str, path: str, model: Materials.Model) -> None: + """Add a model to a library in the given folder. + + This will throw a DatabaseModelExistsError exception if the model already exists.""" + pass + + @abstractmethod + def migrateModel(self, library: str, path: str, model: Materials.Model) -> None: + """Add the model to the library. + + If the model already exists, then no action is performed.""" + pass + + @abstractmethod + def updateModel(self, library: str, path: str, model: Materials.Model) -> None: + """Update the given model""" + pass + + @abstractmethod + def setModelPath(self, library: str, path: str, model: Materials.Model) -> None: + """Change the model path within the library""" + pass + + @abstractmethod + def renameModel(self, library: str, name: str, model: Materials.Model) -> None: + """Change the model name""" + pass + + @abstractmethod + def moveModel(self, library: str, path: str, model: Materials.Model) -> None: + """Move a model across libraries + + Move the model to the desired path in a different library. This should also + remove the model from the old library if that library is managed by this + interface""" + pass + + @abstractmethod + def removeModel(self, model: Materials.Model) -> None: + """Remove the model from the library""" + pass + + # + # Material methods + # + + @abstractmethod + def getMaterial(self, uuid: str) -> Materials.Material: + """ Retrieve a material given its UUID """ + pass + + @abstractmethod + def addMaterial(self, library: str, path: str, material: Materials.Material) -> None: + """Add a material to a library in the given folder. + + This will throw a DatabaseMaterialExistsError exception if the model already exists.""" + pass + + @abstractmethod + def migrateMaterial(self, library: str, path: str, material: Materials.Material) -> None: + """Add the material to the library in the given folder. + + If the material already exists, then no action is performed.""" + pass + + @abstractmethod + def updateMaterial(self, library: str, path: str, material: Materials.Material) -> None: + """Update the given material""" + pass + + @abstractmethod + def setMaterialPath(self, library: str, path: str, material: Materials.Material) -> None: + """Change the material path within the library""" + pass + + @abstractmethod + def renameMaterial(self, library: str, name: str, material: Materials.Material) -> None: + """Change the material name""" + pass + + @abstractmethod + def moveMaterial(self, library: str, path: str, material: Materials.Material) -> None: + """Move a material across libraries + + Move the material to the desired path in a different library. This should also + remove the material from the old library if that library is managed by this + interface""" + pass + + @abstractmethod + def removeMaterial(self, material: Materials.Material) -> None: + """Remove the material from the library""" + pass diff --git a/src/Mod/Material/App/MaterialAPI/__init__.py b/src/Mod/Material/App/MaterialAPI/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/src/Mod/Material/App/MaterialManagerLocal.cpp b/src/Mod/Material/App/MaterialManagerLocal.cpp index 42b3daabe1..7db46b2bad 100644 --- a/src/Mod/Material/App/MaterialManagerLocal.cpp +++ b/src/Mod/Material/App/MaterialManagerLocal.cpp @@ -130,7 +130,7 @@ MaterialManagerLocal::getMaterialLibraries() std::shared_ptr MaterialManagerLocal::getLibrary(const QString& name) const { for (auto& library : *_libraryList) { - if (library->isLocal() && library->sameName(name)) { + if (library->isLocal() && library->isName(name)) { return library; } } @@ -160,7 +160,7 @@ void MaterialManagerLocal::createLibrary(const QString& libraryName, void MaterialManagerLocal::renameLibrary(const QString& libraryName, const QString& newName) { for (auto& library : *_libraryList) { - if (library->isLocal() && library->sameName(libraryName)) { + if (library->isLocal() && library->isName(libraryName)) { auto materialLibrary = reinterpret_cast&>(library); materialLibrary->setName(newName); @@ -174,7 +174,7 @@ void MaterialManagerLocal::renameLibrary(const QString& libraryName, const QStri void MaterialManagerLocal::changeIcon(const QString& libraryName, const QString& icon) { for (auto& library : *_libraryList) { - if (library->isLocal() && library->sameName(libraryName)) { + if (library->isLocal() && library->isName(libraryName)) { auto materialLibrary = reinterpret_cast&>(library); materialLibrary->setIconPath(icon); @@ -188,7 +188,7 @@ void MaterialManagerLocal::changeIcon(const QString& libraryName, const QString& void MaterialManagerLocal::removeLibrary(const QString& libraryName) { for (auto& library : *_libraryList) { - if (library->isLocal() && library->sameName(libraryName)) { + if (library->isLocal() && library->isName(libraryName)) { _libraryList->remove(library); // At this point we should rebuild the material map @@ -207,7 +207,7 @@ MaterialManagerLocal::libraryMaterials(const QString& libraryName) for (auto& it : *_materialMap) { // This is needed to resolve cyclic dependencies auto library = it.second->getLibrary(); - if (library->sameName(libraryName)) { + if (library->isName(libraryName)) { materials->push_back(std::tuple(it.first, it.second->getDirectory(), it.second->getName())); @@ -245,7 +245,7 @@ MaterialManagerLocal::libraryMaterials(const QString& libraryName, for (auto& it : *_materialMap) { // This is needed to resolve cyclic dependencies auto library = it.second->getLibrary(); - if (library->sameName(libraryName)) { + if (library->isName(libraryName)) { if (passFilter(it.second, filter, options)) { materials->push_back(std::tuple(it.first, it.second->getDirectory(), From 0d5481e4486e8d20520a9f7f71a6d29b574daaa0 Mon Sep 17 00:00:00 2001 From: Pieter Hijma Date: Sat, 5 Apr 2025 13:47:00 +0200 Subject: [PATCH 02/63] [Core] Add visibility toggling to ViewProvider With this extension of the API, view providers can indicate whether document objects should be able to be toggled for visibility. There is both a C++ and Python interface, idiomatic for FreeCAD code. --- src/Gui/FreeCADGuiInit.py | 7 ++++++- src/Gui/Tree.cpp | 4 +++- src/Gui/ViewProvider.cpp | 1 + src/Gui/ViewProvider.h | 27 +++++++++++++++++++++++++++ src/Gui/ViewProvider.pyi | 10 ++++++++++ src/Gui/ViewProviderPyImp.cpp | 31 +++++++++++++++++++++++++++++++ 6 files changed, 78 insertions(+), 2 deletions(-) diff --git a/src/Gui/FreeCADGuiInit.py b/src/Gui/FreeCADGuiInit.py index 97f4910d43..5c027d838e 100644 --- a/src/Gui/FreeCADGuiInit.py +++ b/src/Gui/FreeCADGuiInit.py @@ -29,7 +29,7 @@ # imports the one and only import FreeCAD, FreeCADGui -from enum import IntEnum +from enum import IntEnum, Enum # shortcuts Gui = FreeCADGui @@ -52,6 +52,11 @@ class SelectionStyle(IntEnum): NormalSelection = 0 GreedySelection = 1 +# The values must match with that of the Python enum class in ViewProvider.pyi +class ToggleVisibilityMode(Enum): + CanToggleVisibility = "CanToggleVisibility" + NoToggleVisibility = "NoToggleVisibility" + Gui.Selection.SelectionStyle = SelectionStyle # Important definitions diff --git a/src/Gui/Tree.cpp b/src/Gui/Tree.cpp index 77adeb35ee..4cedaba752 100644 --- a/src/Gui/Tree.cpp +++ b/src/Gui/Tree.cpp @@ -5534,7 +5534,9 @@ void DocumentObjectItem::testStatus(bool resetStatus, QIcon& icon1, QIcon& icon2 QPainter pt; pt.begin(&px); pt.setPen(Qt::NoPen); - pt.drawPixmap(0, 0, px_org.width(), px_org.height(), (currentStatus & Status::Visible) ? pxVisible : pxInvisible); + if (object()->canToggleVisibility()) { + pt.drawPixmap(0, 0, px_org.width(), px_org.height(), (currentStatus & Status::Visible) ? pxVisible : pxInvisible); + } pt.drawPixmap(px_org.width() + spacing, 0, px_org.width(), px_org.height(), px_org); pt.end(); diff --git a/src/Gui/ViewProvider.cpp b/src/Gui/ViewProvider.cpp index 2acaebea60..15a30b7adf 100644 --- a/src/Gui/ViewProvider.cpp +++ b/src/Gui/ViewProvider.cpp @@ -93,6 +93,7 @@ PROPERTY_SOURCE_ABSTRACT(Gui::ViewProvider, App::TransactionalObject) ViewProvider::ViewProvider() : overrideMode("As Is") + , toggleVisibilityMode(ToggleVisibilityMode::CanToggleVisibility) { setStatus(UpdateData, true); diff --git a/src/Gui/ViewProvider.h b/src/Gui/ViewProvider.h index fd1aeb3d06..a376491ebe 100644 --- a/src/Gui/ViewProvider.h +++ b/src/Gui/ViewProvider.h @@ -121,6 +121,11 @@ class GuiExport ViewProvider : public App::TransactionalObject PROPERTY_HEADER_WITH_OVERRIDE(Gui::ViewProvider); public: + enum class ToggleVisibilityMode : bool { + CanToggleVisibility = true, + NoToggleVisibility = false + }; + /// constructor. ViewProvider(); @@ -247,6 +252,22 @@ public: /// deliver the icon shown in the tree view virtual QIcon getIcon() const; + /** + * @brief Whether the viewprovider should allow to toggle the visibility. + * + * Some document objects are not rendered and for those document objects, + * it makes no sense to be able to toggle the visibility. Examples are + * VarSet and Spreadsheet. + * + * Note that "rendered" should be seen broadly here. Objects such as + * TechDraw pages, templates, views, and dimensions are not rendered by + * Coin but are "rendered" on the TechDraw page and hence this function can + * return true for those items. + */ + bool canToggleVisibility() const { + return toggleVisibilityMode == ToggleVisibilityMode::CanToggleVisibility; + } + /** @name Methods used by the Tree * If you want to take control over the * viewprovider specific overlay icons that will be drawn with color @@ -571,6 +592,8 @@ protected: /// Turn on mode switch virtual void setModeSwitch(); + void setToggleVisibility(ToggleVisibilityMode mode) { toggleVisibilityMode = mode; } + protected: /// The root Separator of the ViewProvider SoSeparator *pcRoot; @@ -584,6 +607,10 @@ protected: ViewProviderPy* pyViewObject{nullptr}; std::string overrideMode; std::bitset<32> StatusBits; + /// whether visibility can toggled + ToggleVisibilityMode toggleVisibilityMode; + + friend class ViewProviderPy; private: int _iActualMode{-1}; diff --git a/src/Gui/ViewProvider.pyi b/src/Gui/ViewProvider.pyi index 5d651e9893..46d8ec4e9e 100644 --- a/src/Gui/ViewProvider.pyi +++ b/src/Gui/ViewProvider.pyi @@ -2,6 +2,7 @@ from Base.Metadata import constmethod from Base.BoundBox import BoundBox from App.ExtensionContainer import ExtensionContainer from typing import Any, Final, List, Optional +import enum class ViewProvider(ExtensionContainer): @@ -12,6 +13,11 @@ class ViewProvider(ExtensionContainer): Licence: LGPL """ + class ToggleVisibilityMode(enum.Enum): + CanToggleVisibility = "CanToggleVisibility" + NoToggleVisibility = "NoToggleVisibility" + + def addProperty( self, type: str, @@ -367,3 +373,7 @@ class ViewProvider(ExtensionContainer): DropPrefix: Final[str] = "" """Subname referencing the sub-object for holding dropped object.""" + + ToggleVisibility: ToggleVisibilityMode = ToggleVisibilityMode.CanToggleVisibility + """Get/set whether the viewprovider can toggle the visibility of + the object.""" diff --git a/src/Gui/ViewProviderPyImp.cpp b/src/Gui/ViewProviderPyImp.cpp index e3a9f5f5a0..a38d9b0b88 100644 --- a/src/Gui/ViewProviderPyImp.cpp +++ b/src/Gui/ViewProviderPyImp.cpp @@ -706,3 +706,34 @@ Py::String ViewProviderPy::getDropPrefix() const { return {getViewProviderPtr()->getDropPrefix()}; } + +void ViewProviderPy::setToggleVisibility(Py::Object arg) +{ + std::string val; + + if (PyObject_HasAttrString(arg.ptr(), "value")) { + // we are dealing with the enum + val = Py::String(arg.getAttr("value")); + } + else { + // we are dealing with a string + val = Py::String(arg); + } + + if (val == "CanToggleVisibility") { + getViewProviderPtr()->setToggleVisibility(ViewProvider::ToggleVisibilityMode::CanToggleVisibility); + } + else if (val == "NoToggleVisibility") { + getViewProviderPtr()->setToggleVisibility(ViewProvider::ToggleVisibilityMode::NoToggleVisibility); + } + else { + throw Py::ValueError("Invalid ToggleVisibility mode. Use 'CanToggleVisibility' or 'NoToggleVisibility'."); + } +} + +Py::Object ViewProviderPy::getToggleVisibility() const +{ + bool canToggleVisibility = getViewProviderPtr()->canToggleVisibility(); + + return Py::String(canToggleVisibility ? "CanToggleVisibility" : "NoToggleVisibility"); +} From 6fcd72d28612b9a5489cc9fc85e4994c3d28e274 Mon Sep 17 00:00:00 2001 From: Pieter Hijma Date: Tue, 1 Apr 2025 15:08:56 +0200 Subject: [PATCH 03/63] [Core] Remove DisplayMode from Spreadsheet --- src/Mod/Spreadsheet/Gui/ViewProviderSpreadsheet.cpp | 12 ------------ src/Mod/Spreadsheet/Gui/ViewProviderSpreadsheet.h | 2 -- 2 files changed, 14 deletions(-) diff --git a/src/Mod/Spreadsheet/Gui/ViewProviderSpreadsheet.cpp b/src/Mod/Spreadsheet/Gui/ViewProviderSpreadsheet.cpp index 6998e86773..3b17b64777 100644 --- a/src/Mod/Spreadsheet/Gui/ViewProviderSpreadsheet.cpp +++ b/src/Mod/Spreadsheet/Gui/ViewProviderSpreadsheet.cpp @@ -59,18 +59,6 @@ ViewProviderSheet::~ViewProviderSheet() } } -void ViewProviderSheet::setDisplayMode(const char* ModeName) -{ - ViewProviderDocumentObject::setDisplayMode(ModeName); -} - -std::vector ViewProviderSheet::getDisplayModes() const -{ - std::vector StrList; - StrList.emplace_back("Spreadsheet"); - return StrList; -} - QIcon ViewProviderSheet::getIcon() const { return QIcon(QLatin1String(":icons/Spreadsheet.svg")); diff --git a/src/Mod/Spreadsheet/Gui/ViewProviderSpreadsheet.h b/src/Mod/Spreadsheet/Gui/ViewProviderSpreadsheet.h index ab301d3840..9bf1459dd1 100644 --- a/src/Mod/Spreadsheet/Gui/ViewProviderSpreadsheet.h +++ b/src/Mod/Spreadsheet/Gui/ViewProviderSpreadsheet.h @@ -46,12 +46,10 @@ public: /// destructor. ~ViewProviderSheet() override; - void setDisplayMode(const char* ModeName) override; bool useNewSelectionModel() const override { return false; } - std::vector getDisplayModes() const override; bool doubleClicked() override; void setupContextMenu(QMenu* menu, QObject* receiver, const char* member) override; From 2b2da596ffa6c28716fb05dd768fde4e0b1e2c78 Mon Sep 17 00:00:00 2001 From: Pieter Hijma Date: Tue, 1 Apr 2025 15:09:11 +0200 Subject: [PATCH 04/63] [Core] Remove various DisplayModes from FEM --- src/Mod/Fem/Gui/ViewProviderAnalysis.cpp | 5 ----- src/Mod/Fem/Gui/ViewProviderAnalysis.h | 2 -- src/Mod/Fem/Gui/ViewProviderSolver.cpp | 5 ----- src/Mod/Fem/Gui/ViewProviderSolver.h | 2 -- 4 files changed, 14 deletions(-) diff --git a/src/Mod/Fem/Gui/ViewProviderAnalysis.cpp b/src/Mod/Fem/Gui/ViewProviderAnalysis.cpp index 51bbbe69ed..9094c2a4f7 100644 --- a/src/Mod/Fem/Gui/ViewProviderAnalysis.cpp +++ b/src/Mod/Fem/Gui/ViewProviderAnalysis.cpp @@ -147,11 +147,6 @@ std::vector ViewProviderFemAnalysis::claimChildren() const return Gui::ViewProviderDocumentObjectGroup::claimChildren(); } -std::vector ViewProviderFemAnalysis::getDisplayModes() const -{ - return {"Analysis"}; -} - void ViewProviderFemAnalysis::hide() { Gui::ViewProviderDocumentObjectGroup::hide(); diff --git a/src/Mod/Fem/Gui/ViewProviderAnalysis.h b/src/Mod/Fem/Gui/ViewProviderAnalysis.h index f0a4e4eee9..e8f0b0bf2c 100644 --- a/src/Mod/Fem/Gui/ViewProviderAnalysis.h +++ b/src/Mod/Fem/Gui/ViewProviderAnalysis.h @@ -75,8 +75,6 @@ public: void setupContextMenu(QMenu*, QObject*, const char*) override; - /// list of all possible display modes - std::vector getDisplayModes() const override; /// shows solid in the tree bool isShow() const override { diff --git a/src/Mod/Fem/Gui/ViewProviderSolver.cpp b/src/Mod/Fem/Gui/ViewProviderSolver.cpp index e3d3e4f03f..5870c3fea8 100644 --- a/src/Mod/Fem/Gui/ViewProviderSolver.cpp +++ b/src/Mod/Fem/Gui/ViewProviderSolver.cpp @@ -46,11 +46,6 @@ ViewProviderSolver::ViewProviderSolver() ViewProviderSolver::~ViewProviderSolver() = default; -std::vector ViewProviderSolver::getDisplayModes() const -{ - return {"Solver"}; -} - bool ViewProviderSolver::onDelete(const std::vector&) { // warn the user if the object has unselected children diff --git a/src/Mod/Fem/Gui/ViewProviderSolver.h b/src/Mod/Fem/Gui/ViewProviderSolver.h index 0027bb2c93..8681ac20fd 100644 --- a/src/Mod/Fem/Gui/ViewProviderSolver.h +++ b/src/Mod/Fem/Gui/ViewProviderSolver.h @@ -53,8 +53,6 @@ public: { return Visibility.getValue(); } - /// A list of all possible display modes - std::vector getDisplayModes() const override; // handling when object is deleted bool onDelete(const std::vector&) override; From 524d3c41c06a129572618a3a488082621b92850c Mon Sep 17 00:00:00 2001 From: Pieter Hijma Date: Sat, 5 Apr 2025 14:25:51 +0200 Subject: [PATCH 05/63] [Core] Disable toggling visibility for objects - VarSet - Spreadsheet - FEM objects --- src/Gui/ViewProviderVarSet.cpp | 1 + src/Mod/Fem/Gui/ViewProviderAnalysis.cpp | 1 + src/Mod/Fem/Gui/ViewProviderSolver.cpp | 1 + src/Mod/Spreadsheet/Gui/ViewProviderSpreadsheet.cpp | 5 ++++- 4 files changed, 7 insertions(+), 1 deletion(-) diff --git a/src/Gui/ViewProviderVarSet.cpp b/src/Gui/ViewProviderVarSet.cpp index bd091d5256..d9179422d5 100644 --- a/src/Gui/ViewProviderVarSet.cpp +++ b/src/Gui/ViewProviderVarSet.cpp @@ -37,6 +37,7 @@ PROPERTY_SOURCE(Gui::ViewProviderVarSet, Gui::ViewProviderDocumentObject) ViewProviderVarSet::ViewProviderVarSet() { + setToggleVisibility(ToggleVisibilityMode::NoToggleVisibility); sPixmap = "VarSet"; } diff --git a/src/Mod/Fem/Gui/ViewProviderAnalysis.cpp b/src/Mod/Fem/Gui/ViewProviderAnalysis.cpp index 9094c2a4f7..1aaff2ab6b 100644 --- a/src/Mod/Fem/Gui/ViewProviderAnalysis.cpp +++ b/src/Mod/Fem/Gui/ViewProviderAnalysis.cpp @@ -101,6 +101,7 @@ PROPERTY_SOURCE(FemGui::ViewProviderFemAnalysis, Gui::ViewProviderDocumentObject ViewProviderFemAnalysis::ViewProviderFemAnalysis() { + setToggleVisibility(ToggleVisibilityMode::NoToggleVisibility); sPixmap = "FEM_Analysis"; } diff --git a/src/Mod/Fem/Gui/ViewProviderSolver.cpp b/src/Mod/Fem/Gui/ViewProviderSolver.cpp index 5870c3fea8..ea4bdfadc1 100644 --- a/src/Mod/Fem/Gui/ViewProviderSolver.cpp +++ b/src/Mod/Fem/Gui/ViewProviderSolver.cpp @@ -41,6 +41,7 @@ PROPERTY_SOURCE(FemGui::ViewProviderSolver, Gui::ViewProviderDocumentObject) ViewProviderSolver::ViewProviderSolver() { + setToggleVisibility(ToggleVisibilityMode::NoToggleVisibility); sPixmap = "FEM_SolverStandard"; } diff --git a/src/Mod/Spreadsheet/Gui/ViewProviderSpreadsheet.cpp b/src/Mod/Spreadsheet/Gui/ViewProviderSpreadsheet.cpp index 3b17b64777..61eb3ca5a9 100644 --- a/src/Mod/Spreadsheet/Gui/ViewProviderSpreadsheet.cpp +++ b/src/Mod/Spreadsheet/Gui/ViewProviderSpreadsheet.cpp @@ -50,7 +50,10 @@ using namespace Spreadsheet; PROPERTY_SOURCE(SpreadsheetGui::ViewProviderSheet, Gui::ViewProviderDocumentObject) -ViewProviderSheet::ViewProviderSheet() = default; +ViewProviderSheet::ViewProviderSheet() +{ + setToggleVisibility(ToggleVisibilityMode::NoToggleVisibility); +} ViewProviderSheet::~ViewProviderSheet() { From d29e7aa5be42affb24d7780f41525eadf87bc13b Mon Sep 17 00:00:00 2001 From: David Carter Date: Thu, 10 Apr 2025 06:13:38 -0400 Subject: [PATCH 06/63] Materials: Use data classes in interface specification --- src/Mod/Material/App/ExternalManager.cpp | 134 +++++++++--------- src/Mod/Material/App/ExternalManager.h | 8 +- .../MaterialAPI/MaterialManagerExternal.py | 37 ++--- 3 files changed, 92 insertions(+), 87 deletions(-) diff --git a/src/Mod/Material/App/ExternalManager.cpp b/src/Mod/Material/App/ExternalManager.cpp index 249e049234..22d3920e11 100644 --- a/src/Mod/Material/App/ExternalManager.cpp +++ b/src/Mod/Material/App/ExternalManager.cpp @@ -65,9 +65,8 @@ ExternalManager::~ExternalManager() _hGrp->Detach(this); } -void ExternalManager::OnChange(ParameterGrp::SubjectType& rCaller, ParameterGrp::MessageType Reason) +void ExternalManager::OnChange(ParameterGrp::SubjectType& /*rCaller*/, ParameterGrp::MessageType Reason) { - const ParameterGrp& rGrp = static_cast(rCaller); if (std::strncmp(Reason, "Current", 7) == 0) { if (_instantiated) { // The old manager object will be deleted when reconnecting @@ -167,36 +166,74 @@ ExternalManager* ExternalManager::getManager() // //===== -std::shared_ptr -ExternalManager::libraryFromTuple(const Py::Tuple& entry) +bool ExternalManager::checkMaterialLibraryType(const Py::Object& entry) { - auto pyName = entry.getItem(0); + return entry.hasAttr("name") && entry.hasAttr("icon") && entry.hasAttr("readOnly") + && entry.hasAttr("timestamp"); +} + +std::shared_ptr +ExternalManager::libraryFromObject(const Py::Object& entry) +{ + if (!checkMaterialLibraryType(entry)) { + throw InvalidLibrary(); + } + + Py::String pyName(entry.getAttr("name")); + Py::Bytes pyIcon(entry.getAttr("icon")); + Py::Boolean pyReadOnly(entry.getAttr("readOnly")); + Py::String pyTimestamp(entry.getAttr("timestamp")); + QString libraryName; if (!pyName.isNone()) { libraryName = QString::fromStdString(pyName.as_string()); } - auto pyIcon = entry.getItem(1); + QString icon; if (!pyIcon.isNone()) { icon = QString::fromStdString(pyIcon.as_string()); } - auto pyReadOnly = entry.getItem(2); + bool readOnly = pyReadOnly.as_bool(); - auto pyTimestamp = entry.getItem(3); + QString timestamp; if (!pyTimestamp.isNone()) { timestamp = QString::fromStdString(pyTimestamp.as_string()); } - Base::Console().Log("Library name '%s', Icon '%s', readOnly %s, timestamp '%s'\n", - libraryName.toStdString().c_str(), - icon.toStdString().c_str(), - readOnly ? "true" : "false", - timestamp.toStdString().c_str()); auto library = std::make_shared(libraryName, icon, readOnly, timestamp); return library; } +bool ExternalManager::checkMaterialObjectType(const Py::Object& entry) +{ + return entry.hasAttr("UUID") && entry.hasAttr("path") && entry.hasAttr("name"); +} + +std::tuple +ExternalManager::materialObjectTypeFromObject(const Py::Object& entry) +{ + QString uuid; + auto pyUUID = entry.getAttr("UUID"); + if (!pyUUID.isNone()) { + uuid = QString::fromStdString(pyUUID.as_string()); + } + + QString path; + auto pyPath = entry.getAttr("path"); + if (!pyPath.isNone()) { + path = QString::fromStdString(pyPath.as_string()); + } + + QString name; + auto pyName = entry.getAttr("name"); + if (!pyName.isNone()) { + name = QString::fromStdString(pyName.as_string()); + } + + return std::tuple(uuid, path, name); +} + std::shared_ptr>> ExternalManager::libraries() { @@ -210,7 +247,7 @@ ExternalManager::libraries() Py::Callable libraries(_managerObject.getAttr("libraries")); Py::List list(libraries.apply()); for (auto lib : list) { - auto library = libraryFromTuple(Py::Tuple(lib)); + auto library = libraryFromObject(Py::Object(lib)); libList->push_back(library); } } @@ -239,7 +276,7 @@ std::shared_ptr>> ExternalManager::modelLib Py::Callable libraries(_managerObject.getAttr("modelLibraries")); Py::List list(libraries.apply()); for (auto lib : list) { - auto library = libraryFromTuple(Py::Tuple(lib)); + auto library = libraryFromObject(Py::Tuple(lib)); libList->push_back(library); } } @@ -268,7 +305,7 @@ std::shared_ptr>> ExternalManager::material Py::Callable libraries(_managerObject.getAttr("materialLibraries")); Py::List list(libraries.apply()); for (auto lib : list) { - auto library = libraryFromTuple(Py::Tuple(lib)); + auto library = libraryFromObject(Py::Tuple(lib)); libList->push_back(library); } } @@ -299,7 +336,7 @@ std::shared_ptr ExternalManager::getLibrary(const QString& name) Py::Tuple result(libraries.apply(args)); Py::Object libObject = result.getItem(0); - auto lib = libraryFromTuple(Py::Tuple(libObject)); + auto lib = libraryFromObject(Py::Tuple(libObject)); return std::make_shared(*lib); } else { @@ -424,25 +461,12 @@ ExternalManager::libraryModels(const QString& libraryName) args.setItem(0, Py::String(libraryName.toStdString())); Py::List list(libraries.apply(args)); for (auto library : list) { - auto entry = Py::Tuple(library); - - auto pyUUID = entry.getItem(0); - QString uuid; - if (!pyUUID.isNone()) { - uuid = QString::fromStdString(pyUUID.as_string()); - } - auto pyPath = entry.getItem(1); - QString path; - if (!pyPath.isNone()) { - path = QString::fromStdString(pyPath.as_string()); - } - auto pyName = entry.getItem(2); - QString name; - if (!pyName.isNone()) { - name = QString::fromStdString(pyName.as_string()); + auto entry = Py::Object(library); + if (!checkMaterialObjectType(entry)) { + throw InvalidModel(); } - modelList->push_back(std::tuple(uuid, path, name)); + modelList->push_back(materialObjectTypeFromObject(entry)); } } else { @@ -473,25 +497,12 @@ ExternalManager::libraryMaterials(const QString& libraryName) args.setItem(0, Py::String(libraryName.toStdString())); Py::List list(libraries.apply(args)); for (auto library : list) { - auto entry = Py::Tuple(library); - - auto pyUUID = entry.getItem(0); - QString uuid; - if (!pyUUID.isNone()) { - uuid = QString::fromStdString(pyUUID.as_string()); - } - auto pyPath = entry.getItem(1); - QString path; - if (!pyPath.isNone()) { - path = QString::fromStdString(pyPath.as_string()); - } - auto pyName = entry.getItem(2); - QString name; - if (!pyName.isNone()) { - name = QString::fromStdString(pyName.as_string()); + auto entry = Py::Object(library); + if (!checkMaterialObjectType(entry)) { + throw InvalidMaterial(); } - materialList->push_back(std::tuple(uuid, path, name)); + materialList->push_back(materialObjectTypeFromObject(entry)); } } else { @@ -534,25 +545,12 @@ ExternalManager::libraryMaterials(const QString& libraryName, Py::Object(new MaterialFilterOptionsPy(new MaterialFilterOptions(options)), true)); Py::List list(libraries.apply(args)); for (auto library : list) { - auto entry = Py::Tuple(library); - - auto pyUUID = entry.getItem(0); - QString uuid; - if (!pyUUID.isNone()) { - uuid = QString::fromStdString(pyUUID.as_string()); - } - auto pyPath = entry.getItem(1); - QString path; - if (!pyPath.isNone()) { - path = QString::fromStdString(pyPath.as_string()); - } - auto pyName = entry.getItem(2); - QString name; - if (!pyName.isNone()) { - name = QString::fromStdString(pyName.as_string()); + auto entry = Py::Object(library); + if (!checkMaterialObjectType(entry)) { + throw InvalidMaterial(); } - materialList->push_back(std::tuple(uuid, path, name)); + materialList->push_back(materialObjectTypeFromObject(entry)); } } else { diff --git a/src/Mod/Material/App/ExternalManager.h b/src/Mod/Material/App/ExternalManager.h index 56c4ae2a62..91f92b49ca 100644 --- a/src/Mod/Material/App/ExternalManager.h +++ b/src/Mod/Material/App/ExternalManager.h @@ -28,6 +28,7 @@ #include class QMutex; +class QString; namespace Materials { @@ -83,13 +84,16 @@ public: private: ExternalManager(); - ~ExternalManager(); + ~ExternalManager() override; static void initManager(); void getConfiguration(); void instantiate(); void connect(); - std::shared_ptr libraryFromTuple(const Py::Tuple& entry); + bool checkMaterialLibraryType(const Py::Object& entry); + std::shared_ptr libraryFromObject(const Py::Object& entry); + bool checkMaterialObjectType(const Py::Object& entry); + std::tuple materialObjectTypeFromObject(const Py::Object& entry); static ExternalManager* _manager; static QMutex _mutex; diff --git a/src/Mod/Material/App/MaterialAPI/MaterialManagerExternal.py b/src/Mod/Material/App/MaterialAPI/MaterialManagerExternal.py index 2f9db88722..152e4b3525 100644 --- a/src/Mod/Material/App/MaterialAPI/MaterialManagerExternal.py +++ b/src/Mod/Material/App/MaterialAPI/MaterialManagerExternal.py @@ -23,19 +23,22 @@ __author__ = "David Carter" __url__ = "https://www.davesrocketshop.com" from abc import ABC, abstractmethod -# from typing import Tuple +from dataclasses import dataclass import Materials -# This requires Python 3.12 or later. This isn't available on all platforms yet -# type MaterialName = str -# type MaterialIcon = str -# type MaterialReadOnly = bool -# type MaterialTimestamp = str -# type MaterialUUID = str -# type MaterialPath = str -# type MaterialLibraryType = Tuple[MaterialName, MaterialIcon, MaterialReadOnly, MaterialTimestamp] -# type MaterialLibraryObjectType = Tuple[MaterialUUID, MaterialPath, MaterialName] +@dataclass +class MaterialLibraryType: + name: str + icon: bytes + readOnly: bool + timestamp: str + +@dataclass +class MaterialLibraryObjectType: + UUID: str + path: str + name: str class MaterialManagerExternal(ABC): """Abstract base class for all external material managers @@ -55,7 +58,7 @@ class MaterialManagerExternal(ABC): # @abstractmethod - def libraries(self) -> list: #[MaterialLibraryType]: + def libraries(self) -> list[MaterialLibraryType]: """Returns a list of libraries managed by this interface The list contains a series of tuples describing all libraries managed by @@ -65,7 +68,7 @@ class MaterialManagerExternal(ABC): pass @abstractmethod - def modelLibraries(self) -> list: #[MaterialLibraryType]: + def modelLibraries(self) -> list[MaterialLibraryType]: """Returns a list of libraries managed by this interface The list contains a series of tuples describing all libraries managed by @@ -78,7 +81,7 @@ class MaterialManagerExternal(ABC): pass @abstractmethod - def materialLibraries(self) -> list: #[MaterialLibraryType]: + def materialLibraries(self) -> list[MaterialLibraryType]: """Returns a list of libraries managed by this interface The list contains a series of tuples describing all libraries managed by @@ -98,7 +101,7 @@ class MaterialManagerExternal(ABC): pass @abstractmethod - def createLibrary(self, name: str, icon: str, readOnly: bool) -> None: + def createLibrary(self, name: str, icon: bytes, readOnly: bool) -> None: """Create a new library Create a new library with the given name""" @@ -112,7 +115,7 @@ class MaterialManagerExternal(ABC): pass @abstractmethod - def changeIcon(self, name: str, icon: str) -> None: + def changeIcon(self, name: str, icon: bytes) -> None: """Change the library icon Change the library icon""" @@ -126,7 +129,7 @@ class MaterialManagerExternal(ABC): pass @abstractmethod - def libraryModels(self, library: str) -> list: #[MaterialLibraryObjectType]: + def libraryModels(self, library: str) -> list[MaterialLibraryObjectType]: """Returns a list of models managed by this library Each list entry is a tuple containing the UUID, path, and name of the model""" @@ -135,7 +138,7 @@ class MaterialManagerExternal(ABC): @abstractmethod def libraryMaterials(self, library: str, filter: Materials.MaterialFilter = None, - options: Materials.MaterialFilterOptions = None) -> list: #[MaterialLibraryObjectType]: + options: Materials.MaterialFilterOptions = None) -> list[MaterialLibraryObjectType]: """Returns a list of materials managed by this library Each list entry is a tuple containing the UUID, path, and name of the material""" From ac0e188141c9615d8c0e60d7fd63433f5fffccfe Mon Sep 17 00:00:00 2001 From: Benjamin Nauck Date: Tue, 8 Apr 2025 23:06:21 +0200 Subject: [PATCH 07/63] Base: Require clamp to take arithmetic values use std::clamp internally, function should probably be removed --- src/Base/Tools.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/Base/Tools.h b/src/Base/Tools.h index 182d804000..fba72f2890 100644 --- a/src/Base/Tools.h +++ b/src/Base/Tools.h @@ -113,9 +113,10 @@ inline manipulator blanks(int n) // ---------------------------------------------------------------------------- template + requires std::is_arithmetic_v inline T clamp(T num, T lower, T upper) { - return std::max(std::min(upper, num), lower); + return std::clamp(num, lower, upper); } template From f12a63af87412ef1eecfcefab71c35c4ebaee392 Mon Sep 17 00:00:00 2001 From: Benjamin Nauck Date: Tue, 8 Apr 2025 23:10:10 +0200 Subject: [PATCH 08/63] Base: Make sgn branchless --- src/Base/Tools.h | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/src/Base/Tools.h b/src/Base/Tools.h index fba72f2890..895f7922dc 100644 --- a/src/Base/Tools.h +++ b/src/Base/Tools.h @@ -119,14 +119,16 @@ inline T clamp(T num, T lower, T upper) return std::clamp(num, lower, upper); } -template -inline T sgn(T t) +/// Returns -1, 0 or 1 depending on if the value is negative, zero or positive +/// As this function might be used in hot paths, it uses branchless implementation +template +constexpr std::enable_if_t && std::is_signed_v, T> sgn(T val) { - if (t == 0) { - return T(0); - } + int oneIfPositive = int(0 < val); + int oneIfNegative = int(val < 0); + return T(oneIfPositive - oneIfNegative); // 0/1 - 0/1 = -1/0/1 +} - return (t > 0) ? T(1) : T(-1); } template From 494434fc5f81986d389fc76c42ceb9dc66a9fb36 Mon Sep 17 00:00:00 2001 From: Benjamin Nauck Date: Tue, 8 Apr 2025 23:12:12 +0200 Subject: [PATCH 09/63] Base: Make degrees and radians convertions safer and faster --- src/Base/Tools.h | 32 ++++++++++++++++++++++++++------ 1 file changed, 26 insertions(+), 6 deletions(-) diff --git a/src/Base/Tools.h b/src/Base/Tools.h index 895f7922dc..567814191c 100644 --- a/src/Base/Tools.h +++ b/src/Base/Tools.h @@ -129,18 +129,38 @@ constexpr std::enable_if_t && std::is_signed_v, T> sg return T(oneIfPositive - oneIfNegative); // 0/1 - 0/1 = -1/0/1 } +/// Convert degrees to radians, allow deduction for floating point types +template +constexpr T toRadians(T degrees) +{ + constexpr auto degToRad = std::numbers::pi_v / T(180); + return degrees * degToRad; } -template -inline T toRadians(T d) +/// Convert degrees to radians, allow **explicit-only** for any arithmetic type +template + requires(std::is_arithmetic_v && !std::floating_point) +constexpr T toRadians(std::type_identity_t degrees) { - return static_cast((d * std::numbers::pi) / 180.0); + using ResultT = std::conditional_t, double, T>; + return static_cast(toRadians(static_cast(degrees))); } -template -inline T toDegrees(T r) +/// Convert radians to degrees, allow deduction for floating point types +template +constexpr T toDegrees(T radians) { - return static_cast((r / std::numbers::pi) * 180.0); + constexpr auto radToDeg = T(180) / std::numbers::pi_v; + return radians * radToDeg; +} + +/// Convert radians to degrees, allow **explicit-only** for any arithmetic type +template + requires(std::is_arithmetic_v && !std::floating_point) +constexpr T toDegrees(std::type_identity_t radians) +{ + using ResultT = std::conditional_t, double, T>; + return static_cast(toDegrees(static_cast(radians))); } inline float fromPercent(const long value) From 282662e735603f7f6408a081c2a7875b837e5712 Mon Sep 17 00:00:00 2001 From: Benjamin Nauck Date: Tue, 8 Apr 2025 23:12:48 +0200 Subject: [PATCH 10/63] Base: make our fmod require floating point values --- src/Base/Tools.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Base/Tools.h b/src/Base/Tools.h index 567814191c..88982c0ae6 100644 --- a/src/Base/Tools.h +++ b/src/Base/Tools.h @@ -173,7 +173,7 @@ inline long toPercent(float value) return std::lround(100.0 * value); } -template +template inline T fmod(T numerator, T denominator) { T modulo = std::fmod(numerator, denominator); From d1918be11cd6509571806b7bf974f3d4617a7562 Mon Sep 17 00:00:00 2001 From: Jacob Oursland Date: Sat, 12 Apr 2025 23:16:32 -0700 Subject: [PATCH 11/63] pixi: Unset CFLAGS, CXXFLAGS, DEBUG_CFLAGS, and DEBUG_CXXFLAGS. pixi sets a variety of environment variables, which unfortunately includes compiler optimization flags. This PR unsets the compiler flags for parity with other environments. A consequence of this is that debug builds are no longer build with high optimization, which is a desirable outcome. --- pixi.toml | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/pixi.toml b/pixi.toml index 49699858d5..daade9f401 100644 --- a/pixi.toml +++ b/pixi.toml @@ -120,29 +120,29 @@ sed = "*" ## Qt 6 Configuration Presets [target.linux-64.tasks] -configure = { cmd = [ "cmake", "-B", "build", "--preset", "conda-linux-debug", "-DFREECAD_QT_VERSION=6", "-DBUILD_REVERSEENGINEERING=OFF" ], depends-on = ["initialize"]} -configure-debug = { cmd = [ "cmake", "-B", "build", "--preset", "conda-linux-debug", "-DFREECAD_QT_VERSION=6", "-DBUILD_REVERSEENGINEERING=OFF" ], depends-on = ["initialize"]} -configure-release = { cmd = [ "cmake", "-B", "build", "--preset", "conda-linux-release", "-DFREECAD_QT_VERSION=6", "-DBUILD_REVERSEENGINEERING=OFF" ], depends-on = ["initialize"]} +configure = { cmd = [ "cmake", "-B", "build", "--preset", "conda-linux-debug", "-DFREECAD_QT_VERSION=6", "-DBUILD_REVERSEENGINEERING=OFF" ], depends-on = ["initialize"], env={ CFLAGS="", CXXFLAGS="", DEBUG_CFLAGS="", DEBUG_CXXFLAGS="" }} +configure-debug = { cmd = [ "cmake", "-B", "build", "--preset", "conda-linux-debug", "-DFREECAD_QT_VERSION=6", "-DBUILD_REVERSEENGINEERING=OFF" ], depends-on = ["initialize"], env={ CFLAGS="", CXXFLAGS="", DEBUG_CFLAGS="", DEBUG_CXXFLAGS="" }} +configure-release = { cmd = [ "cmake", "-B", "build", "--preset", "conda-linux-release", "-DFREECAD_QT_VERSION=6", "-DBUILD_REVERSEENGINEERING=OFF" ], depends-on = ["initialize"], env={ CFLAGS="", CXXFLAGS="", DEBUG_CFLAGS="", DEBUG_CXXFLAGS="" }} [target.linux-aarch64.tasks] -configure = { cmd = [ "cmake", "-B", "build", "--preset", "conda-linux-debug", "-DFREECAD_QT_VERSION=6", "-DBUILD_REVERSEENGINEERING=OFF" ], depends-on= ["initialize"]} -configure-debug = { cmd = [ "cmake", "-B", "build", "--preset", "conda-linux-debug", "-DFREECAD_QT_VERSION=6", "-DBUILD_REVERSEENGINEERING=OFF" ], depends-on= ["initialize"]} -configure-release = { cmd = [ "cmake", "-B", "build", "--preset", "conda-linux-release", "-DFREECAD_QT_VERSION=6", "-DBUILD_REVERSEENGINEERING=OFF" ], depends-on= ["initialize"]} +configure = { cmd = [ "cmake", "-B", "build", "--preset", "conda-linux-debug", "-DFREECAD_QT_VERSION=6", "-DBUILD_REVERSEENGINEERING=OFF" ], depends-on= ["initialize"], env={ CFLAGS="", CXXFLAGS="", DEBUG_CFLAGS="", DEBUG_CXXFLAGS="" }} +configure-debug = { cmd = [ "cmake", "-B", "build", "--preset", "conda-linux-debug", "-DFREECAD_QT_VERSION=6", "-DBUILD_REVERSEENGINEERING=OFF" ], depends-on= ["initialize"], env={ CFLAGS="", CXXFLAGS="", DEBUG_CFLAGS="", DEBUG_CXXFLAGS="" }} +configure-release = { cmd = [ "cmake", "-B", "build", "--preset", "conda-linux-release", "-DFREECAD_QT_VERSION=6", "-DBUILD_REVERSEENGINEERING=OFF" ], depends-on= ["initialize"], env={ CFLAGS="", CXXFLAGS="", DEBUG_CFLAGS="", DEBUG_CXXFLAGS="" }} [target.osx-64.tasks] -configure = { cmd = [ "cmake", "-B", "build", "--preset", "conda-macos-debug", "-DFREECAD_QT_VERSION=6", "-DBUILD_REVERSEENGINEERING=OFF" ], depends-on = ["initialize"]} -configure-debug = { cmd = [ "cmake", "-B", "build", "--preset", "conda-macos-debug", "-DFREECAD_QT_VERSION=6", "-DBUILD_REVERSEENGINEERING=OFF" ], depends-on = ["initialize"]} -configure-release = { cmd = [ "cmake", "-B", "build", "--preset", "conda-macos-release", "-DFREECAD_QT_VERSION=6", "-DBUILD_REVERSEENGINEERING=OFF" ], depends-on = ["initialize"]} +configure = { cmd = [ "cmake", "-B", "build", "--preset", "conda-macos-debug", "-DFREECAD_QT_VERSION=6", "-DBUILD_REVERSEENGINEERING=OFF" ], depends-on = ["initialize"], env={ CFLAGS="", CXXFLAGS="", DEBUG_CFLAGS="", DEBUG_CXXFLAGS="" }} +configure-debug = { cmd = [ "cmake", "-B", "build", "--preset", "conda-macos-debug", "-DFREECAD_QT_VERSION=6", "-DBUILD_REVERSEENGINEERING=OFF" ], depends-on = ["initialize"], env={ CFLAGS="", CXXFLAGS="", DEBUG_CFLAGS="", DEBUG_CXXFLAGS="" }} +configure-release = { cmd = [ "cmake", "-B", "build", "--preset", "conda-macos-release", "-DFREECAD_QT_VERSION=6", "-DBUILD_REVERSEENGINEERING=OFF" ], depends-on = ["initialize"], env={ CFLAGS="", CXXFLAGS="", DEBUG_CFLAGS="", DEBUG_CXXFLAGS="" }} [target.osx-arm64.tasks] -configure = { cmd = [ "cmake", "-B", "build", "--preset", "conda-macos-debug", "-DFREECAD_QT_VERSION=6", "-DBUILD_REVERSEENGINEERING=OFF" ], depends-on = ["initialize"]} -configure-debug = { cmd = [ "cmake", "-B", "build", "--preset", "conda-macos-debug", "-DFREECAD_QT_VERSION=6", "-DBUILD_REVERSEENGINEERING=OFF" ], depends-on = ["initialize"]} -configure-release = { cmd = [ "cmake", "-B", "build", "--preset", "conda-macos-release", "-DFREECAD_QT_VERSION=6", "-DBUILD_REVERSEENGINEERING=OFF" ], depends-on = ["initialize"]} +configure = { cmd = [ "cmake", "-B", "build", "--preset", "conda-macos-debug", "-DFREECAD_QT_VERSION=6", "-DBUILD_REVERSEENGINEERING=OFF" ], depends-on = ["initialize"], env={ CFLAGS="", CXXFLAGS="", DEBUG_CFLAGS="", DEBUG_CXXFLAGS="" }} +configure-debug = { cmd = [ "cmake", "-B", "build", "--preset", "conda-macos-debug", "-DFREECAD_QT_VERSION=6", "-DBUILD_REVERSEENGINEERING=OFF" ], depends-on = ["initialize"], env={ CFLAGS="", CXXFLAGS="", DEBUG_CFLAGS="", DEBUG_CXXFLAGS="" }} +configure-release = { cmd = [ "cmake", "-B", "build", "--preset", "conda-macos-release", "-DFREECAD_QT_VERSION=6", "-DBUILD_REVERSEENGINEERING=OFF" ], depends-on = ["initialize"], env={ CFLAGS="", CXXFLAGS="", DEBUG_CFLAGS="", DEBUG_CXXFLAGS="" }} [target.win-64.tasks] -configure = { cmd = [ "cmake", "-B", "build", "--preset", "conda-windows-debug", "-DFREECAD_QT_VERSION=6", "-DBUILD_REVERSEENGINEERING=OFF" ], depends-on = ["initialize"]} -configure-debug = { cmd = [ "cmake", "-B", "build", "--preset", "conda-windows-debug", "-DFREECAD_QT_VERSION=6", "-DBUILD_REVERSEENGINEERING=OFF" ], depends-on = ["initialize"]} -configure-release = { cmd = [ "cmake", "-B", "build", "--preset", "conda-windows-release", "-DFREECAD_QT_VERSION=6", "-DBUILD_REVERSEENGINEERING=OFF" ], depends-on = ["initialize"]} +configure = { cmd = [ "cmake", "-B", "build", "--preset", "conda-windows-debug", "-DFREECAD_QT_VERSION=6", "-DBUILD_REVERSEENGINEERING=OFF", "-DCMAKE_GENERATOR_PLATFORM=", "-DCMAKE_GENERATOR_TOOLSET=" ], depends-on = ["initialize"], env={ CFLAGS="", CXXFLAGS="", DEBUG_CFLAGS="", DEBUG_CXXFLAGS="" }} +configure-debug = { cmd = [ "cmake", "-B", "build", "--preset", "conda-windows-debug", "-DFREECAD_QT_VERSION=6", "-DBUILD_REVERSEENGINEERING=OFF", "-DCMAKE_GENERATOR_PLATFORM=", "-DCMAKE_GENERATOR_TOOLSET=" ], depends-on = ["initialize"], env={ CFLAGS="", CXXFLAGS="", DEBUG_CFLAGS="", DEBUG_CXXFLAGS="" }} +configure-release = { cmd = [ "cmake", "-B", "build", "--preset", "conda-windows-release", "-DFREECAD_QT_VERSION=6", "-DBUILD_REVERSEENGINEERING=OFF", "-DCMAKE_GENERATOR_PLATFORM=", "-DCMAKE_GENERATOR_TOOLSET=" ], depends-on = ["initialize"], env={ CFLAGS="", CXXFLAGS="", DEBUG_CFLAGS="", DEBUG_CXXFLAGS="" }} freecad = { cmd = [ ".pixi/envs/default/Library/bin/FreeCAD.exe" ], depends-on = ["install"]} ## Tasks From 4434cebcacd2a2769652916bd08d3d99a38246ef Mon Sep 17 00:00:00 2001 From: tarman3 Date: Sat, 12 Apr 2025 00:08:50 +0300 Subject: [PATCH 12/63] Less warning with Array DressUp --- src/Mod/CAM/Path/Op/Gui/Array.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/Mod/CAM/Path/Op/Gui/Array.py b/src/Mod/CAM/Path/Op/Gui/Array.py index 0e670d76d7..ef63c9c815 100644 --- a/src/Mod/CAM/Path/Op/Gui/Array.py +++ b/src/Mod/CAM/Path/Op/Gui/Array.py @@ -146,6 +146,8 @@ class ObjectArray: self.setEditorModes(obj) obj.Proxy = self + self.FirstRun = True + def dumps(self): return None @@ -205,8 +207,8 @@ class ObjectArray: self.setEditorModes(obj) def execute(self, obj): - if FreeCAD.GuiUp: - + if FreeCAD.GuiUp and self.FirstRun: + self.FirstRun = False QtGui.QMessageBox.warning( None, QT_TRANSLATE_NOOP("CAM_ArrayOp", "Operation is depreciated"), From 9ca9d1b1f1b2e58fb3d63d3b7f8e4d19f687b75e Mon Sep 17 00:00:00 2001 From: tarman3 Date: Sat, 12 Apr 2025 08:07:57 +0300 Subject: [PATCH 13/63] Fix typos in warning message --- src/Mod/CAM/Path/Op/Gui/Array.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/Mod/CAM/Path/Op/Gui/Array.py b/src/Mod/CAM/Path/Op/Gui/Array.py index ef63c9c815..73cdad5804 100644 --- a/src/Mod/CAM/Path/Op/Gui/Array.py +++ b/src/Mod/CAM/Path/Op/Gui/Array.py @@ -211,15 +211,15 @@ class ObjectArray: self.FirstRun = False QtGui.QMessageBox.warning( None, - QT_TRANSLATE_NOOP("CAM_ArrayOp", "Operation is depreciated"), + QT_TRANSLATE_NOOP("CAM_ArrayOp", "Operation is deprecated"), QT_TRANSLATE_NOOP( "CAM_ArrayOp", ( - "CAM -> Path Modification -> Array operation is depreciated " + "CAM -> Path Modification -> Array operation is deprecated " "and will be removed in future FreeCAD versions.\n\n" "Please use CAM -> Path Dressup -> Array instead.\n\n" "DO NOT USE CURRENT ARRAY OPERATION WHEN MACHINING WITH COOLANT!\n" - "Due to a bug - collant will not be enabled for array paths." + "Due to a bug - coolant will not be enabled for array paths." ), ), ) From f6df2b1c5f458bade1610e2458d0f2c7f837419c Mon Sep 17 00:00:00 2001 From: Jackson Oursland Date: Mon, 14 Apr 2025 08:16:58 -0700 Subject: [PATCH 14/63] Add cmake to Ubuntu package dependencies. (#20578) --- package/ubuntu/install-apt-packages.sh | 1 + 1 file changed, 1 insertion(+) diff --git a/package/ubuntu/install-apt-packages.sh b/package/ubuntu/install-apt-packages.sh index 2fff06ea6e..1a7cacf532 100755 --- a/package/ubuntu/install-apt-packages.sh +++ b/package/ubuntu/install-apt-packages.sh @@ -12,6 +12,7 @@ fi packages=( ccache + cmake doxygen graphviz imagemagick From 122dc056ab890b8ab10959d762417a18ab91f986 Mon Sep 17 00:00:00 2001 From: Roy-043 Date: Sat, 5 Apr 2025 16:07:52 +0200 Subject: [PATCH 15/63] BIM: BIM_Leader would create a wire with fewer than 2 points If the BIM_Leader was escaped without clicking a point, or after cicking only 1 point, a Draft_Wire object would still be created. --- src/Mod/BIM/bimcommands/BimLeader.py | 53 +++++++++------------------- 1 file changed, 17 insertions(+), 36 deletions(-) diff --git a/src/Mod/BIM/bimcommands/BimLeader.py b/src/Mod/BIM/bimcommands/BimLeader.py index 199c4fa1ee..be6aeb37ab 100644 --- a/src/Mod/BIM/bimcommands/BimLeader.py +++ b/src/Mod/BIM/bimcommands/BimLeader.py @@ -56,45 +56,26 @@ class BIM_Leader(gui_lines.Line): def finish(self, closed=False, cont=False): import DraftVecUtils + from draftutils import params self.end_callbacks(self.call) self.removeTemporaryObject() - if getattr(self,"oldWP",None): - FreeCAD.DraftWorkingPlane = self.oldWP - if hasattr(Gui, "Snapper"): - FreeCADGui.Snapper.setGrid() - FreeCADGui.Snapper.restack() - self.oldWP = None - rot, sup, pts, fil = self.getStrings() - if self.node: + if len(self.node) > 1: + rot, sup, pts, fil = self.getStrings() base = DraftVecUtils.toString(self.node[0]) - else: - base = DraftVecUtils.toString(FreeCAD.Vector()) - color = FreeCAD.ParamGet( - "User parameter:BaseApp/Preferences/Mod/Draft" - ).GetUnsigned("DefaultTextColor", 255) - r = ((color >> 24) & 0xFF) / 255.0 - g = ((color >> 16) & 0xFF) / 255.0 - b = ((color >> 8) & 0xFF) / 255.0 - cmd_list = [ - "pl = FreeCAD.Placement()", - "pl.Rotation.Q = " + rot, - "pl.Base = " + base, - "points = " + pts, - "leader = Draft.makeWire(points,placement=pl)", - "leader.ViewObject.LineColor = " - + str( - ( - r, - g, - b, - ) - ), - "leader.ViewObject.EndArrow = True", - "Draft.autogroup(leader)", - "FreeCAD.ActiveDocument.recompute()", - ] - FreeCADGui.addModule("Draft") - self.commit(translate("BIM", "Create Leader"), cmd_list) + color = params.get_param("DefaultTextColor") | 0x000000FF + cmd_list = [ + "pl = FreeCAD.Placement()", + "pl.Rotation.Q = " + rot, + "pl.Base = " + base, + "points = " + pts, + "leader = Draft.make_wire(points, placement=pl)", + "leader.ViewObject.LineColor = " + str(color), + "leader.ViewObject.EndArrow = True", + "Draft.autogroup(leader)", + "FreeCAD.ActiveDocument.recompute()", + ] + FreeCADGui.addModule("Draft") + self.commit(translate("BIM", "Create Leader"), cmd_list) super(gui_lines.Line, self).finish() if self.ui and self.ui.continueMode: self.Activated() From 8e7d3325b3ca880e52c732d66648b7e0348a6cc0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Benjamin=20Br=C3=A6strup=20Sayoc?= Date: Sun, 16 Mar 2025 01:35:04 +0100 Subject: [PATCH 16/63] TechDraw: refactor click handles for editable fields Fixes #19387 --- src/Mod/TechDraw/Gui/QGISVGTemplate.cpp | 278 +++++++++++++----------- src/Mod/TechDraw/Gui/QGISVGTemplate.h | 18 +- 2 files changed, 162 insertions(+), 134 deletions(-) diff --git a/src/Mod/TechDraw/Gui/QGISVGTemplate.cpp b/src/Mod/TechDraw/Gui/QGISVGTemplate.cpp index 8b852382c1..6eb5a75c08 100644 --- a/src/Mod/TechDraw/Gui/QGISVGTemplate.cpp +++ b/src/Mod/TechDraw/Gui/QGISVGTemplate.cpp @@ -24,6 +24,7 @@ #ifndef _PreComp_ # include # include +# include # include # include # include @@ -47,17 +48,85 @@ #include "Rez.h" #include "TemplateTextField.h" #include "ZVALUE.h" +#include "DrawGuiUtil.h" + + + +namespace { + QFont getFont(QDomElement& elem) + { + if(elem.hasAttribute(QStringLiteral("font-family"))) { + return elem.attribute(QStringLiteral("font-family")); + } + QDomElement parent = elem.parentNode().toElement(); + // Check if has parent + if(!parent.isNull()) { + // Traverse up and check if parent node has attribute + return getFont(parent); + } + // No attribute and no parent nodes left? Defaulting: + return QFont(QStringLiteral("sans")); + } + + std::vector getFCElements(QDomDocument& doc) { + QDomNodeList textElements = doc.elementsByTagName(QStringLiteral("text")); + std::vector filteredTextElements; + filteredTextElements.reserve(textElements.size()); + for(int i = 0; i < textElements.size(); i++) { + QDomElement textElement = textElements.at(i).toElement(); + if(textElement.hasAttribute(QStringLiteral(FREECAD_ATTR_EDITABLE))) { + filteredTextElements.push_back(textElement); + } + } + return filteredTextElements; + } + + void applyWorkaround(QByteArray& svgCode) + { + QDomDocument doc; + doc.setContent(svgCode); + + // Example sadasd + // QSvgRenderer::boundsOnElement calculates the bounds of the text element using text width of the `tspan` + // but faultly the text height of the `text` element that might have another font size. The width + // of a `tspan will also always be one character too wide. + // Workaround: apply the font-size of the `tspan` to its parent `text` and remove `tspan` completely + std::vector textElements = getFCElements(doc); + for(QDomElement& textElement : textElements) { + QDomElement tspan = textElement.firstChildElement(QStringLiteral("tspan")); + if(tspan.isNull()) { + continue; + } + + if(tspan.hasAttribute(QStringLiteral("font-size"))) { + QString fontSize = tspan.attribute(QStringLiteral("font-size")); + textElement.setAttribute(QStringLiteral("font-size"), fontSize); + } + if(tspan.hasAttribute(QStringLiteral("x"))) { + QString x = tspan.attribute(QStringLiteral("x")); + textElement.setAttribute(QStringLiteral("x"), x); + } + if(tspan.hasAttribute(QStringLiteral("y"))) { + QString y = tspan.attribute(QStringLiteral("y")); + textElement.setAttribute(QStringLiteral("y"), y); + } + + // Delete tspan, but keep tspan content + textElement.replaceChild(tspan.firstChild(), tspan); + } + + svgCode = doc.toByteArray(); + } +} // anonymous namespace using namespace TechDrawGui; using namespace TechDraw; -QGISVGTemplate::QGISVGTemplate(QGSPage* scene) : QGITemplate(scene), firstTime(true) +QGISVGTemplate::QGISVGTemplate(QGSPage* scene) : QGITemplate(scene), + m_svgItem(new QGraphicsSvgItem(this)), + m_svgRender(new QSvgRenderer()) { - - m_svgItem = new QGraphicsSvgItem(this); - m_svgRender = new QSvgRenderer(); - m_svgItem->setSharedRenderer(m_svgRender); m_svgItem->setFlags(QGraphicsItem::ItemClipsToShape); @@ -73,23 +142,20 @@ QGISVGTemplate::~QGISVGTemplate() { delete m_svgRender; } void QGISVGTemplate::openFile(const QFile& file) { Q_UNUSED(file); } -void QGISVGTemplate::load(const QByteArray& svgCode) +void QGISVGTemplate::load(QByteArray svgCode) { + applyWorkaround(svgCode); m_svgRender->load(svgCode); QSize size = m_svgRender->defaultSize(); m_svgItem->setSharedRenderer(m_svgRender); - if (firstTime) { - createClickHandles(); - firstTime = false; - } + createClickHandles(); //convert from pixels or mm or inches in svg file to mm page size TechDraw::DrawSVGTemplate* tmplte = getSVGTemplate(); - double xaspect, yaspect; - xaspect = tmplte->getWidth() / static_cast(size.width()); - yaspect = tmplte->getHeight() / static_cast(size.height()); + double xaspect = tmplte->getWidth() / static_cast(size.width()); + double yaspect = tmplte->getHeight() / static_cast(size.height()); QTransform qtrans; qtrans.translate(0.0, Rez::guiX(-tmplte->getHeight())); @@ -97,8 +163,8 @@ void QGISVGTemplate::load(const QByteArray& svgCode) m_svgItem->setTransform(qtrans); if (Preferences::lightOnDark()) { - QColor color = PreferencesGui::getAccessibleQColor(QColor(Qt::black)); - QGraphicsColorizeEffect* colorizeEffect = new QGraphicsColorizeEffect(); + auto color = PreferencesGui::getAccessibleQColor(QColor(Qt::black)); + auto* colorizeEffect = new QGraphicsColorizeEffect(); colorizeEffect->setColor(color); m_svgItem->setGraphicsEffect(colorizeEffect); } @@ -115,9 +181,8 @@ TechDraw::DrawSVGTemplate* QGISVGTemplate::getSVGTemplate() if (pageTemplate && pageTemplate->isDerivedFrom()) { return static_cast(pageTemplate); } - else { - return nullptr; - } + + return nullptr; } void QGISVGTemplate::draw() @@ -132,12 +197,30 @@ void QGISVGTemplate::draw() void QGISVGTemplate::updateView(bool update) { - Q_UNUSED(update); + if (update) { + clearClickHandles(); + createClickHandles(); + } draw(); } +void QGISVGTemplate::clearClickHandles() +{ + prepareGeometryChange(); + constexpr int TemplateTextFieldType{QGraphicsItem::UserType + 160}; + auto templateChildren = childItems(); + for (auto& child : templateChildren) { + if (child->type() == TemplateTextFieldType) { + child->hide(); + scene()->removeItem(child); + delete child; + } + } +} + void QGISVGTemplate::createClickHandles() { + prepareGeometryChange(); TechDraw::DrawSVGTemplate* svgTemplate = getSVGTemplate(); if (svgTemplate->isRestoring()) { //the embedded file is not available yet, so just return @@ -167,128 +250,75 @@ void QGISVGTemplate::createClickHandles() //TODO: Find location of special fields (first/third angle) and make graphics items for them - QColor editClickBoxColor = PreferencesGui::templateClickBoxColor(); - auto textMap = svgTemplate->EditableTexts.getValues(); TechDraw::XMLQuery query(templateDocument); - // XPath query to select all nodes with "freecad:editable" attribute - // XPath query to select all nodes whose parent - // has "freecad:editable" attribute - query.processItems(QStringLiteral("declare default element namespace \"" SVG_NS_URI "\"; " - "declare namespace freecad=\"" FREECAD_SVG_NS_URI "\"; " - "//text[@" FREECAD_ATTR_EDITABLE "]/tspan"), - [&](QDomElement& tspan) -> bool { - QString fontSizeString = tspan.attribute(QStringLiteral("font-size")); - QDomElement textElement = tspan.parentNode().toElement(); - QString textAnchorString = textElement.attribute(QStringLiteral("text-anchor")); - QString name = textElement.attribute(QString::fromUtf8(FREECAD_ATTR_EDITABLE)); - double x = Rez::guiX( - textElement.attribute(QStringLiteral("x"), QStringLiteral("0.0")).toDouble()); - double y = Rez::guiX( - textElement.attribute(QStringLiteral("y"), QStringLiteral("0.0")).toDouble()); - if (name.isEmpty()) { - Base::Console().Warning( - "QGISVGTemplate::createClickHandles - no name for editable text at %f, %f\n", x, y); - return true; + std::vector textElements = getFCElements(templateDocument); + for(QDomElement& textElement : textElements) { + // Get elements bounding box of text + QString id = textElement.attribute(QStringLiteral("id")); + QRectF textRect = m_svgRender->boundsOnElement(id); + + // Get tight bounding box of text + QDomElement tspan = textElement.firstChildElement(); + QFont font = getFont(tspan); + QFontMetricsF fm(font); + double factor = textRect.height() / fm.height(); // Correcting font metrics and SVG text due to different font sizes + QRectF tightTextRect = textRect.adjusted(0.0, 0.0, 0.0, -fm.descent() * factor); + tightTextRect.setTop(tightTextRect.bottom() - fm.capHeight() * factor); + + // Ensure min size; if no text content, tightTextRect will have no size + // and factor will also be incorrect + + // Default font size guess. Getting attribute seems complicated, as it can have different units + // and both be in style attribute and native attribute + font.setPointSizeF(1.5); + fm = QFontMetricsF(font); + + if (tightTextRect.height() < fm.capHeight()) { + tightTextRect.setTop(tightTextRect.bottom() - fm.capHeight()); } - std::string editableNameString = textMap[name.toStdString()]; - - // default box size - double textHeight{0}; - QString style = textElement.attribute(QStringLiteral("style")); - if (!style.isEmpty()) { - // get text attributes from style element - textHeight = getFontSizeFromStyle(style); + double charWidth = fm.horizontalAdvance(QLatin1Char(' ')); + if(tightTextRect.width() < charWidth) { + tightTextRect.setWidth(charWidth); } - if (textHeight == 0) { - textHeight = getFontSizeFromElement(fontSizeString); - } - - if (textHeight == 0.0) { - textHeight = Preferences::labelFontSizeMM() * 3.78; // 3.78 = px/mm - } - - QGraphicsTextItem textItemForLength; - QFont fontForLength(Preferences::labelFontQString()); - fontForLength.setPixelSize(textHeight); - textItemForLength.setFont(fontForLength); - textItemForLength.setPlainText(QString::fromStdString(editableNameString)); - auto brect = textItemForLength.boundingRect(); - auto newLength = brect.width(); - - double charWidth = newLength / editableNameString.length(); - if (textAnchorString == QStringLiteral("middle")) { - x = x - editableNameString.length() * charWidth / 2; - } - - double textLength = editableNameString.length() * charWidth; - textLength = std::max(charWidth, textLength); + // Transform tight bounding box of text + QPolygonF tightTextPoly(tightTextRect); // Polygon because rect cannot be rotated + QTransform SVGTransform = m_svgRender->transformForElement(id); + tightTextPoly = SVGTransform.map(tightTextPoly); // SVGTransform always before templateTransform + QTransform templateTransform; + templateTransform.translate(0.0, Rez::guiX(-getSVGTemplate()->getHeight())); + templateTransform.scale(Rez::getRezFactor(), Rez::getRezFactor()); + tightTextPoly = templateTransform.map(tightTextPoly); + QString name = textElement.attribute(QStringLiteral(FREECAD_ATTR_EDITABLE)); auto item(new TemplateTextField(this, svgTemplate, name.toStdString())); auto autoValue = svgTemplate->getAutofillByEditableName(name); item->setAutofill(autoValue); - double pad = 1.0; - double top = Rez::guiX(-svgTemplate->getHeight()) + y - textHeight - pad; - double bottom = top + textHeight + 2.0 * pad; - double left = x - pad; - item->setRectangle(QRectF(left, top, - newLength + 2.0 * pad, textHeight + 2.0 * pad)); - item->setLine(QPointF( left, bottom), - QPointF(left + newLength + 2.0 * pad, bottom)); - item->setLineColor(editClickBoxColor); + QMarginsF padding( + 0.0, + 0.15 * tightTextRect.height(), + 0.0, + 0.2 * tightTextRect.height() + ); + QRectF clickrect = tightTextRect.marginsAdded(padding); + QPolygonF clickpoly = SVGTransform.map(clickrect); + clickpoly = templateTransform.map(clickpoly); + item->setRectangle(clickpoly.boundingRect()); // TODO: templateTextField doesn't support polygon yet + QPointF bottomLeft = clickpoly.at(3); + QPointF bottomRight = clickpoly.at(2); + item->setLine(bottomLeft, bottomRight); + item->setLineColor(PreferencesGui::templateClickBoxColor()); item->setZValue(ZVALUE::SVGTEMPLATE + 1); + addToGroup(item); - textFields.push_back(item); - return true; - }); + } } -//! find the font-size hidden in a style element -double QGISVGTemplate::getFontSizeFromStyle(QString style) -{ - if (style.isEmpty()) { - return 0.0; - } - - // get text attributes from style element - QRegularExpression rxFontSize(QStringLiteral("font-size:([0-9]*.?[0-9]*)px;")); - QRegularExpressionMatch match; - - int pos{0}; - pos = style.indexOf(rxFontSize, 0, &match); - if (pos != -1) { - return Rez::guiX(match.captured(1).toDouble()); - } - - return 0.0; -} - -//! find the font-size hidden in a style element -double QGISVGTemplate::getFontSizeFromElement(QString element) -{ - if (element.isEmpty()) { - return 0.0; - } - - // font-size="3.95px" - QRegularExpression rxFontSize(QStringLiteral("([0-9]*.?[0-9]*)px")); - QRegularExpressionMatch match; - - int pos{0}; - pos = element.indexOf(rxFontSize, 0, &match); - if (pos != -1) { - return Rez::guiX(match.captured(1).toDouble()); - } - - return 0.0; -} - - #include diff --git a/src/Mod/TechDraw/Gui/QGISVGTemplate.h b/src/Mod/TechDraw/Gui/QGISVGTemplate.h index 2a0ea1f788..583e379b4d 100644 --- a/src/Mod/TechDraw/Gui/QGISVGTemplate.h +++ b/src/Mod/TechDraw/Gui/QGISVGTemplate.h @@ -25,25 +25,24 @@ #include - class QGraphicsScene; class QGraphicsSvgItem; class QSvgRenderer; class QFile; class QString; +#include "QGITemplate.h" + namespace TechDraw { class DrawSVGTemplate; } -#include "QGITemplate.h" - namespace TechDrawGui { class QGSPage; -class TechDrawGuiExport QGISVGTemplate: public QGITemplate +class TechDrawGuiExport QGISVGTemplate : public TechDrawGui::QGITemplate { Q_OBJECT @@ -64,13 +63,12 @@ public: protected: void openFile(const QFile& file); - void load(const QByteArray& svgCode); - void createClickHandles(void); - static double getFontSizeFromStyle(QString style); - static double getFontSizeFromElement(QString element); + void load(QByteArray svgCode); -protected: - bool firstTime; + void createClickHandles(); + void clearClickHandles(); + +private: QGraphicsSvgItem* m_svgItem; QSvgRenderer* m_svgRender; };// class QGISVGTemplate From 58cc0014e1a660a9090b5d0a443d256afead980d Mon Sep 17 00:00:00 2001 From: David Carter Date: Wed, 2 Apr 2025 00:07:25 -0400 Subject: [PATCH 17/63] Dependencies: Add lru-cache library Adds a generic C++ based caching library to support material external modules. This is a template based library which means there is nothing to build or link. The only modification is to the CMakeLists.txt file to enable integration with FreeCAD, Original source: https://github.com/goldsborough/lru-cache --- src/3rdParty/CMakeLists.txt | 4 + src/3rdParty/lru-cache/CMakeLists.txt | 73 + src/3rdParty/lru-cache/LICENSE | 19 + src/3rdParty/lru-cache/README.md | 304 +++ src/3rdParty/lru-cache/cpplint.cfg | 3 + src/3rdParty/lru-cache/docs/Doxyfile | 2310 +++++++++++++++++ .../lru-cache/examples/CMakeLists.txt | 16 + src/3rdParty/lru-cache/examples/callbacks.cpp | 76 + .../lru-cache/examples/fibonacci-basic.cpp | 55 + .../lru-cache/examples/fibonacci-timed.cpp | 57 + src/3rdParty/lru-cache/examples/lowercase.cpp | 47 + .../lru-cache/examples/statistics.cpp | 76 + src/3rdParty/lru-cache/examples/wrap.cpp | 45 + .../lru-cache/include/lru/cache-tags.hpp | 40 + src/3rdParty/lru-cache/include/lru/cache.hpp | 207 ++ src/3rdParty/lru-cache/include/lru/entry.hpp | 134 + src/3rdParty/lru-cache/include/lru/error.hpp | 107 + .../include/lru/insertion-result.hpp | 76 + .../include/lru/internal/base-cache.hpp | 1588 +++++++++++ .../include/lru/internal/base-iterator.hpp | 216 ++ .../lru/internal/base-ordered-iterator.hpp | 338 +++ .../lru/internal/base-unordered-iterator.hpp | 216 ++ .../include/lru/internal/callback-manager.hpp | 159 ++ .../include/lru/internal/definitions.hpp | 88 + .../lru-cache/include/lru/internal/hash.hpp | 62 + .../include/lru/internal/information.hpp | 145 ++ .../include/lru/internal/last-accessed.hpp | 254 ++ .../include/lru/internal/optional.hpp | 207 ++ .../lru/internal/statistics-mutator.hpp | 150 ++ .../lru/internal/timed-information.hpp | 116 + .../include/lru/internal/utility.hpp | 178 ++ .../lru-cache/include/lru/iterator-tags.hpp | 40 + .../lru-cache/include/lru/key-statistics.hpp | 67 + .../lru-cache/include/lru/lowercase.hpp | 34 + src/3rdParty/lru-cache/include/lru/lru.hpp | 33 + .../lru-cache/include/lru/statistics.hpp | 256 ++ .../lru-cache/include/lru/timed-cache.hpp | 391 +++ src/3rdParty/lru-cache/include/lru/wrap.hpp | 99 + src/3rdParty/lru-cache/tests/CMakeLists.txt | 56 + src/3rdParty/lru-cache/tests/cache-test.cpp | 545 ++++ .../lru-cache/tests/callback-test.cpp | 155 ++ .../lru-cache/tests/iterator-test.cpp | 312 +++ .../lru-cache/tests/last-accessed-test.cpp | 109 + src/3rdParty/lru-cache/tests/logbt.sh | 166 ++ .../lru-cache/tests/move-aware-dummies.hpp | 171 ++ .../lru-cache/tests/move-awareness-test.cpp | 154 ++ .../lru-cache/tests/statistics-test.cpp | 375 +++ .../lru-cache/tests/timed-cache-test.cpp | 177 ++ src/3rdParty/lru-cache/tests/wrap-test.cpp | 90 + 49 files changed, 10596 insertions(+) create mode 100644 src/3rdParty/lru-cache/CMakeLists.txt create mode 100644 src/3rdParty/lru-cache/LICENSE create mode 100644 src/3rdParty/lru-cache/README.md create mode 100644 src/3rdParty/lru-cache/cpplint.cfg create mode 100644 src/3rdParty/lru-cache/docs/Doxyfile create mode 100644 src/3rdParty/lru-cache/examples/CMakeLists.txt create mode 100644 src/3rdParty/lru-cache/examples/callbacks.cpp create mode 100644 src/3rdParty/lru-cache/examples/fibonacci-basic.cpp create mode 100644 src/3rdParty/lru-cache/examples/fibonacci-timed.cpp create mode 100644 src/3rdParty/lru-cache/examples/lowercase.cpp create mode 100644 src/3rdParty/lru-cache/examples/statistics.cpp create mode 100644 src/3rdParty/lru-cache/examples/wrap.cpp create mode 100644 src/3rdParty/lru-cache/include/lru/cache-tags.hpp create mode 100644 src/3rdParty/lru-cache/include/lru/cache.hpp create mode 100644 src/3rdParty/lru-cache/include/lru/entry.hpp create mode 100644 src/3rdParty/lru-cache/include/lru/error.hpp create mode 100644 src/3rdParty/lru-cache/include/lru/insertion-result.hpp create mode 100644 src/3rdParty/lru-cache/include/lru/internal/base-cache.hpp create mode 100644 src/3rdParty/lru-cache/include/lru/internal/base-iterator.hpp create mode 100644 src/3rdParty/lru-cache/include/lru/internal/base-ordered-iterator.hpp create mode 100644 src/3rdParty/lru-cache/include/lru/internal/base-unordered-iterator.hpp create mode 100644 src/3rdParty/lru-cache/include/lru/internal/callback-manager.hpp create mode 100644 src/3rdParty/lru-cache/include/lru/internal/definitions.hpp create mode 100644 src/3rdParty/lru-cache/include/lru/internal/hash.hpp create mode 100644 src/3rdParty/lru-cache/include/lru/internal/information.hpp create mode 100644 src/3rdParty/lru-cache/include/lru/internal/last-accessed.hpp create mode 100644 src/3rdParty/lru-cache/include/lru/internal/optional.hpp create mode 100644 src/3rdParty/lru-cache/include/lru/internal/statistics-mutator.hpp create mode 100644 src/3rdParty/lru-cache/include/lru/internal/timed-information.hpp create mode 100644 src/3rdParty/lru-cache/include/lru/internal/utility.hpp create mode 100644 src/3rdParty/lru-cache/include/lru/iterator-tags.hpp create mode 100644 src/3rdParty/lru-cache/include/lru/key-statistics.hpp create mode 100644 src/3rdParty/lru-cache/include/lru/lowercase.hpp create mode 100644 src/3rdParty/lru-cache/include/lru/lru.hpp create mode 100644 src/3rdParty/lru-cache/include/lru/statistics.hpp create mode 100644 src/3rdParty/lru-cache/include/lru/timed-cache.hpp create mode 100644 src/3rdParty/lru-cache/include/lru/wrap.hpp create mode 100644 src/3rdParty/lru-cache/tests/CMakeLists.txt create mode 100644 src/3rdParty/lru-cache/tests/cache-test.cpp create mode 100644 src/3rdParty/lru-cache/tests/callback-test.cpp create mode 100644 src/3rdParty/lru-cache/tests/iterator-test.cpp create mode 100644 src/3rdParty/lru-cache/tests/last-accessed-test.cpp create mode 100644 src/3rdParty/lru-cache/tests/logbt.sh create mode 100644 src/3rdParty/lru-cache/tests/move-aware-dummies.hpp create mode 100644 src/3rdParty/lru-cache/tests/move-awareness-test.cpp create mode 100644 src/3rdParty/lru-cache/tests/statistics-test.cpp create mode 100644 src/3rdParty/lru-cache/tests/timed-cache-test.cpp create mode 100644 src/3rdParty/lru-cache/tests/wrap-test.cpp diff --git a/src/3rdParty/CMakeLists.txt b/src/3rdParty/CMakeLists.txt index 86619e8d81..a79d60acb2 100644 --- a/src/3rdParty/CMakeLists.txt +++ b/src/3rdParty/CMakeLists.txt @@ -9,6 +9,10 @@ if(NOT FREECAD_USE_EXTERNAL_E57FORMAT) add_subdirectory(libE57Format) endif() +if(BUILD_MATERIAL_EXTERNAL) + add_subdirectory(lru-cache) +endif() + if (BUILD_ASSEMBLY AND NOT FREECAD_USE_EXTERNAL_ONDSELSOLVER) if( NOT EXISTS "${CMAKE_SOURCE_DIR}/src/3rdParty/OndselSolver/CMakeLists.txt" ) message(FATAL_ERROR "The OndselSolver git submodule is not available. Please run diff --git a/src/3rdParty/lru-cache/CMakeLists.txt b/src/3rdParty/lru-cache/CMakeLists.txt new file mode 100644 index 0000000000..c1565034c5 --- /dev/null +++ b/src/3rdParty/lru-cache/CMakeLists.txt @@ -0,0 +1,73 @@ +########################################################### +## CMAKE SETUP +########################################################### + +cmake_minimum_required(VERSION 3.2) +project(lru-cache) + +add_compile_options(-g) + +######################################## +# C++ VERSIONING +######################################## + +include(CheckCXXCompilerFlag) + +# check_cxx_compiler_flag("-std=c++14" COMPILER_SUPPORTS_CXX_14) +# check_cxx_compiler_flag("-std=c++1z" COMPILER_SUPPORTS_CXX_1z) +# check_cxx_compiler_flag("-std=c++17" COMPILER_SUPPORTS_CXX_17) + +# if (COMPILER_SUPPORTS_CXX_1z) +# message(STATUS "Compiling with C++1z") +# set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++1z") +# elseif (COMPILER_SUPPORTS_CXX_14) +# message(STATUS "Compiling with C++14") +# set(CMAKE_CXX_STANDARD 14) +# elseif (COMPILER_SUPPORTS_CXX_17) +# message(STATUS "Compiling with C++17") +# set(CMAKE_CXX_STANDARD 17) +# else() +# message(FATAL_ERROR "Please install a modern C++ compiler, they are not expensive.") +# endif() + +########################################################### +## DEPENDENCIES +########################################################### + +set(CMAKE_MODULE_PATH + ${CMAKE_MODULE_PATH} + "${CMAKE_SOURCE_DIR}/cmake/Modules/" +) + +########################################################### +## INCLUDES +########################################################### + +# Need this top-level include for "tests/" +# include_directories(${CMAKE_CURRENT_SOURCE_DIR}) +include_directories(${CMAKE_CURRENT_SOURCE_DIR}/include) + +########################################################### +## EXAMPLES +########################################################### + +# add_subdirectory(examples) + +######################################## +# TESTS +######################################## + +# option(BUILD_LRU_CACHE_TESTS "Enable tests" OFF) + +# if(BUILD_LRU_CACHE_TESTS) +# message(STATUS "Enabling tests ...") +# enable_testing() +# add_subdirectory(tests) +# else() +# message(STATUS "Disabling tests ...") +# endif() + +file (GLOB LRU_HEADERS include/*.hpp) +file (GLOB LRU_INTERNAL_HEADERS include/*.hpp) +install (FILES ${LRU_HEADERS} DESTINATION ${CMAKE_INSTALL_PREFIX}/include) +install (FILES ${LRU_INTERNAL_HEADERS} DESTINATION ${CMAKE_INSTALL_PREFIX}/include/internal) diff --git a/src/3rdParty/lru-cache/LICENSE b/src/3rdParty/lru-cache/LICENSE new file mode 100644 index 0000000000..afcb9f00a5 --- /dev/null +++ b/src/3rdParty/lru-cache/LICENSE @@ -0,0 +1,19 @@ +The MIT License (MIT) +Copyright (c) 2016 Peter Goldsborough + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/src/3rdParty/lru-cache/README.md b/src/3rdParty/lru-cache/README.md new file mode 100644 index 0000000000..4afc1d339a --- /dev/null +++ b/src/3rdParty/lru-cache/README.md @@ -0,0 +1,304 @@ +# lru-cache + +[![GitHub license](https://img.shields.io/github/license/mashape/apistatus.svg?style=flat-square)](http://goldsborough.mit-license.org) [![Build Status](https://travis-ci.org/goldsborough/lru-cache.svg?branch=master)](https://travis-ci.org/goldsborough/lru-cache) + +A feature complete LRU cache implementation in C++. + +## Description + +A *least recently used* (LRU) cache is a fixed size cache that behaves just like a regular lookup table, but remembers the order in which elements are accessed. Once its (user-defined) capacity is reached, it uses this information to replace the least recently used element with a newly inserted one. This is ideal for caching function return values, where fast lookup of complex computations is favorable, but a memory blowup from caching all `(input, output)` pairs is to be avoided. + +We provide two implementations of an LRU cache: one has only the basic functionality described above, and another can be additionally supplied with a *time to live*. This is useful, for example, when caching resources on a server, where cache entries should be invalidated automatically after a certain amount of time, because they are no longer "fresh". + +Additionally, all our caches can be connected to *statistics* objects, that keep track of cache hits and misses for all keys and, upon request, individual keys (similar to `functools.lru_cache` in Python). You can also register arbitrary callbacks for hits, misses or accesses in general. + +## Basic Usage + +The two main classes we provide are `LRU::Cache` and `LRU::TimedCache`. A basic usage example of these may look like so: + +__`LRU::Cache`__ +```C++ +#include +#include "lru/lru.hpp" + +using Cache = LRU::Cache; + +int fibonacci(int n, Cache& cache) { + if (n < 2) return 1; + + // We internally keep track of the last accessed key, meaning a + // `contains(key)` + `lookup(key)` sequence will involve only a single hash + // table lookup. + if (cache.contains(n)) return cache.lookup(n); + + auto value = fibonacci(n - 1, cache) + fibonacci(n - 2, cache); + + // Caches are 100% move-aware and we have implemented + // `unordered_map` style emplacement and insertion. + cache.emplace(n, value); + + return value; +} + +int fibonacci(int n) { + // Use a capacity of 100 (after 100 insertions, the next insertion will evict + // the least-recently accessed element). The default capacity is 128. + Cache cache(100); + return fibonacci(n, cache); +} +``` + +__`LRU::TimedCache`__ +```C++ +#include +#include + +#include "lru/lru.hpp" + +using namespace std::chrono_literals; + +using Cache = LRU::TimedCache; + +int fibonacci(int n, Cache& cache) { + if (n < 2) return 1; + if (cache.contains(n)) return cache[n]; + + auto value = fibonacci(n - 1, cache) + fibonacci(n - 2, cache); + cache.emplace(n, value); + + return value; +} + +int fibonacci(int n) { + // Use a time to live of 100ms. This means that 100ms after insertion, a key + // will be said to have "expired" and `contains(key)` will return false. + Cache cache(100ms); + return fibonacci(n, cache); +} + +auto main() -> int { + std::cout << fibonacci(32) << std::endl; +} +``` + +## Extended Usage + +Our caches bring along many exciting features including statistics monitoring, function wrapping, arbitrary callbacks as well as ordered and unordered iteration. + +### Ordered and Unordered Iteration + +Both the `LRU::Cache` and `LRU::TimedCache` can be iterated over in two ways: ordered or unordered fashion (where the "order" refers to the order of insertion). The default iterators returned by `begin()`, `cbegin()`, `end()` etc. are *unordered* and mostly similar to `unordered_map` iterators (with some nice non-standard sugar): + +```C++ +LRU::Cache cache = {{1, 2}, {2, 3}, {3, 4}}; + +int sum = 0; +for (const auto& pair : cache) { + sum += pair.first; // Standards compliant (good for templates) + sum += pair.value(); // But sugar on top (also key()) +} + +auto iterator = cache.begin(); // These two lines +auto iterator = cache.unordered_begin(); // are the same +auto iterator = cache.ordered_end(); // This is something different +``` + +Unordered iterators are implemented directly over internal map iterators and thus have access to the key and value of a pointed-to entry. + +Ordered iterators respect the order of insertion. They differ in a few ways from unordered iterators: + +1. They are bidirectional, while unordered iterators are forward iterators. +2. They provide fast access only to the `key()`. Accessing the value requires a hash table lookup the first time an iterator is dereferenced. +3. They can be constructed from unordered iterators! This means writing something like `typename LRU::Cache::OrderedIterator i(unordered_iterator)` will work and is fast. + +Dreferencing an iterator will not change the order of elements in the cache. + +### Statistics + +Our caches can be associated with statistics objects, that monitor hits and misses. There are a few ways to create and use them. First of all, let's say you only wanted to record hits and misses for all keys and didn't care about any particular key. The simplest way to do this is to simply call: + +```cpp +cache.monitor(); +``` + +This allows you to call `cache.stats()`, which returns an `LRU::Statistics` object. It's interface is quite clear, allowing you to write stuff like: + +```cpp +cache.stats().total_hits(); // Hits for any key +cache.stats().total_misses(); // Misses for any key +cache.stats().hit_rate(); // Hit rate in [0, 1] +``` + +Note that a hit or miss only refers to lookup (i.e. methods `contains()`, `find()`, `lookup()` and `operator[]`) but not insertion via `emplace()` or `insert()`. + +#### Sharing Statistics + +Already here, one idea might be that we have two functions, each with their own cache, but we'd like them to share statistics. This is easy to do. Simply create the `Statistics` object as a `std::shared_ptr` and plug it into `cache.monitor()` for as many caches as you like: + +```cpp +auto stats = std::make_shared>(); + +cache1.monitor(stats); +cache2.monitor(stats); + +// Both affect the same statistics object +cache1.lookup("key"); +cache2.lookup("foo"); + +assert(&cache1.stats() == &cache2.stats()); // Ok + +std::shared_ptr> stats2 = cache1.shared_stats(); +``` + +#### Monitoring specific keys + +One of the more interesting features of our statistics API is the ability to monitor hits and misses for a specific set of keys. Say we were writing a web server accepting HTTP requests and wanted to cache resources (I assume that's something people would do). Because our website changes in some way every hour, we'll use a timed cache with a time-to-live of one hour. We're also particularly interested in how many cache hits we get for `index.html`. For this, it's good to know that the empty `monitor()` call we made further up is actually a method accepting variadic arguments to forward to the constructor of an internal statistics object (the empty `monitor()` calls the default constructor). One constructor of `Statistics` takes a number of keys to monitor in particular. So calling `monitor(key1, key2, ...)` will set up monitoring for those keys. We could then something like this: + +```cpp +#include +#include + +#include "lru/lru.hpp" + +using namespace std::chrono_literals; + +struct MyWebServer { + + // We pass 1h to let the cache know that resources are to be invalidated after one hour. + MyWebServer() : cache(1h) { + cache.monitor("index.html"); + } + + std::string get(const std::string& resource_name) { + std::string resource; + if (cache.contains(resource_name)) { + resource = cache.lookup(resource_name); + } else { + resource = fetch_expensively(resource_name); + cache.insert(resource_name, resource); + } + + return resource; + } + + LRU::TimedCache cache; +}; +``` + +Later on, we can use methods like `hits_for("index.html")`, `misses_for("index.html")` or `stats_for("index.html")` on `cache.stats()` to find out how many hits or misses we got for our monitored resource. Note that `stats_for(key)` returns a lightweight `struct` holding hit and miss information about a particular key. + +### Callbacks + +Next to registering statistics, we also allow hook in arbitrary callbacks. The three kinds of callbacks that may be registered are: + +1. Hit callbacks, taking a key and value after a cache hit (registered with `hit_callback()`). +2. Miss callbacks, taking only a key, that was not found in a cache (registered with `miss_callback()`). +3. Access callbacks, taking a key and a boolean indicating a hit or a miss (registered with `access_callback()`). + +Usage could look something like this: + +```cpp +LRU::Cache cache; + +cache.hit_callback([](const auto& key, const auto& value) { + std::clog << "Hit for entry (" + << key << ", " << value << ")" + << std::endl; +}); + +cache.miss_callback([](const auto& key) { + std::clog << "Miss for " << key<< std::endl; +}); + +// Roll your own statistics +std::size_t miss_count = 0; +cache.miss_callback([&miss_count](auto&) { + miss_count += 1; +}); + +cache.access_callback([](const auto& key, bool was_hit) { + std::clog << "Access for " << key + << " was a " << (was_hit ? "hit" : "miss") + << std::endl; +}); +``` + +Note that just like with statistics, these callbacks will only get invoked for lookup and not insertion. + +### Wrapping + +We provide utility functions `LRU::wrap` and `LRU::timed_wrap` that take a function and return a new function, with a (timed) cache attached to it. Feels like Python. Just faster. + +```cpp +#include "lru/lru.hpp" + +int my_expensive_function(int, char, double) { + // ... +} + +auto my_cached_expensive_function = LRU::wrap(my_expensive_function); + +my_cached_expensive_function(1, 'a', 3.14); +``` + +Next to the function to wrap, `LRU::wrap` and `LRU::timed_wrap` take any number of arguments to forward to the constructor of the internal cache: + +```cpp +// Use a capacity of 100 +auto new_function = LRU::wrap(old_function, 1000); + +// Use a time-to-live of 100 milliseconds +auto new_function = LRU::timed_wrap(old_function, 100ms); +``` + +Note that this will *not* cache recursive calls, since we cannot override the actual function symobl. As such we refer to this as "shallow memoization". + +### Lowercase Names + +Not everyone has the same taste. We get that. For this reason, for every public `CamelCase` type name, we've defined a `lower_case` (C++ standard style) alias. You can make these visible by including `lru/lowercase.hpp` instead of `lru/lru.hpp`: + +```cpp +#include +#include + +#include "lru/lowercase.hpp" + +void print(lru::tag::basic_cache) { + std::cout << "basic cache" << '\n'; +} + +void print(lru::tag::timed_cache) { + std::cout << "timed cache" << '\n'; +} + +auto main() -> int { + using namespace std::chrono_literals; + + lru::cache cache; + lru::timed_cache timed_cache(100ms); + + print(cache.tag()); + print(timed_cache.tag()); + + lru::cache::ordered_const_iterator iterator(cache.begin()); + + lru::statistics stats; +} + +``` + +## Documentation + +We have 100% public and private documentation coverage with a decent effort behind it. As such we ask you to RTFM to see the full interface we provide (it is a superset of `std::unordered_map`, minus the new node interface). Documentation can be generated with [Doxygen](http://www.stack.nl/~dimitri/doxygen/) by running the `doxygen` command inside the `docs/` folder. + +Also do check out all the examples in the `examples/` folder! + +## LICENSE + +This project is released under the [MIT License](http://goldsborough.mit-license.org). For more information, see the LICENSE file. + +## Authors + +[Peter Goldsborough](http://goldsborough.me) + [cat](https://goo.gl/IpUmJn) :heart: + +Thanks to [@engelmarkus](https://github.com/engelmarkus) for technical and emotional support. diff --git a/src/3rdParty/lru-cache/cpplint.cfg b/src/3rdParty/lru-cache/cpplint.cfg new file mode 100644 index 0000000000..9be7f77bae --- /dev/null +++ b/src/3rdParty/lru-cache/cpplint.cfg @@ -0,0 +1,3 @@ +# cpplint configuration + +filter=-build/c++11,-whitespace/parens,-runtime/references,-whitespace/operators diff --git a/src/3rdParty/lru-cache/docs/Doxyfile b/src/3rdParty/lru-cache/docs/Doxyfile new file mode 100644 index 0000000000..3a1572d9dc --- /dev/null +++ b/src/3rdParty/lru-cache/docs/Doxyfile @@ -0,0 +1,2310 @@ +# Doxyfile 1.8.6 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "LRU Cache" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = 0.1 + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = A feature-complete LRU cache implementation. + +# With the PROJECT_LOGO tag one can specify an logo or icon that is included in +# the documentation. The maximum height of the logo should not exceed 55 pixels +# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo +# to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = YES + +# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = YES + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a +# new page for each member. If set to NO, the documentation of a member will be +# part of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 2 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = "complexity=\par Complexity\n" + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by by putting a % sign in front of the word +# or globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = YES + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = YES + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = YES + +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = YES + +# If the EXTRACT_STATIC tag is set to YES all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = YES + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = YES + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO these classes will be included in the various overviews. This option has +# no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = YES + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the +# todo list. This list is created by putting \todo commands in the +# documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the +# test list. This list is created by putting \test commands in the +# documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES the list +# will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. Do not use file names with spaces, bibtex cannot handle them. See +# also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO doxygen will only warn about wrong or incomplete parameter +# documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. +# Note: If this tag is empty the current directory is searched. + +INPUT = ../include ../README.md + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank the +# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, +# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, +# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, +# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, +# *.qsf, *.as and *.js. + +FILE_PATTERNS = + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER ) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = README.md + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES, then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- +# defined cascading style sheet that is included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefor more robust against future updates. +# Doxygen will copy the style sheet file to the output directory. For an example +# see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the stylesheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to NO can help when comparing the output of multiple runs. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler ( hhc.exe). If non-empty +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated ( +# YES) or that it should be included in the master .chm file ( NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated ( +# YES) or a normal table of contents ( NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using prerendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = YES + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /