improve trait naming

alanpoon · alanpoon · commit d5763a471a8e · 2025-05-19T17:29:37.000+08:00
diff --git a/src/home/new_message_context_menu.rs b/src/home/new_message_context_menu.rs
@@ -4,10 +4,12 @@
 use bitflags::bitflags;
 use makepad_widgets::*;
 use matrix_sdk::ruma::OwnedEventId;
+use matrix_sdk_ui::timeline::InReplyToDetails;
+use ruma::events::room::message::MessageType;
 
 use crate::sliding_sync::UserPowerLevels;
 
-use super::room_screen::{Eventable, MessageAction, MessageOrSticker, MsgTypeAble};
+use super::room_screen::{MessageViewFromEvent, MessageAction, MessageOrSticker};
 
 const BUTTON_HEIGHT: f64 = 35.0; // KEEP IN SYNC WITH BUTTON_HEIGHT BELOW
 const MENU_WIDTH: f64 = 215.0;   // KEEP IN SYNC WITH MENU_WIDTH BELOW
@@ -246,7 +248,7 @@ bitflags! {
     }
 }
 impl MessageAbilities {
-    pub fn from_user_power_and_event<T: Eventable, M: MsgTypeAble>(
+    pub fn from_user_power_and_event<T: MessageViewFromEvent, M: ContextMenuFromEvent>(
         user_power_levels: &UserPowerLevels,
         event_tl_item: &T,
         _message: &MessageOrSticker<M>,
@@ -618,3 +620,9 @@ impl NewMessageContextMenuRef {
         inner.show(cx, details)
     }
 }
+pub trait ContextMenuFromEvent {
+    fn msgtype(&self) -> &MessageType;
+    fn body(&self) -> &str;
+    fn in_reply_to(&self) -> Option<&InReplyToDetails>;
+    fn is_searched_result(&self) -> bool;
+}
diff --git a/src/home/room_read_receipt.rs b/src/home/room_read_receipt.rs
@@ -7,7 +7,7 @@ use makepad_widgets::*;
 use matrix_sdk::ruma::{events::receipt::Receipt, EventId, OwnedUserId, RoomId};
 use std::cmp;
 
-use super::room_screen::Eventable;
+use super::room_screen::MessageViewFromEvent;
 
 
 /// The maximum number of items to display in the read receipts AvatarRow
@@ -226,7 +226,7 @@ impl AvatarRowRef {
 /// room ID, and an EventTimelineItem, this will populate the avatar
 /// row of the item with the read receipts of the event.
 ///
-pub fn populate_read_receipts<T: Eventable>(
+pub fn populate_read_receipts<T: MessageViewFromEvent>(
     item: &WidgetRef,
     cx: &mut Cx,
     room_id: &RoomId,
diff --git a/src/home/room_screen.rs b/src/home/room_screen.rs
@@ -36,7 +36,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 super::{editing_pane::{EditingPaneAction, EditingPaneWidgetExt}, event_reaction_list::ReactionData, loading_pane::LoadingPaneRef, location_preview::LocationPreviewWidgetExt, new_message_context_menu::{ContextMenuFromEvent, MessageAbilities, MessageDetails}, room_read_receipt::{self, populate_read_receipts, MAX_VISIBLE_AVATARS_IN_READ_RECEIPT}, rooms_list::RoomsListWidgetExt};
 use search_result::{handle_search_input, SearchResultWidgetExt};
 pub use search_result::SearchTimelineItem;
 const GEO_URI_SCHEME: &str = "geo:";
@@ -1319,12 +1319,12 @@ impl Widget for RoomScreen {
                     };
                     let (item, item_new_draw_status) = match timeline_item.kind() {
                         TimelineItemKind::Event(event_tl_item) => {
-                            let event_tl_item_wrapper = &EventableWrapperETI(event_tl_item);
+                            let event_tl_item_wrapper = &MessageViewFromEventWrapperETI(event_tl_item);
                             match event_tl_item.content() {
                                 TimelineItemContent::Message(message) => {
                                     let prev_event = tl_idx.checked_sub(1).and_then(|i| tl_items.get(i));
                                     let prev_event = prev_event.map(PreviousWrapperTI);
-                                    let message = &MsgTypeWrapperTM(message);
+                                    let message = &MessageWrapperTM(message);
                                     populate_message_view(
                                         cx,
                                         list,
@@ -1349,7 +1349,7 @@ impl Widget for RoomScreen {
                                         item_id,
                                         room_id,
                                         event_tl_item_wrapper,
-                                        MessageOrSticker::Sticker::<MsgTypeWrapperTM>(sticker.content()),
+                                        MessageOrSticker::Sticker::<MessageWrapperTM>(sticker.content()),
                                         prev_event.as_ref(),
                                         &mut tl_state.media_cache,
                                         &tl_state.user_power,
@@ -2965,11 +2965,11 @@ impl ItemDrawnStatus {
 //     Message(&'e timeline::Message),
 //     Sticker(&'e StickerEventContent),
 // }
-pub enum MessageOrSticker<'e, T:MsgTypeAble> {
+pub enum MessageOrSticker<'e, T:ContextMenuFromEvent> {
     Message(&'e T),
     Sticker(&'e StickerEventContent),
 }
-impl <T> MessageOrSticker<'_, T> where T:MsgTypeAble{
+impl <T> MessageOrSticker<'_, T> where T:ContextMenuFromEvent{
     /// Returns the type of this message or sticker.
     pub fn get_type(&self) -> MessageOrStickerType {
         match self {
@@ -3017,15 +3017,10 @@ impl <T> MessageOrSticker<'_, T> where T:MsgTypeAble{
     }
 }
 
-pub trait MsgTypeAble {
-    fn msgtype(&self) -> &MessageType;
-    fn body(&self) -> &str;
-    fn in_reply_to(&self) -> Option<&InReplyToDetails>;
-    fn is_searched_result(&self) -> bool;
-}
-pub struct MsgTypeWrapperTM<'a>(pub &'a timeline::Message);
+/// A wrapper around a [`timeline::Message`] that implements [`ContextMenuFromEvent`].
+pub struct MessageWrapperTM<'a>(pub &'a timeline::Message);
 
-impl MsgTypeAble for MsgTypeWrapperTM<'_> {
+impl ContextMenuFromEvent for MessageWrapperTM<'_> {
     fn msgtype(&self) -> &MessageType {
         self.0.msgtype()
     }
@@ -3102,7 +3097,8 @@ impl MessageOrStickerType<'_> {
         }
     }
 }
-pub trait Eventable {
+/// Trait for populating messages in the timeline.
+pub trait MessageViewFromEvent {
     fn timestamp(&self) -> MilliSecondsSinceUnixEpoch;
     fn event_id(&self) -> Option<&EventId>;
     fn sender(&self) -> &UserId;
@@ -3117,8 +3113,9 @@ pub trait Eventable {
     fn room_id(&self) -> Option<&ruma::RoomId>;
 }
 
-pub struct EventableWrapperETI<'a>(pub &'a EventTimelineItem);
-impl Eventable for EventableWrapperETI<'_> {
+/// A wrapper around a [`EventTimelineItem`] that implements [`MessageViewFromEvent`].
+pub struct MessageViewFromEventWrapperETI<'a>(pub &'a EventTimelineItem);
+impl MessageViewFromEvent for MessageViewFromEventWrapperETI<'_> {
     fn timestamp(&self) -> MilliSecondsSinceUnixEpoch {
         self.0.timestamp()
     }
@@ -3157,13 +3154,13 @@ impl Eventable for EventableWrapperETI<'_> {
     }
 }
 
-pub trait PreviousEventable<T:Eventable> {
+pub trait PreviousMessageViewFromEvent<T:MessageViewFromEvent> {
     fn use_compact(&self, current: &T) -> bool;
 }
 
 pub struct PreviousWrapperTI<'a>(pub &'a Arc<TimelineItem>);
-impl <'a> PreviousEventable<EventableWrapperETI<'a>> for PreviousWrapperTI<'a,> {
-    fn use_compact(&self, current: &EventableWrapperETI<'a>) -> bool {
+impl <'a> PreviousMessageViewFromEvent<MessageViewFromEventWrapperETI<'a>> for PreviousWrapperTI<'a,> {
+    fn use_compact(&self, current: &MessageViewFromEventWrapperETI<'a>) -> bool {
         let prev_event = Some(self.0);
         let use_compact_view = match prev_event.map(|p| p.kind()) {
             Some(TimelineItemKind::Event(prev_event_tl_item)) => match prev_event_tl_item.content() {
@@ -3201,7 +3198,7 @@ pub fn populate_message_view<T,P,M>(
     is_contextual: bool,
     item_drawn_status: ItemDrawnStatus,
     room_screen_widget_uid: WidgetUid,
-) -> (WidgetRef, ItemDrawnStatus) where T: Eventable, P: PreviousEventable<T>, M: MsgTypeAble {
+) -> (WidgetRef, ItemDrawnStatus) where T: MessageViewFromEvent, P: PreviousMessageViewFromEvent<T>, M: ContextMenuFromEvent {
     let mut new_drawn_status = item_drawn_status;
     let ts_millis = event_tl_item.timestamp();
 
@@ -4071,7 +4068,7 @@ fn populate_preview_of_timeline_item(
 
 /// A trait for abstracting over the different types of timeline events
 /// that can be displayed in a `SmallStateEvent` widget.
-pub trait SmallStateEventContent<T:Eventable> {
+pub trait SmallStateEventContent<T:MessageViewFromEvent> {
     /// Populates the *content* (not the profile) of the given `item` with data from
     /// the given `event_tl_item` and `self` (the specific type of event content).
     ///
@@ -4102,14 +4099,14 @@ pub trait SmallStateEventContent<T:Eventable> {
 /// An empty marker struct used for populating redacted messages.
 struct RedactedMessageEventMarker;
 
-impl SmallStateEventContent<EventableWrapperETI<'_>> for RedactedMessageEventMarker {
+impl SmallStateEventContent<MessageViewFromEventWrapperETI<'_>> for RedactedMessageEventMarker {
     fn populate_item_content(
         &self,
         cx: &mut Cx,
         _list: &mut PortalList,
         _item_id: usize,
         item: WidgetRef,
-        event_tl_item: &EventableWrapperETI,
+        event_tl_item: &MessageViewFromEventWrapperETI,
         original_sender: &str,
         _item_drawn_status: ItemDrawnStatus,
         mut new_drawn_status: ItemDrawnStatus,
@@ -4124,14 +4121,14 @@ impl SmallStateEventContent<EventableWrapperETI<'_>> for RedactedMessageEventMar
     }
 }
 
-impl SmallStateEventContent<EventableWrapperETI<'_>> for timeline::OtherState {
+impl SmallStateEventContent<MessageViewFromEventWrapperETI<'_>> for timeline::OtherState {
     fn populate_item_content(
         &self,
         cx: &mut Cx,
         list: &mut PortalList,
         item_id: usize,
         item: WidgetRef,
-        _event_tl_item: &EventableWrapperETI,
+        _event_tl_item: &MessageViewFromEventWrapperETI,
         username: &str,
         _item_drawn_status: ItemDrawnStatus,
         mut new_drawn_status: ItemDrawnStatus,
@@ -4150,14 +4147,14 @@ impl SmallStateEventContent<EventableWrapperETI<'_>> for timeline::OtherState {
     }
 }
 
-impl SmallStateEventContent<EventableWrapperETI<'_>> for MemberProfileChange {
+impl SmallStateEventContent<MessageViewFromEventWrapperETI<'_>> for MemberProfileChange {
     fn populate_item_content(
         &self,
         cx: &mut Cx,
         _list: &mut PortalList,
         _item_id: usize,
         item: WidgetRef,
-        _event_tl_item: &EventableWrapperETI,
+        _event_tl_item: &MessageViewFromEventWrapperETI,
         username: &str,
         _item_drawn_status: ItemDrawnStatus,
         mut new_drawn_status: ItemDrawnStatus,
@@ -4172,14 +4169,14 @@ impl SmallStateEventContent<EventableWrapperETI<'_>> for MemberProfileChange {
     }
 }
 
-impl SmallStateEventContent<EventableWrapperETI<'_>> for RoomMembershipChange {
+impl SmallStateEventContent<MessageViewFromEventWrapperETI<'_>> for RoomMembershipChange {
     fn populate_item_content(
         &self,
         cx: &mut Cx,
         list: &mut PortalList,
         item_id: usize,
         item: WidgetRef,
-        _event_tl_item: &EventableWrapperETI,
+        _event_tl_item: &MessageViewFromEventWrapperETI,
         username: &str,
         _item_drawn_status: ItemDrawnStatus,
         mut new_drawn_status: ItemDrawnStatus,
@@ -4205,7 +4202,7 @@ impl SmallStateEventContent<EventableWrapperETI<'_>> for RoomMembershipChange {
 ///
 /// The content of the returned widget is populated with data from the
 /// given room membership change and its parent `EventTimelineItem`.
-pub fn populate_small_state_event<T: Eventable>(
+pub fn populate_small_state_event<T: MessageViewFromEvent>(
     cx: &mut Cx,
     list: &mut PortalList,
     item_id: usize,
@@ -4284,7 +4281,7 @@ pub fn set_timestamp(
 }
 
 /// Returns the display name of the sender of the given `event_tl_item`, if available.
-fn get_profile_display_name<T: Eventable>(event_tl_item: &T) -> Option<String> {
+fn get_profile_display_name<T: MessageViewFromEvent>(event_tl_item: &T) -> Option<String> {
     if let Some(TimelineDetails::Ready(profile)) = event_tl_item.sender_profile() {
         profile.display_name.clone()
     } else {
diff --git a/src/home/room_search_result.rs b/src/home/room_search_result.rs
@@ -7,7 +7,7 @@ use ruma::{events::{receipt::Receipt, room::message::{AudioMessageEventContent,
 
 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};
+use crate::home::{new_message_context_menu::MessageDetails, room_screen::{populate_message_view, populate_small_state_event, MessageViewFromEvent, ItemDrawnStatus, MessageAction, MessageOrSticker, ContextMenuFromEvent, PreviousMessageViewFromEvent, RoomScreen, SmallStateEventContent, TimelineUiState}, rooms_list::RoomsListWidgetExt};
 
 live_design! {
     use link::theme::*;
@@ -368,10 +368,10 @@ pub fn search_result_draw_walk(room_screen: &mut RoomScreen, cx: &mut Cx2d, scop
                                                 text.formatted = Some(FormattedBody::html(formated_string));
                                             }
                                         }
-                                        let event = &EventableWrapperAEI(event, &tl_state.search_result_state.profiles_info);
+                                        let event = &MessageViewFromEventWrapperAEI(event, &tl_state.search_result_state.profiles_info);
                                         // Do not use compact view if previous event is state
                                         let prev_event = prev_event.and_then(|f| if matches!(f, AnyTimelineEvent::State(_)) { None } else { Some(f) }).map(PreviousWrapperAEI);
-                                        let message = MsgTypeWrapperRMC(&message, in_reply_to_details.as_ref());
+                                        let message = MessageWrapperRMC(&message, in_reply_to_details.as_ref());
                                         populate_message_view(
                                             cx,
                                             list,
@@ -388,7 +388,7 @@ pub fn search_result_draw_walk(room_screen: &mut RoomScreen, cx: &mut Cx2d, scop
                                         )
                                     }
                                     Some(AnyMessageLikeEventContent::Sticker(sticker)) => {
-                                        let event = &EventableWrapperAEI(event, &tl_state.search_result_state.profiles_info);
+                                        let event = &MessageViewFromEventWrapperAEI(event, &tl_state.search_result_state.profiles_info);
                                         let prev_event = prev_event.map(PreviousWrapperAEI);
                                         let is_contextual = matches!(&current_item, SearchTimelineItem::ContextEvent(_));
                                         populate_message_view(
@@ -397,7 +397,7 @@ pub fn search_result_draw_walk(room_screen: &mut RoomScreen, cx: &mut Cx2d, scop
                                             item_id,
                                             room_id,
                                             event,
-                                            MessageOrSticker::Sticker::<MsgTypeWrapperRMC>(&sticker),
+                                            MessageOrSticker::Sticker::<MessageWrapperRMC>(&sticker),
                                             prev_event.as_ref(),
                                             &mut tl_state.media_cache,
                                             &tl_state.user_power,
@@ -416,7 +416,7 @@ pub fn search_result_draw_walk(room_screen: &mut RoomScreen, cx: &mut Cx2d, scop
                                 let state_key = state.state_key();
                                 if let Some(content) = state.original_content() {
                                     let wrapper = AnyStateEventContentWrapper(&content, state_key);
-                                    let event = &EventableWrapperAEI(event, &tl_state.search_result_state.profiles_info);
+                                    let event = &MessageViewFromEventWrapperAEI(event, &tl_state.search_result_state.profiles_info);
                                     populate_small_state_event(
                                         cx,
                                         list,
@@ -710,9 +710,11 @@ impl <'a>From<&AnyStateEventContentWrapper<'a>> for Option<AnyOtherFullStateEven
         }
     }
 }
-pub struct EventableWrapperAEI<'a>(pub &'a AnyTimelineEvent, pub &'a BTreeMap<OwnedUserId, TimelineDetails<Profile>>);
 
-impl Eventable for EventableWrapperAEI<'_> {
+/// Wrapper for AnyTimelineEvent that implements `MessageViewFromEvent` trait.
+pub struct MessageViewFromEventWrapperAEI<'a>(pub &'a AnyTimelineEvent, pub &'a BTreeMap<OwnedUserId, TimelineDetails<Profile>>);
+
+impl MessageViewFromEvent for MessageViewFromEventWrapperAEI<'_> {
     fn timestamp(&self) -> MilliSecondsSinceUnixEpoch {
         self.0.origin_server_ts()
     }
@@ -782,14 +784,14 @@ impl Eventable for EventableWrapperAEI<'_> {
 }
 
 
-impl SmallStateEventContent<EventableWrapperAEI<'_>> for AnyStateEventContentWrapper<'_> {
+impl SmallStateEventContent<MessageViewFromEventWrapperAEI<'_>> for AnyStateEventContentWrapper<'_> {
     fn populate_item_content(
         &self,
         cx: &mut Cx,
         list: &mut PortalList,
         item_id: usize,
         item: WidgetRef,
-        _event_tl_item: &EventableWrapperAEI,
+        _event_tl_item: &MessageViewFromEventWrapperAEI,
         username: &str,
         _item_drawn_status: ItemDrawnStatus,
         mut new_drawn_status: ItemDrawnStatus,
@@ -809,9 +811,10 @@ impl SmallStateEventContent<EventableWrapperAEI<'_>> for AnyStateEventContentWra
     }
 }
 
+/// A wrapper for the `AnyTimelineEvent` that implements `PreviousMessageViewFromEvent` trait for compact view.
 pub struct PreviousWrapperAEI<'a>(pub &'a AnyTimelineEvent);
-impl <'a> PreviousEventable<EventableWrapperAEI<'a>> for PreviousWrapperAEI<'a> {
-    fn use_compact(&self, current: &EventableWrapperAEI<'a>) -> bool {
+impl <'a> PreviousMessageViewFromEvent<MessageViewFromEventWrapperAEI<'a>> for PreviousWrapperAEI<'a> {
+    fn use_compact(&self, current: &MessageViewFromEventWrapperAEI<'a>) -> bool {
         let prev_msg_sender = self.0.sender();
         let current_sender = current.0.sender();
         {
@@ -821,8 +824,9 @@ impl <'a> PreviousEventable<EventableWrapperAEI<'a>> for PreviousWrapperAEI<'a>
     }
 }
 
-pub struct MsgTypeWrapperRMC<'a>(pub &'a RoomMessageEventContent, pub Option<&'a InReplyToDetails>);
-impl MsgTypeAble for MsgTypeWrapperRMC<'_> {
+/// A wrapper for the `RoomMessageEventContent` and `InReplyToDetails` that implements `ContextMenuFromEvent` trait.
+pub struct MessageWrapperRMC<'a>(pub &'a RoomMessageEventContent, pub Option<&'a InReplyToDetails>);
+impl ContextMenuFromEvent for MessageWrapperRMC<'_> {
     fn msgtype(&self) -> &MessageType {
         &self.0.msgtype
     }
