tui.go

  1package tui
  2
  3import (
  4	"context"
  5	"fmt"
  6	"math/rand"
  7	"slices"
  8	"strings"
  9	"time"
 10
 11	"github.com/charmbracelet/bubbles/v2/key"
 12	tea "github.com/charmbracelet/bubbletea/v2"
 13	"github.com/charmbracelet/crush/internal/agent/tools/mcp"
 14	"github.com/charmbracelet/crush/internal/app"
 15	"github.com/charmbracelet/crush/internal/config"
 16	"github.com/charmbracelet/crush/internal/event"
 17	"github.com/charmbracelet/crush/internal/permission"
 18	"github.com/charmbracelet/crush/internal/pubsub"
 19	cmpChat "github.com/charmbracelet/crush/internal/tui/components/chat"
 20	"github.com/charmbracelet/crush/internal/tui/components/chat/splash"
 21	"github.com/charmbracelet/crush/internal/tui/components/completions"
 22	"github.com/charmbracelet/crush/internal/tui/components/core"
 23	"github.com/charmbracelet/crush/internal/tui/components/core/layout"
 24	"github.com/charmbracelet/crush/internal/tui/components/core/status"
 25	"github.com/charmbracelet/crush/internal/tui/components/dialogs"
 26	"github.com/charmbracelet/crush/internal/tui/components/dialogs/commands"
 27	"github.com/charmbracelet/crush/internal/tui/components/dialogs/filepicker"
 28	"github.com/charmbracelet/crush/internal/tui/components/dialogs/models"
 29	"github.com/charmbracelet/crush/internal/tui/components/dialogs/permissions"
 30	"github.com/charmbracelet/crush/internal/tui/components/dialogs/quit"
 31	"github.com/charmbracelet/crush/internal/tui/components/dialogs/sessions"
 32	"github.com/charmbracelet/crush/internal/tui/page"
 33	"github.com/charmbracelet/crush/internal/tui/page/chat"
 34	"github.com/charmbracelet/crush/internal/tui/styles"
 35	"github.com/charmbracelet/crush/internal/tui/util"
 36	"github.com/charmbracelet/lipgloss/v2"
 37	"golang.org/x/text/cases"
 38	"golang.org/x/text/language"
 39)
 40
 41var lastMouseEvent time.Time
 42
 43func MouseEventFilter(m tea.Model, msg tea.Msg) tea.Msg {
 44	switch msg.(type) {
 45	case tea.MouseWheelMsg, tea.MouseMotionMsg:
 46		now := time.Now()
 47		// trackpad is sending too many requests
 48		if now.Sub(lastMouseEvent) < 15*time.Millisecond {
 49			return nil
 50		}
 51		lastMouseEvent = now
 52	}
 53	return msg
 54}
 55
 56// appModel represents the main application model that manages pages, dialogs, and UI state.
 57type appModel struct {
 58	wWidth, wHeight int // Window dimensions
 59	width, height   int
 60	keyMap          KeyMap
 61
 62	currentPage  page.PageID
 63	previousPage page.PageID
 64	pages        map[page.PageID]util.Model
 65	loadedPages  map[page.PageID]bool
 66
 67	// Status
 68	status          status.StatusCmp
 69	showingFullHelp bool
 70
 71	app *app.App
 72
 73	dialog       dialogs.DialogCmp
 74	completions  completions.Completions
 75	isConfigured bool
 76
 77	// Chat Page Specific
 78	selectedSessionID string // The ID of the currently selected session
 79
 80	// sendProgressBar instructs the TUI to send progress bar updates to the
 81	// terminal.
 82	sendProgressBar bool
 83
 84	// QueryVersion instructs the TUI to query for the terminal version when it
 85	// starts.
 86	QueryVersion bool
 87}
 88
 89// Init initializes the application model and returns initial commands.
 90func (a appModel) Init() tea.Cmd {
 91	item, ok := a.pages[a.currentPage]
 92	if !ok {
 93		return nil
 94	}
 95
 96	var cmds []tea.Cmd
 97	cmd := item.Init()
 98	cmds = append(cmds, cmd)
 99	a.loadedPages[a.currentPage] = true
100
101	cmd = a.status.Init()
102	cmds = append(cmds, cmd)
103	if a.QueryVersion {
104		cmds = append(cmds, tea.RequestTerminalVersion)
105	}
106
107	return tea.Batch(cmds...)
108}
109
110// Update handles incoming messages and updates the application state.
111func (a *appModel) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
112	var cmds []tea.Cmd
113	var cmd tea.Cmd
114	a.isConfigured = config.HasInitialDataConfig()
115
116	switch msg := msg.(type) {
117	case tea.EnvMsg:
118		// Is this Windows Terminal?
119		if !a.sendProgressBar {
120			a.sendProgressBar = slices.Contains(msg, "WT_SESSION")
121		}
122	case tea.TerminalVersionMsg:
123		termVersion := strings.ToLower(string(msg))
124		// Only enable progress bar for the following terminals.
125		if !a.sendProgressBar {
126			a.sendProgressBar = strings.Contains(termVersion, "ghostty")
127		}
128		return a, nil
129	case tea.KeyboardEnhancementsMsg:
130		for id, page := range a.pages {
131			m, pageCmd := page.Update(msg)
132			a.pages[id] = m
133
134			if pageCmd != nil {
135				cmds = append(cmds, pageCmd)
136			}
137		}
138		return a, tea.Batch(cmds...)
139	case tea.WindowSizeMsg:
140		a.wWidth, a.wHeight = msg.Width, msg.Height
141		a.completions.Update(msg)
142		return a, a.handleWindowResize(msg.Width, msg.Height)
143
144	case pubsub.Event[mcp.Event]:
145		switch msg.Payload.Type {
146		case mcp.EventStateChanged:
147			return a, a.handleStateChanged(context.Background())
148		case mcp.EventPromptsListChanged:
149			return a, handleMCPPromptsEvent(context.Background(), msg.Payload.Name)
150		case mcp.EventToolsListChanged:
151			return a, handleMCPToolsEvent(context.Background(), msg.Payload.Name)
152		}
153
154	// Completions messages
155	case completions.OpenCompletionsMsg, completions.FilterCompletionsMsg,
156		completions.CloseCompletionsMsg, completions.RepositionCompletionsMsg:
157		u, completionCmd := a.completions.Update(msg)
158		if model, ok := u.(completions.Completions); ok {
159			a.completions = model
160		}
161
162		return a, completionCmd
163
164	// Dialog messages
165	case dialogs.OpenDialogMsg, dialogs.CloseDialogMsg:
166		u, completionCmd := a.completions.Update(completions.CloseCompletionsMsg{})
167		a.completions = u.(completions.Completions)
168		u, dialogCmd := a.dialog.Update(msg)
169		a.dialog = u.(dialogs.DialogCmp)
170		return a, tea.Batch(completionCmd, dialogCmd)
171	case commands.ShowArgumentsDialogMsg:
172		var args []commands.Argument
173		for _, arg := range msg.ArgNames {
174			args = append(args, commands.Argument{
175				Name:     arg,
176				Title:    cases.Title(language.English).String(arg),
177				Required: true,
178			})
179		}
180		return a, util.CmdHandler(
181			dialogs.OpenDialogMsg{
182				Model: commands.NewCommandArgumentsDialog(
183					msg.CommandID,
184					msg.CommandID,
185					msg.CommandID,
186					msg.Description,
187					args,
188					msg.OnSubmit,
189				),
190			},
191		)
192	case commands.ShowMCPPromptArgumentsDialogMsg:
193		args := make([]commands.Argument, 0, len(msg.Prompt.Arguments))
194		for _, arg := range msg.Prompt.Arguments {
195			args = append(args, commands.Argument(*arg))
196		}
197		dialog := commands.NewCommandArgumentsDialog(
198			msg.Prompt.Name,
199			msg.Prompt.Title,
200			msg.Prompt.Name,
201			msg.Prompt.Description,
202			args,
203			msg.OnSubmit,
204		)
205		return a, util.CmdHandler(
206			dialogs.OpenDialogMsg{
207				Model: dialog,
208			},
209		)
210	// Page change messages
211	case page.PageChangeMsg:
212		return a, a.moveToPage(msg.ID)
213
214	// Status Messages
215	case util.InfoMsg, util.ClearStatusMsg:
216		s, statusCmd := a.status.Update(msg)
217		a.status = s.(status.StatusCmp)
218		cmds = append(cmds, statusCmd)
219		return a, tea.Batch(cmds...)
220
221	// Session
222	case cmpChat.SessionSelectedMsg:
223		a.selectedSessionID = msg.ID
224	case cmpChat.SessionClearedMsg:
225		a.selectedSessionID = ""
226	// Commands
227	case commands.SwitchSessionsMsg:
228		return a, func() tea.Msg {
229			allSessions, _ := a.app.Sessions.List(context.Background())
230			return dialogs.OpenDialogMsg{
231				Model: sessions.NewSessionDialogCmp(allSessions, a.selectedSessionID),
232			}
233		}
234
235	case commands.SwitchModelMsg:
236		return a, util.CmdHandler(
237			dialogs.OpenDialogMsg{
238				Model: models.NewModelDialogCmp(),
239			},
240		)
241	// Compact
242	case commands.CompactMsg:
243		return a, func() tea.Msg {
244			err := a.app.AgentCoordinator.Summarize(context.Background(), msg.SessionID)
245			if err != nil {
246				return util.ReportError(err)()
247			}
248			return nil
249		}
250	case commands.QuitMsg:
251		return a, util.CmdHandler(dialogs.OpenDialogMsg{
252			Model: quit.NewQuitDialog(),
253		})
254	case commands.ToggleYoloModeMsg:
255		a.app.Permissions.SetSkipRequests(!a.app.Permissions.SkipRequests())
256	case commands.ToggleHelpMsg:
257		a.status.ToggleFullHelp()
258		a.showingFullHelp = !a.showingFullHelp
259		return a, a.handleWindowResize(a.wWidth, a.wHeight)
260	// Model Switch
261	case models.ModelSelectedMsg:
262		if a.app.AgentCoordinator.IsBusy() {
263			return a, util.ReportWarn("Agent is busy, please wait...")
264		}
265
266		config.Get().UpdatePreferredModel(msg.ModelType, msg.Model)
267
268		go a.app.UpdateAgentModel(context.TODO())
269
270		modelTypeName := "large"
271		if msg.ModelType == config.SelectedModelTypeSmall {
272			modelTypeName = "small"
273		}
274		return a, util.ReportInfo(fmt.Sprintf("%s model changed to %s", modelTypeName, msg.Model.Model))
275
276	// File Picker
277	case commands.OpenFilePickerMsg:
278		event.FilePickerOpened()
279
280		if a.dialog.ActiveDialogID() == filepicker.FilePickerID {
281			// If the commands dialog is already open, close it
282			return a, util.CmdHandler(dialogs.CloseDialogMsg{})
283		}
284		return a, util.CmdHandler(dialogs.OpenDialogMsg{
285			Model: filepicker.NewFilePickerCmp(a.app.Config().WorkingDir()),
286		})
287	// Permissions
288	case pubsub.Event[permission.PermissionNotification]:
289		item, ok := a.pages[a.currentPage]
290		if !ok {
291			return a, nil
292		}
293
294		// Forward to view.
295		updated, itemCmd := item.Update(msg)
296		a.pages[a.currentPage] = updated
297
298		return a, itemCmd
299	case pubsub.Event[permission.PermissionRequest]:
300		return a, util.CmdHandler(dialogs.OpenDialogMsg{
301			Model: permissions.NewPermissionDialogCmp(msg.Payload, &permissions.Options{
302				DiffMode: config.Get().Options.TUI.DiffMode,
303			}),
304		})
305	case permissions.PermissionResponseMsg:
306		switch msg.Action {
307		case permissions.PermissionAllow:
308			a.app.Permissions.Grant(msg.Permission)
309		case permissions.PermissionAllowForSession:
310			a.app.Permissions.GrantPersistent(msg.Permission)
311		case permissions.PermissionDeny:
312			a.app.Permissions.Deny(msg.Permission)
313		}
314		return a, nil
315	case splash.OnboardingCompleteMsg:
316		item, ok := a.pages[a.currentPage]
317		if !ok {
318			return a, nil
319		}
320
321		a.isConfigured = config.HasInitialDataConfig()
322		updated, pageCmd := item.Update(msg)
323		a.pages[a.currentPage] = updated
324
325		cmds = append(cmds, pageCmd)
326		return a, tea.Batch(cmds...)
327
328	case tea.KeyPressMsg:
329		return a, a.handleKeyPressMsg(msg)
330
331	case tea.MouseWheelMsg:
332		if a.dialog.HasDialogs() {
333			u, dialogCmd := a.dialog.Update(msg)
334			a.dialog = u.(dialogs.DialogCmp)
335			cmds = append(cmds, dialogCmd)
336		} else {
337			item, ok := a.pages[a.currentPage]
338			if !ok {
339				return a, nil
340			}
341
342			updated, pageCmd := item.Update(msg)
343			a.pages[a.currentPage] = updated
344
345			cmds = append(cmds, pageCmd)
346		}
347		return a, tea.Batch(cmds...)
348	case tea.PasteMsg:
349		if a.dialog.HasDialogs() {
350			u, dialogCmd := a.dialog.Update(msg)
351			if model, ok := u.(dialogs.DialogCmp); ok {
352				a.dialog = model
353			}
354
355			cmds = append(cmds, dialogCmd)
356		} else {
357			item, ok := a.pages[a.currentPage]
358			if !ok {
359				return a, nil
360			}
361
362			updated, pageCmd := item.Update(msg)
363			a.pages[a.currentPage] = updated
364
365			cmds = append(cmds, pageCmd)
366		}
367		return a, tea.Batch(cmds...)
368	}
369	s, _ := a.status.Update(msg)
370	a.status = s.(status.StatusCmp)
371
372	item, ok := a.pages[a.currentPage]
373	if !ok {
374		return a, nil
375	}
376
377	updated, cmd := item.Update(msg)
378	a.pages[a.currentPage] = updated
379
380	if a.dialog.HasDialogs() {
381		u, dialogCmd := a.dialog.Update(msg)
382		if model, ok := u.(dialogs.DialogCmp); ok {
383			a.dialog = model
384		}
385
386		cmds = append(cmds, dialogCmd)
387	}
388	cmds = append(cmds, cmd)
389	return a, tea.Batch(cmds...)
390}
391
392// handleWindowResize processes window resize events and updates all components.
393func (a *appModel) handleWindowResize(width, height int) tea.Cmd {
394	var cmds []tea.Cmd
395
396	// TODO: clean up these magic numbers.
397	if a.showingFullHelp {
398		height -= 5
399	} else {
400		height -= 2
401	}
402
403	a.width, a.height = width, height
404	// Update status bar
405	s, cmd := a.status.Update(tea.WindowSizeMsg{Width: width, Height: height})
406	if model, ok := s.(status.StatusCmp); ok {
407		a.status = model
408	}
409	cmds = append(cmds, cmd)
410
411	// Update the current view.
412	for p, page := range a.pages {
413		updated, pageCmd := page.Update(tea.WindowSizeMsg{Width: width, Height: height})
414		a.pages[p] = updated
415
416		cmds = append(cmds, pageCmd)
417	}
418
419	// Update the dialogs
420	dialog, cmd := a.dialog.Update(tea.WindowSizeMsg{Width: width, Height: height})
421	if model, ok := dialog.(dialogs.DialogCmp); ok {
422		a.dialog = model
423	}
424
425	cmds = append(cmds, cmd)
426
427	return tea.Batch(cmds...)
428}
429
430// handleKeyPressMsg processes keyboard input and routes to appropriate handlers.
431func (a *appModel) handleKeyPressMsg(msg tea.KeyPressMsg) tea.Cmd {
432	// Check this first as the user should be able to quit no matter what.
433	if key.Matches(msg, a.keyMap.Quit) {
434		if a.dialog.ActiveDialogID() == quit.QuitDialogID {
435			return tea.Quit
436		}
437		return util.CmdHandler(dialogs.OpenDialogMsg{
438			Model: quit.NewQuitDialog(),
439		})
440	}
441
442	if a.completions.Open() {
443		// completions
444		keyMap := a.completions.KeyMap()
445		switch {
446		case key.Matches(msg, keyMap.Up), key.Matches(msg, keyMap.Down),
447			key.Matches(msg, keyMap.Select), key.Matches(msg, keyMap.Cancel),
448			key.Matches(msg, keyMap.UpInsert), key.Matches(msg, keyMap.DownInsert):
449			u, cmd := a.completions.Update(msg)
450			a.completions = u.(completions.Completions)
451			return cmd
452		}
453	}
454	if a.dialog.HasDialogs() {
455		u, dialogCmd := a.dialog.Update(msg)
456		a.dialog = u.(dialogs.DialogCmp)
457		return dialogCmd
458	}
459	switch {
460	// help
461	case key.Matches(msg, a.keyMap.Help):
462		a.status.ToggleFullHelp()
463		a.showingFullHelp = !a.showingFullHelp
464		return a.handleWindowResize(a.wWidth, a.wHeight)
465	// dialogs
466	case key.Matches(msg, a.keyMap.Commands):
467		// if the app is not configured show no commands
468		if !a.isConfigured {
469			return nil
470		}
471		if a.dialog.ActiveDialogID() == commands.CommandsDialogID {
472			return util.CmdHandler(dialogs.CloseDialogMsg{})
473		}
474		if a.dialog.HasDialogs() {
475			return nil
476		}
477		return util.CmdHandler(dialogs.OpenDialogMsg{
478			Model: commands.NewCommandDialog(a.selectedSessionID),
479		})
480	case key.Matches(msg, a.keyMap.Sessions):
481		// if the app is not configured show no sessions
482		if !a.isConfigured {
483			return nil
484		}
485		if a.dialog.ActiveDialogID() == sessions.SessionsDialogID {
486			return util.CmdHandler(dialogs.CloseDialogMsg{})
487		}
488		if a.dialog.HasDialogs() && a.dialog.ActiveDialogID() != commands.CommandsDialogID {
489			return nil
490		}
491		var cmds []tea.Cmd
492		if a.dialog.ActiveDialogID() == commands.CommandsDialogID {
493			// If the commands dialog is open, close it first
494			cmds = append(cmds, util.CmdHandler(dialogs.CloseDialogMsg{}))
495		}
496		cmds = append(cmds,
497			func() tea.Msg {
498				allSessions, _ := a.app.Sessions.List(context.Background())
499				return dialogs.OpenDialogMsg{
500					Model: sessions.NewSessionDialogCmp(allSessions, a.selectedSessionID),
501				}
502			},
503		)
504		return tea.Sequence(cmds...)
505	case key.Matches(msg, a.keyMap.Suspend):
506		if a.app.AgentCoordinator != nil && a.app.AgentCoordinator.IsBusy() {
507			return util.ReportWarn("Agent is busy, please wait...")
508		}
509		return tea.Suspend
510	default:
511		item, ok := a.pages[a.currentPage]
512		if !ok {
513			return nil
514		}
515
516		updated, cmd := item.Update(msg)
517		a.pages[a.currentPage] = updated
518		return cmd
519	}
520}
521
522// moveToPage handles navigation between different pages in the application.
523func (a *appModel) moveToPage(pageID page.PageID) tea.Cmd {
524	if a.app.AgentCoordinator.IsBusy() {
525		// TODO: maybe remove this :  For now we don't move to any page if the agent is busy
526		return util.ReportWarn("Agent is busy, please wait...")
527	}
528
529	var cmds []tea.Cmd
530	if _, ok := a.loadedPages[pageID]; !ok {
531		cmd := a.pages[pageID].Init()
532		cmds = append(cmds, cmd)
533		a.loadedPages[pageID] = true
534	}
535	a.previousPage = a.currentPage
536	a.currentPage = pageID
537	if sizable, ok := a.pages[a.currentPage].(layout.Sizeable); ok {
538		cmd := sizable.SetSize(a.width, a.height)
539		cmds = append(cmds, cmd)
540	}
541
542	return tea.Batch(cmds...)
543}
544
545// View renders the complete application interface including pages, dialogs, and overlays.
546func (a *appModel) View() tea.View {
547	var view tea.View
548	view.AltScreen = true
549	t := styles.CurrentTheme()
550	view.BackgroundColor = t.BgBase
551	if a.wWidth < 25 || a.wHeight < 15 {
552		view.Layer = lipgloss.NewCanvas(
553			lipgloss.NewLayer(
554				t.S().Base.Width(a.wWidth).Height(a.wHeight).
555					Align(lipgloss.Center, lipgloss.Center).
556					Render(
557						t.S().Base.
558							Padding(1, 4).
559							Foreground(t.White).
560							BorderStyle(lipgloss.RoundedBorder()).
561							BorderForeground(t.Primary).
562							Render("Window too small!"),
563					),
564			),
565		)
566		return view
567	}
568
569	page := a.pages[a.currentPage]
570	if withHelp, ok := page.(core.KeyMapHelp); ok {
571		a.status.SetKeyMap(withHelp.Help())
572	}
573	pageView := page.View()
574	components := []string{
575		pageView,
576	}
577	components = append(components, a.status.View())
578
579	appView := lipgloss.JoinVertical(lipgloss.Top, components...)
580	layers := []*lipgloss.Layer{
581		lipgloss.NewLayer(appView),
582	}
583	if a.dialog.HasDialogs() {
584		layers = append(
585			layers,
586			a.dialog.GetLayers()...,
587		)
588	}
589
590	var cursor *tea.Cursor
591	if v, ok := page.(util.Cursor); ok {
592		cursor = v.Cursor()
593		// Hide the cursor if it's positioned outside the textarea
594		statusHeight := a.height - strings.Count(pageView, "\n") + 1
595		if cursor != nil && cursor.Y+statusHeight+chat.EditorHeight-2 <= a.height { // 2 for the top and bottom app padding
596			cursor = nil
597		}
598	}
599	activeView := a.dialog.ActiveModel()
600	if activeView != nil {
601		cursor = nil // Reset cursor if a dialog is active unless it implements util.Cursor
602		if v, ok := activeView.(util.Cursor); ok {
603			cursor = v.Cursor()
604		}
605	}
606
607	if a.completions.Open() && cursor != nil {
608		cmp := a.completions.View()
609		x, y := a.completions.Position()
610		layers = append(
611			layers,
612			lipgloss.NewLayer(cmp).X(x).Y(y),
613		)
614	}
615
616	canvas := lipgloss.NewCanvas(
617		layers...,
618	)
619
620	view.Layer = canvas
621	view.Cursor = cursor
622	view.MouseMode = tea.MouseModeCellMotion
623
624	if a.sendProgressBar && a.app != nil && a.app.AgentCoordinator != nil && a.app.AgentCoordinator.IsBusy() {
625		// HACK: use a random percentage to prevent ghostty from hiding it
626		// after a timeout.
627		view.ProgressBar = tea.NewProgressBar(tea.ProgressBarIndeterminate, rand.Intn(100))
628	}
629	return view
630}
631
632func (a *appModel) handleStateChanged(ctx context.Context) tea.Cmd {
633	return func() tea.Msg {
634		a.app.UpdateAgentModel(ctx)
635		return nil
636	}
637}
638
639func handleMCPPromptsEvent(ctx context.Context, name string) tea.Cmd {
640	return func() tea.Msg {
641		mcp.RefreshPrompts(ctx, name)
642		return nil
643	}
644}
645
646func handleMCPToolsEvent(ctx context.Context, name string) tea.Cmd {
647	return func() tea.Msg {
648		mcp.RefreshTools(ctx, name)
649		return nil
650	}
651}
652
653// New creates and initializes a new TUI application model.
654func New(app *app.App) *appModel {
655	chatPage := chat.New(app)
656	keyMap := DefaultKeyMap()
657	keyMap.pageBindings = chatPage.Bindings()
658
659	model := &appModel{
660		currentPage: chat.ChatPageID,
661		app:         app,
662		status:      status.NewStatusCmp(),
663		loadedPages: make(map[page.PageID]bool),
664		keyMap:      keyMap,
665
666		pages: map[page.PageID]util.Model{
667			chat.ChatPageID: chatPage,
668		},
669
670		dialog:      dialogs.NewDialogCmp(),
671		completions: completions.New(),
672	}
673
674	return model
675}