db/mork/src/morkNodeMap.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-  */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1999
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #ifndef _MORKNODEMAP_
  39 #define _MORKNODEMAP_ 1
  40
  41 #ifndef _MORK_
  42 #include "mork.h"
  43 #endif
  44
  45 #ifndef _MORKNODE_
  46 #include "morkNode.h"
  47 #endif
  48
  49 #ifndef _MORKMAP_
  50 #include "morkMap.h"
  51 #endif
  52
  53 #ifndef _MORKINTMAP_
  54 #include "morkIntMap.h"
  55 #endif
  56
  57 //3456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789
  58
  59 #define morkDerived_kNodeMap  /*i*/ 0x6E4D /* ascii 'nM' */
  60
  61 #define morkNodeMap_kStartSlotCount 512
  62
  63 /*| morkNodeMap: maps mork_token -> morkNode
  64 |*/
  65 class morkNodeMap : public morkIntMap { // for mapping tokens to nodes
  66
  67 // { ===== begin morkNode interface =====
  68 public: // morkNode virtual methods
  69   virtual void CloseMorkNode(morkEnv* ev); // CloseNodeMap() only if open
  70   virtual ~morkNodeMap(); // assert that CloseNodeMap() executed earlier
  71
  72 public: // morkMap construction & destruction
  73   morkNodeMap(morkEnv* ev, const morkUsage& inUsage,
  74     nsIMdbHeap* ioHeap, nsIMdbHeap* ioSlotHeap);
  75   void CloseNodeMap(morkEnv* ev); // called by CloseMorkNode();
  76
  77 public: // dynamic type identification
  78   mork_bool IsNodeMap() const
  79   { return IsNode() && mNode_Derived == morkDerived_kNodeMap; }
  80 // } ===== end morkNode methods =====
  81
  82 // { ===== begin morkMap poly interface =====
  83   // use the Equal() and Hash() for mork_u4 inherited from morkIntMap
  84 // } ===== end morkMap poly interface =====
  85
  86 protected: // we want all subclasses to provide typesafe wrappers:
  87
  88   mork_bool  AddNode(morkEnv* ev, mork_token inToken, morkNode* ioNode);
  89   // the AddNode() boolean return equals ev->Good().
  90
  91   mork_bool  CutNode(morkEnv* ev, mork_token inToken);
  92   // The CutNode() boolean return indicates whether removal happened.
  93
  94   morkNode*  GetNode(morkEnv* ev, mork_token inToken);
  95   // Note the returned node does NOT have an increase in refcount for this.
  96
  97   mork_num CutAllNodes(morkEnv* ev);
  98   // CutAllNodes() releases all the reference node values.
  99 };
 100
 101 class morkNodeMapIter: public morkMapIter{ // typesafe wrapper class
 102
 103 public:
 104   morkNodeMapIter(morkEnv* ev, morkNodeMap* ioMap)
 105   : morkMapIter(ev, ioMap) { }
 106
 107   morkNodeMapIter( ) : morkMapIter()  { }
 108   void InitNodeMapIter(morkEnv* ev, morkNodeMap* ioMap)
 109   { this->InitMapIter(ev, ioMap); }
 110
 111   mork_change*
 112   FirstNode(morkEnv* ev, mork_token* outToken, morkNode** outNode)
 113   { return this->First(ev, outToken, outNode); }
 114
 115   mork_change*
 116   NextNode(morkEnv* ev, mork_token* outToken, morkNode** outNode)
 117   { return this->Next(ev, outToken, outNode); }
 118
 119   mork_change*
 120   HereNode(morkEnv* ev, mork_token* outToken, morkNode** outNode)
 121   { return this->Here(ev, outToken, outNode); }
 122
 123   mork_change*
 124   CutHereNode(morkEnv* ev, mork_token* outToken, morkNode** outNode)
 125   { return this->CutHere(ev, outToken, outNode); }
 126 };
 127
 128 //3456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789
 129
 130 #endif /* _MORKNODEMAP_ */