利用CTags開(kāi)發(fā)一個(gè)Sublime Text代碼補(bǔ)完插件
喜歡使用 Sublime Text 的朋友們都知道，Sublime Text 相當(dāng)于 Linux 上的 Vim，它們都具有很強(qiáng)的可擴(kuò)展功能，功能多樣的同時(shí)速度也很快，對(duì)于處理小型文件和項(xiàng)目效率特別高，因此如果不是特別復(fù)雜的項(xiàng)目，我一般都是用 Sublime Text 編寫(xiě)以及編譯的。
然而在用 Sublime Text 開(kāi)發(fā)的過(guò)程中，我發(fā)現(xiàn)了一個(gè)問(wèn)題：Sublime Text 本身的自動(dòng)完成功能只搜索當(dāng)前視圖中正在編輯文件的函數(shù)，當(dāng)我想用其他文件中自定義的函數(shù)時(shí)，是沒(méi)有自動(dòng)完成功能的。而當(dāng)自定義函數(shù)過(guò)多時(shí)，效率會(huì)大大降低，于是我開(kāi)始尋找具有相關(guān)功能的插件。
一開(kāi)始我用了非常熱門(mén)的 “SublimeCodeIntel” 插件，試了一下的確非常好用，但是可惜的是，這個(gè)插件不支持 C/C++，而且占用的空間非常大，追求簡(jiǎn)潔輕便的我不得不另辟蹊徑。后來(lái)又找到一款 “All AutoComplete” 插件，這款插件擴(kuò)展了 Sublime Text 默認(rèn)的自動(dòng)完成功能，可以在當(dāng)前視圖打開(kāi)的所有文件里面尋找定義的函數(shù)和變量，盡管用起來(lái)效果不錯(cuò)，但是它的問(wèn)題也很明顯，必須要同時(shí)打開(kāi)多個(gè)文件才行，非常不方便，于是我又放棄了。
在 Package Control 上找了許久，也沒(méi)能找到我想要的插件，于是我開(kāi)始考慮不如自己寫(xiě)一個(gè)這樣的插件，剛好借此機(jī)會(huì)入門(mén) Python。這時(shí)我剛好想到能不能利用 CTags，它能把當(dāng)前項(xiàng)目中的所有自定義函數(shù)提取出來(lái)，生成 .tags 文件，并提供符號(hào)跳轉(zhuǎn)功能，只要提取 .tags 文件里面的信息，用正則匹配，然后添加到 Sublime Text 的自動(dòng)完成函數(shù)中不就行了。
為了完成這個(gè)插件，我在網(wǎng)上搜索相關(guān)信息，找到相關(guān)素材并重新構(gòu)思了一下，同時(shí)參考了 All Complete 插件的源碼。
需要提一下，在 Sublime Text 下安裝 CTags 的方法這里不會(huì)提到，因此麻煩各位自行查詢(xún)。
插件構(gòu)思
-
讀取設(shè)置，設(shè)置中添加的語(yǔ)言禁用插件功能
-
檢測(cè) .tag 文件是否存在，不存在則直接
return -
讀取當(dāng)前文件夾中的 .tag 文件
-
正則匹配函數(shù)名
-
正則匹配函數(shù)體
-
添加到自動(dòng)完成的接口上
開(kāi)始編寫(xiě)
新建插件
剛開(kāi)始接觸 Sublime Text 插件的編寫(xiě)，當(dāng)然需要先了解 Sublime Text 提供的各種接口，為此，我去 Sublime Text 的官網(wǎng)找到了相關(guān)文檔：How to Create a Sublime Text Plugin，以及 Sublime Text Unofficial Documentation。
首先，在 Sublime Text 中選擇 “Tools -> Developer -> New Plugin” 新建一個(gè)最基本的插件文檔：
import sublimeimport sublime_pluginclass ExampleCommand(sublime_plugin.TextCommand):def run(self, edit):self.view.insert(edit, 0, "Hello, World!")
這里的 sublime 和 sublime_plugin 是 Sublime 必需的模塊，其中具體的類(lèi)和方法可以參考官方的 API Reference。
接著，把這個(gè)文件保存到 Package文件夾（默認(rèn)的保存位置 User 文件夾的上一層）的 CTagsAutoComplete 文件夾（新建）下，并命名為 CTagsAutoComplete.py。盡管命名并沒(méi)有什么限制，但***還是以插件的名稱(chēng)來(lái)統(tǒng)一命名。
然后回到 Sublime Text 中，通過(guò)快捷鍵 Ctrl+` 進(jìn)入 Sublime Text 的 Command Console，然后輸入 view.run_command('example')，如果下方顯示 “Hello World”，說(shuō)明插件已經(jīng)正常加載。
這里之所以直接用
'example'，是因?yàn)?Command 命令的名稱(chēng)是根據(jù)大寫(xiě)字符進(jìn)行拆分的，例子中的ExampleCommand在 Command 中 為'example_command'，直接輸入'example'也可以訪(fǎng)問(wèn)。
文中的術(shù)語(yǔ)
-
Window：Sublime Text 的當(dāng)前窗口對(duì)象 -
View：Sublime Text 當(dāng)前窗口中打開(kāi)的視圖對(duì)象 -
Command Palette：Sublime Text 中通過(guò)快捷鍵Ctrl+Shift+P打開(kāi)的交互式列表
確定插件接口類(lèi)型
Sublime Text 下的插件命令有 3 種命令類(lèi)型（都來(lái)自于 sublime_plugin 模塊）：
-
TextCommand Class：通過(guò)
View對(duì)象提供對(duì)選定文件/緩沖區(qū)的內(nèi)容的訪(fǎng)問(wèn)。 -
WindowCommand Class：通過(guò)
Window對(duì)象提供當(dāng)前窗口的引用 -
ApplicationCommand Class：這個(gè)類(lèi)沒(méi)有引用任何特定窗口或文件/緩沖區(qū)，因此很少使用
2 種事件監(jiān)聽(tīng)類(lèi)型：
-
EventListener Class：監(jiān)聽(tīng) Sublime Text 中各種事件并執(zhí)行一次命令
-
ViewEventListener Class：為
EventListener提供類(lèi)似事件處理的類(lèi)，但綁定到特定的 view。
2 種輸入處理程序：
-
TextInputHandler Class：可用于接受 Command Palette 中的文本輸入。
-
ListInputHandler Class：可用于接受來(lái)自 Command Palette 中列表項(xiàng)的選擇輸入。
因?yàn)槲乙獙?shí)現(xiàn)的功能比較簡(jiǎn)單，只需要監(jiān)聽(tīng)輸入事件并觸發(fā)自動(dòng)完成功能，因此需要用到 EventListener Class。在該類(lèi)下面找到了 on_query_completions 方法用來(lái)處理觸發(fā)自動(dòng)完成時(shí)執(zhí)行的命令。接著修改一下剛才的代碼：
import sublimeimport sublime_pluginclass CTagsAutoComplete(sublime_plugin.EventListener):def on_query_completions(self, view, prefix, locations):
-
view：當(dāng)前視圖 -
prefix：觸發(fā)自動(dòng)完成時(shí)輸入的文字 -
locations: 觸發(fā)自動(dòng)完成時(shí)輸入在緩存區(qū)中的位置，可以通過(guò)這個(gè)參數(shù)判斷語(yǔ)言來(lái)執(zhí)行不同命令 -
返回類(lèi)型：
return Nonereturn [["trigger \t hint", "contents"]...]，其中\t hint為可選內(nèi)容，給自動(dòng)完成的函數(shù)名稱(chēng)添加一個(gè)提示return (results, flag)，其中results是包含自動(dòng)完成語(yǔ)句的 list，如上；flag是一個(gè)額外參數(shù)，可用來(lái)控制是否顯示 Sublime Text 自帶的自動(dòng)完成功能
讀取 CTags 文件
為了讀取 .tag 文件，首先得判斷當(dāng)前項(xiàng)目是否打開(kāi)，同時(shí) .tag 文件是否存在，然后讀取 .tag 文件中的所有內(nèi)容：
import sublimeimport sublime_pluginimport osimport reclass CTagsAutoComplete(sublime_plugin.EventListener):def on_query_completions(self, view, prefix, locations):results = []ctags_paths = [folder + '\.tags' for folder in view.window().folders()]ctags_rows = []for ctags_path in ctags_paths:if not is_file_exist(view, ctags_path):return []ctags_path = str(ctags_path)ctags_file = open(ctags_path, encoding = 'utf-8')ctags_rows += ctags_file.readlines()ctags_file.close()def is_file_exist(view, file):if (not view.window().folders() or not os.path.exists(file)):return Falsereturn True
通過(guò)上述操作，即可讀取當(dāng)前項(xiàng)目下所有的 .tag 文件中的內(nèi)容。
分析 CTags 文件
首先是獲取 .tags 文件中，包含 prefix 的行：
for rows in ctags_rows:target = re.findall('^' + prefix + '.*', rows)
一旦找到，就通過(guò)正則表達(dá)式對(duì)該行數(shù)據(jù)進(jìn)行處理：
if target:matched = re.split('\t', str(target[0]))trigger = matched[0] # 返回的***個(gè)參數(shù)，函數(shù)名稱(chēng)trigger += '\t(%s)' % 'CTags' # 給函數(shù)名稱(chēng)后加上標(biāo)識(shí) 'CTags'contents = re.findall(prefix + '[0-9a-zA-Z_]*\(.*\)', str(matched[2])) # 返回的第二個(gè)參數(shù)，函數(shù)的具體定義if (len(matched) > 1 and contents):results.append((trigger, contents[0]))results = list(set(results)) # 去除重復(fù)的函數(shù)results.sort() # 排序
處理完成之后就可以返回了，考慮到***只顯示 .tags 中的函數(shù)，我不需要顯示 Sublime Text 自帶的自動(dòng)完成功能（提取當(dāng)前頁(yè)面中的變量和函數(shù)），因此我的返回結(jié)果如下：
return (results, sublime.INHIBIT_WORD_COMPLETIONS | sublime.INHIBIT_EXPLICIT_COMPLETIONS)
添加配置文件
考慮到能夠關(guān)閉插件的功能，因此需要添加一個(gè)配置文件，用來(lái)指定不開(kāi)啟插件功能的語(yǔ)言，這里我參考了 “All AutoComplete” 的代碼：
def plugin_loaded():global settingssettings = sublime.load_settings('CTagsAutoComplete.sublime-settings')def is_disabled_in(scope):excluded_scopes = settings.get("exclude_from_completion", [])for excluded_scope in excluded_scopes:if scope.find(excluded_scope) != -1:return Truereturn Falseif is_disabled_in(view.scope_name(locations[0])):return []
這里用到的配置文件需要添加到插件所在的文件夾中，名稱(chēng)為 CTagsAutoComplete.sublime-settings，其內(nèi)容為：
{// An array of syntax names to exclude from being autocompleted."exclude_from_completion": ["css","html"]}
添加設(shè)置文件
有了配置文件，還需要在 Sublime Text 的 “Preferences -> Package settings” 下添加相應(yīng)的設(shè)置，同樣也是放在插件所在文件夾中，名稱(chēng)為 Main.sublime-menu：
[{"caption": "Preferences","mnemonic": "n","id": "preferences","children": [{"caption": "Package Settings","mnemonic": "P","id": "package-settings","children": [{"caption": "CTagsAutoComplete","children": [{"command": "open_file","args": {"file": "${packages}/CTagsAutoComplete/CTagsAutoComplete.sublime-settings"},"caption": "Settings"}]}]}]}]
總結(jié)
首先給出插件的完整源碼：
import sublimeimport sublime_pluginimport osimport redef plugin_loaded():global settingssettings = sublime.load_settings('CTagsAutoComplete.sublime-settings')class CTagsAutoComplete(sublime_plugin.EventListener):def on_query_completions(self, view, prefix, locations):if is_disabled_in(view.scope_name(locations[0])):return []results = []ctags_paths = [folder + '\.tags' for folder in view.window().folders()]ctags_rows = []for ctags_path in ctags_paths:if not is_file_exist(view, ctags_path):return []ctags_path = str(ctags_path)ctags_file = open(ctags_path, encoding = 'utf-8')ctags_rows += ctags_file.readlines()ctags_file.close()for rows in ctags_rows:target = re.findall('^' + prefix + '.*', rows)if target:matched = re.split('\t', str(target[0]))trigger = matched[0]trigger += '\t(%s)' % 'CTags'contents = re.findall(prefix + '[0-9a-zA-Z_]*\(.*\)', str(matched[2]))if (len(matched) > 1 and contents):results.append((trigger, contents[0]))results = list(set(results))results.sort()return (results, sublime.INHIBIT_WORD_COMPLETIONS | sublime.INHIBIT_EXPLICIT_COMPLETIONS)def is_disabled_in(scope):excluded_scopes = settings.get("exclude_from_completion", [])for excluded_scope in excluded_scopes:if scope.find(excluded_scope) != -1:return Truereturn Falsedef is_file_exist(view, file):if (not view.window().folders() or not os.path.exists(file)):return Falsereturn Trueplugin_loaded()
之后我會(huì)把這個(gè)插件整合好后，上傳到 Package Control 上，從而方便更多人使用。通過(guò)這次入門(mén)，我嘗到了甜頭，未來(lái)的開(kāi)發(fā)過(guò)程中，可能會(huì)出現(xiàn)各種各樣獨(dú)特的需求，如果已有的插件無(wú)法提供幫助，那就自己上吧。
