C++（Windows）的OutputDebugString 封装-CSDN博客

本文链接：https://blog.csdn.net/stallion5632/article/details/125612626

文章目录

0. 引言

在Windows平台上，OutputDebugString函数是一个非常便捷的调试工具，它允许将调试信息输出到调试器（如Visual Studio的输出窗口）中。本文将介绍如何封装OutputDebugString函数。

OutputDebugString是Windows API中的一个函数，其原型为：

void OutputDebugString(
  LPCTSTR lpOutputString
);

它用于向调试器输出一个空字符结尾的字符串。在实际应用中，我们通常会使用OutputDebugStringA（多字节字符集版本）或OutputDebugStringW（宽字符集版本），具体取决于要输出的字符串类型。

1. 现有问题

在实际开发中，我们可能会遇到以下问题：

OutputDebugString函数只接受一个C风格字符串作为参数，不支持像printf那样的格式化输出。
使用不同字符类型时，需要调用不同的函数，如OutputDebugStringA和OutputDebugStringW，

为了解决上述问题，我们的封装设计应该具备以下特点：

支持类似于printf的格式化输出，便于输出各种类型的调试信息。
自动选择适当的字符类型版本（char或wchar_t），根据编译配置自动判断。
使用现代C++技术管理内存，确保代码的安全性和效率。

2. 封装实现

设计一个通用的OutputDebugStringEx函数，用于替代直接调用OutputDebugString系列函数。

#include <Windows.h>
#include <memory>
#include <cstdio>
#include <cstdarg>

// 通用版本的OutputDebugStringEx模板
template<typename CharType>
void OutputDebugStringEx(const CharType* format, ...)
{
    va_list args;
    va_start(args, format);
    
    int length;
    
    if constexpr (std::is_same_v<CharType, wchar_t>) {
        // 处理宽字符版本
        length = _vscwprintf(format, args) + 1; // 获取格式化后字符串的长度
    } else {
        // 处理窄字符版本
        length = _vscprintf(format, args) + 1;
    }

    std::unique_ptr<CharType[]> buffer(new CharType[length]);

    if constexpr (std::is_same_v<CharType, wchar_t>) {
        // 格式化宽字符字符串
        vswprintf_s(buffer.get(), length, format, args);
    } else {
        // 格式化窄字符字符串
        vsnprintf_s(buffer.get(), length, _TRUNCATE, format, args);
    }

    va_end(args);
    
    // 输出调试信息
    if constexpr (std::is_same_v<CharType, wchar_t>) {
        OutputDebugStringW(buffer.get()); // 使用宽字符版本
    } else {
        OutputDebugStringA(buffer.get()); // 使用窄字符版本
    }
}

// 定义wchar_t*版本的宏
#define OutputDebugStringExW(fmt, ...) OutputDebugStringEx<wchar_t>(fmt, __VA_ARGS__)

// 定义char*版本的宏
#define OutputDebugStringExA(fmt, ...) OutputDebugStringEx<char>(fmt, __VA_ARGS__)

// 测试代码
int main()
{
  OutputDebugStringExW(L"DEBUG_INFO | %d %s\r\n", 1234, L"this is test 这是一个测试 by kandy(wchar_t*)");
  OutputDebugStringExA("DEBUG_INFO | %d %s\r\n", 5678, "this is test 这是一个测试 by kandy(char*)");
    
    // 如果需要输出到控制台或文件，可以通过OutputDebugStringEx扩展功能
    
    system("pause");
    
    return 0;
}