ProcessData.h

#include <stdlib.h>
#include "ErrorHandler.h"
#include "ADT/ListADT.h"

#ifndef PROCESSDATA_H

#define PROCESSDATA_H

///     ---------- CONSTANTS ----------

//  Movement Constants
#define MAX_TEXT_MOVEMENT 180

//  Airport Constants
#define MAX_TEXT_AIRPORT 370

//  Named Fields
#define M_DEPARTURE "Despegue"
#define M_LOCAL "Cabotaje"

///     ---------- TYPEDEFS ----------

/*
	 * We are interested in tokens with indexes 0 / 3 / 4 / 5 / 6 in the movements file
	 * 		Token 0 :	Movement date
	 * 		Token 3 :	Flight type (internacional o nacional)
	 * 		Token 4 :	Flight classification (aterrizaje o despegue)
	 * 		Token 5 :	Origin OACI
	 * 		Token 6 :	Destination OACI
	 */
typedef enum { M_DATE = 0, M_TYPE = 3, M_CLASS = 4, M_ORIGIN = 5, M_DESTIN = 6 } TokenMovIndex;

/*
	 * We are interested in tokens with indexes 0 / 1 / 2 / 4 in the airports file
	 * 		Token 0 :	Local Code
	 * 		Token 1 :	OACI Code
	 * 		Token 2 :	IATA Code
	 * 		Token 4 :	Denomination
	 */
typedef enum { A_LOCAL = 0, A_OACI = 1, A_IATA = 2, A_DENOM = 4 } TokenAirpIndex;

///     ---------- FUNCTION PROTOTYPES ----------

/*
 * Alternative for strtok, separateToken replaces delimiter with NULL and stores each token in an array.
 * Parameters:
 *      char * str --> Source string. This string will be modified, can't be const.
 *      char del --> Character delimiter.
 *      char ** strArr --> Array of strings which will store all the strings separated by the delimiter.
 *      size_t dim --> Max dimension of strArr.
 * Return value:
 *      size_t --> New size of strArr.
 */
size_t separateToken(char *str, char del, char ** strArr, size_t dim);

/*
 *  Verifies whether or not the OACI code from the airport is unknown.
 *  Unknown OACI codes have this layout (# is a digit):
 *      SA##
 *      AR-####
 *      N/A
 *      More or less than 4 characters
 *  Parameters:
 *      const char * airportOACI --> Constant string containing the airport OACI.
 *  Return values:
 *      0 - if OACI is KNOWN.
 *      1 - if OACI is UNKNOWN.
 */
int isUnknownOACI(const char * airportOACI);

/*
 * 	Given a date, it calculates the day of the week.
 * 	Parameters:
 * 	    const char * date --> Constant string containing the date in format dd/mm/yyyy.
 * 	    int * dayCode --> Array containing the code (an integer) for each day in the week.
 * 	    int * monthCode --> Array containing the code (an integer) for each month.
 * 	    int * yearCode --> Array containing the code (an integer) for each year we are interested in.
 * 	Return value:
 * 	    Integer representing the day of the week for the array movPerDay[]
 */
int
dateToDayOfWeek (const char * date, int * dayCode, int * monthCode, int * yearCode);

/*
 * 	Extracts the day, month and year from a given date.
 * 	Parameters:
 * 	    const char * date --> Constant string containing the date in format dd/mm/yyyy.
 * 	    int * day --> Pointer to the day extracted.
 * 	    int * month --> Pointer to the month extracted.
 * 	    int * year --> Pointer to the year extracted.
 */
void getDate (const char * date, int * day, int * month, int * year);

/*
 * 	Verifies whether or not the year it receives is the year we want.
 * 	Parameters:
 * 	    const char * date --> Constant string containing the date in format dd/mm/yyyy.
 * 	    int yearGiven --> The year the user gave the program.
 * 	Return values:
 * 	    0 - If its NOT the year we want.
 * 	    1 - If it IS the year we want.
 */
int verifyYear (const char * date, int yearGiven);

/*
 *  Verifies whether or not the string passed is only digits.
 *  Parameters:
 *      const char * str --> Constant string to be verified.
 *  Return values:
 *      0 - If the string contains not only numbers.
 *      1 - If the string contains only numbers.
 */
int verifyString (const char * str);

/*
 *	Function to process all data from the flights file.
 *	Parameters:
 *	    ListADT airportList --> List containing all the airports.
 *	    int yearGiven --> The year the user input.
 *	    int * movPerDay --> Array containing movements per day of the week.
 *	    int * dayCode --> Array containing codes for each day of the week.
 *	    int * monthCode --> Array containing codes for each month.
 *	    int * yearCode --> Array containing codes for each possible year
 *	Return Values:	NO_ERROR - if everything works
 *					CANT_OPEN_MOV - if there was an error while trying to open the file
 */
TErrors movementsProcessing (ListADT airportList, int yearGiven, int * movPerDay, int * dayCode, int * monthCode, int * yearcode);

/*  Function to process all data from the airports file.
 * Parameters:
 *      ListADT airportList --> List containing all the airports or an empty list.
 * Return Values:
 *      NO_ERROR - if everything works
 *		CANT_OPEN_AIRP - if there was an error while trying to open the file
 *
 */
TErrors airportProcessing (ListADT airportList);

///     ---------- ----------

#endif