Editor callback function does not get cleared if used as bound method in a class bruderstein#153

- replaced the implementation of ScintillaWrapper with the one from NotepadPlusWrapper
- fixed issue by usage of boost::python::object instead of PyObject*
- fixed NotepadPlusWrapper::clearCallbackFunction()
- added parameter annotation in ScintillaPython.cpp

Author: chcg

PythonScript/src/NotepadPlusWrapper.cpp

@@ -751,7 +751,7 @@ void NotepadPlusWrapper::clearCallbackFunction(boost::python::object callback)
 {
 	for(callbackT::iterator it = m_callbacks.begin(); it != m_callbacks.end();)
 	{
-		if (callback.ptr() == it->second.ptr())
+		if (callback == it->second)
 		{
 			it = m_callbacks.erase(it);
 		}

PythonScript/src/ScintillaPython.cpp

@@ -29,8 +29,8 @@ BOOST_PYTHON_MODULE(Npp)
 
 	boost::python::class_<ScintillaWrapper, boost::shared_ptr<ScintillaWrapper>, boost::noncopyable >("Editor", boost::python::no_init)
 		.def("write", &ScintillaWrapper::AddText, "Add text to the document at current position (alias for addText).")
-		.def("callbackSync", &ScintillaWrapper::addSyncCallback, "Registers a callback to a Python function when a Scintilla event occurs. See also callback() to register an asynchronous callback. Callbacks are called synchronously with the event, so try not to perform too much work in the event handler.\nCertain operations cannot be performed in a synchronous callback.  setDocPointer, searchInTarget or findText calls are examples.  Scintilla doesn't allow recursively modifying the text, so you can't modify the text in a SCINTILLANOTIFICATION.MODIFIED callback - use a standard Asynchronous callback to do this.\ne.g. editor.callbackSync(my_function, [SCINTILLANOTIFICATION.CHARADDED])")
-		.def("callback", &ScintillaWrapper::addAsyncCallback, "Registers a callback to call a Python function synchronously when a Scintilla event occurs. Events are queued up, and run in the order they arrive, one after the other, but asynchronously with the main GUI. See editor.callbackSync() to register a synchronous callback. e.g. editor.callback(my_function, [SCINTILLANOTIFICATION.CHARADDED])")
+		.def("callbackSync", &ScintillaWrapper::addSyncCallback, boost::python::args("callable", "listOfNotifications"), "Registers a callback to a Python function when a Scintilla event occurs. See also callback() to register an asynchronous callback. Callbacks are called synchronously with the event, so try not to perform too much work in the event handler.\nCertain operations cannot be performed in a synchronous callback.  setDocPointer, searchInTarget or findText calls are examples.  Scintilla doesn't allow recursively modifying the text, so you can't modify the text in a SCINTILLANOTIFICATION.MODIFIED callback - use a standard Asynchronous callback to do this.\ne.g. editor.callbackSync(my_function, [SCINTILLANOTIFICATION.CHARADDED])")
+		.def("callback", &ScintillaWrapper::addAsyncCallback, boost::python::args("callable", "listOfNotifications"), "Registers a callback to call a Python function synchronously when a Scintilla event occurs. Events are queued up, and run in the order they arrive, one after the other, but asynchronously with the main GUI. See editor.callbackSync() to register a synchronous callback. e.g. editor.callback(my_function, [SCINTILLANOTIFICATION.CHARADDED])")
 		.def("__getitem__", &ScintillaWrapper::GetLine, "Gets a line from the given (zero based) index")
 		.def("__len__", &ScintillaWrapper::GetLength, "Gets the length (number of bytes) in the document")
 		.def("forEachLine", &ScintillaWrapper::forEachLine, "Runs the function passed for each line in the current document.  The function gets passed 3 arguments, the contents of the line, the line number (starting from zero), and the total number of lines.  If the function returns a number, that number is added to the current line number for the next iteration.\nThat way, if you delete the current line, you should return 0, so as to stay on the current physical line.\n\nUnder normal circumstances, you do not need to return anything from the function (i.e. None)\n(Helper function)")
@@ -41,9 +41,9 @@ BOOST_PYTHON_MODULE(Npp)
 		.def("getUserLineSelection", &ScintillaWrapper::getUserLineSelection, "Gets the start and end (zero indexed) line numbers of the user selection, or the whole document if nothing is selected. (Helper function)")
 		.def("getUserCharSelection", &ScintillaWrapper::getUserCharSelection, "Gets the start and end (zero indexed) byte numbers of the user selection, or the whole document if nothing is selected. (Helper function)")
 		.def("clearCallbacks", &ScintillaWrapper::clearAllCallbacks, "Clears all callbacks")
-		.def("clearCallbacks", &ScintillaWrapper::clearCallbackFunction, "Clears all callbacks for a given function")
-		.def("clearCallbacks", &ScintillaWrapper::clearCallbackEvents, "Clears all callbacks for the given list of events")
-		.def("clearCallbacks", &ScintillaWrapper::clearCallback, "Clears the callback for the given callback function for the list of events")
+		.def("clearCallbacks", &ScintillaWrapper::clearCallbackFunction, boost::python::args("callable"), "Clears all callbacks for a given function")
+		.def("clearCallbacks", &ScintillaWrapper::clearCallbackEvents, boost::python::args("notificationList"), "Clears all callbacks for the given list of events")
+		.def("clearCallbacks", &ScintillaWrapper::clearCallback, boost::python::args("callable", "notificationList"), "Clears the callback for the given callback function for the list of events")
 		.def("flash", &ScintillaWrapper::flash, "Flash the editor by reversing the foreground and background colours briefly")
 		.def("flash", &ScintillaWrapper::flashMilliseconds, boost::python::args("milliseconds"), "Flash the editor by reversing the foreground and background colours briefly")
 		.add_static_property("WHOLEDOC", &ScintillaWrapper::getWholeDocFlag)

PythonScript/src/ScintillaWrapper.cpp

@@ -344,20 +344,20 @@ void ScintillaWrapper::runCallbacks(std::shared_ptr<CallbackExecArgs> args)
     DEBUG_TRACE(L"Finished consuming scintilla callbacks\n");
 }
 
-bool ScintillaWrapper::addSyncCallback(PyObject* callback, boost::python::list events)
+bool ScintillaWrapper::addSyncCallback(boost::python::object callback, boost::python::list events)
 {
     return addCallbackImpl(callback, events, false);
 }
 
-bool ScintillaWrapper::addAsyncCallback(PyObject* callback, boost::python::list events)
+bool ScintillaWrapper::addAsyncCallback(boost::python::object callback, boost::python::list events)
 {
     return addCallbackImpl(callback, events, true);
 }
 
 
-bool ScintillaWrapper::addCallbackImpl(PyObject* callback, boost::python::list events, bool isAsync)
+bool ScintillaWrapper::addCallbackImpl(boost::python::object callback, boost::python::list events, bool isAsync)
 {
-	if (PyCallable_Check(callback))
+	if (PyCallable_Check(callback.ptr()))
 	{
 
 		{
@@ -366,9 +366,9 @@ bool ScintillaWrapper::addCallbackImpl(PyObject* callback, boost::python::list e
 			size_t eventCount = _len(events);
 			for(idx_t i = 0; i < eventCount; ++i)
 			{
-                Py_INCREF(callback);
+                Py_INCREF(callback.ptr());
 				m_callbacks.insert(std::pair<int, boost::shared_ptr<ScintillaCallback> >(boost::python::extract<int>(events[i]), 
-					boost::shared_ptr<ScintillaCallback>(new ScintillaCallback(boost::python::object(boost::python::handle<>(callback)), isAsync))));
+					boost::shared_ptr<ScintillaCallback>(new ScintillaCallback(callback, isAsync))));
 			}
 			m_notificationsEnabled = true;
 		}
@@ -381,12 +381,12 @@ bool ScintillaWrapper::addCallbackImpl(PyObject* callback, boost::python::list e
 	}
 }
 
-void ScintillaWrapper::clearCallbackFunction(PyObject* callback)
+void ScintillaWrapper::clearCallbackFunction(boost::python::object callback)
 {
 	NppPythonScript::MutexHolder hold(m_callbackMutex);
 	for(callbackT::iterator it = m_callbacks.begin(); it != m_callbacks.end();)
 	{
-		if (callback == it->second->getCallback().ptr())
+		if (callback == it->second->getCallback())
 		{
 			it = m_callbacks.erase(it);
 		}
@@ -425,13 +425,13 @@ void ScintillaWrapper::clearCallbackEvents(boost::python::list events)
 }
 
 
-void ScintillaWrapper::clearCallback(PyObject* callback, boost::python::list events)
+void ScintillaWrapper::clearCallback(boost::python::object callback, boost::python::list events)
 {
     NppPythonScript::MutexHolder hold(m_callbackMutex);
 
 	for(callbackT::iterator it = m_callbacks.begin(); it != m_callbacks.end(); )
 	{
-		if(it->second->getCallback().ptr() == callback && boost::python::extract<bool>(events.contains(it->first)))
+		if(it->second->getCallback() == callback && boost::python::extract<bool>(events.contains(it->first)))
 		{
 			it = m_callbacks.erase(it);
 		}

PythonScript/src/ScintillaWrapper.h

@@ -59,14 +59,14 @@ class ScintillaWrapper : public PyProducerConsumer<CallbackExecArgs>
 	void invalidateHandle() { m_handle = NULL; };
 
 	void notify(SCNotification *notifyCode);
-	bool addSyncCallback(PyObject* callback, boost::python::list events);
-    bool addAsyncCallback(PyObject *callback, boost::python::list events);
-    bool addCallbackImpl(PyObject *callback, boost::python::list events, bool isAsync);
+	bool addSyncCallback(boost::python::object callback, boost::python::list events);
+	bool addAsyncCallback(boost::python::object callback, boost::python::list events);
+	bool addCallbackImpl(boost::python::object callback, boost::python::list events, bool isAsync);
 
 	void clearAllCallbacks();
-	void clearCallbackFunction(PyObject* callback);
+	void clearCallbackFunction(boost::python::object callback);
 	void clearCallbackEvents(boost::python::list events);
-	void clearCallback(PyObject* callback, boost::python::list events);
+	void clearCallback(boost::python::object callback, boost::python::list events);
 
 	/* Helper functions
 	 * These functions are designed to make life easier for scripting,