The DisplayVirtualKeyboard function on Windows 8 and beyond should not be displaying the OSK if a p…

base/win/win_util.cc

 // Copyright (c) 2012 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 "base/win/win_util.h"
 
 #include <aclapi.h>
+#include <cfgmgr32.h>
 #include <lm.h>
 #include <powrprof.h>
 #include <shellapi.h>
 #include <shlobj.h>
 #include <shobjidl.h>  // Must be before propkey.
 #include <initguid.h>
 #include <propkey.h>
 #include <propvarutil.h>
 #include <sddl.h>
+#include <setupapi.h>
 #include <signal.h>
 #include <stdlib.h>
 
 #include "base/lazy_instance.h"
 #include "base/logging.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/strings/string_util.h"
 #include "base/strings/stringprintf.h"
 #include "base/threading/thread_restrictions.h"
 #include "base/win/metro.h"
@@ skipping 19 matching lines @@
 }
 
 void __cdecl ForceCrashOnSigAbort(int) {
   *((int*)0) = 0x1337;
 }
 
 const wchar_t kWindows8OSKRegPath[] =
     L"Software\\Classes\\CLSID\\{054AAE20-4BEA-4347-8A35-64A533254A9D}"
     L"\\LocalServer32";
 
+// Returns true if a physical keyboard is detected on Windows 8 and up.
+// Uses the Setup APIs to enumerate the attached keyboards and returns true
+// if the keyboard count is more than 1. While this will work in most cases
+// it won't work if there are devices which expose keyboard interfaces which
+// are attached to the machine.
+bool IsKeyboardPresentOnSlate() {
+  // This function is only supported for Windows 8 and up.
+  if (base::win::GetVersion() < base::win::VERSION_WIN8) {

[Lei Zhang, 2014/10/20 21:53:15]

Since this function is internal to win_util.cc, there should be very few callers
and they should get it right. Just make this a DCHECK instead of trying to
handle it? See philosophy here:
http://www.chromium.org/developers/coding-style#TOC-CHECK-DCHECK-and-NOTREACHED-

[ananta, 2014/10/20 22:00:13]

Done.

+    DCHECK(false);
+    return true;
+  }
+
+  // This function should be only invoked for machines with touch screens.
+  if ((GetSystemMetrics(SM_DIGITIZER) & NID_INTEGRATED_TOUCH)
+        != NID_INTEGRATED_TOUCH) {
+    return true;
+  }
+
+  const GUID KEYBOARD_CLASS_GUID =
+      { 0x4D36E96B, 0xE325,  0x11CE,
+          { 0xBF, 0xC1, 0x08, 0x00, 0x2B, 0xE1, 0x03, 0x18 } };
+
+  // Query for all the keyboard devices.
+  HDEVINFO device_info =
+      SetupDiGetClassDevs(&KEYBOARD_CLASS_GUID, NULL, NULL, DIGCF_PRESENT);
+  if (device_info == INVALID_HANDLE_VALUE)
+    return false;
+
+  // Enumerate all keyboards and look for ACPI\PNP and HID\VID devices. If
+  // the count is more than 1 we assume that a keyboard is present. This is
+  // under the assumption that there will always be one keyboard device.
+  int keyboard_count = 0;
+  for (int i = 0;; ++i) {

[Lei Zhang, 2014/10/20 21:53:15]

Does the compiler care about int vs DWORD?

[ananta, 2014/10/20 22:00:13]

They are the same size. Changed for correctness to DWORD.

+    SP_DEVINFO_DATA device_info_data = { 0 };
+    device_info_data.cbSize = sizeof (device_info_data);

[Lei Zhang, 2014/10/20 21:53:15]

nit: sizeof(

[ananta, 2014/10/20 22:00:13]

Done.

+    if (!SetupDiEnumDeviceInfo(device_info, i, &device_info_data))
+      break;
+    // Get the device ID.
+    wchar_t device_id[MAX_DEVICE_ID_LEN];
+    CONFIGRET status = CM_Get_Device_ID(device_info_data.DevInst,
+                                        device_id,
+                                        MAX_DEVICE_ID_LEN,
+                                        0);
+    if (status == CR_SUCCESS) {
+      // To reduce the scope of the hack we only look for PNP and HID
+      // keyboards.
+      if (StartsWith(L"ACPI\\PNP", device_id, false) ||
+          StartsWith(L"HID\\VID", device_id, false)) {
+        keyboard_count++;
+      }
+    }
+  }
+  // On a Windows machine, the API's always report 1 keyboard at least
+  // regardless of whether the machine has a keyboard attached or not.
+  // The heuristic we are using is to check the count and return true
+  // if the API's report more than one keyboard. Please note that this
+  // will break for non keyboard devices which expose a keyboard PDO.
+  return keyboard_count > 1;
+}
+
 }  // namespace
 
 namespace base {
 namespace win {
 
 static bool g_crash_on_process_detach = false;
 
 #define NONCLIENTMETRICS_SIZE_PRE_VISTA \
     SIZEOF_STRUCT_WITH_SPECIFIED_LAST_MEMBER(NONCLIENTMETRICS, lfMessageFont)
 
@@ skipping 179 matching lines @@
   if (mobile_power_profile || slate_power_profile)
     return (GetSystemMetrics(SM_CONVERTIBLESLATEMODE) == 0);
 
   return false;
 }
 
 bool DisplayVirtualKeyboard() {
   if (base::win::GetVersion() < base::win::VERSION_WIN8)
     return false;
 
+  if (IsKeyboardPresentOnSlate())
+    return false;
+
   static base::LazyInstance<string16>::Leaky osk_path =
       LAZY_INSTANCE_INITIALIZER;
 
   if (osk_path.Get().empty()) {
     // We need to launch TabTip.exe from the location specified under the
     // LocalServer32 key for the {{054AAE20-4BEA-4347-8A35-64A533254A9D}}
     // CLSID.
     // TabTip.exe is typically found at
     // c:\program files\common files\microsoft shared\ink on English Windows.
     // We don't want to launch TabTip.exe from
@@ skipping 145 matching lines @@
 #if defined(_MSC_FULL_VER)
   #pragma message(__PPOUT__(_MSC_FULL_VER))
 #endif
 
 #pragma message("Visual Studio 2012 x86 must be updated to at least Update 1")
 #error Must install Update 1 to Visual Studio 2012.
 #endif
 
 #endif  // _MSC_VER