tui.go

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