Documentation
¶
Overview ¶
Package terminal 提供集成终端:每 session 可开多个交互式 shell(PTY), 供用户自由执行基础 shell 命令。与 agent 的 ACP 通道完全分离(§1.1): agent 永远走 ACP,这里的终端纯粹是给「屏幕前的人」用的。
后端用 creack/pty(Unix 事实标准,纯 Go)spawn 登录 shell;输出经 Wails3 event 推前端,输入/resize/kill 走 service binding(对齐 wails-terminal / 官方 v3 文档)。 生命周期:kill 时关闭 PTY master(内核向 controlling session 发 SIGHUP —— 终端模拟器 的标准清理路径)+ kill(-pgid) 兜底;交互式 shell 自身会 setpgid 成为组长,故按组回收。 session 删除 / app 退出时统一清理,不留孤儿 shell。
Index ¶
- Constants
- type DataPayload
- type ExitPayload
- type StatePayload
- type TerminalService
- func (s *TerminalService) GetTerminalScrollback(id string) (string, error)
- func (s *TerminalService) Kill(id string) error
- func (s *TerminalService) KillSessionTerminals(sessionID string)
- func (s *TerminalService) ListTerminalsBySession() map[string]bool
- func (s *TerminalService) Resize(id string, cols, rows uint16) error
- func (s *TerminalService) ServiceShutdown() error
- func (s *TerminalService) ServiceStartup(ctx context.Context, options application.ServiceOptions) error
- func (s *TerminalService) Start(sessionID, cwd string, cols, rows uint16) (string, error)
- func (s *TerminalService) Write(id, data string) error
Constants ¶
const ( EventData = "terminal:data" // DataPayload(PTY 输出,base64) EventExit = "terminal:exit" // ExitPayload(进程退出码) // EventState 推某 session 是否仍有活跃终端(Start/Kill/退出时派发)。 // 前端据此驱动侧栏「已开终端」图标(后端为权威,跨重启/跨 session 一致)。 EventState = "terminal:state" )
事件名(前端 Events.On 监听;单名 + body 带 id 派发,对齐 chat:event 模式)。
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DataPayload ¶
type DataPayload struct {
ID string `json:"id"`
SessionID string `json:"sessionId"`
Data string `json:"data"`
}
DataPayload 一段 PTY 输出。Data 为 base64(前端 atob 解码后 term.write)。
type ExitPayload ¶
type ExitPayload struct {
ID string `json:"id"`
SessionID string `json:"sessionId"`
Code int `json:"code"`
}
ExitPayload 进程退出。
type StatePayload ¶
type StatePayload struct {
SessionID string `json:"sessionId"`
HasTerminal bool `json:"hasTerminal"`
}
StatePayload 某 session 的终端存在性(前端 hasTermBySession 的权威数据源)。
type TerminalService ¶
type TerminalService struct {
// contains filtered or unexported fields
}
TerminalService 是前端与终端的桥梁(Wails3 service)。 通过 binding 暴露 Start/Write/Resize/Kill/KillSessionTerminals,通过 event 推 data/exit。
func (*TerminalService) GetTerminalScrollback ¶
func (s *TerminalService) GetTerminalScrollback(id string) (string, error)
GetTerminalScrollback 返回某终端的 scrollback 历史(base64)。 供独立窗口 / 重新打开终端时还原历史:前端新建 xterm 后调此拿回后端留存, term.write 解码后的字节,即可还原完整 scrollback(含 ANSI 颜色),再继续订阅实时 data 事件。 这让终端历史有了「后端单一真相」(见 scrollback.go 顶部说明),弹出 / 回切 / 重开走同一路径。 终端不存在或无历史时返回空串。
func (*TerminalService) Kill ¶
func (s *TerminalService) Kill(id string) error
Kill 关闭单个终端(tab 的 × / 中键)。
func (*TerminalService) KillSessionTerminals ¶
func (s *TerminalService) KillSessionTerminals(sessionID string)
KillSessionTerminals 关闭某 session 的全部终端。 前端 removeSession(删除会话)时调:session 删了、worktree 要拆,shell 必须先死。
func (*TerminalService) ListTerminalsBySession ¶
func (s *TerminalService) ListTerminalsBySession() map[string]bool
ListTerminalsBySession 返回当前有 ≥1 活跃终端的 session 集合(sessionId → true)。 供前端启动/打开 session 时同步侧栏图标(后端为权威状态,§5.3 尊重数据源)。
func (*TerminalService) Resize ¶
func (s *TerminalService) Resize(id string, cols, rows uint16) error
Resize 前端 fit 后 → 调 PTY 尺寸。终端已退出则静默忽略。
func (*TerminalService) ServiceShutdown ¶
func (s *TerminalService) ServiceShutdown() error
func (*TerminalService) ServiceStartup ¶
func (s *TerminalService) ServiceStartup(ctx context.Context, options application.ServiceOptions) error
ServiceStartup / ServiceShutdown Wails3 生命周期钩子。退出时杀掉所有终端防孤儿(§3.2)。
func (*TerminalService) Start ¶
func (s *TerminalService) Start(sessionID, cwd string, cols, rows uint16) (string, error)
Start 新建终端。cwd 由前端传(= Session.WorktreePath 或项目目录),不依赖 store, 保持 terminal 包自包含。返回 terminal id 供前端派发事件。
func (*TerminalService) Write ¶
func (s *TerminalService) Write(id, data string) error
Write 前端 xterm.onData → 写入 PTY stdin。终端已退出则静默忽略(不报错)。