term

func CalculateOptimalWidth ¶ added in v0.0.2

func CalculateOptimalWidth(cells [][]Cell) (max int)

CalculateOptimalWidth calculates the width of this cells, such that nothing is truncated if rendered.

func CellsToBytesBuffer ¶ added in v0.0.2

func CellsToBytesBuffer(buffer *bytes.Buffer, cells [][]Cell)

CellsToBytesBuffer copies the bytes representation of the given cell matrix to the supplied buffer.

Caller is responsible for resetting buffer prior to this call if necessary.

func CellsToString ¶ added in v0.0.2

func CellsToString(cells [][]Cell) string

CellsToString returns the string representation of the given cell matrix.

func CellsToStringBuilder ¶ added in v0.0.2

func CellsToStringBuilder(builder *strings.Builder, cells [][]Cell)

CellsToStringBuilder copies the string representation of the given cell matrix to the supplied builder.

Caller is responsible for resetting builder prior to this call if necessary.

func CloneCells ¶ added in v0.0.2

func CloneCells(in [][]Cell) [][]Cell

CloneCells returns a deep clone of in.

func Close ¶

func Close()

Close writer; should be called after successful initialization when termbox's functionality isn't required anymore.

func ContextWithPayload ¶

func ContextWithPayload(ctx context.Context, payload []byte) context.Context

ContextWithPayload returns a new Context that holds locker.

func CoordinatesBlockSort ¶

func CoordinatesBlockSort(from Coordinates, to Coordinates) (
	Coordinates, Coordinates,
)

CoordinatesBlockSort sorts a pair of coordinates (from/to) such that:

	┌──────┐┌──────┐┌──────┐┌──────┐┌──────┐┌──────┐
	│ f    ││ t    ││    f ││    t ││ t  f ││ f  t │
	│    t ││    f ││ t    ││ f    ││      ││      │
	└──────┘└──────┘└──────┘└──────┘└──────┘└──────┘
      |       |        |       |       |       |
      v       v        v       v       v       v
	┌──────┐┌──────┐┌──────┐┌──────┐┌──────┐┌──────┐
	│ f    ││ f    ││ f    ││ f    ││ f  t ││ f  t │
	│    t ││    t ││    t ││    t ││      ││      │
	└──────┘└──────┘└──────┘└──────┘└──────┘└──────┘

func CoordinatesInBounds ¶

func CoordinatesInBounds(pos Coordinates, bounds Coordinates) bool

CoordinatesInBounds returns true if the given position is within the given right-exclusive bounds.

func CoordinatesIntersection ¶

func CoordinatesIntersection(
	startA, endA, startB, endB Coordinates,
) (intersectionStart Coordinates, intersectionEnd Coordinates, ok bool)

CoordinatesIntersection calculates the intersection a ∩ b in a 2D space, defined as the set of all those cells which are common to both a and b. Both a and b are expected to be right-exclusive ranges.

┌──────┐     ┌──────┐     ┌──────┐
│ AA   │  ∩  │      │  =  │      │
│      │     │   BB │     │      │
└──────┘     └──────┘     └──────┘
┌──────┐     ┌──────┐     ┌──────┐
│ AAAAA│  ∩  │      │  =  │      │
│AAA   │     │BBBBB │     │CCC   │
└──────┘     └──────┘     └──────┘
┌──────┐     ┌──────┐     ┌──────┐
│  BBBB│  ∩  │      │  =  │      │
│BBB   │     │AAAAA │     │CCC   │
└──────┘     └──────┘     └──────┘
┌──────┐     ┌──────┐     ┌──────┐
│     A│  ∩  │      │  =  │      │
│AAAAAA│     │BBB   │     │CCC   │
└──────┘     └──────┘     └──────┘

func CoordinatesSort ¶

func CoordinatesSort(from Coordinates, to Coordinates) (
	Coordinates, Coordinates,
)

CoordinatesSort sorts a pair of coordinates (from/to) such that:

	┌──────┐┌──────┐┌──────┐┌──────┐┌──────┐┌──────┐
	│ f    ││ t    ││    f ││    t ││ t  f ││ f  t │
	│    t ││    f ││ t    ││ f    ││      ││      │
	└──────┘└──────┘└──────┘└──────┘└──────┘└──────┘
      |       |        |       |       |       |
      v       v        v       v       v       v
	┌──────┐┌──────┐┌──────┐┌──────┐┌──────┐┌──────┐
	│ f    ││ f    ││    f ││    f ││ f  t ││ f  t │
	│    t ││    t ││ t    ││ t    ││      ││      │
	└──────┘└──────┘└──────┘└──────┘└──────┘└──────┘

func CopyCells ¶ added in v0.0.2

func CopyCells(dst [][]Cell, src [][]Cell) [][]Cell

CopyCells copies src into dst, re-using dst's capacity when possible.

func Init ¶

func Init() error

Init initializes the underlying vte client.

func InterruptAt ¶

func InterruptAt(ctx context.Context, interrupter Interrupter, fps int)

InterruptAt interrupts the main event loop at the given fps, using the given interrupter. This function only returns when context is canceled.

func PayloadFromContext ¶

func PayloadFromContext(ctx context.Context) ([]byte, bool)

PayloadFromContext returns the payload value stored in ctx, if any.

func Poll ¶

func Poll() <-chan tcell.Event

Poll gives access to the underlying tcell.Event channel.

func PublishBell ¶

func PublishBell()

PublishBell It's a shorthand for `ScheduleNextTick(RingBell)`.

func PublishEvent ¶

func PublishEvent(ev Event) bool

PublishEvent sends a synthetic event to the event poller. If the event queue is full then this method does not publish the event and returns false.

func RingBell ¶

func RingBell()

RingBell makes an audible noise. This must be synchronized against other accesses to the term.Writer's screen buffer.

func ScheduleNextTick ¶

func ScheduleNextTick(fn func()) bool

ScheduleNextTick schedules running fn on the next event-loop iteration.

func SetAttr ¶

func SetAttr(newattr Attributes)

SetAttr sets the global foreground and background attributes.

func SetCursorStyle ¶

func SetCursorStyle(style CursorStyle)

SetCursorStyle is used to set the cursor style. If the style is not supported (or cursor styles are not supported at all), then this will have no effect.

func Size ¶

func Size() (width int, height int)

Size returns the size of the terminal window.

func StringToCells ¶ added in v0.0.2

func StringToCells(str string) (cells [][]Cell)

StringToCells returns the cell matrix representation of the given string.