支持任意数据类型的环形队列

已于 2023-05-29 21:22:54 修改
阅读量410 收藏 5
点赞数 2
分类专栏： 编程之美 文章标签： 开发语言 queue 环形队列
于 2023-01-06 22:32:38 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/sinat_31039061/article/details/128576381
版权

文章目录

一、介绍

一个C语言编写的支持任意类型的环形队列。
代码开源连接：https://github.com/Aladdin-Wang/byte_queue

二、API 接口

#define QUEUE_INIT(__QUEUE, __BUFFER, __BUFFER_SIZE )                           \
            queue_init_byte(__QUEUE, __BUFFER, __BUFFER_SIZE )

#define DEQUEUE(__QUEUE, __ADDR,...)                                            \
            __PLOOC_EVAL(__DEQUEUE_,##__VA_ARGS__)                              \
                (__QUEUE,__ADDR,##__VA_ARGS__)                 

#define ENQUEUE(__QUEUE, __ADDR,...)                                            \
            __PLOOC_EVAL(__ENQUEUE_,##__VA_ARGS__)                              \
                (__QUEUE,__ADDR,##__VA_ARGS__) 

#define PEEK_QUEUE(__QUEUE, __ADDR,...)                                         \
            __PLOOC_EVAL(__PEEK_QUEUE_,##__VA_ARGS__)                           \
                (__QUEUE,__ADDR,##__VA_ARGS__) 

#define IS_ENQUEUE_EMPTY(__QUEUE)                                               \
            is_byte_queue_empty(__QUEUE)

#define RESET_PEEK(__QUEUE)                                                     \
            reset_peek_byte(__QUEUE)

#define GET_ALL_PEEKED(__QUEUE)                                                 \
            get_all_peeked_byte(__QUEUE)

#define GET_PEEK_STATUS(__QUEUE)                                                \
            get_peek_status(__QUEUE)

#define RESTORE_PEEK_STATUS(__QUEUE,__COUNT)                                    \
            restore_peek_status(__QUEUE,__COUNT)

#define GET_QUEUE_COUNT(__QUEUE)                                                \
            get_queue_count(__QUEUE)

extern byte_queue_t * queue_init_byte(byte_queue_t *ptObj, void *pBuffer, uint16_t hwItemSize);
extern bool enqueue_byte(byte_queue_t *ptQueue, uint8_t chByte);
extern int16_t enqueue_bytes(byte_queue_t *ptObj, void *pchByte, uint16_t hwLength);
extern bool dequeue_byte(byte_queue_t *ptQueue, uint8_t *pchByte);
extern int16_t dequeue_bytes(byte_queue_t *ptObj, void *pchByte, uint16_t hwLength);
extern bool is_byte_queue_empty(byte_queue_t *ptQueue);
extern bool peek_byte_queue(byte_queue_t *ptQueue, uint8_t *pchByte);
extern bool reset_peek_byte(byte_queue_t *ptQueue);
extern bool get_all_peeked_byte(byte_queue_t *ptQueue);
extern int16_t peek_bytes_queue(byte_queue_t *ptObj, void *pchByte, uint16_t hwLength);
extern uint16_t get_peek_status(byte_queue_t *ptQueue);
extern bool restore_peek_status(byte_queue_t *ptQueue ,uint16_t hwCount);
extern int16_t get_queue_count(byte_queue_t *ptObj);
extern int16_t get_queue_available_count(byte_queue_t *ptObj);

三、API 说明

1. 初始化队列

QUEUE_INIT(__QUEUE, __BUFFER, __BUFFER_SIZE )

参数说明：

参数名描述
__QUEUE队列的地址
__BUFFER队列缓存的首地址
__BUFFER_SIZE队列长度

初始化队列之前首先需要通过byte_queue_t 结构体定义一个队列对象，和缓冲区的buf。
参考代码：

uint8_t s_cFIFOinBuffer[1024];
static byte_queue_t s_tFIFOin;
QUEUE_INIT(&s_tFIFOin, s_cFIFOinBuffer, sizeof(s_cFIFOinBuffer));

2. 入队

#define ENQUEUE(__QUEUE, __ADDR,...)

参数说明：

参数名描述
__QUEUE队列的地址
__ADDR待入队的数据或者数据的地址
…可变参数，需要入队的数据个数，或者数据类型和个数，如果为空，则只入队一个数据

参考代码：

    typedef struct data_t{
        uint32_t a;
        uint32_t b;
        uint32_t c;
    }data_t;
    
    uint8_t  data1 = 0XAA;
    uint16_t data2 = 0X55AA;
    uint32_t data3 = 0X55AAAA55;
    uint16_t data4[] = {0x1234,0x5678};

    data_t data5 = {
        .a = 0X11223344,
        .b = 0X55667788,
        .c = 0X99AABBCC,
    };
    // 一下三种方式都可以正确存储数组
    ENQUEUE(&s_tFIFOin,data4,2);//可以不指名数据类型
    ENQUEUE(&s_tFIFOin,data4,uint16_t,2);//也可以指名数据类型
    ENQUEUE(&s_tFIFOin,data4,uint8_t,sizeof(data4));//或者用字节类型

    //一下两种方式都可以正确存储结构体类型
    ENQUEUE(&s_tFIFOin,data5);//根据结构体的类型，自动计算结构体的大小
    ENQUEUE(&s_tFIFOin,&data5,uint8_t,sizeof(data5));//也可以以数组方式存储

    ENQUEUE(&s_tFIFOin,(uint8_t)0X11); //常量默认为int型，需要强制转换数据类型
    ENQUEUE(&s_tFIFOin,(uint16_t)0X2233); //常量默认为int型，需要强制转换数据类型
    ENQUEUE(&s_tFIFOin,0X44556677);
    ENQUEUE(&s_tFIFOin,(char)'a');//单个字符也需要强制转换数据类型
    ENQUEUE(&s_tFIFOin,"bc");//字符串默认会存储空字符\0
    ENQUEUE(&s_tFIFOin,"def");//字符串默认会存储空字符\0

3. 出队

DEQUEUE(__QUEUE, __ADDR,...)

参数说明：

参数名描述
__QUEUE队列的地址
__ADDR用于保存出队数据变量的地址
…可变参数，需要出队的数据个数，或者数据类型和个数，如果为空，则只出队一个数据

参考代码：

   uint8_t  data[100];
   uint16_t  data1;
   uint32_t  data2;
// 读出全部数据
   DEQUEUE(&s_tFIFOin,data,GET_QUEUE_COUNT(&my_queue));
   DEQUEUE(&s_tFIFOin,data,uint8_t,GET_QUEUE_COUNT(&my_queue))
// 读一个数据，长度为uint16_t类型
   DEQUEUE(&s_tFIFOin,&data1);
// 读一个数据，长度为uint32_t类型
   DEQUEUE(&s_tFIFOin,&data2);

4. 查看

#define PEEK_QUEUE(__QUEUE, __ADDR,...)

参数说明：

参数名描述
__QUEUE队列的地址
__ADDR用于保存查看数据变量的地址
…可变参数，数据类型和需要查看的数据个数，如果为空，则只查看一个数据

参考代码：

   uint8_t data[32];
   uint16_t  data1;
   uint32_t  data2;
// 查看多个数据
   PEEK_QUEUE(&s_tFIFOin,&data,sizeof(data));   
// 查看一个数据，长度为uint16_t类型
   PEEK_QUEUE(&s_tFIFOin,&data1);
// 查看一个数据，长度为uint32_t类型
   PEEK_QUEUE(&s_tFIFOin,&data2);

5. 其他API

  • 队列是否为空
IS_ENQUEUE_EMPTY(__QUEUE)
  • 复位PEEK
RESET_PEEK(__QUEUE)
  • 出队所有查看的数据
GET_ALL_PEEKED(__QUEUE)
  • 获取PEEK的状态
GET_PEEK_STATUS(__QUEUE)
  • 恢复PEEK的状态
RESTORE_PEEK_STATUS(__QUEUE,__COUNT)
  • 获取队列的数据个数
GET_QUEUE_COUNT(__QUEUE)

四、多类型原理说明

以DEQUEUE(__QUEUE, __ADDR,...) 为例，说明如何做到支持任意类型的数据，和不同个数的参数类型。

#define __DEQUEUE_0( __QUEUE, __ADDR)                                \
            dequeue_bytes((__QUEUE), __ADDR,(sizeof(typeof(*(__ADDR)))))

#define __DEQUEUE_1( __QUEUE, __ADDR, __ITEM_COUNT)                        \
            dequeue_bytes((__QUEUE), (__ADDR), __ITEM_COUNT*(sizeof(typeof((__ADDR[0])))))

#define __DEQUEUE_2( __QUEUE, __ADDR, __TYPE,__ITEM_COUNT)                 \
            dequeue_bytes((__QUEUE), (__ADDR), (__ITEM_COUNT * sizeof(__TYPE)))

#define DEQUEUE(__QUEUE, __ADDR,...)                                            \
            __PLOOC_EVAL(__DEQUEUE_,##__VA_ARGS__)                              \
                (__QUEUE,__ADDR,##__VA_ARGS__)

宏DEQUEUE最终调用的是

int16_t dequeue_bytes(byte_queue_t *ptObj, void *pchByte, uint16_t hwLength);

本队列默认只支持字节类型，而字节是最小单位的数据类型，它可以组合成其他的数据类型，所以只要知道其他数据类型的大小，就可以根据类型的大小，读出相对应类型的数据。
因此只需要利用下边两种技巧便可以达到目的：

获取数据类型
typeof() 是GUN C提供的一种特性，可参考C-Extensions，它可以取得变量的类型，或者表达式的类型。
使用typeof来获取接收地址的类型，然后通过sizeof获取类似的大小，从而确定需要读出的数据长度。
宏的重载
如果看过前边的文章C语言变参函数和可变参数宏，就可以发现这里其实使用的就是宏的重载，宏的重载原理已经在前边文章讲解过了，宏DEQUEUE直接使用了PLOOC已经实现好的__PLOOC_EVAL宏。

五、快速使用

    #include "./queue/byte_queue.h"
    uint8_t  data1 = 0XAA;
    uint16_t data2 = 0X55AA;
    uint32_t data3 = 0X55AAAA55;
    uint16_t data4[] = {0x1234,0x5678};
    typedef struct data_t{
        uint32_t a;
        uint32_t b;
        uint32_t c;
    }data_t;
    data_t data5 = {
        .a = 0X11223344,
        .b = 0X55667788,
        .c = 0X99AABBCC,
    };

    uint8_t  data[100];
    static uint8_t s_hwQueueBuffer[100];
    static byte_queue_t my_queue;

    QUEUE_INIT(&my_queue,s_hwQueueBuffer,sizeof(s_hwQueueBuffer));

    QUEUE_INIT(&my_queue,s_hwQueueBuffer,sizeof(s_hwQueueBuffer));

    ENQUEUE(&my_queue,data1);//根据变量的类型，自动计算对象的大小
    ENQUEUE(&my_queue,data2);
    ENQUEUE(&my_queue,data3);

    // 一下三种方式都可以正确存储数组
    ENQUEUE(&my_queue,data4,2);//可以不指名数据类型
    ENQUEUE(&my_queue,data4,uint16_t,2);//也可以指名数据类型
    ENQUEUE(&my_queue,data4,uint8_t,sizeof(data4));//或者用其他类型

    //一下两种方式都可以正确存储结构体类型
    ENQUEUE(&my_queue,data5);//根据结构体的类型，自动计算对象的大小
    ENQUEUE(&my_queue,&data5,uint8_t,sizeof(data5));//也可以以数组方式存储

    ENQUEUE(&my_queue,(uint8_t)0X11); //常量默认为int型，需要强制转换数据类型
    ENQUEUE(&my_queue,(uint16_t)0X2233); //常量默认为int型，需要强制转换数据类型
    ENQUEUE(&my_queue,0X44556677);
    ENQUEUE(&my_queue,(char)'a');//单个字符也需要强制转换数据类型
    ENQUEUE(&my_queue,"bc");//字符串默认会存储空字符\0
    ENQUEUE(&my_queue,"def");

    // 读出全部数据
    DEQUEUE(&my_queue,data,GET_QUEUE_COUNT(&my_queue));//DEQUEUE(&my_queue,data,uint8_t,GET_QUEUE_COUNT(&my_queue))
WALI-KANG
关注
  • 2
    点赞
  • 踩
  • 5
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
易语言任意自定义数据类型排序
07-23
易语言任意自定义数据类型排序源码,任意自定义数据类型排序,通用排序算法_冒泡,冒泡法数组排序演示,列表框初始化
C语言实现任意数据类型的Queue环形队列RingBuffer
小歆CSDN博客
04-14 961
头文件 fifo.h #ifndef __QUEUE_H_ #define __QUEUE_H_ /********************************************************************* * @brief Queue队列类型定义 *********************************************************************/ typedef struct { unsigned int
裸机中环形队列与RTOS中消息队列的区别
李肖遥的专栏
05-17 359
关注、星标公众号，直达精彩内容来源：strongerhuang“环形队列”和“消息队列”在嵌入式领域有应用非常广泛，相信有经验的嵌入式软件工程师对它们都不陌生。但经常看到一些初学者问一些相关的问题，今天就来分享一下关于“环形队列”和“消息队列”的内容。环形队列环形队列是在实际编程极为有用的数据结构，它是一个首尾相连的FIFO的数据结构，采用数组的线性空间，数据组织...
数据结构(C语言版)环形队列
HandsomeYongYong的博客
10-27 658
环形队列是一种队列数据结构，它与普通队列相似，但在内部实现上有一个特殊之处：队列的尾部指针连接到队列的头部，形成一个循环。
C语言-简单的环形队列的源码示例
最新发布
qq_36075612的博客
02-29 466
一个简单的环形队列的源码示例
【Linux】基于环形队列的生产者消费者模型的实现
Sxy_wspsby的博客
07-03 694
上一篇文章我们讲了信号量的几个接口和基于环形队列的生产者消费者模型，下面我们就快速来实现。
数据结构之线性表中的环形队列接口的实现
狂小伍的博客
11-30 277
环形队列的接口的实现
详解环形队列
m0_61704320的博客
10-27 428
环形队列是一种特殊的队列数据结构，它可以通过循环利用数组中的空间来实现队列的操作。与普通的队列不同，环形队列的队尾指针可以超过数组的末尾，指向数组的开头，形成一个环状结构。一个固定大小的数组，用于存储队列中的元素。一个队头指针，指向队列中的第一个元素。一个队尾指针，指向队列中最后一个元素的下一个位置。队列为空时，队头指针和队尾指针相等。当向队列中添加元素时，队尾指针向后移动，并将元素放入队尾指针指向的位置。当从队列中删除元素时，队头指针向后移动，并返回队头指针指向的元素。
【Linux】生产者消费者模型——环形队列RingQueue（信号量）
weixin_60478154的博客
04-24 883
【Linux】生产消费模型——环形队列RingQueue（信号量）
入门数据结构，c语言实现循环队列实现（详细篇）。
A2202333的博客
11-08 4569
队列中的一个分支循环队列，运用了一些技巧降低了其时间复杂度与空间复杂度，学会循环队列可以帮助更好的学习后面复杂的结构（如：树，二叉树，图等）。
创建任意数据类型的环形缓冲区代码实现
06-11
环形缓冲区 代码实现 任意数据类型
C++基本数据类型总结
01-20
一、整形 　1、整形有char、short、int、long、long long，这5个也默认为signed XX ; 　规则：short至少16位；int至少和short一样；long至少32位，且至少和int一样长；long long至少64位，且至少和long一样长。...
C语言实现存放任意数据类型的线性表和链表
02-02
C语言实现存放任意数据类型的线性表和链表数据结构
详解python变量与数据类型
12-17
这篇文章我们学习 Python 变量与数据类型 变量 变量来源于数学，是计算机语言中能储存计算结果或能表示值抽象概念，变量可以通过变量名访问。在 Python 中 变量命名规定，必须是大小写英文，数字和 下划线(_)的组合...
单片机堆栈分配
热门推荐
sinat_31039061的博客
05-14 1万+
Code：表示程序所占用 FLASH 的大小（FLASH）。 RO-data：即 Read Only-data，表示程序定义的常量，如 const 类型（FLASH）。 RW-data：即 Read Write-data，表示已被初始化的全局变量（SRAM） ZI-data：即 Zero Init-data，表示未被初始化的全局变量(SRAM) 静态数据区（DATA）：保存全局变量和static ...
利用MDK的FLM文件生成通用flash驱动
sinat_31039061的博客
01-08 5542
在进行Flash操作时，一般我们需要设计一套Flash抽象层，至少要包括flash的init，read、write、erase这些操作。但每更换一个单片机或者flash器件就要额外去编写flash驱动去适配init，read、write、erase。尽管有会者不难的属性加持，但适配所有的单片机或者flash器件，工作量也可想而知。本文为大家提供一个适配几乎任意单片机型号的flash驱动，之所以说是几乎，是因为我们这次要借东风，而这个东风就是Keil的FLM文件。
[小技巧]使用vscode和armclang编译器改善keil开发效率
sinat_31039061的博客
10-26 3839
准备工作： 实验平台： 硬件： RT-Thread官方ART-PI H750开发版，正点原子4.3寸RGBLCD屏（800*480） 软件： 最新版本的STM32CubeH7固件库，TouchGFXDesigner v4.14和 STM32CubeMX V6.0.1，开发环境MDK v5.29 代码下载： 联系作者： 加我微信，备注“加群”，加入技术交流群 ...
线程安全和可重入函数
sinat_31039061的博客
09-26 2410
先说结论 可重入函数未必是线程安全的；线程安全函数未必是可重入的。 可重入函数的概念 可重入的程序（函数）允许在执行的过程中被打断，并在打断所执行的代码中再次安全的调用。 若一个函数是可重入的，则该函数应当满足下述条件： 不能含有静态（全局）非常量数据。 不能返回静态（全局）非常量数据的地址。 只能处理由调用者提供的数据。 不能依赖于单实例模式资源的锁。 调用(call)的函数也必需是可重入的。 总之一句话：上述条件就是要求可重入函数使用的所有变量都通过函数的调用者提供。 举例说明，设计一个发送字符串
数组名和函数名是什么东西
sinat_31039061的博客
01-09 2248
数组名和函数名的本质都是一个地址 一、数组a[]中a和&a的区别 看个例子： #include <stdio.h> int main() { int a[5] = { 1,2,3,4,5 }; int *ptr = (int *)(&a + 1); printf("a=0x%x\n", a); printf("&a=0x%x\n", &a); ...
sparksql支持的数据类型
06-10
Spark SQL 支持的数据类型包括基本数据类型和复合数据类型，如下所示： 1. 基本数据类型： - BOOLEAN：布尔类型，取值为 true 或 false； - TINYINT：8 位有符号整型，取值范围为 -128 到 127； - SMALLINT：16 位...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

WALI-KANG

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值