Issue 1109 - Support notifications

src/engine/NotificationWindow.h

-#pragma once

[Oleksandr, 2015/06/26 23:05:18]

It is not clear yet if we will ever need such a rich functionality of the whole
rendering engine just to display notifications. Most likely we will only have a
text with link here. For that reusing NotificationMessage class would be better
(by exploiting TTF_PARSELINKS, for example. However we have no idea what our
notifications might look like, so I'm in favor for committing this JIC.

+/*
+ * This file is part of Adblock Plus <https://adblockplus.org/>,
+ * Copyright (C) 2006-2015 Eyeo GmbH
+ *
+ * Adblock Plus 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.
+ *
+ * Adblock Plus is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef NOTIFICATION_WINDOW_H
+#define NOTIFICATION_WINDOW_H
+
 #include <atlbase.h>
 #include <atlwin.h>
 #include <atlctl.h>
 #include <atlimage.h>
 #include <AdblockPlus/JsValue.h>
 #include <AdblockPlus/Notification.h>
 #include <functional>
 #include <MsHtmdid.h>
 
 class IconStaticControl : public ATL::CWindow
@@ skipping 67 matching lines @@
   {
     return m_handle == nullptr;
   }
 protected:
   T m_handle;
 private:
   ScopedObjectHandle(const ScopedObjectHandle&);
   ScopedObjectHandle& operator=(const ScopedObjectHandle&);
 };
 
-class CFont : public ScopedObjectHandle<HFONT>
-{
-public:
-  explicit CFont(HFONT hFont = nullptr) : ScopedObjectHandle(hFont)
-  {
-  }
-
-  void CreateFontIndirect(const LOGFONT* logFontArg, uint32_t dpi)
-  {
-    ATLASSERT(m_handle == nullptr);
-    LOGFONT logFont = *logFontArg;
-    logFont.lfHeight = -MulDiv(dpi, logFont.lfHeight, 72);
-    m_handle = ::CreateFontIndirect(&logFont);
-  }
-};
-
 class CBrush : public ScopedObjectHandle<HBRUSH>
 {
 public:
   explicit CBrush(HBRUSH brush = nullptr) : ScopedObjectHandle(brush)
   {
   }
 
   void CreateSolidBrush(COLORREF crColor)
   {
     ATLASSERT(m_handle == nullptr);
@@ skipping 27 matching lines @@
   {
     return m_hModule;
   }
 private:
   ScopedModule(const ScopedModule&);
   ScopedModule& operator=(const ScopedModule&);
 private:
   HMODULE m_hModule;
 };
 
-typedef ATL::CWinTraits<WS_POPUP | WS_CLIPCHILDREN | WS_CLIPSIBLINGS, WS_EX_TOOLWINDOW | WS_EX_TOPMOST> NotificationWindowStyles;
+class DpiAwareness {
+public:
+  DpiAwareness() : m_dpi(96)
+  {
+  }
+protected:
+  uint32_t DPIAware(uint32_t value) const {
+    return MulDiv(value, m_dpi, 96);
+  }
+  SIZE DPIAware(SIZE value) const {
+    return CSize(DPIAware(value.cx), DPIAware(value.cy));
+  }
+  RECT DPIAware(RECT value) const {
+    return CRect(DPIAware(value.left), DPIAware(value.top), DPIAware(value.right), DPIAware(value.bottom));
+  }
+  uint32_t m_dpi;
+};
+
 enum
 {
   // ID of HTMLDocument ActiveX control, it's used for event binding.
   kHTMLDocumentCtrlID = 101
 };
 
-class NotificationWindow : public ATL::CWindowImpl<NotificationWindow, ATL::CWindow, NotificationWindowStyles>
+class NotificationWindow : public ATL::CWindowImpl<NotificationWindow>
   , ATL::IDispEventImpl<kHTMLDocumentCtrlID, NotificationWindow, &DIID_HTMLDocumentEvents2, &LIBID_MSHTML, 4, 0>
+  , protected DpiAwareness
 {
 public:
   explicit NotificationWindow(const AdblockPlus::Notification& notification, const std::wstring& htmlFileDir);
   ~NotificationWindow();
   BEGIN_MSG_MAP(NotificationWindow)
     if (uMsg == WM_CREATE)
     {
       SetMsgHandled(TRUE);
       lResult = OnCreate(reinterpret_cast<CREATESTRUCT*>(lParam));
       if(IsMsgHandled())
@@ skipping 18 matching lines @@
       if(IsMsgHandled())
         return TRUE;
     }
   END_MSG_MAP()
 
   BEGIN_SINK_MAP(NotificationWindow)
     SINK_ENTRY_EX(kHTMLDocumentCtrlID, DIID_HTMLDocumentEvents2, DISPID_HTMLDOCUMENTEVENTS2_ONCLICK, OnHTMLDocumentClick)
     SINK_ENTRY_EX(kHTMLDocumentCtrlID, DIID_HTMLDocumentEvents2, DISPID_HTMLDOCUMENTEVENTS2_ONSELECTSTART, OnHTMLDocumentSelectStart)
   END_SINK_MAP()
 
-  std::function<void()> destroyed;
-  std::function<void(const std::wstring& url)> linkClicked;
+  void SetOnClick(const std::function<void()>& callback)
+  {
+    m_onClickCallback = callback;
+  }
+  void SetOnLinkClicked(const std::function<void(const std::wstring& url)>& callback)
+  {
+    m_onLinkClickedCallback = callback;
+  }
+  void SetOnClose(const std::function<void()>& callback)
+  {
+    m_onCloseCallback = callback;
+  }
 private:
   LRESULT OnCreate(const CREATESTRUCT* createStruct);
   LRESULT OnCtlColor(UINT msg, WPARAM wParam, LPARAM lParam, BOOL& handled);
   LRESULT OnClick(UINT msg, WPARAM wParam, LPARAM lParam, BOOL& handled);
-  void OnGetMinMaxInfo(MINMAXINFO* minMaxInfo);
   void OnSize(uint32_t wParam, CSize size);
   void OnDestroy();
 
   void __stdcall OnHTMLDocumentClick(IHTMLEventObj* pEvtObj);
   void __stdcall OnHTMLDocumentSelectStart(IHTMLEventObj* pEvtObj);
 
-  void OnFinalMessage(HWND) override;
   void LoadABPIcon();
-  // returns {windowX, windowY} of top left corner on the monitor
-  POINT GetWindowCoordinates();
-
-  uint32_t DPIAware(uint32_t value) const {
-    return MulDiv(value, m_dpi, 96);
-  }
-  SIZE DPIAware(SIZE value) const {
-    return CSize(DPIAware(value.cx), DPIAware(value.cy));
-  }
-  RECT DPIAware(RECT value) const {
-    return CRect(DPIAware(value.left), DPIAware(value.top), DPIAware(value.right), DPIAware(value.bottom));
-  }
-private:
-  uint32_t m_dpi;
+private:
   std::wstring m_htmlPage;
   CBrush m_bgColor;
   ATL::CAxWindow m_axIE;
   ATL::CImage m_iconImg;
   IconStaticControl m_icon;
   std::vector<std::wstring> m_links;
-};
+  std::function<void()> m_onClickCallback;
+  std::function<void()> m_onCloseCallback;
+  std::function<void(const std::wstring& url)> m_onLinkClickedCallback;
+};
+
+typedef ATL::CWinTraits<WS_POPUP | WS_CLIPCHILDREN | WS_CLIPSIBLINGS, WS_EX_TOOLWINDOW | WS_EX_TOPMOST> NotificationBorderWindowStyles;
+class NotificationBorderWindow : public ATL::CWindowImpl<NotificationBorderWindow, ATL::CWindow, NotificationBorderWindowStyles>
+  , protected DpiAwareness
+{
+public:
+  DECLARE_WND_CLASS_EX(/*generate class name*/nullptr, CS_DROPSHADOW, WHITE_BRUSH);
+  NotificationBorderWindow(const AdblockPlus::Notification& notification, const std::wstring& htmlFileDir);
+    BEGIN_MSG_MAP(NotificationWindow)
+    if (uMsg == WM_CREATE)
+    {
+      SetMsgHandled(TRUE);
+      lResult = OnCreate(reinterpret_cast<CREATESTRUCT*>(lParam));
+      if(IsMsgHandled())
+        return TRUE;
+    }
+    MESSAGE_HANDLER(WM_LBUTTONUP, OnClick)
+    MESSAGE_HANDLER(WM_RBUTTONUP, OnClick)
+    if (uMsg == WM_SIZE)
+    {
+      SetMsgHandled(TRUE);
+      OnSize(static_cast<uint32_t>(wParam), CSize(GET_X_LPARAM(lParam), GET_Y_LPARAM(lParam)));
+      lResult = 0;
+      if(IsMsgHandled())
+        return TRUE;
+    }
+  END_MSG_MAP()
+  void SetOnDestroyed(const std::function<void()>& callback)
+  {
+    m_onDestroyedCallback = callback;
+  }
+  void SetOnLinkClicked(const std::function<void(const std::wstring& url)>& callback)
+  {
+    m_content.SetOnLinkClicked(callback);
+  }
+private:
+  LRESULT OnCreate(const CREATESTRUCT* createStruct);
+  void OnSize(uint32_t wParam, CSize size);
+  LRESULT OnClick(UINT msg, WPARAM wParam, LPARAM lParam, BOOL& handled);
+
+  void OnFinalMessage(HWND) override;
+
+  // returns {windowX, windowY} of top left corner on the monitor
+  POINT GetWindowCoordinates();
+private:
+  // m_content is used as a holder of all children and we need it to have a border.
+  // It seems the most correct way to have a border to set WS_POPUPWINDOW style
+  // and paint the border in WM_NCPAINT but it simply does not work here.
+  NotificationWindow m_content;
+  std::function<void()> m_onDestroyedCallback;
+};
+#endif