main.py

# -*- coding: utf-8 -*-
#
# @Author: CPS
# @email: 373704015@qq.com
# @Date:
# @Last Modified by: CPS
# @Last Modified time: 2021-04-12 03:25:48.660601
# @file_path "D:\CPS\IDE\JS_SublmieText\Data\Packages\CPS"
# @Filename "main.py"
# @Description: 功能描述
#

from typing import Optional, NewType
import sublime
import sublime_plugin
import os

from imp import reload

if int(sublime.version()) < 3176:
    raise ImportWarning("本插件不支持当前版本，请使用大于等于3176的sublime Text")

from .core import utils
from .core import comments_creator
from .core import helper

SETTING_FILE = "cps.sublime-settings"
SETTING_KEY = "comments_creator"
SETTINGS = {}

DEFAULT_INSERT_DIRECTION = {
    "mjs": "up",
    "js": "up",
    "ts": "up",
    "cjs": "up",
    "py": "down",
    "typescript": "up",
    "javascript": "up",
}

resLineTuple = NewType("tuple(currt_line:Region, currt_contents:str)", tuple)


def plugin_loaded():
    global SETTING_FILE, SETTING_KEY, SETTINGS

    SETTINGS = SettingManager(SETTING_KEY, SETTING_FILE)


class SettingManager:
    def __init__(self, setting_key: str, default_settings: str):
        self.setting_key = setting_key
        self.default_settings = default_settings
        self.default_settings_path = os.path.join(
            sublime.packages_path(), "cps-plugins", ".sublime", default_settings
        )

        self.data = {}

        sublime.set_timeout_async(self.plugin_loaded_async)

    def __getitem__(self, key: str, default={}):
        if key in self.data:
            return self.data.get(key, default)
        else:
            return {}

    def get(self, key: str, default={}):
        return self.__getitem__(key, default)

    def plugin_loaded_async(self):
        """
        @Description 监听用户配置文件
        """
        with open(self.default_settings_path, "r", encoding="utf8") as f:
            self.data = sublime.decode_value(f.read()).get(self.setting_key, {})

        # 读取现有配置
        user_settings = sublime.load_settings(self.default_settings)
        # 添加配置更新事件
        user_settings.add_on_change(self.default_settings, self._on_settings_change)
        # 将最新的配置更新到内部的data，最终以data为准
        utils.recursive_update(self.data, user_settings.to_dict()[self.setting_key])

    def _on_settings_change(self):
        new_settings = sublime.load_settings(self.default_settings).get(
            self.setting_key, {}
        )

        utils.recursive_update(self.data, new_settings)

        return self


class CpsCommentsCreatorReloadCommand(sublime_plugin.TextCommand):
    def run(self, edit: sublime.Edit) -> None:
        reload(comments_creator)
        print(f"{__package__} reloaded")


class CpsCommentsCreatorCommand(sublime_plugin.TextCommand):
    def run(self, edit: sublime.Edit):
        view = self.view

        # 获取配置
        global SETTINGS
        options = SETTINGS

        # 根据文件后缀名，配置对应的解析函数
        # 为了处理带多个.的文件名，使用切片反方向获取
        _, syntax = os.path.basename(view.file_name()).split(".")[-2:]

        # syntax = utils.check_stynax(self.view.file_name()) or utils.check_stynax(
        #     self.view.settings().get("syntax")
        # )

        print("syntax: ", syntax)

        if not syntax or not syntax in comments_creator.PARSER:
            return print("{}:: >>> 不支持的语法{}".format(__package__, syntax))

        # 默认模板兜底，使用用户模版更新
        syntax_tmpl = options.get("default_tmpl", {})
        if syntax in options.data:
            utils.recursive_update(syntax_tmpl, options[syntax])

        # 定义新注释的插入方向
        # py 是下方
        # js之类的是上方
        global DEFAULT_INSERT_DIRECTION
        insert_direction: str = (
            DEFAULT_INSERT_DIRECTION.get(syntax, None)
            or options.get("comments_direction")
            or syntax_tmpl.get("comments_direction", None)
        )
        print("syntax: ", syntax)

        print(
            "DEFAULT_INSERT_DIRECTION.get(syntax, None): ",
            DEFAULT_INSERT_DIRECTION.get(syntax, None),
        )
        print('options.get("comments_direction"): ', options.get("comments_direction"))
        print(
            'syntax_tmpl.get("comments_direction", None): ',
            syntax_tmpl.get("comments_direction", None),
        )

        print("insert_direction: ", insert_direction)

        # 需要查找的字符串，整行进行匹配
        currt_region, currt_line_contents = self.get_currt_line_str(insert_direction)
        if insert_direction == "down":
            insert_position = currt_region.b
        else:
            insert_position = self.get_pre_line_region(currt_region).b

        print("syntax_tmpl: ", syntax_tmpl)

        # 查找是否有旧的注释块块
        comments_begin: str = syntax_tmpl["comments_header"][0]  # 注释块的头部标识
        comments_end: str = syntax_tmpl["comments_header"][-1]  # 注释快的尾部标识

        old_comments = self.search_old_comments(
            currt_region,
            comments_begin,
            comments_end,
            search_direction=insert_direction,
        )

        # 匹配当前行
        # 实例化解释对象
        parser = comments_creator.PARSER[syntax]()
        if parser.match_line(currt_line_contents):
            # 如果存在旧的注释，尝试提取旧注释（旧注释内不能带空格，空格之后会被忽略）
            if old_comments:
                parser.set_old_comments(view.substr(old_comments))

            # 更新数据到注释模版内
            parser.format(syntax_tmpl)
            if old_comments:
                view.replace(edit, old_comments, parser.output_str)
            else:
                view.insert(edit, insert_position, parser.output_str)
        else:
            # 无法识别时，插入通用格式

            # 获取当前缩进类型
            currt_str = currt_line_contents
            indent = " " if view.settings().get("tab_size", None) else "\t"
            indent = (len(currt_str) - len(currt_str.lstrip())) * indent
            comments_str = "".join(
                [f"{indent}{line}\n" for line in syntax_tmpl["comments_header"]]
            )

            view.insert(edit, currt_region.a, comments_str)

    def get_currt_line_str(self, insert_direction: str) -> resLineTuple:
        """
        @Description 返回要查找的行的具体信息，要查找行的文本内容（完整）

        - param insert_direction :{str} 插入的方向

        @returns `{ resLineTuple}` {description}

        """
        view = self.view
        if helper.has_selection(view):
            currt_region = helper.get_currt_region_full_lines(view)
            currt_region_content = view.substr(currt_region)
            # print("范围获取", (currt_region.a, currt_region.b))

            # 根据最下方的坐标，获取注释最终插入的位置
            # 选择多行的情况下，无法正确的识别最后一行的位置
            # -1 确保多行中，最后一行位置的正确识别
            if insert_direction == "up":
                currt_cursor = currt_region.a
            else:
                currt_cursor = (
                    currt_region.a
                    if currt_region.a > currt_region.b
                    else currt_region.b - 1
                )
            currt_region = view.full_line(currt_cursor)
            currt_contents = helper.merge_line(currt_region_content)
        else:
            # print("非范围获取")

            currt_cursor = view.sel()[0].a
            currt_region = view.full_line(currt_cursor)
            currt_contents = view.substr(currt_region)

        return (currt_region, currt_contents)

    # 获取现有注释模块的内容
    def search_old_comments(
        self,
        line_region: sublime.Region,
        comment_begin: str,
        comment_end: str,
        search_direction: str = "up",
    ) -> sublime.Region:
        """
        @Description 给定一行范围，从该行，向下或者向上开始查找是否存在旧的注释块

        - param line_region         :{sublime.Region} 开始查找的行
        - param comment_begin       :{str}            注释块的开始标识，（py：三个"或者三个'）|（js：/**）等
        - param comment_end         :{str}            注释块的结束标识，（py：三个"或者三个'）|（js：*/）等
        - param search_direction=up :{str}            'down'|'up'查找的方向

        @returns `{ sublime.Region}` (start:int，end:int1)

        """

        begin = comment_begin.strip()
        end = comment_end.strip()

        # 根据查找方向，给定开始查找的行
        if search_direction == "down":
            # 获取下一行的位置
            find_region = self.get_next_line_region(line_region)
        else:
            # 获取前一行的位置
            find_region = self.get_pre_line_region(line_region)

        # 查找注释头标识： begin
        find_begin = self.find_str_by_line_region(
            find_region, begin, max_search_count=1, direction=search_direction
        )

        if not find_begin:
            return False

        # 查找注释尾标识： end
        find_region = self.get_next_line_region(find_begin)
        find_end = self.find_str_by_line_region(
            find_region, end, max_search_count=30, direction="down"
        )

        if not find_end:
            return False

        return sublime.Region(find_begin.a, find_end.b)

    def find_str_by_line_region(
        self,
        line_region: sublime.Region,
        find_str: str,
        max_search_count: int = 1,
        direction: str = "up",
    ) -> Optional[str]:
        """
        @Description 查找一个字符串，并返回其所在的位置1

        - param line_region        :{sublime.Region} 查找开始的位置
        - param find_str           :{str}            要查找的字符串
        - param max_search_count=1 :{int}            查找多少行，默认1
        - param direction=up       :{str}            查找的方向，一般js，ts往上，py往下等等


        """
        view = self.view
        search_count = 1
        while search_count <= max_search_count:
            currt_str = view.substr(line_region).strip()

            if currt_str.find(find_str) == 0:
                # 返回当前行尾
                return line_region
            else:
                if direction == "up":
                    # 向上查找
                    line_region = view.full_line(line_region.a - 1)
                else:
                    # 向下查找
                    line_region = view.full_line(line_region.b + 1)

            search_count += 1
        return False

    def get_next_line_region(self, line_region: sublime.Region) -> sublime.Region:
        """
        @Description 获取下一行Region

        - param line_region :{sublime.Region} sublime.Region是一个一维二元数组

        """
        return self.view.full_line(line_region.b + 1)

    def get_pre_line_region(self, line_region: sublime.Region) -> sublime.Region:
        """
        @Description 获取上一行Region

        - param line_region :{sublime.Region} sublime.Region是一个一维二元数组

        """
        return self.view.full_line(line_region.a - 1)