ptree.h

Go to the documentation of this file.

/*
 * The MIT License
 *
 * Copyright (C) 2015-2016 Alexander Saprykin <saprykin.spb@gmail.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * 'Software'), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#if !defined (PLIBSYS_H_INSIDE) && !defined (PLIBSYS_COMPILATION)
#  error "Header files shouldn't be included directly, consider using <plibsys.h> instead."
#endif

#ifndef PLIBSYS_HEADER_PTREE_H
#define PLIBSYS_HEADER_PTREE_H

#include <pmacros.h>
#include <ptypes.h>

P_BEGIN_DECLS

typedef struct PTree_ PTree;

typedef enum PTreeType_ {
        P_TREE_TYPE_BINARY      = 0,    
        P_TREE_TYPE_RB          = 1,    
        P_TREE_TYPE_AVL         = 2     
} PTreeType;

P_LIB_API PTree *       p_tree_new              (PTreeType              type,
                                                 PCompareFunc           func);

P_LIB_API PTree *       p_tree_new_with_data    (PTreeType              type,
                                                 PCompareDataFunc       func,
                                                 ppointer               data);

P_LIB_API PTree *       p_tree_new_full         (PTreeType              type,
                                                 PCompareDataFunc       func,
                                                 ppointer               data,
                                                 PDestroyFunc           key_destroy,
                                                 PDestroyFunc           value_destroy);

P_LIB_API void          p_tree_insert           (PTree                  *tree,
                                                 ppointer               key,
                                                 ppointer               value);

P_LIB_API pboolean      p_tree_remove           (PTree                  *tree,
                                                 pconstpointer          key);

P_LIB_API ppointer      p_tree_lookup           (PTree                  *tree,
                                                 pconstpointer          key);

P_LIB_API void          p_tree_foreach          (PTree                  *tree,
                                                 PTraverseFunc          traverse_func,
                                                 ppointer               user_data);

P_LIB_API void          p_tree_clear            (PTree                  *tree);

P_LIB_API PTreeType     p_tree_get_type         (const PTree            *tree);

P_LIB_API pint          p_tree_get_nnodes       (const PTree            *tree);

P_LIB_API void          p_tree_free             (PTree                  *tree);

P_END_DECLS

#endif /* PLIBSYS_HEADER_PTREE_H */