cc/blink/web_layer_impl.cc

   1 // Copyright 2014 The Chromium 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
   5 #include "cc/blink/web_layer_impl.h"
   6
   7 #include <utility>
   8 #include <vector>
   9
  10 #include "base/bind.h"
  11 #include "base/lazy_instance.h"
  12 #include "base/strings/string_util.h"
  13 #include "base/threading/thread_checker.h"
  14 #include "base/trace_event/trace_event_impl.h"
  15 #include "cc/animation/animation.h"
  16 #include "cc/base/region.h"
  17 #include "cc/base/switches.h"
  18 #include "cc/blink/web_animation_impl.h"
  19 #include "cc/blink/web_blend_mode.h"
  20 #include "cc/blink/web_filter_operations_impl.h"
  21 #include "cc/blink/web_to_cc_animation_delegate_adapter.h"
  22 #include "cc/layers/layer.h"
  23 #include "cc/layers/layer_position_constraint.h"
  24 #include "cc/trees/layer_tree_host.h"
  25 #include "third_party/WebKit/public/platform/WebFloatPoint.h"
  26 #include "third_party/WebKit/public/platform/WebFloatRect.h"
  27 #include "third_party/WebKit/public/platform/WebGraphicsLayerDebugInfo.h"
  28 #include "third_party/WebKit/public/platform/WebLayerClient.h"
  29 #include "third_party/WebKit/public/platform/WebLayerPositionConstraint.h"
  30 #include "third_party/WebKit/public/platform/WebLayerScrollClient.h"
  31 #include "third_party/WebKit/public/platform/WebSize.h"
  32 #include "third_party/skia/include/utils/SkMatrix44.h"
  33 #include "ui/gfx/geometry/rect_conversions.h"
  34 #include "ui/gfx/geometry/vector2d_conversions.h"
  35
  36 using cc::Animation;
  37 using cc::Layer;
  38 using blink::WebLayer;
  39 using blink::WebFloatPoint;
  40 using blink::WebVector;
  41 using blink::WebRect;
  42 using blink::WebSize;
  43 using blink::WebColor;
  44 using blink::WebFilterOperations;
  45
  46 namespace cc_blink {
  47 namespace {
  48
  49 bool g_impl_side_painting_enabled = false;
  50
  51 base::LazyInstance<cc::LayerSettings> g_layer_settings =
  52     LAZY_INSTANCE_INITIALIZER;
  53
  54 }  // namespace
  55
  56 WebLayerImpl::WebLayerImpl() : layer_(Layer::Create(LayerSettings())) {
  57   web_layer_client_ = nullptr;
  58   layer_->SetLayerClient(this);
  59 }
  60
  61 WebLayerImpl::WebLayerImpl(scoped_refptr<Layer> layer) : layer_(layer) {
  62   web_layer_client_ = nullptr;
  63   layer_->SetLayerClient(this);
  64 }
  65
  66 WebLayerImpl::~WebLayerImpl() {
  67   layer_->ClearRenderSurface();
  68   if (animation_delegate_adapter_.get())
  69     layer_->set_layer_animation_delegate(nullptr);
  70   web_layer_client_ = nullptr;
  71 }
  72
  73 // static
  74 bool WebLayerImpl::UsingPictureLayer() {
  75   return g_impl_side_painting_enabled;
  76 }
  77
  78 // static
  79 void WebLayerImpl::SetImplSidePaintingEnabled(bool enabled) {
  80   g_impl_side_painting_enabled = enabled;
  81 }
  82
  83 // static
  84 void WebLayerImpl::SetLayerSettings(const cc::LayerSettings& settings) {
  85   g_layer_settings.Get() = settings;
  86 }
  87
  88 // static
  89 const cc::LayerSettings& WebLayerImpl::LayerSettings() {
  90   return g_layer_settings.Get();
  91 }
  92
  93 int WebLayerImpl::id() const {
  94   return layer_->id();
  95 }
  96
  97 void WebLayerImpl::invalidateRect(const blink::WebRect& rect) {
  98   layer_->SetNeedsDisplayRect(rect);
  99 }
 100
 101 void WebLayerImpl::invalidate() {
 102   layer_->SetNeedsDisplay();
 103 }
 104
 105 void WebLayerImpl::addChild(WebLayer* child) {
 106   layer_->AddChild(static_cast<WebLayerImpl*>(child)->layer());
 107 }
 108
 109 void WebLayerImpl::insertChild(WebLayer* child, size_t index) {
 110   layer_->InsertChild(static_cast<WebLayerImpl*>(child)->layer(), index);
 111 }
 112
 113 void WebLayerImpl::replaceChild(WebLayer* reference, WebLayer* new_layer) {
 114   layer_->ReplaceChild(static_cast<WebLayerImpl*>(reference)->layer(),
 115                        static_cast<WebLayerImpl*>(new_layer)->layer());
 116 }
 117
 118 void WebLayerImpl::removeFromParent() {
 119   layer_->RemoveFromParent();
 120 }
 121
 122 void WebLayerImpl::removeAllChildren() {
 123   layer_->RemoveAllChildren();
 124 }
 125
 126 void WebLayerImpl::setBounds(const WebSize& size) {
 127   layer_->SetBounds(size);
 128 }
 129
 130 WebSize WebLayerImpl::bounds() const {
 131   return layer_->bounds();
 132 }
 133
 134 void WebLayerImpl::setMasksToBounds(bool masks_to_bounds) {
 135   layer_->SetMasksToBounds(masks_to_bounds);
 136 }
 137
 138 bool WebLayerImpl::masksToBounds() const {
 139   return layer_->masks_to_bounds();
 140 }
 141
 142 void WebLayerImpl::setMaskLayer(WebLayer* maskLayer) {
 143   layer_->SetMaskLayer(
 144       maskLayer ? static_cast<WebLayerImpl*>(maskLayer)->layer() : 0);
 145 }
 146
 147 void WebLayerImpl::setReplicaLayer(WebLayer* replica_layer) {
 148   layer_->SetReplicaLayer(
 149       replica_layer ? static_cast<WebLayerImpl*>(replica_layer)->layer() : 0);
 150 }
 151
 152 void WebLayerImpl::setOpacity(float opacity) {
 153   layer_->SetOpacity(opacity);
 154 }
 155
 156 float WebLayerImpl::opacity() const {
 157   return layer_->opacity();
 158 }
 159
 160 void WebLayerImpl::setBlendMode(blink::WebBlendMode blend_mode) {
 161   layer_->SetBlendMode(BlendModeToSkia(blend_mode));
 162 }
 163
 164 blink::WebBlendMode WebLayerImpl::blendMode() const {
 165   return BlendModeFromSkia(layer_->blend_mode());
 166 }
 167
 168 void WebLayerImpl::setIsRootForIsolatedGroup(bool isolate) {
 169   layer_->SetIsRootForIsolatedGroup(isolate);
 170 }
 171
 172 bool WebLayerImpl::isRootForIsolatedGroup() {
 173   return layer_->is_root_for_isolated_group();
 174 }
 175
 176 void WebLayerImpl::setOpaque(bool opaque) {
 177   layer_->SetContentsOpaque(opaque);
 178 }
 179
 180 bool WebLayerImpl::opaque() const {
 181   return layer_->contents_opaque();
 182 }
 183
 184 void WebLayerImpl::setPosition(const WebFloatPoint& position) {
 185   layer_->SetPosition(position);
 186 }
 187
 188 WebFloatPoint WebLayerImpl::position() const {
 189   return layer_->position();
 190 }
 191
 192 void WebLayerImpl::setTransform(const SkMatrix44& matrix) {
 193   gfx::Transform transform;
 194   transform.matrix() = matrix;
 195   layer_->SetTransform(transform);
 196 }
 197
 198 void WebLayerImpl::setTransformOrigin(const blink::WebFloatPoint3D& point) {
 199   gfx::Point3F gfx_point = point;
 200   layer_->SetTransformOrigin(gfx_point);
 201 }
 202
 203 blink::WebFloatPoint3D WebLayerImpl::transformOrigin() const {
 204   return layer_->transform_origin();
 205 }
 206
 207 SkMatrix44 WebLayerImpl::transform() const {
 208   return layer_->transform().matrix();
 209 }
 210
 211 void WebLayerImpl::setDrawsContent(bool draws_content) {
 212   layer_->SetIsDrawable(draws_content);
 213 }
 214
 215 bool WebLayerImpl::drawsContent() const {
 216   return layer_->DrawsContent();
 217 }
 218
 219 void WebLayerImpl::setShouldFlattenTransform(bool flatten) {
 220   layer_->SetShouldFlattenTransform(flatten);
 221 }
 222
 223 void WebLayerImpl::setRenderingContext(int context) {
 224   layer_->Set3dSortingContextId(context);
 225 }
 226
 227 void WebLayerImpl::setUseParentBackfaceVisibility(
 228     bool use_parent_backface_visibility) {
 229   layer_->set_use_parent_backface_visibility(use_parent_backface_visibility);
 230 }
 231
 232 void WebLayerImpl::setBackgroundColor(WebColor color) {
 233   layer_->SetBackgroundColor(color);
 234 }
 235
 236 WebColor WebLayerImpl::backgroundColor() const {
 237   return layer_->background_color();
 238 }
 239
 240 void WebLayerImpl::setFilters(const WebFilterOperations& filters) {
 241   const WebFilterOperationsImpl& filters_impl =
 242       static_cast<const WebFilterOperationsImpl&>(filters);
 243   layer_->SetFilters(filters_impl.AsFilterOperations());
 244 }
 245
 246 void WebLayerImpl::setBackgroundFilters(const WebFilterOperations& filters) {
 247   const WebFilterOperationsImpl& filters_impl =
 248       static_cast<const WebFilterOperationsImpl&>(filters);
 249   layer_->SetBackgroundFilters(filters_impl.AsFilterOperations());
 250 }
 251
 252 void WebLayerImpl::setAnimationDelegate(
 253     blink::WebCompositorAnimationDelegate* delegate) {
 254   animation_delegate_adapter_.reset(
 255       new WebToCCAnimationDelegateAdapter(delegate));
 256   layer_->set_layer_animation_delegate(animation_delegate_adapter_.get());
 257 }
 258
 259 bool WebLayerImpl::addAnimation(blink::WebCompositorAnimation* animation) {
 260   bool result = layer_->AddAnimation(
 261       static_cast<WebCompositorAnimationImpl*>(animation)->PassAnimation());
 262   delete animation;
 263   return result;
 264 }
 265
 266 void WebLayerImpl::removeAnimation(int animation_id) {
 267   layer_->RemoveAnimation(animation_id);
 268 }
 269
 270 void WebLayerImpl::removeAnimation(
 271     int animation_id,
 272     blink::WebCompositorAnimation::TargetProperty target_property) {
 273   layer_->RemoveAnimation(
 274       animation_id, static_cast<Animation::TargetProperty>(target_property));
 275 }
 276
 277 void WebLayerImpl::pauseAnimation(int animation_id, double time_offset) {
 278   layer_->PauseAnimation(animation_id, time_offset);
 279 }
 280
 281 bool WebLayerImpl::hasActiveAnimation() {
 282   return layer_->HasActiveAnimation();
 283 }
 284
 285 void WebLayerImpl::setForceRenderSurface(bool force_render_surface) {
 286   layer_->SetForceRenderSurface(force_render_surface);
 287 }
 288
 289 void WebLayerImpl::setScrollPositionDouble(blink::WebDoublePoint position) {
 290   layer_->SetScrollOffset(gfx::ScrollOffset(position.x, position.y));
 291 }
 292
 293 void WebLayerImpl::setScrollCompensationAdjustment(
 294     blink::WebDoublePoint position) {
 295   layer_->SetScrollCompensationAdjustment(
 296       gfx::Vector2dF(position.x, position.y));
 297 }
 298
 299 blink::WebDoublePoint WebLayerImpl::scrollPositionDouble() const {
 300   return blink::WebDoublePoint(layer_->scroll_offset().x(),
 301                                layer_->scroll_offset().y());
 302 }
 303
 304 void WebLayerImpl::setScrollClipLayer(WebLayer* clip_layer) {
 305   if (!clip_layer) {
 306     layer_->SetScrollClipLayerId(Layer::INVALID_ID);
 307     return;
 308   }
 309   layer_->SetScrollClipLayerId(clip_layer->id());
 310 }
 311
 312 bool WebLayerImpl::scrollable() const {
 313   return layer_->scrollable();
 314 }
 315
 316 void WebLayerImpl::setUserScrollable(bool horizontal, bool vertical) {
 317   layer_->SetUserScrollable(horizontal, vertical);
 318 }
 319
 320 bool WebLayerImpl::userScrollableHorizontal() const {
 321   return layer_->user_scrollable_horizontal();
 322 }
 323
 324 bool WebLayerImpl::userScrollableVertical() const {
 325   return layer_->user_scrollable_vertical();
 326 }
 327
 328 void WebLayerImpl::setHaveWheelEventHandlers(bool have_wheel_event_handlers) {
 329   layer_->SetHaveWheelEventHandlers(have_wheel_event_handlers);
 330 }
 331
 332 bool WebLayerImpl::haveWheelEventHandlers() const {
 333   return layer_->have_wheel_event_handlers();
 334 }
 335
 336 void WebLayerImpl::setHaveScrollEventHandlers(bool have_scroll_event_handlers) {
 337   layer_->SetHaveScrollEventHandlers(have_scroll_event_handlers);
 338 }
 339
 340 bool WebLayerImpl::haveScrollEventHandlers() const {
 341   return layer_->have_scroll_event_handlers();
 342 }
 343
 344 void WebLayerImpl::setShouldScrollOnMainThread(
 345     bool should_scroll_on_main_thread) {
 346   layer_->SetShouldScrollOnMainThread(should_scroll_on_main_thread);
 347 }
 348
 349 bool WebLayerImpl::shouldScrollOnMainThread() const {
 350   return layer_->should_scroll_on_main_thread();
 351 }
 352
 353 void WebLayerImpl::setNonFastScrollableRegion(const WebVector<WebRect>& rects) {
 354   cc::Region region;
 355   for (size_t i = 0; i < rects.size(); ++i)
 356     region.Union(rects[i]);
 357   layer_->SetNonFastScrollableRegion(region);
 358 }
 359
 360 WebVector<WebRect> WebLayerImpl::nonFastScrollableRegion() const {
 361   size_t num_rects = 0;
 362   for (cc::Region::Iterator region_rects(layer_->non_fast_scrollable_region());
 363        region_rects.has_rect();
 364        region_rects.next())
 365     ++num_rects;
 366
 367   WebVector<WebRect> result(num_rects);
 368   size_t i = 0;
 369   for (cc::Region::Iterator region_rects(layer_->non_fast_scrollable_region());
 370        region_rects.has_rect();
 371        region_rects.next()) {
 372     result[i] = region_rects.rect();
 373     ++i;
 374   }
 375   return result;
 376 }
 377
 378 void WebLayerImpl::setFrameTimingRequests(
 379     const WebVector<std::pair<int64_t, WebRect>>& requests) {
 380   std::vector<cc::FrameTimingRequest> frame_timing_requests(requests.size());
 381   for (size_t i = 0; i < requests.size(); ++i) {
 382     frame_timing_requests[i] = cc::FrameTimingRequest(
 383         requests[i].first, gfx::Rect(requests[i].second));
 384   }
 385   layer_->SetFrameTimingRequests(frame_timing_requests);
 386 }
 387
 388 WebVector<std::pair<int64_t, WebRect>> WebLayerImpl::frameTimingRequests()
 389     const {
 390   const std::vector<cc::FrameTimingRequest>& frame_timing_requests =
 391       layer_->FrameTimingRequests();
 392
 393   size_t num_requests = frame_timing_requests.size();
 394
 395   WebVector<std::pair<int64_t, WebRect>> result(num_requests);
 396   for (size_t i = 0; i < num_requests; ++i) {
 397     result[i] = std::make_pair(frame_timing_requests[i].id(),
 398                                frame_timing_requests[i].rect());
 399   }
 400   return result;
 401 }
 402
 403 void WebLayerImpl::setTouchEventHandlerRegion(const WebVector<WebRect>& rects) {
 404   cc::Region region;
 405   for (size_t i = 0; i < rects.size(); ++i)
 406     region.Union(rects[i]);
 407   layer_->SetTouchEventHandlerRegion(region);
 408 }
 409
 410 WebVector<WebRect> WebLayerImpl::touchEventHandlerRegion() const {
 411   size_t num_rects = 0;
 412   for (cc::Region::Iterator region_rects(layer_->touch_event_handler_region());
 413        region_rects.has_rect();
 414        region_rects.next())
 415     ++num_rects;
 416
 417   WebVector<WebRect> result(num_rects);
 418   size_t i = 0;
 419   for (cc::Region::Iterator region_rects(layer_->touch_event_handler_region());
 420        region_rects.has_rect();
 421        region_rects.next()) {
 422     result[i] = region_rects.rect();
 423     ++i;
 424   }
 425   return result;
 426 }
 427
 428 static_assert(static_cast<ScrollBlocksOn>(blink::WebScrollBlocksOnNone) ==
 429                   SCROLL_BLOCKS_ON_NONE,
 430               "ScrollBlocksOn and WebScrollBlocksOn enums must match");
 431 static_assert(static_cast<ScrollBlocksOn>(blink::WebScrollBlocksOnStartTouch) ==
 432                   SCROLL_BLOCKS_ON_START_TOUCH,
 433               "ScrollBlocksOn and WebScrollBlocksOn enums must match");
 434 static_assert(static_cast<ScrollBlocksOn>(blink::WebScrollBlocksOnWheelEvent) ==
 435                   SCROLL_BLOCKS_ON_WHEEL_EVENT,
 436               "ScrollBlocksOn and WebScrollBlocksOn enums must match");
 437 static_assert(
 438     static_cast<ScrollBlocksOn>(blink::WebScrollBlocksOnScrollEvent) ==
 439         SCROLL_BLOCKS_ON_SCROLL_EVENT,
 440     "ScrollBlocksOn and WebScrollBlocksOn enums must match");
 441
 442 void WebLayerImpl::setScrollBlocksOn(blink::WebScrollBlocksOn blocks) {
 443   layer_->SetScrollBlocksOn(static_cast<ScrollBlocksOn>(blocks));
 444 }
 445
 446 blink::WebScrollBlocksOn WebLayerImpl::scrollBlocksOn() const {
 447   return static_cast<blink::WebScrollBlocksOn>(layer_->scroll_blocks_on());
 448 }
 449
 450 void WebLayerImpl::setIsContainerForFixedPositionLayers(bool enable) {
 451   layer_->SetIsContainerForFixedPositionLayers(enable);
 452 }
 453
 454 bool WebLayerImpl::isContainerForFixedPositionLayers() const {
 455   return layer_->IsContainerForFixedPositionLayers();
 456 }
 457
 458 static blink::WebLayerPositionConstraint ToWebLayerPositionConstraint(
 459     const cc::LayerPositionConstraint& constraint) {
 460   blink::WebLayerPositionConstraint web_constraint;
 461   web_constraint.isFixedPosition = constraint.is_fixed_position();
 462   web_constraint.isFixedToRightEdge = constraint.is_fixed_to_right_edge();
 463   web_constraint.isFixedToBottomEdge = constraint.is_fixed_to_bottom_edge();
 464   return web_constraint;
 465 }
 466
 467 static cc::LayerPositionConstraint ToLayerPositionConstraint(
 468     const blink::WebLayerPositionConstraint& web_constraint) {
 469   cc::LayerPositionConstraint constraint;
 470   constraint.set_is_fixed_position(web_constraint.isFixedPosition);
 471   constraint.set_is_fixed_to_right_edge(web_constraint.isFixedToRightEdge);
 472   constraint.set_is_fixed_to_bottom_edge(web_constraint.isFixedToBottomEdge);
 473   return constraint;
 474 }
 475
 476 void WebLayerImpl::setPositionConstraint(
 477     const blink::WebLayerPositionConstraint& constraint) {
 478   layer_->SetPositionConstraint(ToLayerPositionConstraint(constraint));
 479 }
 480
 481 blink::WebLayerPositionConstraint WebLayerImpl::positionConstraint() const {
 482   return ToWebLayerPositionConstraint(layer_->position_constraint());
 483 }
 484
 485 void WebLayerImpl::setScrollClient(blink::WebLayerScrollClient* scroll_client) {
 486   if (scroll_client) {
 487     layer_->set_did_scroll_callback(
 488         base::Bind(&blink::WebLayerScrollClient::didScroll,
 489                    base::Unretained(scroll_client)));
 490   } else {
 491     layer_->set_did_scroll_callback(base::Closure());
 492   }
 493 }
 494
 495 bool WebLayerImpl::isOrphan() const {
 496   return !layer_->layer_tree_host();
 497 }
 498
 499 void WebLayerImpl::setWebLayerClient(blink::WebLayerClient* client) {
 500   web_layer_client_ = client;
 501 }
 502
 503 class TracedDebugInfo : public base::trace_event::ConvertableToTraceFormat {
 504  public:
 505   // This object takes ownership of the debug_info object.
 506   explicit TracedDebugInfo(blink::WebGraphicsLayerDebugInfo* debug_info)
 507       : debug_info_(debug_info) {}
 508   void AppendAsTraceFormat(std::string* out) const override {
 509     DCHECK(thread_checker_.CalledOnValidThread());
 510     blink::WebString web_string;
 511     debug_info_->appendAsTraceFormat(&web_string);
 512     out->append(web_string.utf8());
 513   }
 514
 515  private:
 516   ~TracedDebugInfo() override {}
 517   scoped_ptr<blink::WebGraphicsLayerDebugInfo> debug_info_;
 518   base::ThreadChecker thread_checker_;
 519 };
 520
 521 scoped_refptr<base::trace_event::ConvertableToTraceFormat>
 522 WebLayerImpl::TakeDebugInfo() {
 523   if (!web_layer_client_)
 524     return nullptr;
 525   blink::WebGraphicsLayerDebugInfo* debug_info =
 526       web_layer_client_->takeDebugInfoFor(this);
 527
 528   if (debug_info)
 529     return new TracedDebugInfo(debug_info);
 530   else
 531     return nullptr;
 532 }
 533
 534 void WebLayerImpl::setScrollParent(blink::WebLayer* parent) {
 535   cc::Layer* scroll_parent = nullptr;
 536   if (parent)
 537     scroll_parent = static_cast<WebLayerImpl*>(parent)->layer();
 538   layer_->SetScrollParent(scroll_parent);
 539 }
 540
 541 void WebLayerImpl::setClipParent(blink::WebLayer* parent) {
 542   cc::Layer* clip_parent = nullptr;
 543   if (parent)
 544     clip_parent = static_cast<WebLayerImpl*>(parent)->layer();
 545   layer_->SetClipParent(clip_parent);
 546 }
 547
 548 Layer* WebLayerImpl::layer() const {
 549   return layer_.get();
 550 }
 551
 552 }  // namespace cc_blink