gridO.h

/*!
   \file gridO.h
   \brief A curses based library to handle text based grid output
   \author Jochymski Hugo
   \date 2021
*/
#include <curses.h>

/* Cell apparence */
#define CELL_CORNER "+" /*!< Cell corner apparence */
// (2y size recommended on default settings)
#define CELL_WIDTH 2 /*!< Cell x-edge size */
#define CELL_HEIGHT 1 /*!< Cell y-edge size */
#define CELL_SIZE (CELL_WIDTH*CELL_HEIGHT) /*!< Space within the cell */
#define CELL_XAXE "-" /*!< Cell x-axis edge apparence */
#define CELL_YAXE "|" /*!< Cell y-axis edge apparence */

/* Color related */
// #define BG_COLOR COLOR_BLACK
#define COLOR_ORANGE 60
#define COLOR_PINK 80
#define CLR_YLW 1
#define CLR_BLU 2
#define CLR_RED 3
#define CLR_GRN 4
#define CLR_WHT 5
#define CLR_ORG 6
#define CLR_VLT 7
#define CLR_PNK 8
#define CLR_CYN 9

/******************************************************************************/
/*********************************** UTILS ************************************/
/******************************************************************************/

/*!
   \brief Converts a y position on the grid to the real position on the file
   \param[in] y Y position to convert
   \return The converted position (integer)
*/
int yGridToReal(int y)
{
	if (y == 0) return 0;
	else return (y*CELL_HEIGHT + y);
}

/*!
   \brief Converts a x position on the grid to the real position on the file
   \param[in] x X position to convert
   \return The converted position (integer)
*/
int xGridToReal(int x)
{
	if (x == 0) return 0;
	else return (x*CELL_WIDTH + x);
}

/*!
   \brief Mimic the strlen function from string.h
   \param[in] str String to be examinated
   \return Length of \p str
*/
int strLen(char* str)
{
	int size = 0;
	while (str[size])
		size++;
	return size;
}

/******************************************************************************/
/********************************* BASIC GRID *********************************/
/******************************************************************************/

/*!
   \brief Prints a cell using the \p x and \p y grid coordinates
   \param[in] x X coordinate
   \param[in] y Y coordinate
   \return -1 on error, 0 on succes
*/
int gp_cell(int x, int y)
{
	if (x < 0 || y < 0)
		return -1;

	//Corners
	mvprintw(yGridToReal(y), xGridToReal(x), CELL_CORNER);
	mvprintw(yGridToReal(y), xGridToReal(x)+CELL_WIDTH+1, CELL_CORNER);
	mvprintw(yGridToReal(y)+CELL_HEIGHT+1, xGridToReal(x), CELL_CORNER);
	mvprintw(yGridToReal(y)+CELL_HEIGHT+1,
		 xGridToReal(x)+CELL_WIDTH+1, CELL_CORNER);

	//x-axis edges
	for (int i=0; i<CELL_WIDTH; i++)
	{
		//top
		mvprintw(yGridToReal(y), xGridToReal(x)+i+1, CELL_XAXE);
		//bot
		mvprintw(yGridToReal(y)+CELL_HEIGHT+1,
			 xGridToReal(x)+i+1, CELL_XAXE);
	}

	//y-axis edges
	for (int i=0; i<CELL_HEIGHT; i++)
	{
		//left
		mvprintw(yGridToReal(y)+i+1, xGridToReal(x), CELL_YAXE);
		//right
		mvprintw(yGridToReal(y)+i+1,
			 xGridToReal(x)+CELL_WIDTH+1, CELL_YAXE);

	}
	return 0;
}

/*!
   \brief Prints a \p length long line at the \p y coordinate starting at \
   \p start on the x-axis
   \param[in] start Starting point on the x-axis
   \param[in] y Y coordinate
   \param[in] len Line length
   \return -1 on error, 0 on succes
*/
int gp_line(int start, int y, int len)
{
	if (start < 0 || y < 0 || len < 0)
		return -1;

	for (int i=start; i<len; i++)
		gp_cell(i, y);
	return 0;
}

/*!
   \brief Prints a \p len long row at the \p x coordinate starting at \
   \p start on the y-axis
   \param[in] x X coordinate
   \param[in] start Starting point on the y-axis
   \param[in] len Row length
   \return -1 on error, 0 on succes
*/
int gp_row(int x, int start, int len)
{
	if (start < 0 || x < 0 || len < 0)
		return -1;

	for (int i=start; i<len; i++)
		gp_cell(x, i);
	return 0;
}


/******************************************************************************/
/******************************** COLORED GRID ********************************/
/******************************************************************************/

/*!
   \brief Prints a \color cell using the \p x and \p y grid coordinates
   \param[in] x X coordinate
   \param[in] y Y coordinate
   \param[in] color The color to be used
   \return -1 on error, 0 on succes
   \note Color is enabled at the beginning and disabled at the end
*/
int gpc_cell(int x, int y, int color)
{
	if (x < 0 || y < 0)
		return -1;

	//Turn color on
	if (attron(COLOR_PAIR(color)) == ERR) return -1;

	//Corners
	mvprintw(yGridToReal(y), xGridToReal(x), CELL_CORNER);
	mvprintw(yGridToReal(y), xGridToReal(x)+CELL_WIDTH+1, CELL_CORNER);
	mvprintw(yGridToReal(y)+CELL_HEIGHT+1, xGridToReal(x), CELL_CORNER);
	mvprintw(yGridToReal(y)+CELL_HEIGHT+1,
		 xGridToReal(x)+CELL_WIDTH+1, CELL_CORNER);

	//x-axis edges
	for (int i=0; i<CELL_WIDTH; i++)
	{
		//top
		mvprintw(yGridToReal(y), xGridToReal(x)+i+1, CELL_XAXE);
		//bot
		mvprintw(yGridToReal(y)+CELL_HEIGHT+1,
			 xGridToReal(x)+i+1, CELL_XAXE);
	}

	//y-axis edges
	for (int i=0; i<CELL_HEIGHT; i++)
	{
		//left
		mvprintw(yGridToReal(y)+i+1, xGridToReal(x), CELL_YAXE);
		//right
		mvprintw(yGridToReal(y)+i+1,
			 xGridToReal(x)+CELL_WIDTH+1, CELL_YAXE);

	}

	//Turn color off
	if (attroff(COLOR_PAIR(color)) == ERR) return -1;
	return 0;
}

/*!
   \brief Prints a \p length \p color long line at the \p y coordinate \
   starting at \p start on the x-axis
   \param[in] start Starting point on the x-axis
   \param[in] y Y coordinate
   \param[in] len Line length
   \param[in] color The color to be used
   \return -1 on error, 0 on succes
*/
int gpc_line(int start, int y, int len, int color)
{
	if (start < 0 || y < 0 || len < 0)
		return -1;

	//Turn color on
	if (attron(COLOR_PAIR(color)) == ERR) return -1;

	for (int i=start; i<len; i++)
		if (gp_cell(i, y) == -1) return -1;

	//Turn color off
	if (attroff(COLOR_PAIR(color)) == ERR) return -1;

	return 0;
}

/*!
   \brief Prints a \p len long \p color row at the \p x coordinate starting at \
   \p start on the y-axis
   \param[in] x X coordinate
   \param[in] start Starting point on the y-axis
   \param[in] len Row length
   \param[in] color The color to be used
   \return -1 on error, 0 on succes
*/
int gpc_row(int x, int start, int len, int color)
{
	if (start < 0 || x < 0 || len < 0)
		return -1;

	//Turn color on
	if (attron(COLOR_PAIR(color)) == ERR) return -1;

	for (int i=start; i<len; i++)
		if (gp_cell(x, i) == -1) return -1;

	//Turn color off
	if (attroff(COLOR_PAIR(color)) == ERR) return -1;

	return 0;
}

/******************************************************************************/
/****************************** CELL MANAGEMENT *******************************/
/******************************************************************************/

/*!
   \brief Prints \p content to a (\p x , \p y ) cell
   \param[in] x X coordinate
   \param[in] y Y coordinate
   \param[in] content What to be print
   \return -1 on error, 0 on succes
   \note \p content length has to be smaller or egal to CELL_SIZE \
   otherwhise it will be truncated
*/
int gp_cellPrint(int x, int y, char* content)
{
	if (x < 0 || y < 0 || content == NULL)
		return -1;

	int len = strLen(content);
	int istr = 0;

	for (int iy=yGridToReal(y)+1; iy<CELL_HEIGHT+yGridToReal(y)+1; iy++)
	{
		for (int ix=xGridToReal(x)+1;
			 ix<CELL_WIDTH+xGridToReal(x)+1; ix++)
		{
			if (istr < len)
				mvprintw(iy, ix, "%c", content[istr++]);
		}
	}

	return 0;
}

/*!
   \brief Erases cell content
   \param[in] x X coordinate
   \param[in] y Y coordinate
   \return -1 on error, 0 on succes
*/
int gp_clearCell(int x, int y)
{
	if (x < 0 || y < 0)
		return -1;

	//Through x-axis
	for (int iy=yGridToReal(y)+1; iy<CELL_HEIGHT+yGridToReal(y)+1; iy++)
	{
		//Through y-axis
		for (int ix=xGridToReal(x)+1;
			 ix<CELL_WIDTH+xGridToReal(x)+1; ix++)
		{
			mvprintw(iy, ix, " ");
		}
	}
	return 0;
}


/******************************************************************************/
/******************************* COLOR HANDLING *******************************/
/******************************************************************************/

/*!
   \brief Init color pairs to be used later
   \return -1 on error, 0 on succes
*/
int init_colors()
{
	if (start_color() == ERR) return -1;
	if (init_pair(CLR_YLW, COLOR_YELLOW, COLOR_BLACK)  == ERR) return -1;
	if (init_pair(CLR_BLU, COLOR_BLUE, COLOR_BLACK)    == ERR) return -1;
	if (init_pair(CLR_RED, COLOR_RED, COLOR_BLACK) 	   == ERR) return -1;
	if (init_pair(CLR_GRN, COLOR_GREEN, COLOR_BLACK)   == ERR) return -1;
	if (init_pair(CLR_WHT, COLOR_WHITE, COLOR_BLACK)   == ERR) return -1;
	if (init_color(COLOR_ORANGE, 1000, 500, 0) 	   == ERR) return -1;
	if (init_pair(CLR_ORG, COLOR_ORANGE, COLOR_BLACK)  == ERR) return -1;
	if (init_pair(CLR_VLT, COLOR_MAGENTA, COLOR_BLACK) == ERR) return -1;
	if (init_color(COLOR_PINK, 1000, 411, 705) 	   == ERR) return -1;
	if (init_pair(CLR_PNK, COLOR_PINK, COLOR_BLACK)    == ERR) return -1;
	if (init_pair(CLR_CYN, COLOR_CYAN, COLOR_BLACK)    == ERR) return -1;
	return 0;
}