visual.go RawHistoryFolder

1package term
2
3import "strconv"
4
5const (
6	altScreenEnter        = "\x1b[?1049h"
7	altScreenExit         = "\x1b[?1049l"
8	cursorHide            = "\x1b[?25l"
9	cursorShow            = "\x1b[?25h"
10	cursorStyleDefault    = "\x1b[0 q"
11	mouseEnable           = "\x1b[?1002h\x1b[?1006h"
12	mouseDisable          = "\x1b[?1002l\x1b[?1006l"
13	bracketedPasteEnable  = "\x1b[?2004h"
14	bracketedPasteDisable = "\x1b[?2004l"
15	colorSchemeEnable     = "\x1b[?2031h"
16	colorSchemeDisable    = "\x1b[?2031l"
17	focusReportEnable     = "\x1b[?1004h"
18	focusReportDisable    = "\x1b[?1004l"
19	autowrapDisable       = "\x1b[?7l"
20	autowrapEnable        = "\x1b[?7h"
21	kittyKeyboardPop      = "\x1b[<u"
22)
23
24const visualEnter = altScreenEnter + autowrapDisable + cursorHide + mouseEnable + bracketedPasteEnable + colorSchemeEnable + focusReportEnable
25
26const visualRestore = cursorShow + cursorStyleDefault + mouseDisable +
27	bracketedPasteDisable + colorSchemeDisable + focusReportDisable + autowrapEnable + altScreenExit
28
29// VisualEnterSequence returns a fresh copy of the visual initialization used
30// after acquiring a terminal. It intentionally excludes OS raw-mode setup.
31func VisualEnterSequence() []byte { return []byte(visualEnter) }
32
33// VisualRestoreSequence returns a fresh copy of the idempotent visual cleanup.
34func VisualRestoreSequence() []byte { return []byte(visualRestore) }
35
36// KittyKeyboardPushSequence pushes kitty keyboard protocol flags. Send it
37// after VisualEnterSequence so it lands on the alternate screen's stack.
38func KittyKeyboardPushSequence(flags int) []byte {
39	return []byte("\x1b[>" + strconv.Itoa(flags) + "u")
40}
41
42// VisualRestoreSequenceWithKittyKeyboard pops the kitty keyboard flags pushed
43// on the alternate screen before running the visual cleanup, so the main
44// screen's keyboard mode is left as it was.
45func VisualRestoreSequenceWithKittyKeyboard() []byte {
46	return []byte(kittyKeyboardPop + visualRestore)
47}