Updates touch calibration API and plumbs through the native touch calibration method

extensions/browser/api/system_display/display_info_provider.h

 // Copyright 2013 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 EXTENSIONS_BROWSER_API_SYSTEM_DISPLAY_DISPLAY_INFO_PROVIDER_H_
 #define EXTENSIONS_BROWSER_API_SYSTEM_DISPLAY_DISPLAY_INFO_PROVIDER_H_
 
 #include <stdint.h>
 
 #include <string>
 #include <vector>
 
+#include "base/callback_forward.h"
 #include "base/macros.h"
 
 namespace display {
 class Display;
 }
 
 namespace extensions {
 
 namespace api {
 namespace system_display {
 struct Bounds;
 struct DisplayLayout;
 struct DisplayProperties;
 struct DisplayUnitInfo;
 struct Insets;
 struct TouchCalibrationPairQuad;
 }
 }
 
 class DisplayInfoProvider {
  public:
   using DisplayUnitInfoList = std::vector<api::system_display::DisplayUnitInfo>;
   using DisplayLayoutList = std::vector<api::system_display::DisplayLayout>;
+  using TouchCalibrationCallback = base::Callback<void(bool)>;
 
   virtual ~DisplayInfoProvider();
 
   // Returns a pointer to DisplayInfoProvider or NULL if Create()
   // or InitializeForTesting() or not called yet.
   static DisplayInfoProvider* Get();
 
   // This is for tests that run in its own process (e.g. browser_tests).
   // Using this in other tests (e.g. unit_tests) will result in DCHECK failure.
   static void InitializeForTesting(DisplayInfoProvider* display_info_provider);
@@ skipping 22 matching lines @@
   // return false if |id| is invalid.
   virtual bool OverscanCalibrationStart(const std::string& id);
   virtual bool OverscanCalibrationAdjust(
       const std::string& id,
       const api::system_display::Insets& delta);
   virtual bool OverscanCalibrationReset(const std::string& id);
   virtual bool OverscanCalibrationComplete(const std::string& id);
 
   // Implements touch calibration methods. See system_display.idl. This returns
   // false if |id| is invalid.
-  virtual bool TouchCalibrationStart(const std::string& id);
-  virtual bool TouchCalibrationSet(
+  virtual bool ShowNativeTouchCalibration(
       const std::string& id,
+      std::string* error,
+      const TouchCalibrationCallback& callback);
+  virtual bool StartCustomTouchCalibration(const std::string& id,
+                                           std::string* error);
+  virtual bool CompleteCustomTouchCalibration(
       const api::system_display::TouchCalibrationPairQuad& pairs,
       const api::system_display::Bounds& bounds,
       std::string* error);
-  virtual bool TouchCalibrationReset(const std::string& id, std::string* error);
-  virtual bool IsTouchCalibrationActive(std::string* error);
+  virtual bool ResetTouchCalibration(const std::string& id, std::string* error);
+  virtual bool IsNativeTouchCalibrationActive(std::string* error);

[stevenjb, 2017/01/19 17:19:01]

All of these should be documented. In particular, document when and how |error|
will be set.

[malaykeshav, 2017/01/19 23:49:07]

Adding comments where the error is being set.

[stevenjb, 2017/01/20 00:07:07]

Public methods should *always* be documented, especially virtual methods (but
not the overrides). We are obviously not great about that in this class, but we
really should improve that.

 
  protected:
   DisplayInfoProvider();
 
   // Create a DisplayUnitInfo from a display::Display for implementations of
   // GetAllDisplaysInfo()
   static api::system_display::DisplayUnitInfo CreateDisplayUnitInfo(
       const display::Display& display,
       int64_t primary_display_id);
 
  private:
   static DisplayInfoProvider* Create();
 
   // Update the content of the |unit| obtained for |display| using
   // platform specific method.
   virtual void UpdateDisplayUnitInfoForPlatform(
       const display::Display& display,
       api::system_display::DisplayUnitInfo* unit) = 0;
 
   DISALLOW_COPY_AND_ASSIGN(DisplayInfoProvider);
 };
 
 }  // namespace extensions
 
 #endif  // EXTENSIONS_BROWSER_API_SYSTEM_DISPLAY_DISPLAY_INFO_PROVIDER_H_