code review 171330043: go.crypto/ssh/terminal: support bracketed paste mode.

go.crypto/ssh/terminal: support bracketed paste mode.

Some terminals support a mode where pasted text is bracketed by escape sequences. This is very useful for terminal applications that otherwise have no good way to tell pastes and typed text apart.

This change allows applications to enable this mode and, if the terminal supports it, will suppress autocompletes during pastes and indicate to the caller that a line came entirely from pasted text.

[agl1, 2014-11-09 01:13:46]

Hello bradfitz@golang.org (cc: golang-codereviews@googlegroups.com),

I'd like you to review this change to
https://code.google.com/p/go.crypto/

[bradfitz, 2014-11-12 17:52:22]

LGTM after naming nits

https://codereview.appspot.com/171330043/diff/40001/ssh/terminal/terminal.go
File ssh/terminal/terminal.go (right):

https://codereview.appspot.com/171330043/diff/40001/ssh/terminal/terminal.go#...
ssh/terminal/terminal.go:825: type pasteIndicator struct{}
error types should end in "Error"

https://codereview.appspot.com/171330043/diff/40001/ssh/terminal/terminal.go#...
ssh/terminal/terminal.go:835: var PasteIndicatorError = pasteIndicator{}
error variables should start with "Err" (or "err")

https://codereview.appspot.com/171330043/diff/40001/ssh/terminal/terminal.go#...
ssh/terminal/terminal.go:844: t.c.Write([]byte("\x1b[?2004h"))
io.WriteString so allocation can be avoided if c supports WriteString?

[agl1, 2014-11-16 22:02:02]

*** Submitted as
https://code.google.com/p/go/source/detail?r=60a80aaa50ff&repo=crypto ***

go.crypto/ssh/terminal: support bracketed paste mode.

Some terminals support a mode where pasted text is bracketed by escape
sequences. This is very useful for terminal applications that otherwise have no
good way to tell pastes and typed text apart.

This change allows applications to enable this mode and, if the terminal
supports it, will suppress autocompletes during pastes and indicate to the
caller that a line came entirely from pasted text.

LGTM=bradfitz
R=bradfitz
CC=golang-codereviews
https://codereview.appspot.com/171330043

[agl1, 2014-11-17 16:13:21]

https://codereview.appspot.com/171330043/diff/40001/ssh/terminal/terminal.go
File ssh/terminal/terminal.go (right):

https://codereview.appspot.com/171330043/diff/40001/ssh/terminal/terminal.go#...
ssh/terminal/terminal.go:825: type pasteIndicator struct{}
On 2014/11/12 17:52:21, bradfitz wrote:
> error types should end in "Error"

Done.

https://codereview.appspot.com/171330043/diff/40001/ssh/terminal/terminal.go#...
ssh/terminal/terminal.go:835: var PasteIndicatorError = pasteIndicator{}
On 2014/11/12 17:52:21, bradfitz wrote:
> error variables should start with "Err" (or "err")

Done.

https://codereview.appspot.com/171330043/diff/40001/ssh/terminal/terminal.go#...
ssh/terminal/terminal.go:844: t.c.Write([]byte("\x1b[?2004h"))
On 2014/11/12 17:52:21, bradfitz wrote:
> io.WriteString so allocation can be avoided if c supports WriteString?

Done.

[bradfitz, 2014-11-17 16:18:31]

https://codereview.appspot.com/171330043/diff/80001/ssh/terminal/terminal.go
File ssh/terminal/terminal.go (right):

https://codereview.appspot.com/171330043/diff/80001/ssh/terminal/terminal.go#...
ssh/terminal/terminal.go:825: type pasteIndicatorError struct{}
in retrospect, why does this type exist? It has no state and it's never tested
for, and it's private. You could just do:

  var ErrPasteIndicator = errors.New("terminal: ErrPasteIndicator not correctly
handled")