Back to index

lightning-sunbird  0.9+nobinonly
PatriciaTree.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 PatricaTree_h_
00041 #define PatricaTree_h_
00042 
00043 #include "patricia.h"
00044 
00045 // node base class. Subclass for your nodes.
00046 
00047 class CPatriciaNode
00048 {
00049 public:
00050                                           CPatriciaNode()             {}
00051        virtual                            ~CPatriciaNode()     {}
00052 };
00053 
00054 
00055 // tree base class. Subclass for your tree.
00056 
00057 class CPatriciaTree
00058 {
00059 public:
00060        
00061        typedef       const unsigned char*        TPatriciaKey; 
00062        
00063                                           CPatriciaTree(long keyBitsLen);
00064        virtual                            ~CPatriciaTree();
00065                             
00066        // override if you want variable replace functionality
00067        // returns true if replaced
00068        virtual Boolean                    InsertNode(TPatriciaKey key, CPatriciaNode* nodeData);
00069        
00070        // returns true if found
00071        Boolean                            SeekNode(TPatriciaKey key, CPatriciaNode**outNodeData);
00072        
00073        // returns true if entire tree traversed
00074        Boolean                            Traverse(NodeTraverseFunction traverseFcn, void *arg, void *refCon);
00075        
00076        long                               GetNumNodes();
00077        
00078 protected:
00079 
00080        // your implementation should override these.
00081        virtual int                        ReplaceNode(CPatriciaNode**nodeDataPtr, TPatriciaKey key, CPatriciaNode *replaceData);
00082        virtual int                        FreeNode(CPatriciaNode *nodeData, TPatriciaKey key);
00083 
00084 private:
00085 
00086        // static callbacks.
00087        static int                         NodeReplaceCallback(void**nodeDataPtr, unsigned char *key, void *replaceData, void *refCon);
00088        static int                         NodeFreeCallback(void *nodeData, unsigned char *key, void *refCon);
00089 
00090 protected:
00091 
00092        PatriciaTreeRef             mTree;
00093        long                               mKeyBits;
00094 
00095 };
00096 
00097 
00098 
00099 
00100 #endif // PatricaTree_h_
00101