Adding the GenericDefaultNameCapability and its implementation

Fixing a conceptual bug in the DefaultNameCapability - it needs to run on a given name (also stored in the database), not on the internal name of the patch. Needs a parameter, it needs.
christofmuc · Jan 1, 2021 · 1a5ee0f · 1a5ee0f
1 parent 3fa8c10
commit 1a5ee0f
Show file tree

Hide file tree

Showing 11 changed files with 100 additions and 31 deletions.
diff --git a/MidiKraft-base b/MidiKraft-base
diff --git a/MidiKraft-database b/MidiKraft-database
diff --git a/adaptions/GenericAdaptation.cpp b/adaptions/GenericAdaptation.cpp
@@ -43,6 +43,7 @@ namespace knobkraft {
 		*kDeviceDetectWaitMilliseconds = "deviceDetectWaitMilliseconds",
 		*kNameFromDump = "nameFromDump",
 		*kRenamePatch = "renamePatch",
+		*kIsDefaultName = "isDefaultName",
 		*kIsEditBufferDump = "isEditBufferDump",
 		*kCreateEditBufferRequest = "createEditBufferRequest",
 		*kConvertToEditBuffer = "convertToEditBuffer",
@@ -67,6 +68,7 @@ namespace knobkraft {
 		kNeedsChannelSpecificDetection,
 		kDeviceDetectWaitMilliseconds,
 		kNameFromDump,
+		kIsDefaultName,
 		kRenamePatch,
 		kIsEditBufferDump,
 		kCreateEditBufferRequest,

diff --git a/adaptions/GenericAdaptation.h b/adaptions/GenericAdaptation.h
@@ -26,7 +26,7 @@ namespace knobkraft {
 	void checkForPythonOutputAndLog();
 
 	extern const char *kIsEditBufferDump, *kCreateEditBufferRequest, *kConvertToEditBuffer,
-		*kNameFromDump, *kRenamePatch,
+		*kNameFromDump, *kRenamePatch, *kIsDefaultName,
 		*kIsSingleProgramDump, *kCreateProgramDumpRequest, *kConvertToProgramDump, *kNumberFromDump,
 		*kCreateBankDumpRequest, *kIsPartOfBankDump, *kIsBankDumpFinished, *kExtractPatchesFromBank;
 

diff --git a/adaptions/GenericPatch.cpp b/adaptions/GenericPatch.cpp
@@ -49,37 +49,57 @@ namespace knobkraft {
 
 	void GenericStoredPatchNameCapability::setName(std::string const &name)
 	{
-		// set name is an optional method - if it is not implemented, the name in the patch is never changed, the name displayed in the Librarian is
-		if (!me_->pythonModuleHasFunction(kRenamePatch)) return;
-
-		// Very well, then try to change the name in the patch data
-		try {
-			ScopedLock lock(GenericAdaptation::multiThreadGuard);
-			std::vector<int> v(me_->data().data(), me_->data().data() + me_->data().size());
-			py::object result = me_->callMethod(kRenamePatch, v, name);
-			auto intVector = result.cast<std::vector<int>>();
-			std::vector<uint8> byteData = GenericAdaptation::intVectorToByteVector(intVector);
-			me_->setData(byteData);
-		}
-		catch (py::error_already_set &ex) {
-			std::string errorMessage = (boost::format("Error calling %s: %s") % kRenamePatch % ex.what()).str();
-			SimpleLogger::instance()->postMessage(errorMessage);
-		}
-		catch (...) {
-			SimpleLogger::instance()->postMessage((boost::format("Uncaught exception in %s of Patch of GenericAdaptation") % kRenamePatch).str());
+		if (!me_.expired()) {
+			// set name is an optional method - if it is not implemented, the name in the patch is never changed, the name displayed in the Librarian is
+			if (!me_.lock()->pythonModuleHasFunction(kRenamePatch)) return;
+
+			// Very well, then try to change the name in the patch data
+			try {
+				ScopedLock lock(GenericAdaptation::multiThreadGuard);
+				std::vector<int> v(me_.lock()->data().data(), me_.lock()->data().data() + me_.lock()->data().size());
+				py::object result = me_.lock()->callMethod(kRenamePatch, v, name);
+				auto intVector = result.cast<std::vector<int>>();
+				std::vector<uint8> byteData = GenericAdaptation::intVectorToByteVector(intVector);
+				me_.lock()->setData(byteData);
+			}
+			catch (py::error_already_set &ex) {
+				std::string errorMessage = (boost::format("Error calling %s: %s") % kRenamePatch % ex.what()).str();
+				SimpleLogger::instance()->postMessage(errorMessage);
+			}
+			catch (...) {
+				SimpleLogger::instance()->postMessage((boost::format("Uncaught exception in %s of Patch of GenericAdaptation") % kRenamePatch).str());
+			}
 		}
 	}
 
-	bool GenericStoredPatchNameCapability::isDefaultName() const
+	bool GenericDefaultNameCapability::isDefaultName(std::string const &patchName) const
 	{
-		// Not implemented yet
+		if (!me_.expired()) {
+			auto patch = me_.lock();
+			try {
+				py::object result = patch->callMethod(kIsDefaultName, patchName);
+				return py::cast<bool>(result);
+			}
+			catch (py::error_already_set &ex) {
+				std::string errorMessage = (boost::format("Error calling %s: %s") % kIsDefaultName % ex.what()).str();
+				SimpleLogger::instance()->postMessage(errorMessage);
+			}
+			catch (...) {
+				SimpleLogger::instance()->postMessage((boost::format("Uncaught exception in %s of Patch of GenericAdaptation") % kIsDefaultName).str());
+			}
+		}
 		return false;
 	}
 
 	bool GenericPatch::hasCapability(std::shared_ptr<midikraft::StoredPatchNameCapability> &outCapability) const
 	{
 		midikraft::StoredPatchNameCapability *impl;
 		if (hasCapability(&impl)) {
+			if (!genericStoredPatchNameCapabilityImpl_) {
+				// Lazy init allowed despite const-ness of method. Smell.
+				GenericPatch *non_const = const_cast<GenericPatch *>(this);
+				non_const->genericStoredPatchNameCapabilityImpl_ = std::make_shared<GenericStoredPatchNameCapability>(non_const->shared_from_this());
+			}
 			outCapability = genericStoredPatchNameCapabilityImpl_;
 			return true;
 		}
@@ -89,11 +109,44 @@ namespace knobkraft {
 	bool GenericPatch::hasCapability(midikraft::StoredPatchNameCapability **outCapability) const
 	{
 		if (pythonModuleHasFunction(kRenamePatch)) {
+			if (!genericStoredPatchNameCapabilityImpl_) {
+				// Lazy init allowed despite const-ness of method. Smell.
+				GenericPatch *non_const = const_cast<GenericPatch *>(this);
+				non_const->genericStoredPatchNameCapabilityImpl_ = std::make_shared<GenericStoredPatchNameCapability>(non_const->shared_from_this());
+			}
 			*outCapability = genericStoredPatchNameCapabilityImpl_.get();
 			return true;
 		}
 		return false;
 	}
 
+	bool GenericPatch::hasCapability(std::shared_ptr<midikraft::DefaultNameCapability> &outCapability) const
+	{
+		midikraft::DefaultNameCapability *impl;
+		if (hasCapability(&impl)) {
+			if (!genericDefaultNameCapabilityImp_) {
+				// Lazy init allowed despite const-ness of method. Smell.
+				GenericPatch *non_const = const_cast<GenericPatch *>(this);
+				non_const->genericDefaultNameCapabilityImp_ = std::make_shared<GenericDefaultNameCapability>(non_const->shared_from_this());
+			}
+			outCapability = genericDefaultNameCapabilityImp_;
+			return true;
+		}
+		return false;
+	}
+
+	bool GenericPatch::hasCapability(midikraft::DefaultNameCapability **outCapability) const
+	{
+		if (pythonModuleHasFunction(kIsDefaultName)) {
+			if (!genericDefaultNameCapabilityImp_) {
+				// Lazy init allowed despite const-ness of method. Smell.
+				GenericPatch *non_const = const_cast<GenericPatch *>(this);
+				non_const->genericDefaultNameCapabilityImp_ = std::make_shared<GenericDefaultNameCapability>(non_const->shared_from_this());
+			}
+			*outCapability = genericDefaultNameCapabilityImp_.get();
+			return true;
+		}
+		return false;
+	}
 }
 
diff --git a/adaptions/GenericPatch.h b/adaptions/GenericPatch.h
@@ -23,16 +23,27 @@ namespace knobkraft {
 
 	class GenericStoredPatchNameCapability : public midikraft::StoredPatchNameCapability {
 	public:
-		GenericStoredPatchNameCapability(GenericPatch *me) : me_(me) {}
+		GenericStoredPatchNameCapability(std::shared_ptr<GenericPatch> me) : me_(me) {}
 
 		void setName(std::string const &name) override;
-		virtual bool isDefaultName() const override;
 
 	private:
-		GenericPatch *me_;
+		std::weak_ptr<GenericPatch> me_;
+	};
+
+	class GenericDefaultNameCapability : public midikraft::DefaultNameCapability {
+	public:
+		GenericDefaultNameCapability(std::shared_ptr<GenericPatch> me) : me_(me) {}
+
+		virtual bool isDefaultName(std::string const &patchName) const override;
+
+	private:
+		std::weak_ptr<GenericPatch> me_;
 	};
 
 	class GenericPatch : public midikraft::DataFile, public midikraft::RuntimeCapability<midikraft::StoredPatchNameCapability>
+		, public midikraft::RuntimeCapability<midikraft::DefaultNameCapability>
+		, public std::enable_shared_from_this<GenericPatch>
 	{
 	public:
 		enum DataType {
@@ -74,9 +85,12 @@ namespace knobkraft {
 		// Runtime Capabilities
 		bool hasCapability(std::shared_ptr<midikraft::StoredPatchNameCapability> &outCapability) const override;
 		bool hasCapability(midikraft::StoredPatchNameCapability **outCapability) const override;
+		bool hasCapability(std::shared_ptr<midikraft::DefaultNameCapability> &outCapability) const override;
+		bool hasCapability(midikraft::DefaultNameCapability **outCapability) const override;
 
 	private:
 		std::shared_ptr<GenericStoredPatchNameCapability> genericStoredPatchNameCapabilityImpl_;
+		std::shared_ptr<GenericDefaultNameCapability> genericDefaultNameCapabilityImp_;
 
 		pybind11::module &adaptation_;
 		std::string name_;

diff --git a/synths/MidiKraft-access-virus b/synths/MidiKraft-access-virus
diff --git a/synths/MidiKraft-oberheim-matrix1000 b/synths/MidiKraft-oberheim-matrix1000
diff --git a/synths/MidiKraft-sequential-ob6 b/synths/MidiKraft-sequential-ob6
diff --git a/synths/MidiKraft-sequential-rev2 b/synths/MidiKraft-sequential-rev2
diff --git a/synths/MidiKraft-yamaha-refacedx b/synths/MidiKraft-yamaha-refacedx
+5 −1		include/StoredPatchNameCapability.h
+14 −3		src/Synth.cpp