How to write macro for Notepad++?

by

Macros in Notepad++ are just a bunch of encoded operations: you start recording, operate on the buffer, perhaps activating menus, stop recording then play the macro.
After investigation, I found out they are saved in the file shortcuts.xml in the Macros section. For example, I have there:

<Macro name="Trim Trailing and save" Ctrl="no" Alt="yes" Shift="yes" Key="83">
    <Action type="1" message="2170" wParam="0" lParam="0" sParam=" " />
    <Action type="1" message="2170" wParam="0" lParam="0" sParam=" " />
    <Action type="1" message="2170" wParam="0" lParam="0" sParam=" " />
    <Action type="0" message="2327" wParam="0" lParam="0" sParam="" />
    <Action type="0" message="2327" wParam="0" lParam="0" sParam="" />
    <Action type="2" message="0" wParam="42024" lParam="0" sParam="" />
    <Action type="2" message="0" wParam="41006" lParam="0" sParam="" />
</Macro>

I haven’t looked at the source, but from the look, I would say we have messages sent to Scintilla (the editing component, perhaps type 0 and 1), and to Notepad++ itself (probably activating menu items).
I don’t think it will record actions in dialogs (like search/replace).

Looking at Scintilla.iface file, we can see that 2170 is the code of ReplaceSel (ie. insert string is nothing is selected), 2327 is Tab command, and Resource Hacker (just have it handy…) shows that 42024 is “Trim Trailing Space” menu item and 41006 is “Save”.
I guess action type 0 is for Scintilla commands with numerical params, type 1 is for commands with string parameter, 2 is for Notepad++ commands.

Problem: Scintilla doesn’t have a “Replace all” command: it is the task of the client to do the iteration, with or without confirmation, etc.
Another problem: it seems type 1 action is limited to 1 char (I edited manually, when exiting N++ it was truncated).
I tried some tricks, but I fear such task is beyond the macro capabilities.

Maybe that’s where SciTE with its Lua scripting ability (or Programmer’s Notepad which seems to be scriptable with Python) has an edge… 🙂

[EDIT] Looks like I got the above macro from this thread or a similar place… 🙂 I guess the first lines are unnecessary (side effect or recording) but they were good examples of macro code anyway.

More Related Contents:

  1. Is it possible to declare variables procedurally using Rust macros?
  2. Can a Rust macro create new identifiers?
  3. Generating documentation in macros
  4. What makes Lisp macros so special?
  5. Macros in Swift?
  6. How can I generate unique values in the C preprocessor?
  7. How to prefix/suffix identifiers within a macro? [duplicate]
  8. Variadic recursive preprocessor macros – is it possible?
  9. How do I match the type of an expression in a Rust macro?
  10. How do I show the value of a #define at compile-time?
  11. Is there a way to count with macros?
  12. Can macros match against constant arguments instead of literals?
  13. How to allow optional trailing commas in macros?
  14. How to auto execute a macro when opening a Powerpoint presentation?
  15. Mathematica: Unevaluated vs Defer vs Hold vs HoldForm vs HoldAllComplete vs etc etc
  16. How to embed a Rust macro variable into documentation?
  17. How to enforce that a type implements a trait at compile time?
  18. Passing values to macros by for loop
  19. Multiple word search and replace in notepad++
  20. Find CRLF in Notepad++
  21. How to use a Objective-C #define from Swift
  22. How To Auto-Format / Indent XML/HTML in Notepad++
  23. Instantiate class from name?
  24. Are C++ Templates just Macros in disguise?
  25. Is there a way to get function name inside a C++ function?
  26. Saving vim macros
  27. Reason why not to have a DELETE macro for C++
  28. EOL conversion in notepad ++
  29. Add preprocessor macro to a target in xcode 6
  30. Can I convert a string to enum without macros in Rust?

Leave a Comment