source/include/adt_tree.h

   1 /*
   2  *  Unix SMB/CIFS implementation.
   3  *  Generic Abstract Data Types
   4  *  Copyright (C) Gerald Carter                     2002-2005.
   5  *
   6  *  This program is free software; you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation; either version 2 of the License, or
   9  *  (at your option) any later version.
  10  *
  11  *  This program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with this program; if not, write to the Free Software
  18  *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  19  */
  20
  21 #ifndef ADT_TREE_H
  22 #define ADT_TREE_H
  23
  24 #ifndef _UPPER_BOOL
  25 typedef int BOOL;
  26 #define _UPPER_BOOL
  27 #endif
  28
  29
  30 /* data structure used to build the tree */
  31
  32 typedef struct _tree_node {
  33         struct _tree_node       *parent;
  34         struct _tree_node       **children;
  35         int                     num_children;
  36         char                    *key;
  37         void                    *data_p;
  38 } TREE_NODE;
  39
  40 typedef struct _tree_root {
  41         TREE_NODE       *root;
  42
  43         /* not used currently (is it needed?) */
  44         int             (*compare)(void* x, void *y);
  45 } SORTED_TREE;
  46
  47 /*
  48  * API
  49  */
  50
  51 /* create a new tree, talloc_free() to throw it away */
  52
  53 SORTED_TREE*  pathtree_init( void *data_p, int (cmp_fn)(void*, void*) );
  54
  55 /* add a new path component */
  56
  57 BOOL          pathtree_add( SORTED_TREE *tree, const char *path, void *data_p );
  58
  59 /* search path */
  60
  61 void*         pathtree_find( SORTED_TREE *tree, char *key );
  62
  63 /* debug (print) functions */
  64
  65 void          pathtree_print_keys( SORTED_TREE *tree, int debug );
  66
  67
  68 #endif