MSGTOPLUGIN implemented for other plugins to call Python functions

 - Changes to allow synchronous scripts to be run (although no interface,
   other than using MSGTOPLUGIN)
 - Starts to documentation for Npp and Notepad objects
   (Editor/Scintilla object will be most auto-generated)

Author: bruderstein

NppPlugin/include/keys.h

@@ -0,0 +1,178 @@
+/*
+See winuser.h
+Altered list to support VK_0-9 and VK_A-Z
+*/
+
+#define VK_NULL           0x00
+
+#define VK_CANCEL         0x03
+
+#define VK_BACK           0x08
+#define VK_TAB            0x09
+
+#define VK_CLEAR          0x0C
+#define VK_RETURN         0x0D
+
+#define VK_SHIFT          0x10
+#define VK_CONTROL        0x11
+#define VK_MENU           0x12
+#define VK_PAUSE          0x13
+#define VK_CAPITAL        0x14
+
+#define VK_KANA           0x15
+#define VK_HANGUL         0x15
+#define VK_JUNJA          0x17
+#define VK_FINAL          0x18
+#define VK_HANJA          0x19
+#define VK_KANJI          0x19
+
+#define VK_ESCAPE         0x1B
+
+#define VK_CONVERT        0x1C
+#define VK_NONCONVERT     0x1D
+#define VK_ACCEPT         0x1E
+#define VK_MODECHANGE     0x1F
+
+#define VK_SPACE          0x20
+#define VK_PRIOR          0x21
+#define VK_NEXT           0x22
+#define VK_END            0x23
+#define VK_HOME           0x24
+#define VK_LEFT           0x25
+#define VK_UP             0x26
+#define VK_RIGHT          0x27
+#define VK_DOWN           0x28
+#define VK_SELECT         0x29
+#define VK_PRINT          0x2A
+#define VK_EXECUTE        0x2B
+#define VK_SNAPSHOT       0x2C
+#define VK_INSERT         0x2D
+#define VK_DELETE         0x2E
+#define VK_HELP           0x2F
+
+#define VK_0              0x30
+#define VK_1              0x31
+#define VK_2              0x32
+#define VK_3              0x33
+#define VK_4              0x34
+#define VK_5              0x35
+#define VK_6              0x36
+#define VK_7              0x37
+#define VK_8              0x38
+#define VK_9              0x39
+#define VK_A              0x41
+#define VK_B              0x42
+#define VK_C              0x43
+#define VK_D              0x44
+#define VK_E              0x45
+#define VK_F              0x46
+#define VK_G              0x47
+#define VK_H              0x48
+#define VK_I              0x49
+#define VK_J              0x4A
+#define VK_K              0x4B
+#define VK_L              0x4C
+#define VK_M              0x4D
+#define VK_N              0x4E
+#define VK_O              0x4F
+#define VK_P              0x50
+#define VK_Q              0x51
+#define VK_R              0x52
+#define VK_S              0x53
+#define VK_T              0x54
+#define VK_U              0x55
+#define VK_V              0x56
+#define VK_W              0x57
+#define VK_X              0x58
+#define VK_Y              0x59
+#define VK_Z              0x5A
+
+#define VK_LWIN           0x5B
+#define VK_RWIN           0x5C
+#define VK_APPS           0x5D
+
+
+#define VK_SLEEP          0x5F
+
+#define VK_NUMPAD0        0x60
+#define VK_NUMPAD1        0x61
+#define VK_NUMPAD2        0x62
+#define VK_NUMPAD3        0x63
+#define VK_NUMPAD4        0x64
+#define VK_NUMPAD5        0x65
+#define VK_NUMPAD6        0x66
+#define VK_NUMPAD7        0x67
+#define VK_NUMPAD8        0x68
+#define VK_NUMPAD9        0x69
+#define VK_MULTIPLY       0x6A
+#define VK_ADD            0x6B
+#define VK_SEPARATOR      0x6C
+#define VK_SUBTRACT       0x6D
+#define VK_DECIMAL        0x6E
+#define VK_DIVIDE         0x6F
+#define VK_F1             0x70
+#define VK_F2             0x71
+#define VK_F3             0x72
+#define VK_F4             0x73
+#define VK_F5             0x74
+#define VK_F6             0x75
+#define VK_F7             0x76
+#define VK_F8             0x77
+#define VK_F9             0x78
+#define VK_F10            0x79
+#define VK_F11            0x7A
+#define VK_F12            0x7B
+#define VK_F13            0x7C
+#define VK_F14            0x7D
+#define VK_F15            0x7E
+#define VK_F16            0x7F
+#define VK_F17            0x80
+#define VK_F18            0x81
+#define VK_F19            0x82
+#define VK_F20            0x83
+#define VK_F21            0x84
+#define VK_F22            0x85
+#define VK_F23            0x86
+#define VK_F24            0x87
+
+#define VK_NUMLOCK        0x90
+#define VK_SCROLL         0x91
+
+#define VK_OEM_1          0xBA   // ';:' for US
+#define VK_OEM_PLUS       0xBB   // '+' any country
+#define VK_OEM_COMMA      0xBC   // ',' any country
+#define VK_OEM_MINUS      0xBD   // '-' any country
+#define VK_OEM_PERIOD     0xBE   // '.' any country
+#define VK_OEM_2          0xBF   // '/?' for US
+#define VK_OEM_3          0xC0   // '`~' for US
+
+#define VK_OEM_4          0xDB  //  '[{' for US
+#define VK_OEM_5          0xDC  //  '\|' for US
+#define VK_OEM_6          0xDD  //  ']}' for US
+#define VK_OEM_7          0xDE  //  ''"' for US
+#define VK_OEM_8          0xDF
+
+#define VK_OEM_102        0xE2  //  "<>" or "\|" on RT 102-key kbd.
+
+#define VK_OEM_RESET      0xE9
+#define VK_OEM_JUMP       0xEA
+#define VK_OEM_PA1        0xEB
+#define VK_OEM_PA2        0xEC
+#define VK_OEM_PA3        0xED
+#define VK_OEM_WSCTRL     0xEE
+#define VK_OEM_CUSEL      0xEF
+#define VK_OEM_ATTN       0xF0
+#define VK_OEM_FINISH     0xF1
+#define VK_OEM_COPY       0xF2
+#define VK_OEM_AUTO       0xF3
+#define VK_OEM_ENLW       0xF4
+#define VK_OEM_BACKTAB    0xF5
+#define VK_ATTN           0xF6
+#define VK_CRSEL          0xF7
+#define VK_EXSEL          0xF8
+#define VK_EREOF          0xF9
+#define VK_PLAY           0xFA
+#define VK_ZOOM           0xFB
+#define VK_NONAME         0xFC
+#define VK_PA1            0xFD
+#define VK_OEM_CLEAR      0xFE

PythonScript/include/PythonScript/NppPythonScript.h

@@ -0,0 +1,76 @@
+#ifndef _NPPPYTHONSCRIPT_H
+#define _NPPPYTHONSCRIPT_H
+
+
+
+#define WIN32_LEAN_AND_MEAN
+#include <Windows.h>
+#undef  WIN32_LEAN_AND_MEAN
+
+#include <tchar.h>
+
+#define PYSCR_START (WM_USER + 3500)
+
+/**  Execute a script in a file
+ *   (wParam = 0, PythonScript_Exec *pse)
+ */
+#define PYSCR_EXECSCRIPT			(PYSCR_START+0)
+
+
+
+/**  Execute a script as a statement
+ *   (wParam = 0, PythonScript_Exec *pse)
+ */
+#define PYSCR_EXECSTATEMENT			(PYSCR_START+1)
+
+
+/** Use PYSCRF_SYNC in the flags member to run the script or statement
+ *  synchronously (i.e. within the same thread).  The SendMessage() call
+ *  will return when the script or statement has completed.
+ *  
+ *  Note that the completedEvent is NOT signalled if PYSCRF_SYNC is used.
+ *  Also bear in mind, that running scripts synchronously runs the script on the 
+ *  UI thread, so everything is blocked - in a long running script, it will look like
+ *  N++ has frozen - short scripts may just cause a jitter.  You have been warned :)
+ *  Better is to use the completedEvent of the struct to wait on a separate thread for 
+ *  the script to finish.
+ */
+#define PYSCRF_SYNC					(0x0001)
+
+
+struct PythonScript_Exec 
+{
+	/// PythonScript_Exec structure version - must always be 1
+	int structVersion;
+
+	/// Python Script (for PYSCR_EXECSTATEMENT) or absolute filename (for PYSCR_EXECSCRIPT)
+	TCHAR *script;
+
+	/** HANDLE to an event created with CreateEvent.  This event is signalled (with SetEvent)
+	 *  when the script has completed. 
+	 *  This can be NULL, in which case no event is signalled
+	 * 
+	 *  Important: Do NOT wait on the handle on the thread that Notepad++ runs on 
+	 *  (ie. the plugin default thread) unless you really know what you are doing :)
+	 *  It will almost certainly deadlock (as Scintilla or N++ may need to process a message) 
+	 */
+
+	HANDLE completedEvent;
+
+	/** Flags for running the script
+	 *  Combination of PYSCRF_xxxxx constants
+	 */
+	int flags;
+
+	/** PythonScripts sets this to TRUE when the PythonScript plugin 
+	 *  has successfully received the message. 
+	 *  Note that a TRUE here does NOT mean the script has run, or ran without
+	 *  errors, merely that the script has been added to the queue to run
+	 * 
+	 *  You should set this to FALSE initially, and check for TRUE when SendMessage() returns.
+	 */
+	BOOL deliverySuccess;
+};
+	
+
+#endif

PythonScript/project/PythonScript2010.vcxproj

@@ -60,6 +60,7 @@
       <Optimization>Disabled</Optimization>
       <PreprocessorDefinitions>WIN32;_DEBUG;_WINDOWS;_USRDLL;PYTHONSCRIPT2010_EXPORTS;BOOST_PYTHON_STATIC_LIB;%(PreprocessorDefinitions)</PreprocessorDefinitions>
       <RuntimeLibrary>MultiThreadedDebug</RuntimeLibrary>
+      <AdditionalIncludeDirectories>../include;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
     </ClCompile>
     <Link>
       <SubSystem>Windows</SubSystem>
@@ -79,6 +80,7 @@
       <IntrinsicFunctions>true</IntrinsicFunctions>
       <PreprocessorDefinitions>WIN32;NDEBUG;_WINDOWS;_USRDLL;PYTHONSCRIPT2010_EXPORTS;BOOST_PYTHON_STATIC_LIB;%(PreprocessorDefinitions)</PreprocessorDefinitions>
       <RuntimeLibrary>MultiThreaded</RuntimeLibrary>
+      <AdditionalIncludeDirectories>../include;%(AdditionalIncludeDirectories)</AdditionalIncludeDirectories>
     </ClCompile>
     <Link>
       <SubSystem>Windows</SubSystem>
@@ -136,6 +138,7 @@
     <ClCompile Include="..\src\WcharMbcsConverter.cpp" />
   </ItemGroup>
   <ItemGroup>
+    <ClInclude Include="..\include\PythonScript\NppPythonScript.h" />
     <ClInclude Include="..\src\AboutDialog.h" />
     <ClInclude Include="..\src\ConfigFile.h" />
     <ClInclude Include="..\src\ConsoleDialog.h" />

PythonScript/project/PythonScript2010.vcxproj.filters

@@ -203,6 +203,9 @@
     <ClInclude Include="..\src\resource1.h">
       <Filter>Header Files</Filter>
     </ClInclude>
+    <ClInclude Include="..\include\PythonScript\NppPythonScript.h">
+      <Filter>Header Files</Filter>
+    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <ResourceCompile Include="..\src\PythonScript.rc">

PythonScript/src/MenuManager.cpp

@@ -27,7 +27,7 @@ bool MenuManager::s_menuItemClicked;
 void (*MenuManager::s_runScript)(int);
 
 
-MenuManager* MenuManager::create(HWND hNotepad, HINSTANCE hInst, void(*runScript)(const char *))
+MenuManager* MenuManager::create(HWND hNotepad, HINSTANCE hInst, void(*runScript)(const char *, bool, HANDLE, bool))
 {
 	if (NULL == s_menuManager)
 	{
@@ -53,7 +53,7 @@ MenuManager* MenuManager::getInstance()
 }
 
 
-MenuManager::MenuManager(HWND hNotepad, HINSTANCE hInst, void(*runScript)(const char *))
+MenuManager::MenuManager(HWND hNotepad, HINSTANCE hInst, void(*runScript)(const char *, bool, HANDLE, bool))
 	:
 	m_hInst (hInst),
 	m_hNotepad (hNotepad),
@@ -450,12 +450,12 @@ int MenuManager::findScripts(HMENU hBaseMenu, int basePathLength, int startID, s
 
 void MenuManager::menuCommand(int commandID)
 {
-	m_runScript(m_scriptCommands[commandID].c_str());
+	m_runScript(m_scriptCommands[commandID].c_str(), false, NULL, false);
 }
 
 void MenuManager::toolbarCommand(int commandID)
 {
-	m_runScript(m_toolbarCommands[commandID].c_str());
+	m_runScript(m_toolbarCommands[commandID].c_str(), false, NULL, false);
 }
 
 

PythonScript/src/MenuManager.h

@@ -28,7 +28,7 @@ class MenuManager
 	typedef std::vector<std::pair<tstring, void (*)()> > ItemVectorTD;
 
 
-	static MenuManager* create(HWND hNotepad, HINSTANCE hInst, void(*runScript)(const char *));
+	static MenuManager* create(HWND hNotepad, HINSTANCE hInst, void(*runScript)(const char *, bool, HANDLE, bool));
 	static MenuManager* getInstance();
 	static void         deleteInstance();
 
@@ -66,15 +66,15 @@ class MenuManager
 
 
 private:
-	MenuManager(HWND hNotepad, HINSTANCE hInst, void(*runScript)(const char *));
+	MenuManager(HWND hNotepad, HINSTANCE hInst, void(*runScript)(const char *, bool, HANDLE, bool));
 
 
 
 	HMENU getOurMenu();
 	int findScripts(HMENU hBaseMenu, int basePathLength, int startID, std::string& path);
 	void subclassNotepadPlusPlus();
 
-	void (*m_runScript)(const char*);
+	void(*m_runScript)(const char *, bool, HANDLE, bool);
 
 	typedef std::set<std::string> MachineScriptNamesTD;
 	typedef std::map<int, std::string> ScriptCommandsTD;