Run Previous Script feature

  - Remembers last run script
  - Updates menu item (including shortcut) with script name

  - Fixed bug with Stop-Script that meant it was disabled but not greyed out
    on XP

Author: bruderstein

PythonScript/src/MenuManager.cpp

@@ -58,8 +58,8 @@ MenuManager::MenuManager(HWND hNotepad, HINSTANCE hInst, void(*runScript)(const
 	m_hInst (hInst),
 	m_hNotepad (hNotepad),
 	m_runScript (runScript),
-	m_pythonPluginMenu (NULL)
-	
+	m_pythonPluginMenu (NULL),
+	m_funcItems(NULL)
 {
 	s_startDynamicEntryID = 1;
 	s_endDynamicEntryID = 0;
@@ -248,9 +248,10 @@ HMENU MenuManager::getOurMenu()
 
 void MenuManager::stopScriptEnabled(bool enabled)
 {
-	if (m_pythonPluginMenu)
+	HMENU pythonPluginMenu = getOurMenu();
+	if (pythonPluginMenu)
 	{
-		::EnableMenuItem(m_pythonPluginMenu, m_stopScriptIndex, MF_BYPOSITION | (enabled ? MF_ENABLED : MF_DISABLED));
+		::EnableMenuItem(pythonPluginMenu, m_stopScriptIndex, MF_BYPOSITION | (enabled ? MF_ENABLED : MF_GRAYED));
 	}
 
 }
@@ -501,7 +502,7 @@ void MenuManager::subclassNotepadPlusPlus()
 
 
 
-FuncItem* MenuManager::getFuncItemArray(int *nbF, ItemVectorTD items, void (*runScript)(int), int dynamicStartIndex, int scriptsMenuIndex, int stopScriptIndex) 
+FuncItem* MenuManager::getFuncItemArray(int *nbF, ItemVectorTD items, void (*runScript)(int), int dynamicStartIndex, int scriptsMenuIndex, int stopScriptIndex, int runPreviousIndex) 
 {
 	s_runScript = runScript;
 
@@ -570,7 +571,8 @@ FuncItem* MenuManager::getFuncItemArray(int *nbF, ItemVectorTD items, void (*run
 	m_originalDynamicCount = m_dynamicCount;
 	m_scriptsMenuIndex = scriptsMenuIndex;
 	m_stopScriptIndex = stopScriptIndex;
-	
+	m_runPreviousIndex = runPreviousIndex;
+
 	return m_funcItems;
 
 }
@@ -807,4 +809,65 @@ int MenuManager::findMenuCommand(HMENU hParentMenu, const TCHAR *menuName, const
 
 	return retVal;
 
+}
+
+void MenuManager::initPreviousScript()
+{
+	ShortcutKey key;
+	if (::SendMessage(m_hNotepad, NPPM_GETSHORTCUTBYCMDID, m_funcItems[m_runPreviousIndex]._cmdID, reinterpret_cast<LPARAM>(&key)))
+	{
+		m_runLastScriptShortcut = getKeyName(key);
+	}
+		
+	::EnableMenuItem(getOurMenu(), m_runPreviousIndex, MF_GRAYED | MF_BYPOSITION);
+
+}
+
+void MenuManager::updateShortcut(UINT cmdID, ShortcutKey* key)
+{
+	if (cmdID == static_cast<UINT>(m_funcItems[m_runPreviousIndex]._cmdID))
+	{
+		if (key && key->_key != VK_NULL)
+		{
+			m_runLastScriptShortcut = getKeyName(*key);
+		}
+		else
+		{
+			m_runLastScriptShortcut.erase();
+		}
+
+		updatePreviousScript(m_previousRunFilename.c_str());
+	}
+}
+
+void MenuManager::updatePreviousScript(const char *filename)
+{
+	char displayName[MAX_PATH];
+	strcpy_s(displayName, MAX_PATH, PathFindFileNameA(filename));
+	PathRemoveExtensionA(displayName);
+
+	m_previousRunFilename = filename;
+	
+	tstring tdisplayName(_T("Run Previous Script ("));
+	tdisplayName.append(WcharMbcsConverter::char2tchar(displayName).get());
+	tdisplayName.append(_T(")"));
+
+	if (!m_runLastScriptShortcut.empty())
+	{
+		tdisplayName.append(_T("\t"));
+		tdisplayName.append(m_runLastScriptShortcut);
+	}
+
+	
+	MENUITEMINFO mi;
+	mi.cbSize = sizeof(MENUITEMINFO);
+	mi.fMask = MIIM_STATE | MIIM_STRING;
+	mi.fState = MFS_ENABLED;
+	
+	// string is not altered in SetMenuItemInfo() call, so we're safe to cast this
+	mi.dwTypeData = const_cast<TCHAR*>(tdisplayName.c_str());
+
+	SetMenuItemInfo(getOurMenu(), m_runPreviousIndex, TRUE, &mi);
+	DrawMenuBar(m_hNotepad);
+	
 }

PythonScript/src/MenuManager.h

@@ -35,7 +35,8 @@ class MenuManager
 
 	void stopScriptEnabled(bool enabled);
 
-	FuncItem* getFuncItemArray(int *nbF, ItemVectorTD items, void (*runScript)(int), int dynamicStartIndex, int scriptsMenuIndex, int stopScriptIndex);
+	FuncItem* getFuncItemArray(int *nbF, ItemVectorTD items, void (*runScript)(int), int dynamicStartIndex, int scriptsMenuIndex, int stopScriptIndex, int runPreviousIndex);
+	FuncItem* getFuncItems() { return m_funcItems; }
 
 	bool populateScriptsMenu();
 	void menuCommand(int commandID);
@@ -51,6 +52,11 @@ class MenuManager
 	int findPluginCommand(const TCHAR *pluginName, const TCHAR *menuOption);
 	int findMenuCommand(const TCHAR *menuName, const TCHAR *menuOption);
 	int findMenuCommand(HMENU parentMenu, const TCHAR *menuName, const TCHAR *menuOption);
+
+	void updatePreviousScript(const char *filename);
+	void updateShortcut(UINT cmdID, ShortcutKey* key);
+	void initPreviousScript();
+
 	static int s_startCommandID;
 	static int s_endCommandID;
 	static int s_startFixedID;
@@ -98,12 +104,15 @@ class MenuManager
 	int			m_originalDynamicCount;
 	int			m_scriptsMenuIndex;
 	int			m_stopScriptIndex;
+	int			m_runPreviousIndex;
 	HMENU		m_pythonPluginMenu;
 	HMENU		m_hScriptsMenu;
 	FuncItem*   m_funcItems;
 	int         m_funcItemCount;
 	std::string m_machineScriptsPath;
 	std::string m_userScriptsPath;
+	tstring		m_runLastScriptShortcut;
+	std::string m_previousRunFilename;
 
 	// Function pointer to the real run script function
 	static void (*s_runScript)(int);

PythonScript/src/PythonScript.cpp

@@ -45,12 +45,12 @@ PythonConsole   *g_console = 0;
 // Paths
 char g_pluginDir[MAX_PATH];
 char g_configDir[MAX_PATH];
+string g_previousScript;
 
 bool g_infoSet = false;
 int g_scriptsMenuIndex = 0;
 int g_stopScriptIndex = 0;
 bool g_initialised = false;
-
 MenuManager *g_menuManager;
 
 // Scripts on the menu
@@ -72,6 +72,8 @@ void runScript(const char *script, bool synchronous, HANDLE completedEvent = NUL
 void runStatement(const char *statement, bool synchronous, HANDLE completedEvent = NULL, bool allowQueuing = false);
 void shutdown(void *);
 void doHelp();
+void previousScript();
+
 FuncItem* getGeneratedFuncItemArray(int *nbF);
 
 
@@ -180,6 +182,7 @@ FuncItem* getGeneratedFuncItemArray(int *nbF)
 	int stopScriptIndex;
 	int dynamicStartIndex;
 	int scriptsMenuIndex;
+	int runPreviousIndex;
 
 	items.push_back(pair<tstring, void(*)()>(_T("New Script"), newScript));
 	items.push_back(pair<tstring, void(*)()>(_T("Show Console"), showConsole));
@@ -192,6 +195,10 @@ FuncItem* getGeneratedFuncItemArray(int *nbF)
 	items.push_back(pair<tstring, void(*)()>(_T("--"), reinterpret_cast<void(*)()>(NULL)));
 
 
+	
+	items.push_back(pair<tstring, void(*)()>(_T("Run Previous Script"), previousScript));
+	runPreviousIndex = items.size() - 1;
+
 	items.push_back(pair<tstring, void(*)()>(_T("--"), reinterpret_cast<void(*)()>(NULL)));
 	scriptsMenuIndex = items.size() - 1;
 
@@ -208,7 +215,7 @@ FuncItem* getGeneratedFuncItemArray(int *nbF)
 
 
 
-	FuncItem* funcItems = menuManager->getFuncItemArray(nbF, items, runScript, dynamicStartIndex, scriptsMenuIndex, stopScriptIndex);
+	FuncItem* funcItems = menuManager->getFuncItemArray(nbF, items, runScript, dynamicStartIndex, scriptsMenuIndex, stopScriptIndex, runPreviousIndex);
 
 
 	return funcItems;
@@ -234,6 +241,7 @@ void initialise()
 	MenuManager* menuManager = MenuManager::getInstance();
 	menuManager->populateScriptsMenu();
 	menuManager->stopScriptEnabled(false);
+	menuManager->initPreviousScript();
 
 
 }
@@ -313,6 +321,13 @@ extern "C" __declspec(dllexport) void beNotified(SCNotification *notifyCode)
 			registerToolbarIcons();
 			break;
 
+		case NPPN_SHORTCUTREMAPPED:
+			{
+				MenuManager *menuManager = MenuManager::getInstance();
+				menuManager->updateShortcut(notifyCode->nmhdr.idFrom, reinterpret_cast<ShortcutKey*>(notifyCode->nmhdr.hwndFrom));
+			}
+			break;
+
 	}
 
 	// Notify the scripts
@@ -431,8 +446,20 @@ void runStatement(const char *statement, bool synchronous, HANDLE completedEvent
 
 }
 
+void updatePreviousScript(const char *filename)
+{
+	if (g_previousScript == filename)
+		return;
+
+	g_previousScript = filename;
+
+	MenuManager *menuManager = MenuManager::getInstance();
+	menuManager->updatePreviousScript(filename);
+}
+
 void runScript(const char *filename, bool synchronous, HANDLE completedEvent /* = NULL */, bool allowQueuing /* = false */)
 {
+	
 	BYTE keyState[256];
 	::GetKeyboardState(keyState);
 
@@ -448,6 +475,10 @@ void runScript(const char *filename, bool synchronous, HANDLE completedEvent /*
 	{
 		CHECK_INITIALISED();
 		MenuManager::getInstance()->stopScriptEnabled(true);
+		
+		// TODO: Really need to not change this if it's a MSGTOPLUGIN run
+		updatePreviousScript(filename);
+
 		if (!pythonHandler->runScript(filename, synchronous, allowQueuing, completedEvent))
 		{
 			MessageBox(NULL, _T("Another script is currently running.  Running two scripts at the same time could produce unpredicable results, and is therefore disabled."), _T("Python Script"), 0);
@@ -558,4 +589,9 @@ void doHelp()
 
 	HelpController help(nppData._nppHandle, which ? nppData._scintillaSecondHandle : nppData._scintillaMainHandle);
 	help.callHelp();
+}
+
+void previousScript()
+{
+	runScript(g_previousScript.c_str(), false);
 }