// Interface to the Record List ADT

// !!! DO NOT MODIFY THIS FILE !!!

#ifndef LIST_H
#define LIST_H

#include <stdbool.h>

#include "Record.h"

typedef struct list *List;

// Creates a new empty list
// Complexity: O(1)
List ListNew(void);

// Frees the given list, but not the records contained in the list
// Complexity: O(1)
void ListFree(List l);

// Adds a record to the end of the list. Does NOT make a copy of the
// record before adding it to the list.
// Average complexity: O(1)
void ListAppend(List l, Record r);

// Returns the number of items in the list
// Complexity: O(1)
int  ListSize(List l);

////////////////////////////////////////////////////////////////////////
// DO NOT use these functions, they are intended to be used by the main
// function only.

typedef struct listIterator *ListIterator;

// Creates an iterator for the given list
// Complexity: O(1)
ListIterator ListItNew(List l);

// Gets the next item in the list. The item should not be modified.
// Complexity: O(1)
Record ListItNext(ListIterator it);

// Checks if the list has a next item
// Complexity: O(1)
bool ListItHasNext(ListIterator it);

// Frees the given iterator
// Complexity: O(1)
void ListItFree(ListIterator it);

#endif