手把手写数据结构之单向循环链表操作

/**************************头文件***************************/

#ifndef _LINK_H_
#define _LINK_H_

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


#define Test(arg)     if(arg == NULL){\
        printf("Invalid arg!\n");\
        return -1;\
    }

/*单链表的实现可以各有不同，只要该实现，符合链表的定义即可。
 *单链表最重要的数据结构是元素结点，
 *最重要的操作是插入结点,删除结点和遍历。
 *其它的操作基本上是这3个操作的组合，依据具体的要求而定。
*/

/*切记作为非空循环链表: 恒成立(tail->next == head)*/

/*******************************************
*单向循环链表结点信息
*
*数据域:    可以是普通类型,也可以是封装类型
*指针域:    next指针
*
*********************************************/
typedef struct node
{
    int num;            //数据域
    struct node *next;    //指针域
}NODE;

/*******************************************
*单向循环链表信息
*
*链表的属性信息: 链表的作用描述，链表当前节点个数等等
*指针信息:        一般必须有表头指针，也可以有尾结点指针
*
*********************************************/
typedef struct list_info
{
    int max;            //结点个数
    NODE *head;            //头结点指针
    NODE *tail;            //尾结点指针
}LIST_INFO;


/*******************************************
*Des:    单向循环链表初始化操作，即创建链表
*Ret:    成功返回0，失败返回-1
*********************************************/
int Init_Link(LIST_INFO **plist);


/*******************************************
*Des:    判断链表是否为空
*Ret:    真空返回1，假空返回0
*********************************************/
int IS_Empty_Link(LIST_INFO *plist);

/*******************************************
*Des:    清空链表
*Ret:    成功返回0， 失败返回-1
*********************************************/
int Empty_Link(LIST_INFO *plist);

/*******************************************
*Des:    插入结点到表头(与在表尾操作类似)
*Ret:    成功返回0，失败返回-1
*********************************************/
int Insert_to_Head(LIST_INFO *plist, int num);

/*******************************************
*Des:    删除数据域为num的结点
*Ret:    成功返回0，失败返回-1
*********************************************/
int Delete_Node_Num(LIST_INFO *plist, int num);



/*******************************************
*Des:    销毁链表
*Ret:    成功返回0，失败返回-1
*********************************************/
int Destory_Link(LIST_INFO **plist);

/*******************************************
*Des:    遍历链表
*Ret:    成功返回0，失败返回-1
*********************************************/
int Traverse_Link(LIST_INFO *plist);

#endif



/*************************循环链表API接口函数实现*************************/


#include "sc_link.h"

/*******************************************
*Des:    创建结点
*Ret:    成功返回结点，失败返回NULL
*********************************************/
static NODE *__Create_Node__(int num)
{
    NODE *new_node = (NODE *)malloc(sizeof(NODE));
    if(NULL == new_node)
    {
        perror("Create Node");
        return NULL;
    }

    new_node->next = NULL;
    new_node->num = num;

    return new_node;
}


/*******************************************
*Des:    单向循环链表初始化操作，即创建链表
*Ret:    成功返回0，失败返回-1
*********************************************/
int Init_Link(LIST_INFO ** plist)
{
    Test(plist);//参数有效性检测

    //创建链表
    *plist = (LIST_INFO *)malloc(sizeof(LIST_INFO));
    if(NULL == *plist)
    {
        perror("Create List");
        return -1;
    }

    //初始化链表
    (*plist)->head = (*plist)->tail = NULL;
    (*plist)->max = 0;

    return 0;
}

/*******************************************
*Des:    判断链表是否为空
*Ret:    真空返回1，假空返回0
*********************************************/
int IS_Empty_Link(LIST_INFO *plist)
{
    return (NULL == plist->head);
}

/*******************************************
*Des:    清空链表
*Ret:    成功返回0， 失败返回-1
*********************************************/
int Empty_Link(LIST_INFO *plist)
{
    Test(plist);//参数有效性检测

    //判断是否已经为空
    if(IS_Empty_Link(plist))
    {
        printf("The list is empty!\n");
        return -1;
    }

    NODE *fnode = NULL, *pnode = plist->head;
    while(plist->tail != pnode)
    {
        fnode = pnode;
        pnode = pnode->next;
        free(fnode);
    }
    fnode = plist->tail;
    free(fnode);

    plist->head = plist->tail = NULL;
    plist->max = 0;
    
    return 0;
}

/*******************************************
*Des:    销毁链表
*Ret:    成功返回0，失败返回-1
*********************************************/
int Destory_Link(LIST_INFO **plist) 
{
    Test(plist);//函数入口检测

    //清空链表
    if(Empty_Link(*plist) < 0)
        return -1;

    free(*plist);

    *plist = NULL;

    return 0;
}



/*******************************************
*Des:    插入结点到表头(与在表尾操作类似)
*Ret:    成功返回0，失败返回-1
*********************************************/
int Insert_to_Head(LIST_INFO *plist, int num)
{
    Test(plist);//参数有效性检测

    NODE *new_node = __Create_Node__(num);
    if(NULL == new_node)
        return -1;

    if(IS_Empty_Link(plist))//当链表为空
    {
        plist->head = plist->tail = new_node;
        plist->head->next = plist->tail;
        plist->tail->next = plist->head;
    }
    else
    {
        plist->tail->next = new_node;
        new_node->next = plist->head;
        plist->head = new_node;
    }

    plist->max++;

    return 0;
}

/*******************************************
*Des:    删除数据域为num的结点
*Ret:    成功返回0，失败返回-1
*********************************************/
int Delete_Node_Num(LIST_INFO *plist, int num)
{
    Test(plist);

    NODE *fnode = NULL, *tmpnode = NULL, *pnode = NULL;

    //判断链表是否为空
    if(IS_Empty_Link(plist))
    {
        printf("The list is empty!\n");
        return -1;
    }

    //查找结点是否有符合的
    pnode = plist->head;
    while(pnode != plist->tail)
    {
        if(pnode->num == num)
            break;
        tmpnode = pnode;
        pnode = pnode->next;
    }
    if(pnode == plist->tail)//结束条件为到了链表的尽头
    {
        if(pnode->num == num)//如果尾结点是的
        {
            fnode = pnode;
            if(plist->max == 1)//只有一个节点
            {
                plist->head = plist->tail = NULL;
            }
            else
            {
                tmpnode->next = plist->head;
                plist->tail = tmpnode;
            }
        }
        else
        {
            printf("Have no such Node!\n");
            return -1;
        }
    }
    else//循环条件因为找到符合的结点而结束的
    {
        if(NULL == tmpnode)//如果是头结点
        {
            fnode = plist->head;
            plist->tail->next = fnode->next;
            plist->head = fnode->next;
        }
        else
        {
            fnode = tmpnode->next;
            tmpnode->next = fnode->next;
        }
    }

    free(fnode);
    plist->max--;

    return 0;
}

/*******************************************
*Des:    遍历链表
*Ret:    成功返回0，失败返回-1
*********************************************/
int Traverse_Link(LIST_INFO *plist)
{
    Test(plist);//参数有效性检测
    
    if(IS_Empty_Link(plist))//判断链表是否为空
    {
        printf("The list is empty!\n");
        return -1;
    }

    printf("The count of Node: %d\n", plist->max);
    NODE *pnode = plist->head;
    while(pnode != plist->tail)
    {
        printf("%-5d", pnode->num);
        pnode =pnode->next;
    }
    printf("%-5d", pnode->num);

    printf("\n\n");

    return 0;
}



/**************************测试代码***************************/

#include "sc_link.h"
#define RANDOM rand()%10

int main()
{

    srand(time(NULL));
    
    int i, num;
    LIST_INFO *plist = NULL;

    //初始化链表操作
    Init_Link(&plist);

    //添加结点
    //for(i = 0; i < 5; i++)
    //{
    //    num = RANDOM;
    //    printf("%5d", num);
        Insert_to_Head(plist, 8);
    //}
    printf("\n\n");

    Traverse_Link(plist);

    //清空链表操作
    //Empty_Link(plist);

    Delete_Node_Num(plist, 8);

    Traverse_Link(plist);

    return 0;
}