PluginDefinition.cpp

//Copyright (C)2011 Kapil Ratnani <kapil.ratnani@iiitb.net>
//
//This program 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.

#include "PluginDefinition.h"
#include "menuCmdID.h"
#include <iostream>
#include <assert.h>
#include "Hyperlinks.h"
#include "pcre.h"
#define OVECCOUNT 60
#include "nppdocitplugin.h"
#include <map>
#include <iterator>

BOOLEAN docitPluginsLoaded=FALSE;
std::map<int, nppDocItPlugin*> pluginMap;

//
// The plugin data that Notepad++ needs
//
FuncItem funcItem[nbFunc];

//
// The data of Notepad++ that you can use in your plugin commands
//
NppData nppData;

HANDLE g_hMod;

//
// Initialize your plugin data here
// It will be called while plugin loading   
void pluginInit(HANDLE hModule)
{
	g_hMod=hModule;
}

void unloadDocitPlugins()
{
	for(std::map<int,nppDocItPlugin*>::const_iterator ci=pluginMap.begin();ci != pluginMap.end();ci++)
	{
		nppDocItPlugin* plugin=ci->second;
		FreeLibrary(plugin->hinstLib);
		delete plugin;
	}
	pluginMap.clear();
}

//
// Here you can do the clean up, save the parameters (if any) for the next session
//
void pluginCleanUp()
{
	unloadDocitPlugins();
}

//
// Initialization of your plugin commands
// You should fill your plugins commands here
void commandMenuInit()
{

	//--------------------------------------------//
	//-- STEP 3. CUSTOMIZE YOUR PLUGIN COMMANDS --//
	//--------------------------------------------//
	// with function :
	// setCommand(int index,                      // zero based number to indicate the order of command
	//            TCHAR *commandName,             // the command name that you want to see in plugin menu
	//            PFUNCPLUGINCMD functionPointer, // the symbol of function (function pointer) associated with this command. The body should be defined below. See Step 4.
	//            ShortcutKey *shortcut,          // optional. Define a shortcut to trigger this command
	//            bool check0nInit                // optional. Make this menu item be checked visually
	//            );
	ShortcutKey *sk=new ShortcutKey();
	sk->_isAlt=TRUE;
	sk->_isCtrl=TRUE;
	sk->_isShift=TRUE;
	sk->_key='D';
	setCommand(0, TEXT("Insert Doc String"), insert_doc_string, sk, false);
	setCommand(1, TEXT("About"), show_about_dlg, NULL, false);
}

//
// Here you can do the clean up (especially for the shortcut)
//
void commandMenuCleanUp()
{
	// Don't forget to deallocate your shortcut here
	delete funcItem[0]._pShKey;
}


//
// This function help you to initialize your plugin commands
//
bool setCommand(size_t index, TCHAR *cmdName, PFUNCPLUGINCMD pFunc, ShortcutKey *sk, bool check0nInit) 
{
	if (index >= nbFunc)
		return false;

	if (!pFunc)
		return false;

	lstrcpy(funcItem[index]._itemName, cmdName);
	funcItem[index]._pFunc = pFunc;
	funcItem[index]._init2Check = check0nInit;
	funcItem[index]._pShKey = sk;

	return true;
}


std::string get_spaces(int sp_count)
{
	std::string sp;
	for(int i=0;i<sp_count;i++)
	{
		sp.append(" ");
	}
	return sp;
}



void loadDocitPlugins()
{
	WIN32_FIND_DATA ffd;
	HANDLE hFind=INVALID_HANDLE_VALUE;
	TCHAR nppDir[MAX_PATH];
	TCHAR findQuery[MAX_PATH];
	TCHAR dllFilePath[MAX_PATH];
	HINSTANCE hinstLib; 

	::SendMessage(nppData._nppHandle,NPPM_GETNPPDIRECTORY,MAX_PATH,(LPARAM)nppDir);
	wcscpy(findQuery,nppDir);
	if(wcslen(nppDir)<MAX_PATH)
	{
		wcscat(findQuery,TEXT("\\plugins\\nppdocitplugins\\*.dll"));
		hFind=FindFirstFile(findQuery,&ffd);
		if(hFind!=INVALID_HANDLE_VALUE)
		{
			do
			{
				wcscpy(dllFilePath,nppDir);
				wcscat(dllFilePath,TEXT("\\plugins\\nppdocitplugins\\"));
				wcscat(dllFilePath,ffd.cFileName);

				hinstLib=LoadLibrary(dllFilePath);			
				if(hinstLib!=NULL)
				{
					nppDocItPlugin *plugin=new nppDocItPlugin;
					plugin->hinstLib=hinstLib;
					plugin->gen_doc_string=(GEN_DOC_STRING)GetProcAddress(hinstLib,"gen_doc_string");
					plugin->get_lang_type=(GET_LANG_TYPE)GetProcAddress(hinstLib,"get_language_type");
					plugin->get_terminating_character=(GET_TERMINATING_CHARACTER)GetProcAddress(hinstLib,"get_terminating_character");
					pluginMap[(plugin->get_lang_type)()]=plugin;
				}

			}while(FindNextFile(hFind,&ffd)!=0);

			FindClose(hFind);
		}
		docitPluginsLoaded=TRUE;	
	}
}

nppDocItPlugin* getCurrentPlugin()
{
	enum LangType lang_type;
	::SendMessage(nppData._nppHandle,NPPM_GETCURRENTLANGTYPE,0,(LPARAM)&lang_type);

	nppDocItPlugin *plugin=pluginMap[lang_type];
	return plugin;
}

//----------------------------------------------//
//-- STEP 4. DEFINE YOUR ASSOCIATED FUNCTIONS --//
//----------------------------------------------//
void insert_doc_string()
{
	//load when required
	if(docitPluginsLoaded==FALSE)
		loadDocitPlugins();

	
	nppDocItPlugin* plugin=getCurrentPlugin();
	if(plugin==NULL)
		return;

	// Get the current scintilla
	int which = -1;
	::SendMessage(nppData._nppHandle, NPPM_GETCURRENTSCINTILLA, 0, (LPARAM)&which);
	if (which == -1)
		return;
	HWND curScintilla = (which == 0)?nppData._scintillaMainHandle:nppData._scintillaSecondHandle;

	//get current position and identation at current line
	int curPos=::SendMessage(curScintilla,SCI_GETCURRENTPOS,0,0);
	int curLine=::SendMessage(curScintilla,SCI_LINEFROMPOSITION,curPos,0);
	int indentation=::SendMessage(curScintilla,SCI_GETLINEINDENTATION,curLine,0);


	//get the location till text is to be fetched
	//search for { or ;
	::SendMessage(curScintilla,SCI_SETTARGETSTART,curPos,0);
	::SendMessage(curScintilla,SCI_SETTARGETEND,curPos+200,0);
	::SendMessage(curScintilla,SCI_SETSEARCHFLAGS,SCFIND_REGEXP,0);
	int pos=::SendMessage(curScintilla,SCI_SEARCHINTARGET,4,(LPARAM)(plugin->get_terminating_character)());
	//This gives me the occurence of the terminating character, need to fetch the string up to 
	//this location
	Sci_TextRange tr;
	tr.chrg.cpMin=curPos;
	if(pos!=-1){
		tr.chrg.cpMax=pos;
		tr.lpstrText=new char[pos-curPos+1];

		int len=::SendMessage(curScintilla,SCI_GETTEXTRANGE,0,(LPARAM)&tr);
		if(len>0){
			//goto first line
			::SendMessage(curScintilla,SCI_HOME,0,0);
			
			//parse the string and if a valid function generate a doc string.
			char *doc_string=NULL;
			
			(plugin->gen_doc_string)(tr.lpstrText,indentation,&doc_string);
			::SendMessage(curScintilla,SCI_INSERTTEXT,-1,(LPARAM)doc_string);	
			
			delete tr.lpstrText;
			//delete doc_string;
		}
	}


	//TODO: think of a proper method to define termination condition for a function of each language
	//TODO: Reorganise the whole code

}



INT_PTR CALLBACK abtDlgProc(HWND hwndDlg,UINT uMsg,WPARAM wParam, LPARAM lParam)
{
	switch(uMsg)
	{
	case WM_INITDIALOG:
		ConvertStaticToHyperlink(hwndDlg,IDC_WEB);
		return TRUE;
	case WM_COMMAND:
		switch(LOWORD(wParam))
		{
		case IDOK:
			EndDialog(hwndDlg,wParam);
			return TRUE;
		case IDC_WEB:
			ShellExecute(hwndDlg, TEXT("open"),TEXT("http://nppdocit.sourceforge.net/"),NULL, NULL, SW_SHOWNORMAL);
			return TRUE;
		}
	}
	return FALSE;
}

void show_about_dlg()
{
	::CreateDialog((HINSTANCE)g_hMod,MAKEINTRESOURCE(IDD_ABOUTDLG),nppData._nppHandle,abtDlgProc);
}