tcellについて

Posted on: May 13, 2020

SetContent()

goのTUIについてで書いたようにtcellのSetContent()は1文字設置していくのでASCIIの範囲内だと簡単ですが、Unicodeの世界では注意すべき点があります。

まず日本語などの全角幅の文字と半角幅の文字が混在すると全角幅のときには、次の文字は1つとばして設置するといったことが必要になります。

単純に実装する場合はrunewidth.RuneWidth()を使用すれば、runeの文字幅を0,1,2で返してくれるので、その分xをずらせば表示されます。以下が実装例です。文字列を渡せるsetContents()で処理しています。

package main

import (
	"log"

	"github.com/gdamore/tcell"
	"github.com/mattn/go-runewidth"
)

func setContents(screen tcell.Screen, x int, y int, str string, style tcell.Style) {
	for _, r := range str {
		screen.SetContent(x, y, r, nil, style)
		x += runewidth.RuneWidth(r)
	}
}

func main() {
	screen, err := tcell.NewScreen()
	if err != nil {
		log.Fatal(err)
	}
	if err = screen.Init(); err != nil {
		log.Fatal(err)
	}
	defer screen.Fini()

	setContents(screen, 0, 10, "あいうえお", tcell.StyleDefault)
	screen.Show()

	quit := make(chan struct{})
	go func() {
		for {
			ev := screen.PollEvent()
			switch ev.(type) {
			case *tcell.EventKey:
				close(quit)
			}
		}
	}()
	<-quit
}

上記では結合文字は無視されて表示されます。結合文字を出したい場合は、文字列をループしている中でruneが結合文字のコード範囲だった場合には、前の文字のcombcに入れた上でSetContent()を実行する必要があります。

また、runewidth.RuneWidth()で、0幅と出る文字の中にはタブ（\t）等、アプリケーションによって判断が変わる文字もあります。

さらに GoのTUIで表示が崩れる場合で書いたようにgo-runewidthでは、曖昧幅がロケールや環境変数RUNEWIDTH_EASTASIANで変わる文字幅があるので注意が必要です。

Style

tcellでは、SetContent()の中でスタイルを指定します。

通常端末ではエスケープシーケンスにより色等を変更しますが、エスケープシーケンスでは色指定した後は別の色指定やリセットするまで、その色が続く仕様でした。

tcellでは、SetContent()の中でスタイルをtcell独自の値で指定すれば良いので明確です。色はtcellの定数で定義されているので、エスケープシーケンスよりも扱うのは簡単だと思います。

たとえば赤い文字で出したい場合は、tcell.StyleDefaultをtcell.StyleDefault.Foreground(tcell.ColorRed)に変更するだけです。

ただし、使用できる色数は端末環境により異なります。16色から24ビットカラーが出せる端末まであり、tcellは24ビットカラーもサポートしています。

多くの端末で動くことを想定するTUIの場合は16色の範囲内で指定することが多いです。ただ、16色だと原色が多く使用されるためケバケバしい印象になります。そこで、端末の環境によっては設定によりパレットを用意して16色の色を変更できるようにしている場合があります。

この様に指定してあると16色の中の赤をエスケープシーケンスで指定しても原色の赤とは違う色にして見やすくカスタマイズができるようになっています。

ところが、tcellでは24ビットカラーをサポートしているため、さまざまな赤が出せる一方tcell.ColorRedは原色の赤で表示されます。

TUIアプリケーションで、それほど多く色を使わない場合はパレットの色を尊重した方が使う人に優しいと思います。その場合は、環境変数TCELL_TRUECOLORをdisableにセットしておくとパレットの方を使用します。

export TCELL_TRUECOLOR=disable

アプリケーションによってはプログラム内でセットしておくと良いでしょう。

エスケープシーケンスの解釈

エスケープシーケンスよりもスタイル指定の方が明確になりますが、デメリットもあります。エスケープシーケンスでは、文字列として渡すことができるため、以下の様にするだけで、一部を赤文字にするといったことができますが、スタイルでは難しくなります。

echo "白\e[31m赤\e[0m白"

また、エスケープシーケンスが含まれた文字列を意図通りの色で表示したい場合やエスケープシーケンスを（\eは文字幅0と解釈されてもその後の[31mが文字列として表示されてしまうので）取り除く場合はエスケープシーケンスを解釈する必要があります。残念ながらエスケープシーケンスを解釈してくれる関数は含まれていないので、自分で実装する必要があります。エスケープシーケンスの解釈自体はそれほど難しくないので、1文字づつ見ていきエスケープシーケンスの開始で処理を入れることで可能になります。

同様なことをしている処理はいくつかありますが、tviewのansi.goで、エスケープシーケンスをパースしています（こちらは、tviewの記法に変換）。

また、拙作のovの中でも解釈してスタイルに変換しています。