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};
  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    language_settings::SoftWrap, Anchor, Buffer, BufferSnapshot, CodeLabel, LanguageRegistry,
 13    ToOffset,
 14};
 15use project::{search::SearchQuery, Completion, CompletionSource};
 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::{prelude::*, TextSize};
 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        buffer: &Entity<Buffer>,
 60        buffer_position: language::Anchor,
 61        _: editor::CompletionContext,
 62        _window: &mut Window,
 63        cx: &mut Context<Editor>,
 64    ) -> Task<Result<Option<Vec<Completion>>>> {
 65        let Some(handle) = self.0.upgrade() else {
 66            return Task::ready(Ok(None));
 67        };
 68        handle.update(cx, |message_editor, cx| {
 69            message_editor.completions(buffer, buffer_position, cx)
 70        })
 71    }
 72
 73    fn resolve_completions(
 74        &self,
 75        _buffer: Entity<Buffer>,
 76        _completion_indices: Vec<usize>,
 77        _completions: Rc<RefCell<Box<[Completion]>>>,
 78        _cx: &mut Context<Editor>,
 79    ) -> Task<anyhow::Result<bool>> {
 80        Task::ready(Ok(false))
 81    }
 82
 83    fn is_completion_trigger(
 84        &self,
 85        _buffer: &Entity<Buffer>,
 86        _position: language::Anchor,
 87        text: &str,
 88        _trigger_in_words: bool,
 89        _cx: &mut Context<Editor>,
 90    ) -> bool {
 91        text == "@"
 92    }
 93}
 94
 95impl MessageEditor {
 96    pub fn new(
 97        language_registry: Arc<LanguageRegistry>,
 98        user_store: Entity<UserStore>,
 99        channel_chat: Option<Entity<ChannelChat>>,
100        editor: Entity<Editor>,
101        window: &mut Window,
102        cx: &mut Context<Self>,
103    ) -> Self {
104        let this = cx.entity().downgrade();
105        editor.update(cx, |editor, cx| {
106            editor.set_soft_wrap_mode(SoftWrap::EditorWidth, cx);
107            editor.set_use_autoclose(false);
108            editor.set_show_gutter(false, cx);
109            editor.set_show_wrap_guides(false, cx);
110            editor.set_show_indent_guides(false, cx);
111            editor.set_completion_provider(Some(Box::new(MessageEditorCompletionProvider(this))));
112            editor.set_auto_replace_emoji_shortcode(
113                MessageEditorSettings::get_global(cx)
114                    .auto_replace_emoji_shortcode
115                    .unwrap_or_default(),
116            );
117        });
118
119        let buffer = editor
120            .read(cx)
121            .buffer()
122            .read(cx)
123            .as_singleton()
124            .expect("message editor must be singleton");
125
126        cx.subscribe_in(&buffer, window, Self::on_buffer_event)
127            .detach();
128        cx.observe_global::<settings::SettingsStore>(|this, cx| {
129            this.editor.update(cx, |editor, cx| {
130                editor.set_auto_replace_emoji_shortcode(
131                    MessageEditorSettings::get_global(cx)
132                        .auto_replace_emoji_shortcode
133                        .unwrap_or_default(),
134                )
135            })
136        })
137        .detach();
138
139        let markdown = language_registry.language_for_name("Markdown");
140        cx.spawn_in(window, |_, mut cx| async move {
141            let markdown = markdown.await.context("failed to load Markdown language")?;
142            buffer.update(&mut cx, |buffer, cx| {
143                buffer.set_language(Some(markdown), cx)
144            })
145        })
146        .detach_and_log_err(cx);
147
148        Self {
149            editor,
150            user_store,
151            channel_chat,
152            mentions: Vec::new(),
153            mentions_task: None,
154            reply_to_message_id: None,
155            edit_message_id: None,
156        }
157    }
158
159    pub fn reply_to_message_id(&self) -> Option<u64> {
160        self.reply_to_message_id
161    }
162
163    pub fn set_reply_to_message_id(&mut self, reply_to_message_id: u64) {
164        self.reply_to_message_id = Some(reply_to_message_id);
165    }
166
167    pub fn clear_reply_to_message_id(&mut self) {
168        self.reply_to_message_id = None;
169    }
170
171    pub fn edit_message_id(&self) -> Option<u64> {
172        self.edit_message_id
173    }
174
175    pub fn set_edit_message_id(&mut self, edit_message_id: u64) {
176        self.edit_message_id = Some(edit_message_id);
177    }
178
179    pub fn clear_edit_message_id(&mut self) {
180        self.edit_message_id = None;
181    }
182
183    pub fn set_channel_chat(&mut self, chat: Entity<ChannelChat>, cx: &mut Context<Self>) {
184        let channel_id = chat.read(cx).channel_id;
185        self.channel_chat = Some(chat);
186        let channel_name = ChannelStore::global(cx)
187            .read(cx)
188            .channel_for_id(channel_id)
189            .map(|channel| channel.name.clone());
190        self.editor.update(cx, |editor, cx| {
191            if let Some(channel_name) = channel_name {
192                editor.set_placeholder_text(format!("Message #{channel_name}"), cx);
193            } else {
194                editor.set_placeholder_text("Message Channel", cx);
195            }
196        });
197    }
198
199    pub fn take_message(&mut self, window: &mut Window, cx: &mut Context<Self>) -> MessageParams {
200        self.editor.update(cx, |editor, cx| {
201            let highlights = editor.text_highlights::<Self>(cx);
202            let text = editor.text(cx);
203            let snapshot = editor.buffer().read(cx).snapshot(cx);
204            let mentions = if let Some((_, ranges)) = highlights {
205                ranges
206                    .iter()
207                    .map(|range| range.to_offset(&snapshot))
208                    .zip(self.mentions.iter().copied())
209                    .collect()
210            } else {
211                Vec::new()
212            };
213
214            editor.clear(window, cx);
215            self.mentions.clear();
216            let reply_to_message_id = std::mem::take(&mut self.reply_to_message_id);
217
218            MessageParams {
219                text,
220                mentions,
221                reply_to_message_id,
222            }
223        })
224    }
225
226    fn on_buffer_event(
227        &mut self,
228        buffer: &Entity<Buffer>,
229        event: &language::BufferEvent,
230        window: &mut Window,
231        cx: &mut Context<Self>,
232    ) {
233        if let language::BufferEvent::Reparsed | language::BufferEvent::Edited = event {
234            let buffer = buffer.read(cx).snapshot();
235            self.mentions_task = Some(cx.spawn_in(window, |this, cx| async move {
236                cx.background_executor()
237                    .timer(MENTIONS_DEBOUNCE_INTERVAL)
238                    .await;
239                Self::find_mentions(this, buffer, cx).await;
240            }));
241        }
242    }
243
244    fn completions(
245        &mut self,
246        buffer: &Entity<Buffer>,
247        end_anchor: Anchor,
248        cx: &mut Context<Self>,
249    ) -> Task<Result<Option<Vec<Completion>>>> {
250        if let Some((start_anchor, query, candidates)) =
251            self.collect_mention_candidates(buffer, end_anchor, cx)
252        {
253            if !candidates.is_empty() {
254                return cx.spawn(|_, cx| async move {
255                    Ok(Some(
256                        Self::resolve_completions_for_candidates(
257                            &cx,
258                            query.as_str(),
259                            &candidates,
260                            start_anchor..end_anchor,
261                            Self::completion_for_mention,
262                        )
263                        .await,
264                    ))
265                });
266            }
267        }
268
269        if let Some((start_anchor, query, candidates)) =
270            self.collect_emoji_candidates(buffer, end_anchor, cx)
271        {
272            if !candidates.is_empty() {
273                return cx.spawn(|_, cx| async move {
274                    Ok(Some(
275                        Self::resolve_completions_for_candidates(
276                            &cx,
277                            query.as_str(),
278                            candidates,
279                            start_anchor..end_anchor,
280                            Self::completion_for_emoji,
281                        )
282                        .await,
283                    ))
284                });
285            }
286        }
287
288        Task::ready(Ok(Some(Vec::new())))
289    }
290
291    async fn resolve_completions_for_candidates(
292        cx: &AsyncApp,
293        query: &str,
294        candidates: &[StringMatchCandidate],
295        range: Range<Anchor>,
296        completion_fn: impl Fn(&StringMatch) -> (String, CodeLabel),
297    ) -> Vec<Completion> {
298        let matches = fuzzy::match_strings(
299            candidates,
300            query,
301            true,
302            10,
303            &Default::default(),
304            cx.background_executor().clone(),
305        )
306        .await;
307
308        matches
309            .into_iter()
310            .map(|mat| {
311                let (new_text, label) = completion_fn(&mat);
312                Completion {
313                    old_range: range.clone(),
314                    new_text,
315                    label,
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        mut cx: 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(&mut 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}