File size: 10,350 Bytes
d90101d | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 | use std::borrow::Cow;
use std::path::PathBuf;
use std::sync::{Arc, Mutex};
use console::{measure_text_width, strip_ansi_codes};
use forge_api::Environment;
use nu_ansi_term::Style;
use rustyline::completion::{Completer, Pair};
use rustyline::config::{ColorMode, CompletionType, Config};
use rustyline::error::ReadlineError as RustyReadlineError;
use rustyline::highlight::Highlighter;
use rustyline::hint::{Hinter, HistoryHinter};
use rustyline::history::DefaultHistory;
use rustyline::validate::Validator;
use rustyline::{
Cmd, Context as RustylineContext, Editor, EventHandler, Helper, KeyCode, KeyEvent, Modifiers,
Prompt as RustylinePrompt,
};
use super::completer::InputCompleter;
use super::zsh::paste::wrap_pasted_text;
use crate::highlighter::ForgeHighlighter;
use crate::model::ForgeCommandManager;
use crate::prompt::ForgePrompt;
const HISTORY_CAPACITY: usize = 1024 * 1024;
/// Interactive terminal editor used by the Forge prompt.
pub struct ForgeEditor {
editor: Editor<ForgeHelper, DefaultHistory>,
history_file: PathBuf,
pending_buffer: Option<String>,
}
/// Result of reading one prompt interaction from the terminal.
#[derive(Debug, PartialEq, Eq)]
pub enum ReadResult {
Success(String),
Empty,
Continue,
Exit,
}
impl ForgeEditor {
/// Creates a new interactive editor with history, completion, and
/// highlighting.
pub fn new(
env: Environment,
custom_history_path: Option<PathBuf>,
manager: Arc<ForgeCommandManager>,
) -> Self {
let history_file = env.history_path(custom_history_path.as_ref());
let helper = ForgeHelper::new(env.cwd, manager);
let config = Config::builder()
.max_history_size(HISTORY_CAPACITY)
.expect("rustyline history capacity should be valid")
.completion_type(CompletionType::List)
.completion_show_all_if_ambiguous(true)
.color_mode(ColorMode::Forced)
.enable_signals(true)
.build();
let mut editor = Editor::<ForgeHelper, DefaultHistory>::with_config(config)
.expect("rustyline editor should initialize for an interactive terminal");
editor.bind_sequence(
KeyEvent(KeyCode::Enter, Modifiers::ALT),
EventHandler::Simple(Cmd::Newline),
);
editor.bind_sequence(
KeyEvent(KeyCode::Char('k'), Modifiers::CTRL),
EventHandler::Simple(Cmd::ClearScreen),
);
editor.bind_sequence(
KeyEvent(KeyCode::Char('K'), Modifiers::CTRL),
EventHandler::Simple(Cmd::ClearScreen),
);
editor.set_helper(Some(helper));
let _ = editor.load_history(&history_file);
Self { editor, history_file, pending_buffer: None }
}
fn normalize_result(&mut self, buffer: String) -> ReadResult {
let result = normalize_result_text(buffer);
if let ReadResult::Success(text) = &result {
let _ = self.editor.add_history_entry(text.as_str());
let _ = self.editor.save_history(&self.history_file);
}
result
}
/// Reads one logical input from the terminal.
pub fn prompt(&mut self, prompt: &mut ForgePrompt) -> anyhow::Result<ReadResult> {
let prompt_text = render_prompt(prompt);
let initial = self.pending_buffer.take().unwrap_or_default();
let readline = if initial.is_empty() {
self.editor.readline(&prompt_text)
} else {
self.editor
.readline_with_initial(&prompt_text, (&initial, ""))
};
prompt.refresh();
match readline {
Ok(buffer) => Ok(self.normalize_result(buffer)),
Err(RustyReadlineError::Interrupted) => Ok(ReadResult::Continue),
Err(RustyReadlineError::Eof) => Ok(ReadResult::Exit),
Err(error) => Err(anyhow::anyhow!(ReadLineError(error))),
}
}
/// Sets the buffer content to be pre-filled on the next prompt.
pub fn set_buffer(&mut self, content: String) {
self.pending_buffer = Some(content);
}
}
#[derive(Debug, thiserror::Error)]
#[error("failed to read line from terminal: {0}")]
pub struct ReadLineError(RustyReadlineError);
fn normalize_result_text(buffer: String) -> ReadResult {
let trimmed = buffer.trim();
if trimmed.is_empty() {
return ReadResult::Empty;
}
ReadResult::Success(wrap_pasted_text(trimmed))
}
fn render_prompt(prompt: &ForgePrompt) -> ResponsivePrompt {
let left = prompt.render_prompt_left();
let indicator = prompt.render_prompt_indicator();
let right = prompt.render_prompt_right();
let right = right.trim_start();
// `raw` is what rustyline measures to position the cursor; `styled` is what
// it prints. `raw` MUST be free of ANSI escapes: rustyline's Windows
// console backend computes cursor columns by counting grapheme widths of
// `raw` (it cannot interpret escape sequences and debug-asserts against
// them), so any styling left in `raw` is counted as visible width and
// pushes the cursor past where the text actually is. The left prompt and
// indicator are styled via `nu_ansi_term`, so strip those codes for `raw`.
// The right prompt is positioned off to the side with cursor save/restore
// and is not part of the input-line geometry, so it is excluded from `raw`
// entirely.
if right.trim().is_empty() {
let styled = format!("{left}{indicator}");
let raw = strip_ansi_codes(&styled).into_owned();
return ResponsivePrompt { raw, styled };
}
if let Some((first_line, remaining)) = left.split_once('\n') {
let right = render_right_prompt(right);
let raw = strip_ansi_codes(&format!("{first_line}\n{remaining}{indicator}")).into_owned();
return ResponsivePrompt {
raw,
styled: format!("{first_line}{right}\n{remaining}{indicator}"),
};
}
let right = render_right_prompt(right);
let raw = strip_ansi_codes(&format!("{left}{indicator}")).into_owned();
ResponsivePrompt { raw, styled: format!("{left}{right}{indicator}") }
}
fn render_right_prompt(right: &str) -> String {
let width = measure_text_width(strip_ansi_codes(right).as_ref());
format!("\x1b[s\x1b[999C\x1b[{width}D{right}\x1b[K\x1b[u")
}
struct ResponsivePrompt {
raw: String,
styled: String,
}
impl RustylinePrompt for ResponsivePrompt {
fn raw(&self) -> &str {
&self.raw
}
fn styled(&self) -> &str {
&self.styled
}
}
struct ForgeHelper {
completer: Mutex<InputCompleter>,
highlighter: ForgeHighlighter,
hinter: HistoryHinter,
}
impl ForgeHelper {
fn new(cwd: PathBuf, command_manager: Arc<ForgeCommandManager>) -> Self {
Self {
completer: Mutex::new(InputCompleter::new(cwd, command_manager)),
highlighter: ForgeHighlighter,
hinter: HistoryHinter {},
}
}
}
impl Helper for ForgeHelper {}
impl Completer for ForgeHelper {
type Candidate = Pair;
fn complete(
&self,
line: &str,
pos: usize,
_ctx: &RustylineContext<'_>,
) -> rustyline::Result<(usize, Vec<Pair>)> {
let mut completer = self
.completer
.lock()
.expect("input completer mutex poisoned");
let suggestions = completer.complete(line, pos);
let start = suggestions
.iter()
.map(|suggestion| suggestion.span.start)
.min()
.unwrap_or(pos);
let pairs = suggestions
.into_iter()
.map(|suggestion| {
let replacement = if suggestion.append_whitespace {
format!("{} ", suggestion.value)
} else {
suggestion.value
};
Pair { display: replacement.clone(), replacement }
})
.collect();
Ok((start, pairs))
}
}
impl Hinter for ForgeHelper {
type Hint = String;
fn hint(&self, line: &str, pos: usize, ctx: &RustylineContext<'_>) -> Option<Self::Hint> {
self.hinter.hint(line, pos, ctx)
}
}
impl Highlighter for ForgeHelper {
fn highlight<'l>(&self, line: &'l str, pos: usize) -> Cow<'l, str> {
let styled = self.highlighter.highlight(line, pos);
if styled.buffer.is_empty() {
return Cow::Borrowed(line);
}
let default_style = Style::new();
let mut rendered = String::with_capacity(line.len());
for (style, text) in styled.buffer {
if style == default_style {
rendered.push_str(&text);
} else {
rendered.push_str(&style.paint(text).to_string());
}
}
Cow::Owned(rendered)
}
fn highlight_hint<'h>(&self, hint: &'h str) -> Cow<'h, str> {
Cow::Owned(Style::new().dimmed().paint(hint).to_string())
}
}
impl Validator for ForgeHelper {}
#[cfg(test)]
mod tests {
use pretty_assertions::assert_eq;
use super::*;
#[test]
fn test_normalize_result_wraps_existing_pasted_path() {
let fixture = "/usr/bin/env".to_string();
let actual = normalize_result_text(fixture);
let expected = ReadResult::Success("@[/usr/bin/env]".to_string());
assert_eq!(actual, expected);
}
#[test]
fn test_render_prompt_raw_has_no_ansi_escapes() {
use std::path::PathBuf;
use forge_api::{AgentId, ModelId};
// rustyline measures `raw()` to position the cursor and, on Windows,
// cannot interpret ANSI escapes (it counts their bytes as visible
// columns). `raw()` must therefore be free of escape sequences even
// though the visible prompt is styled.
let mut prompt = ForgePrompt::new(PathBuf::from("project"), AgentId::default());
prompt.model(ModelId::new("anthropic/claude-opus-4"));
let rendered = render_prompt(&prompt);
assert!(
!rendered.raw.contains('\u{1b}'),
"raw prompt must not contain ANSI escape sequences: {:?}",
rendered.raw
);
// The styled prompt, by contrast, does carry styling for display.
assert!(rendered.styled.contains('\u{1b}'));
}
}
|