VSCode Function Mapping for .mac and .inc files

[toots]

Here is a short guide for building a function list is VSCode that scans macro and include files for lines that start with 'Sub'. It then creates a context map which shows a list of all subs in the file and allows you to click on individual subs to jump to their location in the file.

1) Download the CodeMap extension.

2) Keypress Ctrl+Shift+P
3) Search for 'Preferences: Open Settings (JSON)'
4) add the following snippet to that settings.json file inside the curly brackets { }

"codemap.location": "explorer",
    "codemap.mac": [
        {
          "pattern": "^\\s*(Sub|sub) \\w*\\s*\(([^\)]*)\)",
          "clear": "Sub ",
          "icon": "function"
        }
    ],
    "codemap.inc": [
        {
          "pattern": "^\\s*(Sub|sub) \\w*\\s*\(([^\)]*)\)",
          "clear": "Sub ",
          "icon": "function"
        }
    ]

5) Enjoy the function jumping.

 

[morisato]

Awesome!! Np++ no more

 

[vsab]

I think I love you. This is so simple, but amazing, thanks!

 

[faiding]

Nice find!

I also suggest checking out the Macroquest2 VSCode (vscodemq2) extension for syntax highlighting.

 

[toots]

Yeap. That syntax highlighting is great, but if anyone is up for it it could use some updating and possible extension for full language support.

 

[faiding]

Yeap. That syntax highlighting is great, but if anyone is up for it it could use some updating and possible extension for full language support.

I'm no regex master but I made several updates to the .tmlLanguage file. At least enough to make my scripts look like less of a crime scene. I dunno if he's accepting PRs for updates but I've attached it if anyone wants to take a stab.

(Extract into \.vscode\extensions\dewaynejohnsonbaugh.vscodemq2-0.7.0\syntaxes\)

 

[playj]

Nicely done!

Syntax highlighting working pretty well (way better than NP++)

Now curious why some commands are red - ie those are not recognized as valid MQ2:

/alt activate <- activate is red
/dzquit
/doortarget
/click left door <- door is red
/end <- well this being red would make sense

also MQ2Nav and MQ2AdvPath commands are red but that is to be expected

 

[Maskoi]

If you add "codemap.sortingEnabled": true, it will sort the names alphabetically.
If you use "codemap.location": "codemap", instead of explorer it put its in another window with a dedicated icon to click

    "codemap.location": "codemap",
    "codemap.sortingEnabled": true,
    "codemap.mac": [
        {
          "pattern": "^\\s*(Sub|sub) \\w*\\s*\(([^\)]*)\)",
          "clear": "Sub ",
          "icon": "function"
        }
    ],
    "codemap.inc": [
        {
          "pattern": "^\\s*(Sub|sub) \\w*\\s*\(([^\)]*)\)",
          "clear": "Sub ",
          "icon": "function"
        }
    ]