Skip to content

Commit bacd765

Browse files
committed
Definition updates using notepad_hfiles_synchronizer
1 parent 07139c5 commit bacd765

File tree

3 files changed

+137
-66
lines changed

3 files changed

+137
-66
lines changed

Visual Studio Project Template C#/PluginInfrastructure/Msgs_h.cs

+56-43
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,11 @@ public enum NppMsg : uint
191191
NPPM_GETENABLETHEMETEXTUREFUNC = Constants.NPPMSG + 45,
192192

193193
/// <summary>
194-
///void NPPM_GETPLUGINSCONFIGDIR(int strLen, TCHAR *str)
194+
///INT NPPM_GETPLUGINSCONFIGDIR(int strLen, TCHAR *str)
195+
/// Get user's plugin config directory path. It's useful if plugins want to save/load parameters for the current user
196+
/// Returns the number of TCHAR copied/to copy.
197+
/// Users should call it with "str" be NULL to get the required number of TCHAR (not including the terminating nul character),
198+
/// allocate "str" buffer with the return value + 1, then call it again to get the path.
195199
/// </summary>
196200
NPPM_GETPLUGINSCONFIGDIR = Constants.NPPMSG + 46,
197201

@@ -239,7 +243,7 @@ public enum NppMsg : uint
239243
NPPM_ISTABBARHIDDEN = Constants.NPPMSG + 52,
240244

241245
/// <summary>
242-
/// INT NPPM_GETPOSFROMBUFFERID(INT bufferID, INT priorityView)
246+
/// INT NPPM_GETPOSFROMBUFFERID(UINT_PTR bufferID, INT priorityView)
243247
/// Return VIEW|INDEX from a buffer ID. -1 if the bufferID non existing
244248
/// if priorityView set to SUB_VIEW, then SUB_VIEW will be search firstly
245249
///
@@ -251,11 +255,11 @@ public enum NppMsg : uint
251255
NPPM_GETPOSFROMBUFFERID = Constants.NPPMSG + 57,
252256

253257
/// <summary>
254-
/// INT NPPM_GETFULLPATHFROMBUFFERID(INT bufferID, TCHAR *fullFilePath)
258+
/// INT NPPM_GETFULLPATHFROMBUFFERID(UINT_PTR bufferID, TCHAR *fullFilePath)
255259
/// Get full path file name from a bufferID.
256260
/// Return -1 if the bufferID non existing, otherwise the number of TCHAR copied/to copy
257261
/// User should call it with fullFilePath be NULL to get the number of TCHAR (not including the nul character),
258-
/// allocate fullFilePath with the return values + 1, then call it again to get full path file name
262+
/// allocate fullFilePath with the return values + 1, then call it again to get full path file name
259263
/// </summary>
260264
NPPM_GETFULLPATHFROMBUFFERID = Constants.NPPMSG + 58,
261265

@@ -274,23 +278,23 @@ public enum NppMsg : uint
274278
NPPM_GETCURRENTBUFFERID = Constants.NPPMSG + 60,
275279

276280
/// <summary>
277-
/// VOID NPPM_RELOADBUFFERID(0, 0)
281+
/// VOID NPPM_RELOADBUFFERID(UINT_PTR bufferID, BOOL alert)
278282
/// Reloads Buffer
279283
/// wParam: Buffer to reload
280284
/// lParam: 0 if no alert, else alert
281285
/// </summary>
282286
NPPM_RELOADBUFFERID = Constants.NPPMSG + 61,
283287

284288
/// <summary>
285-
/// INT NPPM_GETBUFFERLANGTYPE(INT bufferID, 0)
289+
/// INT NPPM_GETBUFFERLANGTYPE(UINT_PTR bufferID, 0)
286290
/// wParam: BufferID to get LangType from
287291
/// lParam: 0
288292
/// Returns as int, see LangType. -1 on error
289293
/// </summary>
290294
NPPM_GETBUFFERLANGTYPE = Constants.NPPMSG + 64,
291295

292296
/// <summary>
293-
/// BOOL NPPM_SETBUFFERLANGTYPE(INT bufferID, INT langType)
297+
/// BOOL NPPM_SETBUFFERLANGTYPE(UINT_PTR bufferID, INT langType)
294298
/// wParam: BufferID to set LangType of
295299
/// lParam: LangType
296300
/// Returns TRUE on success, FALSE otherwise
@@ -300,15 +304,15 @@ public enum NppMsg : uint
300304
NPPM_SETBUFFERLANGTYPE = Constants.NPPMSG + 65,
301305

302306
/// <summary>
303-
/// INT NPPM_GETBUFFERENCODING(INT bufferID, 0)
307+
/// INT NPPM_GETBUFFERENCODING(UINT_PTR bufferID, 0)
304308
/// wParam: BufferID to get encoding from
305309
/// lParam: 0
306310
/// returns as int, see UniMode. -1 on error
307311
/// </summary>
308312
NPPM_GETBUFFERENCODING = Constants.NPPMSG + 66,
309313

310314
/// <summary>
311-
/// BOOL NPPM_SETBUFFERENCODING(INT bufferID, INT encoding)
315+
/// BOOL NPPM_SETBUFFERENCODING(UINT_PTR bufferID, INT encoding)
312316
/// wParam: BufferID to set encoding of
313317
/// lParam: encoding
314318
/// Returns TRUE on success, FALSE otherwise
@@ -318,40 +322,22 @@ public enum NppMsg : uint
318322
NPPM_SETBUFFERENCODING = Constants.NPPMSG + 67,
319323

320324
/// <summary>
321-
/// INT NPPM_GETBUFFERFORMAT(INT bufferID, 0)
322-
/// wParam: BufferID to get format from
325+
/// INT NPPM_GETBUFFERFORMAT(UINT_PTR bufferID, 0)
326+
/// wParam: BufferID to get EolType format from
323327
/// lParam: 0
324-
/// returns as int, see formatType. -1 on error
328+
/// returns as int, see EolType format. -1 on error
325329
/// </summary>
326330
NPPM_GETBUFFERFORMAT = Constants.NPPMSG + 68,
327331

328332
/// <summary>
329-
/// BOOL NPPM_SETBUFFERFORMAT(INT bufferID, INT format)
330-
/// wParam: BufferID to set format of
333+
/// BOOL NPPM_SETBUFFERFORMAT(UINT_PTR bufferID, INT format)
334+
/// wParam: BufferID to set EolType format of
331335
/// lParam: format
332336
/// Returns TRUE on success, FALSE otherwise
333-
/// use int, see formatType
337+
/// use int, see EolType format
334338
/// </summary>
335339
NPPM_SETBUFFERFORMAT = Constants.NPPMSG + 69,
336340

337-
/// <summary>
338-
/// BOOL NPPM_ADDREBAR(0, REBARBANDINFO *)
339-
/// Returns assigned ID in wID value of struct pointer
340-
/// </summary>
341-
NPPM_ADDREBAR = Constants.NPPMSG + 57,
342-
343-
/// <summary>
344-
/// BOOL NPPM_ADDREBAR(INT ID, REBARBANDINFO *)
345-
///Use ID assigned with NPPM_ADDREBAR
346-
/// </summary>
347-
NPPM_UPDATEREBAR = Constants.NPPMSG + 58,
348-
349-
/// <summary>
350-
/// BOOL NPPM_ADDREBAR(INT ID, 0)
351-
///Use ID assigned with NPPM_ADDREBAR
352-
/// </summary>
353-
NPPM_REMOVEREBAR = Constants.NPPMSG + 59,
354-
355341
/// <summary>
356342
/// BOOL NPPM_HIDETOOLBAR(0, BOOL hideOrNot)
357343
/// if hideOrNot is set as TRUE then tool bar will be hidden
@@ -398,7 +384,7 @@ public enum NppMsg : uint
398384
/// BOOL NPPM_GETSHORTCUTBYCMDID(int cmdID, ShortcutKey *sk)
399385
/// get your plugin command current mapped shortcut into sk via cmdID
400386
/// You may need it after getting NPPN_READY notification
401-
/// returned value : TRUE if this function call is successful and shorcut is enable, otherwise FALSE
387+
/// returned value : TRUE if this function call is successful and shortcut is enable, otherwise FALSE
402388
/// </summary>
403389
NPPM_GETSHORTCUTBYCMDID = Constants.NPPMSG + 76,
404390

@@ -416,7 +402,7 @@ public enum NppMsg : uint
416402

417403
/// <summary>
418404
/// INT NPPM_GETCURRENTNATIVELANGENCODING(0, 0)
419-
/// returned value : the current native language enconding
405+
/// returned value : the current native language encoding
420406
/// </summary>
421407
NPPM_GETCURRENTNATIVELANGENCODING = Constants.NPPMSG + 79,
422408

@@ -443,7 +429,7 @@ public enum NppMsg : uint
443429

444430
/// <summary>
445431
/// INT NPPM_GETLANGUAGENAME(int langType, TCHAR *langName)
446-
/// Get programing language name from the given language type (LangType)
432+
/// Get programming language name from the given language type (LangType)
447433
/// Return value is the number of copied character / number of character to copy (\0 is not included)
448434
/// You should call this function 2 times - the first time you pass langName as NULL to get the number of characters to copy.
449435
/// You allocate a buffer of the length of (the number of characters + 1) then call NPPM_GETLANGUAGENAME function the 2nd time
@@ -453,7 +439,7 @@ public enum NppMsg : uint
453439

454440
/// <summary>
455441
/// INT NPPM_GETLANGUAGEDESC(int langType, TCHAR *langDesc)
456-
/// Get programing language short description from the given language type (LangType)
442+
/// Get programming language short description from the given language type (LangType)
457443
/// Return value is the number of copied character / number of character to copy (\0 is not included)
458444
/// You should call this function 2 times - the first time you pass langDesc as NULL to get the number of characters to copy.
459445
/// You allocate a buffer of the length of (the number of characters + 1) then call NPPM_GETLANGUAGEDESC function the 2nd time
@@ -462,7 +448,7 @@ public enum NppMsg : uint
462448
NPPM_GETLANGUAGEDESC = Constants.NPPMSG + 84,
463449

464450
/// <summary>
465-
/// VOID NPPM_ISDOCSWITCHERSHOWN(0, BOOL toShowOrNot)
451+
/// VOID NPPM_SHOWDOCSWITCHER(0, BOOL toShowOrNot)
466452
/// Send this message to show or hide doc switcher.
467453
/// if toShowOrNot is TRUE then show doc switcher, otherwise hide it.
468454
/// </summary>
@@ -476,7 +462,7 @@ public enum NppMsg : uint
476462

477463
/// <summary>
478464
/// BOOL NPPM_GETAPPDATAPLUGINSALLOWED(0, 0)
479-
/// Check to see if loading plugins from "%APPDATA%\Notepad++\plugins" is allowed.
465+
/// Check to see if loading plugins from "%APPDATA%\..\Local\Notepad++\plugins" is allowed.
480466
/// </summary>
481467
NPPM_GETAPPDATAPLUGINSALLOWED = Constants.NPPMSG + 87,
482468

@@ -519,21 +505,44 @@ public enum NppMsg : uint
519505
/// </summary>
520506
NPPM_SAVEFILE = Constants.NPPMSG + 94,
521507

508+
/// <summary>
509+
/// VOID NPPM_DISABLEAUTOUPDATE(0, 0)
510+
/// </summary>
511+
NPPM_DISABLEAUTOUPDATE = Constants.NPPMSG + 95,
512+
513+
/// <summary>
514+
/// BOOL NPPM_REMOVESHORTCUTASSIGNMENT(int cmdID)
515+
/// removes the assigned shortcut mapped to cmdID
516+
/// returned value : TRUE if function call is successful, otherwise FALSE
517+
/// </summary>
518+
NPPM_REMOVESHORTCUTBYCMDID = Constants.NPPMSG + 96,
519+
520+
/// <summary>
521+
/// INT NPPM_GETPLUGINHOMEPATH(size_t strLen, TCHAR *pluginRootPath)
522+
/// Get plugin home root path. It's useful if plugins want to get its own path
523+
/// by appending <pluginFolderName> which is the name of plugin without extension part.
524+
/// Returns the number of TCHAR copied/to copy.
525+
/// Users should call it with pluginRootPath be NULL to get the required number of TCHAR (not including the terminating nul character),
526+
/// allocate pluginRootPath buffer with the return value + 1, then call it again to get the path.
527+
/// </summary>
528+
NPPM_GETPLUGINHOMEPATH = Constants.NPPMSG + 97,
529+
522530
RUNCOMMAND_USER = Constants.WM_USER + 3000,
523531
NPPM_GETFULLCURRENTPATH = RUNCOMMAND_USER + FULL_CURRENT_PATH,
524532
NPPM_GETCURRENTDIRECTORY = RUNCOMMAND_USER + CURRENT_DIRECTORY,
525533
NPPM_GETFILENAME = RUNCOMMAND_USER + FILE_NAME,
526534
NPPM_GETNAMEPART = RUNCOMMAND_USER + NAME_PART,
527535
NPPM_GETEXTPART = RUNCOMMAND_USER + EXT_PART,
528536
NPPM_GETCURRENTWORD = RUNCOMMAND_USER + CURRENT_WORD,
537+
NPPM_GETNPPDIRECTORY = RUNCOMMAND_USER + NPP_DIRECTORY,
529538
/// <summary>
530539
/// BOOL NPPM_GETXXXXXXXXXXXXXXXX(size_t strLen, TCHAR *str)
531540
/// where str is the allocated TCHAR array,
532541
/// strLen is the allocated array size
533542
/// The return value is TRUE when get generic_string operation success
534543
/// Otherwise (allocated array size is too small) FALSE
535544
/// </summary>
536-
NPPM_GETNPPDIRECTORY = RUNCOMMAND_USER + NPP_DIRECTORY,
545+
NPPM_GETFILENAMEATCURSOR = RUNCOMMAND_USER + GETFILENAMEATCURSOR,
537546

538547
/// <summary>
539548
/// INT NPPM_GETCURRENTLINE(0, 0)
@@ -547,6 +556,8 @@ public enum NppMsg : uint
547556
/// </summary>
548557
NPPM_GETCURRENTCOLUMN = RUNCOMMAND_USER + CURRENT_COLUMN,
549558

559+
NPPM_GETNPPFULLFILEPATH = RUNCOMMAND_USER + NPP_FULL_FILE_PATH,
560+
550561
VAR_NOT_RECOGNIZED = 0,
551562
FULL_CURRENT_PATH = 1,
552563
CURRENT_DIRECTORY = 2,
@@ -557,6 +568,8 @@ public enum NppMsg : uint
557568
NPP_DIRECTORY = 7,
558569
CURRENT_LINE = 8,
559570
CURRENT_COLUMN = 9,
571+
NPP_FULL_FILE_PATH = 10,
572+
GETFILENAMEATCURSOR = 11,
560573

561574
/// <summary>
562575
/// To notify plugins that all the procedures of launchment of notepad++ are done.
@@ -682,12 +695,12 @@ public enum NppMsg : uint
682695
///scnNotification->nmhdr.hwndFrom = bufferID;
683696
///scnNotification->nmhdr.idFrom = docStatus;
684697
/// where bufferID is BufferID
685-
/// docStatus can be combined by DOCSTAUS_READONLY and DOCSTAUS_BUFFERDIRTY
698+
/// docStatus can be combined by DOCSTATUS_READONLY and DOCSTATUS_BUFFERDIRTY
686699
/// </summary>
687700
NPPN_READONLYCHANGED = NPPN_FIRST + 16,
688701

689-
DOCSTAUS_READONLY = 1,
690-
DOCSTAUS_BUFFERDIRTY = 2,
702+
DOCSTATUS_READONLY = 1,
703+
DOCSTATUS_BUFFERDIRTY = 2,
691704

692705
/// <summary>
693706
///scnNotification->nmhdr.code = NPPN_DOCORDERCHANGED;

0 commit comments

Comments
 (0)