MLIR TOC

by hockyy ST4

Sublime Text package for MLIR files with syntax highlighting and a section table-of-contents workspace.

Labels mlir, navigation, text manipulation

Details

Version 1.1.0
Homepage github.com
Issues github.com
Modified 3 days ago
Last Seen 3 hours ago
First Seen 2 weeks ago

Installs

Total 3
Win 1
Mac 0
Linux 2

	May 18	May 17	May 16	May 15	May 14	May 13	May 12	May 11	May 10	May 9	May 8	May 7	May 6	May 5	May 4	May 3	May 2	May 1	Apr 30	Apr 29	Apr 28	Apr 27	Apr 26	Apr 25	Apr 24	Apr 23	Apr 22	Apr 21	Apr 20	Apr 19	Apr 18	Apr 17	Apr 16	Apr 15	Apr 14	Apr 13	Apr 12	Apr 11	Apr 10	Apr 9	Apr 8	Apr 7	Apr 6	Apr 5	Apr 4
Windows	0	0	0	0	1	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0
Mac	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0
Linux	0	0	0	0	0	1	0	0	0	0	5	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0	0

Readme

Source: raw.githubusercontent.com

MLIR TOC

Sublime Text plugin for MLIR files: a three-pane workspace with the source, a table of contents of // ----- // Section // ----- // headers (using the MLIR TOC syntax for line numbers, pass names, and func.func symbols), and the currently selected section.

For local development (editors, tooling, or any scripts you run outside Sublime), Python 3.8 is pinned in .python-version for pyenv, asdf, and similar tools. That does not change the runtime inside Sublime Text.

Commands

Open the Command Palette and run:

MLIR: Open TOC + Section Workspace — builds the layout and syncs panes.
MLIR: Refresh TOC + Section — refreshes from the source (also runs on save when the workspace is active).

TOC configuration

You can tune TOC rendering from Sublime settings (Preferences.sublime-settings) or per-view settings:

mlir_toc_group_by: "section" (default) or "function".
mlir_toc_show_functions: false (default) or true (only used when grouping by section).

Example:

{
  "mlir_toc_group_by": "section",
  "mlir_toc_show_functions": true
}

Modes

Section mode ("mlir_toc_group_by": "section"): shows section headers like L19937 IR Dump After ...; with "mlir_toc_show_functions": true, each section also lists every func.func found in that section with its own line number.
Function mode ("mlir_toc_group_by": "function"): groups TOC by func.func @name, then lists every section occurrence for that function.

The TOC pane uses mlir_toc.sublime-syntax (not MLIR comment syntax). Line numbers (L12345), section indices ([42]), section titles, and pass slugs in parentheses are highlighted separately.

Install (manual)

Quit Sublime Text.
Put this folder in your Packages directory (not Installed Packages), e.g.
~/.config/sublime-text/Packages/mlir-toc
(or symlink your clone there).
Start Sublime again.

Flatpak / Snap: use Preferences → Browse Packages… in that install to see the real Packages path (it is not always ~/.config/sublime-text/).

Troubleshooting

Commands missing in the Command Palette — Open View → Show Console. If you see a traceback mentioning mlir_toc, fix that error. Set "debug": true in Preferences → Settings and restart; you should see MLIR TOC: plugin loaded when the plugin loads. Confirm Preferences → Browse Packages… shows mlir-toc with mlir_toc.py, mlir_toc.sublime-commands, and mlir.sublime-syntax inside.
Package Control → Install Package — The package only appears there after it is merged into the default channel, or after Package Control: Add Repository with your GitHub URL.

In the palette, search for MLIR** or **TOC Section.

License

This project is released under the MIT License.

mlir.sublime-syntax is derived from rrbutani/sublime-mlir-syntax (MIT). Rahul Butani’s copyright (2020) appears in LICENSE alongside this project’s; the syntax file header points to the upstream repo.