利用 CTags 開發一個 Sublime Text 程式碼補完外掛

這裡用到的配置檔案需要新增到外掛所在的檔案夾中，名稱為 CTagsAutoComplete.sublime-settings，其內容為：

{
    // An array of syntax names to exclude from being autocompleted.
    "exclude_from_completion": [
        "css",
        "html"
    ]
}

新增設定檔案

有了配置檔案，還需要在 Sublime Text 的 “Preferences -> Package settings” 下新增相應的設定，同樣也是放在外掛所在檔案夾中，名稱為 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"
                            }
                        ]
                    }
                ]
            }
        ]
    }
]

總結

首先給出外掛的完整原始碼：

import sublime
import sublime_plugin
import os
import re
def plugin_loaded():
    global settings
    settings = 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 True
    return False
def is_file_exist(view, file):
    if (not view.window().folders() or not os.path.exists(file)):
        return False
    return True
plugin_loaded()