third_party/blink/renderer/core/frame/screen.cc

/*
 * Copyright (C) 2007 Apple Inc.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1.  Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 * 2.  Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
 *     its contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#include "third_party/blink/renderer/core/frame/screen.h"

#include "third_party/blink/public/common/privacy_budget/identifiability_metric_builder.h"
#include "third_party/blink/public/common/privacy_budget/identifiability_metrics.h"
#include "third_party/blink/public/common/widget/screen_info.h"
#include "third_party/blink/renderer/core/frame/local_dom_window.h"
#include "third_party/blink/renderer/core/frame/local_frame.h"
#include "third_party/blink/renderer/core/frame/local_frame_view.h"
#include "third_party/blink/renderer/core/frame/settings.h"
#include "third_party/blink/renderer/core/page/chrome_client.h"
#include "third_party/blink/renderer/core/page/page.h"
#include "third_party/blink/renderer/core/probe/core_probes.h"

namespace blink {

namespace {

ScreenInfo GetScreenInfo(LocalFrame& frame) {
  return frame.GetChromeClient().GetScreenInfo(frame);
}

}  // namespace

Screen::Screen(LocalFrame* frame) : ExecutionContextClient(frame) {}

int Screen::height() const {
  if (display_) {
    DCHECK(RuntimeEnabledFeatures::WindowPlacementEnabled());
    return display_->bounds.height();
  }
  LocalFrame* frame = GetFrame();
  if (!frame)
    return 0;
  Page* page = frame->GetPage();
  if (page->GetSettings().GetReportScreenSizeInPhysicalPixelsQuirk()) {
    ScreenInfo screen_info = GetScreenInfo(*frame);
    return static_cast<int>(
        lroundf(screen_info.rect.height() * screen_info.device_scale_factor));
  }
  return GetScreenInfo(*frame).rect.height();
}

int Screen::width() const {
  if (display_) {
    DCHECK(RuntimeEnabledFeatures::WindowPlacementEnabled());
    return display_->bounds.width();
  }
  LocalFrame* frame = GetFrame();
  if (!frame)
    return 0;
  Page* page = frame->GetPage();
  if (page->GetSettings().GetReportScreenSizeInPhysicalPixelsQuirk()) {
    ScreenInfo screen_info = GetScreenInfo(*frame);
    return static_cast<int>(
        lroundf(screen_info.rect.width() * screen_info.device_scale_factor));
  }
  return GetScreenInfo(*frame).rect.width();
}

unsigned Screen::colorDepth() const {
  if (display_) {
    DCHECK(RuntimeEnabledFeatures::WindowPlacementEnabled());
    return display_->color_depth;
  }
  LocalFrame* frame = GetFrame();
  if (!frame)
    return 0;
  return static_cast<unsigned>(GetScreenInfo(*frame).depth);
}

unsigned Screen::pixelDepth() const {
  return colorDepth();
}

int Screen::availLeft() const {
  if (display_) {
    DCHECK(RuntimeEnabledFeatures::WindowPlacementEnabled());
    return display_->work_area.x();
  }
  LocalFrame* frame = GetFrame();
  if (!frame)
    return 0;
  Page* page = frame->GetPage();
  if (page->GetSettings().GetReportScreenSizeInPhysicalPixelsQuirk()) {
    ScreenInfo screen_info = GetScreenInfo(*frame);
    return static_cast<int>(lroundf(screen_info.available_rect.x() *
                                    screen_info.device_scale_factor));
  }
  return static_cast<int>(GetScreenInfo(*frame).available_rect.x());
}

int Screen::availTop() const {
  if (display_) {
    DCHECK(RuntimeEnabledFeatures::WindowPlacementEnabled());
    return display_->work_area.y();
  }
  LocalFrame* frame = GetFrame();
  if (!frame)
    return 0;
  Page* page = frame->GetPage();
  if (page->GetSettings().GetReportScreenSizeInPhysicalPixelsQuirk()) {
    ScreenInfo screen_info = GetScreenInfo(*frame);
    return static_cast<int>(lroundf(screen_info.available_rect.y() *
                                    screen_info.device_scale_factor));
  }
  return static_cast<int>(GetScreenInfo(*frame).available_rect.y());
}

int Screen::availHeight() const {
  if (display_) {
    DCHECK(RuntimeEnabledFeatures::WindowPlacementEnabled());
    return display_->work_area.height();
  }
  LocalFrame* frame = GetFrame();
  if (!frame)
    return 0;
  Page* page = frame->GetPage();
  if (page->GetSettings().GetReportScreenSizeInPhysicalPixelsQuirk()) {
    ScreenInfo screen_info = GetScreenInfo(*frame);
    return static_cast<int>(lroundf(screen_info.available_rect.height() *
                                    screen_info.device_scale_factor));
  }
  return GetScreenInfo(*frame).available_rect.height();
}

int Screen::availWidth() const {
  if (display_) {
    DCHECK(RuntimeEnabledFeatures::WindowPlacementEnabled());
    return display_->work_area.width();
  }
  LocalFrame* frame = GetFrame();
  if (!frame)
    return 0;
  Page* page = frame->GetPage();
  if (page->GetSettings().GetReportScreenSizeInPhysicalPixelsQuirk()) {
    ScreenInfo screen_info = GetScreenInfo(*frame);
    return static_cast<int>(lroundf(screen_info.available_rect.width() *
                                    screen_info.device_scale_factor));
  }
  return GetScreenInfo(*frame).available_rect.width();
}

void Screen::Trace(Visitor* visitor) const {
  ScriptWrappable::Trace(visitor);
  ExecutionContextClient::Trace(visitor);
  Supplementable<Screen>::Trace(visitor);
}

Screen::Screen(display::mojom::blink::DisplayPtr display,
               bool internal,
               bool primary,
               const String& id)
    : ExecutionContextClient(static_cast<LocalFrame*>(nullptr)),
      display_(std::move(display)),
      internal_(internal),
      primary_(primary),
      id_(id) {}

int Screen::left() const {
  if (display_) {
    DCHECK(RuntimeEnabledFeatures::WindowPlacementEnabled());
    return display_->bounds.x();
  }
  LocalFrame* frame = GetFrame();
  if (!frame)
    return 0;
  Page* page = frame->GetPage();
  if (page->GetSettings().GetReportScreenSizeInPhysicalPixelsQuirk()) {
    ScreenInfo screen_info = GetScreenInfo(*frame);
    return static_cast<int>(
        lroundf(screen_info.rect.x() * screen_info.device_scale_factor));
  }
  return GetScreenInfo(*frame).rect.x();
}

int Screen::top() const {
  if (display_) {
    DCHECK(RuntimeEnabledFeatures::WindowPlacementEnabled());
    return display_->bounds.y();
  }
  LocalFrame* frame = GetFrame();
  if (!frame)
    return 0;
  Page* page = frame->GetPage();
  if (page->GetSettings().GetReportScreenSizeInPhysicalPixelsQuirk()) {
    ScreenInfo screen_info = GetScreenInfo(*frame);
    return static_cast<int>(
        lroundf(screen_info.rect.y() * screen_info.device_scale_factor));
  }
  return GetScreenInfo(*frame).rect.y();
}

bool Screen::internal() const {
  if (display_) {
    DCHECK(RuntimeEnabledFeatures::WindowPlacementEnabled());
    return internal_.has_value() && internal_.value();
  }
  // TODO(http://crbug.com/994889): Implement this for |window.screen|?
  NOTIMPLEMENTED_LOG_ONCE();
  return false;
}

bool Screen::primary() const {
  if (display_) {
    DCHECK(RuntimeEnabledFeatures::WindowPlacementEnabled());
    return primary_.has_value() && primary_.value();
  }
  // TODO(http://crbug.com/994889): Implement this for |window.screen|?
  NOTIMPLEMENTED_LOG_ONCE();
  return false;
}

float Screen::scaleFactor() const {
  if (display_) {
    DCHECK(RuntimeEnabledFeatures::WindowPlacementEnabled());
    return display_->device_scale_factor;
  }
  LocalFrame* frame = GetFrame();
  if (!frame)
    return 0;
  return GetScreenInfo(*frame).device_scale_factor;
}

const String Screen::id() const {
  if (display_) {
    DCHECK(RuntimeEnabledFeatures::WindowPlacementEnabled());
    return id_;
  }
  // TODO(http://crbug.com/994889): Implement this for |window.screen|?
  NOTIMPLEMENTED_LOG_ONCE();
  return String();
}

bool Screen::touchSupport() const {
  if (display_) {
    DCHECK(RuntimeEnabledFeatures::WindowPlacementEnabled());
    return display_->touch_support ==
           display::mojom::blink::TouchSupport::AVAILABLE;
  }
  // TODO(http://crbug.com/994889): Implement this for |window.screen|?
  NOTIMPLEMENTED_LOG_ONCE();
  return false;
}

int64_t Screen::DisplayId() const {
  if (display_) {
    DCHECK(RuntimeEnabledFeatures::WindowPlacementEnabled());
    return display_->id;
  }
  return kInvalidDisplayId;
}

}  // namespace blink