Back to index

lightning-sunbird  0.9+nobinonly
morkNodeMap.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-  */
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.org 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) 1999
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #ifndef _MORKNODEMAP_
00039 #define _MORKNODEMAP_ 1
00040 
00041 #ifndef _MORK_
00042 #include "mork.h"
00043 #endif
00044 
00045 #ifndef _MORKNODE_
00046 #include "morkNode.h"
00047 #endif
00048 
00049 #ifndef _MORKMAP_
00050 #include "morkMap.h"
00051 #endif
00052 
00053 #ifndef _MORKINTMAP_
00054 #include "morkIntMap.h"
00055 #endif
00056 
00057 //3456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789
00058 
00059 #define morkDerived_kNodeMap  /*i*/ 0x6E4D /* ascii 'nM' */
00060 
00061 #define morkNodeMap_kStartSlotCount 512
00062 
00063 /*| morkNodeMap: maps mork_token -> morkNode
00064 |*/
00065 class morkNodeMap : public morkIntMap { // for mapping tokens to nodes
00066 
00067 // { ===== begin morkNode interface =====
00068 public: // morkNode virtual methods
00069   virtual void CloseMorkNode(morkEnv* ev); // CloseNodeMap() only if open
00070   virtual ~morkNodeMap(); // assert that CloseNodeMap() executed earlier
00071   
00072 public: // morkMap construction & destruction
00073   morkNodeMap(morkEnv* ev, const morkUsage& inUsage,
00074     nsIMdbHeap* ioHeap, nsIMdbHeap* ioSlotHeap);
00075   void CloseNodeMap(morkEnv* ev); // called by CloseMorkNode();
00076 
00077 public: // dynamic type identification
00078   mork_bool IsNodeMap() const
00079   { return IsNode() && mNode_Derived == morkDerived_kNodeMap; }
00080 // } ===== end morkNode methods =====
00081 
00082 // { ===== begin morkMap poly interface =====
00083   // use the Equal() and Hash() for mork_u4 inherited from morkIntMap
00084 // } ===== end morkMap poly interface =====
00085 
00086 protected: // we want all subclasses to provide typesafe wrappers:
00087 
00088   mork_bool  AddNode(morkEnv* ev, mork_token inToken, morkNode* ioNode);
00089   // the AddNode() boolean return equals ev->Good().
00090 
00091   mork_bool  CutNode(morkEnv* ev, mork_token inToken);
00092   // The CutNode() boolean return indicates whether removal happened. 
00093   
00094   morkNode*  GetNode(morkEnv* ev, mork_token inToken);
00095   // Note the returned node does NOT have an increase in refcount for this.
00096 
00097   mork_num CutAllNodes(morkEnv* ev);
00098   // CutAllNodes() releases all the reference node values.
00099 };
00100 
00101 class morkNodeMapIter: public morkMapIter{ // typesafe wrapper class
00102 
00103 public:
00104   morkNodeMapIter(morkEnv* ev, morkNodeMap* ioMap)
00105   : morkMapIter(ev, ioMap) { }
00106  
00107   morkNodeMapIter( ) : morkMapIter()  { }
00108   void InitNodeMapIter(morkEnv* ev, morkNodeMap* ioMap)
00109   { this->InitMapIter(ev, ioMap); }
00110    
00111   mork_change*
00112   FirstNode(morkEnv* ev, mork_token* outToken, morkNode** outNode)
00113   { return this->First(ev, outToken, outNode); }
00114   
00115   mork_change*
00116   NextNode(morkEnv* ev, mork_token* outToken, morkNode** outNode)
00117   { return this->Next(ev, outToken, outNode); }
00118   
00119   mork_change*
00120   HereNode(morkEnv* ev, mork_token* outToken, morkNode** outNode)
00121   { return this->Here(ev, outToken, outNode); }
00122   
00123   mork_change*
00124   CutHereNode(morkEnv* ev, mork_token* outToken, morkNode** outNode)
00125   { return this->CutHere(ev, outToken, outNode); }
00126 };
00127 
00128 //3456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789
00129 
00130 #endif /* _MORKNODEMAP_ */