/*
  Copyright 2011 David Robillard <http://drobilla.net>

  Permission to use, copy, modify, and/or distribute this software for any
  purpose with or without fee is hereby granted, provided that the above
  copyright notice and this permission notice appear in all copies.

  THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/

#ifndef ZIX_ZIX_H
#define ZIX_ZIX_H

#include <stdbool.h>

#ifdef ZIX_SHARED
#    ifdef __WIN32__
#        define ZIX_LIB_IMPORT __declspec(dllimport)
#        define ZIX_LIB_EXPORT __declspec(dllexport)
#    else
#        define ZIX_LIB_IMPORT __attribute__((visibility("default")))
#        define ZIX_LIB_EXPORT __attribute__((visibility("default")))
#    endif
#    ifdef ZIX_INTERNAL
#        define ZIX_API ZIX_LIB_EXPORT
#    else
#        define ZIX_API ZIX_LIB_IMPORT
#    endif
#else
#    define ZIX_API
#endif

#ifdef __cplusplus
extern "C" {
#endif

/**
   @defgroup zix Zix
   A lightweight portability library.
   @{
*/

/**
   @name Tree
   @{
*/

#define ZIX_STATUS_SUCCESS   0
#define ZIX_STATUS_ERROR     1
#define ZIX_STATUS_NO_MEM    2
#define ZIX_STATUS_NOT_FOUND 3
#define ZIX_STATUS_EXISTS    4

/**
   Function for comparing two elements.
*/
typedef int (*ZixComparator)(const void* a, const void* b, void* user_data);

/**
   A balanced binary search tree.
*/
typedef struct _ZixTree ZixTree;

/**
   A node in a @ref ZixTree.
*/
typedef struct _ZixTreeNode ZixTreeNode;

/**
   An iterator over a @ref ZixTree.
*/
typedef ZixTreeNode* ZixTreeIter;

/**
   Create a new (empty) tree.
*/
ZixTree*
zix_tree_new(bool allow_duplicates, ZixComparator cmp, void* cmp_data);

/**
   Free @a t.
*/
void
zix_tree_free(ZixTree* t);

/**
   Insert the element @a e into @a t and point @a ti at the new element.
*/
int
zix_tree_insert(ZixTree* t, const void* e, ZixTreeIter* ti);

/**
   Remove the item pointed at by @a ti from @a t.
*/
int
zix_tree_remove(ZixTree* t, ZixTreeIter ti);

/**
   Set @a ti to be the largest element <= @a e in @a t.
   If no such item exists, @a ti is set to NULL.
*/
int
zix_tree_find(const ZixTree* t, const void* e, ZixTreeIter* ti);

/**
   Return the data associated with the given avltree item.
*/
const void*
zix_tree_get_data(ZixTreeIter ti);

/**
   @}
   @}
*/

#endif  /* ZIX_ZIX_H */