Skip to content

Bring the NppMetaClass & pcjHelper from CU to CI #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pryrt merged 5 commits into from
Sep 6, 2025
Merged

Bring the NppMetaClass & pcjHelper from CU to CI #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4e608d2
Bring over the Meta and Helper from CU to CI
pryrt Sep 4, 2025
c32caa1
Switch to the NppMetaClass for version checks
pryrt Sep 4, 2025
4f8a80c
Switch to the NppMetaClass for all the directories
pryrt Sep 4, 2025
91e342b
add official TODO comment: still need to check for NULLs, writable di…
pryrt Sep 4, 2025
730aafc
change delNull, is_dir_writable, and RecursiveCreateDirectory over to…
pryrt Sep 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
208 changes: 25 additions & 183 deletions src/Classes/CollectionInterfaceClass.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,127 +12,24 @@ void delNull(std::wstring& str)
}
}

CollectionInterface::CollectionInterface(HWND hwndNpp) {
_hwndNPP = hwndNpp;
_populateNppDirs();
CollectionInterface::CollectionInterface(HWND /*hwndNpp*/) {
gNppMetaInfo.populate();
_areListsPopulated = getListsFromJson();
};

void CollectionInterface::_populateNppDirs(void) {
// Start by grabbing the directory where notepad++.exe resides
std::wstring exeDir(MAX_PATH, '\0');
::SendMessage(_hwndNPP, NPPM_GETNPPDIRECTORY, MAX_PATH, reinterpret_cast<LPARAM>(exeDir.data()));
delNull(exeDir);

// %AppData%\Notepad++\Plugins\Config or equiv
LRESULT sz = 1 + ::SendMessage(_hwndNPP, NPPM_GETPLUGINSCONFIGDIR, 0, NULL);
std::wstring pluginCfgDir(sz, '\0');
::SendMessage(_hwndNPP, NPPM_GETPLUGINSCONFIGDIR, sz, reinterpret_cast<LPARAM>(pluginCfgDir.data()));
delNull(pluginCfgDir);

// %AppData%\Notepad++\Plugins or equiv
// since it's removing the tail, it will never be longer than pluginCfgDir; since it's in-place, initialize with the first
std::wstring pluginDir = pluginCfgDir;
PathCchRemoveFileSpec(const_cast<PWSTR>(pluginDir.data()), pluginCfgDir.size());
delNull(pluginDir);

// %AppData%\Notepad++ or equiv is what I'm really looking for
// _nppCfgDir #py# _nppConfigDirectory = os.path.dirname(os.path.dirname(notepad.getPluginConfigDir()))
_nppCfgDir = pluginDir;
PathCchRemoveFileSpec(const_cast<PWSTR>(_nppCfgDir.data()), pluginDir.size());
delNull(_nppCfgDir);

std::wstring appDataOrPortableDir = _nppCfgDir;

// %AppData%\FunctionList: FunctionList folder DOES NOT work in Cloud or SettingsDir, so set to the AppData|Portable
// _nppCfgFunctionListDir #py# _nppCfgFunctionListDirectory = os.path.join(_nppConfigDirectory, 'functionList')
_nppCfgFunctionListDir = appDataOrPortableDir + L"\\functionList";

// CloudDirectory: if Notepad++ has cloud enabled, need to use that for some config files
bool usesCloud = false;
sz = ::SendMessage(_hwndNPP, NPPM_GETSETTINGSONCLOUDPATH, 0, 0); // get number of wchars in settings-on-cloud path (0 means settings-on-cloud is disabled)
if (sz) {
usesCloud = true;
std::wstring wsCloudDir(sz + 1, '\0');
LRESULT szGot = ::SendMessage(_hwndNPP, NPPM_GETSETTINGSONCLOUDPATH, sz + 1, reinterpret_cast<LPARAM>(wsCloudDir.data()));
if (szGot == sz) {
delNull(wsCloudDir);
_nppCfgDir = wsCloudDir;
}
}

// -settingsDir: if command-line option is enabled, use that directory for some config files
bool usesSettingsDir = false;
std::wstring wsSettingsDir = _askSettingsDir();
if (wsSettingsDir.length() > 0)
{
usesSettingsDir = true;
_nppCfgDir = wsSettingsDir;
}

// UDL and Themes are both relative to AppData _or_ Cloud _or_ SettingsDir, so they should be set _after_ updating _nppCfgDir.

// _nppCfgUdlDir #py# _nppCfgUdlDirectory = os.path.join(_nppConfigDirectory, 'userDefineLangs')
_nppCfgUdlDir = _nppCfgDir + L"\\userDefineLangs";

// _nppCfgThemesDir #py# _nppCfgThemesDirectory = os.path.join(_nppConfigDirectory, 'themes')
_nppCfgThemesDir = (usesSettingsDir ? appDataOrPortableDir : _nppCfgDir) + L"\\themes";

// AutoCompletion is _always_ relative to notepad++.exe, never in AppData or CloudConfig or SettingsDir
// _nppCfgAutoCompletionDir #py# _nppAppAutoCompletionDirectory = os.path.join(notepad.getNppDir(), 'autoCompletion')
_nppCfgAutoCompletionDir = exeDir + L"\\autoCompletion";

return;
}

// Parse the -settingsDir out of the current command line
// FUTURE: if a future version of N++ includes PR#16946, then do an "if version>vmin, use new message" section in the code
std::wstring CollectionInterface::_askSettingsDir(void)
{
LRESULT sz = ::SendMessage(_hwndNPP, NPPM_GETCURRENTCMDLINE, 0, 0);
if (!sz) return L"";
std::wstring strCmdLine(sz + 1, L'\0');
LRESULT got = ::SendMessage(_hwndNPP, NPPM_GETCURRENTCMDLINE, sz + 1, reinterpret_cast<LPARAM>(strCmdLine.data()));
if (got != sz) return L"";
delNull(strCmdLine);

std::wstring wsSettingsDir = L"";
size_t p = 0;
if ((p=strCmdLine.find(L"-settingsDir=")) != std::wstring::npos) {
std::wstring wsEnd = L" " ;
// start by grabbing from after the = to the end of the string
wsSettingsDir = strCmdLine.substr(p+13, strCmdLine.length() - p - 13);
if (wsSettingsDir[0] == L'"') {
wsSettingsDir = wsSettingsDir.substr(1, wsSettingsDir.length() - 1);
wsEnd = L"\"";
}
p = wsSettingsDir.find(wsEnd);
if (p != std::wstring::npos) {
// found the ending space or quote, so do everything _before_ that (need last position=p-1, which means a count of p)
wsSettingsDir = wsSettingsDir.substr(0, p);
}
else if (wsEnd == L"\"") {
// could not find end quote; should probably throw an error or something, but for now, just pretend I found nothing...
return L"";
} // none found and looking for space means it found end-of-string, which is fine with the space separator
}

return wsSettingsDir;
}

std::vector<char> CollectionInterface::downloadFileInMemory(const std::wstring& url)
{
HINTERNET hInternet = InternetOpen(L"CollectionInterfacePluginForN++", INTERNET_OPEN_TYPE_PRECONFIG, NULL, NULL, 0);
if (hInternet == NULL) {
std::wstring errmsg = L"Could not connect to internet when trying to download\r\n" + url;
::MessageBox(_hwndNPP, errmsg.c_str(), L"Download Error", MB_ICONERROR);
::MessageBox(gNppMetaInfo.hwnd._nppHandle, errmsg.c_str(), L"Download Error", MB_ICONERROR);
return std::vector<char>();
}

HINTERNET hConnect = InternetOpenUrl(hInternet, url.c_str(), NULL, 0, INTERNET_FLAG_RELOAD, 0);
if (hConnect == NULL) {
std::wstring errmsg = L"Could not connect to internet when trying to download\r\n" + url;
::MessageBox(_hwndNPP, errmsg.c_str(), L"Download Error", MB_ICONERROR);
::MessageBox(gNppMetaInfo.hwnd._nppHandle, errmsg.c_str(), L"Download Error", MB_ICONERROR);
return std::vector<char>();
}

Expand All @@ -157,10 +54,10 @@ bool CollectionInterface::downloadFileToDisk(const std::wstring& url, const std:
std::wstring expandedPath(dwExSize, L'\0');
if (!ExpandEnvironmentStrings(path.c_str(), const_cast<LPWSTR>(expandedPath.data()), dwExSize)) {
std::wstring errmsg = L"Could not understand the path \"" + path + L"\": " + std::to_wstring(GetLastError()) + L"\n";
::MessageBox(_hwndNPP, errmsg.c_str(), L"Download Error", MB_ICONERROR);
::MessageBox(gNppMetaInfo.hwnd._nppHandle, errmsg.c_str(), L"Download Error", MB_ICONERROR);
return false;
}
_wsDeleteTrailingNulls(expandedPath);
pcjHelper::delNull(expandedPath);

// don't download and overwrite the file if it already exists
if (!ask_overwrite_if_exists(expandedPath)) {
Expand All @@ -171,14 +68,14 @@ bool CollectionInterface::downloadFileToDisk(const std::wstring& url, const std:
HINTERNET hInternet = InternetOpen(L"CollectionInterfacePluginForN++", INTERNET_OPEN_TYPE_PRECONFIG, NULL, NULL, 0);
if (hInternet == NULL) {
std::wstring errmsg = L"Could not connect to internet when trying to download\r\n" + url;
::MessageBox(_hwndNPP, errmsg.c_str(), L"Download Error", MB_ICONERROR);
::MessageBox(gNppMetaInfo.hwnd._nppHandle, errmsg.c_str(), L"Download Error", MB_ICONERROR);
return false;
}

HINTERNET hConnect = InternetOpenUrl(hInternet, url.c_str(), NULL, 0, INTERNET_FLAG_RELOAD, 0);
if (hConnect == NULL) {
std::wstring errmsg = L"Could not connect to internet when trying to download\r\n" + url;
::MessageBox(_hwndNPP, errmsg.c_str(), L"Download Error", MB_ICONERROR);
::MessageBox(gNppMetaInfo.hwnd._nppHandle, errmsg.c_str(), L"Download Error", MB_ICONERROR);
if (hInternet) InternetCloseHandle(hInternet); // need to free hInternet if hConnect failed
return false;
}
Expand Down Expand Up @@ -323,7 +220,7 @@ bool CollectionInterface::getListsFromJson(void)
msg.resize(100);
msg += "\n...";
}
::MessageBoxA(_hwndNPP, msg.c_str(), "CollectionInterface: Download Problems", MB_ICONWARNING);
::MessageBoxA(gNppMetaInfo.hwnd._nppHandle, msg.c_str(), "CollectionInterface: Download Problems", MB_ICONWARNING);
didThemeFail = true;
}
else {
Expand All @@ -338,12 +235,12 @@ bool CollectionInterface::getListsFromJson(void)
}
catch (nlohmann::json::exception& e) {
std::string msg = std::string("JSON Error in Theme data: ") + e.what();
::MessageBoxA(_hwndNPP, msg.c_str(), "CollectionInterface: JSON Error", MB_ICONERROR);
::MessageBoxA(gNppMetaInfo.hwnd._nppHandle, msg.c_str(), "CollectionInterface: JSON Error", MB_ICONERROR);
didThemeFail = true;
}
catch (std::exception& e) {
std::string msg = std::string("Unrecognized Error in Theme data: ") + e.what();
::MessageBoxA(_hwndNPP, msg.c_str(), "CollectionInterface: Unrecognized Error", MB_ICONERROR);
::MessageBoxA(gNppMetaInfo.hwnd._nppHandle, msg.c_str(), "CollectionInterface: Unrecognized Error", MB_ICONERROR);
didThemeFail = true;
}
}
Expand All @@ -366,7 +263,7 @@ bool CollectionInterface::getListsFromJson(void)
msg += "\n...";
}
if (!didThemeFail)
::MessageBoxA(_hwndNPP, msg.c_str(), "CollectionInterface: Download Problems", MB_ICONWARNING);
::MessageBoxA(gNppMetaInfo.hwnd._nppHandle, msg.c_str(), "CollectionInterface: Download Problems", MB_ICONWARNING);
return false; // without UDL info, it's not worth displaying the Download Dialog
}
else {
Expand Down Expand Up @@ -460,12 +357,12 @@ bool CollectionInterface::getListsFromJson(void)
}
catch (nlohmann::json::exception& e) {
std::string msg = std::string("JSON Error in UDL data: ") + e.what();
::MessageBoxA(_hwndNPP, msg.c_str(), "CollectionInterface: JSON Error", MB_ICONERROR);
::MessageBoxA(gNppMetaInfo.hwnd._nppHandle, msg.c_str(), "CollectionInterface: JSON Error", MB_ICONERROR);
return false; // without UDL info, it's not worth displaying the Download Dialog
}
catch (std::exception& e) {
std::string msg = std::string("Unrecognized Error in UDL data: ") + e.what();
::MessageBoxA(_hwndNPP, msg.c_str(), "CollectionInterface: Unrecognized Error", MB_ICONERROR);
::MessageBoxA(gNppMetaInfo.hwnd._nppHandle, msg.c_str(), "CollectionInterface: Unrecognized Error", MB_ICONERROR);
return false; // without UDL info, it's not worth displaying the Download Dialog
}
}
Expand All @@ -474,98 +371,43 @@ bool CollectionInterface::getListsFromJson(void)
return true;
}

std::wstring& CollectionInterface::_wsDeleteTrailingNulls(std::wstring& str)
{
str.resize(lstrlen(str.c_str()));
return str;
}

BOOL CollectionInterface::_RecursiveCreateDirectory(std::wstring wsPath)
{
std::wstring wsParent = wsPath;
PathRemoveFileSpec(const_cast<LPWSTR>(wsParent.data()));
if (!PathFileExists(wsParent.c_str())) {
BOOL stat = _RecursiveCreateDirectory(wsParent);
if (!stat) return stat;
}
return CreateDirectory(wsPath.c_str(), NULL);
}


bool CollectionInterface::_is_dir_writable(const std::wstring& path)
{
// first grab the directory and make sure it exists
std::wstring cleanFilePath = path;
_wsDeleteTrailingNulls(cleanFilePath);

if (!PathFileExists(cleanFilePath.c_str())) {
BOOL stat = _RecursiveCreateDirectory(cleanFilePath);
if (!stat) {
DWORD errNum = GetLastError();
if (errNum != ERROR_ACCESS_DENIED) {
std::wstring errmsg = L"Could not find or create directory for \"" + path + L"\": " + std::to_wstring(GetLastError()) + L"\n";
::MessageBox(NULL, errmsg.c_str(), L"Directory error", MB_ICONERROR);
}
return false;
}
}

// then create the tempfile name, and see if it is writable
std::wstring tmpFileName = cleanFilePath + L"\\~$TMPFILE.PRYRT";

HANDLE hFile = CreateFile(tmpFileName.c_str(), GENERIC_WRITE, 0, NULL, CREATE_ALWAYS, FILE_ATTRIBUTE_NORMAL, NULL);
if (hFile == INVALID_HANDLE_VALUE) {
DWORD errNum = GetLastError();
if (errNum != ERROR_ACCESS_DENIED) {
std::wstring errmsg = L"Error when testing if \"" + path + L"\" is writeable: " + std::to_wstring(GetLastError()) + L"\n";
::MessageBox(NULL, errmsg.c_str(), L"Directory error", MB_ICONERROR);
}
return false;
}

// cleanup
CloseHandle(hFile);
DeleteFile(tmpFileName.c_str());
return true;
}

std::wstring CollectionInterface::getWritableTempDir(void)
{
// first try the system TEMP
std::wstring tempDir(MAX_PATH + 1, L'\0');
GetTempPath(MAX_PATH + 1, const_cast<LPWSTR>(tempDir.data()));
_wsDeleteTrailingNulls(tempDir);
pcjHelper::delNull(tempDir);

// if that fails, try c:\tmp or c:\temp
if (!_is_dir_writable(tempDir)) {
if (!pcjHelper::is_dir_writable(tempDir)) {
tempDir = L"c:\\temp";
_wsDeleteTrailingNulls(tempDir);
pcjHelper::delNull(tempDir);
}
if (!_is_dir_writable(tempDir)) {
if (!pcjHelper::is_dir_writable(tempDir)) {
tempDir = L"c:\\tmp";
_wsDeleteTrailingNulls(tempDir);
pcjHelper::delNull(tempDir);
}

// if that fails, try the %USERPROFILE%
if (!_is_dir_writable(tempDir)) {
if (!pcjHelper::is_dir_writable(tempDir)) {
tempDir.resize(MAX_PATH + 1);
if (!ExpandEnvironmentStrings(L"%USERPROFILE%", const_cast<LPWSTR>(tempDir.data()), MAX_PATH + 1)) {
std::wstring errmsg = L"getWritableTempDir::ExpandEnvirontmentStrings(%USERPROFILE%) failed: " + std::to_wstring(GetLastError()) + L"\n";
::MessageBox(NULL, errmsg.c_str(), L"Directory Error", MB_ICONERROR);
return L"";
}
_wsDeleteTrailingNulls(tempDir);
pcjHelper::delNull(tempDir);
}

// last try: current directory
if (!_is_dir_writable(tempDir)) {
if (!pcjHelper::is_dir_writable(tempDir)) {
tempDir.resize(MAX_PATH + 1);
GetCurrentDirectory(MAX_PATH + 1, const_cast<LPWSTR>(tempDir.data()));
_wsDeleteTrailingNulls(tempDir);
pcjHelper::delNull(tempDir);
}

// if that fails, no other ideas
if (!_is_dir_writable(tempDir)) {
if (!pcjHelper::is_dir_writable(tempDir)) {
std::wstring errmsg = L"getWritableTempDir() cannot find any writable directory; please make sure %TEMP% is defined and writable\n";
::MessageBox(NULL, errmsg.c_str(), L"Directory Error", MB_ICONERROR);
return L"";
Expand All @@ -577,6 +419,6 @@ bool CollectionInterface::ask_overwrite_if_exists(const std::wstring& path)
{
if (!PathFileExists(path.c_str())) return true; // if file doesn't exist, it's okay to "overwrite" nothing ;-)
std::wstring msg = L"The path\r\n" + path + L"\r\nalready exists. Should I overwrite it?";
int ans = ::MessageBox(_hwndNPP, msg.c_str(), L"Overwrite File?", MB_YESNO);
int ans = ::MessageBox(gNppMetaInfo.hwnd._nppHandle, msg.c_str(), L"Overwrite File?", MB_YESNO);
return ans == IDYES;
}
36 changes: 5 additions & 31 deletions src/Classes/CollectionInterfaceClass.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
#include <wininet.h>
#include <pathcch.h>
#include "PluginDefinition.h"

#include "NppMetaClass.h"

class CollectionInterface {
public:
Expand All @@ -26,26 +26,15 @@ class CollectionInterface {
std::vector<std::wstring> vThemeFiles;

// Methods
//std::vector<char> downloadFileInMemory(const std::string& url);
std::vector<char> downloadFileInMemory(const std::wstring& url);
//bool downloadFileToDisk(const std::string& url, const std::string& path);
//bool downloadFileToDisk(const std::wstring& url, const std::string& path);
//bool downloadFileToDisk(const std::string& url, const std::wstring& path);
bool downloadFileToDisk(const std::wstring& url, const std::wstring& path);
bool getListsFromJson(void);

// getter methods
std::wstring nppCfgDir(void) { return _nppCfgDir; };
std::wstring nppCfgUdlDir(void) { return _nppCfgUdlDir; };
std::wstring nppCfgFunctionListDir(void) { return _nppCfgFunctionListDir; };
std::wstring nppCfgAutoCompletionDir(void) { return _nppCfgAutoCompletionDir; };
std::wstring nppCfgThemesDir(void) { return _nppCfgThemesDir; };

// status methods
bool isUdlDirWritable(void) { return _is_dir_writable(_nppCfgUdlDir); };
bool isFunctionListDirWritable(void) { return _is_dir_writable(_nppCfgFunctionListDir); };
bool isAutoCompletionDirWritable(void) { return _is_dir_writable(_nppCfgAutoCompletionDir); };
bool isThemesDirWritable(void) { return _is_dir_writable(_nppCfgThemesDir); };
bool isUdlDirWritable(void) { return pcjHelper::is_dir_writable(gNppMetaInfo.dir.cfgUdl); };
bool isFunctionListDirWritable(void) { return pcjHelper::is_dir_writable(gNppMetaInfo.dir.cfgFunctionList); };
bool isAutoCompletionDirWritable(void) { return pcjHelper::is_dir_writable(gNppMetaInfo.dir.cfgAutoCompletion); };
bool isThemesDirWritable(void) { return pcjHelper::is_dir_writable(gNppMetaInfo.dir.cfgThemes); };
bool areListsPopulated(void) { return _areListsPopulated; };

// if the chosen directory isn't writable, need to be able to use a directory that _is_ writable
Expand All @@ -57,20 +46,5 @@ class CollectionInterface {

private:
std::string _xml_unentity(const std::string& text);
std::wstring& _wsDeleteTrailingNulls(std::wstring& text);
bool _is_dir_writable(const std::wstring& path);
BOOL _RecursiveCreateDirectory(std::wstring wsPath);
std::wstring _askSettingsDir(void);

// Npp Metadata
void _populateNppDirs(void);
std::wstring
_nppCfgDir,
_nppCfgUdlDir,
_nppCfgFunctionListDir,
_nppCfgAutoCompletionDir,
_nppCfgThemesDir;

HWND _hwndNPP;
bool _areListsPopulated;
};
Loading
Loading