difftui

type File struct {
	Path string
	// Settled is a file a receipt covers at exactly its current content: read, and unmoved since.
	//
	// Folded by default for the same reason Generated is - it is not what the reader is here for -
	// but for a different reason, so it is a separate flag and a separate key. A generated file is
	// a machine's restatement of an edit made elsewhere; a settled file is one this reader already
	// weighed. Conflating them would fold a colleague's unreviewed generated file and a reader's
	// own finished work under one word.
	Settled   bool
	Generated bool
	Facts     []string
	Hunks     []Hunk
}

type Hunk struct {
	// NewStart is the hunk's first line on the new side, and Declaration is the enclosing
	// declaration git named in its header. Together they are what the heading row says, in place
	// of the raw @@ coordinates: where the reader is, and what they are inside of.
	NewStart    int
	Declaration string
	// Index is the hunk's position in the PATCH, which is the coordinate a comment and a
	// suggestion are anchored by (see changeset.Hunk.Index). Carried rather than taken from the
	// position in Hunks, so a caller that ever hands over a subset cannot silently renumber
	// every anchor in the file.
	Index  int
	Header string
	Lines  []string
	Digest string
	// Emph is, per line of Lines, which part of it changed - as byte offsets into the RAW
	// line, marker included, because that is what the renderer slices. Empty or short is fine
	// and means no emphasis, which is what a caller that does not compute it gets.
	//
	// Passed in rather than derived here, like Digest above and for the same reason: the
	// parser works it out once and both surfaces read the one answer.
	Emph []changeset.Span
}

type Input struct {
	Files    []File
	Unranked bool
	// Viewed carries the digests already marked read, from the session or the local store.
	Viewed      []string
	Comments    []types.DiffComment
	Suggestions []types.DiffSuggestion
	// Threads are the remarks already on the host's review, with Hunk resolved by
	// changeset.PlaceThreads. A thread whose line this changeset does not contain (Hunk < 0) renders
	// under the file heading rather than being dropped: a colleague said it, and a viewer that
	// silently withheld it would be telling the reader nobody had.
	Threads []types.ReviewThread
	// Unfolded starts with generated files expanded, which is what --generated asks for.
	Unfolded bool
	// Link decorates a path for display (an OSC 8 hyperlink). Nil renders it plain.
	Link func(string) string
}

type Model struct {
	// contains filtered or unexported fields
}

type Options struct {
	// In is read for keys and Out is drawn on. Both must be terminals; the caller has
	// already refused otherwise, and OpenInput refuses again rather than trusting that.
	In    *os.File
	Out   io.Writer
	Probe tty.Probe
	Input Input
	// Sync is nil when nothing is listening - no daemon, no console, no agent.
	Sync Sync
	// Summary is the one line left behind in the scrollback when the reader quits, so the
	// session records what was read rather than vanishing without a trace. It is called at that
	// moment and handed the fold the reader left in, because `.` changes what the line has to
	// describe. Nil leaves nothing behind.
	Summary func(unfolded bool) string
}

type OverviewRow struct {
	// Path is undecorated. The link, when there is one, is in Rendered.
	Path string
	// HunkCount rather than Hunks: File.Hunks in this same package is the hunks THEMSELVES, and
	// one name for two shapes reads as a copy of the slice at every use.
	HunkCount int
	Read      int
	Generated bool
	Rendered  string
}

type Row struct {
	Kind RowKind
	File int
	Hunk int
	// Thread is the host thread this row renders a line of, empty on every other row. It is
	// what lets the viewer report a remark as SHOWN once it has actually been drawn on screen,
	// rather than when the changeset was handed over.
	Thread string
	Text   string
	// Emph is which PART of Text changed, in BYTES of Text, on a RowLine that could be paired
	// with its counterpart. The zero span means there is nothing to draw harder than the rest -
	// the line has no partner, or the whole of it changed and the row color already says so.
	Emph changeset.Span
}

type RowKind int

type Sync interface {
	SetCursor(c types.DiffCursor)
	SetViewed(digest string, on bool)
	// SetThreadsSeen records that these of the host's review threads have been in front of the
	// reader, which is the watermark deciding what still counts as NEW. A workspace whose
	// watermark nobody ever advances is one the forge-watching job reads as never reviewed in,
	// and it then reports no colleague's remark at all - so a terminal reader has to write it
	// for the same reason a browser one does.
	SetThreadsSeen(ids []string)
}

type ViewedChange struct {
	Digest string
	On     bool
}