[llvm] [TextMate] Add textmate bundle for LLVM IR (PR #122677)
Mats Jun Larsen via llvm-commits
llvm-commits at lists.llvm.org
Mon Jan 13 01:33:34 PST 2025
https://github.com/junlarsen created https://github.com/llvm/llvm-project/pull/122677
This patch copies the LLVM IR tmLanguage from the vscode plugin so that it's standalone installable as a .tmbundle.
Similar to how we have a standalone .tmbundle for TableGen files, it will now be possible to install simple syntax highlighting for LLVM IR. I recently needed this in RustRover for viewing LLVM IR.
>From b71d143397b675b2f6eb5f1309ce9a712a4577c9 Mon Sep 17 00:00:00 2001
From: Mats Larsen <mats at jun.codes>
Date: Mon, 13 Jan 2025 18:29:37 +0900
Subject: [PATCH] [TextMate] Add textmate bundle for LLVM IR
This patch copies the LLVM IR tmLanguage from the vscode plugin so that it's standalone installable as a .tmbundle.
---
.../Syntaxes/LLVM.tmLanguage.json | 125 ++++++++++++++++++
llvm/utils/textmate/LLVM.tmbundle/info.plist | 12 ++
llvm/utils/textmate/README | 22 ++-
.../vscode/llvm/syntaxes/ll.tmLanguage.yaml | 1 +
4 files changed, 155 insertions(+), 5 deletions(-)
create mode 100644 llvm/utils/textmate/LLVM.tmbundle/Syntaxes/LLVM.tmLanguage.json
create mode 100644 llvm/utils/textmate/LLVM.tmbundle/info.plist
diff --git a/llvm/utils/textmate/LLVM.tmbundle/Syntaxes/LLVM.tmLanguage.json b/llvm/utils/textmate/LLVM.tmbundle/Syntaxes/LLVM.tmLanguage.json
new file mode 100644
index 00000000000000..5d82f856ef1872
--- /dev/null
+++ b/llvm/utils/textmate/LLVM.tmbundle/Syntaxes/LLVM.tmLanguage.json
@@ -0,0 +1,125 @@
+{
+ "$schema": "https://raw.githubusercontent.com/martinring/tmlanguage/master/tmlanguage.json",
+ "name": "LLVM IR",
+ "scopeName": "source.llvm",
+ "fileTypes": [
+ "ll"
+ ],
+ "patterns": [
+ {
+ "match": "\\bvoid\\b|\\bhalf\\b|\\bbfloat\\b|\\bfloat\\b|\\bdouble\\b|\\bx86_fp80\\b|\\bfp128\\b|\\bppc_fp128\\b|\\blabel\\b|\\bmetadata\\b|\\bx86_mmx\\b|\\bx86_amx\\b|\\btype\\b|\\blabel\\b|\\bopaque\\b|\\btoken\\b|\\bi\\d+\\**",
+ "name": "storage.type.llvm"
+ },
+ {
+ "match": "!([a-zA-Z]+)\\s*\\(",
+ "captures": {
+ "1": {
+ "name": "storage.type.llvm"
+ }
+ }
+ },
+ {
+ "match": "(?<=\\s|^)#dbg_(assign|declare|label|value)\\b|\\badd\\b|\\baddrspacecast\\b|\\balloca\\b|\\band\\b|\\barcp\\b|\\bashr\\b|\\batomicrmw\\b|\\bbitcast\\b|\\bbr\\b|\\bcatchpad\\b|\\bcatchswitch\\b|\\bcatchret\\b|\\bcall\\b|\\bcallbr\\b|\\bcleanuppad\\b|\\bcleanupret\\b|\\bcmpxchg\\b|\\beq\\b|\\bexact\\b|\\bextractelement\\b|\\bextractvalue\\b|\\bfadd\\b|\\bfast\\b|\\bfcmp\\b|\\bfdiv\\b|\\bfence\\b|\\bfmul\\b|\\bfpext\\b|\\bfptosi\\b|\\bfptoui\\b|\\bfptrunc\\b|\\bfree\\b|\\bfrem\\b|\\bfreeze\\b|\\bfsub\\b|\\bfneg\\b|\\bgetelementptr\\b|\\bicmp\\b|\\binbounds\\b|\\bindirectbr\\b|\\binsertelement\\b|\\binsertvalue\\b|\\binttoptr\\b|\\binvoke\\b|\\blandingpad\\b|\\bload\\b|\\blshr\\b|\\bmalloc\\b|\\bmax\\b|\\bmin\\b|\\bmul\\b|\\bnand\\b|\\bne\\b|\\bninf\\b|\\bnnan\\b|\\bnsw\\b|\\bnsz\\b|\\bnuw\\b|\\boeq\\b|\\boge\\b|\\bogt\\b|\\bole\\b|\\bolt\\b|\\bone\\b|\\bor\\b|\\bord\\b|\\bphi\\b|\\bptrtoint\\b|\\bresume\\b|\\bret\\b|\\bsdiv\\b|\\bselect\\b|\\bsext\\b|\\bsge\\b|\\bsgt\\b|\\bshl\\b|\\bshufflevector\\b|\\bsitofp\\b|\\bsle\\b|\\bslt\\b|\\bsrem\\b|\\bstore\\b|\\bsub\\b|\\bswitch\\b|\\btrunc\\b|\\budiv\\b|\\bueq\\b|\\buge\\b|\\bugt\\b|\\buitofp\\b|\\bule\\b|\\bult\\b|\\bumax\\b|\\bumin\\b|\\bune\\b|\\buno\\b|\\bunreachable\\b|\\bunwind\\b|\\burem\\b|\\bva_arg\\b|\\bxchg\\b|\\bxor\\b|\\bzext\\b",
+ "name": "keyword.instruction.llvm"
+ },
+ {
+ "match": "\\bacq_rel\\b|\\bacquire\\b|\\baddrspace\\b|\\balias\\b|\\balign\\b|\\balignstack\\b|\\ballocsize\\b|\\balwaysinline\\b|\\bappending\\b|\\bargmemonly\\b|\\barm_aapcs_vfpcc\\b|\\barm_aapcscc\\b|\\barm_apcscc\\b|\\basm\\b|\\batomic\\b|\\bavailable_externally\\b|\\bblockaddress\\b|\\bbuiltin\\b|\\bbyref\\b|\\bbyval\\b|\\bc\\b|\\bcaller\\b|\\bcatch\\b|\\bcc\\b|\\bccc\\b|\\bcleanup\\b|\\bcold\\b|\\bcoldcc\\b|\\bcomdat\\b|\\bcommon\\b|\\bconstant\\b|\\bconvergent\\b|\\bdatalayout\\b|\\bdeclare\\b|\\bdefault\\b|\\bdefine\\b|\\bdeplibs\\b|\\bdereferenceable\\b|\\bdereferenceable_or_null\\b|\\bdistinct\\b|\\bdllexport\\b|\\bdllimport\\b|\\bdso_local\\b|\\bdso_preemptable\\b|\\bexcept\\b|\\bextern_weak\\b|\\bexternal\\b|\\bexternally_initialized\\b|\\bfastcc\\b|\\bfilter\\b|\\bfrom\\b|\\bgc\\b|\\bglobal\\b|\\bhhvm_ccc\\b|\\bhhvmcc\\b|\\bhidden\\b|\\bhot\\b|\\bimmarg\\b|\\binaccessiblemem_or_argmemonly\\b|\\binaccessiblememonly\\b|\\binalloc\\b|\\binitialexec\\b|\\binlinehint\\b|\\binreg\\b|\\bintel_ocl_bicc\\b|\\binteldialect\\b|\\binternal\\b|\\bjumptable\\b|\\blinkonce\\b|\\blinkonce_odr\\b|\\blocal_unnamed_addr\\b|\\blocaldynamic\\b|\\blocalexec\\b|\\bminsize\\b|\\bmodule\\b|\\bmonotonic\\b|\\bmsp430_intrcc\\b|\\bmustprogress\\b|\\bmusttail\\b|\\bnaked\\b|\\bnest\\b|\\bnoalias\\b|\\bnobuiltin\\b|\\bnocallback\\b|\\bnocapture\\b|\\bnocf_check\\b|\\bnoduplicate\\b|\\bnofree\\b|\\bnoimplicitfloat\\b|\\bnoinline\\b|\\bnomerge\\b|\\bnonlazybind\\b|\\bnonnull\\b|\\bnoprofile\\b|\\bnorecurse\\b|\\bnoredzone\\b|\\bnoreturn\\b|\\bnosync\\b|\\bnoundef\\b|\\bnounwind\\b|\\bnosanitize_bounds\\b|\\bnosanitize_coverage\\b|\\bnull_pointer_is_valid\\b|\\boptforfuzzing\\b|\\boptnone\\b|\\boptsize\\b|\\bpersonality\\b|\\bpreallocated\\b|\\bprivate\\b|\\bprotected\\b|\\bptx_device\\b|\\bptx_kernel\\b|\\breadnone\\b|\\breadonly\\b|\\brelease\\b|\\breturned\\b|\\breturns_twice\\b|\\bsafestack\\b|\\bsanitize_address\\b|\\bsanitize_hwaddress\\b|\\bsanitize_memory\\b|\\bsanitize_memtag\\b|\\bsanitize_thread\\b|\\bsection\\b|\\bseq_cst\\b|\\bshadowcallstack\\b|\\bsideeffect\\b|\\bsignext\\b|\\bsource_filename\\b|\\bspeculatable\\b|\\bspeculative_load_hardening\\b|\\bspir_func\\b|\\bspir_kernel\\b|\\bsret\\b|\\bssp\\b|\\bsspreq\\b|\\bsspstrong\\b|\\bstrictfp\\b|\\bswiftcc\\b|\\bswifterror\\b|\\bswiftself\\b|\\bsyncscope\\b|\\btail\\b|\\btailcc\\b|\\btarget\\b|\\bthread_local\\b|\\bto\\b|\\btriple\\b|\\bunnamed_addr\\b|\\bunordered\\b|\\buselistorder\\b|\\buselistorder_bb\\b|\\buwtable\\b|\\bvolatile\\b|\\bweak\\b|\\bweak_odr\\b|\\bwillreturn\\b|\\bwin64cc\\b|\\bwithin\\b|\\bwriteonly\\b|\\bx86_64_sysvcc\\b|\\bx86_fastcallcc\\b|\\bx86_stdcallcc\\b|\\bx86_thiscallcc\\b|\\bzeroext\\b",
+ "name": "storage.modifier.llvm"
+ },
+ {
+ "match": "@[-a-zA-Z$._][-a-zA-Z$._0-9]*",
+ "name": "entity.name.function.llvm"
+ },
+ {
+ "match": "[%@!]\\d+\\b",
+ "name": "variable.llvm"
+ },
+ {
+ "match": "%[-a-zA-Z$._][-a-zA-Z$._0-9]*",
+ "name": "variable.llvm"
+ },
+ {
+ "match": "(![-a-zA-Z$._][-a-zA-Z$._0-9]*)\\s*$",
+ "captures": {
+ "1": {
+ "name": "variable.llvm"
+ }
+ }
+ },
+ {
+ "match": "(![-a-zA-Z$._][-a-zA-Z$._0-9]*)\\s*[=!]",
+ "captures": {
+ "1": {
+ "name": "variable.llvm"
+ }
+ }
+ },
+ {
+ "begin": "\"",
+ "end": "\"",
+ "patterns": [
+ {
+ "name": "constant.character.escape.untitled",
+ "match": "\\."
+ }
+ ],
+ "name": "string.quoted.double.llvm"
+ },
+ {
+ "match": "[-a-zA-Z$._][-a-zA-Z$._0-9]*:",
+ "name": "entity.name.label.llvm"
+ },
+ {
+ "match": "-?\\b\\d+\\.\\d*(e[+-]\\d+)?\\b",
+ "name": "constant.numeric.float"
+ },
+ {
+ "match": "\\b0x\\x+\\b",
+ "name": "constant.numeric.float"
+ },
+ {
+ "match": "-?\\b\\d+\\b",
+ "name": "constant.numeric.integer"
+ },
+ {
+ "match": "\\btrue\\b|\\bfalse\\b|\\bnull\\b|\\bzeroinitializer\\b|\\bundef\\b|\\bpoison\\b|\\bnull\\b|\\bnone\\b",
+ "name": "constant.language"
+ },
+ {
+ "match": "\\bDW_TAG_[a-z_]+\\b|\\bDW_ATE_[a-zA-Z_]+\\b|\\bDW_OP_[a-zA-Z0-9_]+\\b|\\bDW_LANG_[a-zA-Z0-9_]+\\b|\\bDW_VIRTUALITY_[a-z_]+\\b|\\bDIFlag[A-Za-z]+\\b",
+ "name": "constant.other"
+ },
+ {
+ "match": ";\\s*PR\\d*\\s*$",
+ "name": "string.regexp"
+ },
+ {
+ "match": ";\\s*REQUIRES:.*$",
+ "name": "string.regexp"
+ },
+ {
+ "match": ";\\s*RUN:.*$",
+ "name": "string.regexp"
+ },
+ {
+ "match": ";\\s*ALLOW_RETRIES:.*$",
+ "name": "string.regexp"
+ },
+ {
+ "match": ";\\s*CHECK:.*$",
+ "name": "string.regexp"
+ },
+ {
+ "match": ";\\s*CHECK-(NEXT|NOT|DAG|SAME|LABEL):.*$",
+ "name": "string.regexp"
+ },
+ {
+ "match": ";\\s*XFAIL:.*$",
+ "name": "string.regexp"
+ },
+ {
+ "match": ";.*$",
+ "name": "comment.line.llvm"
+ }
+ ]
+}
\ No newline at end of file
diff --git a/llvm/utils/textmate/LLVM.tmbundle/info.plist b/llvm/utils/textmate/LLVM.tmbundle/info.plist
new file mode 100644
index 00000000000000..b70055844bfc22
--- /dev/null
+++ b/llvm/utils/textmate/LLVM.tmbundle/info.plist
@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+ <key>name</key>
+ <string>LLVM IR</string>
+ <key>ordering</key>
+ <array/>
+ <key>uuid</key>
+ <string>96925448-7219-41E9-A7F0-8D5B70E9B877</string>
+</dict>
+</plist>
diff --git a/llvm/utils/textmate/README b/llvm/utils/textmate/README
index b01352551afee7..f432b71a9c24b5 100644
--- a/llvm/utils/textmate/README
+++ b/llvm/utils/textmate/README
@@ -1,8 +1,20 @@
-This directory contains a "bundle" for doing syntax highlighting of TableGen
-files for the TextMate editor for OS X. The highlighting follows that done
-by the TextMate "C" bundle. Currently, keywords, comments, and strings are
-highlighted.
+This directory contains TextMate bundles[1] for doing ad-hoc syntax
+highlighting of LLVM IR and TableGen files. The highlighting bundles mirror
+the syntaxes in the VSCode extension found at /llvm/utils/vscode/llvm. At the
+moment, only basic tokens like keywords, comments, and strings are highlighted.
+
+These bundles can be used by the TextMate editor for OS X, as well as other
+editors that support them, such as IntelliJ IDEA[2].
To install this bundle, copy it to the per user area:
cp -R utils/textmate/TableGen.tmbundle \
- ~/Library/Application\ Support/TextMate/Bundles/TableGen.tmbundle
+ ~/Library/Application\ Support/TextMate/Bundles/TableGen.tmbundle
+
+[1] https://macromates.com/manual/en/bundles
+[2] https://www.jetbrains.com/help/idea/textmate.html
+
+Implementation notes:
+
+The TextMate Syntaxes must use either .tmLanguage or .tmLanguage.json for
+IntelliJ IDEA to recognize them. LLVM.tmbundle/Syntaxes/LLVM.tmLanguage.json is
+simply a conversion of /llvm/utils/vscode/llvm/syntaxes/ll.tmLanguage.yaml.
diff --git a/llvm/utils/vscode/llvm/syntaxes/ll.tmLanguage.yaml b/llvm/utils/vscode/llvm/syntaxes/ll.tmLanguage.yaml
index b64482336f4042..aac3c5cee8e152 100644
--- a/llvm/utils/vscode/llvm/syntaxes/ll.tmLanguage.yaml
+++ b/llvm/utils/vscode/llvm/syntaxes/ll.tmLanguage.yaml
@@ -11,6 +11,7 @@
$schema: https://raw.githubusercontent.com/martinring/tmlanguage/master/tmlanguage.json
name: LLVM IR
scopeName: source.llvm
+fileTypes: ["ll"]
patterns:
- match: "\\bvoid\\b|\
\\bhalf\\b|\
More information about the llvm-commits
mailing list