list.h

Go to the documentation of this file.

#ifndef LIST_H
#define LIST_H

#include "copyright.h"
#include "utility.h"


class ListElement
{
  public:
    ListElement (void *itemPtr, long long sortKey); // initialize a list element

    ListElement *next;      // next element on list, 
    // NULL if this is the last
    long long key;          // priority, for a sorted list
    void *item;         // pointer to item on the list
};

// The following class defines a "list" -- a singly linked list of
// list elements, each of which points to a single item on the list.
//
// By using the "Sorted" functions, the list can be kept in sorted
// in increasing order by "key" in ListElement.

class List
{
  public:
    List ();            // initialize the list
    ~List ();           // de-allocate the list

    void Prepend (void *item);  // Put item at the beginning of the list
    void Append (void *item);   // Put item at the end of the list
    void *Remove ();        // Take item off the front of the list

    void Mapcar (VoidFunctionPtr func); // Apply "func" to every element 
    // on the list
    bool IsEmpty ();        // is the list empty? 


    // Routines to put/get items on/off list in order (sorted by key)
    void SortedInsert (void *item, long long sortKey);  // Put item into list
    void *SortedRemove (long long *keyPtr); // Remove first item from list

    void * get(unsigned int index);
    unsigned int size();
// A Tester
    bool removeElement(void * ElementAdress);

  private:
      ListElement * first;  // Head of the list, NULL if list is empty
    ListElement *last;      // Last element of list
};

#endif // LIST_H