Issue #3432 - Manage COM events with a resource class

src/plugin/PluginClass.h

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
- * Copyright (C) 2006-2015 Eyeo GmbH
+ * Copyright (C) 2006-2016 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.
  *
@@ skipping 43 matching lines @@
   CComPtr<Source> producer;
 public:
   /**
    * \throw std::runtime_error
    *   If connection is not established
    *
    * \par Precondition
    *   - consumer is not nullptr (not checked)
    *   - producer is not nullptr (not checked)
    */
   AtlEventRegistration(Sink* consumer, Source* producer)

[sergei, 2016/02/04 13:45:50]

Just noticed, it would be better to call them as listener and source
respectively, because the domain is events.

[Eric, 2016/02/04 17:00:28]

Neither pair of words "source/sink" and "listener/source" is particularly great
English. "Consume/produce" is better. If you'd like to get into the fine points
of English connotation, I can expound.

[sergei, 2016/02/04 19:41:57]

I think we should not write the code how it would be written by Shakespeare.
There is a common terms in certain domains and we should stay with that terms to
have the code maintainable.

Terms "consumer" and "producer" better fit producer–consumer problem, which is
about transferring data from producer to consumer using different types of
shared buffers.

Terms "listener" and "source" or "sender" better fit to the events domain.
Compare the frequency of usage
https://github.com/search?l=cpp&q=event+producer+consumer&ref=searchresults&t...
https://github.com/search?l=cpp&q=event+listener+source&ref=searchresults&typ...
https://github.com/search?l=cpp&q=event+listener+sender&ref=searchresults&typ...

[Eric, 2016/02/04 20:13:25]

We've entered bikeshedding territory here. You have a personal preference that
differs from mine.

Suggestion rejected.

     : consumer(consumer), producer(producer)
   {
     auto hr = consumer->DispEventAdvise(producer);
     if (FAILED(hr))
     {
       DEBUG_ERROR_LOG(hr, PLUGIN_ERROR_SET_SITE, PLUGIN_ERROR_SET_SITE_ADVICE, "AtlEventRegistrationImpl::<constructor> - Advise");
       throw std::runtime_error("DispEventAdvise() failed");
     }
   }
 
@@ skipping 45 matching lines @@
       return false;
     }
     return true;
   }
 
   void Stop() // noexcept
   {
     impl.reset();
   }
 };
-
 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;
 
@@ skipping 24 matching lines @@
   ~CPluginClass();
 
   // 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);
+  static CPluginTab* GetTabForCurrentThread();
   CPluginTab* GetTab();
 
   void UpdateStatusBar();
 
 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);
@@ skipping 72 matching lines @@
   static DWORD s_hIconTypes[ICON_MAX];
 
   static HICON GetIcon(int type);
 
   // Main thread
   static HANDLE s_hMainThread;
   static bool s_isMainThreadDone;
 
   static HINSTANCE s_hUxtheme;
   static std::set<CPluginClass*> s_instances;
-  static std::map<DWORD,CPluginClass*> s_threadInstances;
   static CComAutoCriticalSection s_criticalSectionLocal;
   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_