Issue #1234 - Rework strings in debug facility

src/plugin/Config.h

 /*
  * 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 _CONFIG_H
 #define _CONFIG_H
 
 #define TIMER_THREAD_SLEEP_TAB_LOOP 10000
 
 // Should we to on debug information
 #ifdef _DEBUG
 #define ENABLE_DEBUG_INFO
 #define ENABLE_DEBUG_GENERAL
 #define ENABLE_DEBUG_ERROR
-#undef  ENABLE_DEBUG_BLOCKER
-#undef  ENABLE_DEBUG_FILTER
-#undef  ENABLE_DEBUG_SETTINGS
-#undef  ENABLE_DEBUG_THREAD
-#undef  ENABLE_DEBUG_NAVI
-#undef  ENABLE_DEBUG_DICTIONARY
-#undef  ENABLE_DEBUG_CHECKSUM
-#undef  ENABLE_DEBUG_INI
-#undef  ENABLE_DEBUG_MUTEX
-#undef  ENABLE_DEBUG_HIDE_EL
-#undef  ENABLE_DEBUG_WHITELIST
 
 #define ENABLE_DEBUG_RESULT
 #define ENABLE_DEBUG_RESULT_IGNORED
 #define ENABLE_DEBUG_SPLIT_FILE
 #else
 #undef ENABLE_DEBUG_INFO
 #endif
 
 #ifdef NDEBUG
 #undef ENABLE_DEBUG_INFO
 #endif
 
 #undef ENABLE_DEBUG_SELFTEST
 
 #define DEBUG_FUNC CPluginDebug::Debug
-#define DEBUG_ERROR_FUNC CPluginDebug::DebugError
-#define DEBUG_ERROR_CODE_FUNC CPluginDebug::DebugErrorCode
 
 #if (defined ENABLE_DEBUG_INFO && defined ENABLE_DEBUG_GENERAL)
-#undef  DEBUG_GENERAL
 #define DEBUG_GENERAL(x) DEBUG_FUNC(x);
-#endif
-
-#if (defined ENABLE_DEBUG_INFO)
-#undef  DEBUG
-#define DEBUG(x) DEBUG_FUNC(x);
-#endif
-
-#if (defined ENABLE_DEBUG_INFO && defined ENABLE_DEBUG_BLOCKER)
-#undef  DEBUG_BLOCKER
-#define DEBUG_BLOCKER(x) DEBUG_FUNC(x);
+#else
+#define DEBUG_GENERAL(x)
 #endif
 
 #if (defined ENABLE_DEBUG_INFO && defined ENABLE_DEBUG_FILTER)
-#undef  DEBUG_FILTER
 #define DEBUG_FILTER(x) DEBUG_FUNC(x);
+#else
+#define DEBUG_FILTER(x)
 #endif
 
 #if (defined ENABLE_DEBUG_INFO && defined ENABLE_DEBUG_SETTINGS)
-#undef  DEBUG_SETTINGS
 #define DEBUG_SETTINGS(x) DEBUG_FUNC(x);
+#else
+#define DEBUG_SETTINGS(x)
 #endif
 
 #if (defined ENABLE_DEBUG_INFO && defined ENABLE_DEBUG_THREAD)
-#undef  DEBUG_THREAD
 #define DEBUG_THREAD(x) DEBUG_FUNC(x);
+#else
+#define DEBUG_THREAD(x)
 #endif
 
 #if (defined ENABLE_DEBUG_INFO && defined ENABLE_DEBUG_NAVI)
-#undef  DEBUG_NAVI
 #define DEBUG_NAVI(x) DEBUG_FUNC(x);
-#endif
-
-#if (defined ENABLE_DEBUG_INFO && defined ENABLE_DEBUG_CHECKSUM)
-#undef  DEBUG_CHECKSUM
-#define DEBUG_CHECKSUM(x) DEBUG_FUNC(x);
-#endif
-
-#if (defined ENABLE_DEBUG_INFO && defined ENABLE_DEBUG_DICTIONARY)
-#undef  DEBUG_DICTIONARY
-#define DEBUG_DICTIONARY(x) DEBUG_FUNC(x);
-#endif
-
-#if (defined ENABLE_DEBUG_INFO && defined ENABLE_DEBUG_INI)
-#undef  DEBUG_INI
-#define DEBUG_INI(x) DEBUG_FUNC(x);
+#else
+#define DEBUG_NAVI(x)
 #endif
 
 #if (defined ENABLE_DEBUG_INFO && defined ENABLE_DEBUG_MUTEX)
-#undef  DEBUG_MUTEX
 #define DEBUG_MUTEX(x) DEBUG_FUNC(x);
+#else
+#define DEBUG_MUTEX(x)
 #endif
 
 #if (defined ENABLE_DEBUG_INFO && defined ENABLE_DEBUG_HIDE_EL)
-#undef  DEBUG_HIDE_EL
 #define DEBUG_HIDE_EL(x) DEBUG_FUNC(x);
-#endif
-
-#if (defined ENABLE_DEBUG_INFO && defined ENABLE_DEBUG_WHITELIST)
-#undef  DEBUG_WHITELIST
-#define DEBUG_WHITELIST(x) DEBUG_FUNC(x);
+#else
+#define DEBUG_HIDE_EL(x)
 #endif
 
 #if (defined ENABLE_DEBUG_INFO && defined ENABLE_DEBUG_ERROR)
-#undef  DEBUG_ERROR
-#define DEBUG_ERROR(x) DEBUG_ERROR_FUNC("!!! Error:" + CString(x));
-#undef  DEBUG_ERROR_CODE
-#define DEBUG_ERROR_CODE(err, x) DEBUG_ERROR_CODE_FUNC(err, "!!! Error:" + CString(x));
-#undef  DEBUG_ERROR_CODE_EX
-#define DEBUG_ERROR_CODE_EX(err, x, process, thread) DEBUG_ERROR_CODE_FUNC(err, "!!! Error:" + CString(x), process, thread);
+#define DEBUG_EXCEPTION(x) CPluginDebug::DebugException(x)
+#define DEBUG_ERROR_CODE(err, x) CPluginDebug::DebugErrorCode(err, x);
+#define DEBUG_ERROR_CODE_EX(err, x, process, thread) CPluginDebug::DebugErrorCode(err, x, process, thread);
+#else
+#define DEBUG_EXCEPTION(x)
+#define DEBUG_ERROR_CODE(err, x)
+#define DEBUG_ERROR_CODE_EX(err, x, process, thread)
 #endif
 
-#undef  DEBUG_ERROR_LOG
-#define DEBUG_ERROR_LOG(err, id, subid, description) CPluginClient::LogPluginError(err, id, subid, description);
+#define DEBUG_ERROR_LOG(err, id, subid, description) CPluginClientBase::PostPluginError(err, id, subid, description);

[sergei, 2015/02/25 13:53:31]

Why is it changed from Log to Post?

[Eric, 2015/02/25 15:24:46]

The change is both a clarification and an optimization.

The optimization: The implementation of 'LogPluginError' has seven arguments,
the last three with default values. The fifth argument, 'isAsync', defaults to
false and controls flow within the function. This macro, not specifying the
value, uses the default. With the default value, the only behavior of
'LogPluginError' is to call 'PostPluginError'.

The clarification: In other words, use of this macro always uses the log queue.

[sergei, 2015/02/25 15:51:23]

Clear.
However, I would say that impl of `CPluginClientBase::LogPluginError` is
incorrect regarding `isAsync` because it should queue it if `isAsync` is true.
Anyway, it's not related to this issue, so it's OK.

[Eric, 2015/02/25 16:14:00]

Yes, I agree. The sense of 'isAsync' is backwards. 

In another pending review, these functions are part of the rump of
'CPluginClientBase' which is getting renamed to 'LogQueue'. That queue object
needs a rewrite, and we'll fix this naming issue then, likely by eliminating the
argument entirely with a new class structure with separate functions for
synchronous and asynchronous reporting.

+#define DEBUG_SYSTEM_EXCEPTION(ex, id, subid, description) CPluginDebug::DebugSystemException(ex, id, subid, description)
+#define DEBUG_SELFTEST(x)
 
 // ----------------------------------------------------------------------------
 // Miscellaneous
 // ----------------------------------------------------------------------------
 
-//For debugging production build
-//#define ENABLE_DEBUG_INFO
-
-// If defined, we will surround most of the methods with try catch
-#undef CATCHALL
-
-// If defined, we will throw exceptions for errors
-// Otherwise we will try to handle it in a silent way, and only report
-#undef THROW_ON_ERROR
-
 // Status bar pane name
 #define STATUSBAR_PANE_NAME L"AdblockPlusStatusBarPane"
 
 // Status bar pane number
 #define STATUSBAR_PANE_NUMBER 2
 
 #define ENGINE_STARTUP_TIMEOUT 10000
 
 
 
 #endif // _CONFIG_H