add doc, fix search_result issues.

alanpoon · alanpoon · commit 00b9d3ae7637 · 2025-05-19T16:44:51.000+08:00
diff --git a/src/home/room_screen.rs b/src/home/room_screen.rs
@@ -22,11 +22,11 @@ use matrix_sdk_ui::timeline::{
 use ruma::{OwnedUserId, UserId};
 
 use crate::{
-    app::AppState, avatar_cache, event_preview::{plaintext_body_of_timeline_item, text_preview_of_member_profile_change, text_preview_of_other_state, text_preview_of_redacted_message, text_preview_of_room_membership_change, text_preview_of_timeline_item}, home::loading_pane::{LoadingPaneState, LoadingPaneWidgetExt}, location::init_location_subscriber, media_cache::{MediaCache, MediaCacheEntry}, profile::{
+    avatar_cache, event_preview::{plaintext_body_of_timeline_item, text_preview_of_member_profile_change, text_preview_of_other_state, text_preview_of_redacted_message, text_preview_of_room_membership_change, text_preview_of_timeline_item}, home::loading_pane::{LoadingPaneState, LoadingPaneWidgetExt}, location::init_location_subscriber, media_cache::{MediaCache, MediaCacheEntry}, profile::{
         user_profile::{AvatarState, ShowUserProfileAction, UserProfile, UserProfileAndRoomId, UserProfilePaneInfo, UserProfileSlidingPaneRef, UserProfileSlidingPaneWidgetExt},
         user_profile_cache,
     }, shared::{
-        avatar::AvatarWidgetRefExt, callout_tooltip::TooltipAction, html_or_plaintext::{HtmlOrPlaintextRef, HtmlOrPlaintextWidgetRefExt, RobrixHtmlLinkAction}, jump_to_bottom_button::{JumpToBottomButtonWidgetExt, UnreadMessageCount}, popup_list::enqueue_popup_notification, room_filter_input_bar::RoomFilterAction, styles::COLOR_DANGER_RED, text_or_image::{TextOrImageRef, TextOrImageWidgetRefExt}, typing_animation::TypingAnimationWidgetExt
+        avatar::AvatarWidgetRefExt, callout_tooltip::TooltipAction, html_or_plaintext::{HtmlOrPlaintextRef, HtmlOrPlaintextWidgetRefExt, RobrixHtmlLinkAction}, jump_to_bottom_button::{JumpToBottomButtonWidgetExt, UnreadMessageCount}, popup_list::enqueue_popup_notification, styles::COLOR_DANGER_RED, text_or_image::{TextOrImageRef, TextOrImageWidgetRefExt}, typing_animation::TypingAnimationWidgetExt
     }, sliding_sync::{get_client, submit_async_request, take_timeline_endpoints, BackwardsPaginateUntilEventRequest, MatrixRequest, PaginationDirection, TimelineRequestSender, UserPowerLevels}, utils::{self, room_name_or_id, unix_time_millis_to_datetime, ImageFormat, MEDIA_THUMBNAIL_FORMAT}
 };
 use crate::home::event_reaction_list::ReactionListWidgetRefExt;
@@ -37,7 +37,7 @@ use crate::shared::mentionable_text_input::MentionableTextInputWidgetRefExt;
 use rangemap::RangeSet;
 
 use super::{editing_pane::{EditingPaneAction, EditingPaneWidgetExt}, event_reaction_list::ReactionData, loading_pane::LoadingPaneRef, location_preview::LocationPreviewWidgetExt, new_message_context_menu::{MessageAbilities, MessageDetails}, room_read_receipt::{self, populate_read_receipts, MAX_VISIBLE_AVATARS_IN_READ_RECEIPT}, rooms_list::RoomsListWidgetExt};
-use search_result::SearchResultWidgetExt;
+use search_result::{handle_search_input, SearchResultWidgetExt};
 pub use search_result::SearchTimelineItem;
 const GEO_URI_SCHEME: &str = "geo:";
 
@@ -1010,7 +1010,7 @@ impl Widget for RoomScreen {
             let message_input = self.room_input_bar(id!(input_bar)).text_input(id!(text_input));
 
             for action in actions {
-                self.handle_search(cx, action, scope);
+                handle_search_input(self, cx, action, scope);
                 // Handle the highlight animation.
                 let Some(tl) = self.tl_state.as_mut() else { return };
                 if let MessageHighlightAnimationState::Pending { item_id } = tl.message_highlight_animation_state {
@@ -2600,83 +2600,6 @@ impl RoomScreen {
         }
         tl.last_scrolled_index = first_index;
     }
-    
-    
-    /// Handles any search-related actions received by this RoomScreen.
-    ///
-    /// See `SearchBarAction` for the possible actions.
-    fn handle_search(
-        &mut self,
-        cx: &mut Cx,
-        action: &Action,
-        scope: &mut Scope,
-    ) {
-        let widget_action = action.as_widget_action();
-        match widget_action.cast() {
-            RoomFilterAction::Changed(search_term) => {
-                
-                if let Some(selected_room) = {
-                    let app_state = scope.data.get::<AppState>().unwrap();
-                    app_state.selected_room.clone()
-                } {
-                    if  Some(selected_room.room_id()) == self.room_id.as_ref() {
-                        if search_term.is_empty() {
-                            self.search_result(id!(search_result_plane)).reset(cx);
-                            self.view(id!(timeline)).set_visible(cx, true);
-                            self.view(id!(search_timeline)).set_visible(cx, false);
-                            self.search_result(id!(search_result_plane)).set_visible(cx, false);
-                            return;
-                        }
-                        self.search_debounce_timer = cx.start_timeout(1.0);
-                        if let Some(ref mut tl_state) = self.tl_state {
-                            tl_state.search_result_state.items.clear();
-                            tl_state.search_result_state.highlighted_strings.clear();
-                        }
-                        let mut criteria = self.search_result(id!(search_result_plane)).get_search_criteria();
-                        criteria.search_term = search_term.clone();
-                        self.search_result(id!(search_result_plane)).set_search_criteria(cx, criteria);
-                        self.view(id!(timeline)).set_visible(cx, false);
-                    }
-                }
-            }
-            RoomFilterAction::Click(search_term) => {
-                if let Some(selected_room) = {
-                    let app_state = scope.data.get::<AppState>().unwrap();
-                    app_state.selected_room.clone()
-                } {
-                    if Some(selected_room.room_id()) == self.room_id.as_ref() {      
-                        let mut criteria = self.search_result(id!(search_result_plane)).get_search_criteria();
-                        if search_term == criteria.search_term && !search_term.is_empty() {
-                            return;
-                        }
-                        criteria.search_term = search_term.clone();                  
-                        self.search_result(id!(search_result_plane)).set_search_criteria(cx, criteria);
-                        self.view(id!(timeline)).set_visible(cx, false);
-                    }
-                }
-            }
-            RoomFilterAction::Clear => {
-                if let Some(selected_room) = {
-                    let app_state = scope.data.get::<AppState>().unwrap();
-                    app_state.selected_room.clone()
-                } {
-                    if Some(selected_room.room_id()) == self.room_id.as_ref() {
-                        cx.stop_timer(self.search_debounce_timer);
-                        let Some(tl) = self.tl_state.as_mut() else { return };
-                        tl.search_result_state.items.clear();
-                        tl.search_result_state.highlighted_strings.clear();
-                        self.view(id!(search_timeline)).set_visible(cx, false);
-                        self.view(id!(timeline)).set_visible(cx, true);
-                        self.search_result(id!(search_result_plane)).reset(cx);
-                        self.search_result(id!(search_result_plane)).set_visible(cx, false);
-                    }
-                }
-            }
-            _ => {
-
-            }
-        }        
-    }
 
 }
 
@@ -2916,14 +2839,14 @@ pub struct TimelineUiState {
     /// State used to display search results.
     search_result_state: SearchResultState,
 }
+/// States that are necessary to display search results.
 #[derive(Default)]
 pub struct SearchResultState {
     /// The list of events in the search results.
     items: Vector<SearchTimelineItem>,
     /// The list of strings that should be highlighted in the search results.
     highlighted_strings: Vec<String>,
-    /// Upon a background update, only item indices greater than or equal to the
-    /// `index_of_first_change` are removed from this set.
+    /// See [`TimelineUiState.content_drawn_since_last_update`].
     content_drawn_since_last_update: RangeSet<usize>,
     /// Same as `content_drawn_since_last_update`, but for the event **profiles** (avatar, username).
     profile_drawn_since_last_update: RangeSet<usize>,
diff --git a/src/home/room_search_result.rs b/src/home/room_search_result.rs
@@ -5,7 +5,7 @@ use makepad_widgets::*;
 use matrix_sdk_ui::timeline::{AnyOtherFullStateEventContent, InReplyToDetails, Profile, ReactionsByKeyBySender, TimelineDetails, TimelineEventItemId};
 use ruma::{events::{receipt::Receipt, room::message::{AudioMessageEventContent, EmoteMessageEventContent, FileMessageEventContent, FormattedBody, ImageMessageEventContent, KeyVerificationRequestEventContent, MessageType, NoticeMessageEventContent, Relation, RoomMessageEventContent, TextMessageEventContent, VideoMessageEventContent}, AnyMessageLikeEvent, AnyMessageLikeEventContent, AnyStateEventContent, AnyTimelineEvent, FullStateEventContent}, uint, EventId, MilliSecondsSinceUnixEpoch, OwnedRoomId, OwnedUserId, UserId};
 
-use crate::{event_preview::text_preview_of_other_state, shared::room_filter_input_bar::RoomFilterAction, sliding_sync::{current_user_id, submit_async_request, MatrixRequest}, utils::unix_time_millis_to_datetime};
+use crate::{app::AppState, event_preview::text_preview_of_other_state, shared::room_filter_input_bar::RoomFilterAction, sliding_sync::{current_user_id, submit_async_request, MatrixRequest}, utils::unix_time_millis_to_datetime};
 
 use crate::home::{new_message_context_menu::MessageDetails, room_screen::{populate_message_view, populate_small_state_event, Eventable, ItemDrawnStatus, MessageAction, MessageOrSticker, MsgTypeAble, PreviousEventable, RoomScreen, SmallStateEventContent, TimelineUiState}, rooms_list::RoomsListWidgetExt};
 
@@ -270,6 +270,13 @@ impl SearchResultRef {
     }
 }
 
+/// This is a specialized version of `RoomScreen::draw_walk()` that is specific to rendering the timeline of a search result.
+///
+/// It takes a `RoomScreen` widget and iterates through the `PortalList` widget inside it. For each item in the list, it checks if the item is a `DateDivider`, `ContextEvent` or `Event` and renders it accordingly.
+///
+/// The rendering of the timeline items is done by calling `populate_message_view()` for messages and `populate_small_state_event()` for state events.
+///
+/// This function is used in the `RoomScreen` widget's `draw_walk()` method when the timeline is being rendered as a search result.
 pub fn search_result_draw_walk(room_screen: &mut RoomScreen, cx: &mut Cx2d, scope: &mut Scope, walk: Walk) -> DrawStep {
     let room_screen_widget_uid = room_screen.widget_uid();
     let Some(room_id) = &room_screen.room_id else { return DrawStep::done(); };
@@ -447,6 +454,13 @@ pub fn search_result_draw_walk(room_screen: &mut RoomScreen, cx: &mut Cx2d, scop
     DrawStep::done()
 }
 
+/// Copies the HTML content of a message to the clipboard if the message is a text message, notice, emote, image, file, audio, video, or verification request, and if it is formatted as HTML.
+///
+/// If the message is an edit of another message, the function will copy the content of the original message instead of the edited message.
+///
+/// Returns `true` if the content was copied successfully, and `false` otherwise.
+///
+/// The function takes as input the current Makepad context, a reference to a `MessageDetails` struct, a reference to a `TimelineUiState` struct, and a mutable reference to a boolean to set to `true` if the content was copied successfully.
 pub fn search_result_copy_html_to_clipboard(cx: &mut Cx, details: &MessageDetails, tl: &TimelineUiState, success: &mut bool) {
     let (Some(SearchTimelineItem::Event(event)) | Some(SearchTimelineItem::ContextEvent(event))) = tl.search_result_state.items
         .get(details.item_id) else { return };
@@ -478,6 +492,11 @@ pub fn search_result_copy_html_to_clipboard(cx: &mut Cx, details: &MessageDetail
         }
     }
 }
+/// Copies the text of the message at the given item id to the clipboard.
+///
+/// The item id must point to a message in the timeline, otherwise this function does nothing.
+///
+/// If the message is a reply-to message, the body of the replied-to message is copied instead.
 pub fn search_result_copy_to_clipboard(cx: &mut Cx, details: &MessageDetails, tl: &TimelineUiState) {
     let (Some(SearchTimelineItem::Event(event)) | Some(SearchTimelineItem::ContextEvent(event))) = tl.search_result_state.items
         .get(details.item_id) else { return };
@@ -495,6 +514,12 @@ pub fn search_result_copy_to_clipboard(cx: &mut Cx, details: &MessageDetails, tl
         }
     }
 }
+/// React to a message in the timeline.
+///
+/// The item id must point to a message in the timeline, otherwise this function does nothing.
+///
+/// If the message is a reply-to message, the reaction is sent to the replied-to message instead.
+///
 pub fn search_result_react(_cx: &mut Cx, details: &MessageDetails, tl: &TimelineUiState, reaction: String, success: &mut bool) {
     let (Some(SearchTimelineItem::Event(event)) | Some(SearchTimelineItem::ContextEvent(event))) = tl.search_result_state.items
         .get(details.item_id) else { return };
@@ -518,6 +543,13 @@ pub fn search_result_react(_cx: &mut Cx, details: &MessageDetails, tl: &Timeline
     *success = true;
 }
 
+/// Reply to a message in the timeline.
+///
+/// The item id must point to a message in the timeline, otherwise this function does nothing.
+///
+/// If the message is a reply-to message, the reply is sent to the replied-to message instead.
+///
+/// This function also hides the search results view and clears the search filter.
 pub fn search_result_reply(cx: &mut Cx, room_screen: &RoomScreen, details: &MessageDetails, tl: &TimelineUiState, success: &mut bool) {
     let (Some(SearchTimelineItem::Event(event)) | Some(SearchTimelineItem::ContextEvent(event))) = tl.search_result_state.items
         .get(details.item_id) else { return };
@@ -540,6 +572,11 @@ pub fn search_result_reply(cx: &mut Cx, room_screen: &RoomScreen, details: &Mess
     );
     *success = true;
 }
+/// Finds the index of the timeline item in the main timeline items list
+/// that the given search result item is related to (i.e. is a reply to).
+///
+/// Returns `None` if the search result item is not a reply to a message
+/// in the main timeline items list.
 pub fn search_result_jump_to_related(_cx: &mut Cx, details: &MessageDetails, tl: &TimelineUiState)-> Option<usize> {
     let (Some(SearchTimelineItem::Event(event)) | Some(SearchTimelineItem::ContextEvent(event))) = tl.search_result_state.items
         .get(details.item_id) else { return None};
@@ -551,6 +588,83 @@ pub fn search_result_jump_to_related(_cx: &mut Cx, details: &MessageDetails, tl:
     }
     None
 }
+
+/// Handles any search-related actions received by this RoomScreen.
+///
+/// See `RoomFilterAction` for the possible actions.
+pub fn handle_search_input(
+        room_screen: &mut RoomScreen,
+        cx: &mut Cx,
+        action: &Action,
+        scope: &mut Scope,
+    ){
+    let widget_action = action.as_widget_action();
+    match widget_action.cast() {
+        RoomFilterAction::Changed(search_term) => {
+            
+            if let Some(selected_room) = {
+                let app_state = scope.data.get::<AppState>().unwrap();
+                app_state.selected_room.clone()
+            } {
+                if  Some(selected_room.room_id()) == room_screen.room_id.as_ref() {
+                    if search_term.is_empty() {
+                        room_screen.search_result(id!(search_result_plane)).reset(cx);
+                        room_screen.view(id!(timeline)).set_visible(cx, true);
+                        room_screen.view(id!(search_timeline)).set_visible(cx, false);
+                        room_screen.search_result(id!(search_result_plane)).set_visible(cx, false);
+                        return;
+                    }
+                    room_screen.search_debounce_timer = cx.start_timeout(1.0);
+                    if let Some(ref mut tl_state) = room_screen.tl_state {
+                        tl_state.search_result_state.items.clear();
+                        tl_state.search_result_state.highlighted_strings.clear();
+                    }
+                    let mut criteria = room_screen.search_result(id!(search_result_plane)).get_search_criteria();
+                    criteria.search_term = search_term.clone();
+                    room_screen.search_result(id!(search_result_plane)).set_search_criteria(cx, criteria);
+                    room_screen.view(id!(timeline)).set_visible(cx, false);
+                }
+            }
+        }
+        RoomFilterAction::Click(search_term) => {
+            if let Some(selected_room) = {
+                let app_state = scope.data.get::<AppState>().unwrap();
+                app_state.selected_room.clone()
+            } {
+                if Some(selected_room.room_id()) == room_screen.room_id.as_ref() {      
+                    let mut criteria = room_screen.search_result(id!(search_result_plane)).get_search_criteria();
+                    if search_term == criteria.search_term && !search_term.is_empty() {
+                        return;
+                    }
+                    criteria.search_term = search_term.clone();                  
+                    room_screen.search_result(id!(search_result_plane)).set_search_criteria(cx, criteria);
+                    room_screen.view(id!(timeline)).set_visible(cx, false);
+                }
+            }
+        }
+        RoomFilterAction::Clear => {
+            if let Some(selected_room) = {
+                let app_state = scope.data.get::<AppState>().unwrap();
+                app_state.selected_room.clone()
+            } {
+                if Some(selected_room.room_id()) == room_screen.room_id.as_ref() {
+                    cx.stop_timer(room_screen.search_debounce_timer);
+                    let Some(tl) = room_screen.tl_state.as_mut() else { return };
+                    tl.search_result_state.items.clear();
+                    tl.search_result_state.highlighted_strings.clear();
+                    room_screen.view(id!(search_timeline)).set_visible(cx, false);
+                    room_screen.view(id!(timeline)).set_visible(cx, true);
+                    room_screen.search_result(id!(search_result_plane)).reset(cx);
+                    room_screen.search_result(id!(search_result_plane)).set_visible(cx, false);
+                }
+            }
+        }
+        _ => {
+
+        }
+    }        
+}
+/// Search result as timeline item
 #[derive(Clone, Debug)]
 pub enum SearchTimelineItem {
     /// The event that matches the search criteria.
@@ -559,7 +673,7 @@ pub enum SearchTimelineItem {
     ContextEvent(AnyTimelineEvent),
     /// A date divider used to separate each search results.
     DateDivider(MilliSecondsSinceUnixEpoch),
-    /// The room name for other's room messages.
+    /// The room id used for displaying room header for all searched messages in a screen.
     RoomHeader(OwnedRoomId),
 }
 
