[Monarch] asm/mips 語(yǔ)法高亮開發(fā)心得 - Monaco Editor

MonarchMonaco Editor 自帶的一個(gè)語(yǔ)法高亮庫(kù)妆偏,可以用類似 JSON 的語(yǔ)法來實(shí)現(xiàn)自定義語(yǔ)言的語(yǔ)法高亮功能杜顺。本文將通過編寫一個(gè)簡(jiǎn)單的mips匯編語(yǔ)言的自定義語(yǔ)法高亮胰坟,來介紹 Monarch 的使用狂打。

1. 初始化

首先需要定義一門語(yǔ)言敌呈,在此我們指定語(yǔ)言的名字叫 asm浆兰。

// Register a new language
monaco.languages.register({ id: "asm", ignoreCase: false });

monaco 官方文檔如下,

### register
register(language: ILanguageExtensionPoint): void

Defined in monaco.d.ts:4659
Register information about a new language.

#### Parameters
* language: ILanguageExtensionPoint

#### Returns void

其中 ILanguageExtensionPoint 是以下 Object家妆,

{
    aliases?: string[],
    configuration?: Uri,
    extensions?: string[], // 源代碼文件拓展名
    filenamePatterns?: string[],
    filenames?: string[],
    firstLine?: string,
    id: string, // 語(yǔ)言的名字
    mimetypes?: string[]
}

2. Monarch Tokens Provider

接下來需要注冊(cè)該語(yǔ)言的標(biāo)識(shí)解釋器鸵荠,在此我們?cè)O(shè)置該語(yǔ)言是大小寫敏感的,并且有一個(gè) tokenizer伤极。

// Register a tokens provider for the language
monaco.languages.setMonarchTokensProvider("asm", {
    ignoreCase: false,
    tokenizer: {...}
}

Tokenizer

官方文檔中有以下描述

(object with states) This defines the tokenization rules. The tokenizer attribute describes how lexical analysis takes place, and how the input is divided into tokens. Each token is given a CSS class name which is used to render each token in the editor.

即是將源代碼轉(zhuǎn)化為各個(gè)標(biāo)識(shí)符(關(guān)鍵字蛹找、字符串、注釋)的規(guī)則哨坪。具體而言庸疾, tokenizer 描述了一系列 state 和其規(guī)則,可以看成是一個(gè)語(yǔ)法解析狀態(tài)機(jī)当编,而每一條規(guī)則描述了該 state 的匹配規(guī)則届慈、行為action、下一狀態(tài) next

https://microsoft.github.io/monaco-editor/monarch.html 中有很多樣例金顿,這里不具體講解各種配置的意義词渤,下面直接舉例 asm 語(yǔ)言的 tokenizer

話不多說上代碼串绩,最終的結(jié)果如下缺虐,

{
storage_type_kw: /\.(ascii|asciiz|byte|data|double|float|half|kdata|ktext|space|text|word|set\s*(noat|at|noreorder|reorder))\b/,
function_normal: ["abs.d", "abs.s", "add", "add.d", "add.s", ..., "xor", "xori"],
function_pseudo: ["mul", "abs", "div", "divu", ..., "sd", "ush", "usw", "move", "mfc1.d", "l.d", "l.s", "s.d", "s.s"],

tokenizer: {
    root: [
        [/^\s*?/, "line.line", "@line_pre"],
        { include: "@normal" }
    ],
    normal: [
        [/#.*$/, "comment", "@popall"],
        [/"/, { token: "string.quote", bracket: "@open", next: "@string" }],
        [/[\w\.\-]+/, {
            cases: {
                "-?\\d+": { token: "number", next: "@popall" },
                "-?\\d+\\.\\d+": { token: "number.float", next: "@popall" },
                "0[xX]([0-9a-fA-F]*)": { token: "number.hex", next: "@popall" },
                "0[bB]([01]*)": { token: "number.binary", next: "@popall" },
                "@default": { token: "source", next: "@popall" },
                "@eos": { token: "line.line", next: "@popall" }
            }
        }],
        { include: "register" }
    ],

    line_pre: [
        [/([a-zA-Z_]\w*):/, "tag.label.$1", "@line_fun"],
        { include: "@line_fun" },
        { include: "@normal" },
    ],

    line_fun: [
        [/[a-z][\w\.]*/, {
            cases: {
                "@function_normal": { token: "function.normal.$0", next: "@popall" },
                "@function_pseudo": { token: "function.pseudo.$0", next: "@popall" },
                "@default": { token: "source", next: "@popall" },
                "@eos": { token: "line.line", next: "@popall" }
            }
        }],
        [/@storage_type_kw/, "constructor.storage.type", "@popall"],
        [/\.(align|extern|globl)\b/, "constructor.storage.modifier", "@popall"],
        { include: "@normal" },
    ],

    register: [
        [/(\$)(0|[2-9]|1[0-9]|2[0-589]|3[0-1])\b/, "variable.register.by-number", "@popall"],
        [/(\$)(zero|v[01]|a[0-3]|t[0-9]|s[0-7]|gp|sp|fp|ra)\b/, "variable.register.by-name", "@popall"],
        [/(\$)(at|k[01]|1|2[67])\b/, "variable.register.reserved", "@popall"],
        [/(\$)f([0-9]|1[0-9]|2[0-9]|3[0-1])\b/, "variable.register.floating-point", "@popall"]
    ],

    string: [
        [/[^\\"&]+/, "string"],
        { include: "@string_common" },
        [/"/, { token: 'string.quote', bracket: '@close', next: '@popall' }]
    ],

    string_common: [
        [/\\[rnt\\']/, "string.escape"],
        [/&\w+;/, 'string.escape'],
        [/[\\&]/, 'string']
    ]
}
}

其中規(guī)則的入口是 tokenizer.root ,與tokenizer同級(jí)的是關(guān)鍵字表礁凡,tokenizer 的子元素是規(guī)則表高氮。

include

包含 tokenizer 下其它的規(guī)則,例如顷牌,

root: [ { include: "@normal" } ]

Inspecting Tokens

Monaco provides an Inspect Tokens tool in browsers to help identify the tokens parsed from source code.

To activate:

  • Press F1 while focused on a Monaco instance. (或者右鍵 - Command Palette)
  • Trigger the Developer: Inspect Tokens option.

This will show a display over the currently selected token for its language, token type, basic font style and colors, and selector you can target in your editor themes.

可以看出 beq 的標(biāo)識(shí)是 function.normal.beq.asm

3. Theme

4. Completion Item Provider

[To be continued]

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末剪芍,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子窟蓝,更是在濱河造成了極大的恐慌罪裹,老刑警劉巖,帶你破解...
    沈念sama閱讀 218,284評(píng)論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件运挫,死亡現(xiàn)場(chǎng)離奇詭異状共,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)谁帕,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,115評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門峡继,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人匈挖,你說我怎么就攤上這事碾牌。” “怎么了儡循?”我有些...
    開封第一講書人閱讀 164,614評(píng)論 0 354
  • 文/不壞的土叔 我叫張陵舶吗,是天一觀的道長(zhǎng)。 經(jīng)常有香客問我择膝,道長(zhǎng)誓琼,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,671評(píng)論 1 293
  • 正文 為了忘掉前任调榄,我火速辦了婚禮踊赠,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘每庆。我一直安慰自己,他們只是感情好今穿,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,699評(píng)論 6 392
  • 文/花漫 我一把揭開白布缤灵。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪腮出。 梳的紋絲不亂的頭發(fā)上帖鸦,一...
    開封第一講書人閱讀 51,562評(píng)論 1 305
  • 那天,我揣著相機(jī)與錄音胚嘲,去河邊找鬼作儿。 笑死,一個(gè)胖子當(dāng)著我的面吹牛馋劈,可吹牛的內(nèi)容都是我干的攻锰。 我是一名探鬼主播,決...
    沈念sama閱讀 40,309評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼妓雾,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼娶吞!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起械姻,我...
    開封第一講書人閱讀 39,223評(píng)論 0 276
  • 序言:老撾萬榮一對(duì)情侶失蹤妒蛇,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后楷拳,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體绣夺,經(jīng)...
    沈念sama閱讀 45,668評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,859評(píng)論 3 336
  • 正文 我和宋清朗相戀三年欢揖,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了乐导。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 39,981評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡浸颓,死狀恐怖物臂,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情产上,我是刑警寧澤棵磷,帶...
    沈念sama閱讀 35,705評(píng)論 5 347
  • 正文 年R本政府宣布,位于F島的核電站晋涣,受9級(jí)特大地震影響仪媒,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜谢鹊,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,310評(píng)論 3 330
  • 文/蒙蒙 一算吩、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧佃扼,春花似錦偎巢、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,904評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)求冷。三九已至,卻和暖如春窍霞,著一層夾襖步出監(jiān)牢的瞬間匠题,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,023評(píng)論 1 270
  • 我被黑心中介騙來泰國(guó)打工但金, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留韭山,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 48,146評(píng)論 3 370
  • 正文 我出身青樓冷溃,卻偏偏與公主長(zhǎng)得像钱磅,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子秃诵,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,933評(píng)論 2 355

推薦閱讀更多精彩內(nèi)容