Shulou(Shulou.com)06/01 Report--

Editor to share with you how to use CTags to develop a Sublime Text code completion plug-in in linux, I believe most people do not know much about it, so share this article for your reference. I hope you will gain a lot after reading this article. Let's learn about it together.

Start writing new plug-ins

When I first came into contact with the writing of Sublime Text plug-ins, of course, I needed to understand the various interfaces provided by Sublime Text. To this end, I went to the official website of Sublime Text to find the relevant documentation: How to Create a Sublime Text Plugin, and Sublime Text Unofficial Documentation.

First, select "Tools-> Developer-> New Plugin" in Sublime Text to create a new basic plug-in document:

Import sublimeimport sublime_plugin class ExampleCommand (sublime_plugin.TextCommand): def run (self, edit): self.view.insert (edit, 0, "Hello, World!")

Sublime and sublime_plugin here are required modules for Sublime, and specific classes and methods can be found in the official API Reference.

Next, save this file to the CTagsAutoComplete folder (New) in the Package folder (one level above the default User folder) and name it CTagsAutoComplete.py. Although there is no restriction on naming, * * is uniformly named after the plug-in.

Then go back to Sublime Text, use the shortcut key Ctrl+ `to enter the Command Console of Sublime Text, and then enter view.run_command ('example'). If "Hello World" is displayed below, the plug-in has loaded normally.

The reason for using 'example', directly here is because the name of the Command command is split based on uppercase characters, and the ExampleCommand in the example can also be accessed as a' example_command', direct input 'example' in Command.

Terms in the text

Current window object of Window:Sublime Text

View objects open in the current window of View:Sublime Text

Interactive list opened by shortcut key Ctrl+Shift+P in Command Palette:Sublime Text

Determine the type of plug-in interface

There are three types of plug-in commands under Sublime Text (all from the sublime_plugin module):

TextCommand Class: provides access to the contents of the selected file / buffer through the View object.

WindowCommand Class: provides a reference to the current window through the Window object

ApplicationCommand Class: this class does not reference any specific windows or files / buffers, so it is rarely used

There are 2 types of event monitoring:

EventListener Class: listen for various events in Sublime Text and execute a command

ViewEventListener Class: a class that provides EventListener with similar event handling, but binds to a specific view.

Two input handlers:

TextInputHandler Class: can be used to accept text input in Command Palette.

ListInputHandler Class: can be used to accept select input from list items in Command Palette.

Because the function I want to implement is relatively simple, I only need to listen for input events and trigger autocomplete, so I need to use EventListener Class. The on_query_completions method is found under this class to handle commands that are executed when autocomplete is triggered. Then modify the code just now:

Import sublimeimport sublime_plugin class CTagsAutoComplete (sublime_plugin.EventListener): def on_query_completions (self, view, prefix, locations):

View: current view

Prefix: text entered when autocomplete is triggered

Locations: enter the location in the cache when autocomplete is triggered. You can use this parameter to determine the language to execute different commands.

Return type:

Return None

Return [["trigger\ t hint", "contents"]...], where\ t hint is optional, add a prompt to the name of the auto-completed function

Return (results, flag), where results is the list containing autocomplete statements, as above; flag is an additional parameter that can be used to control whether the autocomplete function included with Sublime Text is displayed.

Read CTags file

In order to read the .tag file, you must first determine whether the current project is open and whether the .tag file exists, and then read everything in the .tag file:

Import sublimeimport sublime_pluginimport osimport re class 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 False return True

By doing this, you can read the contents of all .tag files under the current project.

Analyze CTags files

The first is to get the lines in the .tags file that contain prefix:

For rows in ctags_rows: target = re.findall ('^'+ prefix +'. *', rows)

Once found, the line of data is processed by a regular expression:

If target: matched = re.split ('\ tfight, str (target [0])) trigger = matched [0] # returned * parameters Function name trigger + ='\ t (% s)'% 'CTags' # appends the function name with the second parameter returned by the identification' CTags' contents = re.findall (prefix +'[0-9amurzAmurz] *\ (. *\)', str (matched [2])) Specific definition of function if (len (matched) > 1 and contents): results.append ((trigger, contents [0])) results = list (set (results)) # remove duplicate function results.sort () # sort

After processing, you can return. Considering that * only displays functions in .tags, I do not need to display the autocomplete feature that comes with Sublime Text (extracting variables and functions from the current page), so my return result is as follows:

Return (results, sublime.INHIBIT_WORD_COMPLETIONS | sublime.INHIBIT_EXPLICIT_COMPLETIONS) add configuration file

Considering that the plug-in function can be turned off, you need to add a configuration file to specify the language in which the plug-in feature is not enabled. Here I refer to the code of "All AutoComplete":

Def plugin_loaded (): global settings settings = 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 True return False if is_disabled_in (view.scope_name (locations [0)): return []

The configuration file used here needs to be added to the folder where the plug-in is located, named CTagsAutoComplete.sublime-settings, and its contents are:

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

Once you have the configuration file, you also need to add the appropriate settings under "Preferences-> Package settings" in Sublime Text, which is also placed in the folder where the plug-in is located, named 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"}] these are all the contents of the article "how to use CTags to develop a Sublime Text Code completion plug-in in linux" Thank you for reading! I believe we all have a certain understanding, hope to share the content to help you, if you want to learn more knowledge, welcome to follow the industry information channel!

Welcome to subscribe "Shulou Technology Information " to get latest news, interesting things and hot topics in the IT industry, and controls the hottest and latest Internet news, technology news and IT industry trends.