flights.h

/**
*  Header file for the Flights C program
*  Provides the Declarations of Methods and Struct(s)
*  This file is used by other parts of the application
*  @file flights.h 
*  @author Pranav Kale
*/

#include <stdbool.h>

#ifndef FLIGHTS_H
#define FLIGHTS_H

#define INITIALCAP 15
#define TABLE_SIZE 100

/** 
    Structure to store the flight details
    Includes information like date, flightID, airports, etc.
*/
typedef struct {
    char date[20];
    char flightID[10];
    char departureAirport[50];
    char departureCountry[50];
    char departTime[10];
    char arrivalTime[10];
    char arrivalAirport[50];
    int seats;
    char aircraftType[50];
    char pilot[50];
    double totalMiles;
    int totalTrips;
    char operatorName[30];
} Flight;

/**
* Structure for Flight Data base 
* Includes the Pointers to flights
* Includes the Count for tracking number of flights
* Includes the Capacity for memory usage
*/
typedef struct {
    Flight **flight;
    int count;
    int capacity;
} FlightDatabase;

/**
* AirportNode is used to store a linked list of all airports
* Includes the airport name 
* Includes a pointer to the next AirportNode
*/
typedef struct AirportNode {
    char airport[50];
    struct AirportNode *next;
} AirportNode;

/** 
* CountryNode is used to store a linked list of all countries 
* Includes the country name
* Includes a pointer to the next CountryNode
* Includes all the airports for X CountryNode
*/
typedef struct CountryNode {
    char country[50];
    AirportNode *airports;
    struct CountryNode *next;
} CountryNode;

/** 
* Hash Table is used to store buckets of Country Nodes 
* size for keeping track bucket size
*/
typedef struct {
    CountryNode **buckets;
    int size;
} HashTable;

/** 
    Creates database to store all the flights in struct
    @return a flight database struct
*/
FlightDatabase *makeDatabase();

/**
    Free the Flight Database to Avoid Memory Leak
    @param flightdb the database to free
*/
void freeFlightDatabase(FlightDatabase *flightdb);

/** 
    Free the hash table of country / airport data
    @param table the table to free
*/
void freeHashTable(HashTable *table);

/** 
    Get all the data for a flight 
    @param fname to store flights
    @param flight the pointer to flight struct
*/
bool getData(const char fname[], Flight *flight);

/**
    Unique algorithm to hash provided data 
    Secure method to store the information
    @param str the string to hash
*/
unsigned int hash(const char *str);

/**
    Creates a hash table with provided size
    @param size the size of table 
    @return a hash table 
*/
HashTable *createTable(int size);

/**
    Calculate all the Average Miles per Flight 
    Allows customer to know usual flight miles on each travel
    @param miles the mileage of plane
    @param trips the # of trips the plane has chartered
    @return avgMiles the average miles per trip
*/
double calculateAverageMilesPerFlight(double miles, int trips);

/**
    Calculate flight time of this plane
    @param departTime the time of departure
    @param arrivalTime the time of arrival
    @return fTime total flight time 
*/
char* calculateFlightTime(const char departTime[], const char arrivalTime[]);

/**
* Calculate the total revenue of the flight
* Take the number of seats and multiply by fixed price
*/
double calculateTotalRevenue(int numSeats, double pricePerSeat);

/**
    Insert an airport into the hash table
    Use the provided information to traverse the table
    @param table the table to insert in
    @param country the country to add
    @param airport the airport to attach to valid country
*/
void insertAirport(HashTable *table, const char *country, const char *airport);

#endif