bubbletea/screen.go
Drew Smirnoff 9c6c325f83
fix: ingnore implausible terminal resize reports (#1887)
Signed-off-by: drew <me@andrinoff.com>
2026-10-26 17:59:16 +04:00

81 lines
2.2 KiB
Go

package tea
import "github.com/charmbracelet/x/ansi"
// WindowSizeMsg is used to report the terminal size. It's sent to Update once
// initially and then on every terminal resize.
type WindowSizeMsg struct {
Width int
Height int
}
// ClearScreen is a special command that tells the program to clear the screen
// before the next update. This can be used to move the cursor to the top left
// of the screen and clear visual clutter when the alt screen is not in use.
//
// Note that it should never be necessary to call ClearScreen() for regular
// redraws.
func ClearScreen() Msg {
return clearScreenMsg{}
}
// clearScreenMsg is an internal message that signals to clear the screen.
// You can send a clearScreenMsg with ClearScreen.
type clearScreenMsg struct{}
// ModeReportMsg is a message that represents a mode report event (DECRPM).
//
// This is sent by the terminal in response to a request for a terminal mode
// report (DECRQM). It indicates the current setting of a specific terminal
// mode like cursor visibility, mouse tracking, etc.
//
// Example:
//
// ```go
// func (m model) Init() tea.Cmd {
// // Does my terminal support reporting focus events?
// return tea.Raw(ansi.RequestModeFocusEvent)
// }
//
// func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
// switch msg := msg.(type) {
// case tea.ModeReportMsg:
// if msg.Mode == ansi.ModeFocusEvent && !msg.Value.IsNotRecognized() {
// // Terminal supports focus events
// m.supportsFocus = true
// }
// }
// return m, nil
// }
//
// func (m model) View() tea.View {
// var view tea.View
// view.ReportFocus = m.supportsFocus
// view.SetContent(fmt.Sprintf("Terminal supports focus events: %v", m.supportsFocus))
// return view
// }
// ```
//
// See: https://vt100.net/docs/vt510-rm/DECRPM.html
type ModeReportMsg struct {
// Mode is the mode number.
Mode ansi.Mode
// Value is the mode value.
Value ansi.ModeSetting
}
const (
maxWindowDimension = 4096
maxWindowCells = 1 << 20
)
func isPlausibleWindowSize(width, height int) bool {
if width < 0 || height < 0 {
return false
}
if width > maxWindowDimension || height > maxWindowDimension {
return false
}
return width*height <= maxWindowCells
}