Back to index

lightning-sunbird  0.9+nobinonly
patricia.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is Mozilla Communicator client code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Simon Fraser <sfraser@netscape.com>
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either of the GNU General Public License Version 2 or later (the "GPL"),
00027  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 
00040 #ifndef __PATRICIA__
00041 #define __PATRICIA__
00042 
00043 /*---------------------------------------------------------------------
00044 
00045        Patricia
00046        
00047        D.R. Morrison's "Practical Algorithm To Retrieve Information
00048        Coded in Alphanumeric"
00049        
00050        See patricia.c for more information.
00051        
00052        Ref: Donald R. Morrison. PATRICIA -- practical algorithm to retrieve
00053        information coded in alphanumeric. Journal of the ACM, 15(4):514-534,
00054        October 1968
00055 
00056        See SedgeWick, R. Algorithms, 2nd Ed. (1988) for implemenation details.
00057 
00058 -----------------------------------------------------------------------*/
00059 
00060 #ifdef __cplusplus
00061 extern "C" {
00062 #endif
00063 
00064 /*     A type which you should use externally to refer to a Patricia tree. You
00065        application should treat the tree as an opaque data structure, accessed
00066        only through those routines whose prototypes are declared below.
00067        
00068        All externally-visible routines start with 'Patricia'. Internal routines
00069        are declared static in the .c file, and should not be used elsewhere.
00070 */
00071 typedef void *PatriciaTreeRef;
00072 
00073 
00074 /*     Declarations for user-supplied functions, which are called on replacing
00075        nodes (i.e. when inserting a node with a duplicate key, on traversing
00076        the tree, and on freeing nodes. A non-zero return value indicates failure.
00077 */
00078 typedef int (*NodeReplaceFunction) (void* *nodeDataPtr, unsigned char *key, void *replaceData, void *refCon);
00079 typedef int (*NodeTraverseFunction) (void *nodeData, unsigned char *key, void *arg, void *refCon);
00080 typedef int (*NodeFreeFunction) (void *nodeData, unsigned char *key, void *refCon);
00081 
00082 /*     The creation and destruction functions for allocating and freeing a tree.
00083        PatriciaInitTree() allocates space for a tree and initializes it.
00084        PatriciaFreeTree() frees the tree nodes and the tree itself. It does *NOT* free
00085        the data associated with each node, unless you pass a NodeFreeFunction that
00086        does this.
00087 */
00088 PatriciaTreeRef PatriciaInitTree(long numKeyBits);
00089 void   PatriciaFreeTree(PatriciaTreeRef treeRef, NodeFreeFunction freeFunc, void *refCon);
00090 
00091 /*     Functions for inserting nodes, searching for a node with a given key,
00092        and traversing the tree. Traversal involves visiting every node in the tree,
00093        but does not guarantee that the nodes are visited in a particular order.
00094 */
00095 int    PatriciaInsert(PatriciaTreeRef treeRef, NodeReplaceFunction replaceFunc, const unsigned char *key, void *data, void *refCon);
00096 int    PatriciaSearch(PatriciaTreeRef treeRef, const unsigned char *key, void **data);
00097 int    PatriciaTraverse(PatriciaTreeRef treeRef, NodeTraverseFunction traverseFunc, void *arg, void *refCon);
00098 
00099 /*     An accessor function that returns the total number of nodes in the tree
00100 */
00101 long PatriciaGetNumNodes(PatriciaTreeRef treeRef);
00102 
00103 #ifdef __cplusplus
00104 }
00105 #endif
00106 
00107 #endif /* __PATRICIA__ */
00108