fix bruderstein#303

chcg · chcg · commit 0c7e163f1dae · 2023-08-19T08:47:39.000+02:00
add support for notepad.allocateIndicator function
available with N++ 8.5.6 and therefore updated N++ files
diff --git a/NppPlugin/include/Notepad_plus_msgs.h b/NppPlugin/include/Notepad_plus_msgs.h
@@ -368,7 +368,7 @@ enum Platform { PF_UNKNOWN, PF_X86, PF_X64, PF_IA64, PF_ARM64 };
 
 	#define NPPM_ALLOCATEMARKER  (NPPMSG + 82)
     // BOOL NPPM_ALLOCATEMARKER(int numberRequested, int* startNumber)
-    // sets startNumber to the initial command ID if successful
+    // sets startNumber to the initial marker ID if successful
     // Allocates a marker number to a plugin: if a plugin need to add a marker on Notepad++'s Scintilla marker margin,
 	// it has to use this message to get marker number, in order to prevent from the conflict with the other plugins.
     // Returns: TRUE if successful, FALSE otherwise. startNumber will also be set to 0 if unsuccessful
@@ -591,6 +591,12 @@ enum Platform { PF_UNKNOWN, PF_X86, PF_X64, PF_IA64, PF_ARM64 };
 	//	}
 	//}
 
+	#define NPPM_ALLOCATEINDICATOR  (NPPMSG + 113)
+	// BOOL NPPM_ALLOCATEINDICATOR(int numberRequested, int* startNumber)
+	// sets startNumber to the initial indicator ID if successful
+	// Allocates an indicator number to a plugin: if a plugin needs to add an indicator,
+	// it has to use this message to get the indicator number, in order to prevent a conflict with the other plugins.
+	// Returns: TRUE if successful, FALSE otherwise.
 
 	// For RUNCOMMAND_USER
 	#define VAR_NOT_RECOGNIZED 0
diff --git a/PythonScript/python_tests/tests/NotepadWrapperTestCase.py b/PythonScript/python_tests/tests/NotepadWrapperTestCase.py
@@ -518,6 +518,21 @@ def test_allocateMarker(self):
         # test functionality
 
 
+    def test_allocateIndicator(self):
+        ''' '''
+        notepad_method = notepad.allocateIndicator
+        with self.assertRaises(ArgumentError):
+            self._invalid_parameter_passed(notepad_method)
+        with self.assertRaises(ArgumentError):
+            self._invalid_parameter_passed(notepad_method, '')
+        with self.assertRaises(ArgumentError):
+            self._invalid_parameter_passed(notepad_method, -1,-1)
+        with self.assertRaises(ArgumentError):
+            self._invalid_parameter_passed(notepad_method, 0,0)
+        # test return code
+        # test functionality
+
+
     def test_allocateSupported(self):
         ''' '''
         self.__test_invalid_parameter_passed(notepad.allocateSupported)
diff --git a/PythonScript/src/NotepadPlusWrapper.cpp b/PythonScript/src/NotepadPlusWrapper.cpp
@@ -889,6 +889,20 @@ boost::python::object NotepadPlusWrapper::allocateMarker(int quantity)
 	}
 }
 
+boost::python::object NotepadPlusWrapper::allocateIndicator(int quantity)
+{
+	int startID = 0;
+	bool result = static_cast<bool>(callNotepad(NPPM_ALLOCATEINDICATOR, static_cast<WPARAM>(quantity), reinterpret_cast<LPARAM>(&startID)));
+	if (result)
+	{
+		return boost::python::object(startID);
+	}
+	else
+	{
+		return boost::python::object();
+	}
+}
+
 intptr_t NotepadPlusWrapper::getMenuHandle(int menu = 0)
 {
 	return callNotepad(NPPM_GETMENUHANDLE, static_cast<WPARAM>(menu), 0);
diff --git a/PythonScript/src/NotepadPlusWrapper.h b/PythonScript/src/NotepadPlusWrapper.h
@@ -845,6 +845,7 @@ class NotepadPlusWrapper
 	bool allocateSupported();
 	boost::python::object allocateCmdID(int quantity);
 	boost::python::object allocateMarker(int quantity);
+	boost::python::object allocateIndicator(int quantity);
 
 	typedef std::multimap<idx_t, boost::python::object> callbackT;
 
diff --git a/docs/source/notepad.rst b/docs/source/notepad.rst
@@ -38,11 +38,18 @@ Notepad++ Object
 
 .. method:: notepad.allocateMarker(numberRequested) -> bool
 
-   Allocates a range of marker number for Scintilla.
+   Allocates a range of marker numbers for Scintilla.
    Use this to stop marker number collisions with other plugins / scripts.
 
    Returns the start number of the requested range
 
+.. method:: notepad.allocateIndicator(numberRequested) -> bool
+
+   Allocates a range of indicator numbers for Scintilla.
+   Use this to stop indicator number collisions with other plugins / scripts.
+
+   Returns the start number of the requested range
+
 
 .. method:: notepad.allocateSupported() -> bool
 
