src/ui/testing/scene_provider/scene_provider.h

// Copyright 2022 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef SRC_UI_TESTING_SCENE_PROVIDER_SCENE_PROVIDER_H_
#define SRC_UI_TESTING_SCENE_PROVIDER_SCENE_PROVIDER_H_

#include <fuchsia/element/cpp/fidl.h>
#include <fuchsia/session/scene/cpp/fidl.h>
#include <fuchsia/ui/observation/test/cpp/fidl.h>
#include <fuchsia/ui/test/scene/cpp/fidl.h>
#include <lib/fidl/cpp/binding_set.h>
#include <lib/sys/cpp/component_context.h>

#include <memory>

namespace ui_testing {

class FakeViewController : public fuchsia::element::ViewController {
 public:
  explicit FakeViewController(
      fidl::InterfaceRequest<fuchsia::element::ViewController> view_controller,
      fit::function<void()> dismiss) {
    view_controller_bindings_.AddBinding(this, std::move(view_controller));
    dismiss_ = std::move(dismiss);
  }
  ~FakeViewController() override = default;

  // |fuchsia.element.ViewController|
  void Dismiss() override;

 private:
  fidl::BindingSet<fuchsia::element::ViewController> view_controller_bindings_;
  fit::function<void()> dismiss_;
};

class SceneProvider : public fuchsia::ui::test::scene::Controller,
                      public fuchsia::element::GraphicalPresenter {
 public:
  explicit SceneProvider(sys::ComponentContext* context);
  ~SceneProvider() override = default;

  // |fuchsia::ui::test::scene::Controller|
  void AttachClientView(fuchsia::ui::test::scene::ControllerAttachClientViewRequest request,
                        AttachClientViewCallback callback) override;

  // |fuchsia::ui::test::scene::Controller|
  void PresentClientView(
      fuchsia::ui::test::scene::ControllerPresentClientViewRequest request) override;

  // |fuchsia::ui::test::scene::Controller|
  void RegisterViewTreeWatcher(
      fidl::InterfaceRequest<fuchsia::ui::observation::geometry::ViewTreeWatcher> view_tree_watcher,
      RegisterViewTreeWatcherCallback callback) override;

  // |fuchsia::ui::test::scene::Controller|
  void WatchViewPresentation(WatchViewPresentationCallback callback) override;

  // |fuchsia::element::GraphicalPresenter|
  void PresentView(
      fuchsia::element::ViewSpec view_spec,
      fidl::InterfaceHandle<fuchsia::element::AnnotationController> annotation_controller,
      fidl::InterfaceRequest<fuchsia::element::ViewController> view_controller,
      PresentViewCallback callback) override;

  // Returns a scene controller interface request handler bound to this object.
  fidl::InterfaceRequestHandler<fuchsia::ui::test::scene::Controller> GetSceneControllerHandler();

  // Returns a graphical presenter interface request handler bound to this
  // object.
  fidl::InterfaceRequestHandler<fuchsia::element::GraphicalPresenter>
  GetGraphicalPresenterHandler();

  // Drops the existing view.
  void DismissView();

 private:
  // Calls a registered view presentation watcher if there was at least one
  // View `Present()`-ed, as counted by way of any of the following presentation
  // methods:
  //   * `fuchsia.ui.test.scene.Controller/AttachClientView()`
  //   * `fuchsia.ui.test.scene.Controller/PresentClientView()`
  //   * `fuchsia.element.GraphicalPresenter/PresentView()`
  void NotifyViewPresentationWatcher();

  fidl::BindingSet<fuchsia::ui::test::scene::Controller> scene_controller_bindings_;
  fidl::BindingSet<fuchsia::element::GraphicalPresenter> graphical_presenter_bindings_;
  fuchsia::session::scene::ManagerSyncPtr scene_manager_;
  std::optional<FakeViewController> fake_view_controller_;
  fuchsia::element::AnnotationControllerPtr annotation_controller_;
  sys::ComponentContext* context_ = nullptr;

  // A registered view presentation watcher, if any, as registered through
  // `fuchsia.ui.test.scene.Controller/WatchViewPresentation()`.
  WatchViewPresentationCallback view_presentation_callback_;

  // The number of views that have been `Present()`-ed but not yet communicated
  // to any registered view presentation watcher view the
  // `view_presentation_callback_`.
  //
  // This count is incremented once any of the following presentation methods
  // completes:
  //   * `fuchsia.ui.test.scene.Controller/AttachClientView()`
  //   * `fuchsia.ui.test.scene.Controller/PresentClientView()`
  //   * `fuchsia.element.GraphicalPresenter/PresentView()`
  //
  // This count is decremented any time `view_presentation_callback_` is called.
  uint32_t pending_presented_view_count_ = 0;
};

}  // namespace ui_testing

#endif  // SRC_UI_TESTING_SCENE_PROVIDER_SCENE_PROVIDER_H_