Noissue - Trace life cycle of 'CPluginClass'

src/plugin/PluginClass.cpp

 /*
  * 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
@@ skipping 74 matching lines @@
     int Width() const
     {
       return right - left;
     }
   };
 }
 
 CPluginClass::CPluginClass()
   : m_webBrowser2(nullptr)
 {
+  DEBUG_GENERAL([this]() -> std::wstring
+    {
+      std::wstring s = L"CPluginClass::<constructor>, this = ";
+      s += ToHexLiteral(this);
+      return s;
+    }());
+
   //Use this line to debug memory leaks
   //    _CrtDumpMemoryLeaks();
 
   m_isAdvised = false;
   m_hTabWnd = NULL;
   m_hStatusBarWnd = NULL;
   m_hPaneWnd = NULL;
   m_nPaneWidth = 0;
   m_pWndProcStatus = NULL;
   m_hTheme = NULL;
   m_isInitializedOk = false;
 
 
   m_tab = new CPluginTab(this);
 
   Dictionary::Create(GetBrowserLanguage());
 }
 
 CPluginClass::~CPluginClass()
 {
+  DEBUG_GENERAL([this]() -> std::wstring
+    {
+      std::wstring s = L"CPluginClass::<destructor>, this = ";
+      s += ToHexLiteral(this);
+      return s;
+    }());
+
   delete m_tab;
 }
 
 HWND CPluginClass::GetBrowserHWND() const
 {
   if (!m_webBrowser2)
   {
     DEBUG_ERROR_LOG(0, 0, 0, "CPluginClass::GetBrowserHWND - Reached with m_webBrowser2 == nullptr");
     return nullptr;
   }
@@ skipping 65 matching lines @@
  * 'unknownSite' will be null. Extraordinarily, this is sometimes _not_ called when IE
  * is shutting down. Thus 'SetSite(nullptr)' has some similarities with a destructor,
  * but it is not a proper substitute for one.
  */
 STDMETHODIMP CPluginClass::SetSite(IUnknown* unknownSite)
 {
   try
   {
     if (unknownSite)
     {
-
-      DEBUG_GENERAL(L"================================================================================\nNEW TAB UI\n================================================================================")
+      DEBUG_GENERAL(L"================================================================================\nNEW TAB UI\n================================================================================");
 
       HRESULT hr = ::CoInitialize(NULL);
       if (FAILED(hr))
       {
         DEBUG_ERROR_LOG(hr, PLUGIN_ERROR_SET_SITE, PLUGIN_ERROR_SET_SITE_COINIT, "Class::SetSite - CoInitialize");
       }
 
       /*
        * We were instantiated as a BHO, so our site is always of type IWebBrowser2.
        */
       m_webBrowser2 = ATL::CComQIPtr<IWebBrowser2>(unknownSite);
       if (!m_webBrowser2)
       {
         throw std::logic_error("CPluginClass::SetSite - Unable to convert site pointer to IWebBrowser2*");
       }
+      DEBUG_GENERAL([this]() -> std::wstring
+        {
+          std::wstringstream ss;
+          ss << L"CPluginClass::SetSite, this = " << ToHexLiteral(this);
+          ss << L", browser = " << ToHexLiteral(m_webBrowser2);
+          return ss.str();
+        }());
 
       //register the mimefilter
       //and only mimefilter
       //on some few computers the mimefilter does not get properly registered when it is done on another thread
       s_criticalSectionLocal.Lock();
       {
         // Always register on startup, then check if we need to unregister in a separate thread
         s_mimeFilter = CPluginClientFactory::GetMimeFilterClientInstance();
         s_asyncWebBrowser2 = unknownSite;
         s_instances.insert(this);
       }
       s_criticalSectionLocal.Unlock();
 
       try
       {
-        DEBUG_GENERAL("Loaded as BHO");
         HRESULT hr = DispEventAdvise(m_webBrowser2);
         if (SUCCEEDED(hr))
         {
           m_isAdvised = true;
           try
           {
             std::thread startInitObjectThread(StartInitObject, this);
             startInitObjectThread.detach(); // TODO: but actually we should wait for the thread in the dtr.
           }
           catch (const std::system_error& ex)
           {
             DEBUG_SYSTEM_EXCEPTION(ex, PLUGIN_ERROR_THREAD, PLUGIN_ERROR_MAIN_THREAD_CREATE_PROCESS, 
               "Class::Thread - Failed to create StartInitObject thread");
           }
         }
         else
         {
           DEBUG_ERROR_LOG(hr, PLUGIN_ERROR_SET_SITE, PLUGIN_ERROR_SET_SITE_ADVICE, "Class::SetSite - Advise");
         }
       }
       catch (const std::runtime_error& ex)
       {
         DEBUG_EXCEPTION(ex);
         Unadvise();
       }
     }
     else
     {
+      DEBUG_GENERAL([this]() -> std::wstring
+      {
+        std::wstringstream ss;
+        ss << L"CPluginClass::SetSite, this = " << ToHexLiteral(this);
+        ss << L", browser = nullptr";
+        return ss.str();
+      }());
+
       Unadvise();
 
       // Destroy window
       if (m_pWndProcStatus)
       {
         ::SetWindowLongPtr(m_hStatusBarWnd, GWLP_WNDPROC, (LPARAM)(WNDPROC)m_pWndProcStatus);
 
         m_pWndProcStatus = NULL;
       }
 
@@ skipping 1362 matching lines @@
   s_criticalSectionLocal.Unlock();
 
   return icon;
 }
 
 ATOM CPluginClass::GetAtomPaneClass()
 {
   return s_atomPaneClass;
 }