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(ChildView::new(pane).contained().with_border(border).boxed())
226                    .with_children(prompt)
227                    .boxed()
228            }
229            Member::Axis(axis) => axis.render(project, theme, follower_states, active_call, cx),
230        }
231    }
232
233    fn collect_panes<'a>(&'a self, panes: &mut Vec<&'a ViewHandle<Pane>>) {
234        match self {
235            Member::Axis(axis) => {
236                for member in &axis.members {
237                    member.collect_panes(panes);
238                }
239            }
240            Member::Pane(pane) => panes.push(pane),
241        }
242    }
243}
244
245#[derive(Clone, Debug, Eq, PartialEq)]
246struct PaneAxis {
247    axis: Axis,
248    members: Vec<Member>,
249}
250
251impl PaneAxis {
252    fn split(
253        &mut self,
254        old_pane: &ViewHandle<Pane>,
255        new_pane: &ViewHandle<Pane>,
256        direction: SplitDirection,
257    ) -> Result<()> {
258        use SplitDirection::*;
259
260        for (idx, member) in self.members.iter_mut().enumerate() {
261            match member {
262                Member::Axis(axis) => {
263                    if axis.split(old_pane, new_pane, direction).is_ok() {
264                        return Ok(());
265                    }
266                }
267                Member::Pane(pane) => {
268                    if pane == old_pane {
269                        if direction.matches_axis(self.axis) {
270                            match direction {
271                                Up | Left => {
272                                    self.members.insert(idx, Member::Pane(new_pane.clone()));
273                                }
274                                Down | Right => {
275                                    self.members.insert(idx + 1, Member::Pane(new_pane.clone()));
276                                }
277                            }
278                        } else {
279                            *member =
280                                Member::new_axis(old_pane.clone(), new_pane.clone(), direction);
281                        }
282                        return Ok(());
283                    }
284                }
285            }
286        }
287        Err(anyhow!("Pane not found"))
288    }
289
290    fn remove(&mut self, pane_to_remove: &ViewHandle<Pane>) -> Result<Option<Member>> {
291        let mut found_pane = false;
292        let mut remove_member = None;
293        for (idx, member) in self.members.iter_mut().enumerate() {
294            match member {
295                Member::Axis(axis) => {
296                    if let Ok(last_pane) = axis.remove(pane_to_remove) {
297                        if let Some(last_pane) = last_pane {
298                            *member = last_pane;
299                        }
300                        found_pane = true;
301                        break;
302                    }
303                }
304                Member::Pane(pane) => {
305                    if pane == pane_to_remove {
306                        found_pane = true;
307                        remove_member = Some(idx);
308                        break;
309                    }
310                }
311            }
312        }
313
314        if found_pane {
315            if let Some(idx) = remove_member {
316                self.members.remove(idx);
317            }
318
319            if self.members.len() == 1 {
320                Ok(self.members.pop())
321            } else {
322                Ok(None)
323            }
324        } else {
325            Err(anyhow!("Pane not found"))
326        }
327    }
328
329    fn render(
330        &self,
331        project: &ModelHandle<Project>,
332        theme: &Theme,
333        follower_state: &FollowerStatesByLeader,
334        active_call: Option<&ModelHandle<ActiveCall>>,
335        cx: &mut RenderContext<Workspace>,
336    ) -> ElementBox {
337        let last_member_ix = self.members.len() - 1;
338        Flex::new(self.axis)
339            .with_children(self.members.iter().enumerate().map(|(ix, member)| {
340                let mut member = member.render(project, theme, follower_state, active_call, cx);
341                if ix < last_member_ix {
342                    let mut border = theme.workspace.pane_divider;
343                    border.left = false;
344                    border.right = false;
345                    border.top = false;
346                    border.bottom = false;
347                    match self.axis {
348                        Axis::Vertical => border.bottom = true,
349                        Axis::Horizontal => border.right = true,
350                    }
351                    member = Container::new(member).with_border(border).boxed();
352                }
353
354                FlexItem::new(member).flex(1.0, true).boxed()
355            }))
356            .boxed()
357    }
358}
359
360#[derive(Clone, Copy, Debug, Deserialize, PartialEq)]
361pub enum SplitDirection {
362    Up,
363    Down,
364    Left,
365    Right,
366}
367
368impl SplitDirection {
369    fn matches_axis(self, orientation: Axis) -> bool {
370        use Axis::*;
371        use SplitDirection::*;
372
373        match self {
374            Up | Down => match orientation {
375                Vertical => true,
376                Horizontal => false,
377            },
378            Left | Right => match orientation {
379                Vertical => false,
380                Horizontal => true,
381            },
382        }
383    }
384}
385
386#[cfg(test)]
387mod tests {
388    // use super::*;
389    // use serde_json::json;
390
391    // #[test]
392    // fn test_split_and_remove() -> Result<()> {
393    //     let mut group = PaneGroup::new(1);
394    //     assert_eq!(
395    //         serde_json::to_value(&group)?,
396    //         json!({
397    //             "type": "pane",
398    //             "paneId": 1,
399    //         })
400    //     );
401
402    //     group.split(1, 2, SplitDirection::Right)?;
403    //     assert_eq!(
404    //         serde_json::to_value(&group)?,
405    //         json!({
406    //             "type": "axis",
407    //             "orientation": "horizontal",
408    //             "members": [
409    //                 {"type": "pane", "paneId": 1},
410    //                 {"type": "pane", "paneId": 2},
411    //             ]
412    //         })
413    //     );
414
415    //     group.split(2, 3, SplitDirection::Up)?;
416    //     assert_eq!(
417    //         serde_json::to_value(&group)?,
418    //         json!({
419    //             "type": "axis",
420    //             "orientation": "horizontal",
421    //             "members": [
422    //                 {"type": "pane", "paneId": 1},
423    //                 {
424    //                     "type": "axis",
425    //                     "orientation": "vertical",
426    //                     "members": [
427    //                         {"type": "pane", "paneId": 3},
428    //                         {"type": "pane", "paneId": 2},
429    //                     ]
430    //                 },
431    //             ]
432    //         })
433    //     );
434
435    //     group.split(1, 4, SplitDirection::Right)?;
436    //     assert_eq!(
437    //         serde_json::to_value(&group)?,
438    //         json!({
439    //             "type": "axis",
440    //             "orientation": "horizontal",
441    //             "members": [
442    //                 {"type": "pane", "paneId": 1},
443    //                 {"type": "pane", "paneId": 4},
444    //                 {
445    //                     "type": "axis",
446    //                     "orientation": "vertical",
447    //                     "members": [
448    //                         {"type": "pane", "paneId": 3},
449    //                         {"type": "pane", "paneId": 2},
450    //                     ]
451    //                 },
452    //             ]
453    //         })
454    //     );
455
456    //     group.split(2, 5, SplitDirection::Up)?;
457    //     assert_eq!(
458    //         serde_json::to_value(&group)?,
459    //         json!({
460    //             "type": "axis",
461    //             "orientation": "horizontal",
462    //             "members": [
463    //                 {"type": "pane", "paneId": 1},
464    //                 {"type": "pane", "paneId": 4},
465    //                 {
466    //                     "type": "axis",
467    //                     "orientation": "vertical",
468    //                     "members": [
469    //                         {"type": "pane", "paneId": 3},
470    //                         {"type": "pane", "paneId": 5},
471    //                         {"type": "pane", "paneId": 2},
472    //                     ]
473    //                 },
474    //             ]
475    //         })
476    //     );
477
478    //     assert_eq!(true, group.remove(5)?);
479    //     assert_eq!(
480    //         serde_json::to_value(&group)?,
481    //         json!({
482    //             "type": "axis",
483    //             "orientation": "horizontal",
484    //             "members": [
485    //                 {"type": "pane", "paneId": 1},
486    //                 {"type": "pane", "paneId": 4},
487    //                 {
488    //                     "type": "axis",
489    //                     "orientation": "vertical",
490    //                     "members": [
491    //                         {"type": "pane", "paneId": 3},
492    //                         {"type": "pane", "paneId": 2},
493    //                     ]
494    //                 },
495    //             ]
496    //         })
497    //     );
498
499    //     assert_eq!(true, group.remove(4)?);
500    //     assert_eq!(
501    //         serde_json::to_value(&group)?,
502    //         json!({
503    //             "type": "axis",
504    //             "orientation": "horizontal",
505    //             "members": [
506    //                 {"type": "pane", "paneId": 1},
507    //                 {
508    //                     "type": "axis",
509    //                     "orientation": "vertical",
510    //                     "members": [
511    //                         {"type": "pane", "paneId": 3},
512    //                         {"type": "pane", "paneId": 2},
513    //                     ]
514    //                 },
515    //             ]
516    //         })
517    //     );
518
519    //     assert_eq!(true, group.remove(3)?);
520    //     assert_eq!(
521    //         serde_json::to_value(&group)?,
522    //         json!({
523    //             "type": "axis",
524    //             "orientation": "horizontal",
525    //             "members": [
526    //                 {"type": "pane", "paneId": 1},
527    //                 {"type": "pane", "paneId": 2},
528    //             ]
529    //         })
530    //     );
531
532    //     assert_eq!(true, group.remove(2)?);
533    //     assert_eq!(
534    //         serde_json::to_value(&group)?,
535    //         json!({
536    //             "type": "pane",
537    //             "paneId": 1,
538    //         })
539    //     );
540
541    //     assert_eq!(false, group.remove(1)?);
542    //     assert_eq!(
543    //         serde_json::to_value(&group)?,
544    //         json!({
545    //             "type": "pane",
546    //             "paneId": 1,
547    //         })
548    //     );
549
550    //     Ok(())
551    // }
552}