common.c File Reference

#include <stdlib.h>
#include <stdio.h>
#include <sys/ioctl.h>
#include <wchar.h>
#include <termios.h>
#include <unistd.h>
#include <sys/time.h>
#include <sys/types.h>
#include "common.h"
#include "definitions.h"

Go to the source code of this file.

Functions
void	sound ()
	Makes a beep sound.
void	clearCLI (void)
	Call the system function to clear the cli.
void	exitFailure (void)
	Exit the program after cleaning everything on screen.
void	delayTimer (int time)
	Call the system sleep.
int	intLen (int value)
	Calculate the length of a given number.
void	widthSpacing (int filledWidth)
	Apply an horizontal spacing based on window width and what need to be printed.
void	printCentered (wchar_t *text)
	Print text centered horizontally based on string length.
void	heightSpacing (int filledHeight)
	Apply a vertical spacing based on window heigth and what need to be printed.
void	u_cleanup (void)
int	u_kbhit (void)
int	u_getchar (void)
int	waitUserInput (void)
	Loop until user press a valid key.
void	waitUser (void)
	Wait until Enter key is pressed.

Variables
const wchar_t	chSq = 0x2705
	Assign unicode character (green check square) to this global variable.
const wchar_t	crSq = 0x274E
	Assign unicode character (green crossed square) to this global variable.
const wchar_t	eSq = 0x2B1C
	Assign unicode character (white square) to this global variable.
const wchar_t	fSq = 0x2B1B
	Assign unicode character (black square) to this global variable.
const int	timeLimit = 1000
	Time waiting before letting the tetromino fall one row below.
struct winsize	w
	Global variable type struct winsize used for terminal width and height.

Function Documentation

clearCLI()

void clearCLI

(

void

)

Call the system function to clear the cli.

Definition at line 25 of file common.c.

                   {
 
  int res;
 
  res = system("clear");
  if (res == 1){
    clearCLI();
    exit(EXIT_FAILURE);
  }
}

delayTimer()

void delayTimer

(

int

timeDelay

)

Call the system sleep.

Parameters

[in]

timeDelay

Time of the sleep in seconds.

Definition at line 41 of file common.c.

                         {
  sleep(time);
}

exitFailure()

void exitFailure

(

void

)

Exit the program after cleaning everything on screen.

Definition at line 36 of file common.c.

                      {
  clearCLI();
  exit(EXIT_FAILURE);
}

heightSpacing()

void heightSpacing

(

int

filledHeight

)

Apply a vertical spacing based on window heigth and what need to be printed.

Parameters

[in]

filledHeight

Height of what is printed that need to be centered.

Definition at line 76 of file common.c.

                                    {
 
  int i;
 
  ioctl(STDOUT_FILENO, TIOCGWINSZ, &w);
  for(i=0; i<(w.ws_row-filledHeight)/2; i++)
    wprintf(L"\r\n");
}

intLen()

int intLen

(

int

value

)

Calculate the length of a given number.

Parameters

[in]	value	Number which needs his length calculated.
[in]	length	Return the length of the number.

Definition at line 47 of file common.c.

                     {
 
  int length = 0;
 
  if (value != 0){
    while(value!=0){
       value = value/10;
       length++;
    }
  }
 
  return (length==0)?1:length;
 
}

printCentered()

void printCentered

(

wchar_t *

text

)

Print text centered horizontally based on string length.

Parameters

[in]

text

Text that need to be printed on screen (doesn't include special characters).

Definition at line 71 of file common.c.

                                 {
  widthSpacing(wcslen(text));
  wprintf(L"%ls\r\n", text);
}

sound()

void sound

(

void

)

Makes a beep sound.

Definition at line 21 of file common.c.

            {
  wprintf(L"\a");
}

u_cleanup()

void u_cleanup

(

void

)

Definition at line 87 of file common.c.

                    {
  tcsetattr(0, TCSANOW, &orig_term);
}

u_getchar()

int u_getchar

(

void

)

Definition at line 118 of file common.c.

                   {
 
  int ret;
  unsigned char buf;
 
  if(read(0, &buf, 1)!=1)
    ret=0;
  else
    ret=buf;
  return ret;
}

u_kbhit()

int u_kbhit

(

void

)

Definition at line 91 of file common.c.

                 {
 
  struct termios t;
  fd_set rfd;
  struct timeval to;
  static int first_hit=0;
 
  if(first_hit==0){
    if(tcgetattr(0, &t)!=0)
      exit(0);
    orig_term=t;
    cfmakeraw(&t);
    if(tcsetattr(0, TCSANOW, &t)!=0)
      exit(0);
    atexit(u_cleanup);
    first_hit=1;
  }
 
  FD_ZERO(&rfd);
  FD_SET(0, &rfd);
  to.tv_sec=0;
  to.tv_usec=0;
  if(select(1, &rfd, NULL, NULL, &to)==1)
    return 1;
  return 0;
}

waitUser()

void waitUser

(

void

)

Wait until Enter key is pressed.

Definition at line 146 of file common.c.

                   {
  int key=2;
  while(key!=CARRIAGE_RETURN){
    key = waitUserInput();
  }
}

waitUserInput()

int waitUserInput

(

void

)

Loop until user press a valid key.

Parameters

[in]

time

Time in microseconds which the usleep is called.

Definition at line 130 of file common.c.

                       {
 
  int key=0;
 
  while(1){
    if(u_kbhit()){
      key=u_getchar();
      if (key == CTRL_C)
        exitFailure();
      return key;
    }
    usleep(NSEC_TO_SLEEP);
  }
  exitFailure();
}

widthSpacing()

void widthSpacing

(

int

filledWidth

)

Apply an horizontal spacing based on window width and what need to be printed.

Parameters

[in]

filledWidth

Width of what is printed that need to be centered.

Definition at line 62 of file common.c.

                                  {
 
  int i;
 
  ioctl(STDOUT_FILENO, TIOCGWINSZ, &w);
  for(i=0; i<(w.ws_col-filledWidth)/2; i++)
    wprintf(L" ");
}

Variable Documentation

chSq

const wchar_t chSq = 0x2705

Assign unicode character (green check square) to this global variable.

Definition at line 14 of file common.c.

crSq

const wchar_t crSq = 0x274E

Assign unicode character (green crossed square) to this global variable.

Definition at line 15 of file common.c.

eSq

const wchar_t eSq = 0x2B1C

Assign unicode character (white square) to this global variable.

Definition at line 16 of file common.c.

fSq

const wchar_t fSq = 0x2B1B

Assign unicode character (black square) to this global variable.

Definition at line 17 of file common.c.

timeLimit

const int timeLimit = 1000

Time waiting before letting the tetromino fall one row below.

Definition at line 19 of file common.c.

w

struct winsize w

Global variable type struct winsize used for terminal width and height.

Definition at line 45 of file common.c.