Prevent entering maximize mode when the lid is closed or has recently opened.

ash/wm/maximize_mode/maximize_mode_controller.h

 // 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.
 
 #ifndef ASH_WM_MAXIMIZE_MODE_MAXIMIZE_MODE_CONTROLLER_H_
 #define ASH_WM_MAXIMIZE_MODE_MAXIMIZE_MODE_CONTROLLER_H_
 
 #include "ash/accelerometer/accelerometer_observer.h"
 #include "ash/ash_export.h"
 #include "ash/display/display_controller.h"
 #include "ash/display/display_manager.h"
 #include "ash/shell_observer.h"
 #include "base/macros.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/observer_list.h"
-#include "base/power_monitor/power_observer.h"
+#include "chromeos/dbus/power_manager_client.h"
 #include "ui/gfx/display.h"
 
 namespace ui {
 class EventHandler;
 }
 
 namespace ash {
 
 class MaximizeModeControllerTest;
 class ScopedDisableInternalMouseAndKeyboard;
 class MaximizeModeWindowManager;
 class MaximizeModeWindowManagerTest;
 
 // MaximizeModeController listens to accelerometer events and automatically
 // enters and exits maximize mode when the lid is opened beyond the triggering
 // angle and rotates the display to match the device when in maximize mode.
 class ASH_EXPORT MaximizeModeController : public AccelerometerObserver,
-    public base::PowerObserver,
+    public chromeos::PowerManagerClient::Observer,
     public ShellObserver,
     public DisplayController::Observer {
  public:
   // Observer that reports changes to the state of MaximizeModeController's
   // rotation lock.
   class Observer {
    public:
     // Invoked whenever |rotation_locked_| is changed.
     virtual void OnRotationLockChanged(bool rotation_locked) {}
 
@@ skipping 46 matching lines @@
 
   // AccelerometerObserver:
   virtual void OnAccelerometerUpdated(const gfx::Vector3dF& base,
                                       const gfx::Vector3dF& lid) OVERRIDE;
 
   // ShellObserver:
   virtual void OnAppTerminating() OVERRIDE;
   virtual void OnMaximizeModeStarted() OVERRIDE;
   virtual void OnMaximizeModeEnded() OVERRIDE;
 
-  // base::PowerObserver:
-  virtual void OnSuspend() OVERRIDE;
-  virtual void OnResume() OVERRIDE;
-
   // DisplayController::Observer:
   virtual void OnDisplayConfigurationChanged() OVERRIDE;
 
+  // PowerManagerClient::Observer:
+  virtual void LidEventReceived(bool open,
+                                const base::TimeTicks& time) OVERRIDE;
+  virtual void SuspendImminent() OVERRIDE;
+  virtual void SuspendDone(const base::TimeDelta& sleep_duration) OVERRIDE;
+
  private:
   friend class MaximizeModeControllerTest;
   friend class MaximizeModeWindowManagerTest;
 
+  // An abstraction of the current time in TimeTicks.
+  // This is used so that tests can  artificially control the current time.
+  // This prevents test flakiness caused by dependencies on a true clock time.
+  class TimeTickProvider {

[jonross, 2014/07/24 14:22:00]

I dislike the idea of changing the time provider.

Other classes that calculate duration all directly use base::TimeTicks::Now()
directly in their code. Where the start time can be modified:

https://code.google.com/p/chromium/codesearch#chromium/src/ash/system/chromeo...

Or their method for processing takes base::TimeTicks as the parameter, and so it
can be modified by tests:

https://code.google.com/p/chromium/codesearch#chromium/src/ui/gfx/animation/l...

Since this class exists for testing I would prefer if you switched to an
alternate method such as these.

+   public:
+    TimeTickProvider() {}
+    virtual ~TimeTickProvider() {}
+    virtual base::TimeTicks Now() const = 0;
+
+   private:
+    DISALLOW_COPY_AND_ASSIGN(TimeTickProvider);
+  };
+
+  // The default TimeTickProvider used by the MaximizeModeController.
+  class TimeTickProviderImpl : public TimeTickProvider {

[jonross, 2014/07/24 14:22:00]

This class is not needed for testing, nor for any definitions below. Please move
to an anonymous namespace within the .cc file.

+   public:
+    TimeTickProviderImpl() : TimeTickProvider() {}
+    virtual ~TimeTickProviderImpl() {}
+
+    // TimeTickProvider:
+    virtual base::TimeTicks Now() const OVERRIDE;
+
+   private:
+    DISALLOW_COPY_AND_ASSIGN(TimeTickProviderImpl);
+  };
+
+  // Set the TimeTickProvider.
+  // This is only to be used by tests that need to artificially and
+  // deterministically control the current time.
+  // Ownership of |provider| is assumed by this.
+  void SetTimeTickProviderForTest(TimeTickProvider* provider);
+
   // Detect hinge rotation from |base| and |lid| accelerometers and
   // automatically start / stop maximize mode.
   void HandleHingeRotation(const gfx::Vector3dF& base,
                            const gfx::Vector3dF& lid);
 
   // Detect screen rotation from |lid| accelerometer and automatically rotate
   // screen.
   void HandleScreenRotation(const gfx::Vector3dF& lid);
 
   // Sets the display rotation and suppresses display notifications.
   void SetDisplayRotation(DisplayManager* display_manager,
                           gfx::Display::Rotation rotation);
 
+  // Returns true if the lid was recently opened.
+  bool WasLidOpenedRecently() const;
+
   // Enables MaximizeModeWindowManager, and determines the current state of
   // rotation lock.
   void EnterMaximizeMode();
 
   // Removes MaximizeModeWindowManager and resets the display rotation if there
   // is no rotation lock.
   void LeaveMaximizeMode();
 
   // Record UMA stats tracking touchview usage.
   void RecordTouchViewStateTransition();
@@ skipping 27 matching lines @@
   gfx::Display::Rotation current_rotation_;
 
   // Rotation Lock observers.
   ObserverList<Observer> observers_;
 
   // Tracks time spent in (and out of) touchview mode.
   base::Time last_touchview_transition_time_;
   base::TimeDelta total_touchview_time_;
   base::TimeDelta total_non_touchview_time_;
 
+  // Tracks the last time we received a lid open event.
+  // This is used to suppress erroneous acceleromter readings as the lid
+  // is opened but the acceleromater reports readings that make
+  // the lid to appear near fully open.
+  base::TimeTicks last_lid_open_time_;
+
+  // Source for the current time in base::TimeTicks.
+  scoped_ptr<TimeTickProvider> time_tick_provider_;
+
+  // Tracks when the lid is closed.
+  // Used to prevent entering maximize mode.
+  bool lid_is_closed_;
+
   DISALLOW_COPY_AND_ASSIGN(MaximizeModeController);
 };
 
 }  // namespace ash
 
 #endif  // ASH_WM_MAXIMIZE_MODE_MAXIMIZE_MODE_CONTROLLER_H_