src/Utils/DebugOutput.h

   1 // TortoiseGit - a Windows shell extension for easy version control
   2
   3 // Copyright (C) 2009, 2011, 2013-2014 - TortoiseSVN
   4
   5 // This program is free software; you can redistribute it and/or
   6 // modify it under the terms of the GNU General Public License
   7 // as published by the Free Software Foundation; either version 2
   8 // of the License, or (at your option) any later version.
   9
  10 // This program is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14
  15 // You should have received a copy of the GNU General Public License
  16 // along with this program; if not, write to the Free Software Foundation,
  17 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 //
  19 #pragma once
  20 #include "registry.h"
  21
  22
  23 class CTraceToOutputDebugString
  24 {
  25 public:
  26         static CTraceToOutputDebugString& Instance()
  27         {
  28                 if (!m_pInstance)
  29                         m_pInstance = new CTraceToOutputDebugString;
  30                 return *m_pInstance;
  31         }
  32
  33         static bool Active()
  34         {
  35                 return Instance().m_bActive;
  36         }
  37
  38         // Non Unicode output helper
  39         void operator()(PCSTR pszFormat, ...)
  40         {
  41                 if (m_bActive)
  42                 {
  43                         va_list ptr;
  44                         va_start(ptr, pszFormat);
  45                         TraceV(pszFormat,ptr);
  46                         va_end(ptr);
  47                 }
  48         }
  49
  50         // Unicode output helper
  51         void operator()(PCWSTR pszFormat, ...)
  52         {
  53                 if (m_bActive)
  54                 {
  55                         va_list ptr;
  56                         va_start(ptr, pszFormat);
  57                         TraceV(pszFormat,ptr);
  58                         va_end(ptr);
  59                 }
  60         }
  61
  62 private:
  63         CTraceToOutputDebugString()
  64         {
  65                 m_LastTick = GetTickCount64();
  66                 m_bActive = !!CRegStdDWORD(_T("Software\\TortoiseGit\\DebugOutputString"), FALSE);
  67         }
  68         ~CTraceToOutputDebugString()
  69         {
  70                 delete m_pInstance;
  71         }
  72         // prevent cloning
  73         CTraceToOutputDebugString(const CTraceToOutputDebugString&);
  74         CTraceToOutputDebugString& operator=(const CTraceToOutputDebugString&);
  75
  76         ULONGLONG m_LastTick;
  77         bool    m_bActive;
  78         static CTraceToOutputDebugString * m_pInstance;
  79
  80         // Non Unicode output helper
  81         void TraceV(PCSTR pszFormat, va_list args) const
  82         {
  83                 // Format the output buffer
  84                 char szBuffer[1024];
  85                 _vsnprintf_s(szBuffer, _countof(szBuffer), _countof(szBuffer)-1, pszFormat, args);
  86                 OutputDebugStringA(szBuffer);
  87         }
  88
  89         // Unicode output helper
  90         void TraceV(PCWSTR pszFormat, va_list args) const
  91         {
  92                 wchar_t szBuffer[1024];
  93                 _vsnwprintf_s(szBuffer, _countof(szBuffer), _countof(szBuffer)-1, pszFormat, args);
  94                 OutputDebugStringW(szBuffer);
  95         }
  96
  97         bool IsActive()
  98         {
  99 #ifdef DEBUG
 100                 return true;
 101 #else
 102                 if (GetTickCount64() - m_LastTick > 10000UL)
 103                 {
 104                         m_LastTick = GetTickCount64();
 105                         m_bActive = !!CRegStdDWORD(_T("Software\\TortoiseGit\\DebugOutputString"), FALSE);
 106                 }
 107                 return m_bActive;
 108 #endif
 109         }
 110 };