Sublime Text进阶（二） API的使用：TextCom

2017-09-30 本文已影响68人 yongaliang

前言

在(一)中我们使用了 WindowCommand Class 里面的window.run_command去批量执行了一堆命令,
在很长一段时间里都满足了我的使用需求.比如批量预处理一些日志,预处理一些繁琐但是工作内容固定的任务.
类似下面

import sublime
import sublime_plugin

class UsEditCommand(sublime_plugin.WindowCommand):
    def run(self, reverse=False):
        window = self.window
        window.run_command("show_panel", {"panel": "find"})#打开查找面板
        window.run_command("insert", {"characters": "[\(\)\{\}\$\^\-]"})#输入字符串[\(\)\{\}\$\^\-]
        window.run_command("hide_panel",{"cancel":"true"})#关掉查找面板
        window.run_command("find_all", {"characters": "n"})#查找所有符合的内容
        window.run_command("left_delete")#左删除
#在Key Bindings 里面添加快捷键
#{ "keys": ["f5"], "command": "us_edit" }

上面代码所做的工作其实是查找出所有 (){}$^- 这些符号删掉,这里是输入了一个正则表达式,而我们操作的时候,是需要先打开启用正则表达式开关的,(因为没有打开、关闭正则表达式的command)如果没有打开的话,其实是在查找符合的字符串然后删掉的,也就不符合我们的场景需求,即没有效果了.

此外使用 window.run_command 去做一个批处理的操作还有一些其他的缺陷

只能按照固定命令执行,无法添加逻辑判断等,不能处理一些复杂的文字处理
如果使用到查找功能,需要手工开启/关闭正则表达式功能
如果执行了不是我们想要的效果,撤退需要撤退多次(类似于你自己操作了那么多步骤,所以撤退还是要按多次的)
虽然有大部分command,但还是不足够我们使用

此篇文章介绍一下Sublime Text API 里面的Sublime.view 和TextCommand,已经如何使用view 来创建一些自定义的Command.

sublime.View

TextCommand里面的View提供了更多操纵视图的方法,如内容的新增、修改、替换和光标的一些操作等.
那么如何使用view呢？我们先在User目录下面先新建一个py文件

TestView.py

import sublime
import sublime_plugin
class TestViewCommand(sublime_plugin.TextCommand):
    def run(self,edit):
        view = self.view
        point =  view.sel()[0].begin()
        view.insert(edit,point,"hello Sublime Text")
#{ "keys": ["f5"], "command": "test_view" },

上面代码的执行效果是在你的当前视图的第一个光标所在位置插入了 "hello Sublime Text" 内容.观察可以发现与上一章不一样的是现在这里引用了TextCommand 替换了WindowCommand 且 run()里面添加多了一个edit参数. edit 是TextCommand里面的一个对象,view里面对内容操作的一些方法需要使用到TextCommand 的edit对象才可以编辑.

view相当于我们获取当前所在的sublime的窗口的视图,获取了该视图才能对里面的内容做操作.

view一些常用的方法

    view.file_name()#获取当前视图的文件名(包含文件路径)
    view.run_command()#等价于window.run_command()
    view.substr(region)#获取此region区域的内容
    view.substr(point)#获取此point区域的内容
    view.insert(edit, point, string)#在此point上插入字符串string
    view.replace(edit, region, string)#替换region上的内容为string
    view.sel()#获取当前光标所在的region,返回region的数组Selection.(因为光标可以多选)
    view.line(point)#获取此point的所在行的region
    view.find(pattern, start_point, <flags>)#查找符合正则表达式pattern的内容所在的Region,从start_point开始查找,返回第一个符合的Region
    view.find_all(pattern, <flags>, <format>, <extractions>)#同上,返回所有符合的Region

解释view里面参数的含义

point = x 表示一个整数,表示一个位置,从文本开头计算,第一个为0,一个任意字符占用一个位置
reigon =(x,y) 表示一个区域,两个point指间的内容,表示第x个字符到第y个字符指间的区域
selection = [(x,y),(x1,y1),(x2,y2)],表示一组区域,如在多行编辑的时候 view.sel()就返回一组region

如果对point,region,selection有不太理解的话
可以试试下面代码自己动手操作试试输出是什么,更容易理解

import sublime
import sublime_plugin
class HelloWorldCommand(sublime_plugin.TextCommand):
    def run(self, edit):
        view = self.view
        selection = view.sel()
        if selection:
            print("selection = ",selection)#输出Selection 对象 到console 面板
            for region in selection:
                print("region = ",region)#输出region
                print("begin point = ",region.begin())#输出region的第一个point

        str = view.substr(selection[0])#获取第一个光标选中的内容
        print("str = ",str)
        #输出当前文件的路径到光标位置上
        path = view.file_name()#获取文件名(包含路径)
        point =  view.sel()[0].begin()#获取当前视图第一个光标region的第一个位置
        view.insert(edit,point,path)#在此point上输出file_name
#{ "keys": ["f5"], "command": "hello_world" },

一些例子

有时候我们经常需要获取当前文件目录,那么可以使用下面代码

import re
import sublime
import sublime_plugin
class GetPathCommand(sublime_plugin.TextCommand):
    def run(self, edit):
        view = self.view
        def getpath():
            pattern = re.compile(r"\\[\w._-]+$")
            return re.sub(pattern, '', view.file_name())
        view.insert(edit,view.sel()[0].begin(),getpath())
#{ "keys": ["f5"], "command": "get_path" },
#改写一下可以讲路径存到剪贴板,可以当作练习

image

对选中的内容中,替换为首字母大写

import sublime
import sublime_plugin
class CamelCaseCommand(sublime_plugin.TextCommand):
    def run(self, edit):
        view = self.view
        selection = view.sel()
        for region in selection:
            str = view.substr(region)
            str = str.title()
            view.replace(edit,region,str)
#{ "keys": ["f5"], "command": "camel_case" },

image

在多个光标下输入递增数字

import sublime
import sublime_plugin
class MultiNumberCommand(sublime_plugin.TextCommand):
    def run(self, edit):
        view = self.view
        selection = view.sel()
        for i in range(0,len(selection)):
            view.insert(edit,selection[i].begin(),str(i))
#{ "keys": ["f5"], "command": "multi_number" },

image

此篇文章需要有一定python的基础知识,python的基础语法也不会太难,花几个小时基本上就可以学会,我本人也不是学python的.有兴趣的小伙伴可以周末花个半天学学python的基础语法,再研究一下sublime Text的API,就可以写一些自己想要的command了.

如果有帮助,请帮忙点喜欢,谢谢！

Sublime Text进阶（二） API的使用：TextCom

前言

sublime.View

一些例子

猜你喜欢

热点阅读