readline.go 4.9 KB

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