顺序栈的接口设计

/********************************************************************************************************
*
*
* 该程序实现顺序栈元素的增删改查，目的是提高设计程序的逻辑思维，另外为了提高可移植性，所以顺序栈中元素的
* 数据类型为DataType_t，用户可以根据实际情况修改顺序表中元素的类型。
*
* 另外，为了方便管理顺序栈,所以用户设计SeqStack_t结构体，该结构体中包含三个成员：栈底地址+栈容量+栈顶元素的下标
*
* 
*
* Copyright (c)  2023-2024   [email protected]   All right Reserved
* ******************************************************************************************************/
#include <stdio.h>
#include <stdbool.h>
#include <stdlib.h>




//指的是顺序栈中的元素的数据类型，用户可以根据需要进行修改
typedef int  DataType_t;

//构造记录顺序栈SequenceStack各项参数(栈底地址+栈容量+栈顶元素的下标)的结构体
typedef struct SequenceStack
{
	DataType_t * Bottom;		//记录栈底地址
	unsigned int Size;			//记录栈容量
	int			 Top;      		//记录栈顶元素的下标	

}SeqStack_t;


//创建顺序表并对顺序栈进行初始化
SeqStack_t * SeqStack_Create(unsigned int size)
{
	//1.利用calloc为顺序栈的管理结构体申请一块堆内存
	SeqStack_t *Manager = (SeqStack_t *)calloc(1,sizeof(SeqStack_t));

	if(NULL == Manager)
	{
		perror("calloc memory for manager is failed");
		exit(-1); //程序异常终止
	}

	//2.利用calloc为所有元素申请堆内存
	Manager->Bottom = (DataType_t *)calloc(size,sizeof(DataType_t));

	if (NULL == Manager->Bottom)
	{
		perror("calloc memory for Stack is failed");
		free(Manager);
		exit(-1); //程序异常终止
	}

	//3.对管理顺序栈的结构体进行初始化（元素容量 + 最后元素下标）
	Manager->Size = size;	//对顺序栈中的容量进行初始化
	Manager->Top = -1;		//由于顺序栈为空，则栈顶元素的下标初值为-1
	
	return Manager;
}


//判断顺序栈是否已满
bool SeqStack_IsFull(SeqStack_t *Manager)
{
	return (Manager->Top + 1 == Manager->Size) ? true : false;
}


//入栈
bool SeqStack_Push(SeqStack_t *Manager, DataType_t Data)
{
	//1.判断顺序栈是否已满
	if ( SeqStack_IsFull(Manager) )
	{
		printf("SeqStack Full is Full!\n");
		return false;
	}

	//2.如果顺序栈有空闲空间，则把新元素添加到顺序栈的栈顶
	Manager->Bottom[++Manager->Top] = Data;

	return true;
}





//判断顺序栈是否为空
bool SeqStack_IsEmpty(SeqStack_t *Manager)
{
	return (-1 == Manager->Top) ? true : false;
}



//出栈
DataType_t SeqStack_Pop(SeqStack_t *Manager)
{
	DataType_t temp = 0;  //用于存储出栈元素的值

	//1.判断顺序栈是否为空
	if ( SeqStack_IsEmpty(Manager) )
	{
		printf("SeqStack is Empty!\n");
		return;
	}
	
	//2.由于删除了一个元素，则需要让顺序栈的栈顶元素下标-1
	temp = Manager->Bottom[Manager->Top--];

	return temp;
}


//遍历顺序表的元素
void SeqStack_Print(SeqStack_t *Manager)
{
	for (int i = 0; i <= Manager->Top; ++i)
	{
		printf(" Stack Element[%d] = %d\n",i,Manager->Bottom[i]);
	}
}



int main(int argc, char const *argv[])
{

	//1.创建顺序表
	SeqStack_t * Top = SeqStack_Create(20);
	

	//2.向顺序表中的尾部插入新元素
	printf("*********************************入栈********************************\n");
	SeqStack_Push(Top,5);
	SeqStack_Push(Top,2);
	SeqStack_Push(Top,1);
	SeqStack_Push(Top,4);
	SeqStack_Push(Top,6);  


	// //3.遍历顺序表
	SeqStack_Print(Top); // -- 5 2 1 4 6
	printf("\n");
	//4.向顺序表中的头部插入新元素
	printf("*********************************出栈********************************\n");
	printf("出栈元素为%d\n",SeqStack_Pop(Top));
	printf("出栈元素为%d\n",SeqStack_Pop(Top));
	printf("出栈元素为%d\n",SeqStack_Pop(Top));
	printf("出栈元素为%d\n",SeqStack_Pop(Top));
	printf("出栈元素为%d\n",SeqStack_Pop(Top));  

	// //5.遍历顺序表
	SeqStack_Print(Top); // --空
	printf("\n");

    //2.向顺序表中的尾部插入新元素
	printf("*********************************入栈********************************\n");
	SeqStack_Push(Top,6);
	SeqStack_Push(Top,4);
	SeqStack_Push(Top,1);
	SeqStack_Push(Top,2);
	SeqStack_Push(Top,5);  


	// //3.遍历顺序表
	SeqStack_Print(Top); // -- 6 4 1 2 5
	printf("\n");
	return 0;
}