/*
 * Copyright (C) 2009-2011 by Benedict Paten (benedictpaten@gmail.com)
 *
 * Released under the MIT license, see LICENSE.txt
 */

#ifndef CACTUS_EVENT_TREE_H_
#define CACTUS_EVENT_TREE_H_

#include "cactusGlobals.h"

////////////////////////////////////////////////
////////////////////////////////////////////////
////////////////////////////////////////////////
//Basic event tree functions.
////////////////////////////////////////////////
////////////////////////////////////////////////
////////////////////////////////////////////////

/*
 * Constructs an event tree, with given root event.
 */
EventTree *eventTree_construct(Name rootEventName, Flower *flower);

/*
 * Constructs an event tree, with one root event.
 */
EventTree *eventTree_construct2(Flower *flower);

/*
 * Copy constructs the event tree, replacing the existing flower with the new flower. Only includes
 * the unary events which are true, given the unary event function.
 */
EventTree *eventTree_copyConstruct(EventTree *eventTree, Flower *newFlower, int32_t (unaryEventFilterFn)(Event *event));

/*
 * Returns the root event.
 */
Event *eventTree_getRootEvent(EventTree *eventTree);

/*
 * Gets the event with the given name.
 */
Event *eventTree_getEvent(EventTree *eventTree, Name eventName);

/*
 * Finds an event in the given event tree with the given header string.
 */
Event *eventTree_getEventByHeader(EventTree *eventTree, const char *eventHeader);

/*
 * Gets the common ancestor of two events.
 */
Event *eventTree_getCommonAncestor(Event *event, Event *event2);

/*
 * Gets the parent flower.
 */
Flower *eventTree_getFlower(EventTree *eventTree);

/*
 * Gets the total number of events in the event tree.
 */
int32_t eventTree_getEventNumber(EventTree *eventTree);

/*
 * Gets the first event in the list.
 */
Event *eventTree_getFirst(EventTree *eventTree);

/*
 * Gets an iterator over the eventTree events.
 */
EventTree_Iterator *eventTree_getIterator(EventTree *eventTree);

/*
 * Gets the next event from the iterator.
 */
Event *eventTree_getNext(EventTree_Iterator *iterator);

/*
 * Gets the previous event from the iterator.
 */
Event *eventTree_getPrevious(EventTree_Iterator *iterator);

/*
 * Duplicates the iterator.
 */
EventTree_Iterator *eventTree_copyIterator(EventTree_Iterator *iterator);

/*
 * Destructs the iterator.
 */
void eventTree_destructIterator(EventTree_Iterator *iterator);

/*
 * Makes a newick string representation of the event tree.
 */
char *eventTree_makeNewickString(EventTree *eventTree);

/*
 * Insert given unary event, from a sibling event tree into the given event tree,
 * where sibling means their containing flowers have the same parent flowers.
 */
void eventTree_addSiblingUnaryEvent(EventTree *eventTree, Event *event);

/*
 * Runs event_check for each event in tree, which is sufficient to check properties of event tree.
 */
void eventTree_check(EventTree *eventTree);

#endif