readline.go 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287
  1. package readline
  2. import (
  3. "bufio"
  4. "fmt"
  5. "io"
  6. "os"
  7. )
  8. type Prompt struct {
  9. Prompt string
  10. AltPrompt string
  11. Placeholder string
  12. AltPlaceholder string
  13. UseAlt bool
  14. }
  15. func (p *Prompt) prompt() string {
  16. if p.UseAlt {
  17. return p.AltPrompt
  18. }
  19. return p.Prompt
  20. }
  21. func (p *Prompt) placeholder() string {
  22. if p.UseAlt {
  23. return p.AltPlaceholder
  24. }
  25. return p.Placeholder
  26. }
  27. type Terminal struct {
  28. outchan chan rune
  29. rawmode bool
  30. termios any
  31. }
  32. type Instance struct {
  33. Prompt *Prompt
  34. Terminal *Terminal
  35. History *History
  36. Pasting bool
  37. }
  38. func New(prompt Prompt) (*Instance, error) {
  39. term, err := NewTerminal()
  40. if err != nil {
  41. return nil, err
  42. }
  43. history, err := NewHistory()
  44. if err != nil {
  45. return nil, err
  46. }
  47. return &Instance{
  48. Prompt: &prompt,
  49. Terminal: term,
  50. History: history,
  51. }, nil
  52. }
  53. func (i *Instance) Readline() (string, error) {
  54. if !i.Terminal.rawmode {
  55. fd := os.Stdin.Fd()
  56. termios, err := SetRawMode(fd)
  57. if err != nil {
  58. return "", err
  59. }
  60. i.Terminal.rawmode = true
  61. i.Terminal.termios = termios
  62. }
  63. prompt := i.Prompt.prompt()
  64. if i.Pasting {
  65. // force alt prompt when pasting
  66. prompt = i.Prompt.AltPrompt
  67. }
  68. fmt.Print(prompt)
  69. defer func() {
  70. fd := os.Stdin.Fd()
  71. //nolint:errcheck
  72. UnsetRawMode(fd, i.Terminal.termios)
  73. i.Terminal.rawmode = false
  74. }()
  75. buf, _ := NewBuffer(i.Prompt)
  76. var esc bool
  77. var escex bool
  78. var metaDel bool
  79. var currentLineBuf []rune
  80. for {
  81. // don't show placeholder when pasting unless we're in multiline mode
  82. showPlaceholder := !i.Pasting || i.Prompt.UseAlt
  83. if buf.IsEmpty() && showPlaceholder {
  84. ph := i.Prompt.placeholder()
  85. fmt.Print(ColorGrey + ph + CursorLeftN(len(ph)) + ColorDefault)
  86. }
  87. r, err := i.Terminal.Read()
  88. if buf.IsEmpty() {
  89. fmt.Print(ClearToEOL)
  90. }
  91. if err != nil {
  92. return "", io.EOF
  93. }
  94. if escex {
  95. escex = false
  96. switch r {
  97. case KeyUp:
  98. if i.History.Pos > 0 {
  99. if i.History.Pos == i.History.Size() {
  100. currentLineBuf = []rune(buf.String())
  101. }
  102. buf.Replace([]rune(i.History.Prev()))
  103. }
  104. case KeyDown:
  105. if i.History.Pos < i.History.Size() {
  106. buf.Replace([]rune(i.History.Next()))
  107. if i.History.Pos == i.History.Size() {
  108. buf.Replace(currentLineBuf)
  109. }
  110. }
  111. case KeyLeft:
  112. buf.MoveLeft()
  113. case KeyRight:
  114. buf.MoveRight()
  115. case CharBracketedPaste:
  116. var code string
  117. for range 3 {
  118. r, err = i.Terminal.Read()
  119. if err != nil {
  120. return "", io.EOF
  121. }
  122. code += string(r)
  123. }
  124. if code == CharBracketedPasteStart {
  125. i.Pasting = true
  126. } else if code == CharBracketedPasteEnd {
  127. i.Pasting = false
  128. }
  129. case KeyDel:
  130. if buf.DisplaySize() > 0 {
  131. buf.Delete()
  132. }
  133. metaDel = true
  134. case MetaStart:
  135. buf.MoveToStart()
  136. case MetaEnd:
  137. buf.MoveToEnd()
  138. default:
  139. // skip any keys we don't know about
  140. continue
  141. }
  142. continue
  143. } else if esc {
  144. esc = false
  145. switch r {
  146. case 'b':
  147. buf.MoveLeftWord()
  148. case 'f':
  149. buf.MoveRightWord()
  150. case CharBackspace:
  151. buf.DeleteWord()
  152. case CharEscapeEx:
  153. escex = true
  154. }
  155. continue
  156. }
  157. switch r {
  158. case CharNull:
  159. continue
  160. case CharEsc:
  161. esc = true
  162. case CharInterrupt:
  163. return "", ErrInterrupt
  164. case CharLineStart:
  165. buf.MoveToStart()
  166. case CharLineEnd:
  167. buf.MoveToEnd()
  168. case CharBackward:
  169. buf.MoveLeft()
  170. case CharForward:
  171. buf.MoveRight()
  172. case CharBackspace, CharCtrlH:
  173. buf.Remove()
  174. case CharTab:
  175. // todo: convert back to real tabs
  176. for range 8 {
  177. buf.Add(' ')
  178. }
  179. case CharDelete:
  180. if buf.DisplaySize() > 0 {
  181. buf.Delete()
  182. } else {
  183. return "", io.EOF
  184. }
  185. case CharKill:
  186. buf.DeleteRemaining()
  187. case CharCtrlU:
  188. buf.DeleteBefore()
  189. case CharCtrlL:
  190. buf.ClearScreen()
  191. case CharCtrlW:
  192. buf.DeleteWord()
  193. case CharCtrlZ:
  194. fd := os.Stdin.Fd()
  195. return handleCharCtrlZ(fd, i.Terminal.termios)
  196. case CharEnter, CharCtrlJ:
  197. output := buf.String()
  198. if output != "" {
  199. i.History.Add(output)
  200. }
  201. buf.MoveToEnd()
  202. fmt.Println()
  203. return output, nil
  204. default:
  205. if metaDel {
  206. metaDel = false
  207. continue
  208. }
  209. if r >= CharSpace || r == CharEnter || r == CharCtrlJ {
  210. buf.Add(r)
  211. }
  212. }
  213. }
  214. }
  215. func (i *Instance) HistoryEnable() {
  216. i.History.Enabled = true
  217. }
  218. func (i *Instance) HistoryDisable() {
  219. i.History.Enabled = false
  220. }
  221. func NewTerminal() (*Terminal, error) {
  222. fd := os.Stdin.Fd()
  223. termios, err := SetRawMode(fd)
  224. if err != nil {
  225. return nil, err
  226. }
  227. t := &Terminal{
  228. outchan: make(chan rune),
  229. rawmode: true,
  230. termios: termios,
  231. }
  232. go t.ioloop()
  233. return t, nil
  234. }
  235. func (t *Terminal) ioloop() {
  236. buf := bufio.NewReader(os.Stdin)
  237. for {
  238. r, _, err := buf.ReadRune()
  239. if err != nil {
  240. close(t.outchan)
  241. break
  242. }
  243. t.outchan <- r
  244. }
  245. }
  246. func (t *Terminal) Read() (rune, error) {
  247. r, ok := <-t.outchan
  248. if !ok {
  249. return 0, io.EOF
  250. }
  251. return r, nil
  252. }