blob: 20699b5e2b38cba45a69c2b0ef5d6daedd31360f [file] [log] [blame]
// Copyright 2016 The Chromium 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 UI_AURA_MUS_WINDOW_PORT_MUS_H_
#define UI_AURA_MUS_WINDOW_PORT_MUS_H_
#include <stdint.h>
#include <string>
#include <vector>
#include "base/logging.h"
#include "base/macros.h"
#include "base/memory/weak_ptr.h"
#include "base/optional.h"
#include "base/time/time.h"
#include "components/viz/common/surfaces/parent_local_surface_id_allocator.h"
#include "components/viz/common/surfaces/surface_info.h"
#include "services/ws/public/mojom/cursor/cursor.mojom.h"
#include "services/ws/public/mojom/window_tree.mojom.h"
#include "services/ws/public/mojom/window_tree_constants.mojom.h"
#include "ui/aura/aura_export.h"
#include "ui/aura/mus/mus_types.h"
#include "ui/aura/mus/window_mus.h"
#include "ui/aura/window.h"
#include "ui/aura/window_port.h"
#include "ui/gfx/geometry/rect.h"
#include "ui/platform_window/mojo/text_input_state.mojom.h"
namespace cc {
namespace mojo_embedder {
class AsyncLayerTreeFrameSink;
}
}
namespace gpu {
class GpuMemoryBufferManager;
}
namespace viz {
class ContextProvider;
class RasterContextProvider;
}
namespace aura {
class ClientSurfaceEmbedder;
class PropertyConverter;
class WindowTreeClient;
class WindowTreeClientTestApi;
class WindowTreeHostMus;
// WindowPortMus is a WindowPort that forwards calls to WindowTreeClient
// so that changes are propagated to the server. All changes from
// WindowTreeClient to the underlying Window route through this class (by
// way of WindowMus) and are done in such a way that they don't result in
// calling back to WindowTreeClient.
class AURA_EXPORT WindowPortMus : public WindowPort, public WindowMus {
public:
// See WindowMus's constructor for details on |window_mus_type|.
WindowPortMus(WindowTreeClient* client, WindowMusType window_mus_type);
~WindowPortMus() override;
static WindowPortMus* Get(Window* window);
Window* window() { return window_; }
const Window* window() const { return window_; }
ClientSurfaceEmbedder* client_surface_embedder() const {
return client_surface_embedder_.get();
}
const viz::SurfaceId& PrimarySurfaceIdForTesting() const {
return primary_surface_id_;
}
void SetTextInputState(ui::mojom::TextInputStatePtr state);
void SetImeVisibility(bool visible, ui::mojom::TextInputStatePtr state);
const ui::CursorData& cursor() const { return cursor_; }
void SetCursor(const ui::CursorData& cursor);
// Sets the EventTargetingPolicy, default is TARGET_AND_DESCENDANTS.
void SetEventTargetingPolicy(ws::mojom::EventTargetingPolicy policy);
// Sets whether this window can accept drops, defaults to false.
void SetCanAcceptDrops(bool can_accept_drops);
// See description in mojom for details on this.
void SetHitTestInsets(const gfx::Insets& mouse, const gfx::Insets& touch);
// Embeds a new client in this Window. See WindowTreeClient::Embed() for
// details on arguments.
void Embed(ws::mojom::WindowTreeClientPtr client,
uint32_t flags,
ws::mojom::WindowTree::EmbedCallback callback);
void EmbedUsingToken(const base::UnguessableToken& token,
uint32_t flags,
ws::mojom::WindowTree::EmbedCallback callback);
std::unique_ptr<cc::mojo_embedder::AsyncLayerTreeFrameSink>
RequestLayerTreeFrameSink(
scoped_refptr<viz::ContextProvider> context_provider,
scoped_refptr<viz::RasterContextProvider> raster_context_provider,
gpu::GpuMemoryBufferManager* gpu_memory_buffer_manager);
viz::FrameSinkId GenerateFrameSinkIdFromServerId() const;
private:
friend class WindowPortMusTestHelper;
friend class WindowTreeClient;
friend class WindowTreeClientTestApi;
friend class WindowTreeHostMus;
friend class HitTestDataProviderAuraTest;
using ServerChangeIdType = uint8_t;
// Changes to the underlying Window originating from the server must be done
// in such a way that the same change is not applied back to the server. To
// accomplish this every change from the server is associated with at least
// one ServerChange. If the underlying Window ends up calling back to this
// class and the change is expected then the change is ignored and not sent to
// the server. For example, here's the flow when the server changes the
// bounds:
// . WindowTreeClient calls SetBoundsFromServer().
// . A ServerChange is added of type BOUNDS and the matching bounds.
// . Window::SetBounds() is called.
// . Window::SetBounds() calls WindowPortMus::OnDidChangeBounds().
// . A ServerChange of type BOUNDS is found, and the request is ignored.
// Additionally the ServerChange is removed at this point so that if another
// bounds change is made it will be propagated. This is important as changes
// to underyling window may generate more changes.
//
// The typical pattern in implementing a call from the server looks like:
// // Create and configure the data as appropriate to the change:
// ServerChangeData data;
// data.foo = window->bar();
// ScopedServerChange change(this, ServerChangeType::FOO, data);
// window_->SetFoo(...);
//
// And the call from the Window (by way of WindowPort interface) looks like:
// ServerChangeData change_data;
// change_data.foo = ...;
// if (!RemoveChangeByTypeAndData(ServerChangeType::FOO, change_data))
// window_tree_client_->OnFooChanged(this, ...);
enum ServerChangeType {
ADD,
ADD_TRANSIENT,
BOUNDS,
DESTROY,
PROPERTY,
REMOVE,
REMOVE_TRANSIENT,
REORDER,
TRANSFORM,
VISIBLE,
};
// Contains data needed to identify a change from the server.
struct ServerChangeData {
// Applies to ADD, ADD_TRANSIENT, REMOVE, REMOVE_TRANSIENT, and REORDER.
ws::Id child_id;
// Applies to BOUNDS. This should be in dip.
gfx::Rect bounds_in_dip;
// Applies to VISIBLE.
bool visible;
// Applies to PROPERTY.
std::string property_name;
// Applies to TRANSFORM.
gfx::Transform transform;
};
// Used to identify a change the server.
struct ServerChange {
ServerChangeType type;
// A unique id assigned to the change and used later on to identify it for
// removal.
ServerChangeIdType server_change_id;
ServerChangeData data;
};
using ServerChanges = std::vector<ServerChange>;
// Convenience for adding/removing a ScopedChange.
class ScopedServerChange {
public:
ScopedServerChange(WindowPortMus* window_impl,
const ServerChangeType type,
const ServerChangeData& data)
: window_impl_(window_impl),
server_change_id_(window_impl->ScheduleChange(type, data)) {}
~ScopedServerChange() { window_impl_->RemoveChangeById(server_change_id_); }
private:
WindowPortMus* window_impl_;
const ServerChangeIdType server_change_id_;
DISALLOW_COPY_AND_ASSIGN(ScopedServerChange);
};
struct WindowMusChangeDataImpl : public WindowMusChangeData {
WindowMusChangeDataImpl();
~WindowMusChangeDataImpl() override;
std::unique_ptr<ScopedServerChange> change;
};
// Derived from WindowObserver to update local occlusion state. Not using
// OnVisibilityChanged because occlusion state is based on Window::IsVisible
// and needs to consider ancestors' visibility as well.
class VisibilityTracker;
// Creates and adds a ServerChange to |server_changes_|. Returns the id
// assigned to the ServerChange.
ServerChangeIdType ScheduleChange(const ServerChangeType type,
const ServerChangeData& data);
// Removes a ServerChange by id.
void RemoveChangeById(ServerChangeIdType change_id);
// If there is a schedule change matching |type| and |data| it is removed and
// true is returned. If no matching change is scheduled returns false.
bool RemoveChangeByTypeAndData(const ServerChangeType type,
const ServerChangeData& data);
ServerChanges::iterator FindChangeByTypeAndData(const ServerChangeType type,
const ServerChangeData& data);
// Called to setup state necessary for an embedding. Returns false if an
// embedding is not allowed in this window.
bool PrepareForEmbed();
// Called from OnEmbed() with the result of the embedding. |real_callback| is
// the callback supplied to the embed call.
static void OnEmbedAck(base::WeakPtr<WindowPortMus> window,
ws::mojom::WindowTree::EmbedCallback real_callback,
bool result);
PropertyConverter* GetPropertyConverter();
// Calls GetOrAllocateLocalSurfaceId() with the current size.
void GetOrAllocateLocalSurfaceIdForCurrentSize();
// WindowMus:
Window* GetWindow() override;
void AddChildFromServer(WindowMus* window) override;
void RemoveChildFromServer(WindowMus* child) override;
void ReorderFromServer(WindowMus* child,
WindowMus* relative,
ws::mojom::OrderDirection) override;
void SetBoundsFromServer(
const gfx::Rect& bounds,
const base::Optional<viz::LocalSurfaceId>& local_surface_id) override;
void SetTransformFromServer(const gfx::Transform& transform) override;
void SetVisibleFromServer(bool visible) override;
void SetOpacityFromServer(float opacity) override;
void SetCursorFromServer(const ui::CursorData& cursor) override;
void SetPropertyFromServer(
const std::string& property_name,
const std::vector<uint8_t>* property_data) override;
void SetFrameSinkIdFromServer(const viz::FrameSinkId& frame_sink_id) override;
const viz::LocalSurfaceId& GetOrAllocateLocalSurfaceId(
const gfx::Size& surface_size_in_pixels) override;
void UpdateLocalSurfaceIdFromEmbeddedClient(
const viz::LocalSurfaceIdAllocation&
embedded_client_local_surface_id_allocation) override;
void DestroyFromServer() override;
void AddTransientChildFromServer(WindowMus* child) override;
void RemoveTransientChildFromServer(WindowMus* child) override;
ChangeSource OnTransientChildAdded(WindowMus* child) override;
ChangeSource OnTransientChildRemoved(WindowMus* child) override;
std::unique_ptr<WindowMusChangeData> PrepareForServerBoundsChange(
const gfx::Rect& bounds) override;
std::unique_ptr<WindowMusChangeData> PrepareForServerVisibilityChange(
bool value) override;
void PrepareForDestroy() override;
void NotifyEmbeddedAppDisconnected() override;
bool HasLocalLayerTreeFrameSink() override;
float GetDeviceScaleFactor() override;
// WindowPort:
void OnPreInit(Window* window) override;
void OnDeviceScaleFactorChanged(float old_device_scale_factor,
float new_device_scale_factor) override;
void OnWillAddChild(Window* child) override;
void OnWillRemoveChild(Window* child) override;
void OnWillMoveChild(size_t current_index, size_t dest_index) override;
void OnVisibilityChanged(bool visible) override;
void OnDidChangeBounds(const gfx::Rect& old_bounds,
const gfx::Rect& new_bounds) override;
void OnDidChangeTransform(const gfx::Transform& old_transform,
const gfx::Transform& new_transform) override;
std::unique_ptr<ui::PropertyData> OnWillChangeProperty(
const void* key) override;
void OnPropertyChanged(const void* key,
int64_t old_value,
std::unique_ptr<ui::PropertyData> data) override;
std::unique_ptr<cc::LayerTreeFrameSink> CreateLayerTreeFrameSink() override;
void AllocateLocalSurfaceId() override;
viz::ScopedSurfaceIdAllocator GetSurfaceIdAllocator(
base::OnceCallback<void()> allocation_task) override;
const viz::LocalSurfaceIdAllocation& GetLocalSurfaceIdAllocation() override;
void InvalidateLocalSurfaceId() override;
void OnEventTargetingPolicyChanged() override;
bool ShouldRestackTransientChildren() override;
void RegisterFrameSinkId(const viz::FrameSinkId& frame_sink_id) override;
void UnregisterFrameSinkId(const viz::FrameSinkId& frame_sink_id) override;
void TrackOcclusionState() override;
void UpdatePrimarySurfaceId();
// Called by WindowTreeClient to update window occlusion state.
void SetOcclusionStateFromServer(ws::mojom::OcclusionState occlusion_state);
// Updates |window_| occlusion state to |new_state|.
void UpdateOcclusionState(Window::OcclusionState new_state);
// Update the local occlusion state after visibility of |window_| is changed.
// This is called from VisibilityTracker when window_->IsVisible changes to
// capture the visibility change from |window_| and its ancestors.
void UpdateOcclusionStateAfterVisiblityChange(bool visible);
WindowTreeClient* window_tree_client_;
Window* window_ = nullptr;
// Used when this window is embedding a client.
std::unique_ptr<ClientSurfaceEmbedder> client_surface_embedder_;
ServerChangeIdType next_server_change_id_ = 0;
ServerChanges server_changes_;
viz::SurfaceId primary_surface_id_;
// TODO(sad, fsamuel): For 'mash' mode, where the embedder is responsible for
// allocating the LocalSurfaceIds, this should use a
// ChildLocalSurfaceIdAllocator instead.
viz::ParentLocalSurfaceIdAllocator parent_local_surface_id_allocator_;
gfx::Size last_surface_size_in_pixels_;
ui::CursorData cursor_;
// Set if this class calls SetEmbedFrameSinkId() on the associated window.
viz::FrameSinkId embed_frame_sink_id_;
// See description in single place that changes the value for details.
bool should_restack_transient_children_ = true;
// True if this window has an embedding.
bool has_embedding_ = false;
// When a frame sink is created
// for a local aura::Window, we need keep a weak ptr of it, so we can update
// the local surface id when necessary.
base::WeakPtr<cc::LayerTreeFrameSink> local_layer_tree_frame_sink_;
// Tracks |window_->IsVisible()| change and update local occlusion state.
std::unique_ptr<VisibilityTracker> visibility_tracker_;
// The occlusion state that is not UNKNOWN before changing to HIDDEN. If the
// value is set, it will be used when |window_| becomes visible again. This
// allows synchronous occlusion state change when making |window_| visible.
// Window Service will send back the real occlusion state later.
base::Optional<Window::OcclusionState> occlusion_state_before_hidden_;
base::WeakPtrFactory<WindowPortMus> weak_ptr_factory_;
DISALLOW_COPY_AND_ASSIGN(WindowPortMus);
};
} // namespace aura
#endif // UI_AURA_MUS_WINDOW_PORT_MUS_H_