uthash项目中的utstack：C语言侵入式栈宏详解-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00954/article/details/148527026

uthash项目中的utstack：C语言侵入式栈宏详解

uthash C macros for hash tables and more 项目地址: https://gitcode.com/gh_mirrors/ut/uthash

引言

在C语言开发中，数据结构是构建高效程序的基础。uthash项目提供的utstack.h头文件包含了一组简洁而强大的栈操作宏，为C开发者提供了轻量级的栈实现方案。本文将深入解析这些宏的使用方法、实现原理和最佳实践。

什么是utstack

utstack是uthash项目中的一部分，提供了一组侵入式栈操作的宏定义。所谓"侵入式"，是指数据结构节点本身包含了指向下一个节点的指针，这与传统容器将数据与结构分离的设计不同。

主要特性

极简实现：仅需一个头文件
高效操作：所有核心操作都是O(1)时间复杂度
跨平台：支持Linux、Mac OS X和Windows等主流平台
类型安全：基于C语言的类型系统
灵活配置：支持自定义next指针字段名

基本使用方法

头文件引入

#include "utstack.h"

栈结构定义

栈的节点需要包含一个指向同类型节点的next指针：

typedef struct element {
    /* 你的数据字段 */
    struct element *next;  // 必须包含next指针
} element;

栈初始化

栈头指针必须初始化为NULL：

element *stack = NULL;  // 重要：必须初始化为NULL

核心操作宏

utstack提供了以下基本操作宏：

| 宏名称 | 功能描述 | 时间复杂度 | |--------|----------|------------| | STACK_PUSH(stack, add) | 将元素压入栈顶 | O(1) | | STACK_POP(stack, elt) | 弹出栈顶元素并保存到elt | O(1) | | STACK_COUNT(stack, tmp, count) | 计算栈中元素数量 | O(n) | | STACK_TOP(stack) | 获取栈顶元素 | O(1) | | STACK_EMPTY(stack) | 判断栈是否为空 | O(1) |

参数说明

stack: 栈头指针
add: 要压入栈的元素指针
elt: 用于接收弹出元素的指针变量
tmp: 临时指针变量（与元素同类型）
count: 用于接收元素数量的整型变量

实际应用示例

下面是一个完整的示例程序，演示了如何使用utstack宏：

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "utstack.h"

#define MAX_NAME_LEN 50

typedef struct person {
    char name[MAX_NAME_LEN];
    struct person *next;
} person;

int main() {
    person *stack = NULL;  // 栈初始化
    person *p, *tmp;
    int count;
    
    // 压入三个人员信息
    p = (person*)malloc(sizeof(person));
    strcpy(p->name, "Alice");
    STACK_PUSH(stack, p);
    
    p = (person*)malloc(sizeof(person));
    strcpy(p->name, "Bob");
    STACK_PUSH(stack, p);
    
    p = (person*)malloc(sizeof(person));
    strcpy(p->name, "Charlie");
    STACK_PUSH(stack, p);
    
    // 获取栈大小
    STACK_COUNT(stack, tmp, count);
    printf("Stack size: %d\n", count);
    
    // 弹出并打印所有元素
    while (!STACK_EMPTY(stack)) {
        printf("Popping: %s\n", STACK_TOP(stack)->name);
        STACK_POP(stack, p);
        free(p);
    }
    
    return 0;
}

高级用法：自定义next字段名

如果你的结构体中使用的是非标准的next指针字段名，可以使用带"2"后缀的宏版本：

typedef struct custom_element {
    char data[100];
    struct custom_element *link;  // 非标准next字段名
} custom_element;

// 使用带2的宏版本
custom_element *custom_stack = NULL;
custom_element *ce = malloc(sizeof(custom_element));
STACK_PUSH2(custom_stack, ce, link);  // 指定字段名为link

对应的宏包括：