summaryrefslogtreecommitdiffstats
path: root/comm/mailnews/db/mork/morkNodeMap.h
blob: c2edc7007eeca41e62a5b7fa39864170698fc72c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-  */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef _MORKNODEMAP_
#define _MORKNODEMAP_ 1

#ifndef _MORK_
#  include "mork.h"
#endif

#ifndef _MORKNODE_
#  include "morkNode.h"
#endif

#ifndef _MORKMAP_
#  include "morkMap.h"
#endif

#ifndef _MORKINTMAP_
#  include "morkIntMap.h"
#endif

// 456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789

#define morkDerived_kNodeMap /*i*/ 0x6E4D /* ascii 'nM' */

#define morkNodeMap_kStartSlotCount 512

/*| morkNodeMap: maps mork_token -> morkNode
|*/
class morkNodeMap : public morkIntMap {  // for mapping tokens to nodes

  // { ===== begin morkNode interface =====
 public:  // morkNode virtual methods
  virtual void CloseMorkNode(
      morkEnv* ev) override;  // CloseNodeMap() only if open
  virtual ~morkNodeMap();     // assert that CloseNodeMap() executed earlier

 public:  // morkMap construction & destruction
  morkNodeMap(morkEnv* ev, const morkUsage& inUsage, nsIMdbHeap* ioHeap,
              nsIMdbHeap* ioSlotHeap);
  void CloseNodeMap(morkEnv* ev);  // called by CloseMorkNode();

 public:  // dynamic type identification
  mork_bool IsNodeMap() const {
    return IsNode() && mNode_Derived == morkDerived_kNodeMap;
  }
  // } ===== end morkNode methods =====

  // { ===== begin morkMap poly interface =====
  // use the Equal() and Hash() for mork_u4 inherited from morkIntMap
  // } ===== end morkMap poly interface =====

 protected:  // we want all subclasses to provide typesafe wrappers:
  mork_bool AddNode(morkEnv* ev, mork_token inToken, morkNode* ioNode);
  // the AddNode() boolean return equals ev->Good().

  mork_bool CutNode(morkEnv* ev, mork_token inToken);
  // The CutNode() boolean return indicates whether removal happened.

  morkNode* GetNode(morkEnv* ev, mork_token inToken);
  // Note the returned node does NOT have an increase in refcount for this.

  mork_num CutAllNodes(morkEnv* ev);
  // CutAllNodes() releases all the reference node values.
};

class morkNodeMapIter : public morkMapIter {  // typesafe wrapper class

 public:
  morkNodeMapIter(morkEnv* ev, morkNodeMap* ioMap) : morkMapIter(ev, ioMap) {}

  morkNodeMapIter() : morkMapIter() {}
  void InitNodeMapIter(morkEnv* ev, morkNodeMap* ioMap) {
    this->InitMapIter(ev, ioMap);
  }

  mork_change* FirstNode(morkEnv* ev, mork_token* outToken,
                         morkNode** outNode) {
    return this->First(ev, outToken, outNode);
  }

  mork_change* NextNode(morkEnv* ev, mork_token* outToken, morkNode** outNode) {
    return this->Next(ev, outToken, outNode);
  }

  mork_change* HereNode(morkEnv* ev, mork_token* outToken, morkNode** outNode) {
    return this->Here(ev, outToken, outNode);
  }

  mork_change* CutHereNode(morkEnv* ev, mork_token* outToken,
                           morkNode** outNode) {
    return this->CutHere(ev, outToken, outNode);
  }
};

// 456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789

#endif /* _MORKNODEMAP_ */