Add initial support for external plugins

Author: dail8859

docs_gen/ExternalPluginSupport.md

@@ -0,0 +1,42 @@
+# External Plugin Support
+Plugin developers are able to execute Lua code from their own plugins. Notepad++ provides a mechanism for sending messages between plugins using `NPPM_MSGTOPLUGIN`.
+
+*Note: More commands and fields can be added if needed; feel free to open an issue on GitHub.*
+
+<br/>
+
+Information needed for LuaScript is defined in the custom struct defined [here](https://github.com/dail8859/LuaScript/blob/master/src/NppLuaScript.h).
+
+ - `structVersion` - (reserved for future use) must always be `1`
+ - `flags` - (reserved for future use) must always be `0`
+ - `script` - UTF-8 encoded string. The meaning of this is dependent on the command executed.
+
+<br/>
+
+### Commands
+
+- `LS_EXECUTE_SCRIPT` - executes a file from the hard drive. `script` specifies the full file path to execute.
+- `LS_EXECUTE_STATEMENT` - executes an arbitrary string. `script` is the actual Lua code to execute.
+
+<br/>
+
+### Example 
+The following is example C code to execute a string.
+
+```c
+void function()
+{
+    CommunicationInfo ci;
+    LuaScriptInfo lsi;
+
+    lsi.structVersion = 1;
+    lsi.flags = 0;
+    lsi.script = "for i = 1, 10 do print(i) end";
+
+    ci.srcModuleName = TEXT("MyPlugin.dll");
+    ci.internalMsg = LS_EXECUTE_STATEMENT;
+    ci.info = reinterpret_cast<void *>(&lsi);
+
+    SendMessage(nppHwnd, NPPM_MSGTOPLUGIN, reinterpret_cast<WPARAM>(TEXT("LuaScript.dll")), reinterpret_cast<LPARAM>(&ci));
+}
+```

docs_gen/config.ld

@@ -47,6 +47,7 @@ use_markdown_titles = true
 
 topics = { -- Put any md files here
 	'Callbacks.md',
+	'ExternalPluginSupport.md',
 }
 
 file = { -- sourcecode to parse comments from (Lua or C)

src/LuaScript.cpp

@@ -28,6 +28,7 @@
 #include "NppExtensionAPI.h"
 #include "GUI.h"
 #include "StyleWriter.h"
+#include "NppLuaScript.h"
 
 // --- Menu callbacks ---
 static void showConsole();
@@ -412,7 +413,22 @@ extern "C" __declspec(dllexport) void beNotified(SCNotification *notifyCode) {
 	return;
 }
 
-extern "C" __declspec(dllexport) LRESULT messageProc(UINT Message, WPARAM wParam, LPARAM lParam) {
+// NOTE: this function's return value doesn't actually matter since N++ never uses it
+extern "C" __declspec(dllexport) LRESULT messageProc(UINT message, WPARAM wParam, LPARAM lParam) {
+	if (message == NPPM_MSGTOPLUGIN) {
+		auto ci = reinterpret_cast<const CommunicationInfo*>(lParam);
+		auto lsi = reinterpret_cast<const LuaScriptInfo*>(ci->info);
+
+		if (lsi && lsi->structVersion == 1) {
+			if (ci->internalMsg == LS_EXECUTE_SCRIPT && lsi->script != nullptr) {
+				LuaExtension::Instance().RunFile(GUI::StringFromUTF8(lsi->script).c_str());
+			}
+			else if (ci->internalMsg == LS_EXECUTE_STATEMENT && lsi->script != nullptr) {
+				LuaExtension::Instance().RunString(lsi->script);
+			}
+		}
+	}
+
 	return TRUE;
 }
 

src/LuaScript.vcxproj

@@ -239,6 +239,7 @@
     <ClInclude Include="IFaceTableMixer.h" />
     <ClInclude Include="NppExtensionAPI.h" />
     <ClInclude Include="NppIFaceTable.h" />
+    <ClInclude Include="NppLuaScript.h" />
     <ClInclude Include="Npp\Docking.h" />
     <ClInclude Include="Npp\dockingResource.h" />
     <ClInclude Include="Npp\menuCmdID.h" />

src/LuaScript.vcxproj.filters

@@ -128,6 +128,9 @@
     <ClInclude Include="SciIFaceTable.h">
       <Filter>Header Files</Filter>
     </ClInclude>
+    <ClInclude Include="NppLuaScript.h">
+      <Filter>Header Files</Filter>
+    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <ResourceCompile Include="Dialogs\resource.rc">

src/NppLuaScript.h

@@ -0,0 +1,41 @@
+// This file is part of LuaScript.
+// 
+// Copyright (C)2017 Justin Dailey <[email protected]>
+// 
+// LuaScript is free software; you can redistribute it and/or
+// modify it under the terms of the GNU General Public License
+// as published by the Free Software Foundation; either
+// version 2 of the License, or (at your option) any later version.
+// 
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+// 
+// You should have received a copy of the GNU General Public License
+// along with this program; if not, write to the Free Software
+// Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+
+#ifndef NPPLUASCRIPT_H
+#define NPPLUASCRIPT_H
+
+#define LS_START (WM_USER + 3500)
+
+// Commands that can be sent to LuaScript
+
+#define LS_EXECUTE_SCRIPT (LS_START + 0)
+#define LS_EXECUTE_STATEMENT (LS_START + 1)
+
+struct LuaScriptInfo
+{
+	// The structure's version. This must be 1.
+	int structVersion;
+
+	// Configurable flags
+	int flags;
+
+	// Script to run. This has different meaning based on the command.
+	const char *script;
+};
+
+#endif