pane_group.rs

  1use crate::{FollowerStatesByLeader, JoinProject, Pane, Workspace};
  2use anyhow::{anyhow, Result};
  3use call::ActiveCall;
  4use gpui::{
  5    elements::*, Axis, Border, CursorStyle, ModelHandle, MouseButton, RenderContext, ViewHandle,
  6};
  7use project::Project;
  8use serde::Deserialize;
  9use theme::Theme;
 10
 11#[derive(Clone, Debug, Eq, PartialEq)]
 12pub struct PaneGroup {
 13    root: Member,
 14}
 15
 16impl PaneGroup {
 17    pub fn new(pane: ViewHandle<Pane>) -> Self {
 18        Self {
 19            root: Member::Pane(pane),
 20        }
 21    }
 22
 23    pub fn split(
 24        &mut self,
 25        old_pane: &ViewHandle<Pane>,
 26        new_pane: &ViewHandle<Pane>,
 27        direction: SplitDirection,
 28    ) -> Result<()> {
 29        match &mut self.root {
 30            Member::Pane(pane) => {
 31                if pane == old_pane {
 32                    self.root = Member::new_axis(old_pane.clone(), new_pane.clone(), direction);
 33                    Ok(())
 34                } else {
 35                    Err(anyhow!("Pane not found"))
 36                }
 37            }
 38            Member::Axis(axis) => axis.split(old_pane, new_pane, direction),
 39        }
 40    }
 41
 42    /// Returns:
 43    /// - Ok(true) if it found and removed a pane
 44    /// - Ok(false) if it found but did not remove the pane
 45    /// - Err(_) if it did not find the pane
 46    pub fn remove(&mut self, pane: &ViewHandle<Pane>) -> Result<bool> {
 47        match &mut self.root {
 48            Member::Pane(_) => Ok(false),
 49            Member::Axis(axis) => {
 50                if let Some(last_pane) = axis.remove(pane)? {
 51                    self.root = last_pane;
 52                }
 53                Ok(true)
 54            }
 55        }
 56    }
 57
 58    pub(crate) fn render(
 59        &self,
 60        project: &ModelHandle<Project>,
 61        theme: &Theme,
 62        follower_states: &FollowerStatesByLeader,
 63        active_call: Option<&ModelHandle<ActiveCall>>,
 64        cx: &mut RenderContext<Workspace>,
 65    ) -> ElementBox {
 66        self.root
 67            .render(project, theme, follower_states, active_call, cx)
 68    }
 69
 70    pub(crate) fn panes(&self) -> Vec<&ViewHandle<Pane>> {
 71        let mut panes = Vec::new();
 72        self.root.collect_panes(&mut panes);
 73        panes
 74    }
 75}
 76
 77#[derive(Clone, Debug, Eq, PartialEq)]
 78enum Member {
 79    Axis(PaneAxis),
 80    Pane(ViewHandle<Pane>),
 81}
 82
 83impl Member {
 84    fn new_axis(
 85        old_pane: ViewHandle<Pane>,
 86        new_pane: ViewHandle<Pane>,
 87        direction: SplitDirection,
 88    ) -> Self {
 89        use Axis::*;
 90        use SplitDirection::*;
 91
 92        let axis = match direction {
 93            Up | Down => Vertical,
 94            Left | Right => Horizontal,
 95        };
 96
 97        let members = match direction {
 98            Up | Left => vec![Member::Pane(new_pane), Member::Pane(old_pane)],
 99            Down | Right => vec![Member::Pane(old_pane), Member::Pane(new_pane)],
100        };
101
102        Member::Axis(PaneAxis { axis, members })
103    }
104
105    pub fn render(
106        &self,
107        project: &ModelHandle<Project>,
108        theme: &Theme,
109        follower_states: &FollowerStatesByLeader,
110        active_call: Option<&ModelHandle<ActiveCall>>,
111        cx: &mut RenderContext<Workspace>,
112    ) -> ElementBox {
113        enum FollowIntoExternalProject {}
114
115        match self {
116            Member::Pane(pane) => {
117                let leader = follower_states
118                    .iter()
119                    .find_map(|(leader_id, follower_states)| {
120                        if follower_states.contains_key(pane) {
121                            Some(leader_id)
122                        } else {
123                            None
124                        }
125                    })
126                    .and_then(|leader_id| {
127                        let room = active_call?.read(cx).room()?.read(cx);
128                        let collaborator = project.read(cx).collaborators().get(leader_id)?;
129                        let participant = room.remote_participants().get(&leader_id)?;
130                        Some((collaborator.replica_id, participant))
131                    });
132
133                let mut border = Border::default();
134
135                let prompt = if let Some((replica_id, leader)) = leader {
136                    let leader_color = theme.editor.replica_selection_style(replica_id).cursor;
137                    border = Border::all(theme.workspace.leader_border_width, leader_color);
138                    border
139                        .color
140                        .fade_out(1. - theme.workspace.leader_border_opacity);
141                    border.overlay = true;
142
143                    match leader.location {
144                        call::ParticipantLocation::SharedProject {
145                            project_id: leader_project_id,
146                        } => {
147                            if Some(leader_project_id) == project.read(cx).remote_id() {
148                                None
149                            } else {
150                                let leader_user = leader.user.clone();
151                                let leader_user_id = leader.user.id;
152                                Some(
153                                    MouseEventHandler::<FollowIntoExternalProject>::new(
154                                        pane.id(),
155                                        cx,
156                                        |_, _| {
157                                            Label::new(
158                                                format!(
159                                                    "Follow {} on their active project",
160                                                    leader_user.github_login,
161                                                ),
162                                                theme
163                                                    .workspace
164                                                    .external_location_message
165                                                    .text
166                                                    .clone(),
167                                            )
168                                            .contained()
169                                            .with_style(
170                                                theme.workspace.external_location_message.container,
171                                            )
172                                            .boxed()
173                                        },
174                                    )
175                                    .with_cursor_style(CursorStyle::PointingHand)
176                                    .on_click(MouseButton::Left, move |_, cx| {
177                                        cx.dispatch_action(JoinProject {
178                                            project_id: leader_project_id,
179                                            follow_user_id: leader_user_id,
180                                        })
181                                    })
182                                    .aligned()
183                                    .bottom()
184                                    .right()
185                                    .boxed(),
186                                )
187                            }
188                        }
189                        call::ParticipantLocation::UnsharedProject => Some(
190                            Label::new(
191                                format!(
192                                    "{} is viewing an unshared Zed project",
193                                    leader.user.github_login
194                                ),
195                                theme.workspace.external_location_message.text.clone(),
196                            )
197                            .contained()
198                            .with_style(theme.workspace.external_location_message.container)
199                            .aligned()
200                            .bottom()
201                            .right()
202                            .boxed(),
203                        ),
204                        call::ParticipantLocation::External => Some(
205                            Label::new(
206                                format!(
207                                    "{} is viewing a window outside of Zed",
208                                    leader.user.github_login
209                                ),
210                                theme.workspace.external_location_message.text.clone(),
211                            )
212                            .contained()
213                            .with_style(theme.workspace.external_location_message.container)
214                            .aligned()
215                            .bottom()
216                            .right()
217                            .boxed(),
218                        ),
219                    }
220                } else {
221                    None
222                };
223
224                Stack::new()
225                    .with_child(
226                        ChildView::new(pane, cx)
227                            .contained()
228                            .with_border(border)
229                            .boxed(),
230                    )
231                    .with_children(prompt)
232                    .boxed()
233            }
234            Member::Axis(axis) => axis.render(project, theme, follower_states, active_call, cx),
235        }
236    }
237
238    fn collect_panes<'a>(&'a self, panes: &mut Vec<&'a ViewHandle<Pane>>) {
239        match self {
240            Member::Axis(axis) => {
241                for member in &axis.members {
242                    member.collect_panes(panes);
243                }
244            }
245            Member::Pane(pane) => panes.push(pane),
246        }
247    }
248}
249
250#[derive(Clone, Debug, Eq, PartialEq)]
251struct PaneAxis {
252    axis: Axis,
253    members: Vec<Member>,
254}
255
256impl PaneAxis {
257    fn split(
258        &mut self,
259        old_pane: &ViewHandle<Pane>,
260        new_pane: &ViewHandle<Pane>,
261        direction: SplitDirection,
262    ) -> Result<()> {
263        use SplitDirection::*;
264
265        for (idx, member) in self.members.iter_mut().enumerate() {
266            match member {
267                Member::Axis(axis) => {
268                    if axis.split(old_pane, new_pane, direction).is_ok() {
269                        return Ok(());
270                    }
271                }
272                Member::Pane(pane) => {
273                    if pane == old_pane {
274                        if direction.matches_axis(self.axis) {
275                            match direction {
276                                Up | Left => {
277                                    self.members.insert(idx, Member::Pane(new_pane.clone()));
278                                }
279                                Down | Right => {
280                                    self.members.insert(idx + 1, Member::Pane(new_pane.clone()));
281                                }
282                            }
283                        } else {
284                            *member =
285                                Member::new_axis(old_pane.clone(), new_pane.clone(), direction);
286                        }
287                        return Ok(());
288                    }
289                }
290            }
291        }
292        Err(anyhow!("Pane not found"))
293    }
294
295    fn remove(&mut self, pane_to_remove: &ViewHandle<Pane>) -> Result<Option<Member>> {
296        let mut found_pane = false;
297        let mut remove_member = None;
298        for (idx, member) in self.members.iter_mut().enumerate() {
299            match member {
300                Member::Axis(axis) => {
301                    if let Ok(last_pane) = axis.remove(pane_to_remove) {
302                        if let Some(last_pane) = last_pane {
303                            *member = last_pane;
304                        }
305                        found_pane = true;
306                        break;
307                    }
308                }
309                Member::Pane(pane) => {
310                    if pane == pane_to_remove {
311                        found_pane = true;
312                        remove_member = Some(idx);
313                        break;
314                    }
315                }
316            }
317        }
318
319        if found_pane {
320            if let Some(idx) = remove_member {
321                self.members.remove(idx);
322            }
323
324            if self.members.len() == 1 {
325                Ok(self.members.pop())
326            } else {
327                Ok(None)
328            }
329        } else {
330            Err(anyhow!("Pane not found"))
331        }
332    }
333
334    fn render(
335        &self,
336        project: &ModelHandle<Project>,
337        theme: &Theme,
338        follower_state: &FollowerStatesByLeader,
339        active_call: Option<&ModelHandle<ActiveCall>>,
340        cx: &mut RenderContext<Workspace>,
341    ) -> ElementBox {
342        let last_member_ix = self.members.len() - 1;
343        Flex::new(self.axis)
344            .with_children(self.members.iter().enumerate().map(|(ix, member)| {
345                let mut member = member.render(project, theme, follower_state, active_call, cx);
346                if ix < last_member_ix {
347                    let mut border = theme.workspace.pane_divider;
348                    border.left = false;
349                    border.right = false;
350                    border.top = false;
351                    border.bottom = false;
352                    match self.axis {
353                        Axis::Vertical => border.bottom = true,
354                        Axis::Horizontal => border.right = true,
355                    }
356                    member = Container::new(member).with_border(border).boxed();
357                }
358
359                FlexItem::new(member).flex(1.0, true).boxed()
360            }))
361            .boxed()
362    }
363}
364
365#[derive(Clone, Copy, Debug, Deserialize, PartialEq)]
366pub enum SplitDirection {
367    Up,
368    Down,
369    Left,
370    Right,
371}
372
373impl SplitDirection {
374    fn matches_axis(self, orientation: Axis) -> bool {
375        use Axis::*;
376        use SplitDirection::*;
377
378        match self {
379            Up | Down => match orientation {
380                Vertical => true,
381                Horizontal => false,
382            },
383            Left | Right => match orientation {
384                Vertical => false,
385                Horizontal => true,
386            },
387        }
388    }
389}
390
391#[cfg(test)]
392mod tests {
393    // use super::*;
394    // use serde_json::json;
395
396    // #[test]
397    // fn test_split_and_remove() -> Result<()> {
398    //     let mut group = PaneGroup::new(1);
399    //     assert_eq!(
400    //         serde_json::to_value(&group)?,
401    //         json!({
402    //             "type": "pane",
403    //             "paneId": 1,
404    //         })
405    //     );
406
407    //     group.split(1, 2, SplitDirection::Right)?;
408    //     assert_eq!(
409    //         serde_json::to_value(&group)?,
410    //         json!({
411    //             "type": "axis",
412    //             "orientation": "horizontal",
413    //             "members": [
414    //                 {"type": "pane", "paneId": 1},
415    //                 {"type": "pane", "paneId": 2},
416    //             ]
417    //         })
418    //     );
419
420    //     group.split(2, 3, SplitDirection::Up)?;
421    //     assert_eq!(
422    //         serde_json::to_value(&group)?,
423    //         json!({
424    //             "type": "axis",
425    //             "orientation": "horizontal",
426    //             "members": [
427    //                 {"type": "pane", "paneId": 1},
428    //                 {
429    //                     "type": "axis",
430    //                     "orientation": "vertical",
431    //                     "members": [
432    //                         {"type": "pane", "paneId": 3},
433    //                         {"type": "pane", "paneId": 2},
434    //                     ]
435    //                 },
436    //             ]
437    //         })
438    //     );
439
440    //     group.split(1, 4, SplitDirection::Right)?;
441    //     assert_eq!(
442    //         serde_json::to_value(&group)?,
443    //         json!({
444    //             "type": "axis",
445    //             "orientation": "horizontal",
446    //             "members": [
447    //                 {"type": "pane", "paneId": 1},
448    //                 {"type": "pane", "paneId": 4},
449    //                 {
450    //                     "type": "axis",
451    //                     "orientation": "vertical",
452    //                     "members": [
453    //                         {"type": "pane", "paneId": 3},
454    //                         {"type": "pane", "paneId": 2},
455    //                     ]
456    //                 },
457    //             ]
458    //         })
459    //     );
460
461    //     group.split(2, 5, SplitDirection::Up)?;
462    //     assert_eq!(
463    //         serde_json::to_value(&group)?,
464    //         json!({
465    //             "type": "axis",
466    //             "orientation": "horizontal",
467    //             "members": [
468    //                 {"type": "pane", "paneId": 1},
469    //                 {"type": "pane", "paneId": 4},
470    //                 {
471    //                     "type": "axis",
472    //                     "orientation": "vertical",
473    //                     "members": [
474    //                         {"type": "pane", "paneId": 3},
475    //                         {"type": "pane", "paneId": 5},
476    //                         {"type": "pane", "paneId": 2},
477    //                     ]
478    //                 },
479    //             ]
480    //         })
481    //     );
482
483    //     assert_eq!(true, group.remove(5)?);
484    //     assert_eq!(
485    //         serde_json::to_value(&group)?,
486    //         json!({
487    //             "type": "axis",
488    //             "orientation": "horizontal",
489    //             "members": [
490    //                 {"type": "pane", "paneId": 1},
491    //                 {"type": "pane", "paneId": 4},
492    //                 {
493    //                     "type": "axis",
494    //                     "orientation": "vertical",
495    //                     "members": [
496    //                         {"type": "pane", "paneId": 3},
497    //                         {"type": "pane", "paneId": 2},
498    //                     ]
499    //                 },
500    //             ]
501    //         })
502    //     );
503
504    //     assert_eq!(true, group.remove(4)?);
505    //     assert_eq!(
506    //         serde_json::to_value(&group)?,
507    //         json!({
508    //             "type": "axis",
509    //             "orientation": "horizontal",
510    //             "members": [
511    //                 {"type": "pane", "paneId": 1},
512    //                 {
513    //                     "type": "axis",
514    //                     "orientation": "vertical",
515    //                     "members": [
516    //                         {"type": "pane", "paneId": 3},
517    //                         {"type": "pane", "paneId": 2},
518    //                     ]
519    //                 },
520    //             ]
521    //         })
522    //     );
523
524    //     assert_eq!(true, group.remove(3)?);
525    //     assert_eq!(
526    //         serde_json::to_value(&group)?,
527    //         json!({
528    //             "type": "axis",
529    //             "orientation": "horizontal",
530    //             "members": [
531    //                 {"type": "pane", "paneId": 1},
532    //                 {"type": "pane", "paneId": 2},
533    //             ]
534    //         })
535    //     );
536
537    //     assert_eq!(true, group.remove(2)?);
538    //     assert_eq!(
539    //         serde_json::to_value(&group)?,
540    //         json!({
541    //             "type": "pane",
542    //             "paneId": 1,
543    //         })
544    //     );
545
546    //     assert_eq!(false, group.remove(1)?);
547    //     assert_eq!(
548    //         serde_json::to_value(&group)?,
549    //         json!({
550    //             "type": "pane",
551    //             "paneId": 1,
552    //         })
553    //     );
554
555    //     Ok(())
556    // }
557}