Package osc52

OSC 52 ; Pc ; Pd BEL

c: clipboard
p: primary
q: secondary (not supported)
s: select (not supported)
0-7: cut-buffers (not supported)

// copy "hello world" to the system clipboard
fmt.Fprint(os.Stderr, osc52.New("hello world"))

// copy "hello world" to the primary Clipboard
fmt.Fprint(os.Stderr, osc52.New("hello world").Primary())

// limit the size of the string to copy 10 bytes
fmt.Fprint(os.Stderr, osc52.New("0123456789").Limit(10))

// escape the OSC52 sequence for screen using DCS sequences
fmt.Fprint(os.Stderr, osc52.New("hello world").Screen())

// escape the OSC52 sequence for Tmux
fmt.Fprint(os.Stderr, osc52.New("hello world").Tmux())

// query the system Clipboard
fmt.Fprint(os.Stderr, osc52.Query())

// query the primary clipboard
fmt.Fprint(os.Stderr, osc52.Query().Primary())

// clear the system Clipboard
fmt.Fprint(os.Stderr, osc52.Clear())

// clear the primary Clipboard
fmt.Fprint(os.Stderr, osc52.Clear().Primary())

type Clipboard ¶

Clipboard is the clipboard buffer to use.

type Clipboard rune

const (
    // SystemClipboard is the system clipboard buffer.
    SystemClipboard Clipboard = 'c'
    // PrimaryClipboard is the primary clipboard buffer (X11).
    PrimaryClipboard = 'p'
)

type Mode ¶

Mode is the mode to use for the OSC52 sequence.

type Mode uint

const (
    // DefaultMode is the default OSC52 sequence mode.
    DefaultMode Mode = iota
    // ScreenMode escapes the OSC52 sequence for screen using DCS sequences.
    ScreenMode
    // TmuxMode escapes the OSC52 sequence for tmux. Not needed if tmux
    // clipboard is set to `set-clipboard on`
    TmuxMode
)

type Operation ¶

Operation is the OSC52 operation.

type Operation uint

const (
    // SetOperation is the copy operation.
    SetOperation Operation = iota
    // QueryOperation is the query operation.
    QueryOperation
    // ClearOperation is the clear operation.
    ClearOperation
)

type Sequence ¶

Sequence is the OSC52 sequence.

type Sequence struct {
    // contains filtered or unexported fields
}

func Clear ¶

func Clear() Sequence

Clear creates a new OSC52 sequence with the ClearOperation. This returns a new OSC52 sequence to clear the clipboard.

This is a syntactic sugar for New().Clear().

func New ¶

func New(strs ...string) Sequence

New creates a new OSC52 sequence with the given string(s). Strings are joined with a space character.

func Query ¶

func Query() Sequence

Query creates a new OSC52 sequence with the QueryOperation. This returns a new OSC52 sequence to query the clipboard contents.

This is a syntactic sugar for New().Query().

func (Sequence) Clear ¶

func (s Sequence) Clear() Sequence

Clear sets the operation to ClearOperation. This clears the clipboard.

This is a syntactic sugar for s.Operation(ClearOperation).

func (Sequence) Clipboard ¶

func (s Sequence) Clipboard(c Clipboard) Sequence

Clipboard sets the clipboard buffer for the OSC52 sequence.

func (Sequence) Limit ¶

func (s Sequence) Limit(l int) Sequence

Limit sets the limit for the OSC52 sequence. The default limit is 0 (no limit).

Strings longer than the limit get ignored. Settting the limit to 0 or a negative value disables the limit. Each terminal defines its own escapse sequence limit.

func (Sequence) Mode ¶

func (s Sequence) Mode(m Mode) Sequence

Mode sets the mode for the OSC52 sequence.

func (Sequence) Operation ¶

func (s Sequence) Operation(o Operation) Sequence

Operation sets the operation for the OSC52 sequence. The default operation is SetOperation.

func (Sequence) Primary ¶

func (s Sequence) Primary() Sequence

Primary sets the clipboard buffer to PrimaryClipboard. This is the X11 primary clipboard.

This is a syntactic sugar for s.Clipboard(PrimaryClipboard).

func (Sequence) Query ¶

func (s Sequence) Query() Sequence

Query sets the operation to QueryOperation. This queries the clipboard contents.

This is a syntactic sugar for s.Operation(QueryOperation).

func (Sequence) Screen ¶

func (s Sequence) Screen() Sequence

Screen sets the mode to ScreenMode. Used to escape the OSC52 sequence for `screen`.

This is a syntactic sugar for s.Mode(ScreenMode).

func (Sequence) SetString ¶

func (s Sequence) SetString(strs ...string) Sequence

SetString sets the string for the OSC52 sequence. Strings are joined with a space character.

func (Sequence) String ¶

func (s Sequence) String() string

String returns the OSC52 sequence.

func (Sequence) Tmux ¶

func (s Sequence) Tmux() Sequence

Tmux sets the mode to TmuxMode. Used to escape the OSC52 sequence for `tmux`.

Note: this is not needed if tmux clipboard is set to `set-clipboard on`. If TmuxMode is used, tmux must have `allow-passthrough on` set.

This is a syntactic sugar for s.Mode(TmuxMode).

func (Sequence) WriteTo ¶

func (s Sequence) WriteTo(out io.Writer) (int64, error)

WriteTo writes the OSC52 sequence to the writer.