Merge pull request #1 from iTrace-Dev/develop

Create first release of iTrace-NotepadPlusPlus

Author: Joshua2000B

.gitignore

@@ -0,0 +1,19 @@
+bin/
+bin64/
+arm64/
+vs.proj/Debug
+vs.proj/Release
+vs.proj/.vs
+vs.proj/iTrace-NPP
+vs.proj/x64
+vs.proj/ARM64
+vs.proj/iTrace-NPP.opensdf
+vs.proj/iTrace-NPP.sdf
+*.suo
+*.sln
+vs.proj/iTrace-NPP.exp
+vs.proj/iTrace-NPP.lib
+*.aps
+vs.proj/iTrace-NPP.vcxproj.user
+*.zip
+*.bak

LICENSE.md

@@ -1,2 +1,27 @@
 # iTrace-NotepadPlusPlus
-Notepad++ plugin to identify textual and interface elements based on iTrace Core gaze data 
+iTrace-NotepadPlusPlus (or iTrace-Notepad++) is a plugin for the Notepad++ Text Editor. The plugin will establish a connection to the [iTrace-Core](https://github.com/iTrace-Dev/iTrace-Core) desktop application. Once connected to the Core, the plugin will accept eye-tracking information from the Core and translate it to editor-specific data and output said data to an XML file.
+
+# Installation
+1. Download the latest version of the plugin. It will be a .dll file.
+2. Open Notepad++, and select Plugins->Open Plugins Folder...
+3. Create a folder for the plugin. The folder must be named the same as the .dll file. By default, the folder should be named `iTrace-NPP`.
+4. Drag and drop the .dll file in the folder.
+5. Restart Notepad++. The plugin should now be installed.
+
+# Usage
+To use iTrace-Notepad++, make sure you have iTrace-Core installed.
+1. Open any files you wish to view in Notepad++.
+2. Run iTrace-Core and set up the parameters of your tracking session.
+3. Select Plugins->iTrace-NPP->Connect to iTrace Core. Alternatively, press `Alt+I`.
+4. iTrace-Notepad++ should not be connected to iTrace-Core. A notification should appear in the bottom left notifying you of any errors in connecting.
+5. Once a tracking session is started, iTrace-Notepad++ will begin writing to a file in the location specified in iTrace-Core. When the tracking session is finished, two files will be present - one from iTrace-Notepad++ and the other from iTrace-Core.
+
+# How to Build From Source
+If you want to build the plugin from source, follow these steps:
+1. Download or clone the source code.
+2. Open `/vs.proj/iTrace-NPP.vcxproj` using Visual Studio 2022.
+3. The code should now be open in Visual Studio.
+4. To build the .dll file, select Build->Build Solution. The .dll will be created in `/vs.proj/x64/Debug/`.
+
+# Further Steps
+After gathering your data, you can use our other tools [iTrace-Toolkit](https://github.com/iTrace-Dev/iTrace-Toolkit) and [iTrace-Visualize](https://github.com/iTrace-Dev/iTrace-Visualize) to analyze and process the tracking sessions.

README.md

@@ -0,0 +1,74 @@
+// This file is part of Notepad++ project
+// Copyright (C)2022 Don HO <[email protected]>
+
+// 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 3 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, see <https://www.gnu.org/licenses/>.
+
+
+#pragma once
+
+#include <windows.h>
+
+// ATTENTION : It's a part of interface header, so don't include the others header here
+
+// styles for containers
+#define	CAPTION_TOP				TRUE
+#define	CAPTION_BOTTOM			FALSE
+
+//   defines for docking manager
+#define	CONT_LEFT		0
+#define	CONT_RIGHT		1
+#define	CONT_TOP		2
+#define	CONT_BOTTOM		3
+#define	DOCKCONT_MAX	4
+
+// mask params for plugins of internal dialogs
+#define DWS_ICONTAB			0x00000001			// Icon for tabs are available
+#define DWS_ICONBAR			0x00000002			// Icon for icon bar are available (currently not supported)
+#define DWS_ADDINFO			0x00000004			// Additional information are in use
+#define DWS_PARAMSALL		(DWS_ICONTAB|DWS_ICONBAR|DWS_ADDINFO)
+
+// default docking values for first call of plugin
+#define DWS_DF_CONT_LEFT	(CONT_LEFT	<< 28)	// default docking on left
+#define DWS_DF_CONT_RIGHT	(CONT_RIGHT	<< 28)	// default docking on right
+#define DWS_DF_CONT_TOP		(CONT_TOP	<< 28)	// default docking on top
+#define DWS_DF_CONT_BOTTOM	(CONT_BOTTOM << 28)	// default docking on bottom
+#define DWS_DF_FLOATING		0x80000000			// default state is floating
+
+
+typedef struct {
+	HWND		hClient;		// client Window Handle
+	const TCHAR	*pszName;		// name of plugin (shown in window)
+	int			dlgID;			// a funcItem provides the function pointer to start a dialog. Please parse here these ID
+
+	// user modifications
+	UINT		uMask;			// mask params: look to above defines
+	HICON		hIconTab;		// icon for tabs
+	const TCHAR *pszAddInfo;		// for plugin to display additional informations
+
+	// internal data, do not use !!!
+	RECT		rcFloat;		// floating position
+	int			iPrevCont;		// stores the privious container (toggling between float and dock)
+	const TCHAR*	pszModuleName;	// it's the plugin file name. It's used to identify the plugin
+} tTbData;
+
+
+typedef struct {
+	HWND		hWnd;							// the docking manager wnd
+	RECT		rcRegion[DOCKCONT_MAX];			// position of docked dialogs
+} tDockMgr;
+
+
+#define	HIT_TEST_THICKNESS		20
+#define SPLITTER_WIDTH			4
+

src/DockingFeature/Docking.h

@@ -0,0 +1,131 @@
+// This file is part of Notepad++ project
+// Copyright (C)2006 Jens Lorenz <[email protected]>
+
+// 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 3 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, see <https://www.gnu.org/licenses/>.
+
+
+#pragma once
+
+#include "dockingResource.h"
+#include "Docking.h"
+
+#include <assert.h>
+#include <shlwapi.h>
+#include <string>
+#include "StaticDialog.h"
+
+
+
+class DockingDlgInterface : public StaticDialog
+{
+public:
+	DockingDlgInterface() = default;
+	explicit DockingDlgInterface(int dlgID): _dlgID(dlgID) {}
+
+	virtual void init(HINSTANCE hInst, HWND parent) {
+		StaticDialog::init(hInst, parent);
+		TCHAR temp[MAX_PATH];
+		::GetModuleFileName(reinterpret_cast<HMODULE>(hInst), temp, MAX_PATH);
+		_moduleName = ::PathFindFileName(temp);
+	}
+
+    void create(tTbData* data, bool isRTL = false) {
+		assert(data != nullptr);
+		StaticDialog::create(_dlgID, isRTL);
+		TCHAR temp[MAX_PATH];
+		::GetWindowText(_hSelf, temp, MAX_PATH);
+		_pluginName = temp;
+
+        // user information
+		data->hClient = _hSelf;
+		data->pszName = _pluginName.c_str();
+
+		// supported features by plugin
+		data->uMask = 0;
+
+		// additional info
+		data->pszAddInfo = NULL;
+	}
+
+	virtual void updateDockingDlg() {
+		::SendMessage(_hParent, NPPM_DMMUPDATEDISPINFO, 0, reinterpret_cast<LPARAM>(_hSelf));
+	}
+
+    virtual void destroy() {}
+
+	virtual void setBackgroundColor(COLORREF) {}
+	virtual void setForegroundColor(COLORREF) {}
+
+	virtual void display(bool toShow = true) const {
+		::SendMessage(_hParent, toShow ? NPPM_DMMSHOW : NPPM_DMMHIDE, 0, reinterpret_cast<LPARAM>(_hSelf));
+	}
+
+	bool isClosed() const {
+		return _isClosed;
+	}
+
+	void setClosed(bool toClose) {
+		_isClosed = toClose;
+	}
+
+	const TCHAR * getPluginFileName() const {
+		return _moduleName.c_str();
+	}
+
+protected :
+	int	_dlgID = -1;
+	bool _isFloating = true;
+	int _iDockedPos = 0;
+	std::wstring _moduleName;
+	std::wstring _pluginName;
+	bool _isClosed = false;
+
+	virtual INT_PTR CALLBACK run_dlgProc(UINT message, WPARAM, LPARAM lParam) {
+		switch (message)
+		{
+			case WM_NOTIFY: 
+			{
+				LPNMHDR	pnmh = reinterpret_cast<LPNMHDR>(lParam);
+
+				if (pnmh->hwndFrom == _hParent)
+				{
+					switch (LOWORD(pnmh->code))
+					{
+						case DMN_CLOSE:
+						{
+							break;
+						}
+						case DMN_FLOAT:
+						{
+							_isFloating = true;
+							break;
+						}
+						case DMN_DOCK:
+						{
+							_iDockedPos = HIWORD(pnmh->code);
+							_isFloating = false;
+							break;
+						}
+						default:
+							break;
+					}
+				}
+				break;
+			}
+			default:
+				break;
+		}
+		return FALSE;
+	};
+};

src/DockingFeature/DockingDlgInterface.h

@@ -0,0 +1,56 @@
+//this file is part of notepad++
+//Copyright (C)2022 Don HO <[email protected]>
+//
+//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 "GoToLineDlg.h"
+#include "../PluginDefinition.h"
+
+extern NppData nppData;
+
+INT_PTR CALLBACK DemoDlg::run_dlgProc(UINT message, WPARAM wParam, LPARAM lParam)
+{
+	switch (message) 
+	{
+		case WM_COMMAND : 
+		{
+			switch (wParam)
+			{
+				case IDOK :
+				{
+					int line = getLine();
+					if (line != -1)
+					{
+						// Get the current scintilla
+						int which = -1;
+						::SendMessage(nppData._nppHandle, NPPM_GETCURRENTSCINTILLA, 0, (LPARAM)&which);
+						if (which == -1)
+							return FALSE;
+						HWND curScintilla = (which == 0)?nppData._scintillaMainHandle:nppData._scintillaSecondHandle;
+
+						::SendMessage(curScintilla, SCI_ENSUREVISIBLE, line-1, 0);
+						::SendMessage(curScintilla, SCI_GOTOLINE, line-1, 0);
+					}
+					return TRUE;
+				}
+			}
+				return FALSE;
+		}
+
+		default :
+			return DockingDlgInterface::run_dlgProc(message, wParam, lParam);
+	}
+}
+

src/DockingFeature/GoToLineDlg.cpp

@@ -0,0 +1,52 @@
+//this file is part of notepad++
+//Copyright (C)2022 Don HO <[email protected]>
+//
+//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.
+
+#ifndef GOTILINE_DLG_H
+#define GOTILINE_DLG_H
+
+#include "DockingDlgInterface.h"
+#include "resource.h"
+
+class DemoDlg : public DockingDlgInterface
+{
+public :
+	DemoDlg() : DockingDlgInterface(IDD_PLUGINGOLINE_DEMO){};
+
+    virtual void display(bool toShow = true) const {
+        DockingDlgInterface::display(toShow);
+        if (toShow)
+            ::SetFocus(::GetDlgItem(_hSelf, ID_GOLINE_EDIT));
+    };
+
+	void setParent(HWND parent2set){
+		_hParent = parent2set;
+	};
+
+protected :
+	virtual INT_PTR CALLBACK run_dlgProc(UINT message, WPARAM wParam, LPARAM lParam);
+
+private :
+
+    int getLine() const {
+        BOOL isSuccessful;
+        int line = ::GetDlgItemInt(_hSelf, ID_GOLINE_EDIT, &isSuccessful, FALSE);
+        return (isSuccessful?line:-1);
+    };
+
+};
+
+#endif //GOTILINE_DLG_H