1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-  */
2 /* This Source Code Form is subject to the terms of the Mozilla Public
3  * License, v. 2.0. If a copy of the MPL was not distributed with this
4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
5 
6 #ifndef _MORKARRAY_
7 #define _MORKARRAY_ 1
8 
9 #ifndef _MORK_
10 #  include "mork.h"
11 #endif
12 
13 #ifndef _MORKNODE_
14 #  include "morkNode.h"
15 #endif
16 
17 // 456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789
18 
19 #define morkDerived_kArray /*i*/ 0x4179 /* ascii 'Ay' */
20 
21 class morkArray : public morkNode {  // row iterator
22 
23   // public: // slots inherited from morkObject (meant to inform only)
24   // nsIMdbHeap*     mNode_Heap;
25   // mork_able    mNode_Mutable; // can this node be modified?
26   // mork_load    mNode_Load;    // is this node clean or dirty?
27   // mork_base    mNode_Base;    // must equal morkBase_kNode
28   // mork_derived mNode_Derived; // depends on specific node subclass
29   // mork_access  mNode_Access;  // kOpen, kClosing, kShut, or kDead
30   // mork_usage   mNode_Usage;   // kHeap, kStack, kMember, kGlobal, kNone
31   // mork_uses    mNode_Uses;    // refcount for strong refs
32   // mork_refs    mNode_Refs;    // refcount for strong refs + weak refs
33 
34  public:  // state is public because the entire Mork system is private
35   void** mArray_Slots;      // array of pointers
36   nsIMdbHeap* mArray_Heap;  // required heap for allocating mArray_Slots
37   mork_fill mArray_Fill;    // logical count of used slots in mArray_Slots
38   mork_size mArray_Size;    // physical count of mArray_Slots ( >= Fill)
39   mork_seed mArray_Seed;    // change counter for syncing with iterators
40 
41   // { ===== begin morkNode interface =====
42  public:                                             // morkNode virtual methods
43   virtual void CloseMorkNode(morkEnv* ev) override;  // CloseArray()
44   virtual ~morkArray();  // assert that close executed earlier
45 
46  public:  // morkArray construction & destruction
47   morkArray(morkEnv* ev, const morkUsage& inUsage, nsIMdbHeap* ioHeap,
48             mork_size inSize, nsIMdbHeap* ioSlotHeap);
49   void CloseArray(morkEnv* ev);  // called by CloseMorkNode();
50 
51  private:  // copying is not allowed
52   morkArray(const morkArray& other);
53   morkArray& operator=(const morkArray& other);
54 
55  public:  // dynamic type identification
IsArray()56   mork_bool IsArray() const {
57     return IsNode() && mNode_Derived == morkDerived_kArray;
58   }
59   // } ===== end morkNode methods =====
60 
61  public:  // typing & errors
62   static void NonArrayTypeError(morkEnv* ev);
63   static void IndexBeyondEndError(morkEnv* ev);
64   static void NilSlotsAddressError(morkEnv* ev);
65   static void FillBeyondSizeError(morkEnv* ev);
66 
67  public:  // other table row cursor methods
Length()68   mork_fill Length() const { return mArray_Fill; }
Capacity()69   mork_size Capacity() const { return mArray_Size; }
70 
71   mork_bool Grow(morkEnv* ev, mork_size inNewSize);
72   // Grow() returns true if capacity becomes >= inNewSize and ev->Good()
73 
At(mork_pos inPos)74   void* At(mork_pos inPos) const { return mArray_Slots[inPos]; }
AtPut(mork_pos inPos,void * ioSlot)75   void AtPut(mork_pos inPos, void* ioSlot) { mArray_Slots[inPos] = ioSlot; }
76 
77   void* SafeAt(morkEnv* ev, mork_pos inPos);
78   void SafeAtPut(morkEnv* ev, mork_pos inPos, void* ioSlot);
79 
80   mork_pos AppendSlot(morkEnv* ev, void* ioSlot);
81   void AddSlot(morkEnv* ev, mork_pos inPos, void* ioSlot);
82   void CutSlot(morkEnv* ev, mork_pos inPos);
83   void CutAllSlots(morkEnv* ev);
84 
85  public:  // typesafe refcounting inlines calling inherited morkNode methods
SlotWeakArray(morkArray * me,morkEnv * ev,morkArray ** ioSlot)86   static void SlotWeakArray(morkArray* me, morkEnv* ev, morkArray** ioSlot) {
87     morkNode::SlotWeakNode((morkNode*)me, ev, (morkNode**)ioSlot);
88   }
89 
SlotStrongArray(morkArray * me,morkEnv * ev,morkArray ** ioSlot)90   static void SlotStrongArray(morkArray* me, morkEnv* ev, morkArray** ioSlot) {
91     morkNode::SlotStrongNode((morkNode*)me, ev, (morkNode**)ioSlot);
92   }
93 };
94 
95 // 456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789
96 
97 #endif /* _MORKTABLEROWCURSOR_ */
98