Merge lp:~azzar1/unity/hud-text-5.0 into lp:unity/5.0

[Andrea Azzarone]

Backports branch lp:~andyrock/unity/hud-text.

Copy pasted from https://code.launchpad.net/~andyrock/unity/hud-text/+merge/107986

== Problem ==
Copy pasted from https://code.launchpad.net/~thumper/unity/hud-text/+merge/106550

The initial work on the hud had the results from the hud service being shown directly. The hud service uses the <b> tag to indicate search matches.

The design, https://launchpadlibrarian.net/93965245/Pangolin_matrix_v1-3e.png had transparent text for not match parts.

== Fix ==
I could add the ability to render text with with transparency in dash::Style but I preferred to use a nux::Layout + nux::StaticCairoText because later we'll need a nux::Layout to show for example shortcuts, etc.

== Test ==
./tests/test-gtest-xless --gtest_filter=TestHudPrivate*
./test/test-getst --gtest_filter=TestHudButton*

== Screenshot ==
http://ubuntuone.com/1Yt5VlOwibqJWbM1P98Hn7

[Tim Penhey (thumper)]

Thanks.

review: Approve

=== modified file 'plugins/unityshell/src/HudButton.cpp'
--- plugins/unityshell/src/HudButton.cpp	2012-03-01 16:14:19 +0000
+++ plugins/unityshell/src/HudButton.cpp	2012-05-31 09:10:24 +0000
@@ -26,6 +26,7 @@
 #include <gtk/gtk.h>
 
 #include <Nux/Nux.h>
+#include <Nux/HLayout.h>
 #include <NuxCore/Logger.h>
 #include <NuxImage/CairoGraphics.h>
 #include <NuxGraphics/NuxGraphics.h>
@@ -33,12 +34,17 @@
 #include <UnityCore/Variant.h>
 
 #include "DashStyle.h"
+#include "StaticCairoText.h"
 
 #include "HudButton.h"
+#include "HudPrivate.h"
 
 namespace
 {
 nux::logging::Logger logger("unity.hud.HudButton");
+
+const int hlayout_left_padding = 46;
+const char* const button_font = "Ubuntu 13"; // 17px = 13
 }
 
 namespace unity
@@ -46,44 +52,15 @@
 namespace hud
 {
 
-
-HudButton::HudButton (nux::TextureArea *image, NUX_FILE_LINE_DECL)
-    : nux::Button (image, NUX_FILE_LINE_PARAM)
-    , is_rounded(false)
-    , is_focused_(false)
-{
-  Init();
-}
-
-HudButton::HudButton (const std::string label_, NUX_FILE_LINE_DECL)
-    : nux::Button (NUX_FILE_LINE_PARAM)
-    , is_rounded(false)
-    , is_focused_(false)
-{
-  Init();
-}
-
-HudButton::HudButton (const std::string label_, nux::TextureArea *image, NUX_FILE_LINE_DECL)
-    : nux::Button (image, NUX_FILE_LINE_PARAM)
-    , is_rounded(false)
-    , is_focused_(false)
-{
-  Init();
-}
-
 HudButton::HudButton (NUX_FILE_LINE_DECL)
     : nux::Button (NUX_FILE_LINE_PARAM)
     , is_rounded(false)
     , is_focused_(false)
 {
-  Init();
-}
-
-HudButton::~HudButton() {
-}
-
-void HudButton::Init()
-{
+  hlayout_ = new nux::HLayout(NUX_TRACKER_LOCATION);
+  hlayout_->SetLeftAndRightPadding(hlayout_left_padding, -1);
+  SetLayout(hlayout_);
+
   InitTheme();
   key_nav_focus_change.connect([this](nux::Area *area, bool recieving, nux::KeyNavDirection direction)
   {
@@ -96,6 +73,9 @@
   });
 }
 
+HudButton::~HudButton() {
+}
+
 void HudButton::InitTheme()
 {
   is_rounded.changed.connect([&] (bool rounded)
@@ -119,9 +99,9 @@
 
 void HudButton::RedrawTheme(nux::Geometry const& geom, cairo_t* cr, nux::ButtonVisualState faked_state)
 {
-  dash::Style::Instance().SquareButton(cr, faked_state, label_,
-                                           is_rounded, 17,
-                                           dash::Alignment::LEFT, true);
+  dash::Style::Instance().SquareButton(cr, faked_state, "",
+                                       is_rounded, 17,
+                                       dash::Alignment::LEFT, true);
 }
 
 bool HudButton::AcceptKeyNavFocus()
@@ -191,18 +171,27 @@
   GfxContext.GetRenderStates().SetBlend(alpha, src, dest);
 }
 
-void HudButton::DrawContent(nux::GraphicsEngine& GfxContext, bool force_draw) {
-}
-
-void HudButton::PostDraw(nux::GraphicsEngine& GfxContext, bool force_draw) {
-  nux::Button::PostDraw(GfxContext, force_draw);
+void HudButton::DrawContent(nux::GraphicsEngine& GfxContext, bool force_draw)
+{
+  if (IsFullRedraw())
+    hlayout_->ProcessDraw(GfxContext, force_draw);
 }
 
 void HudButton::SetQuery(Query::Ptr query)
 {
   query_ = query;
-  label_ = query->formatted_text;
   label = query->formatted_text;
+
+  auto items(impl::RefactorText(label()));
+
+  hlayout_->Clear();
+  for (auto item : items)
+  {
+    nux::StaticCairoText* text = new nux::StaticCairoText(item.first.c_str());
+    text->SetTextColor(nux::Color(1.0f, 1.0f, 1.0f, item.second ? 1.0f : 0.5f));
+    text->SetFont(button_font);
+    hlayout_->AddView(text, 0, nux::MINOR_POSITION_CENTER, nux::MINOR_SIZE_FULL);
+  }
 }
 
 Query::Ptr HudButton::GetQuery()
@@ -219,8 +208,8 @@
 void HudButton::AddProperties(GVariantBuilder* builder)
 {
   variant::BuilderWrapper(builder)
-    .add("label", label_);
+    .add("label", label());
 }
 
-}
-}
+} // namespace hud
+} // namespace unity

=== modified file 'plugins/unityshell/src/HudButton.h'
--- plugins/unityshell/src/HudButton.h	2012-02-12 17:46:48 +0000
+++ plugins/unityshell/src/HudButton.h	2012-05-31 09:10:24 +0000
@@ -29,18 +29,23 @@
 #include <Nux/Button.h>
 #include <Nux/TextureArea.h>
 #include <UnityCore/Hud.h>
+
 #include "Introspectable.h"
 
-namespace unity {
-namespace hud {
+namespace nux { class HLayout; }
+
+namespace unity
+{
+namespace hud
+{
+
 class HudButton : public nux::Button, public unity::debug::Introspectable 
 {
   typedef nux::ObjectPtr<nux::BaseTexture> BaseTexturePtr;
+  typedef std::unique_ptr<nux::CairoWrapper> NuxCairoPtr;
 public:
   typedef nux::ObjectPtr<HudButton> Ptr;
-  HudButton (nux::TextureArea *image, NUX_FILE_LINE_PROTO);
-  HudButton (const std::string label, NUX_FILE_LINE_PROTO);
-  HudButton (const std::string label, nux::TextureArea *image, NUX_FILE_LINE_PROTO);
+
   HudButton (NUX_FILE_LINE_PROTO);
   virtual ~HudButton();
   
@@ -51,32 +56,29 @@
   nux::Property<std::string> hint;
   nux::Property<bool> is_rounded;
   nux::Property<bool> fake_focused;
+
 protected:
-
   virtual bool AcceptKeyNavFocus();
   virtual long ComputeContentSize();
   virtual void Draw(nux::GraphicsEngine& GfxContext, bool force_draw);
   virtual void DrawContent(nux::GraphicsEngine& GfxContext, bool force_draw);
-  virtual void PostDraw(nux::GraphicsEngine& GfxContext, bool force_draw);
 
   std::string GetName() const;
   void AddProperties(GVariantBuilder* builder);
- 
-  void Init();
-  void InitTheme ();
+
+  void InitTheme();
   void RedrawTheme(nux::Geometry const& geom, cairo_t* cr, nux::ButtonVisualState faked_state);
-  typedef std::unique_ptr<nux::CairoWrapper> NuxCairoPtr;
-
-  NuxCairoPtr prelight_;
-  NuxCairoPtr active_;
-  NuxCairoPtr normal_;
 
 private:
-  std::string label_;
-
   Query::Ptr query_;
   nux::Geometry cached_geometry_;
   bool is_focused_;
+
+  NuxCairoPtr prelight_;
+  NuxCairoPtr active_;
+  NuxCairoPtr normal_;
+
+  nux::HLayout* hlayout_;
 };
 }
 }

=== added file 'plugins/unityshell/src/HudPrivate.cpp'
--- plugins/unityshell/src/HudPrivate.cpp	1970-01-01 00:00:00 +0000
+++ plugins/unityshell/src/HudPrivate.cpp	2012-05-31 09:10:24 +0000
@@ -0,0 +1,78 @@
+/*
+ * Copyright 2012 Canonical Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License version 3, as
+ * published by the  Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranties of
+ * MERCHANTABILITY, SATISFACTORY QUALITY or FITNESS FOR A PARTICULAR
+ * PURPOSE.  See the applicable version of the GNU Lesser General Public
+ * License for more details.
+ *
+ * You should have received a copy of both the GNU Lesser General Public
+ * License version 3 along with this program.  If not, see
+ * <http://www.gnu.org/licenses/>
+ *
+ * Authored by: Andrea Azzarone <[e-mail]>
+ *              Tim Penhey <[e-mail]>
+ *
+ */
+
+#include "HudPrivate.h"
+
+namespace unity
+{
+namespace hud
+{
+namespace impl
+{
+
+std::vector<std::pair<std::string, bool>> RefactorText(std::string const& text)
+{
+  std::vector<std::pair<std::string, bool>> ret;
+
+  static const std::string bold_start("<b>");
+  static const std::string bold_end("</b>");
+
+  std::string::size_type last = 0;
+  std::string::size_type len = text.length();
+  std::string::size_type pos = text.find(bold_start);
+
+  while (pos != std::string::npos)
+  {
+    if (pos != last)
+    {
+      ret.push_back(std::pair<std::string, bool>(text.substr(last, pos - last), false));
+    }
+
+    // Look for the end
+    pos += 3; // // to skip the "<b>"
+    std::string::size_type end_pos = text.find(bold_end, pos);
+    // We hope we find it, if we don't, just output everything...
+    if (end_pos != std::string::npos)
+    {
+      ret.push_back(std::pair<std::string, bool>(text.substr(pos, end_pos - pos), true));
+      last = end_pos + 4; // the length of "</b>"
+      pos = text.find(bold_start, last);
+    }
+    else
+    {
+      ret.push_back(std::pair<std::string, bool>(text.substr(pos), true));
+      pos = std::string::npos;
+      last = len;
+    }
+  }
+
+  if (last < len)
+  {
+    ret.push_back(std::pair<std::string, bool>(text.substr(last), false));
+  }
+
+  return ret;
+}
+
+} // namespace unity
+} // namespace hud
+} // namespace impl

=== added file 'plugins/unityshell/src/HudPrivate.h'
--- plugins/unityshell/src/HudPrivate.h	1970-01-01 00:00:00 +0000
+++ plugins/unityshell/src/HudPrivate.h	2012-05-31 09:10:24 +0000
@@ -0,0 +1,42 @@
+/*
+ * Copyright 2012 Canonical Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License version 3, as
+ * published by the  Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranties of
+ * MERCHANTABILITY, SATISFACTORY QUALITY or FITNESS FOR A PARTICULAR
+ * PURPOSE.  See the applicable version of the GNU Lesser General Public
+ * License for more details.
+ *
+ * You should have received a copy of both the GNU Lesser General Public
+ * License version 3 along with this program.  If not, see
+ * <http://www.gnu.org/licenses/>
+ *
+ * Authored by: Andrea Azzarone <[e-mail]>
+ *
+ */
+
+#ifndef UNITYSHELL_HUD_PRIVATE_H
+#define UNITYSHELL_HUD_PRIVATE_H
+
+#include <string>
+#include <utility>
+#include <vector>
+
+namespace unity
+{
+namespace hud
+{
+namespace impl
+{
+
+std::vector<std::pair<std::string, bool>> RefactorText(std::string const& text);
+
+} // namespace impl
+} // namespace hud
+} // namespace unity
+
+#endif // UNITYSHELL_HUD_PRIVATE_H

=== modified file 'plugins/unityshell/src/StaticCairoText.cpp'
--- plugins/unityshell/src/StaticCairoText.cpp	2012-04-14 08:48:36 +0000
+++ plugins/unityshell/src/StaticCairoText.cpp	2012-05-31 09:10:24 +0000
@@ -245,6 +245,12 @@
   return _text;
 }
 
+nux::Color StaticCairoText::GetTextColor() const
+{
+  return _textColor;
+}
+
+
 void
 StaticCairoText::SetTextColor(Color const& textColor)
 {

=== modified file 'plugins/unityshell/src/StaticCairoText.h'
--- plugins/unityshell/src/StaticCairoText.h	2012-03-14 06:24:18 +0000
+++ plugins/unityshell/src/StaticCairoText.h	2012-05-31 09:10:24 +0000
@@ -86,6 +86,7 @@
   void SetLines(int maximum_lines);
 
   std::string GetText() const;
+  nux::Color GetTextColor() const;
 
   int  GetLineCount();
   int GetBaseline() const;

=== modified file 'tests/CMakeLists.txt'
--- tests/CMakeLists.txt	2012-05-23 13:11:59 +0000
+++ tests/CMakeLists.txt	2012-05-31 09:10:24 +0000
@@ -143,6 +143,7 @@
                  test_grabhandle.cpp
                  test_unityshell_private.cpp
 		 test_showdesktop_handler.cpp
+                 test_hud_private.cpp
                  ${UNITY_SRC}/AbstractLauncherIcon.cpp
                  ${UNITY_SRC}/AbstractShortcutHint.h
                  ${UNITY_SRC}/Animator.cpp
@@ -151,6 +152,7 @@
                  ${UNITY_SRC}/FavoriteStore.cpp
                  ${UNITY_SRC}/FavoriteStoreGSettings.cpp
                  ${UNITY_SRC}/IconTextureSource.cpp
+                 ${UNITY_SRC}/HudPrivate.cpp
                  ${UNITY_SRC}/LauncherModel.cpp
                  ${UNITY_SRC}/LauncherEntryRemote.cpp
                  ${UNITY_SRC}/FavoriteStorePrivate.cpp
@@ -194,6 +196,7 @@
 
 # Tests that require X
   add_executable(test-gtest
+                 test_hud_button.cpp
                  test_dashview_impl.cpp
                  test_texture_cache.cpp
                  test_main.cpp
@@ -207,6 +210,8 @@
                  ${UNITY_SRC}/AbstractPlacesGroup.cpp
                  ${UNITY_SRC}/BackgroundEffectHelper.cpp
                  ${UNITY_SRC}/CairoBaseWindow.cpp
+                 ${UNITY_SRC}/DashSettings.cpp
+                 ${UNITY_SRC}/DashStyle.cpp
                  ${UNITY_SRC}/DashViewPrivate.cpp
                  ${UNITY_SRC}/Decaymulator.cpp
                  ${UNITY_SRC}/DNDCollectionWindow.cpp
@@ -216,6 +221,8 @@
                  ${UNITY_SRC}/IconRenderer.cpp
                  ${UNITY_SRC}/IconTextureSource.cpp
                  ${UNITY_SRC}/Introspectable.cpp
+                 ${UNITY_SRC}/HudButton.cpp
+                 ${UNITY_SRC}/HudPrivate.cpp
                  ${UNITY_SRC}/LayoutSystem.cpp
                  ${UNITY_SRC}/Launcher.cpp
                  ${UNITY_SRC}/LauncherDragWindow.cpp
@@ -224,6 +231,7 @@
                  ${UNITY_SRC}/LauncherHoverMachine.cpp
                  ${UNITY_SRC}/LauncherIcon.cpp
                  ${UNITY_SRC}/LauncherModel.cpp
+                 ${UNITY_SRC}/JSONParser.cpp
                  ${UNITY_SRC}/SimpleLauncherIcon.cpp
                  ${UNITY_SRC}/SingleMonitorLauncherIcon.cpp
                  ${UNITY_SRC}/LensViewPrivate.cpp

=== added file 'tests/test_hud_button.cpp'
--- tests/test_hud_button.cpp	1970-01-01 00:00:00 +0000
+++ tests/test_hud_button.cpp	2012-05-31 09:10:24 +0000
@@ -0,0 +1,73 @@
+/*
+ * Copyright 2012 Canonical Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License version 3, as
+ * published by the  Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranties of
+ * MERCHANTABILITY, SATISFACTORY QUALITY or FITNESS FOR A PARTICULAR
+ * PURPOSE.  See the applicable version of the GNU Lesser General Public
+ * License for more details.
+ *
+ * You should have received a copy of both the GNU Lesser General Public
+ * License version 3 along with this program.  If not, see
+ * <http://www.gnu.org/licenses/>
+ *
+ * Authored by: Andrea Azzarone <[e-mail]>
+ *
+ */
+
+#include <gtest/gtest.h>
+
+#include <Nux/Nux.h>
+#include <Nux/Layout.h>
+#include <UnityCore/Hud.h>
+
+#include "HudButton.h"
+#include "DashStyle.h"
+#include "StaticCairoText.h"
+#include "DashSettings.h"
+
+using namespace unity;
+
+namespace
+{
+
+TEST(TestHudButton, TestLabelOpacity)
+{
+  dash::Settings unity_settings;
+  dash::Style dash_style;
+  nux::ObjectPtr<hud::HudButton> button(new hud::HudButton());
+  nux::Layout* layout = button->GetLayout();
+
+  ASSERT_NE(layout, nullptr);
+  ASSERT_EQ(layout->GetChildren().size(), 0);
+
+  hud::Query::Ptr query(new hud::Query("<b>Op</b> Fi<b>le</b>", "","", "", "", NULL));
+  button->SetQuery(query);
+
+  auto children(layout->GetChildren());
+  ASSERT_EQ(children.size(), 3);
+
+  auto it = children.begin();
+  nux::StaticCairoText* label = dynamic_cast<nux::StaticCairoText*>(*it);
+  ASSERT_NE(label, nullptr);
+  EXPECT_EQ(label->GetText(), "Op");
+  EXPECT_EQ(label->GetTextColor().alpha, 1.0f);
+
+  it++;
+  label = dynamic_cast<nux::StaticCairoText*>(*it);
+  ASSERT_NE(label, nullptr);
+  EXPECT_EQ(label->GetText(), " Fi");
+  EXPECT_EQ(label->GetTextColor().alpha, 0.5f);
+
+  it++;
+  label = dynamic_cast<nux::StaticCairoText*>(*it);
+  ASSERT_NE(label, nullptr);
+  EXPECT_EQ(label->GetText(), "le");
+  EXPECT_EQ(label->GetTextColor().alpha, 1.0f);
+}
+
+}

=== added file 'tests/test_hud_private.cpp'
--- tests/test_hud_private.cpp	1970-01-01 00:00:00 +0000
+++ tests/test_hud_private.cpp	2012-05-31 09:10:24 +0000
@@ -0,0 +1,77 @@
+/*
+ * Copyright 2012 Canonical Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License version 3, as
+ * published by the  Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranties of
+ * MERCHANTABILITY, SATISFACTORY QUALITY or FITNESS FOR A PARTICULAR
+ * PURPOSE.  See the applicable version of the GNU Lesser General Public
+ * License for more details.
+ *
+ * You should have received a copy of both the GNU Lesser General Public
+ * License version 3 along with this program.  If not, see
+ * <http://www.gnu.org/licenses/>
+ *
+ * Authored by: Andrea Azzarone <[e-mail]>
+ *
+ */
+
+#include <gtest/gtest.h>
+
+#include "HudPrivate.h"
+using namespace unity::hud;
+
+namespace
+{
+
+TEST(TestHudPrivate, RefactorTextEmpty)
+{
+  std::vector<std::pair<std::string, bool>> temp;
+
+  temp = impl::RefactorText("");
+  ASSERT_EQ(temp.size(), 0);
+
+  temp = impl::RefactorText("Test");
+  ASSERT_EQ(temp.size(), 1);
+  EXPECT_EQ(temp[0].first, "Test");
+  EXPECT_EQ(temp[0].second, false); // True means "Full opacity", false "Half opacity"
+
+  temp = impl::RefactorText("<b>Test</b>");
+  ASSERT_EQ(temp.size(), 1);
+  EXPECT_EQ(temp[0].first, "Test");
+  EXPECT_EQ(temp[0].second, true);
+
+  temp = impl::RefactorText("Hello > <b>Test</b> World");
+  ASSERT_EQ(temp.size(), 3);
+  EXPECT_EQ(temp[0].first, "Hello > ");
+  EXPECT_EQ(temp[0].second, false);
+  EXPECT_EQ(temp[1].first, "Test");
+  EXPECT_EQ(temp[1].second, true);
+  EXPECT_EQ(temp[2].first, " World");
+  EXPECT_EQ(temp[2].second, false);
+
+  temp = impl::RefactorText("Open <b>Fi</b>le <b>Wit</b>h");
+  ASSERT_EQ(temp.size(), 5);
+  EXPECT_EQ(temp[0].first, "Open ");
+  EXPECT_EQ(temp[0].second, false);
+  EXPECT_EQ(temp[1].first, "Fi");
+  EXPECT_EQ(temp[1].second, true);
+  EXPECT_EQ(temp[2].first, "le ");
+  EXPECT_EQ(temp[2].second, false);
+  EXPECT_EQ(temp[3].first, "Wit");
+  EXPECT_EQ(temp[3].second, true);
+  EXPECT_EQ(temp[4].first, "h");
+  EXPECT_EQ(temp[4].second, false);
+
+  temp = impl::RefactorText("Open <b>File With");
+  ASSERT_EQ(temp.size(), 2);
+  EXPECT_EQ(temp[0].first, "Open ");
+  EXPECT_EQ(temp[0].second, false);
+  EXPECT_EQ(temp[1].first, "File With");
+  EXPECT_EQ(temp[1].second, true);
+}
+
+}