/********************************************************************************************************
 *
 *该程序实现链式队列元素的增删改查，目的是提高设计程序的逻辑思维，另外为了提高可移植性，所以链式队列中元素
 *的数据类型为DataType_t，用户可以根据实际情况修改链式队列中元素的类型。
 *
 *另外，为了方便管理链式队列,所以用户设计LQueue_t结构体，该结构体中包含两个成员：结点的数据域+结点的指针域
 *
 *以链表作为基础来实现队列的操作，可以避免内存浪费以及避免内存成片移动，只需要确定队头和队尾即可，一般把链表头部作为队头，可以实现头删，把链表尾部作为队尾，可以实现尾插。
 *
 * Copyright (c)  2023-2024   a1583839363@163.com   All right Reserved
 * ******************************************************************************************************/

#include <stdio.h>
#include <stdbool.h>
#include <stdlib.h>

// 指的是链式队列中的结点有效数据类型，用户可以根据需要进行修改
typedef int DataType_t;

// 构造链式队列的结点,其中所有结点的数据类型应该是相同的
typedef struct LinkedQueue
{
    DataType_t data;          // 结点的数据域
    struct LinkedQueue *next; // 结点的指针域

} LQueue_t;

// 创建一个空链式队列，空链式队列应该有一个头结点，对链表进行初始化
LQueue_t *LQueue_Create(void)
{
    // 1.创建一个头结点并对头结点申请内存
    LQueue_t *Head = (LQueue_t *)calloc(1, sizeof(LQueue_t));
    if (NULL == Head)
    {
        perror("Calloc memory for Head is Failed");
        exit(-1);
    }

    // 2.对头结点进行初始化，头结点是不存储有效内容的！！！
    Head->next = NULL;

    // 3.把头结点的地址返回即可
    return Head;
}

// 创建新的结点，并对新结点进行初始化（数据域 + 指针域）
LQueue_t *LQueue_NewNode(DataType_t data)
{
    // 1.创建一个新结点并对新结点申请内存
    LQueue_t *New = (LQueue_t *)calloc(1, sizeof(LQueue_t));
    if (NULL == New)
    {
        perror("Calloc memory for NewNode is Failed");
        return NULL;
    }

    // 2.对新结点的数据域和指针域进行初始化
    New->data = data;
    New->next = NULL;

    return New;
}

// 入队
bool LQueue_Enqueue(LQueue_t *Head, DataType_t data)
{
    // 1.创建新的结点，并对新结点进行初始化
    LQueue_t *New = LQueue_NewNode(data);
    if (NULL == New)
    {
        printf("can not insert new node\n");
        return false;
    }

    // 2.判断链式队列是否为空，如果为空，则直接入队即可
    if (NULL == Head->next)
    {
        Head->next = New;
        return true;
    }

    // 3.如果链式队列为非空，则把新结点入队到链式队列的队尾
    LQueue_t *Last = Head;
    while (Last->next != NULL)
    {
        Last = Last->next;
    }
    Last->next = New;

    return true;
}

// 出队
bool LQueue_Dequeue(LQueue_t *Head)
{
    // 1.对链式队列的首结点的地址进行备份
    LQueue_t *Temp = Head->next;
    // 2.判断链式队列是否为空，如果为空，则直接退出
    if (NULL == Head->next)
    {
        return false;
    }
    // 3.链式队列非空，则直接出队
    Head->next = Temp->next;
    Temp->next = NULL;
    free(Temp);

    return true;
}

// 遍历
void LQueue_Print(LQueue_t *Head)
{
    // 对链式队列的头结点的地址进行备份
    LQueue_t *Phead = Head;

    // 首结点
    while (Phead->next)
    {
        // 把头的直接后继作为新的头结点
        Phead = Phead->next;

        // 输出头结点的直接后继的数据域
        printf("data = %d\n", Phead->data);
    }
}

int main(int argc, char const *argv[])
{
    LQueue_t *Head = LQueue_Create();
    LQueue_Enqueue(Head, 1);
    LQueue_Enqueue(Head, 2);
    LQueue_Enqueue(Head, 3);
    LQueue_Dequeue(Head);
    LQueue_Print(Head);

    return 0;
}