Я хотел бы сделать функцию регистрации отладки с теми же параметрами, что и printf. Но тот, который может быть удален предварительным процессором во время оптимизированных сборок.
Например:
Debug_Print("Warning: value %d > 3!\n", value);
Я рассмотрел переменные макросы, но они недоступны на всех платформах. gcc поддерживает их, msvc не делает.
Я все еще делаю это по-старому, определяя макрос (XTRACE, ниже), который коррелирует либо с вызовом no-op, либо с вызовом функции с переменным списком аргументов. Внутри вызовите vsnprintf, чтобы сохранить синтаксис printf:
#include <stdio.h>
void XTrace0(LPCTSTR lpszText)
{
::OutputDebugString(lpszText);
}
void XTrace(LPCTSTR lpszFormat, ...)
{
va_list args;
va_start(args, lpszFormat);
int nBuf;
TCHAR szBuffer[512]; // get rid of this hard-coded buffer
nBuf = _vsnprintf(szBuffer, 511, lpszFormat, args);
::OutputDebugString(szBuffer);
va_end(args);
}
Затем типичный переключатель #ifdef:
#ifdef _DEBUG
#define XTRACE XTrace
#else
#define XTRACE
#endif
Хорошо, что можно немного почистить, но это основная идея.
Вот как я делаю debug print out в С++. Определите 'dout' (debug out) следующим образом:
#ifdef DEBUG
#define dout cout
#else
#define dout 0 && cout
#endif
В коде я использую 'dout' так же, как 'cout'.
dout << "in foobar with x= " << x << " and y= " << y << '\n';
Если препроцессор заменяет "dout" на "0 && cout 'обратите внимание, что < имеет более высокий приоритет, чем && и оценка короткого замыкания && делает всю строку оценкой равной 0. Поскольку 0 не используется, компилятор не генерирует никакого кода для этой строки.
Здесь что-то, что я делаю в C/С++. Во-первых, вы пишете функцию, которая использует материал varargs (см. Ссылку в публикации Stu). Затем сделайте что-то вроде этого:
int debug_printf( const char *fmt, ... );
#if defined( DEBUG )
#define DEBUG_PRINTF(x) debug_printf x
#else
#define DEBUG_PRINTF(x)
#endif
DEBUG_PRINTF(( "Format string that takes %s %s\n", "any number", "of args" ));
Все, что вам нужно запомнить, это использовать двойные парсеры при вызове функции отладки, и вся строка будет удалена в коде, отличном от DEBUG.
Еще один интересный способ вытеснить вариативные функции:
#define function sizeof
@CodingTheWheel:
Есть одна небольшая проблема с вашим подходом. Рассмотрим вызов типа
XTRACE("x=%d", x);
Это прекрасно работает в сборке отладки, но в сборке релизов он будет расширяться до:
("x=%d", x);
Это совершенно законный C и будет компилироваться и обычно запускаться без побочных эффектов, но генерирует ненужный код. Подход, который я обычно использую, чтобы устранить эту проблему:
Сделайте функцию XTrace возвратой int (просто верните 0, возвращаемое значение не имеет значения)
Измените #define в предложении #else на:
0 && XTrace
Теперь версия выпуска будет расширяться до:
0 && XTrace("x=%d", x);
и любой достойный оптимизатор выбросит все это, поскольку оценка короткого замыкания предотвратит что-либо после && & от когда-либо выполняемых.
Конечно, так же, как я написал это последнее предложение, я понял, что, возможно, исходная форма также может быть оптимизирована, а в случае побочных эффектов, таких как вызовы функций, переданные в качестве параметров XTrace, это может быть лучшее решение так как он гарантирует, что версии отладки и выпуска будут вести себя одинаково.
А, vsprintf() - это то, чего я не хватало. Я могу использовать это, чтобы передать список аргументов переменных непосредственно printf():
#include <stdarg.h>
#include <stdio.h>
void DBG_PrintImpl(char * format, ...)
{
char buffer[256];
va_list args;
va_start(args, format);
vsprintf(buffer, format, args);
printf("%s", buffer);
va_end(args);
}
Затем заверните все это в макрос.
В С++ вы можете использовать оператор потоковой передачи для упрощения:
#if defined _DEBUG
class Trace
{
public:
static Trace &GetTrace () { static Trace trace; return trace; }
Trace &operator << (int value) { /* output int */ return *this; }
Trace &operator << (short value) { /* output short */ return *this; }
Trace &operator << (Trace &(*function)(Trace &trace)) { return function (*this); }
static Trace &Endl (Trace &trace) { /* write newline and flush output */ return trace; }
// and so on
};
#define TRACE(message) Trace::GetTrace () << message << Trace::Endl
#else
#define TRACE(message)
#endif
и используйте его как:
void Function (int param1, short param2)
{
TRACE ("param1 = " << param1 << ", param2 = " << param2);
}
Затем вы можете реализовать персонализированный вывод трассировки для классов почти так же, как и для вывода на std::cout.
Частью проблемы с такой функциональностью является то, что она часто требует переменные макросы. Они были сравнительно недавно стандартизированы (C99), и старые компиляторы C не поддерживают стандарт или имеют собственную специальную работу вокруг.
Ниже заголовок отладки, который я написал, имеет несколько интересных функций:
Примечание. По какой-то причине у меня были некоторые проблемы с форматированием кода.
#ifndef _DEBUG_H_
#define _DEBUG_H_
#if HAVE_CONFIG_H
#include "config.h"
#endif
#include "stdarg.h"
#include "stdio.h"
#define ENABLE 1
#define DISABLE 0
extern FILE* debug_fd;
int debug_file_init(char *file);
int debug_file_close(void);
#if HAVE_C99
#define PRINT(x, format, ...) \
if ( x ) { \
if ( debug_fd != NULL ) { \
fprintf(debug_fd, format, ##__VA_ARGS__); \
} \
else { \
fprintf(stdout, format, ##__VA_ARGS__); \
} \
}
#else
void PRINT(int enable, char *fmt, ...);
#endif
#if _DEBUG
#if HAVE_C99
#define DEBUG(x, format, ...) \
if ( x ) { \
if ( debug_fd != NULL ) { \
fprintf(debug_fd, "%s : %d " format, __FILE__, __LINE__, ##__VA_ARGS__); \
} \
else { \
fprintf(stderr, "%s : %d " format, __FILE__, __LINE__, ##__VA_ARGS__); \
} \
}
#define DEBUGPRINT(x, format, ...) \
if ( x ) { \
if ( debug_fd != NULL ) { \
fprintf(debug_fd, format, ##__VA_ARGS__); \
} \
else { \
fprintf(stderr, format, ##__VA_ARGS__); \
} \
}
#else /* HAVE_C99 */
void DEBUG(int enable, char *fmt, ...);
void DEBUGPRINT(int enable, char *fmt, ...);
#endif /* HAVE_C99 */
#else /* _DEBUG */
#define DEBUG(x, format, ...)
#define DEBUGPRINT(x, format, ...)
#endif /* _DEBUG */
#endif /* _DEBUG_H_ */
Посмотрите на эту тему:
Он должен ответить на ваш вопрос.
На каких платформах они недоступны? stdarg является частью стандартной библиотеки:
http://www.opengroup.org/onlinepubs/009695399/basedefs/stdarg.h.html
Любая платформа, не предоставляющая ее, не является стандартной реализацией C (или очень, очень старой). Для них вам придется использовать varargs:
http://opengroup.org/onlinepubs/007908775/xsh/varargs.h.html
Сегодня, столкнувшись с проблемой, моим решением является следующий макрос:
static TCHAR __DEBUG_BUF[1024]
#define DLog(fmt, ...) swprintf(__DEBUG_BUF, fmt, ##__VA_ARGS__); OutputDebugString(__DEBUG_BUF)
Вы можете вызвать функцию следующим образом:
int value = 42;
DLog(L"The answer is: %d\n", value);
Это то, что я использую:
inline void DPRINTF(int level, char *format, ...)
{
# ifdef _DEBUG_LOG
va_list args;
va_start(args, format);
if(debugPrint & level) {
vfprintf(stdout, format, args);
}
va_end(args);
# endif /* _DEBUG_LOG */
}
который абсолютно не стоит во время выполнения, когда флаг _DEBUG_LOG выключен.
Это версия пользовательского ответа TCHAR, поэтому она будет работать как ASCII (обычный), или в режиме Unicode (более или менее).
#define DEBUG_OUT( fmt, ...) DEBUG_OUT_TCHAR( \
TEXT(##fmt), ##__VA_ARGS__ )
#define DEBUG_OUT_TCHAR( fmt, ...) \
Trace( TEXT("[DEBUG]") #fmt, \
##__VA_ARGS__ )
void Trace(LPCTSTR format, ...)
{
LPTSTR OutputBuf;
OutputBuf = (LPTSTR)LocalAlloc(LMEM_ZEROINIT, \
(size_t)(4096 * sizeof(TCHAR)));
va_list args;
va_start(args, format);
int nBuf;
_vstprintf_s(OutputBuf, 4095, format, args);
::OutputDebugString(OutputBuf);
va_end(args);
LocalFree(OutputBuf); // tyvm @sam shaw
}
Я говорю "более или менее", потому что он не будет автоматически преобразовывать строковые аргументы ASCII в WCHAR, но он должен вытащить вас из большинства сборок Unicode, не беспокоясь об обертывании строки формата в TEXT() или предыдущем это с L.
В основном получена из MSDN: получение кода последней ошибки