message_editor.rs

  1use anyhow::{Context as _, Result};
  2use channel::{ChannelChat, ChannelStore, MessageParams};
  3use client::{UserId, UserStore};
  4use collections::HashSet;
  5use editor::{AnchorRangeExt, CompletionProvider, Editor, EditorElement, EditorStyle, ExcerptId};
  6use fuzzy::{StringMatch, StringMatchCandidate};
  7use gpui::{
  8    AsyncApp, AsyncWindowContext, Context, Entity, Focusable, FontStyle, FontWeight,
  9    HighlightStyle, IntoElement, Render, Task, TextStyle, WeakEntity, Window,
 10};
 11use language::{
 12    Anchor, Buffer, BufferSnapshot, CodeLabel, LanguageRegistry, ToOffset,
 13    language_settings::SoftWrap,
 14};
 15use project::{Completion, CompletionSource, search::SearchQuery};
 16use settings::Settings;
 17use std::{
 18    cell::RefCell,
 19    ops::Range,
 20    rc::Rc,
 21    sync::{Arc, LazyLock},
 22    time::Duration,
 23};
 24use theme::ThemeSettings;
 25use ui::{TextSize, prelude::*};
 26
 27use crate::panel_settings::MessageEditorSettings;
 28
 29const MENTIONS_DEBOUNCE_INTERVAL: Duration = Duration::from_millis(50);
 30
 31static MENTIONS_SEARCH: LazyLock<SearchQuery> = LazyLock::new(|| {
 32    SearchQuery::regex(
 33        "@[-_\\w]+",
 34        false,
 35        false,
 36        false,
 37        Default::default(),
 38        Default::default(),
 39        None,
 40    )
 41    .unwrap()
 42});
 43
 44pub struct MessageEditor {
 45    pub editor: Entity<Editor>,
 46    user_store: Entity<UserStore>,
 47    channel_chat: Option<Entity<ChannelChat>>,
 48    mentions: Vec<UserId>,
 49    mentions_task: Option<Task<()>>,
 50    reply_to_message_id: Option<u64>,
 51    edit_message_id: Option<u64>,
 52}
 53
 54struct MessageEditorCompletionProvider(WeakEntity<MessageEditor>);
 55
 56impl CompletionProvider for MessageEditorCompletionProvider {
 57    fn completions(
 58        &self,
 59        _excerpt_id: ExcerptId,
 60        buffer: &Entity<Buffer>,
 61        buffer_position: language::Anchor,
 62        _: editor::CompletionContext,
 63        _window: &mut Window,
 64        cx: &mut Context<Editor>,
 65    ) -> Task<Result<Option<Vec<Completion>>>> {
 66        let Some(handle) = self.0.upgrade() else {
 67            return Task::ready(Ok(None));
 68        };
 69        handle.update(cx, |message_editor, cx| {
 70            message_editor.completions(buffer, buffer_position, cx)
 71        })
 72    }
 73
 74    fn resolve_completions(
 75        &self,
 76        _buffer: Entity<Buffer>,
 77        _completion_indices: Vec<usize>,
 78        _completions: Rc<RefCell<Box<[Completion]>>>,
 79        _cx: &mut Context<Editor>,
 80    ) -> Task<anyhow::Result<bool>> {
 81        Task::ready(Ok(false))
 82    }
 83
 84    fn is_completion_trigger(
 85        &self,
 86        _buffer: &Entity<Buffer>,
 87        _position: language::Anchor,
 88        text: &str,
 89        _trigger_in_words: bool,
 90        _cx: &mut Context<Editor>,
 91    ) -> bool {
 92        text == "@"
 93    }
 94}
 95
 96impl MessageEditor {
 97    pub fn new(
 98        language_registry: Arc<LanguageRegistry>,
 99        user_store: Entity<UserStore>,
100        channel_chat: Option<Entity<ChannelChat>>,
101        editor: Entity<Editor>,
102        window: &mut Window,
103        cx: &mut Context<Self>,
104    ) -> Self {
105        let this = cx.entity().downgrade();
106        editor.update(cx, |editor, cx| {
107            editor.set_soft_wrap_mode(SoftWrap::EditorWidth, cx);
108            editor.set_use_autoclose(false);
109            editor.set_show_gutter(false, cx);
110            editor.set_show_wrap_guides(false, cx);
111            editor.set_show_indent_guides(false, cx);
112            editor.set_completion_provider(Some(Box::new(MessageEditorCompletionProvider(this))));
113            editor.set_auto_replace_emoji_shortcode(
114                MessageEditorSettings::get_global(cx)
115                    .auto_replace_emoji_shortcode
116                    .unwrap_or_default(),
117            );
118        });
119
120        let buffer = editor
121            .read(cx)
122            .buffer()
123            .read(cx)
124            .as_singleton()
125            .expect("message editor must be singleton");
126
127        cx.subscribe_in(&buffer, window, Self::on_buffer_event)
128            .detach();
129        cx.observe_global::<settings::SettingsStore>(|this, cx| {
130            this.editor.update(cx, |editor, cx| {
131                editor.set_auto_replace_emoji_shortcode(
132                    MessageEditorSettings::get_global(cx)
133                        .auto_replace_emoji_shortcode
134                        .unwrap_or_default(),
135                )
136            })
137        })
138        .detach();
139
140        let markdown = language_registry.language_for_name("Markdown");
141        cx.spawn_in(window, async move |_, cx| {
142            let markdown = markdown.await.context("failed to load Markdown language")?;
143            buffer.update(cx, |buffer, cx| buffer.set_language(Some(markdown), cx))
144        })
145        .detach_and_log_err(cx);
146
147        Self {
148            editor,
149            user_store,
150            channel_chat,
151            mentions: Vec::new(),
152            mentions_task: None,
153            reply_to_message_id: None,
154            edit_message_id: None,
155        }
156    }
157
158    pub fn reply_to_message_id(&self) -> Option<u64> {
159        self.reply_to_message_id
160    }
161
162    pub fn set_reply_to_message_id(&mut self, reply_to_message_id: u64) {
163        self.reply_to_message_id = Some(reply_to_message_id);
164    }
165
166    pub fn clear_reply_to_message_id(&mut self) {
167        self.reply_to_message_id = None;
168    }
169
170    pub fn edit_message_id(&self) -> Option<u64> {
171        self.edit_message_id
172    }
173
174    pub fn set_edit_message_id(&mut self, edit_message_id: u64) {
175        self.edit_message_id = Some(edit_message_id);
176    }
177
178    pub fn clear_edit_message_id(&mut self) {
179        self.edit_message_id = None;
180    }
181
182    pub fn set_channel_chat(&mut self, chat: Entity<ChannelChat>, cx: &mut Context<Self>) {
183        let channel_id = chat.read(cx).channel_id;
184        self.channel_chat = Some(chat);
185        let channel_name = ChannelStore::global(cx)
186            .read(cx)
187            .channel_for_id(channel_id)
188            .map(|channel| channel.name.clone());
189        self.editor.update(cx, |editor, cx| {
190            if let Some(channel_name) = channel_name {
191                editor.set_placeholder_text(format!("Message #{channel_name}"), cx);
192            } else {
193                editor.set_placeholder_text("Message Channel", cx);
194            }
195        });
196    }
197
198    pub fn take_message(&mut self, window: &mut Window, cx: &mut Context<Self>) -> MessageParams {
199        self.editor.update(cx, |editor, cx| {
200            let highlights = editor.text_highlights::<Self>(cx);
201            let text = editor.text(cx);
202            let snapshot = editor.buffer().read(cx).snapshot(cx);
203            let mentions = if let Some((_, ranges)) = highlights {
204                ranges
205                    .iter()
206                    .map(|range| range.to_offset(&snapshot))
207                    .zip(self.mentions.iter().copied())
208                    .collect()
209            } else {
210                Vec::new()
211            };
212
213            editor.clear(window, cx);
214            self.mentions.clear();
215            let reply_to_message_id = std::mem::take(&mut self.reply_to_message_id);
216
217            MessageParams {
218                text,
219                mentions,
220                reply_to_message_id,
221            }
222        })
223    }
224
225    fn on_buffer_event(
226        &mut self,
227        buffer: &Entity<Buffer>,
228        event: &language::BufferEvent,
229        window: &mut Window,
230        cx: &mut Context<Self>,
231    ) {
232        if let language::BufferEvent::Reparsed | language::BufferEvent::Edited = event {
233            let buffer = buffer.read(cx).snapshot();
234            self.mentions_task = Some(cx.spawn_in(window, async move |this, cx| {
235                cx.background_executor()
236                    .timer(MENTIONS_DEBOUNCE_INTERVAL)
237                    .await;
238                Self::find_mentions(this, buffer, cx).await;
239            }));
240        }
241    }
242
243    fn completions(
244        &mut self,
245        buffer: &Entity<Buffer>,
246        end_anchor: Anchor,
247        cx: &mut Context<Self>,
248    ) -> Task<Result<Option<Vec<Completion>>>> {
249        if let Some((start_anchor, query, candidates)) =
250            self.collect_mention_candidates(buffer, end_anchor, cx)
251        {
252            if !candidates.is_empty() {
253                return cx.spawn(async move |_, cx| {
254                    Ok(Some(
255                        Self::resolve_completions_for_candidates(
256                            &cx,
257                            query.as_str(),
258                            &candidates,
259                            start_anchor..end_anchor,
260                            Self::completion_for_mention,
261                        )
262                        .await,
263                    ))
264                });
265            }
266        }
267
268        if let Some((start_anchor, query, candidates)) =
269            self.collect_emoji_candidates(buffer, end_anchor, cx)
270        {
271            if !candidates.is_empty() {
272                return cx.spawn(async move |_, cx| {
273                    Ok(Some(
274                        Self::resolve_completions_for_candidates(
275                            &cx,
276                            query.as_str(),
277                            candidates,
278                            start_anchor..end_anchor,
279                            Self::completion_for_emoji,
280                        )
281                        .await,
282                    ))
283                });
284            }
285        }
286
287        Task::ready(Ok(Some(Vec::new())))
288    }
289
290    async fn resolve_completions_for_candidates(
291        cx: &AsyncApp,
292        query: &str,
293        candidates: &[StringMatchCandidate],
294        range: Range<Anchor>,
295        completion_fn: impl Fn(&StringMatch) -> (String, CodeLabel),
296    ) -> Vec<Completion> {
297        let matches = fuzzy::match_strings(
298            candidates,
299            query,
300            true,
301            10,
302            &Default::default(),
303            cx.background_executor().clone(),
304        )
305        .await;
306
307        matches
308            .into_iter()
309            .map(|mat| {
310                let (new_text, label) = completion_fn(&mat);
311                Completion {
312                    old_range: range.clone(),
313                    new_text,
314                    label,
315                    icon_path: None,
316                    confirm: None,
317                    documentation: None,
318                    source: CompletionSource::Custom,
319                }
320            })
321            .collect()
322    }
323
324    fn completion_for_mention(mat: &StringMatch) -> (String, CodeLabel) {
325        let label = CodeLabel {
326            filter_range: 1..mat.string.len() + 1,
327            text: format!("@{}", mat.string),
328            runs: Vec::new(),
329        };
330        (mat.string.clone(), label)
331    }
332
333    fn completion_for_emoji(mat: &StringMatch) -> (String, CodeLabel) {
334        let emoji = emojis::get_by_shortcode(&mat.string).unwrap();
335        let label = CodeLabel {
336            filter_range: 1..mat.string.len() + 1,
337            text: format!(":{}: {}", mat.string, emoji),
338            runs: Vec::new(),
339        };
340        (emoji.to_string(), label)
341    }
342
343    fn collect_mention_candidates(
344        &mut self,
345        buffer: &Entity<Buffer>,
346        end_anchor: Anchor,
347        cx: &mut Context<Self>,
348    ) -> Option<(Anchor, String, Vec<StringMatchCandidate>)> {
349        let end_offset = end_anchor.to_offset(buffer.read(cx));
350
351        let query = buffer.update(cx, |buffer, _| {
352            let mut query = String::new();
353            for ch in buffer.reversed_chars_at(end_offset).take(100) {
354                if ch == '@' {
355                    return Some(query.chars().rev().collect::<String>());
356                }
357                if ch.is_whitespace() || !ch.is_ascii() {
358                    break;
359                }
360                query.push(ch);
361            }
362            None
363        })?;
364
365        let start_offset = end_offset - query.len();
366        let start_anchor = buffer.read(cx).anchor_before(start_offset);
367
368        let mut names = HashSet::default();
369        if let Some(chat) = self.channel_chat.as_ref() {
370            let chat = chat.read(cx);
371            for participant in ChannelStore::global(cx)
372                .read(cx)
373                .channel_participants(chat.channel_id)
374            {
375                names.insert(participant.github_login.clone());
376            }
377            for message in chat
378                .messages_in_range(chat.message_count().saturating_sub(100)..chat.message_count())
379            {
380                names.insert(message.sender.github_login.clone());
381            }
382        }
383
384        let candidates = names
385            .into_iter()
386            .map(|user| StringMatchCandidate::new(0, &user))
387            .collect::<Vec<_>>();
388
389        Some((start_anchor, query, candidates))
390    }
391
392    fn collect_emoji_candidates(
393        &mut self,
394        buffer: &Entity<Buffer>,
395        end_anchor: Anchor,
396        cx: &mut Context<Self>,
397    ) -> Option<(Anchor, String, &'static [StringMatchCandidate])> {
398        static EMOJI_FUZZY_MATCH_CANDIDATES: LazyLock<Vec<StringMatchCandidate>> =
399            LazyLock::new(|| {
400                let emojis = emojis::iter()
401                    .flat_map(|s| s.shortcodes())
402                    .map(|emoji| StringMatchCandidate::new(0, emoji))
403                    .collect::<Vec<_>>();
404                emojis
405            });
406
407        let end_offset = end_anchor.to_offset(buffer.read(cx));
408
409        let query = buffer.update(cx, |buffer, _| {
410            let mut query = String::new();
411            for ch in buffer.reversed_chars_at(end_offset).take(100) {
412                if ch == ':' {
413                    let next_char = buffer
414                        .reversed_chars_at(end_offset - query.len() - 1)
415                        .next();
416                    // Ensure we are at the start of the message or that the previous character is a whitespace
417                    if next_char.is_none() || next_char.unwrap().is_whitespace() {
418                        return Some(query.chars().rev().collect::<String>());
419                    }
420
421                    // If the previous character is not a whitespace, we are in the middle of a word
422                    // and we only want to complete the shortcode if the word is made up of other emojis
423                    let mut containing_word = String::new();
424                    for ch in buffer
425                        .reversed_chars_at(end_offset - query.len() - 1)
426                        .take(100)
427                    {
428                        if ch.is_whitespace() {
429                            break;
430                        }
431                        containing_word.push(ch);
432                    }
433                    let containing_word = containing_word.chars().rev().collect::<String>();
434                    if util::word_consists_of_emojis(containing_word.as_str()) {
435                        return Some(query.chars().rev().collect::<String>());
436                    }
437                    break;
438                }
439                if ch.is_whitespace() || !ch.is_ascii() {
440                    break;
441                }
442                query.push(ch);
443            }
444            None
445        })?;
446
447        let start_offset = end_offset - query.len() - 1;
448        let start_anchor = buffer.read(cx).anchor_before(start_offset);
449
450        Some((start_anchor, query, &EMOJI_FUZZY_MATCH_CANDIDATES))
451    }
452
453    async fn find_mentions(
454        this: WeakEntity<MessageEditor>,
455        buffer: BufferSnapshot,
456        cx: &mut AsyncWindowContext,
457    ) {
458        let (buffer, ranges) = cx
459            .background_spawn(async move {
460                let ranges = MENTIONS_SEARCH.search(&buffer, None).await;
461                (buffer, ranges)
462            })
463            .await;
464
465        this.update(cx, |this, cx| {
466            let mut anchor_ranges = Vec::new();
467            let mut mentioned_user_ids = Vec::new();
468            let mut text = String::new();
469
470            this.editor.update(cx, |editor, cx| {
471                let multi_buffer = editor.buffer().read(cx).snapshot(cx);
472                for range in ranges {
473                    text.clear();
474                    text.extend(buffer.text_for_range(range.clone()));
475                    if let Some(username) = text.strip_prefix('@') {
476                        if let Some(user) = this
477                            .user_store
478                            .read(cx)
479                            .cached_user_by_github_login(username)
480                        {
481                            let start = multi_buffer.anchor_after(range.start);
482                            let end = multi_buffer.anchor_after(range.end);
483
484                            mentioned_user_ids.push(user.id);
485                            anchor_ranges.push(start..end);
486                        }
487                    }
488                }
489
490                editor.clear_highlights::<Self>(cx);
491                editor.highlight_text::<Self>(
492                    anchor_ranges,
493                    HighlightStyle {
494                        font_weight: Some(FontWeight::BOLD),
495                        ..Default::default()
496                    },
497                    cx,
498                )
499            });
500
501            this.mentions = mentioned_user_ids;
502            this.mentions_task.take();
503        })
504        .ok();
505    }
506
507    pub(crate) fn focus_handle(&self, cx: &gpui::App) -> gpui::FocusHandle {
508        self.editor.read(cx).focus_handle(cx)
509    }
510}
511
512impl Render for MessageEditor {
513    fn render(&mut self, _: &mut Window, cx: &mut Context<Self>) -> impl IntoElement {
514        let settings = ThemeSettings::get_global(cx);
515        let text_style = TextStyle {
516            color: if self.editor.read(cx).read_only(cx) {
517                cx.theme().colors().text_disabled
518            } else {
519                cx.theme().colors().text
520            },
521            font_family: settings.ui_font.family.clone(),
522            font_features: settings.ui_font.features.clone(),
523            font_fallbacks: settings.ui_font.fallbacks.clone(),
524            font_size: TextSize::Small.rems(cx).into(),
525            font_weight: settings.ui_font.weight,
526            font_style: FontStyle::Normal,
527            line_height: relative(1.3),
528            ..Default::default()
529        };
530
531        div()
532            .w_full()
533            .px_2()
534            .py_1()
535            .bg(cx.theme().colors().editor_background)
536            .rounded_sm()
537            .child(EditorElement::new(
538                &self.editor,
539                EditorStyle {
540                    local_player: cx.theme().players().local(),
541                    text: text_style,
542                    ..Default::default()
543                },
544            ))
545    }
546}