Merge lp:~3v1n0/unity/hud-lock-out-monitors-tests into lp:unity

[Marco Trevisan (Treviño)]

HudController: Fixed geometries for single-launcher mode.

And added tests for multimonitor in HUD, with lock-out support.

Added tests for multimonitor in HUD, with lock-out support.

Also fixed the bug #963577 with some HudController and HudView code cleanup and improvements.
The tests now also support the HudLauncherIcon, and I've included some more utility functions to avoid them to fail.

[Gord Allott (gordallott)]

+1, seems good here

review: Approve

[Thomi Richards (thomir-deactivatedaccount)]

Hi,

44 + def is_rect_on_monitor(self, monitor_number, x, y, w, h):
45 + (m_x, m_y, m_w, m_h) = self.get_monitor_geometry(monitor_number)
46 + return (x >= m_x and x + w <= m_x + m_w and y >= m_y and y + h <= m_y + m_h)
47 +

Instead of passing x,y,w & h as separate parameters, just pass 'rect', and make sure it's a tuple in the function:
def is_rect_on_monitor(self, monitor_number, rect):
    """Returns True if `rect` is _entirely_ on the specified monitor, with no overlap"""
    if type(rect) is not tuple:
        raise TypeError("rect must be a tuple.")

...if you want you can also check that monitor_number is a valid integer, and that the tuple values are all ints.

This:

59 + def get_geometry(self):
60 + return (self.x, self.y, self.width, self.height)
61 +

should be a property, like this:

58 + @property
59 + def geometry(self):
60 + return (self.x, self.y, self.width, self.height)
61 +

this:

84 + screen_geometry = ScreenGeometry()
85 + num_monitors = screen_geometry.get_num_monitors()
86 +
87 + if num_monitors == 1:
88 + scenarios = [
89 + ('Single Monitor, Launcher never hide', {'hud_monitor': 0, 'launcher_hide_mode': 0}),
90 + ('Single Monitor, Launcher autohide', {'hud_monitor': 0, 'launcher_hide_mode': 1}),
91 + ]
92 + else:
93 + scenarios = []
94 + for i in range(num_monitors):
95 + scenarios.append(('Monitor %d, Launcher never hide' % (i), {'hud_monitor': i, 'launcher_hide_mode': 0}))
96 + scenarios.append(('Monitor %d, Launcher autohide' % (i), {'hud_monitor': i, 'launcher_hide_mode': 1}))

is kind of ugly. A better way to do it is how we do it in the launcher tests - use a function to generate the scenarios.

The first two changes I mentioned mean that you can rewrite this:

112 + (x, y, w, h) = self.hud.get_geometry()
113 + self.assertTrue(self.screen_geometry.is_rect_on_monitor(self.hud_monitor, x, y, w, h))

like this:

self.assertTrue(self.screen_geometry.is_rect_on_monitor(self.hud_monitor, self.hud.geometry)

The new test:

131 + def test_hud_dont_change_launcher_status(self):

...needs a docstring.

Finally, please use matchers for everything except simple true/false tests, so this:

139 + self.assertEqual(launcher_shows_pre, launcher_shows_post)

becomes:

self.assertThat(launcher_shows_pre, Equals(launcher_shows_post))

Cheers,

review: Needs Fixing

[Thomi Richards (thomir-deactivatedaccount)]

Hi,

There are a few things that need to be fixed:

712 - .add("x", _center[0].x)
713 - .add("y", _center[0].y)
714 - .add("z", _center[0].z)
715 - .add("related-windows", (int)Windows().size())
716 - .add("icon-type", _icon_type)
717 - .add("tooltip-text", tooltip_text())
718 - .add("sort-priority", _sort_priority)
719 - .add("quirk-active", GetQuirk(QUIRK_ACTIVE))
720 - .add("quirk-visible", GetQuirk(QUIRK_VISIBLE))
721 - .add("quirk-urgent", GetQuirk(QUIRK_URGENT))
722 - .add("quirk-running", GetQuirk(QUIRK_RUNNING))
723 - .add("quirk-presented", GetQuirk(QUIRK_PRESENTED));
724 + .add("center_x", _center[0].x)
725 + .add("center_y", _center[0].y)
726 + .add("center_z", _center[0].z)
727 + .add("related_windows", static_cast<unsigned int>(Windows().size()))
728 + .add("icon_type", _icon_type)
729 + .add("tooltip_text", tooltip_text())
730 + .add("sort_priority", _sort_priority)
731 + .add("active", GetQuirk(QUIRK_ACTIVE))
732 + .add("visible", GetQuirk(QUIRK_VISIBLE))
733 + .add("urgent", GetQuirk(QUIRK_URGENT))
734 + .add("running", GetQuirk(QUIRK_RUNNING))
735 + .add("starting", GetQuirk(QUIRK_STARTING))
736 + .add("desaturated", GetQuirk(QUIRK_DESAT))
737 + .add("presented", GetQuirk(QUIRK_PRESENTED));

Hyphens ('-') get translated to underscores ('_') in python automatically. You don't need to do this in the C++ code. It doesn't hurt, but you don't need to do it. More importantly, I don't think renaming 'x', 'y', 'z' to center_x, center_y, and center_z is a good idea. It seems natural to me that the x,y & z properties represent the center of the icon. If you are going to change this, please make sure that all the autopilot tests are updated accordingly.

There's something very wrong with this code:

823 + def is_rect_on_monitor(self, monitor_number, rect):
824 + """Returns True if `rect` is _entirely_ on the specified monitor, with no overlap"""
825 +
826 + if type(rect) is not tuple or len(rect) != 4:
827 + raise TypeError("rect must be a tuple of 4 int elements.")
828 +
829 + (x, y, w, h) = self.get_monitor_geometry(monitor_number)
830 +
831 + (m_x, m_y, m_w, m_h) = self.get_monitor_geometry(monitor_number)
832 + return (x >= m_x and x + w <= m_x + m_w and y >= m_y and y + h <= m_y + m_h)
833 +

...Can you spot it? What exactly is 'rect' used for?

THis property:

910 + @property
911 + def show_embedded_icon(self):

Should be renamed. Either 'showing_embedded_icon' or 'has_embedded_icon', or maybe even 'displaying_embedded_icon'. 'show' is a verb, and shouldn't be used in property names.

I notice that you've changed this code:

970 icons = self.get_children_by_type(SimpleLauncherIcon, desktop_file=desktop_file)
971 - return icons or None
972 + if len(icons):
973 + return icons[0]
974 +
975 + return None
976 +

It used to return a list or none, now it returns an instance or none. Have you updated everywhere that called this method to cope with the change? Further, are you *absolutely* sure that it's impossible for there to be more than one launcher icon with the same desktop file? I'm pretty sure Jason said that this could happen, whcih is why I was returning a list.

This:

1016 +def _make_scenarios():
1017 + screen_geometry = Screen...

review: Needs Fixing

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

Ooops... Myabe I was too tired yesterday night, I figured there was still some debugging code around, sorry.

> Hi,
>
> There are a few things that need to be fixed:
>
> 728 + .add("icon_type", _icon_type)

> Hyphens ('-') get translated to underscores ('_') in python automatically. You
> don't need to do this in the C++ code. It doesn't hurt, but you don't need to
> do it.

Yes, I know, but it also was to keep the same way of naming the introspection parameters.
Plus, there was no need to include the "quirk-" prefix.

> More importantly, I don't think renaming 'x', 'y', 'z' to center_x,
> center_y, and center_z is a good idea. It seems natural to me that the x,y & z
> properties represent the center of the icon.

Yes, maybe you are, but I'm not sure we're all since there was this code:
  target_y = icon.y + (self.icon_size / 2)
  self._mouse.move(target_x, target_y )
  self._mouse.click(button)

Also, considering that everywhere we consider the X / Y points as the coordinates of the top left edge, we should just apply this to icons too.

> If you are going to change this, please make sure that all the autopilot tests
> are updated accordingly.

Yes, I've done that.

> There's something very wrong with this code:
>
> 823 + def is_rect_on_monitor(self, monitor_number, rect):

> ...Can you spot it? What exactly is 'rect' used for?

Yes, sorry it should have been used here:

> 829 + (x, y, w, h) = self.get_monitor_geometry(monitor_number)

Maybe a copy&paste typo.

> THis property:
>
> 910 + @property
> 911 + def show_embedded_icon(self):
>
> Should be renamed. Either 'showing_embedded_icon' or 'has_embedded_icon', or
> maybe even 'displaying_embedded_icon'. 'show' is a verb, and shouldn't be used
> in property names.

Yes, actually I should have removed that, since I don't use it anymore (I used on previous revisions).
I've updated it against new API and new name, btw.

> I notice that you've changed this code:
>
> 970 icons = self.get_children_by_type(SimpleLauncherIcon,
> desktop_file=desktop_file)
> 971 - return icons or None
> 972 + if len(icons):
> 973 + return icons[0]
> 974 +
> 975 + return None
> 976 +
>
> It used to return a list or none, now it returns an instance or none. Have you
> updated everywhere that called this method to cope with the change?

Yes, it was called only once in an HUD test, that I've updated moving to desktop_id

> Further, are you *absolutely* sure that it's impossible for there to be more than one
> launcher icon with the same desktop file? I'm pretty sure Jason said that this
> could happen, whcih is why I was returning a list.

No, it's currently impossible (at least, it shouldn't happen unless we have bamf crashes, but this something to be fixed elsewhere) that two icons have the same desktop file, considering by "desktop file" the .desktop full path.
If it happens, btw it's safe to just take the first icon.
Otherwise we should just rename it into get_icons_by_desktop_file (plural form, I mean) since the current name could lead to some misunderstanding.
Anyway I'm for the only-one-icon way: it simplifies the usage and just works.

> This:
>
> 1016 +...

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

Thomi, the tests now should be done.

[Thomi Richards (thomir-deactivatedaccount)]

Hi,

Almost there :)

Please change this:

81 + .add("desktop_id", glib::String(g_path_get_basename(DesktopFile().c_str())).Str())

to use the methods on the std::string. Something like this (untested, but should work):

std::string desktop_file = DesktopFile();
std::string desktop_id = desktop_file.substr(desktop_file.rfind('/'));

The current code involves way too much casting, uses c functions when we have c++ alternatives, and looks awful.

This docstringsd needs a period at the end:

762 + """Returns True if `rect` is _entirely_ on the specified monitor, with no overlap"""

Please add a blank line between the class docstring at the property:

797 """Proxy object for the hud view child of the controller."""
798 + @property
799 + def geometry(self):

Please add a docstring here:

814 + def get_embedded_icon(self):

...detailing what the possible return values are.

Please rename this:

858 + @property
859 + def center_geometry(self):

since you're not returning the geometry, just a point. Maybe call it "position", "center_position", or "center_point" or something. Also, please add a docstring, since you're returning x, y AND z properties, which might confuse people (who only expect X & Y).

Please revert this change:

966 - scenario_name = ','.join(names)
967 + scenario_name = ', '.join(names)

multiply_scenarios is from testscenarios. I won't want two functions that behave differently.

This should go in AutopilotTestCase:

1034 + screen_geo = ScreenGeometry()

Please add a blank line betweeb the class definition and the setUp method:

1081 +class HudBehaviorTests(HudTestsBase):
1082 + def setUp(self):

This test:

1245 + def test_hud_desaturates_launcher_icons(self):
1246 + """Tests that the launcher icons are desaturates when HUD is open"""
1247 +
1248 + self.reveal_hud()
1249 + sleep(.5)
1250 +
1251 + for icon in self.launcher.model.get_launcher_icons():
1252 + if not isinstance(icon, HudLauncherIcon):
1253 + self.assertTrue(icon.desaturated)

Is good, but we probably want another one that asserts that the hud icon is NOT desaturated.

As discussed on IRC, please change this:

975 + def start_app_c_locale(self, app_name, files=[]):
976 + """Start one of the known apps using the C locale, and kill it on tear down.
977 +
978 + if files is specified, start the application with the specified files.
979 + """
980 + os.putenv("LC_ALL", "C")
981 + self.start_app(app_name, files)
982 + self.addCleanup(os.unsetenv, "LC_ALL")

to something like this (changing the current start_app):

def start_app(self, app_name, files=[], locale=None):
        """Start one of the known apps, and kill it on tear down.

        If files is specified, start the application with the specified files.
        If locale is specified, the locale will be set when the application is launched.
        """
        if locale:
            os.putenv("LC_ALL", "C")
            self.addCleanup(os.unsetenv, "LC_ALL")
            logger.info("Starting application '%s' with files %r in locale %s", app_name, files, locale)
        else:
            logger.info("Starting application '%s' with files %r", app_name, files)
        app = self.KNOWN_APPS[app_name]
        self.bamf....

review: Needs Fixing

[Thomi Richards (thomir-deactivatedaccount)]

+1

review: Approve

=== modified file 'manual-tests/Hud.txt'
--- manual-tests/Hud.txt	2012-03-26 21:04:10 +0000
+++ manual-tests/Hud.txt	2012-03-27 22:51:18 +0000
@@ -49,22 +49,6 @@
   After pressing escape in step three, the text "test" should be removed from the hud search
   After step four, the hud should dismiss itself and not be present.
 
-Hud Reveal Behaviour
----------
-This test ensures that the hud behaves correctly with a locked out launcher
-
-Setup:
-#. Ensure the launchers hide mode is set to "Never"
-
-Action:
-#. Tap Alt
-
-Outcome:
-  The Launcher should stick be locked out.
-  The Launcher icons should be desaturated.
-  The top most Launcher icon should be an icon related the the focused window
-  The BFB should not be present
-
 Alt+Arrow keys not passed to application
 ----------------------------------------
 Tests that Alt+ArrowKey events are correctly passed to the active window

=== modified file 'plugins/unityshell/src/BamfLauncherIcon.cpp'
--- plugins/unityshell/src/BamfLauncherIcon.cpp	2012-03-22 15:14:49 +0000
+++ plugins/unityshell/src/BamfLauncherIcon.cpp	2012-03-27 22:51:18 +0000
@@ -335,7 +335,7 @@
 
 std::vector<Window> BamfLauncherIcon::WindowsOnViewport()
 {
-  WindowFilterMask filter;
+  WindowFilterMask filter = 0;
   filter |= WindowFilter::MAPPED;
   filter |= WindowFilter::USER_VISIBLE;
   filter |= WindowFilter::ON_CURRENT_DESKTOP;
@@ -346,7 +346,7 @@
 
 std::vector<Window> BamfLauncherIcon::WindowsForMonitor(int monitor)
 {
-  WindowFilterMask filter;
+  WindowFilterMask filter = 0;
   filter |= WindowFilter::MAPPED;
   filter |= WindowFilter::USER_VISIBLE;
   filter |= WindowFilter::ON_CURRENT_DESKTOP;
@@ -455,26 +455,18 @@
 
 void BamfLauncherIcon::AddProperties(GVariantBuilder* builder)
 {
-  LauncherIcon::AddProperties(builder);
-
-  GList* children, *l;
-  children = bamf_view_get_children(BAMF_VIEW(_bamf_app.RawPtr()));
-  GVariant* xids[(int) g_list_length(children)];
-
-  int i = 0;
-  for (l = children; l; l = l->next)
-  {
-    if (!BAMF_IS_WINDOW(l->data))
-      continue;
-
-    Window xid = bamf_window_get_xid(static_cast<BamfWindow*>(l->data));
-    xids[i++] = g_variant_new_uint32(xid);
-  }
-  g_list_free(children);
+  SimpleLauncherIcon::AddProperties(builder);
+
+  GVariantBuilder xids_builder;
+  g_variant_builder_init(&xids_builder, G_VARIANT_TYPE ("au"));
+
+  for (auto xid : GetWindows())
+    g_variant_builder_add(&xids_builder, "u", xid);
 
   variant::BuilderWrapper(builder)
-    .add("desktop-file", DesktopFile())
-    .add("xids", g_variant_new_array(G_VARIANT_TYPE_UINT32, xids, i))
+    .add("desktop_file", DesktopFile())
+    .add("desktop_id", GetDesktopID())
+    .add("xids", g_variant_builder_end(&xids_builder))
     .add("sticky", IsSticky());
 }
 
@@ -627,26 +619,8 @@
 
 bool BamfLauncherIcon::Spread(bool current_desktop, int state, bool force)
 {
-  GList* children, *l;
-  children = bamf_view_get_children(BAMF_VIEW(_bamf_app.RawPtr()));
-  WindowManager* wm = WindowManager::Default();
-
-  std::vector<Window> windowList;
-  for (l = children; l; l = l->next)
-  {
-    if (!BAMF_IS_WINDOW(l->data))
-      continue;
-
-    Window xid = bamf_window_get_xid(static_cast<BamfWindow*>(l->data));
-
-    if (!current_desktop || (current_desktop && wm->IsWindowOnCurrentDesktop(xid)))
-    {
-      windowList.push_back(xid);
-    }
-  }
-
-  g_list_free(children);
-  return WindowManager::Default()->ScaleWindowGroup(windowList, state, force);
+  auto windows = GetWindows(current_desktop ? WindowFilter::ON_CURRENT_DESKTOP : 0);
+  return WindowManager::Default()->ScaleWindowGroup(windows, state, force);
 }
 
 void BamfLauncherIcon::EnsureWindowState()
@@ -1049,16 +1023,35 @@
   UpdateIconGeometries(center);
 }
 
+std::string BamfLauncherIcon::GetDesktopID()
+{
+  std::string const& desktop_file = DesktopFile();
+
+  if (!desktop_file.empty())
+  {
+    size_t id_pos = desktop_file.rfind('/');
+
+    if (id_pos != std::string::npos)
+    {
+      size_t id_start = id_pos + 1;
+
+      return (id_start < desktop_file.length()) ? desktop_file.substr(id_start) : "";
+    }
+  }
+
+  return desktop_file;
+}
+
 const gchar* BamfLauncherIcon::GetRemoteUri()
 {
   if (_remote_uri.empty())
   {
     const std::string prefix = "application://";
-    glib::String basename(g_path_get_basename(DesktopFile().c_str()));
+    std::string const& desktop_id = GetDesktopID();
 
-    if (!basename.Str().empty())
+    if (!desktop_id.empty())
     {
-      _remote_uri = prefix + basename.Str();
+      _remote_uri = prefix + desktop_id;
     }
   }
 

=== modified file 'plugins/unityshell/src/BamfLauncherIcon.h'
--- plugins/unityshell/src/BamfLauncherIcon.h	2012-03-22 15:14:49 +0000
+++ plugins/unityshell/src/BamfLauncherIcon.h	2012-03-27 22:51:18 +0000
@@ -113,8 +113,9 @@
 
   bool OwnsWindow(Window w) const;
 
-  std::vector<Window> GetWindows(WindowFilterMask filter, int monitor = -1);
+  std::vector<Window> GetWindows(WindowFilterMask filter = 0, int monitor = -1);
   const std::set<std::string>& GetSupportedTypes();
+  std::string GetDesktopID();
 
 
   glib::Object<BamfApplication> _bamf_app;

=== modified file 'plugins/unityshell/src/HudController.cpp'
--- plugins/unityshell/src/HudController.cpp	2012-03-21 15:30:49 +0000
+++ plugins/unityshell/src/HudController.cpp	2012-03-27 22:51:18 +0000
@@ -40,6 +40,8 @@
 
 Controller::Controller()
   : launcher_width(65)
+  , launcher_locked_out(false)
+  , multiple_launchers(true)
   , hud_service_("com.canonical.hud", "/com/canonical/hud")
   , window_(nullptr)
   , visible_(false)
@@ -47,12 +49,11 @@
   , timeline_id_(0)
   , last_opacity_(0.0f)
   , start_time_(0)
-  , launcher_is_locked_out_(false)
   , view_(nullptr)
   , monitor_index_(0)
 {
   LOG_DEBUG(logger) << "hud startup";
-  SetupRelayoutCallbacks();
+  UScreen::GetDefault()->changed.connect([&] (int, std::vector<nux::Geometry>&) { Relayout(); });
 
   ubus.RegisterInterest(UBUS_HUD_CLOSE_REQUEST, sigc::mem_fun(this, &Controller::OnExternalHideHud));
 
@@ -65,13 +66,13 @@
     gint32 overlay_monitor = 0;
     g_variant_get(data, UBUS_OVERLAY_FORMAT_STRING, &overlay_identity, &can_maximise, &overlay_monitor);
 
-    if (g_strcmp0(overlay_identity, "hud"))
+    if (overlay_identity.Str() != "hud")
     {
       HideHud(true);
     }
   });
 
-  launcher_width.changed.connect([this] (int new_width) { Relayout(); });
+  launcher_width.changed.connect([&] (int new_width) { Relayout(); });
 
   PluginAdapter::Default()->compiz_screen_ungrabbed.connect(sigc::mem_fun(this, &Controller::OnScreenUngrabbed));
 
@@ -120,14 +121,24 @@
   AddChild(view_);
 }
 
-void Controller::SetupRelayoutCallbacks()
-{
-  GdkScreen* screen = gdk_screen_get_default();
-
-  sig_manager_.Add(new glib::Signal<void, GdkScreen*>(screen,
-    "monitors-changed", sigc::mem_fun(this, &Controller::Relayout)));
-  sig_manager_.Add(new glib::Signal<void, GdkScreen*>(screen,
-    "size-changed", sigc::mem_fun(this, &Controller::Relayout)));
+int Controller::GetTargetMonitor()
+{
+  return UScreen::GetDefault()->GetMonitorWithMouse();
+}
+
+bool Controller::IsLockedToLauncher(int monitor)
+{
+  if (launcher_locked_out)
+  {
+    int primary_monitor = UScreen::GetDefault()->GetPrimaryMonitor();
+
+    if (multiple_launchers || (!multiple_launchers && primary_monitor == monitor))
+    {
+      return true;
+    }
+  }
+
+  return false;
 }
 
 void Controller::EnsureHud()
@@ -158,30 +169,31 @@
 
 nux::Geometry Controller::GetIdealWindowGeometry()
 {
-  UScreen *uscreen = UScreen::GetDefault();
-  int primary_monitor = uscreen->GetMonitorWithMouse();
-  auto monitor_geo = uscreen->GetMonitorGeometry(primary_monitor);
+  int target_monitor = GetTargetMonitor();
+  auto monitor_geo = UScreen::GetDefault()->GetMonitorGeometry(target_monitor);
 
-  // We want to cover as much of the screen as possible to grab any mouse events outside
-  // of our window
+  // We want to cover as much of the screen as possible to grab any mouse events
+  // outside of our window
   panel::Style &panel_style = panel::Style::Instance();
   nux::Geometry geo(monitor_geo.x,
-                       monitor_geo.y + panel_style.panel_height,
-                       monitor_geo.width,
-                       monitor_geo.height - panel_style.panel_height);
-  if (launcher_is_locked_out_)
+                    monitor_geo.y + panel_style.panel_height,
+                    monitor_geo.width,
+                    monitor_geo.height - panel_style.panel_height);
+
+  if (IsLockedToLauncher(target_monitor))
   {
     geo.x += launcher_width;
     geo.width -= launcher_width;
   }
+
   return geo;
 }
 
-void Controller::Relayout(GdkScreen*screen)
+void Controller::Relayout()
 {
   EnsureHud();
-  nux::Geometry content_geo = view_->GetGeometry();
-  nux::Geometry geo = GetIdealWindowGeometry();
+  nux::Geometry const& content_geo = view_->GetGeometry();
+  nux::Geometry const& geo = GetIdealWindowGeometry();
 
   window_->SetGeometry(geo);
   layout_->SetMinMaxSize(content_geo.width, content_geo.height);
@@ -190,7 +202,7 @@
 }
 
 void Controller::OnMouseDownOutsideWindow(int x, int y,
-                                              unsigned long bflags, unsigned long kflags)
+                                          unsigned long bflags, unsigned long kflags)
 {
   LOG_DEBUG(logger) << "OnMouseDownOutsideWindow called";
   HideHud();
@@ -234,16 +246,6 @@
   return visible_;
 }
 
-void Controller::SetLauncherIsLockedOut(bool launcher_is_locked_out)
-{
-  launcher_is_locked_out_ = launcher_is_locked_out;
-  if (launcher_is_locked_out_)
-    view_->SetHideIcon(IconHideState::HIDE);
-  else
-    view_->SetHideIcon(IconHideState::SHOW);
-  Relayout();
-}
-
 void Controller::ShowHud()
 {
   PluginAdapter* adaptor = PluginAdapter::Default();
@@ -259,6 +261,15 @@
     return;
   }
 
+  unsigned int target_monitor = GetTargetMonitor();
+
+  if (target_monitor != monitor_index_)
+  {
+    Relayout();
+    monitor_index_ = target_monitor;
+  }
+
+  view_->ShowEmbeddedIcon(!IsLockedToLauncher(monitor_index_));
   view_->AboutToShow();
 
   // we first want to grab the currently active window, luckly we can just ask the jason interface(bamf)
@@ -289,7 +300,6 @@
   // hide the launcher
   GVariant* message_data = g_variant_new("(b)", TRUE);
   ubus.SendMessage(UBUS_LAUNCHER_LOCK_HIDE, message_data);
-  monitor_index_ = UScreen::GetDefault()->GetMonitorWithMouse();
   GVariant* info = g_variant_new(UBUS_OVERLAY_FORMAT_STRING, "hud", FALSE, monitor_index_);
   ubus.SendMessage(UBUS_OVERLAY_SHOWN, info);
 
@@ -410,7 +420,6 @@
   ubus.SendMessage(UBUS_HUD_ICON_CHANGED, g_variant_new_string(query->icon_name.c_str()));
 }
 
-
 void Controller::OnQueriesFinished(Hud::Queries queries)
 {
   view_->SetQueries(queries);
@@ -438,7 +447,10 @@
 void Controller::AddProperties(GVariantBuilder* builder)
 {
   variant::BuilderWrapper(builder)
-    .add("visible", visible_);
+    .add(window_ ? window_->GetGeometry() : nux::Geometry())
+    .add("visible", visible_)
+    .add("hud_monitor", monitor_index_)
+    .add("locked_to_launcher", IsLockedToLauncher(monitor_index_));
 }
 
 

=== modified file 'plugins/unityshell/src/HudController.h'
--- plugins/unityshell/src/HudController.h	2012-03-21 15:30:49 +0000
+++ plugins/unityshell/src/HudController.h	2012-03-27 22:51:18 +0000
@@ -22,7 +22,6 @@
 #include <memory>
 
 #include <gdk/gdk.h>
-#include <UnityCore/GLibSignal.h>
 #include <UnityCore/Hud.h>
 
 #include <NuxCore/Property.h>
@@ -49,12 +48,13 @@
   nux::BaseWindow* window() const;
 
   nux::Property<int> launcher_width;
+  nux::Property<bool> launcher_locked_out;
+  nux::Property<bool> multiple_launchers;
 
   void ShowHideHud();
   void ShowHud();
   void HideHud(bool restore_focus = true);
   bool IsVisible();
-  void SetLauncherIsLockedOut(bool launcher_is_locked_out);
 
 protected:
   std::string GetName() const;
@@ -64,11 +64,13 @@
   void EnsureHud();
   void SetupWindow();
   void SetupHudView();
-  void SetupRelayoutCallbacks();
   void RegisterUBusInterests();
 
+  int GetTargetMonitor();
+  bool IsLockedToLauncher(int monitor);
+
   nux::Geometry GetIdealWindowGeometry();
-  void Relayout(GdkScreen*screen=NULL);
+  void Relayout();
 
   void OnMouseDownOutsideWindow(int x, int y, unsigned long bflags, unsigned long kflags);
   void OnScreenUngrabbed();
@@ -81,8 +83,6 @@
   void OnQueryActivated(Query::Ptr query);
   void OnQuerySelected(Query::Ptr query);
 
-
-private:
   void StartShowHideTimeline();
   static gboolean OnViewShowHideFrame(Controller* self);
 
@@ -93,7 +93,6 @@
 private:
   UBusManager ubus;
   Hud hud_service_;
-  glib::SignalManager sig_manager_;
   nux::BaseWindow* window_;
   bool visible_;
   bool need_show_;
@@ -101,8 +100,6 @@
   guint timeline_id_;
   float last_opacity_;
   gint64 start_time_;
- 
-  bool launcher_is_locked_out_;
 
   View* view_;
   guint ensure_id_;

=== modified file 'plugins/unityshell/src/HudIcon.cpp'
--- plugins/unityshell/src/HudIcon.cpp	2012-03-26 22:43:48 +0000
+++ plugins/unityshell/src/HudIcon.cpp	2012-03-27 22:51:18 +0000
@@ -42,10 +42,6 @@
   Init();
 }
 
-Icon::~Icon()
-{
-}
-
 void Icon::Init()
 {
   SetMinimumWidth(66);
@@ -89,6 +85,10 @@
   icon_renderer_.RenderIcon(GfxContext, arg, toplevel->GetGeometry(), toplevel->GetGeometry());
 }
 
+std::string Icon::GetName() const
+{
+  return "EmbeddedIcon";
+}
 
 }
 }

=== modified file 'plugins/unityshell/src/HudIcon.h'
--- plugins/unityshell/src/HudIcon.h	2012-03-26 22:43:48 +0000
+++ plugins/unityshell/src/HudIcon.h	2012-03-27 22:51:18 +0000
@@ -53,12 +53,13 @@
   typedef nux::ObjectPtr<IconTexture> Ptr;
   Icon(nux::BaseTexture* texture, guint width, guint height);
   Icon(std::string const& icon_name, unsigned int size, bool defer_icon_loading = false);
-  ~Icon();
 
 protected:
   void Draw(nux::GraphicsEngine& GfxContext, bool force_draw);
   void Init();
 
+  std::string GetName() const;
+
   nux::ObjectPtr<nux::BaseTexture> background_;
   nux::ObjectPtr<nux::BaseTexture> gloss_;
   nux::ObjectPtr<nux::BaseTexture> edge_;

=== modified file 'plugins/unityshell/src/HudView.cpp'
--- plugins/unityshell/src/HudView.cpp	2012-03-21 15:07:29 +0000
+++ plugins/unityshell/src/HudView.cpp	2012-03-27 22:51:18 +0000
@@ -64,7 +64,7 @@
   , current_height_(0)
   , timeline_need_more_draw_(false)
   , selected_button_(0)
-  , icon_state_(IconHideState::SHOW)
+  , show_embedded_icon_(true)
   , activated_signal_sent_(false)
 {
   renderer_.SetOwner(this);
@@ -127,7 +127,6 @@
 
 View::~View()
 {
-  RemoveChild(search_bar_.GetPointer());
   for (auto button = buttons_.begin(); button != buttons_.end(); button++)
   {
     RemoveChild((*button).GetPointer());
@@ -272,22 +271,30 @@
 void View::SetIcon(std::string icon_name)
 {
   LOG_DEBUG(logger) << "Setting icon to " << icon_name;
-  icon_->SetByIconName(icon_name.c_str(), icon_size);
+  icon_->SetByIconName(icon_name, icon_size);
   QueueDraw();
 }
 
-void View::SetHideIcon(IconHideState hide_icon)
+void View::ShowEmbeddedIcon(bool show)
 {
   LOG_DEBUG(logger) << "Hide icon called";
-  if (hide_icon == icon_state_)
+  if (show == show_embedded_icon_)
     return;
 
-  icon_state_ = hide_icon;
-
-  if (icon_state_ == IconHideState::HIDE)
-    layout_->RemoveChildObject(dynamic_cast<nux::Area*>(icon_layout_.GetPointer()));
+  show_embedded_icon_ = show;
+
+  if (show_embedded_icon_)
+  {
+    layout_->AddLayout(icon_layout_.GetPointer(), 0, nux::MINOR_POSITION_TOP,
+                       nux::MINOR_SIZE_MATCHCONTENT, 100.0f, nux::LayoutPosition::NUX_LAYOUT_BEGIN);
+
+    AddChild(icon_.GetPointer());
+  }
   else
-    layout_->AddLayout(icon_layout_.GetPointer(), 0, nux::MINOR_POSITION_TOP, nux::MINOR_SIZE_MATCHCONTENT, 100.0f, nux::LayoutPosition::NUX_LAYOUT_BEGIN);
+  {
+    layout_->RemoveChildObject(static_cast<nux::Area*>(icon_layout_.GetPointer()));
+    RemoveChild(icon_.GetPointer());
+  }
 
   Relayout();
 }
@@ -303,7 +310,7 @@
   width = 1024;
   height = 276;
 
-  if (icon_state_ == IconHideState::HIDE)
+  if (!show_embedded_icon_)
   {
     width -= icon_layout_->GetGeometry().width;
   }
@@ -351,6 +358,7 @@
     icon_ = new Icon("", icon_size, true);
     icon_layout_ = new nux::VLayout();
     {
+      AddChild(icon_.GetPointer());
       icon_layout_->SetVerticalExternalMargin(icon_vertical_margin);
       icon_layout_->AddView(icon_.GetPointer(), 0, nux::MINOR_POSITION_LEFT, nux::MINOR_SIZE_FULL);
       layout_->AddLayout(icon_layout_.GetPointer(), 0, nux::MINOR_POSITION_TOP, nux::MINOR_SIZE_MATCHCONTENT);
@@ -491,6 +499,7 @@
 {
   unsigned num_buttons = buttons_.size();
   variant::BuilderWrapper(builder)
+    .add(GetGeometry())
     .add("selected_button", selected_button_)
     .add("num_buttons", num_buttons);
 }

=== modified file 'plugins/unityshell/src/HudView.h'
--- plugins/unityshell/src/HudView.h	2012-03-21 14:44:41 +0000
+++ plugins/unityshell/src/HudView.h	2012-03-27 22:51:18 +0000
@@ -44,12 +44,6 @@
 namespace hud
 {
 
-enum IconHideState
-{
-  HIDE,
-  SHOW
-};
-
 class View : public nux::View, public unity::debug::Introspectable
 {
   NUX_DECLARE_OBJECT_TYPE(HudView, nux::View);
@@ -65,7 +59,7 @@
 
   void SetQueries(Hud::Queries queries);
   void SetIcon(std::string icon_name);
-  void SetHideIcon(IconHideState hide_icon);
+  void ShowEmbeddedIcon(bool show);
 
   void AboutToShow();
   void AboutToHide();
@@ -126,7 +120,7 @@
   int current_height_;
   bool timeline_need_more_draw_;
   int selected_button_;
-  IconHideState icon_state_;
+  bool show_embedded_icon_;
   bool activated_signal_sent_;
 };
 

=== modified file 'plugins/unityshell/src/IconTexture.cpp'
--- plugins/unityshell/src/IconTexture.cpp	2012-03-27 01:38:08 +0000
+++ plugins/unityshell/src/IconTexture.cpp	2012-03-27 22:51:18 +0000
@@ -57,44 +57,47 @@
 }
 
 IconTexture::IconTexture(std::string const& icon_name, unsigned int size, bool defer_icon_loading)
-  : TextureArea(NUX_TRACKER_LOCATION)
-  , _accept_key_nav_focus(false)
-  , _icon_name(icon_name.empty() ? DEFAULT_ICON : icon_name)
-  , _size(size)
-  , _texture_width(0)
-  , _texture_height(0)
-  , _loading(false)
-  , _opacity(1.0f)
+  : TextureArea(NUX_TRACKER_LOCATION),
+    _accept_key_nav_focus(false),
+    _icon_name(!icon_name.empty() ? icon_name : DEFAULT_ICON),
+    _size(size),
+    _texture_width(0),
+    _texture_height(0),
+    _loading(false),
+    _opacity(1.0f)
 {
-
-  if (_icon_name != "" && !defer_icon_loading)
+  if (!defer_icon_loading)
     LoadIcon();
 }
 
+IconTexture::~IconTexture()
+{}
+
 void IconTexture::SetByIconName(std::string const& icon_name, unsigned int size)
 {
+  if (_icon_name == icon_name && _size == size)
+    return;
+
   _icon_name = icon_name;
   _size = size;
+
   LoadIcon();
 }
 
+
 void IconTexture::SetByFilePath(std::string const& file_path, unsigned int size)
 {
-  _icon_name = file_path;
-  _size = size;
-
-  LoadIcon();
+  SetByIconName(file_path, size);
 }
 
 void IconTexture::LoadIcon()
 {
   LOG_DEBUG(logger) << "LoadIcon called (" << _icon_name << ") - loading: " << _loading;
-static const char* const DEFAULT_GICON = ". GThemedIcon text-x-preview";
-  if (_icon_name.empty())
-    return;
+  static const char* const DEFAULT_GICON = ". GThemedIcon text-x-preview";
 
   if (_loading)
     return;
+
   _loading = true;
 
   glib::Object<GIcon> icon(::g_icon_new_for_string(_icon_name.empty() ?  DEFAULT_GICON : _icon_name.c_str(), NULL));
@@ -231,7 +234,7 @@
 {
   unity::variant::BuilderWrapper(builder)
   .add(GetGeometry())
-  .add("iconname", _icon_name);
+  .add("icon_name", _icon_name);
 }
 
 //

=== modified file 'plugins/unityshell/src/IconTexture.h'
--- plugins/unityshell/src/IconTexture.h	2012-03-26 22:43:48 +0000
+++ plugins/unityshell/src/IconTexture.h	2012-03-27 22:51:18 +0000
@@ -38,6 +38,7 @@
 public:
   IconTexture(nux::BaseTexture* texture, guint width, guint height);
   IconTexture(std::string const& icon_name, unsigned int size, bool defer_icon_loading = false);
+  virtual ~IconTexture();
 
   void SetByIconName(std::string const& icon_name, unsigned int size);
   void SetByFilePath(std::string const& file_path, unsigned int size);

=== modified file 'plugins/unityshell/src/LauncherIcon.cpp'
--- plugins/unityshell/src/LauncherIcon.cpp	2012-03-26 23:23:42 +0000
+++ plugins/unityshell/src/LauncherIcon.cpp	2012-03-27 22:51:18 +0000
@@ -185,18 +185,20 @@
 LauncherIcon::AddProperties(GVariantBuilder* builder)
 {
   unity::variant::BuilderWrapper(builder)
-  .add("x", _center[0].x)
-  .add("y", _center[0].y)
-  .add("z", _center[0].z)
-  .add("related-windows", (int)Windows().size())
-  .add("icon-type", _icon_type)
-  .add("tooltip-text", tooltip_text())
-  .add("sort-priority", _sort_priority)
-  .add("quirk-active", GetQuirk(QUIRK_ACTIVE))
-  .add("quirk-visible", GetQuirk(QUIRK_VISIBLE))
-  .add("quirk-urgent", GetQuirk(QUIRK_URGENT))
-  .add("quirk-running", GetQuirk(QUIRK_RUNNING))
-  .add("quirk-presented", GetQuirk(QUIRK_PRESENTED));
+  .add("center_x", _center[0].x)
+  .add("center_y", _center[0].y)
+  .add("center_z", _center[0].z)
+  .add("related_windows", static_cast<unsigned int>(Windows().size()))
+  .add("icon_type", _icon_type)
+  .add("tooltip_text", tooltip_text())
+  .add("sort_priority", _sort_priority)
+  .add("active", GetQuirk(QUIRK_ACTIVE))
+  .add("visible", GetQuirk(QUIRK_VISIBLE))
+  .add("urgent", GetQuirk(QUIRK_URGENT))
+  .add("running", GetQuirk(QUIRK_RUNNING))
+  .add("starting", GetQuirk(QUIRK_STARTING))
+  .add("desaturated", GetQuirk(QUIRK_DESAT))
+  .add("presented", GetQuirk(QUIRK_PRESENTED));
 }
 
 void

=== modified file 'plugins/unityshell/src/SimpleLauncherIcon.cpp'
--- plugins/unityshell/src/SimpleLauncherIcon.cpp	2012-03-14 06:24:18 +0000
+++ plugins/unityshell/src/SimpleLauncherIcon.cpp	2012-03-27 22:51:18 +0000
@@ -23,6 +23,7 @@
 #include <NuxCore/Logger.h>
 #include <Nux/Nux.h>
 #include <Nux/BaseWindow.h>
+#include <UnityCore/Variant.h>
 
 #include "SimpleLauncherIcon.h"
 #include "PluginAdapter.h"
@@ -148,6 +149,12 @@
   return "SimpleLauncherIcon";
 }
 
+void SimpleLauncherIcon::AddProperties(GVariantBuilder* builder)
+{
+  LauncherIcon::AddProperties(builder);
+  variant::BuilderWrapper(builder).add("icon_name", icon_name);
+}
+
 } // namespace launcher
 } // namespace unity
 

=== modified file 'plugins/unityshell/src/SimpleLauncherIcon.h'
--- plugins/unityshell/src/SimpleLauncherIcon.h	2012-03-14 06:24:18 +0000
+++ plugins/unityshell/src/SimpleLauncherIcon.h	2012-03-27 22:51:18 +0000
@@ -47,6 +47,8 @@
 
 protected:
   std::string GetName() const;
+  void AddProperties(GVariantBuilder* builder);
+
   virtual void OnMouseDown(int button, int monitor);
   virtual void OnMouseUp(int button, int monitor);
   virtual void OnMouseClick(int button, int monitor);

=== modified file 'plugins/unityshell/src/unityshell.cpp'
--- plugins/unityshell/src/unityshell.cpp	2012-03-26 21:52:33 +0000
+++ plugins/unityshell/src/unityshell.cpp	2012-03-27 22:51:18 +0000
@@ -2520,6 +2520,7 @@
     case UnityshellOptions::NumLaunchers:
       launcher_controller_->multiple_launchers = optionGetNumLaunchers() == 0;
       dash_controller_->use_primary = !launcher_controller_->multiple_launchers();
+      hud_controller_->multiple_launchers = launcher_controller_->multiple_launchers();
       break;
     case UnityshellOptions::LauncherCaptureMouse:
       launcher_options->edge_resist = optionGetLauncherCaptureMouse();
@@ -2540,7 +2541,7 @@
     case UnityshellOptions::LauncherHideMode:
     {
       launcher_options->hide_mode = (unity::launcher::LauncherHideMode) optionGetLauncherHideMode();
-      hud_controller_->SetLauncherIsLockedOut(launcher_options->hide_mode == unity::launcher::LauncherHideMode::LAUNCHER_HIDE_NEVER);
+      hud_controller_->launcher_locked_out = (launcher_options->hide_mode == unity::launcher::LauncherHideMode::LAUNCHER_HIDE_NEVER);
       break;
     }
     case UnityshellOptions::BacklightMode:
@@ -2775,7 +2776,8 @@
   /* Setup Hud */
   hud_controller_.reset(new hud::Controller());
   auto hide_mode = (unity::launcher::LauncherHideMode) optionGetLauncherHideMode();
-  hud_controller_->SetLauncherIsLockedOut(hide_mode == unity::launcher::LauncherHideMode::LAUNCHER_HIDE_NEVER);
+  hud_controller_->launcher_locked_out = (hide_mode == unity::launcher::LauncherHideMode::LAUNCHER_HIDE_NEVER);
+  hud_controller_->multiple_launchers = (optionGetNumLaunchers() == 0);
   AddChild(hud_controller_.get());
   LOG_INFO(logger) << "initLauncher-hud " << timer.ElapsedSeconds() << "s";
   

=== modified file 'tests/autopilot/autopilot/emulators/X11.py'
--- tests/autopilot/autopilot/emulators/X11.py	2012-03-25 20:50:33 +0000
+++ tests/autopilot/autopilot/emulators/X11.py	2012-03-27 22:51:18 +0000
@@ -360,10 +360,20 @@
         Returns a tuple containing (x,y,width,height).
 
         """
-        if monitor_number >= self.get_num_monitors():
+        if monitor_number < 0 or monitor_number >= self.get_num_monitors():
             raise ValueError('Specified monitor number is out of range.')
         return tuple(self._default_screen.get_monitor_geometry(monitor_number))
 
+    def is_rect_on_monitor(self, monitor_number, rect):
+        """Returns True if `rect` is _entirely_ on the specified monitor, with no overlap."""
+
+        if type(rect) is not tuple or len(rect) != 4:
+            raise TypeError("rect must be a tuple of 4 int elements.")
+
+        (x, y, w, h) = rect
+        (m_x, m_y, m_w, m_h) = self.get_monitor_geometry(monitor_number)
+        return (x >= m_x and x + w <= m_x + m_w and y >= m_y and y + h <= m_y + m_h)
+
     def move_mouse_to_monitor(self, monitor_number):
         """Move the mouse to the center of the specified monitor."""
         geo = self.get_monitor_geometry(monitor_number)

=== modified file 'tests/autopilot/autopilot/emulators/bamf.py'
--- tests/autopilot/autopilot/emulators/bamf.py	2012-03-20 00:21:52 +0000
+++ tests/autopilot/autopilot/emulators/bamf.py	2012-03-27 22:51:18 +0000
@@ -184,6 +184,11 @@
         return self._view_iface.Name()
 
     @property
+    def icon(self):
+        """Get the application icon."""
+        return self._view_iface.Icon()
+
+    @property
     def is_active(self):
         """Is the application active (i.e.- has keyboard focus)?"""
         return self._view_iface.IsActive()

=== modified file 'tests/autopilot/autopilot/emulators/unity/hud.py'
--- tests/autopilot/autopilot/emulators/unity/hud.py	2012-03-04 23:12:19 +0000
+++ tests/autopilot/autopilot/emulators/unity/hud.py	2012-03-27 22:51:18 +0000
@@ -14,6 +14,16 @@
 class HudView(UnityIntrospectionObject):
     """Proxy object for the hud view child of the controller."""
 
+    @property
+    def geometry(self):
+        return (self.x, self.y, self.width, self.height)
+
+class EmbeddedIcon(UnityIntrospectionObject):
+    """Proxy object for the hud embedded icon child of the view."""
+
+    @property
+    def geometry(self):
+        return (self.x, self.y, self.width, self.height)
 
 class HudController(UnityIntrospectionObject, KeybindingsHelper):
     """Proxy object for the Unity Hud Controller."""
@@ -35,11 +45,24 @@
         """Tap the 'Alt' key to toggle the hud visibility."""
         self.keybinding("hud/reveal", tap_delay)
 
+    def get_embedded_icon(self):
+        """Returns the HUD view embedded icon or None if is not shown."""
+        view = self._get_view()
+        if (not view):
+            return None
+
+        icons = view.get_children_by_type(EmbeddedIcon)
+        return icons[0] if icons else None
+
     def _get_view(self):
         views = self.get_children_by_type(HudView)
         return views[0] if views else None
 
     @property
+    def geometry(self):
+        return (self.x, self.y, self.width, self.height)
+
+    @property
     def selected_button(self):
         view = self._get_view()
         if view:
@@ -54,3 +77,15 @@
             return view.num_buttons
         else:
             return 0
+
+    @property
+    def is_locked_to_launcher(self):
+        return bool(self.locked_to_launcher)
+
+    @property
+    def monitor(self):
+        return int(self.hud_monitor)
+
+    @property
+    def has_embedded_icon(self):
+        return (self.get_embedded_icon() != None)

=== modified file 'tests/autopilot/autopilot/emulators/unity/icons.py'
--- tests/autopilot/autopilot/emulators/unity/icons.py	2012-03-04 23:12:19 +0000
+++ tests/autopilot/autopilot/emulators/unity/icons.py	2012-03-27 22:51:18 +0000
@@ -19,6 +19,11 @@
 
     """
 
+    @property
+    def center_position(self):
+        """Get the center point of an icon, returns a tuple with (x, y, z)"""
+        return (self.center_x, self.center_y, self.center_z)
+
     def get_quicklist(self):
         """Get the quicklist for this launcher icon.
 
@@ -34,6 +39,10 @@
     """Represents the BFB button in the launcher."""
 
 
+class HudLauncherIcon(SimpleLauncherIcon):
+    """Represents the HUD button in the launcher."""
+
+
 class BamfLauncherIcon(SimpleLauncherIcon):
     """Represents a launcher icon with BAMF integration."""
 

=== modified file 'tests/autopilot/autopilot/emulators/unity/launcher.py'
--- tests/autopilot/autopilot/emulators/unity/launcher.py	2012-03-25 21:25:54 +0000
+++ tests/autopilot/autopilot/emulators/unity/launcher.py	2012-03-27 22:51:18 +0000
@@ -12,7 +12,7 @@
 
 from autopilot.keybindings import KeybindingsHelper
 from autopilot.emulators.unity import UnityIntrospectionObject
-from autopilot.emulators.unity.icons import BamfLauncherIcon, SimpleLauncherIcon
+from autopilot.emulators.unity.icons import BFBLauncherIcon, BamfLauncherIcon, SimpleLauncherIcon
 from autopilot.emulators.X11 import Mouse, ScreenGeometry
 
 
@@ -200,8 +200,8 @@
         logger.debug("Clicking launcher icon %r on monitor %d with mouse button %d",
             icon, self.monitor, button)
         self.mouse_reveal_launcher()
-        target_x = icon.x + self.x
-        target_y = icon.y + (self.icon_size / 2)
+        target_x = icon.center_x + self.x
+        target_y = icon.center_y
         self._mouse.move(target_x, target_y )
         self._mouse.click(button)
         self.move_mouse_to_right_of_launcher()
@@ -258,10 +258,15 @@
 class LauncherModel(UnityIntrospectionObject):
     """THe launcher model. Contains all launcher icons as children."""
 
+    def get_bfb_icon(self):
+        icons = BFBLauncherIcon.get_all_instances()
+        assert(len(icons) == 1)
+        return icons[0]
+
     def get_launcher_icons(self, visible_only=True):
         """Get a list of launcher icons in this launcher."""
         if visible_only:
-            return self.get_children_by_type(SimpleLauncherIcon, quirk_visible=True)
+            return self.get_children_by_type(SimpleLauncherIcon, visible=True)
         else:
             return self.get_children_by_type(SimpleLauncherIcon)
 
@@ -281,7 +286,21 @@
         Returns None if there is no such launcher icon.
         """
         icons = self.get_children_by_type(SimpleLauncherIcon, desktop_file=desktop_file)
-        return icons or None
+        if len(icons):
+            return icons[0]
+
+        return None
+
+    def get_icon_by_desktop_id(self, desktop_id):
+        """Gets a launcher icon with the specified desktop id.
+
+        Returns None if there is no such launcher icon.
+        """
+        icons = self.get_children_by_type(SimpleLauncherIcon, desktop_id=desktop_id)
+        if len(icons):
+            return icons[0]
+
+        return None
 
     def num_launcher_icons(self):
         """Get the number of icons in the launcher model."""

=== modified file 'tests/autopilot/autopilot/emulators/unity/switcher.py'
--- tests/autopilot/autopilot/emulators/unity/switcher.py	2012-03-07 17:24:15 +0000
+++ tests/autopilot/autopilot/emulators/unity/switcher.py	2012-03-27 22:51:18 +0000
@@ -136,11 +136,11 @@
             return None
 
     def get_icon_name(self, index):
-        return self.__get_icon(index)['tooltip-text']
+        return self.__get_icon(index)['tooltip_text']
 
     def get_icon_desktop_file(self, index):
         try:
-            return self.__get_icon(index)['desktop-file']
+            return self.__get_icon(index)['desktop_file']
         except:
             return None
 

=== modified file 'tests/autopilot/autopilot/tests/__init__.py'
--- tests/autopilot/autopilot/tests/__init__.py	2012-03-27 20:48:14 +0000
+++ tests/autopilot/autopilot/tests/__init__.py	2012-03-27 22:51:18 +0000
@@ -25,7 +25,7 @@
 from autopilot.emulators.unity.launcher import LauncherController
 from autopilot.emulators.unity.switcher import Switcher
 from autopilot.emulators.unity.workspace import WorkspaceManager
-from autopilot.emulators.X11 import Keyboard, Mouse
+from autopilot.emulators.X11 import ScreenGeometry, Keyboard, Mouse
 from autopilot.glibrunner import GlibRunner
 from autopilot.globals import (global_context,
     video_recording_enabled,
@@ -229,17 +229,25 @@
         self.dash = Dash()
         self.switcher = Switcher()
         self.workspace = WorkspaceManager()
+        self.screen_geo = ScreenGeometry()
         self.launcher = self._get_launcher_controller()
         self.addCleanup(self.workspace.switch_to, self.workspace.current_workspace)
         self.addCleanup(Keyboard.cleanup)
         self.addCleanup(Mouse.cleanup)
 
-    def start_app(self, app_name, files=[]):
+    def start_app(self, app_name, files=[], locale=None):
         """Start one of the known apps, and kill it on tear down.
 
-        if files is specified, start the application with the specified files.
+        If files is specified, start the application with the specified files.
+        If locale is specified, the locale will be set when the application is launched.
         """
-        logger.info("Starting application '%s'", app_name)
+        if locale:
+            os.putenv("LC_ALL", locale)
+            self.addCleanup(os.unsetenv, "LC_ALL")
+            logger.info("Starting application '%s' with files %r in locale %s", app_name, files, locale)
+        else:
+            logger.info("Starting application '%s' with files %r", app_name, files)
+
         app = self.KNOWN_APPS[app_name]
         self.bamf.launch_application(app['desktop-file'], files)
         self.addCleanup(call, ["killall", app['process-name']])

=== modified file 'tests/autopilot/autopilot/tests/test_hud.py'
--- tests/autopilot/autopilot/tests/test_hud.py	2012-03-21 14:44:41 +0000
+++ tests/autopilot/autopilot/tests/test_hud.py	2012-03-27 22:51:18 +0000
@@ -1,58 +1,81 @@
 # -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
-# Copyright 2010 Canonical
-# Author: Alex Launi
+# Copyright 2012 Canonical
+# Author: Alex Launi,
+#         Marco Trevisan
 #
 # This program is free software: you can redistribute it and/or modify it
 # under the terms of the GNU General Public License version 3, as published
 # by the Free Software Foundation.
 
-from testtools.matchers import Equals, LessThan
+from testtools.matchers import Equals, NotEquals, LessThan, GreaterThan
 from time import sleep
 
+from autopilot.emulators.X11 import ScreenGeometry
 from autopilot.emulators.unity.hud import HudController
-from autopilot.tests import AutopilotTestCase
+from autopilot.emulators.unity.icons import HudLauncherIcon
+from autopilot.tests import AutopilotTestCase, multiply_scenarios
 from os import remove
 
-class HudTests(AutopilotTestCase):
-
-    scenarios = [
-        ('Launcher never hide', {'launcher_hide_mode': 0}),
-        ('Launcher autohide', {'launcher_hide_mode': 1}),
-        ]
+def _make_monitor_scenarios():
+    num_monitors = ScreenGeometry().get_num_monitors()
+    scenarios = []
+
+    if num_monitors == 1:
+        scenarios = [('Single Monitor', {'hud_monitor': 0})]
+
+    else:
+        for i in range(num_monitors):
+            scenarios += [('Monitor %d' % (i), {'hud_monitor': i})]
+
+    return scenarios
+
+class HudTestsBase(AutopilotTestCase):
 
     def setUp(self):
-        super(HudTests, self).setUp()
-        self.set_unity_option('launcher_hide_mode', self.launcher_hide_mode)
-        sleep(0.5)
+        super(HudTestsBase, self).setUp()
+
+        sleep(0.25)
         self.hud = self.get_hud_controller()
 
     def tearDown(self):
         self.hud.ensure_hidden()
-        super(HudTests, self).tearDown()
+        super(HudTestsBase, self).tearDown()
 
     def get_hud_controller(self):
         controllers = HudController.get_all_instances()
         self.assertEqual(1, len(controllers))
         return controllers[0]
 
+    def get_hud_launcher_icon(self):
+        icons = HudLauncherIcon.get_all_instances()
+        self.assertEqual(1, len(icons))
+        return icons[0]
+
     def get_num_active_launcher_icons(self):
         num_active = 0
         for icon in self.launcher.model.get_launcher_icons():
-            if icon.quirk_active and icon.quirk_visible:
+            if icon.active and icon.visible:
                 num_active += 1
         return num_active
 
-    def test_initially_hidden(self):
-        self.assertFalse(self.hud.visible)
-
     def reveal_hud(self):
         self.hud.toggle_reveal()
         for counter in range(10):
             sleep(1)
             if self.hud.visible:
                 break
+
         self.assertTrue(self.hud.visible, "HUD did not appear.")
 
+
+class HudBehaviorTests(HudTestsBase):
+
+    def setUp(self):
+        super(HudBehaviorTests, self).setUp()
+
+        self.hud_monitor = self.screen_geo.get_primary_monitor()
+        self.screen_geo.move_mouse_to_monitor(self.hud_monitor)
+
     def test_no_initial_values(self):
         self.reveal_hud()
         self.assertThat(self.hud.num_buttons, Equals(0))
@@ -121,36 +144,6 @@
         sleep(1)
         self.assertFalse(self.hud.visible)
 
-    def test_multiple_hud_reveal_does_not_break_launcher(self):
-        """Multiple Hud reveals must not cause the launcher to set multiple
-        apps as active.
-
-        """
-        # We need an app to switch to:
-        self.start_app('Character Map')
-        # We need an application to play with - I'll use the calculator.
-        self.start_app('Calculator')
-        sleep(1)
-
-        # before we start, make sure there's zero or one active icon:
-        num_active = self.get_num_active_launcher_icons()
-        self.assertThat(num_active, LessThan(2), "Invalid number of launcher icons active before test has run!")
-
-        # reveal and hide hud several times over:
-        for i in range(3):
-            self.hud.ensure_visible()
-            sleep(0.5)
-            self.hud.ensure_hidden()
-            sleep(0.5)
-
-        # click application icons for running apps in the launcher:
-        icon = self.launcher.model.get_icon_by_tooltip_text("Character Map")
-        self.launcher.get_launcher_for_monitor(0).click_launcher_icon(icon)
-
-        # see how many apps are marked as being active:
-        num_active = self.get_num_active_launcher_icons()
-        self.assertLessEqual(num_active, 1, "More than one launcher icon active after test has run!")
-
     def test_restore_focus(self):
         """Ensures that once the hud is dismissed, the same application
         that was focused before hud invocation is refocused
@@ -191,7 +184,7 @@
         """Read the saved file. The content should be "0 "."""
 
         self.addCleanup(remove, '/tmp/autopilot_gedit_undo_test_temp_file.txt')
-        self.start_app('Text Editor', files=['/tmp/autopilot_gedit_undo_test_temp_file.txt'])
+        self.start_app('Text Editor', files=['/tmp/autopilot_gedit_undo_test_temp_file.txt'], locale='C')
 
         sleep(1)
         self.keyboard.type("0")
@@ -202,8 +195,9 @@
         sleep(1)
 
         self.keyboard.type("undo")
+        sleep(1)
         self.keyboard.press_and_release('Return')
-        sleep(1)
+        sleep(.5)
 
         self.keyboard.press_and_release("Ctrl+s")
         sleep(1)
@@ -211,3 +205,199 @@
         contents = open("/tmp/autopilot_gedit_undo_test_temp_file.txt").read().strip('\n')
         self.assertEqual("0 ", contents)
 
+
+class HudLauncherInteractionsTests(HudTestsBase):
+
+    launcher_modes = [('Launcher autohide', {'launcher_autohide': False}),
+                      ('Launcher never hide', {'launcher_autohide': True})]
+
+    scenarios = multiply_scenarios(_make_monitor_scenarios(), launcher_modes)
+
+    def setUp(self):
+        super(HudLauncherInteractionsTests, self).setUp()
+        # Launchers on all monitors
+        self.set_unity_option('num_launchers', 0)
+        self.set_unity_option('launcher_hide_mode', int(self.launcher_autohide))
+
+        self.screen_geo.move_mouse_to_monitor(self.hud_monitor)
+        sleep(0.5)
+
+    def test_multiple_hud_reveal_does_not_break_launcher(self):
+        """Multiple Hud reveals must not cause the launcher to set multiple
+        apps as active.
+
+        """
+        launcher = self.launcher.get_launcher_for_monitor(self.hud_monitor)
+
+        # We need an app to switch to:
+        self.start_app('Character Map')
+        # We need an application to play with - I'll use the calculator.
+        self.start_app('Calculator')
+        sleep(1)
+
+        # before we start, make sure there's zero or one active icon:
+        num_active = self.get_num_active_launcher_icons()
+        self.assertThat(num_active, LessThan(2), "Invalid number of launcher icons active before test has run!")
+
+        # reveal and hide hud several times over:
+        for i in range(3):
+            self.hud.ensure_visible()
+            sleep(0.5)
+            self.hud.ensure_hidden()
+            sleep(0.5)
+
+        # click application icons for running apps in the launcher:
+        icon = self.launcher.model.get_icon_by_desktop_id("gucharmap.desktop")
+        launcher.click_launcher_icon(icon)
+
+        # see how many apps are marked as being active:
+        num_active = self.get_num_active_launcher_icons()
+        self.assertLessEqual(num_active, 1, "More than one launcher icon active after test has run!")
+
+    def test_hud_does_not_change_launcher_status(self):
+        """Tests if the HUD reveal keeps the launcher in the status it was"""
+
+        launcher = self.launcher.get_launcher_for_monitor(self.hud_monitor)
+
+        launcher_shows_pre = launcher.is_showing()
+        sleep(.25)
+
+        self.reveal_hud()
+        sleep(1)
+
+        launcher_shows_post = launcher.is_showing()
+        self.assertThat(launcher_shows_pre, Equals(launcher_shows_post))
+
+
+class HudLockedLauncherInteractionsTests(HudTestsBase):
+
+    scenarios = _make_monitor_scenarios()
+
+    def setUp(self):
+        super(HudLockedLauncherInteractionsTests, self).setUp()
+        # Locked Launchers on all monitors
+        self.set_unity_option('num_launchers', 0)
+        self.set_unity_option('launcher_hide_mode', 0)
+
+        self.screen_geo.move_mouse_to_monitor(self.hud_monitor)
+        sleep(0.5)
+
+    def test_hud_launcher_icon_hides_bfb(self):
+        """Tests that the BFB icon is hidden when the HUD launcher icon is shown"""
+
+        hud_icon = self.get_hud_launcher_icon()
+        bfb_icon = self.launcher.model.get_bfb_icon()
+
+        self.assertTrue(bfb_icon.visible)
+        self.assertFalse(hud_icon.visible)
+        sleep(.25)
+
+        self.reveal_hud()
+        sleep(.5)
+
+        self.assertTrue(hud_icon.visible)
+        self.assertFalse(bfb_icon.visible)
+
+    def test_hud_desaturates_launcher_icons(self):
+        """Tests that the launcher icons are desaturates when HUD is open"""
+
+        self.reveal_hud()
+        sleep(.5)
+
+        for icon in self.launcher.model.get_launcher_icons():
+            if isinstance(icon, HudLauncherIcon):
+                self.assertFalse(icon.desaturated)
+            else:
+                self.assertTrue(icon.desaturated)
+
+
+class HudVisualTests(HudTestsBase):
+
+    launcher_modes = [('Launcher autohide', {'launcher_autohide': False}),
+                      ('Launcher never hide', {'launcher_autohide': True})]
+
+    launcher_screen = [('Launcher on primary monitor', {'launcher_primary_only': False}),
+                       ('Launcher on all monitors', {'launcher_primary_only': True})]
+
+    scenarios = multiply_scenarios(_make_monitor_scenarios(), launcher_modes, launcher_screen)
+
+    def setUp(self):
+        super(HudVisualTests, self).setUp()
+        self.screen_geo.move_mouse_to_monitor(self.hud_monitor)
+        self.set_unity_option('launcher_hide_mode', int(self.launcher_autohide))
+        self.set_unity_option('num_launchers', int(self.launcher_primary_only))
+        self.hud_monitor_is_primary = (self.screen_geo.get_primary_monitor() == self.hud_monitor)
+        self.hud_locked = (not self.launcher_autohide and (not self.launcher_primary_only or self.hud_monitor_is_primary))
+        sleep(0.5)
+
+    def test_initially_hidden(self):
+        self.assertFalse(self.hud.visible)
+
+    def test_hud_is_on_right_monitor(self):
+        """Tests if the hud is shown and fits the monitor where it should be"""
+        self.reveal_hud()
+        self.assertThat(self.hud_monitor, Equals(self.hud.monitor))
+        self.assertTrue(self.screen_geo.is_rect_on_monitor(self.hud.monitor, self.hud.geometry))
+
+    def test_hud_geometries(self):
+        """Tests the HUD geometries for the given monitor and status"""
+        self.reveal_hud()
+        monitor_geo = self.screen_geo.get_monitor_geometry(self.hud_monitor)
+        monitor_x = monitor_geo[0]
+        monitor_w = monitor_geo[2]
+        hud_x = self.hud.geometry[0]
+        hud_w = self.hud.geometry[2]
+
+        if self.hud_locked:
+            self.assertThat(hud_x, GreaterThan(monitor_x))
+            self.assertThat(hud_x, LessThan(monitor_x + monitor_w))
+            self.assertThat(hud_w, Equals(monitor_x + monitor_w - hud_x))
+        else:
+            self.assertThat(hud_x, Equals(monitor_x))
+            self.assertThat(hud_w, Equals(monitor_w))
+
+    def test_hud_is_locked_to_launcher(self):
+        """Tests if the HUD is locked to launcher as we expect or not"""
+        self.reveal_hud()
+        sleep(.25)
+
+        self.assertThat(self.hud.is_locked_to_launcher, Equals(self.hud_locked))
+
+    def test_hud_icon_is_shown(self):
+        """Tests that the correct HUD icon is shown"""
+        self.reveal_hud()
+        sleep(.5)
+
+        hud_launcher_icon = self.get_hud_launcher_icon()
+        hud_embedded_icon = self.hud.get_embedded_icon()
+
+        # FIXME this should check self.hud.is_locked_to_launcher
+        # but the HUD icon is currently shared between launchers.
+        if not self.launcher_autohide:
+            self.assertTrue(hud_launcher_icon.visible)
+            self.assertFalse(hud_launcher_icon.desaturated)
+
+            # FIXME remove this once the issue above has been resolved
+            if self.hud.is_locked_to_launcher:
+                self.assertThat(hud_embedded_icon, Equals(None))
+        else:
+            self.assertThat(hud_embedded_icon, NotEquals(None))
+            self.assertFalse(hud_launcher_icon.visible)
+
+    def test_hud_icon_show_the_focused_application_emblem(self):
+        """Tests that the correct HUD icon is shown"""
+        self.start_app("Calculator")
+        calctools = self.get_app_instances("Calculator")
+        self.assertThat(len(calctools), GreaterThan(0))
+        calc = calctools[0]
+        self.assertTrue(calc.is_active)
+
+        self.reveal_hud()
+        sleep(.5)
+
+        if self.hud.is_locked_to_launcher:
+            hud_launcher_icon = self.get_hud_launcher_icon()
+            self.assertThat(hud_launcher_icon.icon_name, Equals(calc.icon))
+        else:
+            hud_embedded_icon = self.hud.get_embedded_icon()
+            self.assertThat(hud_embedded_icon.icon_name, Equals(calc.icon))

=== modified file 'tests/autopilot/autopilot/tests/test_launcher.py'
--- tests/autopilot/autopilot/tests/test_launcher.py	2012-03-27 20:48:14 +0000
+++ tests/autopilot/autopilot/tests/test_launcher.py	2012-03-27 22:51:18 +0000
@@ -534,9 +534,8 @@
     def test_launcher_does_not_reveal_with_mouse_down(self):
         """Launcher must not reveal if have mouse button 1 down."""
         launcher_instance = self.get_launcher()
-        screens = ScreenGeometry()
 
-        screens.move_mouse_to_monitor(launcher_instance.monitor)
+        self.screen_geo.move_mouse_to_monitor(launcher_instance.monitor)
         self.mouse.press(1)
         launcher_instance.mouse_reveal_launcher()
         self.assertThat(launcher_instance.is_showing(), Equals(False))

=== modified file 'tests/autopilot/autopilot/tests/test_shortcut_hint.py'
--- tests/autopilot/autopilot/tests/test_shortcut_hint.py	2012-03-21 22:32:36 +0000
+++ tests/autopilot/autopilot/tests/test_shortcut_hint.py	2012-03-27 22:51:18 +0000
@@ -29,9 +29,8 @@
         sleep(1)
 
     def skip_if_monitor_too_small(self):
-        screen = ScreenGeometry();
-        monitor = screen.get_primary_monitor()
-        monitor_geo = screen.get_monitor_geometry(monitor);
+        monitor = self.screen_geo.get_primary_monitor()
+        monitor_geo = self.screen_geo.get_monitor_geometry(monitor);
         monitor_w = monitor_geo[2];
         monitor_h = monitor_geo[3];
         launcher_width = self.launcher.get_launcher_for_monitor(monitor).geometry[2];
@@ -49,8 +48,7 @@
     def get_launcher(self):
         # We could parameterise this so all tests run on both monitors (if MM is
         # set up), but I think it's fine to just always use monitor primary monitor:
-        screen = ScreenGeometry();
-        monitor = screen.get_primary_monitor()
+        monitor = self.screen_geo.get_primary_monitor()
         return self.launcher.get_launcher_for_monitor(monitor)
 
 

=== modified file 'tests/autopilot/autopilot/tests/test_showdesktop.py'
--- tests/autopilot/autopilot/tests/test_showdesktop.py	2012-03-12 04:06:44 +0000
+++ tests/autopilot/autopilot/tests/test_showdesktop.py	2012-03-27 22:51:18 +0000
@@ -9,6 +9,7 @@
 from time import sleep
 
 from autopilot.emulators.unity.switcher import Switcher
+from autopilot.emulators.unity.icons import DesktopLauncherIcon
 from autopilot.tests import AutopilotTestCase
 
 
@@ -23,8 +24,8 @@
 
     def launch_test_apps(self):
         """Launch character map and calculator apps."""
-        self.start_app('Character Map')
-        self.start_app('Calculator')
+        self.start_app('Character Map', locale='C')
+        self.start_app('Calculator', locale='C')
         sleep(1)
 
     def test_showdesktop_hides_apps(self):
@@ -75,7 +76,7 @@
             self.assertTrue(win.is_hidden, "Window '%s' is not hidden after show desktop activated." % (win.title))
 
         # We'll un-minimise the character map - find it's launcherIcon in the launcher:
-        charmap_icon = self.launcher.model.get_icon_by_tooltip_text('Character Map')
+        charmap_icon = self.launcher.model.get_icon_by_desktop_id("gucharmap.desktop")
         if charmap_icon:
             self.launcher.get_launcher_for_monitor(0).click_launcher_icon(charmap_icon)
         else:
@@ -108,7 +109,7 @@
         for i in range(switcher.get_model_size()):
             current_icon = switcher.current_icon
             self.assertIsNotNone(current_icon)
-            if current_icon.tooltip_text == 'Show Desktop':
+            if isinstance(current_icon, DesktopLauncherIcon):
                 found = True
                 break
             switcher.previous_icon()

=== modified file 'tests/autopilot/autopilot/tests/test_switcher.py'
--- tests/autopilot/autopilot/tests/test_switcher.py	2012-03-14 06:24:18 +0000
+++ tests/autopilot/autopilot/tests/test_switcher.py	2012-03-27 22:51:18 +0000
@@ -292,6 +292,11 @@
 class SwitcherWorkspaceTests(AutopilotTestCase):
     """Test Switcher behavior with respect to multiple workspaces."""
 
+    def get_bamf_application(self, name):
+        apps = self.get_app_instances(name)
+        self.assertThat(len(apps), Equals(1))
+        return apps[0]
+
     def test_switcher_shows_current_workspace_only(self):
         """Switcher must show apps from the current workspace only."""
         self.close_all_app('Calculator')
@@ -308,8 +313,8 @@
         sleep(1)
         icon_names = [i.tooltip_text for i in self.switcher.get_switcher_icons()]
         self.switcher.terminate()
-        self.assertThat(icon_names, Contains("Character Map"))
-        self.assertThat(icon_names, Not(Contains("Calculator")))
+        self.assertThat(icon_names, Contains(self.get_bamf_application("Character Map").name))
+        self.assertThat(icon_names, Not(Contains(self.get_bamf_application("Calculator").name)))
 
     def test_switcher_all_mode_shows_all_apps(self):
         """Test switcher 'show_all' mode shows apps from all workspaces."""
@@ -327,8 +332,8 @@
         sleep(1)
         icon_names = [i.tooltip_text for i in self.switcher.get_switcher_icons()]
         self.switcher.terminate()
-        self.assertThat(icon_names, Contains("Character Map"))
-        self.assertThat(icon_names, Contains("Calculator"))
+        self.assertThat(icon_names, Contains(self.get_bamf_application("Calculator").name))
+        self.assertThat(icon_names, Contains(self.get_bamf_application("Character Map").name))
 
     def test_switcher_can_switch_to_minimised_window(self):
         """Switcher must be able to switch to a minimised window when there's
@@ -353,16 +358,14 @@
 
         self.switcher.initiate()
         sleep(1)
-        while self.switcher.current_icon.tooltip_text != 'Mahjongg':
+        while self.switcher.current_icon.tooltip_text != self.get_bamf_application("Mahjongg").name:
             self.switcher.next_icon()
             sleep(1)
         self.switcher.stop()
         sleep(1)
 
-        #get calculator windows - there should be only one:
-        mahjongg_apps = self.get_app_instances("Mahjongg")
-        self.assertThat(len(mahjongg_apps), Equals(1))
-        wins = mahjongg_apps[0].get_windows()
+        #get mahjongg windows - there should be two:
+        wins = self.get_bamf_application("Mahjongg").get_windows()
         self.assertThat(len(wins), Equals(2))
         # Ideally we should be able to find the instance that is on the
         # current workspace and ask that one if it is hidden.