plugin.py

from __future__ import annotations
from contextlib import contextmanager
from functools import lru_cache
from itertools import chain, tee
import operator as op
from pathlib import Path
import string
from string import Template

import sublime
import sublime_plugin


from typing import Iterable, Iterator, NamedTuple, Sequence, TypeVar
from typing_extensions import TypeAlias
T = TypeVar("T")
flatten = chain.from_iterable
word_separators = string.punctuation + string.whitespace


class LineSpan(NamedTuple):
    start: int
    end: int

    @classmethod
    def from_region(cls, view: sublime.View, region: sublime.Region) -> LineSpan:
        return cls(
            view.rowcol(region.begin())[0],
            view.rowcol(region.end())[0]
        )


class TextRange(NamedTuple):
    text: str
    region: sublime.Region

    @classmethod
    def from_region(cls, view: sublime.View, region: sublime.Region) -> TextRange:
        return cls(view.substr(region), region)


ViewportPosition: TypeAlias = "tuple[float, float]"
PickableSelection: TypeAlias = "list[tuple[int, int]]"
ViewState: TypeAlias = "tuple[ViewportPosition, PickableSelection]"

OBSERVER_KEY = "83112d45-8bc5-478d-923c-450bc49e81bd"
SETTINGS_FILE = "InlineOutline.sublime-settings"
SUBTLE_MATCH_HIGHLIGHTING = True


def view_state(view: sublime.View) -> ViewState:
    return (
        view.viewport_position(),
        [s.to_tuple() for s in view.sel()]
    )


def plugin_loaded() -> None:
    plugin_settings = sublime.load_settings(SETTINGS_FILE)
    plugin_settings.add_on_change(OBSERVER_KEY, settings_changed)
    settings_changed()


def plugin_unloaded() -> None:
    plugin_settings = sublime.load_settings(SETTINGS_FILE)
    plugin_settings.clear_on_change(OBSERVER_KEY)


def settings_changed() -> None:
    plugin_settings = sublime.load_settings(SETTINGS_FILE)
    chord = plugin_settings.get("bind")
    write_key_bindings(chord)

    global SUBTLE_MATCH_HIGHLIGHTING
    SUBTLE_MATCH_HIGHLIGHTING = plugin_settings.get("subtle_match_highlighting", True)


@lru_cache(maxsize=1)
def write_key_bindings(chord: str | list[str]):
    pp = Path(sublime.packages_path())
    package = "InlineOutline"
    fpath = pp / package

    if chord:
        if isinstance(chord, str):
            chord = [chord]
        chord_ = "[{}]".format(", ".join(f'"{key}"' for key in chord))
        template = sublime.load_resource(str(
            Path("Packages") / package / "keymap-template.yaml"
        )).replace("\r", "")
        keymap = Template(template).substitute(main_key=chord_)

        fpath.mkdir(exist_ok=True)
        (fpath / "Default.sublime-keymap").write_text(keymap)

    else:
        fpath = pp / package
        (fpath / "Default.sublime-keymap").unlink(missing_ok=True)
        if not list(fpath.glob("*")):
            fpath.rmdir()


class OutlineModeQueryContext(sublime_plugin.EventListener):
    def on_query_context(
        self,
        view: sublime.View,
        key: str,
        operator,
        operand,
        match_all: bool
    ) -> bool | None:
        if key == "outline_mode":
            if operator not in (sublime.OP_EQUAL, sublime.OP_NOT_EQUAL):
                print(f"Context '{key}' only supports operator 'equal' and 'not_equal'.")
                return False

            if operand not in (True, False):
                print(f"Context '{key}' only supports operand 'true' and 'false'.")
                return False

            return (op.eq if operator == sublime.OP_EQUAL else op.ne)(
                (
                    bool(view.folded_regions())
                    and view.settings().get("outline_mode")
                ),
                operand
            )

        return None


class enter_outline_mode(sublime_plugin.TextCommand):
    def run(self, edit: sublime.Edit, enter_search: str | bool = False) -> None:
        view = self.view
        symbols = symbol_regions(view)
        if not symbols:
            flash(view, "This view defines no symbols.")
            return

        frozen_sel = [s for s in view.sel()]
        sel = frozen_sel[0]
        caret = sel.begin()
        view_size = view.size()
        next_non_empty_line = TextRange.from_region(view, view.full_line(caret))
        while True:
            if next_non_empty_line.text.strip() or next_non_empty_line.region.end() >= view_size:
                break
            next_non_empty_line = TextRange.from_region(view, view.full_line(next_non_empty_line.region.end()))

        original_view_state = view_state(view)
        focus_regions(view, [s.region for s in symbols])
        _, y = view.viewport_position()
        view.set_viewport_position((0, y))

        row, _ = view.rowcol(next_non_empty_line.region.a)
        nearest_region = next(
            (
                s.region
                for s in reversed(symbols)
                if view.rowcol(s.region.a)[0] <= row
            ),
            symbols[0].region
        )
        set_sel(view, [flip_region(nearest_region)])
        view.settings().set("outline_mode", True)
        view.settings().set("original_view_state", original_view_state)

        if enter_search:
            self.view.run_command("outline_enter_search", (
                {"initial_text": enter_search}
                if isinstance(enter_search, str)
                else {}
            ))


class abort_outline_mode(sublime_plugin.TextCommand):
    def run(self, edit: sublime.Edit) -> None:
        view = self.view

        original_view_state: ViewState | None
        original_view_state = view.settings().get("original_view_state")
        view.run_command("exit_outline_mode")
        if original_view_state:
            apply_view_state(view, original_view_state)

        if (window := view.window()) and PANELS.get(window):
            window.run_command("hide_panel", {"cancel": True})


def apply_view_state(view: sublime.View, state: ViewState) -> None:
    viewport_position, _sel = state
    frozen_sel = [
        sublime.Region(*s)
        for s
        in _sel
    ]
    set_sel(view, frozen_sel)
    view.set_viewport_position(viewport_position)


class exit_outline_mode(sublime_plugin.TextCommand):
    def run(self, edit: sublime.Edit) -> None:
        view = self.view

        view.run_command("fixed_unfold_all")
        view.settings().erase("outline_mode")
        view.settings().erase("original_view_state")

        if (window := view.window()) and PANELS.get(window):
            window.run_command("hide_panel", {"cancel": True})


class fixed_unfold_all(sublime_plugin.TextCommand):
    def run(self, edit):
        view = self.view
        with stable_viewport(view):
            view.run_command("unfold_all")


@contextmanager
def stable_viewport(view):
    frozen_sel = [s for s in view.sel()]
    sel = frozen_sel[0]
    caret = sel.begin()

    offset = y_offset(view, caret)
    yield
    apply_offset(view, caret, offset)


def y_offset(view, cursor):
    # type: (sublime.View, int) -> float
    _, cy = view.text_to_layout(cursor)
    _, vy = view.viewport_position()
    return cy - vy


def apply_offset(view: sublime.View, cursor: int, offset: float) -> None:
    _, cy = view.text_to_layout(cursor)
    vy = cy - offset
    vx, _ = view.viewport_position()
    view.set_viewport_position((vx, vy), animate=False)


def focus_regions(
    view: sublime.View,
    regions: Iterable[sublime.Region],
    context: int = 0
) -> None:
    selected_row_spans = list(
        LineSpan.from_region(view, r)
        for r in sorted(regions, key=lambda r: r.begin())
    )
    # print("selected_row_spans", selected_row_spans)

    last_row_of_view = view.rowcol(view.size())[0]

    line_spans_to_fold = list(
        LineSpan(a_end + context, b.start - context)
        for a, b in pairwise(chain(
            [LineSpan(0 - context, 0 - context)],
            selected_row_spans,
            [LineSpan(last_row_of_view + context, last_row_of_view + context)]
        ))
        if (a_end := a.end + 1) or True
        if (b.start - a_end) > 2 * context
        # if (print(a, b) or True)
    )
    # print("line_spans_to_fold", line_spans_to_fold)
    regions_to_fold = [
        sublime.Region(
            view.text_point(start, 0) - (1 if context == 0 else 0),
            view.text_point(end, 0) - 1
        )
        for start, end in line_spans_to_fold
    ]
    # print("regions_to_fold", regions_to_fold)
    view.run_command("unfold_all")
    view.fold(regions_to_fold)
    view.show(view.sel())


class outline_next_symbol2(sublime_plugin.WindowCommand):
    def run(self, pagewise=False):
        window = self.window
        for view in visible_views(window):
            if view.settings().get("outline_mode"):
                view.run_command("outline_next_symbol", {"pagewise": pagewise})
                return


class outline_prev_symbol2(sublime_plugin.WindowCommand):
    def run(self, pagewise=False):
        window = self.window
        for view in visible_views(window):
            if view.settings().get("outline_mode"):
                view.run_command("outline_prev_symbol", {"pagewise": pagewise})
                return


def visible_views(window: sublime.Window) -> Iterator[sublime.View]:
    num_groups = window.num_groups()
    for group_id in range(num_groups):
        if (view := window.active_view_in_group(group_id)):
            yield view


class outline_next_symbol(sublime_plugin.TextCommand):
    def run(self, edit, pagewise=False):
        # type: (sublime.Edit, bool) -> None
        view = self.view
        if pagewise:
            view.run_command("move", {"by": "pages", "forward": True})
            view.run_command("move_to", {"to": "eol", "extend": False})
            view.run_command("outline_prev_symbol")
            return

        frozen_sel = [s for s in view.sel()]
        sel = frozen_sel[0]
        pt = sel.end()
        folded_regions = view.folded_regions()
        for s in symbol_regions(view):
            if any(s.region in region for region in folded_regions):
                continue
            if s.region.begin() > pt:
                break
        else:
            return
        set_sel(view, [flip_region(s.region)])
        view.show(s.region, show_surrounds=False)


class outline_prev_symbol(sublime_plugin.TextCommand):
    def run(self, edit, pagewise=False):
        # type: (sublime.Edit, bool) -> None
        view = self.view
        if pagewise:
            view.run_command("move", {"by": "pages", "forward": False})
            view.run_command("move_to", {"to": "bol", "extend": False})
            view.run_command("outline_next_symbol")
            return

        frozen_sel = [s for s in view.sel()]
        sel = frozen_sel[0]
        pt = sel.begin()
        folded_regions = view.folded_regions()
        for s in reversed(symbol_regions(view)):
            if any(s.region in region for region in folded_regions):
                continue
            if s.region.end() < pt:
                break
        else:
            return
        set_sel(view, [flip_region(s.region)])
        view.show(s.region, show_surrounds=False)


PANELS: dict[sublime.Window, sublime.View] = {}


class outline_enter_search(sublime_plugin.TextCommand):
    def run(self, edit: sublime.Edit, initial_text: str = "") -> None:
        view = self.view
        window = view.window()
        if not window:
            return
        if panel := PANELS.get(window):
            window.focus_view(panel)
            return

        original_view_state = view_state(view)
        folded_regions = view.folded_regions()
        if not folded_regions:
            return

        def restore_initial_state():
            view.run_command("fixed_unfold_all")
            view.fold(folded_regions)
            apply_view_state(view, original_view_state)
            view.add_regions("matched_chars", [])

        def on_done(term: str) -> None:
            PANELS.pop(window, None)
            view.add_regions("matched_chars", [])
            view.run_command("exit_outline_mode")
            view.show(view.sel())

        def on_change(term: str) -> None:
            if not term:
                restore_initial_state()
                return

            symbols = symbol_regions(view)
            lines = [
                TextRange.from_region(view, view.line(s.region))
                for s in symbols
            ]
            matches = fuzzyfind(term, lines)
            focus_regions(view, [
                line.region
                for line, positions in matches
            ])

            regions_per_line: list[list[sublime.Region]] = [
                combine_adjacent_regions(
                    sublime.Region(p + line.region.a, p + line.region.a + 1)
                    for p in sorted(positions)
                )
                for line, positions in matches
                if positions
            ]

            view.add_regions(
                "matched_chars",
                list(flatten(regions_per_line)),
                scope="region.bluish",
                flags=(
                    64
                    | (
                        sublime.DRAW_SOLID_UNDERLINE | sublime.DRAW_NO_OUTLINE
                        if SUBTLE_MATCH_HIGHLIGHTING else
                        0
                    )
                    | sublime.RegionFlags.DRAW_NO_FILL
                    | sublime.RegionFlags.NO_UNDO
                ),
            )

            if regions_per_line:
                best_match = regions_per_line[0]
                set_sel(view, [sublime.Region(best_match[0].a, best_match[-1].b)])

        def on_cancel() -> None:
            PANELS.pop(window, None)
            view.add_regions("matched_chars", [])
            if view.settings().get("outline_mode") and view.folded_regions():
                view.run_command("abort_outline_mode")

        panel = window.show_input_panel(
            "",
            initial_text,
            on_done=on_done,
            on_change=on_change,
            on_cancel=on_cancel,
        )
        PANELS[window] = panel
        panel.settings().set("outline_mode_search_panel", True)


debug_info: list[tuple[str, tuple, str]] = []


def fuzzyfind(primer: str, collection: Iterable[TextRange]) -> list[tuple[TextRange, list[int]]]:
    """
    Fuzzy match a primer, e.g. a search term, against the items in collection.
    """
    global debug_info
    debug_info = []
    suggestions = []
    for item in collection:
        if score := fuzzy_score(primer, item.text):
            suggestions.append((score, item))

    # print("\n-", primer)
    # for resolution__, score__, matched_item__ in sorted(debug_info, key=lambda x: x[1]):
    #     print(f"{resolution__:<6} {score__[0]:>4.1f} {' '.join(map(str, score__[1:])):<50} {matched_item__}")
    return [(item, positions) for (_, positions), item in sorted(suggestions)]


def fuzzy_score(primer: str, item: str) -> tuple[float, list[int]] | None:
    item_l = item.lower()
    primer_l = primer.lower()
    pos, score = -1, 0.0
    positions = []
    scores = []
    for idx in range(len(primer)):
        try:
            pos, _score = find_char(primer, primer_l, idx, item, item_l, pos + 1)
        except ValueError:
            return None

        positions.append(pos)
        scores.append(_score)

        score += _score
        if score > 5:
            shift = positions[0] + 1
            if scores[0] <= 0 and shift < len(item):
                # print(f"recurse. matching {primer!r} with {item!r} scored already {score}", positions, scores)
                if (r := fuzzy_score(primer, item[shift:])):
                    return (r[0], [p + shift for p in r[1]])
            debug_info.append(("reject", (score, positions, scores), item))
            return None

    debug_info.append(("match", (score, positions, scores), item))
    return (score, positions)


def find_char(
    primer: str, primer_l: str, cur_pos_in_primer: int,
    item: str, item_l: str, cur_pos_in_item: int
) -> tuple[int, float]:
    pos, score_ = find_char_(primer_l[cur_pos_in_primer:], item, item_l, cur_pos_in_item)

    score = 2 * score_
    if score_ <= 0 and primer[cur_pos_in_primer] == item[pos]:
        score -= 0.5 if primer[cur_pos_in_primer] == primer_l[cur_pos_in_primer] else 2
    return pos, score


def find_char_(primer_rest: str, item: str, item_l: str, start: int) -> tuple[int, float]:
    prev = ""
    first_seen = -1
    needle = primer_rest[0]
    separators_seen = 0
    for idx, ch in enumerate(item[start:], start):
        # We give a penalty whenever we cross a non-word char.
        # That is necessary because `item` is not a token
        # here but a full line.  Matches across tokens are unlikely
        # to be intended.
        # But keep in mind search terms like "class diff" where
        # "class" is only meant to restrict the results.
        if ch in word_separators:
            separators_seen += 1 if ch in "_-" else 10

        if needle == ch.lower():
            if idx != start and not prev:
                raise RuntimeError(f"assertion failed: `prev` should be truthy but is '{prev}'")

            # consecutive letters/matches don't get a penalty,
            # so do jumps to word boundaries
            if idx == start or prev in word_separators or (ch.isupper() and prev.islower()):
                return idx, (
                    -1 if start == 0 else  # initial wide jump to a boundary
                    0 + (separators_seen / 10)
                )
            if first_seen == -1:
                first_seen = idx
        prev = ch

    # try a *reverse* lookup if needle can't be found
    if first_seen == -1:
        if (
            start > 1
            and (pos := item_l.rfind(needle, 0, start - 1)) != -1
        ):
            return pos, start - 1 - pos
        raise ValueError(f"can't match {primer_rest!r} with {item!r}")

    # a jump to a complete suffix match does not get the full penalty
    if item.endswith(primer_rest):
        return len(item) - len(primer_rest), 1

    return first_seen, (
        first_seen - (start - 1)  # typically the penalty is the distance we have to jump
        if start > 0 else
        1                         # except for an initial jump
    )


def flip_region(region: sublime.Region) -> sublime.Region:
    return sublime.Region(region.b, region.a)


def set_sel(view: sublime.View, selection: Sequence[sublime.Region | sublime.Point]) -> None:
    sel = view.sel()
    sel.clear()
    sel.add_all(selection)


def flash(view: sublime.View, message: str):
    window = view.window()
    if window:
        window.status_message(message)


def combine_adjacent_regions(regions: Iterable[sublime.Region]) -> list[sublime.Region]:
    prev = None
    rv = []
    for r in regions:
        if prev is None or prev.b != r.a:
            rv.append(r)
            prev = r
        else:
            prev.b = r.b
    return rv


def pairwise(iterable: Iterable[T]) -> Iterable[tuple[T, T]]:
    "s -> (s0,s1), (s1,s2), (s2, s3), ..."
    a, b = tee(iterable)
    next(b, None)
    return zip(a, b)


def symbol_regions(view: sublime.View) -> list[sublime.SymbolRegion]:
    return _symbol_regions(view, view.change_count())


@lru_cache(maxsize=16)
def _symbol_regions(view: sublime.View, _cc: int) -> list[sublime.SymbolRegion]:
    return view.symbol_regions()
    rv = view.symbol_regions()
    for s in rv:
        if s.name.endswith("\n"):
            s.name = s.name.rstrip("\n")
            s.region.b = s.region.a + len(s.name)
    return rv