summaryrefslogtreecommitdiffstats
path: root/comm/mailnews/db/mork/morkSearchRowCursor.h
blob: c267f35bf6b8d1a52b19a37fee85995327a48167 (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
/* -*- 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 _MORKSEARCHROWCURSOR_
#define _MORKSEARCHROWCURSOR_ 1

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

#ifndef _MORKCURSOR_
#  include "morkCursor.h"
#endif

#ifndef _MORKTABLEROWCURSOR_
#  include "morkTableRowCursor.h"
#endif

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

// 456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789

class morkUniqRowCursor;
class orkinTableRowCursor;
// #define morkDerived_kSearchRowCursor  /*i*/ 0x7352 /* ascii 'sR' */

class morkSearchRowCursor : public morkTableRowCursor {  // row iterator

  // public: // slots inherited from morkObject (meant to inform only)
  // nsIMdbHeap*     mNode_Heap;
  // mork_able    mNode_Mutable; // can this node be modified?
  // mork_load    mNode_Load;    // is this node clean or dirty?
  // mork_base    mNode_Base;    // must equal morkBase_kNode
  // mork_derived mNode_Derived; // depends on specific node subclass
  // mork_access  mNode_Access;  // kOpen, kClosing, kShut, or kDead
  // mork_usage   mNode_Usage;   // kHeap, kStack, kMember, kGlobal, kNone
  // mork_uses    mNode_Uses;    // refcount for strong refs
  // mork_refs    mNode_Refs;    // refcount for strong refs + weak refs

  // morkFactory* mObject_Factory;  // weak ref to suite factory

  // mork_seed  mCursor_Seed;
  // mork_pos   mCursor_Pos;
  // mork_bool  mCursor_DoFailOnSeedOutOfSync;
  // mork_u1    mCursor_Pad[ 3 ]; // explicitly pad to u4 alignment

  // morkTable*  mTableRowCursor_Table; // weak ref to table

  // { ===== begin morkNode interface =====
 public:
  virtual void CloseMorkNode(morkEnv* ev);  // CloseSearchRowCursor()
  virtual ~morkSearchRowCursor();  // assert that close executed earlier

 public:  // morkSearchRowCursor construction & destruction
  morkSearchRowCursor(morkEnv* ev, const morkUsage& inUsage, nsIMdbHeap* ioHeap,
                      morkTable* ioTable, mork_pos inRowPos);
  void CloseSearchRowCursor(morkEnv* ev);  // called by CloseMorkNode();

 private:  // copying is not allowed
  morkSearchRowCursor(const morkSearchRowCursor& other);
  morkSearchRowCursor& operator=(const morkSearchRowCursor& other);

  // } ===== end morkNode methods =====

 public:  // typing
  static void NonSearchRowCursorTypeError(morkEnv* ev);

 public:  // uniquify
  morkUniqRowCursor* MakeUniqCursor(morkEnv* ev);

 public:  // other search row cursor methods
  virtual mork_bool CanHaveDupRowMembers(morkEnv* ev);
  virtual mork_count GetMemberCount(morkEnv* ev);

#if 0
  virtual orkinTableRowCursor* AcquireUniqueRowCursorHandle(morkEnv* ev);
#endif

  // virtual mdb_pos NextRowOid(morkEnv* ev, mdbOid* outOid);
  virtual morkRow* NextRow(morkEnv* ev, mdbOid* outOid, mdb_pos* outPos);

 public:  // typesafe refcounting inlines calling inherited morkNode methods
  static void SlotWeakSearchRowCursor(morkSearchRowCursor* me, morkEnv* ev,
                                      morkSearchRowCursor** ioSlot) {
    morkNode::SlotWeakNode((morkNode*)me, ev, (morkNode**)ioSlot);
  }

  static void SlotStrongSearchRowCursor(morkSearchRowCursor* me, morkEnv* ev,
                                        morkSearchRowCursor** ioSlot) {
    morkNode::SlotStrongNode((morkNode*)me, ev, (morkNode**)ioSlot);
  }
};

// 456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789

#endif /* _MORKSEARCHROWCURSOR_ */