Add Get/SetDisplayLayout to chrome.system.display extension API

chrome/browser/extensions/display_info_provider_chromeos.cc

 // Copyright 2014 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.
 
 #include "chrome/browser/extensions/display_info_provider_chromeos.h"
 
 #include <stdint.h>
 
 #include "ash/display/display_configuration_controller.h"
 #include "ash/display/display_manager.h"
 #include "ash/display/resolution_notification_controller.h"
 #include "ash/shell.h"
 #include "base/strings/string_number_conversions.h"
 #include "chrome/browser/chromeos/display/display_preferences.h"
 #include "chrome/browser/chromeos/display/overscan_calibrator.h"
 #include "extensions/common/api/system_display.h"
 #include "ui/display/display.h"
 #include "ui/display/manager/display_layout.h"
+#include "ui/display/manager/display_layout_builder.h"
 #include "ui/gfx/geometry/point.h"
 #include "ui/gfx/geometry/rect.h"
 
 namespace extensions {
 
-using api::system_display::Bounds;
-using api::system_display::DisplayUnitInfo;
-using api::system_display::DisplayProperties;
-using api::system_display::Insets;
+namespace system_display = api::system_display;
 
 namespace {
 
 // Maximum allowed bounds origin absolute value.
 const int kMaxBoundsOrigin = 200 * 1000;
 
 // Gets the display with the provided string id.
 display::Display GetDisplay(const std::string& display_id_str) {
   int64_t display_id;
   if (!base::StringToInt64(display_id_str, &display_id))
@@ skipping 17 matching lines @@
       return display::Display::ROTATE_90;
     case 180:
       return display::Display::ROTATE_180;
     case 270:
       return display::Display::ROTATE_270;
     default:
       return display::Display::ROTATE_0;
   }
 }
 
+// Converts system_display::LayoutPosition to
+// display::DisplayPlacement::Position.
+display::DisplayPlacement::Position GetDisplayPlacementPosition(
+    system_display::LayoutPosition position) {
+  switch (position) {
+    case system_display::LAYOUT_POSITION_TOP:
+      return display::DisplayPlacement::TOP;
+    case system_display::LAYOUT_POSITION_BOTTOM:
+      return display::DisplayPlacement::BOTTOM;
+    case system_display::LAYOUT_POSITION_LEFT:
+      return display::DisplayPlacement::LEFT;
+    case system_display::LAYOUT_POSITION_RIGHT:
+    default:
+      // Default: layout to the right.
+      return display::DisplayPlacement::RIGHT;
+  }
+}
+
+// Converts display::DisplayPlacement::Position to
+// system_display::LayoutPosition.
+system_display::LayoutPosition GetLayoutPosition(
+    display::DisplayPlacement::Position position) {
+  switch (position) {
+    case display::DisplayPlacement::TOP:
+      return system_display::LayoutPosition::LAYOUT_POSITION_TOP;
+    case display::DisplayPlacement::RIGHT:
+      return system_display::LayoutPosition::LAYOUT_POSITION_RIGHT;
+    case display::DisplayPlacement::BOTTOM:
+      return system_display::LayoutPosition::LAYOUT_POSITION_BOTTOM;
+    case display::DisplayPlacement::LEFT:
+      return system_display::LayoutPosition::LAYOUT_POSITION_LEFT;
+  }
+  return system_display::LayoutPosition::LAYOUT_POSITION_NONE;
+}
+
 // Checks if the given point is over the radius vector described by it's end
 // point |vector|. The point is over a vector if it's on its positive (left)
 // side. The method sees a point on the same line as the vector as being over
 // the vector.
 bool PointIsOverRadiusVector(const gfx::Point& point,
                              const gfx::Point& vector) {
   // |point| is left of |vector| if its radius vector's scalar product with a
   // vector orthogonal (and facing the positive side) to |vector| is positive.
   //
   // An orthogonal vector of (a, b) is (b, -a), as the scalar product of these
@@ skipping 111 matching lines @@
 
   ash::Shell::GetInstance()
       ->display_configuration_controller()
       ->SetDisplayLayout(std::move(layout), true /* user_action */);
 }
 
 // Validates that parameters passed to the SetInfo function are valid for the
 // desired display and the current display manager state.
 // Returns whether the parameters are valid. On failure |error| is set to the
 // error message.
-bool ValidateParamsForDisplay(const DisplayProperties& info,
+bool ValidateParamsForDisplay(const system_display::DisplayProperties& info,
                               const display::Display& display,
                               ash::DisplayManager* display_manager,
                               int64_t primary_display_id,
                               std::string* error) {
   int64_t id = display.id();
   bool is_primary =
       id == primary_display_id || (info.is_primary && *info.is_primary);
 
   // If mirroring source id is set, a display with the given id should exist,
   // and if should not be the same as the target display's id.
@@ skipping 105 matching lines @@
       // change.
       ash::Shell::GetInstance()
           ->resolution_notification_controller()
           ->PrepareNotification(id, current_mode, new_mode,
                                 base::Bind(&chromeos::StoreDisplayPrefs));
     }
   }
   return true;
 }
 
-extensions::api::system_display::DisplayMode GetDisplayMode(
+system_display::DisplayMode GetDisplayMode(
     ash::DisplayManager* display_manager,
     const ash::DisplayInfo& display_info,
     const ash::DisplayMode& display_mode) {
-  extensions::api::system_display::DisplayMode result;
+  system_display::DisplayMode result;
 
   bool is_internal = display::Display::HasInternalDisplay() &&
                      display::Display::InternalDisplayId() == display_info.id();
   gfx::Size size_dip = display_mode.GetSizeInDIP(is_internal);
   result.width = size_dip.width();
   result.height = size_dip.height();
   result.width_in_native_pixels = display_mode.size.width();
   result.height_in_native_pixels = display_mode.size.height();
   result.ui_scale = display_mode.ui_scale;
   result.device_scale_factor = display_mode.device_scale_factor;
   result.is_native = display_mode.native;
   result.is_selected = display_mode.IsEquivalent(
       display_manager->GetActiveModeForDisplayId(display_info.id()));
   return result;
 }
 
 }  // namespace
 
-DisplayInfoProviderChromeOS::DisplayInfoProviderChromeOS() {
-}
+DisplayInfoProviderChromeOS::DisplayInfoProviderChromeOS() {}
 
-DisplayInfoProviderChromeOS::~DisplayInfoProviderChromeOS() {
-}
+DisplayInfoProviderChromeOS::~DisplayInfoProviderChromeOS() {}
 
-bool DisplayInfoProviderChromeOS::SetInfo(const std::string& display_id_str,
-                                          const DisplayProperties& info,
-                                          std::string* error) {
+bool DisplayInfoProviderChromeOS::SetInfo(
+    const std::string& display_id_str,
+    const system_display::DisplayProperties& info,
+    std::string* error) {
   ash::DisplayManager* display_manager =
       ash::Shell::GetInstance()->display_manager();
   ash::DisplayConfigurationController* display_configuration_controller =
       ash::Shell::GetInstance()->display_configuration_controller();
 
   const display::Display target = GetDisplay(display_id_str);
 
   if (target.id() == display::Display::kInvalidDisplayID) {
     *error = "Display not found.";
     return false;
   }
 
   int64_t display_id = target.id();
   const display::Display& primary =
       display::Screen::GetScreen()->GetPrimaryDisplay();
 
-  if (!ValidateParamsForDisplay(
-          info, target, display_manager, primary.id(), error)) {
+  if (!ValidateParamsForDisplay(info, target, display_manager, primary.id(),
+                                error)) {
     return false;
   }
 
   // Process 'isPrimary' parameter.
   if (info.is_primary && *info.is_primary && target.id() != primary.id()) {
     display_configuration_controller->SetPrimaryDisplayId(
         display_id, true /* user_action */);
   }
 
   // Process 'mirroringSourceId' parameter.
   if (info.mirroring_source_id) {
     bool mirror = !info.mirroring_source_id->empty();
     display_configuration_controller->SetMirrorMode(mirror,
                                                     true /* user_action */);
   }
 
   // Process 'overscan' parameter.
   if (info.overscan) {
-    display_manager->SetOverscanInsets(display_id,
-                                       gfx::Insets(info.overscan->top,
-                                                   info.overscan->left,
-                                                   info.overscan->bottom,
-                                                   info.overscan->right));
+    display_manager->SetOverscanInsets(
+        display_id, gfx::Insets(info.overscan->top, info.overscan->left,
+                                info.overscan->bottom, info.overscan->right));
   }
 
   // Process 'rotation' parameter.
   if (info.rotation) {
     display_configuration_controller->SetDisplayRotation(
         display_id, DegreesToRotation(*info.rotation),
         display::Display::ROTATION_SOURCE_ACTIVE, true /* user_action */);
   }
 
   // Process new display origin parameters.
   gfx::Point new_bounds_origin = target.bounds().origin();
   if (info.bounds_origin_x)
     new_bounds_origin.set_x(*info.bounds_origin_x);
   if (info.bounds_origin_y)
     new_bounds_origin.set_y(*info.bounds_origin_y);
 
   if (new_bounds_origin != target.bounds().origin()) {
     gfx::Rect target_bounds = target.bounds();
     target_bounds.Offset(new_bounds_origin.x() - target.bounds().x(),
                          new_bounds_origin.y() - target.bounds().y());
-    UpdateDisplayLayout(
-        primary.bounds(), primary.id(), target_bounds, target.id());
+    UpdateDisplayLayout(primary.bounds(), primary.id(), target_bounds,
+                        target.id());
   }
 
   return true;
 }
 
+bool DisplayInfoProviderChromeOS::SetDisplayLayout(
+    const DisplayLayoutList& layouts) {
+  ash::DisplayManager* display_manager =
+      ash::Shell::GetInstance()->display_manager();
+  display::DisplayLayoutBuilder builder(
+      display_manager->GetCurrentDisplayLayout());
+
+  bool have_root = false;
+  builder.ClearPlacements();
+  for (const system_display::DisplayLayout& layout : layouts) {
+    display::Display display = GetDisplay(layout.id);
+    if (display.id() == display::Display::kInvalidDisplayID)
+      return false;

[oshima, 2016/06/20 21:30:33]

optinoal: Can this happen? If not, DCHECK or LOG(ERROR) may help troubleshooting
the feedback reports.

[stevenjb, 2016/06/20 23:28:55]

It could if, e.g. the display were unplugged while a layout change was in
progress. I will add a LOG(ERROR). Done.

+    display::Display parent = GetDisplay(layout.parent_id);
+    if (parent.id() == display::Display::kInvalidDisplayID) {
+      if (have_root)
+        return false;
+      have_root = true;
+      continue;  // No placement for root (primary) display.
+    }
+    display::DisplayPlacement::Position position =
+        GetDisplayPlacementPosition(layout.position);
+    builder.AddDisplayPlacement(display.id(), parent.id(), position,
+                                layout.offset);
+  }
+  std::unique_ptr<display::DisplayLayout> layout = builder.Build();
+  if (!display::DisplayLayout::Validate(
+          display_manager->GetCurrentDisplayIdList(), *layout)) {
+    LOG(ERROR) << "Invalid layout passed to SetDisplayLayout";
+    return false;
+  }
+  ash::Shell::GetInstance()
+      ->display_configuration_controller()
+      ->SetDisplayLayout(std::move(layout), true /* user_action */);
+  return true;
+}
+
 void DisplayInfoProviderChromeOS::UpdateDisplayUnitInfoForPlatform(
     const display::Display& display,
-    extensions::api::system_display::DisplayUnitInfo* unit) {
+    system_display::DisplayUnitInfo* unit) {
   ash::DisplayManager* display_manager =
       ash::Shell::GetInstance()->display_manager();
   unit->name = display_manager->GetDisplayNameForId(display.id());
   if (display_manager->IsInMirrorMode()) {
     unit->mirroring_source_id =
         base::Int64ToString(display_manager->mirroring_display_id());
   }
 
   const ash::DisplayInfo& display_info =
       display_manager->GetDisplayInfo(display.id());
@@ skipping 14 matching lines @@
     unit->modes.push_back(
         GetDisplayMode(display_manager, display_info, display_mode));
   }
 }
 
 void DisplayInfoProviderChromeOS::EnableUnifiedDesktop(bool enable) {
   ash::Shell::GetInstance()->display_manager()->SetUnifiedDesktopEnabled(
       enable);
 }
 
-DisplayUnitInfoList DisplayInfoProviderChromeOS::GetAllDisplaysInfo() {
+DisplayInfoProvider::DisplayUnitInfoList
+DisplayInfoProviderChromeOS::GetAllDisplaysInfo() {
   ash::DisplayManager* display_manager =
       ash::Shell::GetInstance()->display_manager();
   if (!display_manager->IsInUnifiedMode())
     return DisplayInfoProvider::GetAllDisplaysInfo();
 
   std::vector<display::Display> displays =
       display_manager->software_mirroring_display_list();
   CHECK_GT(displays.size(), 0u);
 
   // Use first display as primary.
   int64_t primary_id = displays[0].id();
   DisplayUnitInfoList all_displays;
   for (const display::Display& display : displays) {
-    api::system_display::DisplayUnitInfo unit =
+    system_display::DisplayUnitInfo unit =
         CreateDisplayUnitInfo(display, primary_id);
     UpdateDisplayUnitInfoForPlatform(display, &unit);
     all_displays.push_back(std::move(unit));
   }
   return all_displays;
 }
 
+DisplayInfoProvider::DisplayLayoutList
+DisplayInfoProviderChromeOS::GetDisplayLayout() {
+  ash::DisplayManager* display_manager =
+      ash::Shell::GetInstance()->display_manager();
+
+  display::Screen* screen = display::Screen::GetScreen();
+  std::vector<display::Display> displays = screen->GetAllDisplays();
+
+  DisplayLayoutList result;
+  for (const display::Display& display : displays) {
+    const display::DisplayPlacement placement =
+        display_manager->GetCurrentDisplayLayout().FindPlacementById(
+            display.id());
+    if (placement.display_id == display::Display::kInvalidDisplayID)
+      continue;
+    system_display::DisplayLayout display_layout;
+    display_layout.id = base::Int64ToString(placement.display_id);
+    display_layout.parent_id = base::Int64ToString(placement.parent_display_id);
+    display_layout.position = GetLayoutPosition(placement.position);
+    display_layout.offset = placement.offset;
+    result.push_back(std::move(display_layout));
+  }
+  return result;
+}
+
 bool DisplayInfoProviderChromeOS::OverscanCalibrationStart(
     const std::string& id) {
   VLOG(1) << "OverscanCalibrationStart: " << id;
   const display::Display display = GetDisplay(id);
   if (display.id() == display::Display::kInvalidDisplayID)
     return false;
   auto insets =
       ash::Shell::GetInstance()->window_tree_host_manager()->GetOverscanInsets(
           display.id());
   overscan_calibrators_[id].reset(
       new chromeos::OverscanCalibrator(display, insets));
   return true;
 }
 
 bool DisplayInfoProviderChromeOS::OverscanCalibrationAdjust(
     const std::string& id,
-    const api::system_display::Insets& delta) {
+    const system_display::Insets& delta) {
   VLOG(1) << "OverscanCalibrationAdjust: " << id;
   chromeos::OverscanCalibrator* calibrator = GetCalibrator(id);
   if (!calibrator)
     return false;
   gfx::Insets insets = calibrator->insets();
   insets += gfx::Insets(delta.top, delta.left, delta.bottom, delta.right);
   calibrator->UpdateInsets(insets);
   return true;
 }
 
@@ skipping 25 matching lines @@
     return nullptr;
   return iter->second.get();
 }
 
 // static
 DisplayInfoProvider* DisplayInfoProvider::Create() {
   return new DisplayInfoProviderChromeOS();
 }
 
 }  // namespace extensions