source3/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 3 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, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #ifndef ADT_TREE_H
  21 #define ADT_TREE_H
  22
  23 /* data structure used to build the tree */
  24
  25 typedef struct _tree_node {
  26         struct _tree_node       *parent;
  27         struct _tree_node       **children;
  28         int                     num_children;
  29         char                    *key;
  30         void                    *data_p;
  31 } TREE_NODE;
  32
  33 typedef struct _tree_root {
  34         TREE_NODE       *root;
  35
  36         /* not used currently (is it needed?) */
  37         int             (*compare)(void* x, void *y);
  38 } SORTED_TREE;
  39
  40 /*
  41  * API
  42  */
  43
  44 /* create a new tree, talloc_free() to throw it away */
  45
  46 SORTED_TREE*  pathtree_init( void *data_p, int (cmp_fn)(void*, void*) );
  47
  48 /* add a new path component */
  49
  50 WERROR        pathtree_add( SORTED_TREE *tree, const char *path, void *data_p );
  51
  52 /* search path */
  53
  54 void*         pathtree_find( SORTED_TREE *tree, char *key );
  55
  56 /* debug (print) functions */
  57
  58 void          pathtree_print_keys( SORTED_TREE *tree, int debug );
  59
  60
  61 #endif