kindred/create
1
1
Fork 0
Code Issues 37 Pull Requests Actions Packages Projects 9 Releases 2 Wiki Activity

App: Align Document to best practices (#21059)

Browse Source 
* use static cast

* join declaration and definition

* don't hide previous declaration

* initialize in declaration

* redundant else

* reserved identifier

* endl

* implicit conversion

* narrowing

* always false

* replace define with constexpr

* return and continue

* avoid copy

* multiple declarations in line

* use auto

* member initialize

* uninitialized

* range based loop

* move to inner scope

* redundant

* const, mainly

* function parameter descriptions

* misc

---------

Co-authored-by: bofdahof <172177156+bofdahof@users.noreply.github.com>
This commit is contained in:
3x380V
2025-05-14 09:36:42 +02:00
committed by GitHub
parent c951255a6c
commit 9d6f1ad37c
3 changed files with 542 additions and 600 deletions
Download Patch File Download Diff File Expand all files Collapse all files

973
src/App/Document.cpp
View File

File diff suppressed because it is too large Load Diff

145
src/App/Document.h
View File

@@ -38,7 +38,6 @@
#include <utility> #include <utility>
#include <list> #include <list>
#include <string> #include <string>
#include <QString>
namespace Base namespace Base
{ {
@@ -62,7 +61,7 @@ using StringHasherRef = Base::Reference<StringHasher>;
* @ingroup DocumentGroup * @ingroup DocumentGroup
* @details For a more high-level discussion see the topic @ref DocumentGroup "Document". * @details For a more high-level discussion see the topic @ref DocumentGroup "Document".
*/ */
class AppExport Document: public App::PropertyContainer class AppExport Document: public PropertyContainer
{ {
PROPERTY_HEADER_WITH_OVERRIDE(App::Document); PROPERTY_HEADER_WITH_OVERRIDE(App::Document);
@@ -112,13 +111,13 @@ public:
/// unique identifier of the document /// unique identifier of the document
PropertyUUID Uid; PropertyUUID Uid;
/// Full name of the licence e.g. "Creative Commons Attribution". See https://spdx.org/licenses/ /// Full name of the licence e.g. "Creative Commons Attribution". See https://spdx.org/licenses/
App::PropertyString License; PropertyString License;
/// License description/contract URL /// License description/contract URL
App::PropertyString LicenseURL; PropertyString LicenseURL;
/// Meta descriptions /// Meta descriptions
App::PropertyMap Meta; PropertyMap Meta;
/// Material descriptions, used and defined in the Material module. /// Material descriptions, used and defined in the Material module.
App::PropertyMap Material; PropertyMap Material;
/// read-only name of the temp dir created when the document is opened /// read-only name of the temp dir created when the document is opened
PropertyString TransientDir; PropertyString TransientDir;
/// Tip object of the document (if any) /// Tip object of the document (if any)
@@ -135,31 +134,31 @@ public:
//@{ //@{
// clang-format off // clang-format off
/// signal before changing an doc property /// signal before changing an doc property
boost::signals2::signal<void(const App::Document&, const App::Property&)> signalBeforeChange; boost::signals2::signal<void(const Document&, const Property&)> signalBeforeChange;
/// signal on changed doc property /// signal on changed doc property
boost::signals2::signal<void(const App::Document&, const App::Property&)> signalChanged; boost::signals2::signal<void(const Document&, const Property&)> signalChanged;
/// signal on new Object /// signal on new Object
boost::signals2::signal<void(const App::DocumentObject&)> signalNewObject; boost::signals2::signal<void(const DocumentObject&)> signalNewObject;
/// signal on deleted Object /// signal on deleted Object
boost::signals2::signal<void(const App::DocumentObject&)> signalDeletedObject; boost::signals2::signal<void(const DocumentObject&)> signalDeletedObject;
/// signal before changing an Object /// signal before changing an Object
boost::signals2::signal<void(const App::DocumentObject&, const App::Property&)> signalBeforeChangeObject; boost::signals2::signal<void(const DocumentObject&, const Property&)> signalBeforeChangeObject;
/// signal on changed Object /// signal on changed Object
boost::signals2::signal<void(const App::DocumentObject&, const App::Property&)> signalChangedObject; boost::signals2::signal<void(const DocumentObject&, const Property&)> signalChangedObject;
/// signal on manually called DocumentObject::touch() /// signal on manually called DocumentObject::touch()
boost::signals2::signal<void(const App::DocumentObject&)> signalTouchedObject; boost::signals2::signal<void(const DocumentObject&)> signalTouchedObject;
/// signal on relabeled Object /// signal on relabeled Object
boost::signals2::signal<void(const App::DocumentObject&)> signalRelabelObject; boost::signals2::signal<void(const DocumentObject&)> signalRelabelObject;
/// signal on activated Object /// signal on activated Object
boost::signals2::signal<void(const App::DocumentObject&)> signalActivatedObject; boost::signals2::signal<void(const DocumentObject&)> signalActivatedObject;
/// signal on created object /// signal on created object
boost::signals2::signal<void(const App::DocumentObject&, Transaction*)> signalTransactionAppend; boost::signals2::signal<void(const DocumentObject&, Transaction*)> signalTransactionAppend;
/// signal on removed object /// signal on removed object
boost::signals2::signal<void(const App::DocumentObject&, Transaction*)> signalTransactionRemove; boost::signals2::signal<void(const DocumentObject&, Transaction*)> signalTransactionRemove;
/// signal on undo /// signal on undo
boost::signals2::signal<void(const App::Document&)> signalUndo; boost::signals2::signal<void(const Document&)> signalUndo;
/// signal on redo /// signal on redo
boost::signals2::signal<void(const App::Document&)> signalRedo; boost::signals2::signal<void(const Document&)> signalRedo;
/** signal on load/save document /** signal on load/save document
* this signal is given when the document gets streamed. * this signal is given when the document gets streamed.
* you can use this hook to write additional information in * you can use this hook to write additional information in
@@ -167,28 +166,28 @@ public:
*/ */
boost::signals2::signal<void(Base::Writer&)> signalSaveDocument; boost::signals2::signal<void(Base::Writer&)> signalSaveDocument;
boost::signals2::signal<void(Base::XMLReader&)> signalRestoreDocument; boost::signals2::signal<void(Base::XMLReader&)> signalRestoreDocument;
boost::signals2::signal<void(const std::vector<App::DocumentObject*>&, Base::Writer&)> signalExportObjects; boost::signals2::signal<void(const std::vector<DocumentObject*>&, Base::Writer&)> signalExportObjects;
boost::signals2::signal<void(const std::vector<App::DocumentObject*>&, Base::Writer&)> signalExportViewObjects; boost::signals2::signal<void(const std::vector<DocumentObject*>&, Base::Writer&)> signalExportViewObjects;
boost::signals2::signal<void(const std::vector<App::DocumentObject*>&, Base::XMLReader&)> signalImportObjects; boost::signals2::signal<void(const std::vector<DocumentObject*>&, Base::XMLReader&)> signalImportObjects;
boost::signals2::signal<void(const std::vector<App::DocumentObject*>&, Base::Reader&, boost::signals2::signal<void(const std::vector<DocumentObject*>&, Base::Reader&,
const std::map<std::string, std::string>&)> signalImportViewObjects; const std::map<std::string, std::string>&)> signalImportViewObjects;
boost::signals2::signal<void(const std::vector<App::DocumentObject*>&)> signalFinishImportObjects; boost::signals2::signal<void(const std::vector<DocumentObject*>&)> signalFinishImportObjects;
// signal starting a save action to a file // signal starting a save action to a file
boost::signals2::signal<void(const App::Document&, const std::string&)> signalStartSave; boost::signals2::signal<void(const Document&, const std::string&)> signalStartSave;
// signal finishing a save action to a file // signal finishing a save action to a file
boost::signals2::signal<void(const App::Document&, const std::string&)> signalFinishSave; boost::signals2::signal<void(const Document&, const std::string&)> signalFinishSave;
boost::signals2::signal<void(const App::Document&)> signalBeforeRecompute; boost::signals2::signal<void(const Document&)> signalBeforeRecompute;
boost::signals2::signal<void(const App::Document&, const std::vector<App::DocumentObject*>&)> signalRecomputed; boost::signals2::signal<void(const Document&, const std::vector<DocumentObject*>&)> signalRecomputed;
boost::signals2::signal<void(const App::DocumentObject&)> signalRecomputedObject; boost::signals2::signal<void(const DocumentObject&)> signalRecomputedObject;
// signal a new opened transaction // signal a new opened transaction
boost::signals2::signal<void(const App::Document&, std::string)> signalOpenTransaction; boost::signals2::signal<void(const Document&, std::string)> signalOpenTransaction;
// signal a committed transaction // signal a committed transaction
boost::signals2::signal<void(const App::Document&)> signalCommitTransaction; boost::signals2::signal<void(const Document&)> signalCommitTransaction;
// signal an aborted transaction // signal an aborted transaction
boost::signals2::signal<void(const App::Document&)> signalAbortTransaction; boost::signals2::signal<void(const Document&)> signalAbortTransaction;
boost::signals2::signal<void(const App::Document&, const std::vector<App::DocumentObject*>&)> signalSkipRecompute; boost::signals2::signal<void(const Document&, const std::vector<DocumentObject*>&)> signalSkipRecompute;
boost::signals2::signal<void(const App::DocumentObject&)> signalFinishRestoreObject; boost::signals2::signal<void(const DocumentObject&)> signalFinishRestoreObject;
boost::signals2::signal<void(const App::Document&, const App::Property&)> signalChangePropertyEditor; boost::signals2::signal<void(const Document&, const Property&)> signalChangePropertyEditor;
boost::signals2::signal<void(std::string)> signalLinkXsetValue; boost::signals2::signal<void(std::string)> signalLinkXsetValue;
// clang-format on // clang-format on
//@} //@}
@@ -210,16 +209,16 @@ public:
bool delaySignal = false, bool delaySignal = false,
const std::vector<std::string>& objNames = {}); const std::vector<std::string>& objNames = {});
bool afterRestore(bool checkPartial = false); bool afterRestore(bool checkPartial = false);
bool afterRestore(const std::vector<App::DocumentObject*>&, bool checkPartial = false); bool afterRestore(const std::vector<DocumentObject*>&, bool checkPartial = false);
enum ExportStatus enum ExportStatus
{ {
NotExporting, NotExporting,
Exporting, Exporting,
}; };
ExportStatus isExporting(const App::DocumentObject* obj) const; ExportStatus isExporting(const DocumentObject* obj) const;
void exportObjects(const std::vector<App::DocumentObject*>&, std::ostream&); void exportObjects(const std::vector<DocumentObject*>&, std::ostream&);
void exportGraphviz(std::ostream&) const; void exportGraphviz(std::ostream&) const;
std::vector<App::DocumentObject*> importObjects(Base::XMLReader& reader); std::vector<DocumentObject*> importObjects(Base::XMLReader& reader);
/** Import any externally linked objects /** Import any externally linked objects
* *
* @param objs: input list of objects. Only objects belonging to this document will * @param objs: input list of objects. Only objects belonging to this document will
@@ -232,8 +231,8 @@ public:
* *
* @return the list of imported objects * @return the list of imported objects
*/ */
std::vector<App::DocumentObject*> std::vector<DocumentObject*>
importLinks(const std::vector<App::DocumentObject*>& objs = {}); importLinks(const std::vector<DocumentObject*>& objs = {});
/// Opens the document from its file name /// Opens the document from its file name
// void open (void); // void open (void);
/// Is the document already saved to a file? /// Is the document already saved to a file?
@@ -317,6 +316,7 @@ public:
/** Copy objects from another document to this document /** Copy objects from another document to this document
* *
* @param objs
* @param recursive: if true, then all objects this object depends on are * @param recursive: if true, then all objects this object depends on are
* copied as well. By default \a recursive is false. * copied as well. By default \a recursive is false.
* *
@@ -345,7 +345,7 @@ public:
/// Returns true if the DocumentObject is contained in this document /// Returns true if the DocumentObject is contained in this document
bool isIn(const DocumentObject* pFeat) const; bool isIn(const DocumentObject* pFeat) const;
/// Returns a Name of an Object or 0 /// Returns a Name of an Object or 0
const char *getObjectName(DocumentObject* pFeat) const; const char *getObjectName(const DocumentObject* pFeat) const;
/// Returns a Name for a new Object or empty if proposedName is null or empty. /// Returns a Name for a new Object or empty if proposedName is null or empty.
std::string getUniqueObjectName(const char* proposedName) const; std::string getUniqueObjectName(const char* proposedName) const;
/// Returns a name different from any of the Labels of any objects in this document, based on the given modelName. /// Returns a name different from any of the Labels of any objects in this document, based on the given modelName.
@@ -384,7 +384,7 @@ public:
/// check if there is any object must execute in this document /// check if there is any object must execute in this document
bool mustExecute() const; bool mustExecute() const;
/// returns all touched objects /// returns all touched objects
std::vector<App::DocumentObject*> getTouched() const; std::vector<DocumentObject*> getTouched() const;
/// set the document to be closable, this is on by default. /// set the document to be closable, this is on by default.
void setClosable(bool); void setClosable(bool);
/// check whether the document can be closed /// check whether the document can be closed
@@ -397,15 +397,18 @@ public:
* *
* @param objs: specify a sub set of objects to recompute. If empty, then * @param objs: specify a sub set of objects to recompute. If empty, then
* all object in this document is checked for recompute * all object in this document is checked for recompute
* @param force
* @param hasError
* @param options
*/ */
int recompute(const std::vector<App::DocumentObject*>& objs = {}, int recompute(const std::vector<DocumentObject*>& objs = {},
bool force = false, bool force = false,
bool* hasError = nullptr, bool* hasError = nullptr,
int options = 0); int options = 0);
/// Recompute only one feature /// Recompute only one feature
bool recomputeFeature(DocumentObject* Feat, bool recursive = false); bool recomputeFeature(DocumentObject* Feat, bool recursive = false);
/// get the text of the error of a specified object /// get the text of the error of a specified object
const char* getErrorDescription(const App::DocumentObject*) const; const char* getErrorDescription(const DocumentObject*) const;
/// return the status bits /// return the status bits
bool testStatus(Status pos) const; bool testStatus(Status pos) const;
/// set the status bits /// set the status bits
@@ -440,17 +443,17 @@ public:
* *
* @param name: transaction name * @param name: transaction name
* *
* This function calls App::Application::setActiveTransaction(name) instead * This function calls Application::setActiveTransaction(name) instead
* to setup a potential transaction which will only be created if there is * to setup a potential transaction which will only be created if there is
* actual changes. * actual changes.
*/ */
void openTransaction(const char* name = nullptr); void openTransaction(const char* name = nullptr);
/// Rename the current transaction if the id matches /// Rename the current transaction if the id matches
void renameTransaction(const char* name, int id); void renameTransaction(const char* name, int id) const;
/// Commit the Command transaction. Do nothing If there is no Command transaction open. /// Commit the Command transaction. Do nothing If there is no Command transaction open.
void commitTransaction(); void commitTransaction();
/// Abort the actually running transaction. /// Abort the actually running transaction.
void abortTransaction(); void abortTransaction() const;
/// Check if a transaction is open /// Check if a transaction is open
bool hasPendingTransaction() const; bool hasPendingTransaction() const;
/// Return the undo/redo transaction ID starting from the back /// Return the undo/redo transaction ID starting from the back
@@ -484,7 +487,7 @@ public:
/// redo/undo or rollback /// redo/undo or rollback
bool isPerformingTransaction() const; bool isPerformingTransaction() const;
/// \internal add or remove property from a transactional object /// \internal add or remove property from a transactional object
void addOrRemovePropertyOfObject(TransactionalObject*, Property* prop, bool add); void addOrRemovePropertyOfObject(TransactionalObject*, const Property* prop, bool add);
//@} //@}
/** @name dependency stuff */ /** @name dependency stuff */
@@ -492,9 +495,9 @@ public:
/// write GraphViz file /// write GraphViz file
void writeDependencyGraphViz(std::ostream& out); void writeDependencyGraphViz(std::ostream& out);
/// checks if the graph is directed and has no cycles /// checks if the graph is directed and has no cycles
bool checkOnCycle(); static bool checkOnCycle();
/// get a list of all objects linking to the given object /// get a list of all objects linking to the given object
std::vector<App::DocumentObject*> getInList(const DocumentObject* me) const; std::vector<DocumentObject*> getInList(const DocumentObject* me) const;
/// Option bit flags used by getDepenencyList() /// Option bit flags used by getDepenencyList()
enum DependencyOption enum DependencyOption
@@ -515,24 +518,24 @@ public:
* @param objs: input objects to query for dependency. * @param objs: input objects to query for dependency.
* @param options: See DependencyOption * @param options: See DependencyOption
*/ */
static std::vector<App::DocumentObject*> static std::vector<DocumentObject*>
getDependencyList(const std::vector<App::DocumentObject*>& objs, int options = 0); getDependencyList(const std::vector<DocumentObject*>& objs, int options = 0);
std::vector<App::Document*> getDependentDocuments(bool sort = true); std::vector<Document*> getDependentDocuments(bool sort = true);
static std::vector<App::Document*> getDependentDocuments(std::vector<App::Document*> docs, static std::vector<Document*> getDependentDocuments(std::vector<Document*> docs,
bool sort); bool sort);
// set Changed // set Changed
// void setChanged(DocumentObject* change); // void setChanged(DocumentObject* change);
/// get a list of topological sorted objects (https://en.wikipedia.org/wiki/Topological_sorting) /// get a list of topological sorted objects (https://en.wikipedia.org/wiki/Topological_sorting)
std::vector<App::DocumentObject*> topologicalSort() const; std::vector<DocumentObject*> topologicalSort() const;
/// get all root objects (objects no other one reference too) /// get all root objects (objects no other one reference too)
std::vector<App::DocumentObject*> getRootObjects() const; std::vector<DocumentObject*> getRootObjects() const;
/// get all tree root objects (objects that are at the root of the object tree) /// get all tree root objects (objects that are at the root of the object tree)
std::vector<App::DocumentObject*> getRootObjectsIgnoreLinks() const; std::vector<DocumentObject*> getRootObjectsIgnoreLinks() const;
/// get all possible paths from one object to another following the OutList /// get all possible paths from one object to another following the OutList
std::vector<std::list<App::DocumentObject*>> std::vector<std::list<DocumentObject*>>
getPathsByOutList(const App::DocumentObject* from, const App::DocumentObject* to) const; getPathsByOutList(const DocumentObject* from, const DocumentObject* to) const;
//@} //@}
/** Called by a property during save to store its StringHasher /** Called by a property during save to store its StringHasher
@@ -566,7 +569,7 @@ public:
* *
* @param links: holds the links found * @param links: holds the links found
* @param obj: the linked object. If NULL, then all links are returned. * @param obj: the linked object. If NULL, then all links are returned.
* @param option: @sa App::GetLinkOption * @param options: @sa GetLinkOption
* @param maxCount: limit the number of links returned, 0 means no limit * @param maxCount: limit the number of links returned, 0 means no limit
* @param objs: optional objects to search for, if empty, then all objects * @param objs: optional objects to search for, if empty, then all objects
* of this document are searched. * of this document are searched.
@@ -590,9 +593,9 @@ public:
/// Function called to signal that an object identifier has been renamed /// Function called to signal that an object identifier has been renamed
void renameObjectIdentifiers( void renameObjectIdentifiers(
const std::map<App::ObjectIdentifier, App::ObjectIdentifier>& paths, const std::map<ObjectIdentifier, ObjectIdentifier>& paths,
const std::function<bool(const App::DocumentObject*)>& selector = const std::function<bool(const DocumentObject*)>& selector =
[](const App::DocumentObject*) { [](const DocumentObject*) {
return true; return true;
}); });
@@ -627,8 +630,8 @@ protected:
/// checks if a valid transaction is open /// checks if a valid transaction is open
void _checkTransaction(DocumentObject* pcDelObj, const Property* What, int line); void _checkTransaction(DocumentObject* pcDelObj, const Property* What, int line);
void breakDependency(DocumentObject* pcObject, bool clear); void breakDependency(DocumentObject* pcObject, bool clear);
std::vector<App::DocumentObject*> readObjects(Base::XMLReader& reader); std::vector<DocumentObject*> readObjects(Base::XMLReader& reader);
void writeObjects(const std::vector<App::DocumentObject*>&, Base::Writer& writer) const; void writeObjects(const std::vector<DocumentObject*>&, Base::Writer& writer) const;
bool saveToFile(const char* filename) const; bool saveToFile(const char* filename) const;
int countObjectsOfType(const Base::Type& typeId) const; int countObjectsOfType(const Base::Type& typeId) const;
@@ -645,7 +648,7 @@ protected:
/// refresh the internal dependency graph /// refresh the internal dependency graph
void _rebuildDependencyList( void _rebuildDependencyList(
const std::vector<App::DocumentObject*>& objs = std::vector<App::DocumentObject*>()); const std::vector<DocumentObject*>& objs = std::vector<DocumentObject*>());
std::string getTransientDirectoryName(const std::string& uuid, std::string getTransientDirectoryName(const std::string& uuid,
const std::string& filename) const; const std::string& filename) const;
@@ -661,9 +664,9 @@ protected:
* AutoTransaction setting. * AutoTransaction setting.
*/ */
int _openTransaction(const char* name = nullptr, int id = 0); int _openTransaction(const char* name = nullptr, int id = 0);
/// Internally called by App::Application to commit the Command transaction. /// Internally called by Application to commit the Command transaction.
void _commitTransaction(bool notify = false); void _commitTransaction(bool notify = false);
/// Internally called by App::Application to abort the running transaction. /// Internally called by Application to abort the running transaction.
void _abortTransaction(); void _abortTransaction();
private: private:
@@ -685,7 +688,7 @@ template<typename T>
inline std::vector<T*> Document::getObjectsOfType() const inline std::vector<T*> Document::getObjectsOfType() const
{ {
std::vector<T*> type; std::vector<T*> type;
std::vector<App::DocumentObject*> obj = this->getObjectsOfType(T::getClassTypeId()); const std::vector<DocumentObject*> obj = this->getObjectsOfType(T::getClassTypeId());
type.reserve(obj.size()); type.reserve(obj.size());
for (auto it : obj) { for (auto it : obj) {
type.push_back(static_cast<T*>(it)); type.push_back(static_cast<T*>(it));
@@ -696,7 +699,7 @@ inline std::vector<T*> Document::getObjectsOfType() const
template<typename T> template<typename T>
inline int Document::countObjectsOfType() const inline int Document::countObjectsOfType() const
{ {
static_assert(std::is_base_of<App::DocumentObject, T>::value, static_assert(std::is_base_of_v<DocumentObject, T>,
"T must be derived from App::DocumentObject"); "T must be derived from App::DocumentObject");
return this->countObjectsOfType(T::getClassTypeId()); return this->countObjectsOfType(T::getClassTypeId());
} }

24
src/App/private/DocumentP.h
View File

@@ -77,26 +77,26 @@ struct DocumentP
std::unordered_map<long, DocumentObject*> objectIdMap; std::unordered_map<long, DocumentObject*> objectIdMap;
std::unordered_map<std::string, bool> partialLoadObjects; std::unordered_map<std::string, bool> partialLoadObjects;
std::vector<DocumentObjectT> pendingRemove; std::vector<DocumentObjectT> pendingRemove;
long lastObjectId; long lastObjectId {};
DocumentObject* activeObject; DocumentObject* activeObject {nullptr};
Transaction* activeUndoTransaction; Transaction* activeUndoTransaction {nullptr};
// pointer to the python class // pointer to the python class
Py::Object DocumentPythonObject; Py::Object DocumentPythonObject;
int iTransactionMode; int iTransactionMode {0};
bool rollback; bool rollback {false};
bool undoing; ///< document in the middle of undo or redo bool undoing {false}; ///< document in the middle of undo or redo
bool committing; bool committing {false};
bool opentransaction; bool opentransaction {false};
std::bitset<32> StatusBits; std::bitset<32> StatusBits;
int iUndoMode; int iUndoMode {0};
unsigned int UndoMemSize; unsigned int UndoMemSize {0};
unsigned int UndoMaxStackSize; unsigned int UndoMaxStackSize {20};
std::string programVersion; std::string programVersion;
mutable HasherMap hashers; mutable HasherMap hashers;
std::multimap<const App::DocumentObject*, std::unique_ptr<App::DocumentObjectExecReturn>> std::multimap<const App::DocumentObject*, std::unique_ptr<App::DocumentObjectExecReturn>>
_RecomputeLog; _RecomputeLog;
StringHasherRef Hasher; StringHasherRef Hasher {new StringHasher};
DocumentP(); DocumentP();