1pub mod editor_lsp_test_context;
2pub mod editor_test_context;
3
4use std::{rc::Rc, sync::LazyLock};
5
6pub use crate::rust_analyzer_ext::expand_macro_recursively;
7use crate::{
8 DisplayPoint, Editor, EditorMode, FoldPlaceholder, MultiBuffer, SelectionEffects,
9 display_map::{
10 Block, BlockPlacement, CustomBlockId, DisplayMap, DisplayRow, DisplaySnapshot,
11 ToDisplayPoint,
12 },
13};
14use collections::HashMap;
15use gpui::{
16 AppContext as _, Context, Entity, EntityId, Font, FontFeatures, FontStyle, FontWeight, Pixels,
17 VisualTestContext, Window, font, size,
18};
19use multi_buffer::{MultiBufferOffset, ToPoint};
20use pretty_assertions::assert_eq;
21use project::{Project, project_settings::DiagnosticSeverity};
22use ui::{App, BorrowAppContext, px};
23use util::test::{generate_marked_text, marked_text_offsets, marked_text_ranges};
24
25#[cfg(test)]
26#[ctor::ctor]
27fn init_logger() {
28 zlog::init_test();
29}
30
31pub fn test_font() -> Font {
32 static TEST_FONT: LazyLock<Font> = LazyLock::new(|| {
33 #[cfg(not(target_os = "windows"))]
34 {
35 font("Helvetica")
36 }
37
38 #[cfg(target_os = "windows")]
39 {
40 font("Courier New")
41 }
42 });
43
44 TEST_FONT.clone()
45}
46
47// Returns a snapshot from text containing '|' character markers with the markers removed, and DisplayPoints for each one.
48#[track_caller]
49pub fn marked_display_snapshot(
50 text: &str,
51 cx: &mut gpui::App,
52) -> (DisplaySnapshot, Vec<DisplayPoint>) {
53 let (unmarked_text, markers) = marked_text_offsets(text);
54
55 let font = Font {
56 family: ".ZedMono".into(),
57 features: FontFeatures::default(),
58 fallbacks: None,
59 weight: FontWeight::default(),
60 style: FontStyle::default(),
61 };
62 let font_size: Pixels = 14usize.into();
63
64 let buffer = MultiBuffer::build_simple(&unmarked_text, cx);
65 let display_map = cx.new(|cx| {
66 DisplayMap::new(
67 buffer,
68 font,
69 font_size,
70 None,
71 1,
72 1,
73 FoldPlaceholder::test(),
74 DiagnosticSeverity::Warning,
75 cx,
76 )
77 });
78 let snapshot = display_map.update(cx, |map, cx| map.snapshot(cx));
79 let markers = markers
80 .into_iter()
81 .map(|offset| MultiBufferOffset(offset).to_display_point(&snapshot))
82 .collect();
83
84 (snapshot, markers)
85}
86
87#[track_caller]
88pub fn select_ranges(
89 editor: &mut Editor,
90 marked_text: &str,
91 window: &mut Window,
92 cx: &mut Context<Editor>,
93) {
94 let (unmarked_text, text_ranges) = marked_text_ranges(marked_text, true);
95 assert_eq!(editor.text(cx), unmarked_text);
96 editor.change_selections(SelectionEffects::no_scroll(), window, cx, |s| {
97 s.select_ranges(
98 text_ranges
99 .into_iter()
100 .map(|range| MultiBufferOffset(range.start)..MultiBufferOffset(range.end)),
101 )
102 });
103}
104
105#[track_caller]
106pub fn assert_text_with_selections(
107 editor: &mut Editor,
108 marked_text: &str,
109 cx: &mut Context<Editor>,
110) {
111 let (unmarked_text, _text_ranges) = marked_text_ranges(marked_text, true);
112 assert_eq!(editor.text(cx), unmarked_text, "text doesn't match");
113 let actual = generate_marked_text(
114 &editor.text(cx),
115 &editor
116 .selections
117 .ranges::<MultiBufferOffset>(&editor.display_snapshot(cx))
118 .into_iter()
119 .map(|range| range.start.0..range.end.0)
120 .collect::<Vec<_>>(),
121 marked_text.contains("«"),
122 );
123 assert_eq!(actual, marked_text, "Selections don't match");
124}
125
126// RA thinks this is dead code even though it is used in a whole lot of tests
127#[allow(dead_code)]
128#[cfg(any(test, feature = "test-support"))]
129pub(crate) fn build_editor(
130 buffer: Entity<MultiBuffer>,
131 window: &mut Window,
132 cx: &mut Context<Editor>,
133) -> Editor {
134 Editor::new(EditorMode::full(), buffer, None, window, cx)
135}
136
137pub(crate) fn build_editor_with_project(
138 project: Entity<Project>,
139 buffer: Entity<MultiBuffer>,
140 window: &mut Window,
141 cx: &mut Context<Editor>,
142) -> Editor {
143 Editor::new(EditorMode::full(), buffer, Some(project), window, cx)
144}
145
146#[derive(Default)]
147struct TestBlockContent(
148 HashMap<(EntityId, CustomBlockId), Rc<dyn Fn(&mut VisualTestContext) -> String>>,
149);
150
151impl gpui::Global for TestBlockContent {}
152
153pub fn set_block_content_for_tests(
154 editor: &Entity<Editor>,
155 id: CustomBlockId,
156 cx: &mut App,
157 f: impl Fn(&mut VisualTestContext) -> String + 'static,
158) {
159 cx.update_default_global::<TestBlockContent, _>(|bc, _| {
160 bc.0.insert((editor.entity_id(), id), Rc::new(f))
161 });
162}
163
164pub fn block_content_for_tests(
165 editor: &Entity<Editor>,
166 id: CustomBlockId,
167 cx: &mut VisualTestContext,
168) -> Option<String> {
169 let f = cx.update(|_, cx| {
170 cx.default_global::<TestBlockContent>()
171 .0
172 .get(&(editor.entity_id(), id))
173 .cloned()
174 })?;
175 Some(f(cx))
176}
177
178pub fn editor_content_with_blocks(editor: &Entity<Editor>, cx: &mut VisualTestContext) -> String {
179 cx.draw(
180 gpui::Point::default(),
181 size(px(3000.0), px(3000.0)),
182 |_, _| editor.clone(),
183 );
184 let (snapshot, mut lines, blocks) = editor.update_in(cx, |editor, window, cx| {
185 let snapshot = editor.snapshot(window, cx);
186 let text = editor.display_text(cx);
187 let lines = text.lines().map(|s| s.to_string()).collect::<Vec<String>>();
188 let blocks = snapshot
189 .blocks_in_range(DisplayRow(0)..snapshot.max_point().row())
190 .map(|(row, block)| (row, block.clone()))
191 .collect::<Vec<_>>();
192 (snapshot, lines, blocks)
193 });
194 for (row, block) in blocks {
195 match block {
196 Block::Custom(custom_block) => {
197 if let BlockPlacement::Near(x) = &custom_block.placement
198 && snapshot.intersects_fold(x.to_point(&snapshot.buffer_snapshot()))
199 {
200 continue;
201 };
202 let content = block_content_for_tests(editor, custom_block.id, cx)
203 .expect("block content not found");
204 // 2: "related info 1 for diagnostic 0"
205 if let Some(height) = custom_block.height {
206 if height == 0 {
207 lines[row.0 as usize - 1].push_str(" § ");
208 lines[row.0 as usize - 1].push_str(&content);
209 } else {
210 let block_lines = content.lines().collect::<Vec<_>>();
211 assert_eq!(block_lines.len(), height as usize);
212 lines[row.0 as usize].push_str("§ ");
213 lines[row.0 as usize].push_str(block_lines[0].trim_end());
214 for i in 1..height as usize {
215 if row.0 as usize + i >= lines.len() {
216 lines.push("".to_string());
217 };
218 lines[row.0 as usize + i].push_str("§ ");
219 lines[row.0 as usize + i].push_str(block_lines[i].trim_end());
220 }
221 }
222 }
223 }
224 Block::FoldedBuffer {
225 first_excerpt,
226 height,
227 } => {
228 lines[row.0 as usize].push_str(&cx.update(|_, cx| {
229 format!("§ {}", first_excerpt.buffer.file().unwrap().file_name(cx))
230 }));
231 for row in row.0 + 1..row.0 + height {
232 lines[row as usize].push_str("§ -----");
233 }
234 }
235 Block::ExcerptBoundary { height, .. } => {
236 for row in row.0..row.0 + height {
237 lines[row as usize].push_str("§ -----");
238 }
239 }
240 Block::BufferHeader { excerpt, height } => {
241 lines[row.0 as usize].push_str(
242 &cx.update(|_, cx| {
243 format!("§ {}", excerpt.buffer.file().unwrap().file_name(cx))
244 }),
245 );
246 for row in row.0 + 1..row.0 + height {
247 lines[row as usize].push_str("§ -----");
248 }
249 }
250 }
251 }
252 lines.join("\n")
253}