Merge lp:~brandontschaefer/unity/lockscreen-caps-lock-detector into lp:unity

[Brandon Schaefer]

When we detect caps lock, or caps lock is pressed, render a warning icon to show its on.

When we detect caps lock, or caps lock is pressed, render a warning icon to show its on.

[Marco Trevisan (Treviño) (3v1n0)]

Cool, looks good to me!

review: Approve

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:3751
http://jenkins.qa.ubuntu.com/job/unity-ci/860/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-trusty-amd64-ci/396
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-trusty-armhf-ci/392
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-trusty-i386-ci/394

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-ci/860/rebuild

review: Approve (continuous-integration)

=== modified file 'lockscreen/LockScreenAbstractShield.h'
--- lockscreen/LockScreenAbstractShield.h	2014-03-24 21:36:55 +0000
+++ lockscreen/LockScreenAbstractShield.h	2014-04-09 17:10:19 +0000
@@ -47,6 +47,7 @@
 
   using MockableBaseWindow::RemoveLayout;
   virtual bool IsIndicatorOpen() const = 0;
+  virtual void CheckCapsLockPrompt() = 0;
 
   sigc::signal<void, int, int> grab_motion;
 

=== modified file 'lockscreen/LockScreenController.cpp'
--- lockscreen/LockScreenController.cpp	2014-03-24 21:36:55 +0000
+++ lockscreen/LockScreenController.cpp	2014-04-09 17:10:19 +0000
@@ -101,6 +101,7 @@
 
       primary_shield_->primary = false;
       primary_shield_ = shield;
+      primary_shield_->CheckCapsLockPrompt();
       shield->primary = true;
       auto move_cb = sigc::mem_fun(this, &Controller::OnPrimaryShieldMotion);
       motion_connection_ = shield->grab_motion.connect(move_cb);

=== modified file 'lockscreen/LockScreenShield.cpp'
--- lockscreen/LockScreenShield.cpp	2014-03-07 19:35:46 +0000
+++ lockscreen/LockScreenShield.cpp	2014-04-09 17:10:19 +0000
@@ -86,6 +86,12 @@
   }
 }
 
+void Shield::CheckCapsLockPrompt()
+{
+  if (prompt_view_)
+    prompt_view_->CheckIfCapsLockOn();
+}
+
 void Shield::ShowPrimaryView()
 {
   GrabPointer();

=== modified file 'lockscreen/LockScreenShield.h'
--- lockscreen/LockScreenShield.h	2014-03-07 19:17:35 +0000
+++ lockscreen/LockScreenShield.h	2014-04-09 17:10:19 +0000
@@ -38,7 +38,8 @@
 public:
   Shield(session::Manager::Ptr const&, indicator::Indicators::Ptr const&, int monitor, bool is_primary);
 
-  bool IsIndicatorOpen() const;
+  bool IsIndicatorOpen() const override;
+  void CheckCapsLockPrompt() override;
 
 protected:
   bool AcceptKeyNavFocus() override;
@@ -64,4 +65,4 @@
 }
 }
 
-#endif
\ No newline at end of file
+#endif

=== modified file 'lockscreen/UserPromptView.cpp'
--- lockscreen/UserPromptView.cpp	2014-03-26 18:52:13 +0000
+++ lockscreen/UserPromptView.cpp	2014-04-09 17:10:19 +0000
@@ -21,9 +21,12 @@
 
 #include <boost/algorithm/string/trim.hpp>
 #include <Nux/VLayout.h>
+#include <X11/XKBlib.h>
 
 #include "LockScreenSettings.h"
 #include "unity-shared/CairoTexture.h"
+#include "unity-shared/DashStyle.h"
+#include "unity-shared/PreviewStyle.h"
 #include "unity-shared/TextInput.h"
 #include "unity-shared/StaticCairoText.h"
 #include "unity-shared/RawPixel.h"
@@ -34,11 +37,12 @@
 {
 namespace
 {
-const RawPixel PADDING = 10_em;
-const RawPixel LAYOUT_MARGIN = 10_em;
-const RawPixel MSG_LAYOUT_MARGIN = 15_em;
+const RawPixel PADDING              = 10_em;
+const RawPixel LAYOUT_MARGIN        = 10_em;
+const RawPixel MSG_LAYOUT_MARGIN    = 15_em;
 const RawPixel PROMPT_LAYOUT_MARGIN = 5_em;
-const int PROMPT_FONT_SIZE = 13;
+
+const int PROMPT_FONT_SIZE     = 13;
 
 nux::AbstractPaintLayer* CrateBackgroundLayer(int width, int height)
 {
@@ -74,6 +78,28 @@
                                 rop));
 }
 
+nux::AbstractPaintLayer* CreateWarningLayer(nux::BaseTexture* texture)
+{
+  // Create the texture layer
+  nux::TexCoordXForm texxform;
+
+  texxform.SetTexCoordType(nux::TexCoordXForm::OFFSET_COORD);
+  texxform.SetWrap(nux::TEXWRAP_REPEAT, nux::TEXWRAP_REPEAT);
+  texxform.min_filter = nux::TEXFILTER_LINEAR;
+  texxform.mag_filter = nux::TEXFILTER_LINEAR;
+
+  nux::ROPConfig rop;
+  rop.Blend = true;
+  rop.SrcBlend = GL_ONE;
+  rop.DstBlend = GL_ONE_MINUS_SRC_ALPHA;
+
+  return (new nux::TextureLayer(texture->GetDeviceTexture(),
+                                texxform,
+                                nux::color::White,
+                                true,
+                                rop));
+}
+
 std::string SanitizeMessage(std::string const& message)
 {
   std::string msg = boost::algorithm::trim_copy(message);
@@ -98,6 +124,7 @@
 UserPromptView::UserPromptView(session::Manager::Ptr const& session_manager)
   : nux::View(NUX_TRACKER_LOCATION)
   , session_manager_(session_manager)
+  , caps_lock_on_(false)
 {
   user_authenticator_.echo_on_requested.connect([this](std::string const& message, PromiseAuthCodePtr const& promise){
     AddPrompt(message, /* visible */ true, promise);
@@ -119,10 +146,32 @@
     ResetLayout();
   });
 
+  dash::previews::Style& preview_style = dash::previews::Style::Instance();
+
+  warning_ = preview_style.GetWarningIcon();
   ResetLayout();
 
   user_authenticator_.AuthenticateStart(session_manager_->UserName(),
                                         sigc::mem_fun(this, &UserPromptView::AuthenticationCb));
+
+  // When we get to HiDPI changes here, we will need to update this width
+  dash::Style& style = dash::Style::Instance();
+  spin_icon_width_ = style.GetSearchSpinIcon()->GetWidth();
+
+  CheckIfCapsLockOn();
+}
+
+void UserPromptView::CheckIfCapsLockOn()
+{
+  Display *dpy = nux::GetGraphicsDisplay()->GetX11Display();
+  unsigned int state = 0;
+  XkbGetIndicatorState(dpy, XkbUseCoreKbd, &state);
+
+  // Caps is on 0x1, couldn't find any #define in /usr/include/X11
+  if ((state & 0x1) == 1)
+    caps_lock_on_ = true;
+  else
+    caps_lock_on_ = false;
 }
 
 bool UserPromptView::InspectKeyEvent(unsigned int eventType, unsigned int key_sym, const char* character)
@@ -211,6 +260,15 @@
     nux::GetPainter().PushLayer(graphics_engine, geo, bg_layer_.get());
   }
 
+  if (caps_lock_on_)
+  {
+    for (auto const& text_entry : focus_queue_)
+      PaintWarningIcon(graphics_engine, text_entry->GetGeometry());
+
+    if (focus_queue_.empty())
+      PaintWarningIcon(graphics_engine, cached_focused_geo_);
+  }
+
   if (GetLayout())
     GetLayout()->ProcessDraw(graphics_engine, force_draw);
 
@@ -220,6 +278,19 @@
   graphics_engine.PopClippingRectangle();
 }
 
+void UserPromptView::PaintWarningIcon(nux::GraphicsEngine& graphics_engine, nux::Geometry const& geo)
+{
+  nux::Geometry warning_geo = {geo.x + geo.width - GetWarningIconOffset(),
+                               geo.y, warning_->GetWidth(), warning_->GetHeight()};
+
+  nux::GetPainter().PushLayer(graphics_engine, warning_geo, CreateWarningLayer(warning_));
+}
+
+int UserPromptView::GetWarningIconOffset()
+{
+  return warning_->GetWidth() + spin_icon_width_;
+}
+
 nux::View* UserPromptView::focus_view()
 {
   if (focus_queue_.empty())
@@ -232,6 +303,26 @@
   return focus_queue_.front();
 }
 
+void UserPromptView::ToggleCapsLockBool()
+{
+  caps_lock_on_ = !caps_lock_on_;
+  QueueDraw();
+}
+
+void UserPromptView::RecvKeyUp(unsigned keysym,
+                               unsigned long keycode,
+                               unsigned long state)
+{
+  if (!caps_lock_on_ && keysym == NUX_VK_CAPITAL)
+  {
+    ToggleCapsLockBool();
+  }
+  else if (caps_lock_on_ && keysym == NUX_VK_CAPITAL)
+  {
+    ToggleCapsLockBool();
+  }
+}
+
 void UserPromptView::AddPrompt(std::string const& message, bool visible, PromiseAuthCodePtr const& promise)
 {
   auto* text_input = new unity::TextInput();
@@ -243,11 +334,15 @@
   text_entry->SetPasswordChar("•");
   text_entry->SetToggleCursorVisibilityOnKeyFocus(true);
 
+  text_entry->key_up.connect(sigc::mem_fun(this, &UserPromptView::RecvKeyUp));
+
   text_input->SetMinimumHeight(Settings::GRID_SIZE);
   text_input->SetMaximumHeight(Settings::GRID_SIZE);
   prompt_layout_->AddView(text_input, 1);
   focus_queue_.push_back(text_entry);
 
+  CheckIfCapsLockOn();
+
   // Don't remove it, it helps with a11y.
   if (focus_queue_.size() == 1)
     nux::GetWindowCompositor().SetKeyFocusArea(text_entry);
@@ -261,6 +356,7 @@
 
     focus_queue_.pop_front();
     auto* text_entry = text_input->text_entry();
+    cached_focused_geo_ = text_entry->GetGeometry();
     text_entry->SetInputEventSensitivity(false);
     QueueRelayout();
     QueueDraw();

=== modified file 'lockscreen/UserPromptView.h'
--- lockscreen/UserPromptView.h	2014-03-25 18:39:24 +0000
+++ lockscreen/UserPromptView.h	2014-04-09 17:10:19 +0000
@@ -29,7 +29,6 @@
 
 #include "UserAuthenticatorPam.h"
 #include "unity-shared/IMTextEntry.h"
-#include "unity-shared/SearchBarSpinner.h"
 
 namespace nux
 {
@@ -57,6 +56,8 @@
   void AddMessage(std::string const& message, nux::Color const& color);
   void AuthenticationCb(bool authenticated);
 
+  void CheckIfCapsLockOn();
+
 protected:
   void Draw(nux::GraphicsEngine& graphics_engine, bool force_draw) override;
   void DrawContent(nux::GraphicsEngine& graphics_engine, bool force_draw) override;
@@ -65,6 +66,12 @@
   void ResetLayout();
 
   bool InspectKeyEvent(unsigned int eventType, unsigned int key_sym, const char* character);
+  void RecvKeyUp(unsigned int, unsigned long, unsigned long);
+
+  void PaintWarningIcon(nux::GraphicsEngine& graphics_engine, nux::Geometry const& geo);
+  void ToggleCapsLockBool();
+
+  int GetWarningIconOffset();
 
   session::Manager::Ptr session_manager_;
   UserAuthenticatorPam user_authenticator_;
@@ -75,6 +82,12 @@
   StaticCairoText* error_;
   StaticCairoText* invalid_login_;
   std::deque<IMTextEntry*> focus_queue_;
+
+  nux::BaseTexture* warning_;
+  nux::Geometry cached_focused_geo_;
+
+  bool caps_lock_on_;
+  int spin_icon_width_;
 };
 
 }

=== modified file 'tests/test_lockscreen_controller.cpp'
--- tests/test_lockscreen_controller.cpp	2014-03-21 23:08:47 +0000
+++ tests/test_lockscreen_controller.cpp	2014-04-09 17:10:19 +0000
@@ -68,6 +68,7 @@
   {}
 
   MOCK_CONST_METHOD0(IsIndicatorOpen, bool());
+  MOCK_METHOD0(CheckCapsLockPrompt, void());
 };
 
 struct ShieldFactoryMock : ShieldFactoryInterface

=== modified file 'unity-shared/CompizUtils.cpp'
--- unity-shared/CompizUtils.cpp	2014-03-29 02:10:18 +0000
+++ unity-shared/CompizUtils.cpp	2014-04-09 17:10:19 +0000
@@ -180,8 +180,8 @@
   if (win->region().numRects() != 1) // Non rectangular windows
     return false;
 
-  if (win->alpha())
-    return WindowHasMotifDecorations(win);
+  if (win->overrideRedirect() && win->alpha())
+    return false;
 
   return true;
 }
@@ -194,14 +194,6 @@
   if (!IsWindowShadowDecorable(win))
     return false;
 
-  return WindowHasMotifDecorations(win);
-}
-
-bool WindowHasMotifDecorations(CompWindow* win)
-{
-  if (!win)
-    return false;
-
   if (win->overrideRedirect())
     return false;
 

=== modified file 'unity-shared/CompizUtils.h'
--- unity-shared/CompizUtils.h	2014-03-29 02:10:18 +0000
+++ unity-shared/CompizUtils.h	2014-04-09 17:10:19 +0000
@@ -113,7 +113,6 @@
 
 bool IsWindowShadowDecorable(CompWindow*);
 bool IsWindowFullyDecorable(CompWindow*);
-bool WindowHasMotifDecorations(CompWindow*);
 
 } // compiz_utils namespace
 } // unity namespace