【C语言】调试宏：进阶篇

前言

调试是软件开发过程中不可或缺的一部分。使用宏可以帮助我们在编译时就植入调试信息，从而在运行时捕获关键的数据点或者行为。这些宏通常用于打印变量的值、跟踪函数调用、检查断言等。

基础调试宏

1. 打印变量的值

宏定义

#define DEBUG_PRINT(x) printf("DEBUG: %s = %d\n", #x, x)

使用案例

假设我们有一个简单的函数 `calculate`，它计算两个数的和。
#include <stdio.h>

void calculate(int a, int b) {
    DEBUG_PRINT(a);
    DEBUG_PRINT(b);
    int sum = a + b;
    DEBUG_PRINT(sum);
}

int main() {
    calculate(5, 10);
    return 0;
}

输出
DEBUG: a = 5
DEBUG: b = 10
DEBUG: sum = 15

2. 跟踪函数调用

宏定义

#define FUNCTION_ENTER() printf("Entering function %s\n", __FUNCTION__)
#define FUNCTION_EXIT() printf("Exiting function %s\n", __FUNCTION__)

使用案例

让我们扩展之前的 `calculate` 函数，添加函数调用的跟踪。
#include <stdio.h>

void calculate(int a, int b) {
    FUNCTION_ENTER();
    DEBUG_PRINT(a);
    DEBUG_PRINT(b);
    int sum = a + b;
    DEBUG_PRINT(sum);
    FUNCTION_EXIT();
}

int main() {
    FUNCTION_ENTER();
    calculate(5, 10);
    FUNCTION_EXIT();
    return 0;
}

输出
Entering function main
Entering function calculate
DEBUG: a = 5
DEBUG: b = 10
DEBUG: sum = 15
Exiting function calculate
Exiting function main

进阶调试宏

3. 断言检查

宏定义

#define ASSERT(condition) do { \
    if (!(condition)) { \
        fprintf(stderr, "Assertion failed: %s in %s:%d\n", #condition, __FILE__, __LINE__); \
        abort(); \
    } \
} while (0)

使用案例

现在我们将使用 `ASSERT` 来确保传入 `calculate` 的参数是非负数。
#include <stdio.h>
#include <stdlib.h>

void calculate(int a, int b) {
    FUNCTION_ENTER();
    ASSERT(a >= 0);
    ASSERT(b >= 0);
    DEBUG_PRINT(a);
    DEBUG_PRINT(b);
    int sum = a + b;
    DEBUG_PRINT(sum);
    FUNCTION_EXIT();
}

int main() {
    FUNCTION_ENTER();
    calculate(-5, 10); // This will trigger an assertion failure
    FUNCTION_EXIT();
    return 0;
}

输出
Entering function main
Entering function calculate
Assertion failed: a >= 0 in filename.c:13
Aborted

4. 动态调试级别

宏定义

#ifndef DEBUG_LEVEL
#define DEBUG_LEVEL 0
#endif

#define LOG(level, fmt, ...) do { \
    if (level <= DEBUG_LEVEL) { \
        printf(fmt, ##__VA_ARGS__); \
    } \
} while (0)

#define LOG_INFO(fmt, ...) LOG(1, fmt, ##__VA_ARGS__)
#define LOG_WARNING(fmt, ...) LOG(2, fmt, ##__VA_ARGS__)
#define LOG_ERROR(fmt, ...) LOG(3, fmt, ##__VA_ARGS__)

使用案例

我们可以根据不同的调试级别来控制输出的信息量。
#include <stdio.h>

void calculate(int a, int b) {
    FUNCTION_ENTER();
    LOG_INFO("Calculating with a = %d and b = %d\n", a, b);
    int sum = a + b;
    LOG_INFO("Sum is %d\n", sum);
    FUNCTION_EXIT();
}

int main() {
    FUNCTION_ENTER();
    LOG_INFO("Starting calculation\n");
    calculate(5, 10);
    LOG_INFO("Calculation complete\n");
    FUNCTION_EXIT();
    return 0;
}

设置 `DEBUG_LEVEL` 为 1 来查看 `LOG_INFO` 级别的输出。

输出
Entering function main
Starting calculation
Entering function calculate
Calculating with a = 5 and b = 10
Sum is 15
Exiting function calculate
Calculation complete
Exiting function main

以上就是本篇关于 C 语言调试宏的内容。这些宏可以帮助你在开发过程中更好地理解和追踪你的代码执行情况。请记得，在实际项目中，你应该根据具体需求调整宏的功能，以适应不同的调试要求。