1use super::{
2 stack_frame_list::{StackFrameList, StackFrameListEvent},
3 variable_list::VariableList,
4};
5use anyhow::Result;
6use collections::HashMap;
7use dap::OutputEvent;
8use editor::{Bias, CompletionProvider, Editor, EditorElement, EditorStyle, ExcerptId};
9use fuzzy::StringMatchCandidate;
10use gpui::{
11 Context, Entity, FocusHandle, Focusable, Render, Subscription, Task, TextStyle, WeakEntity,
12};
13use language::{Buffer, CodeLabel, ToOffset};
14use menu::Confirm;
15use project::{
16 Completion,
17 debugger::session::{CompletionsQuery, OutputToken, Session},
18};
19use settings::Settings;
20use std::{cell::RefCell, rc::Rc, usize};
21use theme::ThemeSettings;
22use ui::{Divider, prelude::*};
23
24pub struct Console {
25 console: Entity<Editor>,
26 query_bar: Entity<Editor>,
27 session: Entity<Session>,
28 _subscriptions: Vec<Subscription>,
29 variable_list: Entity<VariableList>,
30 stack_frame_list: Entity<StackFrameList>,
31 last_token: OutputToken,
32 update_output_task: Task<()>,
33 focus_handle: FocusHandle,
34}
35
36impl Console {
37 pub fn new(
38 session: Entity<Session>,
39 stack_frame_list: Entity<StackFrameList>,
40 variable_list: Entity<VariableList>,
41 window: &mut Window,
42 cx: &mut Context<Self>,
43 ) -> Self {
44 let console = cx.new(|cx| {
45 let mut editor = Editor::multi_line(window, cx);
46 editor.move_to_end(&editor::actions::MoveToEnd, window, cx);
47 editor.set_read_only(true);
48 editor.disable_scrollbars_and_minimap(window, cx);
49 editor.set_show_gutter(false, cx);
50 editor.set_show_runnables(false, cx);
51 editor.set_show_breakpoints(false, cx);
52 editor.set_show_code_actions(false, cx);
53 editor.set_show_line_numbers(false, cx);
54 editor.set_show_git_diff_gutter(false, cx);
55 editor.set_autoindent(false);
56 editor.set_input_enabled(false);
57 editor.set_use_autoclose(false);
58 editor.set_show_wrap_guides(false, cx);
59 editor.set_show_indent_guides(false, cx);
60 editor.set_show_edit_predictions(Some(false), window, cx);
61 editor.set_use_modal_editing(false);
62 editor.set_soft_wrap_mode(language::language_settings::SoftWrap::EditorWidth, cx);
63 editor
64 });
65 let focus_handle = cx.focus_handle();
66
67 let this = cx.weak_entity();
68 let query_bar = cx.new(|cx| {
69 let mut editor = Editor::single_line(window, cx);
70 editor.set_placeholder_text("Evaluate an expression", cx);
71 editor.set_use_autoclose(false);
72 editor.set_show_gutter(false, cx);
73 editor.set_show_wrap_guides(false, cx);
74 editor.set_show_indent_guides(false, cx);
75 editor.set_completion_provider(Some(Box::new(ConsoleQueryBarCompletionProvider(this))));
76
77 editor
78 });
79
80 let _subscriptions = vec![
81 cx.subscribe(&stack_frame_list, Self::handle_stack_frame_list_events),
82 cx.on_focus_in(&focus_handle, window, |console, window, cx| {
83 if console.is_running(cx) {
84 console.query_bar.focus_handle(cx).focus(window);
85 }
86 }),
87 ];
88
89 Self {
90 session,
91 console,
92 query_bar,
93 variable_list,
94 _subscriptions,
95 stack_frame_list,
96 update_output_task: Task::ready(()),
97 last_token: OutputToken(0),
98 focus_handle,
99 }
100 }
101
102 #[cfg(test)]
103 pub(crate) fn editor(&self) -> &Entity<Editor> {
104 &self.console
105 }
106
107 fn is_running(&self, cx: &Context<Self>) -> bool {
108 self.session.read(cx).is_local()
109 }
110
111 fn handle_stack_frame_list_events(
112 &mut self,
113 _: Entity<StackFrameList>,
114 event: &StackFrameListEvent,
115 cx: &mut Context<Self>,
116 ) {
117 match event {
118 StackFrameListEvent::SelectedStackFrameChanged(_) => cx.notify(),
119 StackFrameListEvent::BuiltEntries => {}
120 }
121 }
122
123 pub(crate) fn show_indicator(&self, cx: &App) -> bool {
124 self.session.read(cx).has_new_output(self.last_token)
125 }
126
127 pub fn add_messages<'a>(
128 &mut self,
129 events: impl Iterator<Item = &'a OutputEvent>,
130 window: &mut Window,
131 cx: &mut App,
132 ) {
133 self.console.update(cx, |console, cx| {
134 let mut to_insert = String::default();
135 for event in events {
136 use std::fmt::Write;
137
138 _ = write!(to_insert, "{}\n", event.output.trim_end());
139 }
140
141 console.set_read_only(false);
142 console.move_to_end(&editor::actions::MoveToEnd, window, cx);
143 console.insert(&to_insert, window, cx);
144 console.set_read_only(true);
145
146 cx.notify();
147 });
148 }
149
150 pub fn evaluate(&mut self, _: &Confirm, window: &mut Window, cx: &mut Context<Self>) {
151 let expression = self.query_bar.update(cx, |editor, cx| {
152 let expression = editor.text(cx);
153
154 editor.clear(window, cx);
155
156 expression
157 });
158
159 self.session.update(cx, |session, cx| {
160 session
161 .evaluate(
162 expression,
163 Some(dap::EvaluateArgumentsContext::Repl),
164 self.stack_frame_list.read(cx).selected_stack_frame_id(),
165 None,
166 cx,
167 )
168 .detach();
169 });
170 }
171
172 fn render_console(&self, cx: &Context<Self>) -> impl IntoElement {
173 EditorElement::new(&self.console, self.editor_style(cx))
174 }
175
176 fn editor_style(&self, cx: &Context<Self>) -> EditorStyle {
177 let settings = ThemeSettings::get_global(cx);
178 let text_style = TextStyle {
179 color: if self.console.read(cx).read_only(cx) {
180 cx.theme().colors().text_disabled
181 } else {
182 cx.theme().colors().text
183 },
184 font_family: settings.buffer_font.family.clone(),
185 font_features: settings.buffer_font.features.clone(),
186 font_size: settings.buffer_font_size(cx).into(),
187 font_weight: settings.buffer_font.weight,
188 line_height: relative(settings.buffer_line_height.value()),
189 ..Default::default()
190 };
191 EditorStyle {
192 background: cx.theme().colors().editor_background,
193 local_player: cx.theme().players().local(),
194 text: text_style,
195 ..Default::default()
196 }
197 }
198
199 fn render_query_bar(&self, cx: &Context<Self>) -> impl IntoElement {
200 EditorElement::new(&self.query_bar, self.editor_style(cx))
201 }
202}
203
204impl Render for Console {
205 fn render(&mut self, window: &mut Window, cx: &mut Context<Self>) -> impl IntoElement {
206 let session = self.session.clone();
207 let token = self.last_token;
208 self.update_output_task = cx.spawn_in(window, async move |this, cx| {
209 _ = session.update_in(cx, move |session, window, cx| {
210 let (output, last_processed_token) = session.output(token);
211
212 _ = this.update(cx, |this, cx| {
213 if last_processed_token == this.last_token {
214 return;
215 }
216 this.add_messages(output, window, cx);
217
218 this.last_token = last_processed_token;
219 });
220 });
221 });
222
223 v_flex()
224 .track_focus(&self.focus_handle)
225 .key_context("DebugConsole")
226 .on_action(cx.listener(Self::evaluate))
227 .size_full()
228 .child(self.render_console(cx))
229 .when(self.is_running(cx), |this| {
230 this.child(Divider::horizontal())
231 .child(self.render_query_bar(cx))
232 })
233 .border_2()
234 }
235}
236
237impl Focusable for Console {
238 fn focus_handle(&self, _cx: &App) -> gpui::FocusHandle {
239 self.focus_handle.clone()
240 }
241}
242
243struct ConsoleQueryBarCompletionProvider(WeakEntity<Console>);
244
245impl CompletionProvider for ConsoleQueryBarCompletionProvider {
246 fn completions(
247 &self,
248 _excerpt_id: ExcerptId,
249 buffer: &Entity<Buffer>,
250 buffer_position: language::Anchor,
251 _trigger: editor::CompletionContext,
252 _window: &mut Window,
253 cx: &mut Context<Editor>,
254 ) -> Task<Result<Option<Vec<Completion>>>> {
255 let Some(console) = self.0.upgrade() else {
256 return Task::ready(Ok(None));
257 };
258
259 let support_completions = console
260 .read(cx)
261 .session
262 .read(cx)
263 .capabilities()
264 .supports_completions_request
265 .unwrap_or_default();
266
267 if support_completions {
268 self.client_completions(&console, buffer, buffer_position, cx)
269 } else {
270 self.variable_list_completions(&console, buffer, buffer_position, cx)
271 }
272 }
273
274 fn resolve_completions(
275 &self,
276 _buffer: Entity<Buffer>,
277 _completion_indices: Vec<usize>,
278 _completions: Rc<RefCell<Box<[Completion]>>>,
279 _cx: &mut Context<Editor>,
280 ) -> gpui::Task<gpui::Result<bool>> {
281 Task::ready(Ok(false))
282 }
283
284 fn apply_additional_edits_for_completion(
285 &self,
286 _buffer: Entity<Buffer>,
287 _completions: Rc<RefCell<Box<[Completion]>>>,
288 _completion_index: usize,
289 _push_to_history: bool,
290 _cx: &mut Context<Editor>,
291 ) -> gpui::Task<gpui::Result<Option<language::Transaction>>> {
292 Task::ready(Ok(None))
293 }
294
295 fn is_completion_trigger(
296 &self,
297 _buffer: &Entity<Buffer>,
298 _position: language::Anchor,
299 _text: &str,
300 _trigger_in_words: bool,
301 _cx: &mut Context<Editor>,
302 ) -> bool {
303 true
304 }
305}
306
307impl ConsoleQueryBarCompletionProvider {
308 fn variable_list_completions(
309 &self,
310 console: &Entity<Console>,
311 buffer: &Entity<Buffer>,
312 buffer_position: language::Anchor,
313 cx: &mut Context<Editor>,
314 ) -> Task<Result<Option<Vec<Completion>>>> {
315 let (variables, string_matches) = console.update(cx, |console, cx| {
316 let mut variables = HashMap::default();
317 let mut string_matches = Vec::default();
318
319 for variable in console.variable_list.update(cx, |variable_list, cx| {
320 variable_list.completion_variables(cx)
321 }) {
322 if let Some(evaluate_name) = &variable.evaluate_name {
323 variables.insert(evaluate_name.clone(), variable.value.clone());
324 string_matches.push(StringMatchCandidate {
325 id: 0,
326 string: evaluate_name.clone(),
327 char_bag: evaluate_name.chars().collect(),
328 });
329 }
330
331 variables.insert(variable.name.clone(), variable.value.clone());
332
333 string_matches.push(StringMatchCandidate {
334 id: 0,
335 string: variable.name.clone(),
336 char_bag: variable.name.chars().collect(),
337 });
338 }
339
340 (variables, string_matches)
341 });
342
343 let query = buffer.read(cx).text();
344
345 cx.spawn(async move |_, cx| {
346 let matches = fuzzy::match_strings(
347 &string_matches,
348 &query,
349 true,
350 10,
351 &Default::default(),
352 cx.background_executor().clone(),
353 )
354 .await;
355
356 Ok(Some(
357 matches
358 .iter()
359 .filter_map(|string_match| {
360 let variable_value = variables.get(&string_match.string)?;
361
362 Some(project::Completion {
363 replace_range: buffer_position..buffer_position,
364 new_text: string_match.string.clone(),
365 label: CodeLabel {
366 filter_range: 0..string_match.string.len(),
367 text: format!("{} {}", string_match.string.clone(), variable_value),
368 runs: Vec::new(),
369 },
370 icon_path: None,
371 documentation: None,
372 confirm: None,
373 source: project::CompletionSource::Custom,
374 insert_text_mode: None,
375 })
376 })
377 .collect(),
378 ))
379 })
380 }
381
382 fn client_completions(
383 &self,
384 console: &Entity<Console>,
385 buffer: &Entity<Buffer>,
386 buffer_position: language::Anchor,
387 cx: &mut Context<Editor>,
388 ) -> Task<Result<Option<Vec<Completion>>>> {
389 let completion_task = console.update(cx, |console, cx| {
390 console.session.update(cx, |state, cx| {
391 let frame_id = console.stack_frame_list.read(cx).selected_stack_frame_id();
392
393 state.completions(
394 CompletionsQuery::new(buffer.read(cx), buffer_position, frame_id),
395 cx,
396 )
397 })
398 });
399 let snapshot = buffer.read(cx).text_snapshot();
400 cx.background_executor().spawn(async move {
401 let completions = completion_task.await?;
402
403 Ok(Some(
404 completions
405 .into_iter()
406 .map(|completion| {
407 let new_text = completion
408 .text
409 .as_ref()
410 .unwrap_or(&completion.label)
411 .to_owned();
412 let buffer_text = snapshot.text();
413 let buffer_bytes = buffer_text.as_bytes();
414 let new_bytes = new_text.as_bytes();
415
416 let mut prefix_len = 0;
417 for i in (0..new_bytes.len()).rev() {
418 if buffer_bytes.ends_with(&new_bytes[0..i]) {
419 prefix_len = i;
420 break;
421 }
422 }
423
424 let buffer_offset = buffer_position.to_offset(&snapshot);
425 let start = buffer_offset - prefix_len;
426 let start = snapshot.clip_offset(start, Bias::Left);
427 let start = snapshot.anchor_before(start);
428 let replace_range = start..buffer_position;
429
430 project::Completion {
431 replace_range,
432 new_text,
433 label: CodeLabel {
434 filter_range: 0..completion.label.len(),
435 text: completion.label,
436 runs: Vec::new(),
437 },
438 icon_path: None,
439 documentation: None,
440 confirm: None,
441 source: project::CompletionSource::BufferWord {
442 word_range: buffer_position..language::Anchor::MAX,
443 resolved: false,
444 },
445 insert_text_mode: None,
446 }
447 })
448 .collect(),
449 ))
450 })
451 }
452}