Issue 1672 - Subscribe and listen COM events using ATL::IDispEventImpl and BEGIN_SINK_MAP

src/plugin/PluginClass.h

Index: src/plugin/PluginClass.h
diff --git a/src/plugin/PluginClass.h b/src/plugin/PluginClass.h
index db0a801bcda9b27c5d842bbf0fd67056201e9b05..13ef25eae3c0ea998e2d34a8655fded4410d81b2 100644
--- a/src/plugin/PluginClass.h
+++ b/src/plugin/PluginClass.h
@@ -15,177 +15,187 @@
  * along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/*
-* http://msdn.microsoft.com/en-us/library/bb250436.aspx
-*/
-
-#ifndef _PLUGIN_CLASS_H_
-#define _PLUGIN_CLASS_H_
-
-
-#include "Plugin.h"
-#include "PluginTabBase.h"
-#define _CRTDBG_MAP_ALLOC
-#include <stdlib.h>
-#include <crtdbg.h>
-#include <set>
-
-#include "NotificationMessage.h"
-
-#define ICON_PLUGIN_DISABLED 0
-#define ICON_PLUGIN_ENABLED 1
-#define ICON_PLUGIN_DEACTIVATED 2
-#define ICON_MAX 3
-
-#define WM_LAUNCH_INFO					(WM_APP + 10)
-
-class CPluginMimeFilterClient;
-
-
-class ATL_NO_VTABLE CPluginClass :
-  public CComObjectRootEx<CComMultiThreadModel>,
-  public CComCoClass<CPluginClass, &CLSID_PluginClass>,
-  public IObjectWithSiteImpl<CPluginClass>,
-  public IDispatchImpl<IIEPlugin, &IID_IIEPlugin, &LIBID_PluginLib>,
-  public IOleCommandTarget
-{
-
-  friend class CPluginTab;
-
-private:
-
-  CPluginTab* m_tab;
-
-public:
-
-  DECLARE_REGISTRY_RESOURCEID(IDR_PLUGIN_CLASS)
-
-  DECLARE_PROTECT_FINAL_CONSTRUCT()
-
-  BEGIN_COM_MAP(CPluginClass)
-    COM_INTERFACE_ENTRY(IIEPlugin)
-    COM_INTERFACE_ENTRY(IDispatch)
-    COM_INTERFACE_ENTRY(IObjectWithSite)
-    COM_INTERFACE_ENTRY(IOleCommandTarget)
-  END_COM_MAP()
-
-  CPluginClass();
-  ~CPluginClass();
-
-  HRESULT FinalConstruct();
-  void FinalRelease();
-
-  // IObjectWithSite
-
-  STDMETHOD(SetSite)(IUnknown *pUnkSite);
-
-  // IOleCommandTarget
-
-  STDMETHOD(QueryStatus)(const GUID* pguidCmdGroup, ULONG cCmds, OLECMD prgCmds[], OLECMDTEXT* pCmdText);
-  STDMETHOD(Exec)(const GUID*, DWORD nCmdID, DWORD, VARIANTARG*, VARIANTARG* pvaOut);
-
-  // IDispatch
-
-  STDMETHOD(Invoke)(DISPID dispidMember,REFIID riid, LCID lcid, WORD wFlags,
-    DISPPARAMS * pdispparams, VARIANT * pvarResult,EXCEPINFO * pexcepinfo, UINT * puArgErr);
-
-  static CPluginTab* GetTab(DWORD dwThreadId);
-  CPluginTab* GetTab();
-
-  void UpdateStatusBar();
-  static DWORD WINAPI MainThreadProc(LPVOID pParam);
-
-private:
-
-  bool SetMenuBar(HMENU hMenu, const std::wstring& url);
-  HMENU CreatePluginMenu(const std::wstring& url);
-
-  void DisplayPluginMenu(HMENU hMenu, int nToolbarCmdID, POINT pt, UINT nMenuFlags);
-  bool CreateStatusBarPane();
-
-  CComPtr<IConnectionPoint> GetConnectionPoint();
-
-public:
-  HWND GetBrowserHWND() const;
-  HWND GetTabHWND() const;
-  CComQIPtr<IWebBrowser2> GetBrowser() const;
-
-  STDMETHODIMP OnTabChanged(DISPPARAMS* pDispParams, WORD wFlags);
-
-  static CPluginMimeFilterClient* s_mimeFilter;
-
-private:
-
-  std::wstring GetBrowserUrl() const;
-
-  static DWORD WINAPI StartInitObject(LPVOID thisPtr);
-  bool InitObject(bool bBHO);
-  void CloseTheme();
-  void UpdateTheme();
-
-  static HICON GetStatusBarIcon(const std::wstring& url);
-  static CPluginClass* FindInstance(HWND hStatusBarWnd);
-  static LRESULT CALLBACK NewStatusProc(HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam);
-  static LRESULT CALLBACK PaneWindowProc(HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam);
-  static void FirstRunThread();
-  void BeforeNavigate2(DISPPARAMS* pDispParams);
-
-  void Unadvice();
-
-  void ShowStatusBar();
-  bool IsStatusBarEnabled();
-
-public:
-  CComQIPtr<IWebBrowser2> m_webBrowser2;
-private:
-  DWORD m_nConnectionID;
-  HWND m_hBrowserWnd;
-  HWND m_hTabWnd;
-  HWND m_hStatusBarWnd;
-  HWND m_hPaneWnd;
-  
-  WNDPROC m_pWndProcStatus;
-  int m_nPaneWidth;
-  HANDLE m_hTheme;
-
-  CriticalSection m_csStatusBar;
-
-  NotificationMessage notificationMessage;
-
-  bool m_isAdviced;
-  bool m_isInitializedOk;
-
-  // Atom pane class
-  static ATOM s_atomPaneClass;
-
-  static ATOM GetAtomPaneClass();
-
-  // Icons
-  static HICON s_hIcons[ICON_MAX];
-  static DWORD s_hIconTypes[ICON_MAX];
-
-  static HICON GetIcon(int type);
-
-  // Main thread
-  static HANDLE s_hMainThread;
-  static bool s_isMainThreadDone;
-
-  static HANDLE GetMainThreadHandle();
-  static bool IsMainThreadDone(HANDLE mainThread);
-
-  static HINSTANCE s_hUxtheme;
-  static std::set<CPluginClass*> s_instances;
-  static std::map<DWORD,CPluginClass*> s_threadInstances;
-  static CComAutoCriticalSection s_criticalSectionLocal;
-  static CComAutoCriticalSection s_criticalSectionBrowser;
-  static CComAutoCriticalSection s_criticalSectionWindow;
-
-  // Async browser
-  static CComQIPtr<IWebBrowser2> s_asyncWebBrowser2;
-  static CComQIPtr<IWebBrowser2> GetAsyncBrowser();
-};
-
-OBJECT_ENTRY_AUTO(__uuidof(PluginClass), CPluginClass)
-
-
-#endif // _PLUGIN_CLASS_H_
+/*
+* http://msdn.microsoft.com/en-us/library/bb250436.aspx
+*/
+
+#ifndef _PLUGIN_CLASS_H_
+#define _PLUGIN_CLASS_H_
+
+
+#include "Plugin.h"
+#include "PluginTabBase.h"
+#define _CRTDBG_MAP_ALLOC
+#include <stdlib.h>
+#include <crtdbg.h>
+#include <set>
+
+#include "NotificationMessage.h"
+
+#define ICON_PLUGIN_DISABLED 0
+#define ICON_PLUGIN_ENABLED 1
+#define ICON_PLUGIN_DEACTIVATED 2
+#define ICON_MAX 3
+
+#define WM_LAUNCH_INFO					(WM_APP + 10)
+
+class CPluginMimeFilterClient;
+
+
+class ATL_NO_VTABLE CPluginClass :
+  public ATL::CComObjectRootEx<ATL::CComMultiThreadModel>,
+  public ATL::CComCoClass<CPluginClass, &CLSID_PluginClass>,
+  public ATL::IObjectWithSiteImpl<CPluginClass>,
+  public IOleCommandTarget,
+  public ATL::IDispEventImpl<1, CPluginClass, &DIID_DWebBrowserEvents2, &LIBID_SHDocVw, 1, 1>
+{
+
+  friend class CPluginTab;
+
+private:
+
+  CPluginTab* m_tab;
+
+public:
+
+  DECLARE_REGISTRY_RESOURCEID(IDR_PLUGIN_CLASS)
+
+  DECLARE_PROTECT_FINAL_CONSTRUCT()
+
+  BEGIN_COM_MAP(CPluginClass)
+    COM_INTERFACE_ENTRY(IObjectWithSite)
+    COM_INTERFACE_ENTRY(IOleCommandTarget)
+  END_COM_MAP()
+
+  BEGIN_SINK_MAP(CPluginClass)
+    SINK_ENTRY_EX(1, DIID_DWebBrowserEvents2, DISPID_BEFORENAVIGATE2, OnBeforeNavigate2)
+    SINK_ENTRY_EX(1, DIID_DWebBrowserEvents2, DISPID_DOWNLOADCOMPLETE, OnDownloadComplete)
+    SINK_ENTRY_EX(1, DIID_DWebBrowserEvents2, DISPID_DOCUMENTCOMPLETE, OnDocumentComplete)
+    SINK_ENTRY_EX(1, DIID_DWebBrowserEvents2, DISPID_WINDOWSTATECHANGED, OnWindowStateChanged)
+    SINK_ENTRY_EX(1, DIID_DWebBrowserEvents2, DISPID_COMMANDSTATECHANGE, OnCommandStateChange)
+    SINK_ENTRY_EX(1, DIID_DWebBrowserEvents2, DISPID_ONQUIT, OnOnQuit)
+  END_SINK_MAP()
+
+  CPluginClass();
+  ~CPluginClass();
+
+  HRESULT FinalConstruct();
+  void FinalRelease();
+
+  // IObjectWithSite
+
+  STDMETHOD(SetSite)(IUnknown *pUnkSite);
+
+  // IOleCommandTarget
+
+  STDMETHOD(QueryStatus)(const GUID* pguidCmdGroup, ULONG cCmds, OLECMD prgCmds[], OLECMDTEXT* pCmdText);
+  STDMETHOD(Exec)(const GUID*, DWORD nCmdID, DWORD, VARIANTARG*, VARIANTARG* pvaOut);
+
+
+  static CPluginTab* GetTab(DWORD dwThreadId);
+  CPluginTab* GetTab();
+
+  void UpdateStatusBar();
+  static DWORD WINAPI MainThreadProc(LPVOID pParam);
+
+private:
+
+  bool SetMenuBar(HMENU hMenu, const std::wstring& url);
+  HMENU CreatePluginMenu(const std::wstring& url);
+
+  void DisplayPluginMenu(HMENU hMenu, int nToolbarCmdID, POINT pt, UINT nMenuFlags);
+  bool CreateStatusBarPane();
+
+public:
+  HWND GetBrowserHWND() const;
+  HWND GetTabHWND() const;
+  CComQIPtr<IWebBrowser2> GetBrowser() const;
+
+
+  static CPluginMimeFilterClient* s_mimeFilter;
+
+private:
+
+  std::wstring GetBrowserUrl() const;
+
+  static DWORD WINAPI StartInitObject(LPVOID thisPtr);
+  bool InitObject(bool bBHO);
+  void CloseTheme();
+  void UpdateTheme();
+
+  static HICON GetStatusBarIcon(const std::wstring& url);
+  static CPluginClass* FindInstance(HWND hStatusBarWnd);
+  static LRESULT CALLBACK NewStatusProc(HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam);
+  static LRESULT CALLBACK PaneWindowProc(HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam);
+  static void FirstRunThread();
+
+  void STDMETHODCALLTYPE OnBeforeNavigate2(/* [in] */ IDispatch* pDisp,
+                         /* [in] */ VARIANT* URL,
+                         /* [in] */ VARIANT* Flags,
+                         /* [in] */ VARIANT* TargetFrameName,
+                         /* [in] */ VARIANT* PostData,
+                         /* [in] */ VARIANT* Headers,
+                         /* [in, out] */ VARIANT_BOOL* Cancel);
+  void STDMETHODCALLTYPE OnDownloadComplete();
+  void STDMETHODCALLTYPE OnDocumentComplete(IDispatch* frameBrowserDisp, VARIANT* /*urlOrPidl*/);
+  void STDMETHODCALLTYPE OnWindowStateChanged(unsigned long flags, unsigned long validFlagsMask);
+  void STDMETHODCALLTYPE OnCommandStateChange(long command, VARIANT_BOOL enable);
+  void STDMETHODCALLTYPE OnOnQuit();
+  void Unadvise();
+
+  void ShowStatusBar();
+  bool IsStatusBarEnabled();
+
+public:
+  CComQIPtr<IWebBrowser2> m_webBrowser2;
+private:
+  HWND m_hBrowserWnd;
+  HWND m_hTabWnd;
+  HWND m_hStatusBarWnd;
+  HWND m_hPaneWnd;
+  
+  WNDPROC m_pWndProcStatus;
+  int m_nPaneWidth;
+  HANDLE m_hTheme;
+
+  CriticalSection m_csStatusBar;
+
+  NotificationMessage notificationMessage;
+
+  bool m_isAdvised;
+  bool m_isInitializedOk;
+
+  // Atom pane class
+  static ATOM s_atomPaneClass;
+
+  static ATOM GetAtomPaneClass();
+
+  // Icons
+  static HICON s_hIcons[ICON_MAX];
+  static DWORD s_hIconTypes[ICON_MAX];
+
+  static HICON GetIcon(int type);
+
+  // Main thread
+  static HANDLE s_hMainThread;
+  static bool s_isMainThreadDone;
+
+  static HANDLE GetMainThreadHandle();
+  static bool IsMainThreadDone(HANDLE mainThread);
+
+  static HINSTANCE s_hUxtheme;
+  static std::set<CPluginClass*> s_instances;
+  static std::map<DWORD,CPluginClass*> s_threadInstances;
+  static CComAutoCriticalSection s_criticalSectionLocal;
+  static CComAutoCriticalSection s_criticalSectionBrowser;
+  static CComAutoCriticalSection s_criticalSectionWindow;
+
+  // Async browser
+  static CComQIPtr<IWebBrowser2> s_asyncWebBrowser2;
+  static CComQIPtr<IWebBrowser2> GetAsyncBrowser();
+};
+
+OBJECT_ENTRY_AUTO(__uuidof(PluginClass), CPluginClass)
+
+
+#endif // _PLUGIN_CLASS_H_