Error Handling
[Utils]

This module standardizes the error messages returned by the interface functions of all modules. More...

Collaboration diagram for Error Handling:

Data Structures
struct	ENUM_error
	Error codes to be used by interface messages, this codes can be expanded to acomodate various failure reasons. More...
Files
file	errorhandling.cpp
	Error handling functions source code.
file	errorhandling.h
	main header file for this module. Includes, global vars, funtion prototypes, etc.
Defines
#define	_LAR_TEXT_RESET_   0
#define	_LAR_TEXT_BRIGHT_   1
#define	_LAR_TEXT_DIM_   2
#define	_LAR_TEXT_UNDERLINE_   3
#define	_LAR_TEXT_BLINK_   4
#define	_LAR_TEXT_REVERSE_   7
#define	_LAR_TEXT_HIDDEN_   8
#define	_LAR_TEXT_BLACK_   0
#define	_LAR_TEXT_RED_   1
#define	_LAR_TEXT_GREEN_   2
#define	_LAR_TEXT_YELLOW_   3
#define	_LAR_TEXT_BLUE_   4
#define	_LAR_TEXT_MAGENTA_   5
#define	_LAR_TEXT_CYAN_   6
#define	_LAR_TEXT_GRAY_   7
#define	_LAR_TEXT_WHITE_   8
Enumerations
enum	ENUM_error { E_SUCCESS = 50, E_UNKNOWN_FAILURE }
Functions
int	errorhandling (char *str, ENUM_error error)
	Prints error message.

---

Detailed Description

This module standardizes the error messages returned by the interface functions of all modules.

---

Define Documentation

#define _LAR_TEXT_BLACK_   0

Referenced by main().

#define _LAR_TEXT_BLINK_   4

#define _LAR_TEXT_BLUE_   4

#define _LAR_TEXT_BRIGHT_   1

Referenced by main().

#define _LAR_TEXT_CYAN_   6

#define _LAR_TEXT_DIM_   2

#define _LAR_TEXT_GRAY_   7

#define _LAR_TEXT_GREEN_   2

Referenced by control_mapping(), main(), and select_ini_file().

#define _LAR_TEXT_HIDDEN_   8

#define _LAR_TEXT_MAGENTA_   5

#define _LAR_TEXT_RED_   1

Referenced by copie_lines_to_list(), initialize_gamepad(), main(), on_signal(), optional_signs_computation(), read_pid(), select_ini_file(), and shutdown_module().

#define _LAR_TEXT_RESET_   0

Referenced by main().

#define _LAR_TEXT_REVERSE_   7

#define _LAR_TEXT_UNDERLINE_   3

#define _LAR_TEXT_WHITE_   8

Referenced by main().

#define _LAR_TEXT_YELLOW_   3

---

Enumeration Type Documentation

enum ENUM_error

Enumerator:

E_SUCCESS
E_UNKNOWN_FAILURE

---

Function Documentation

int errorhandling	(	char *	str,
		ENUM_error	error
	)

Prints error message.

Parameters:

	str	string that will be printed along error message
	error	error code defined in ENUM_error

Returns:

the result of main 1 is success. 0 is failure.