Files
vdiff/vdiff/state.py
Vaclav Tvrdik 8c174bc131 initial commit
2026-09-23 21:10:59 +02:00

91 lines
2.9 KiB
Python

""" Per-view state of review views, keyed by view id; the essentials are mirrored into view settings for restore """
from collections import namedtuple
# view setting marking a review view (keymap context "setting.vdiff_view")
VIEW_FLAG = "vdiff_view"
# view setting holding what the view shows, so a restored tab can re-render
VIEW_DATA = "vdiff"
# what a quick panel goes back to on Esc
Kept = namedtuple("Kept", "sha commit change files")
def find_change(files, path):
"""Index of the FileChange with `path`, or -1"""
for i, change in enumerate(files):
if change.path == path:
return i
return -1
class ViewState:
"""Everything a review view needs to re-render itself and act on its file
`sha` is None in working-tree mode and the reviewed commit's hash otherwise.
"""
def __init__(self, repo):
self.repo = repo
self.sha = None
self.commit = None # git.CommitInfo when sha is set
self.change = None # git.FileChange currently shown
self.files = [] # git.FileChange list the user is browsing (next/prev file)
self.lines = [] # parse.Line list currently rendered
self.blocks = [] # parse.change_blocks(lines)
self.binary = False
self.token = 0 # bumped per show request; a stale async result is dropped
self.rendered_token = -1 # token of the request that produced the current render
self.highlight = 0 # bumped per quick-panel highlight, to debounce previews
self.fingerprint = None # (file mtime, index mtime) at render time, working-tree mode
@property
def in_commit(self):
return self.sha is not None
def index(self):
"""Position of the shown file in `files`, or -1"""
return find_change(self.files, self.change.path) if self.change else -1
def kept(self):
return Kept(self.sha, self.commit, self.change, list(self.files))
def enter(self, sha=None, commit=None):
"""Switch to browsing a commit (or the working tree); returns what to restore on Esc"""
kept = self.kept()
if sha != self.sha:
self.change = None
self.sha, self.commit = sha, commit
return kept
def restore(self, kept):
self.sha, self.commit, self.change, self.files = kept
def persist(self, view):
"""Mirror the essentials into view settings (survives a restart)"""
data = {"repo": self.repo, "sha": self.sha}
if self.change:
data["path"] = self.change.path
data["status"] = self.change.status
data["staged"] = self.change.staged
view.settings().set(VIEW_DATA, data)
STATES = {}
def get(view):
return STATES.get(view.id())
def put(view, st):
STATES[view.id()] = st
return st
def drop(view):
STATES.pop(view.id(), None)
def is_review_view(view):
return bool(view and view.settings().get(VIEW_FLAG))