terminfo_test.go

// Copyright 2022 The TCell Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use file except in compliance with the License.
// You may obtain a copy of the license at
//
//    http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package terminfo

import (
	"bytes"
	"testing"
	"time"
)

// This terminfo entry is a stripped down version from
// xterm-256color, but I've added some of my own entries.
var testTerminfo = &Terminfo{
	Name:      "simulation_test",
	Columns:   80,
	Lines:     24,
	Colors:    256,
	Bell:      "\a",
	Blink:     "\x1b2ms$<20>something",
	Reverse:   "\x1b[7m",
	SetFg:     "\x1b[%?%p1%{8}%<%t3%p1%d%e%p1%{16}%<%t9%p1%{8}%-%d%e38;5;%p1%d%;m",
	SetBg:     "\x1b[%?%p1%{8}%<%t4%p1%d%e%p1%{16}%<%t10%p1%{8}%-%d%e48;5;%p1%d%;m",
	AltChars:  "``aaffggiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz{{||}}~~",
	Mouse:     "\x1b[M",
	SetCursor: "\x1b[%i%p1%d;%p2%dH",
	PadChar:   "\x00",
	EnterUrl:  "\x1b]8;;%p1%s\x1b\\",
}

func TestTerminfoExpansion(t *testing.T) {

	ti := testTerminfo

	// Tests %i and basic parameter strings too
	if ti.TGoto(7, 9) != "\x1b[10;8H" {
		t.Error("TGoto expansion failed")
	}

	// This tests some conditionals
	if ti.TParm("A[%p1%2.2X]B", 47) != "A[2F]B" {
		t.Error("TParm conditionals failed")
	}

	// Color tests.
	if ti.TParm(ti.SetFg, 7) != "\x1b[37m" {
		t.Error("SetFg(7) failed")
	}
	if ti.TParm(ti.SetFg, 15) != "\x1b[97m" {
		t.Error("SetFg(15) failed")
	}
	if ti.TParm(ti.SetFg, 200) != "\x1b[38;5;200m" {
		t.Error("SetFg(200) failed")
	}

	type testCase struct {
		expect string
		format string
		params []interface{}
	}

	cases := []testCase{
		{expect: "0a", format: "%p1%02x", params: []interface{}{10}},
		{expect: "0A", format: "%p1%02X", params: []interface{}{10}},
		{expect: "A", format: "%p1%c", params: []interface{}{65}},
		{expect: "A", format: "%'A'%c", params: []interface{}{}},
		{expect: "65", format: "%'A'%d", params: []interface{}{}},
		{expect: "7", format: "%i%p1%p2%+%d", params: []interface{}{2, 3}},
		{expect: "abc", format: "%p1%s", params: []interface{}{"abc"}},
		{expect: "1%d", format: "1%%d", params: []interface{}{}},
		{expect: "abc", format: "%p1%s%", params: []interface{}{"abc"}}, // unterminated %
		{expect: "  abc", format: "%p1%5s", params: []interface{}{"abc"}},
		{expect: "abc  ", format: "%p1%:-5s", params: []interface{}{"abc"}},
		{expect: "15", format: "%{3}%p1%*%d", params: []interface{}{5}},
		{expect: " A", format: "%p1%2c", params: []interface{}{65}},
		{expect: "4", format: "%p1%l%d", params: []interface{}{"four"}},
		{expect: "0", format: "%pA%d", params: []interface{}{}}, // missing/invalid parameter
		{expect: "5", format: "%p1%p2%/%d", params: []interface{}{15, 3}},
		{expect: "0", format: "%p1%p2%/%d", params: []interface{}{3, 15}},
		{expect: "0", format: "%p1%p2%/%d", params: []interface{}{3, 0}},
		{expect: "3", format: "%p1%p2%m%d", params: []interface{}{15, 4}},
		{expect: "0", format: "%p1%p2%m%d", params: []interface{}{3, 0}},
		{expect: "2", format: "%p1%Pa%{4}%{3}%ga%d", params: []interface{}{2}},
		{expect: "2", format: "%p1%PA%{4}%{3}%gA%d", params: []interface{}{2}},
		{expect: "0", format: "%p1%PA%{4}%{3}%ga%d", params: []interface{}{2}},
		{expect: "0", format: "%p1%Pz%{4}%{3}%gZ%d", params: []interface{}{2}},
		{expect: "0", format: "%d", params: []interface{}{}}, // underflow
		{expect: "", format: "%s", params: []interface{}{}},  // underflow
		{expect: "1", format: "%p1%p2%=%d", params: []interface{}{3, 3}},
		{expect: "0", format: "%p1%p2%=%d", params: []interface{}{3, 4}},
		{expect: "1", format: "%p1%p2%=%!%d", params: []interface{}{3, 4}},
		{expect: "1", format: "%p1%p2%>%d", params: []interface{}{4, 3}},
		{expect: "3", format: "%p1%p2%|%d", params: []interface{}{1, 2}},
		{expect: "2", format: "%p1%p2%&%d", params: []interface{}{2, 3}},
		{expect: "1", format: "%p1%p2%^%d", params: []interface{}{2, 3}},
		{expect: "f", format: "%p1%~%{255}%&%x", params: []interface{}{0xf0}},
		{expect: "%Z", format: "%Z", params: []interface{}{2, 3}}, // unknown sequence
	}

	for i := range cases {
		if res := ti.TParm(cases[i].format, cases[i].params...); res != cases[i].expect {
			t.Errorf("Format case %d failed: Format %q got %q", i, cases[i].format, res)
		}
	}
	t.Logf("Tested %d cases", len(cases))
}

func TestTerminfoDelay(t *testing.T) {
	ti := testTerminfo
	buf := bytes.NewBuffer(nil)
	now := time.Now()
	ti.TPuts(buf, ti.Blink)
	then := time.Now()
	s := string(buf.Bytes())
	if s != "\x1b2mssomething" {
		t.Errorf("Terminfo delay failed: %s", s)
	}
	if then.Sub(now) < time.Millisecond*20 {
		t.Error("Too short delay")
	}
	if then.Sub(now) > time.Millisecond*50 {
		t.Error("Too late delay")
	}
}

func TestStringParameter(t *testing.T) {
	ti := testTerminfo
	s := ti.TParm(ti.EnterUrl, "https://example.org/test")
	if s != "\x1b]8;;https://example.org/test\x1b\\" {
		t.Errorf("Result string failed: %s", s)
	}
}

func BenchmarkSetFgBg(b *testing.B) {
	ti := testTerminfo

	for i := 0; i < b.N; i++ {
		ti.TParm(ti.SetFg, 100, 200)
		ti.TParm(ti.SetBg, 100, 200)
	}
}