readline.go 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275
  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. for {
  80. // don't show placeholder when pasting unless we're in multiline mode
  81. showPlaceholder := !i.Pasting || i.Prompt.UseAlt
  82. if buf.IsEmpty() && showPlaceholder {
  83. ph := i.Prompt.placeholder()
  84. fmt.Print(ColorGrey + ph + CursorLeftN(len(ph)) + ColorDefault)
  85. }
  86. r, err := i.Terminal.Read()
  87. if buf.IsEmpty() {
  88. fmt.Print(ClearToEOL)
  89. }
  90. if err != nil {
  91. return "", io.EOF
  92. }
  93. if escex {
  94. escex = false
  95. switch r {
  96. case KeyUp:
  97. buf.Replace([]rune(i.History.Prev()))
  98. case KeyDown:
  99. buf.Replace([]rune(i.History.Next()))
  100. case KeyLeft:
  101. buf.MoveLeft()
  102. case KeyRight:
  103. buf.MoveRight()
  104. case CharBracketedPaste:
  105. var code string
  106. for range 3 {
  107. r, err = i.Terminal.Read()
  108. if err != nil {
  109. return "", io.EOF
  110. }
  111. code += string(r)
  112. }
  113. if code == CharBracketedPasteStart {
  114. i.Pasting = true
  115. } else if code == CharBracketedPasteEnd {
  116. i.Pasting = false
  117. }
  118. case KeyDel:
  119. if buf.DisplaySize() > 0 {
  120. buf.Delete()
  121. }
  122. metaDel = true
  123. case MetaStart:
  124. buf.MoveToStart()
  125. case MetaEnd:
  126. buf.MoveToEnd()
  127. default:
  128. // skip any keys we don't know about
  129. continue
  130. }
  131. continue
  132. } else if esc {
  133. esc = false
  134. switch r {
  135. case 'b':
  136. buf.MoveLeftWord()
  137. case 'f':
  138. buf.MoveRightWord()
  139. case CharBackspace:
  140. buf.DeleteWord()
  141. case CharEscapeEx:
  142. escex = true
  143. }
  144. continue
  145. }
  146. switch r {
  147. case CharNull:
  148. continue
  149. case CharEsc:
  150. esc = true
  151. case CharInterrupt:
  152. return "", ErrInterrupt
  153. case CharLineStart:
  154. buf.MoveToStart()
  155. case CharLineEnd:
  156. buf.MoveToEnd()
  157. case CharBackward:
  158. buf.MoveLeft()
  159. case CharForward:
  160. buf.MoveRight()
  161. case CharBackspace, CharCtrlH:
  162. buf.Remove()
  163. case CharTab:
  164. // todo: convert back to real tabs
  165. for range 8 {
  166. buf.Add(' ')
  167. }
  168. case CharDelete:
  169. if buf.DisplaySize() > 0 {
  170. buf.Delete()
  171. } else {
  172. return "", io.EOF
  173. }
  174. case CharKill:
  175. buf.DeleteRemaining()
  176. case CharCtrlU:
  177. buf.DeleteBefore()
  178. case CharCtrlL:
  179. buf.ClearScreen()
  180. case CharCtrlW:
  181. buf.DeleteWord()
  182. case CharCtrlZ:
  183. fd := os.Stdin.Fd()
  184. return handleCharCtrlZ(fd, i.Terminal.termios)
  185. case CharEnter, CharCtrlJ:
  186. output := buf.String()
  187. if output != "" {
  188. i.History.Add(output)
  189. }
  190. buf.MoveToEnd()
  191. fmt.Println()
  192. return output, nil
  193. default:
  194. if metaDel {
  195. metaDel = false
  196. continue
  197. }
  198. if r >= CharSpace || r == CharEnter || r == CharCtrlJ {
  199. buf.Add(r)
  200. }
  201. }
  202. }
  203. }
  204. func (i *Instance) HistoryEnable() {
  205. i.History.Enabled = true
  206. }
  207. func (i *Instance) HistoryDisable() {
  208. i.History.Enabled = false
  209. }
  210. func NewTerminal() (*Terminal, error) {
  211. fd := os.Stdin.Fd()
  212. termios, err := SetRawMode(fd)
  213. if err != nil {
  214. return nil, err
  215. }
  216. t := &Terminal{
  217. outchan: make(chan rune),
  218. rawmode: true,
  219. termios: termios,
  220. }
  221. go t.ioloop()
  222. return t, nil
  223. }
  224. func (t *Terminal) ioloop() {
  225. buf := bufio.NewReader(os.Stdin)
  226. for {
  227. r, _, err := buf.ReadRune()
  228. if err != nil {
  229. close(t.outchan)
  230. break
  231. }
  232. t.outchan <- r
  233. }
  234. }
  235. func (t *Terminal) Read() (rune, error) {
  236. r, ok := <-t.outchan
  237. if !ok {
  238. return 0, io.EOF
  239. }
  240. return r, nil
  241. }