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::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| 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(text_ranges)
98 });
99}
100
101#[track_caller]
102pub fn assert_text_with_selections(
103 editor: &mut Editor,
104 marked_text: &str,
105 cx: &mut Context<Editor>,
106) {
107 let (unmarked_text, _text_ranges) = marked_text_ranges(marked_text, true);
108 assert_eq!(editor.text(cx), unmarked_text, "text doesn't match");
109 let actual = generate_marked_text(
110 &editor.text(cx),
111 &editor.selections.ranges(&editor.display_snapshot(cx)),
112 marked_text.contains("«"),
113 );
114 assert_eq!(actual, marked_text, "Selections don't match");
115}
116
117// RA thinks this is dead code even though it is used in a whole lot of tests
118#[allow(dead_code)]
119#[cfg(any(test, feature = "test-support"))]
120pub(crate) fn build_editor(
121 buffer: Entity<MultiBuffer>,
122 window: &mut Window,
123 cx: &mut Context<Editor>,
124) -> Editor {
125 Editor::new(EditorMode::full(), buffer, None, window, cx)
126}
127
128pub(crate) fn build_editor_with_project(
129 project: Entity<Project>,
130 buffer: Entity<MultiBuffer>,
131 window: &mut Window,
132 cx: &mut Context<Editor>,
133) -> Editor {
134 Editor::new(EditorMode::full(), buffer, Some(project), window, cx)
135}
136
137#[derive(Default)]
138struct TestBlockContent(
139 HashMap<(EntityId, CustomBlockId), Rc<dyn Fn(&mut VisualTestContext) -> String>>,
140);
141
142impl gpui::Global for TestBlockContent {}
143
144pub fn set_block_content_for_tests(
145 editor: &Entity<Editor>,
146 id: CustomBlockId,
147 cx: &mut App,
148 f: impl Fn(&mut VisualTestContext) -> String + 'static,
149) {
150 cx.update_default_global::<TestBlockContent, _>(|bc, _| {
151 bc.0.insert((editor.entity_id(), id), Rc::new(f))
152 });
153}
154
155pub fn block_content_for_tests(
156 editor: &Entity<Editor>,
157 id: CustomBlockId,
158 cx: &mut VisualTestContext,
159) -> Option<String> {
160 let f = cx.update(|_, cx| {
161 cx.default_global::<TestBlockContent>()
162 .0
163 .get(&(editor.entity_id(), id))
164 .cloned()
165 })?;
166 Some(f(cx))
167}
168
169pub fn editor_content_with_blocks(editor: &Entity<Editor>, cx: &mut VisualTestContext) -> String {
170 cx.draw(
171 gpui::Point::default(),
172 size(px(3000.0), px(3000.0)),
173 |_, _| editor.clone(),
174 );
175 let (snapshot, mut lines, blocks) = editor.update_in(cx, |editor, window, cx| {
176 let snapshot = editor.snapshot(window, cx);
177 let text = editor.display_text(cx);
178 let lines = text.lines().map(|s| s.to_string()).collect::<Vec<String>>();
179 let blocks = snapshot
180 .blocks_in_range(DisplayRow(0)..snapshot.max_point().row())
181 .map(|(row, block)| (row, block.clone()))
182 .collect::<Vec<_>>();
183 (snapshot, lines, blocks)
184 });
185 for (row, block) in blocks {
186 match block {
187 Block::Custom(custom_block) => {
188 if let BlockPlacement::Near(x) = &custom_block.placement
189 && snapshot.intersects_fold(x.to_point(&snapshot.buffer_snapshot()))
190 {
191 continue;
192 };
193 let content = block_content_for_tests(editor, custom_block.id, cx)
194 .expect("block content not found");
195 // 2: "related info 1 for diagnostic 0"
196 if let Some(height) = custom_block.height {
197 if height == 0 {
198 lines[row.0 as usize - 1].push_str(" § ");
199 lines[row.0 as usize - 1].push_str(&content);
200 } else {
201 let block_lines = content.lines().collect::<Vec<_>>();
202 assert_eq!(block_lines.len(), height as usize);
203 lines[row.0 as usize].push_str("§ ");
204 lines[row.0 as usize].push_str(block_lines[0].trim_end());
205 for i in 1..height as usize {
206 if row.0 as usize + i >= lines.len() {
207 lines.push("".to_string());
208 };
209 lines[row.0 as usize + i].push_str("§ ");
210 lines[row.0 as usize + i].push_str(block_lines[i].trim_end());
211 }
212 }
213 }
214 }
215 Block::FoldedBuffer {
216 first_excerpt,
217 height,
218 } => {
219 lines[row.0 as usize].push_str(&cx.update(|_, cx| {
220 format!("§ {}", first_excerpt.buffer.file().unwrap().file_name(cx))
221 }));
222 for row in row.0 + 1..row.0 + height {
223 lines[row as usize].push_str("§ -----");
224 }
225 }
226 Block::ExcerptBoundary { height, .. } => {
227 for row in row.0..row.0 + height {
228 lines[row as usize].push_str("§ -----");
229 }
230 }
231 Block::BufferHeader { excerpt, height } => {
232 lines[row.0 as usize].push_str(
233 &cx.update(|_, cx| {
234 format!("§ {}", excerpt.buffer.file().unwrap().file_name(cx))
235 }),
236 );
237 for row in row.0 + 1..row.0 + height {
238 lines[row as usize].push_str("§ -----");
239 }
240 }
241 }
242 }
243 lines.join("\n")
244}