Make File-Picker modal on Linux

ui/views/widget/desktop_aura/desktop_window_tree_host_x11.cc

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "ui/views/widget/desktop_aura/desktop_window_tree_host_x11.h"
 
 #include <X11/Xatom.h>
 #include <X11/Xregion.h>
 #include <X11/Xutil.h>
 #include <X11/extensions/XInput2.h>
@@ skipping 14 matching lines @@
 #include "ui/aura/window_property.h"
 #include "ui/base/dragdrop/os_exchange_data_provider_aurax11.h"
 #include "ui/base/hit_test.h"
 #include "ui/base/ime/input_method.h"
 #include "ui/base/x/x11_util.h"
 #include "ui/base/x/x11_util_internal.h"
 #include "ui/events/devices/x11/device_data_manager_x11.h"
 #include "ui/events/devices/x11/device_list_cache_x11.h"
 #include "ui/events/devices/x11/touch_factory_x11.h"
 #include "ui/events/event_utils.h"
+#include "ui/events/null_event_targeter.h"
 #include "ui/events/platform/platform_event_source.h"
 #include "ui/events/platform/x11/x11_event_source.h"
 #include "ui/gfx/display.h"
 #include "ui/gfx/geometry/insets.h"
 #include "ui/gfx/geometry/size_conversions.h"
 #include "ui/gfx/image/image_skia.h"
 #include "ui/gfx/image/image_skia_rep.h"
 #include "ui/gfx/path.h"
 #include "ui/gfx/path_x11.h"
 #include "ui/gfx/screen.h"
@@ skipping 101 matching lines @@
       break;
     if (child_windows)
       XFree(child_windows);
     window = parent_win;
   }
   return result;
 }
 
 }  // namespace
 
+DesktopWindowTreeHostX11::ScopedHandle::ScopedHandle(const base::Closure&
+    destroy_callback)
+    : destroy_callback_(destroy_callback) {
+}
+
+void DesktopWindowTreeHostX11::ScopedHandle::CancelCallback() {
+  if (!destroy_callback_.is_null())
+    destroy_callback_.Reset();
+}
+
+DesktopWindowTreeHostX11::ScopedHandle::~ScopedHandle() {
+  if (!destroy_callback_.is_null())
+    destroy_callback_.Run();
+}
+
 ////////////////////////////////////////////////////////////////////////////////
 // DesktopWindowTreeHostX11, public:
 
 DesktopWindowTreeHostX11::DesktopWindowTreeHostX11(
     internal::NativeWidgetDelegate* native_widget_delegate,
     DesktopNativeWidgetAura* desktop_native_widget_aura)
     : xdisplay_(gfx::GetXDisplay()),
       xwindow_(0),
       x_root_window_(DefaultRootWindow(xdisplay_)),
       atom_cache_(xdisplay_, kAtomsToCache),
       window_mapped_(false),
       is_fullscreen_(false),
       is_always_on_top_(false),
       use_native_frame_(false),
       should_maximize_after_map_(false),
       use_argb_visual_(false),
       drag_drop_client_(NULL),
       native_widget_delegate_(native_widget_delegate),
       desktop_native_widget_aura_(desktop_native_widget_aura),
       content_window_(NULL),
       window_parent_(NULL),
       custom_window_shape_(false),
       urgency_hint_set_(false),
       activatable_(true),
+      modal_dialog_xid_(0),
+      scoped_handle_(NULL),
       close_widget_factory_(this) {
 }
 
 DesktopWindowTreeHostX11::~DesktopWindowTreeHostX11() {
   window()->ClearProperty(kHostForRootWindow);
   aura::client::SetWindowMoveClient(window(), NULL);
   desktop_native_widget_aura_->OnDesktopWindowTreeHostDestroyed(this);
   DestroyDispatcher();
 }
 
@@ skipping 141 matching lines @@
   drag_drop_client_ = new DesktopDragDropClientAuraX11(
       window(), cursor_manager, xdisplay_, xwindow_);
   drag_drop_client_->Init();
   return base::WrapUnique(drag_drop_client_);
 }
 
 void DesktopWindowTreeHostX11::Close() {
   // TODO(erg): Might need to do additional hiding tasks here.
   delayed_resize_task_.Cancel();
 
+  // We should cancel the callback function when trying to close
+  // the host window while opening the file-picker, which allows
+  // to invalidate weak pointers of |close_widget_factory_|.
+  if (targeter_for_modal_)
+    scoped_handle_->CancelCallback();

[joone, 2016/04/21 20:45:45]

I added CancelCallback method to fix the problem that the file-picker is not
closed when trying to close the host window while opening the file-picker. The
reason is that |close_widget_factory_| has weak pointers at this situation so
the CloseNow callback cannot be called.

[sadrul, 2016/05/11 05:27:47]

I am not sure I understand this well. What happens if we don't do this
CancelCallback()?

[joone, 2016/05/11 19:18:05]

This file-pick is still opened after closing the host window. Then, the instance
of the host window is still alive after closing the file-picker. 

[sadrul, 2016/05/11 19:20:36]

If this host-window is closed, then that would invalidate the weak-ptr to this
DWTHX11 object, and the callback would not be run when the file-dialog is
closed.
?? Not sure what this means.

+
   if (!close_widget_factory_.HasWeakPtrs()) {
     // And we delay the close so that if we are called from an ATL callback,
     // we don't destroy the window before the callback returned (as the caller
     // may delete ourselves on destroy and the ATL callback would still
     // dereference us when the callback returns).
     base::MessageLoop::current()->PostTask(
         FROM_HERE,
         base::Bind(&DesktopWindowTreeHostX11::CloseNow,
                    close_widget_factory_.GetWeakPtr()));
   }
@@ skipping 1169 matching lines @@
   if (g_current_capture && g_current_capture != this &&
       event->type() == ui::ET_TOUCH_PRESSED) {
     ConvertEventToDifferentHost(event, g_current_capture);
     g_current_capture->SendEventToProcessor(event);
   } else {
     SendEventToProcessor(event);
   }
 }
 
 void DesktopWindowTreeHostX11::DispatchKeyEvent(ui::KeyEvent* event) {
-  GetInputMethod()->DispatchKeyEvent(event);
+  if (native_widget_delegate_->AsWidget()->IsActive())
+    GetInputMethod()->DispatchKeyEvent(event);
 }
 
 void DesktopWindowTreeHostX11::ConvertEventToDifferentHost(
     ui::LocatedEvent* located_event,
     DesktopWindowTreeHostX11* host) {
   DCHECK_NE(this, host);
   const gfx::Display display_src =
       gfx::Screen::GetScreen()->GetDisplayNearestWindow(window());
   const gfx::Display display_dest =
       gfx::Screen::GetScreen()->GetDisplayNearestWindow(host->window());
@@ skipping 474 matching lines @@
   return gfx::ToEnclosingRect(rect_in_dip);
 }
 
 gfx::Rect DesktopWindowTreeHostX11::ToPixelRect(
     const gfx::Rect& rect_in_dip) const {
   gfx::RectF rect_in_pixels = gfx::RectF(rect_in_dip);
   GetRootTransform().TransformRect(&rect_in_pixels);
   return gfx::ToEnclosingRect(rect_in_pixels);
 }
 
+XID DesktopWindowTreeHostX11::GetModalDialog() {
+  return modal_dialog_xid_;
+}
+
+std::unique_ptr<DesktopWindowTreeHostX11::ScopedHandle>
+    DesktopWindowTreeHostX11::DisableEventListening(XID dialog) {
+  DCHECK(dialog);
+  DCHECK(!modal_dialog_xid_);
+  modal_dialog_xid_ = dialog;
+  // ScopedWindowTargeter is used to temporarily replace the event-targeter
+  // with NullEventTargeter to make |dialog| modal.
+  targeter_for_modal_.reset(new aura::ScopedWindowTargeter(window(),
+      std::unique_ptr<ui::EventTargeter>(new ui::NullEventTargeter)));
+
+  scoped_handle_ = new DesktopWindowTreeHostX11::ScopedHandle(
+      base::Bind(&DesktopWindowTreeHostX11::EnableEventListening,
+      close_widget_factory_.GetWeakPtr()));
+  return base::WrapUnique(scoped_handle_);
+}
+
+void DesktopWindowTreeHostX11::EnableEventListening() {
+  DCHECK(modal_dialog_xid_);
+  modal_dialog_xid_ = 0;
+  targeter_for_modal_.reset();
+}
+
 ////////////////////////////////////////////////////////////////////////////////
 // DesktopWindowTreeHost, public:
 
 // static
 DesktopWindowTreeHost* DesktopWindowTreeHost::Create(
     internal::NativeWidgetDelegate* native_widget_delegate,
     DesktopNativeWidgetAura* desktop_native_widget_aura) {
   return new DesktopWindowTreeHostX11(native_widget_delegate,
                                       desktop_native_widget_aura);
 }
 
 // static
 ui::NativeTheme* DesktopWindowTreeHost::GetNativeTheme(aura::Window* window) {
   const views::LinuxUI* linux_ui = views::LinuxUI::instance();
   if (linux_ui) {
     ui::NativeTheme* native_theme = linux_ui->GetNativeTheme(window);
     if (native_theme)
       return native_theme;
   }
 
   return ui::NativeThemeAura::instance();
 }
 
 }  // namespace views