carnelian/app/strategies/
base.rs

1// Copyright 2020 The Fuchsia Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5use crate::app::strategies::flatland::FlatlandAppStrategy;
6use crate::app::strategies::framebuffer::{
7    first_display_device_path, DisplayCoordinator, DisplayDirectAppStrategy, DisplayId,
8};
9use crate::app::{Config, InternalSender, MessageInternal, ViewMode};
10use crate::input::{self};
11use crate::view::strategies::base::{ViewStrategyParams, ViewStrategyPtr};
12use crate::view::ViewKey;
13use anyhow::Error;
14use async_trait::async_trait;
15use fidl_fuchsia_hardware_display::VirtconMode;
16use fidl_fuchsia_input_report as hid_input_report;
17use fuchsia_component::server::{ServiceFs, ServiceObjLocal};
18use futures::channel::mpsc::UnboundedSender;
19use keymaps::select_keymap;
20use std::path::PathBuf;
21
22// This trait exists to keep the hosted implementation and the
23// direct implementations as separate as possible.
24// At the moment this abstraction is quite leaky, but it is good
25// enough and can be refined with experience.
26#[async_trait(?Send)]
27pub(crate) trait AppStrategy {
28    async fn create_view_strategy(
29        &mut self,
30        key: ViewKey,
31        app_sender: UnboundedSender<MessageInternal>,
32        strategy_params: ViewStrategyParams,
33    ) -> Result<ViewStrategyPtr, Error>;
34    #[allow(dead_code)]
35    fn supports_scenic(&self) -> bool;
36    fn create_view_for_testing(&self, _: &UnboundedSender<MessageInternal>) -> Result<(), Error> {
37        Ok(())
38    }
39    fn create_view_strategy_params_for_additional_view(
40        &mut self,
41        view_key: ViewKey,
42    ) -> ViewStrategyParams;
43    fn start_services<'a, 'b>(
44        &self,
45        _app_sender: UnboundedSender<MessageInternal>,
46        _fs: &'a mut ServiceFs<ServiceObjLocal<'b, ()>>,
47    ) -> Result<(), Error> {
48        Ok(())
49    }
50    async fn post_setup(&mut self, _internal_sender: &InternalSender) -> Result<(), Error>;
51    fn handle_input_report(
52        &mut self,
53        _device_id: &input::DeviceId,
54        _input_report: &hid_input_report::InputReport,
55    ) -> Vec<input::Event> {
56        Vec::new()
57    }
58    fn handle_keyboard_autorepeat(&mut self, _device_id: &input::DeviceId) -> Vec<input::Event> {
59        Vec::new()
60    }
61    fn handle_register_input_device(
62        &mut self,
63        _device_id: &input::DeviceId,
64        _device_descriptor: &hid_input_report::DeviceDescriptor,
65    ) {
66    }
67    async fn handle_new_display_coordinator(&mut self, _display_path: PathBuf) {}
68    async fn handle_display_coordinator_event(
69        &mut self,
70        _event: fidl_fuchsia_hardware_display::CoordinatorListenerRequest,
71    ) {
72    }
73    fn set_virtcon_mode(&mut self, _virtcon_mode: VirtconMode) {}
74    fn handle_view_closed(&mut self, _view_key: ViewKey) {}
75    fn get_focused_view_key(&self) -> Option<ViewKey> {
76        panic!("get_focused_view_key not implemented");
77    }
78    fn get_visible_view_key_for_display(&self, _display_id: DisplayId) -> Option<ViewKey> {
79        panic!("get_visible_view_key_for_display not implemented");
80    }
81}
82
83pub(crate) type AppStrategyPtr = Box<dyn AppStrategy>;
84
85fn make_flatland_app_strategy() -> Result<AppStrategyPtr, Error> {
86    Ok::<AppStrategyPtr, Error>(Box::new(FlatlandAppStrategy {}))
87}
88
89fn make_direct_app_strategy(
90    display_coordinator: Option<DisplayCoordinator>,
91    app_config: &Config,
92    internal_sender: InternalSender,
93) -> Result<AppStrategyPtr, Error> {
94    let strat = DisplayDirectAppStrategy::new(
95        display_coordinator,
96        select_keymap(&app_config.keymap_name),
97        internal_sender,
98        &app_config,
99    );
100
101    Ok(Box::new(strat))
102}
103
104pub(crate) async fn create_app_strategy(
105    internal_sender: &InternalSender,
106) -> Result<AppStrategyPtr, Error> {
107    let app_config = Config::get();
108    match app_config.view_mode {
109        ViewMode::Auto => {
110            // Tries to open the display coordinator. If that fails, assume we want to run as hosted.
111            let display_coordinator = if let Some(path) = first_display_device_path() {
112                DisplayCoordinator::open(
113                    path.to_str().unwrap(),
114                    &app_config.virtcon_mode,
115                    &internal_sender,
116                )
117                .await
118                .ok()
119            } else {
120                None
121            };
122            if display_coordinator.is_none() {
123                make_flatland_app_strategy()
124            } else {
125                make_direct_app_strategy(display_coordinator, app_config, internal_sender.clone())
126            }
127        }
128        ViewMode::Direct => {
129            DisplayCoordinator::watch_displays(internal_sender.clone()).await;
130            make_direct_app_strategy(None, app_config, internal_sender.clone())
131        }
132        ViewMode::Hosted => make_flatland_app_strategy(),
133    }
134}
carnelian/app/strategies/base.rs

carnelian/app/strategies/
base.rs
