Back to index

lightning-sunbird  0.9+nobinonly
morkSearchRowCursor.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 _MORKSEARCHROWCURSOR_
00039 #define _MORKSEARCHROWCURSOR_ 1
00040 
00041 #ifndef _MORK_
00042 #include "mork.h"
00043 #endif
00044 
00045 #ifndef _MORKCURSOR_
00046 #include "morkCursor.h"
00047 #endif
00048 
00049 #ifndef _MORKTABLEROWCURSOR_
00050 #include "morkTableRowCursor.h"
00051 #endif
00052 
00053 #ifndef _MORKMAP_
00054 #include "morkMap.h"
00055 #endif
00056 
00057 //3456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789
00058 
00059 class morkUniqRowCursor;
00060 class orkinTableRowCursor;
00061 // #define morkDerived_kSearchRowCursor  /*i*/ 0x7352 /* ascii 'sR' */
00062 
00063 class morkSearchRowCursor : public morkTableRowCursor { // row iterator
00064 
00065 // public: // slots inherited from morkObject (meant to inform only)
00066   // nsIMdbHeap*     mNode_Heap;
00067   // mork_able    mNode_Mutable; // can this node be modified?
00068   // mork_load    mNode_Load;    // is this node clean or dirty?
00069   // mork_base    mNode_Base;    // must equal morkBase_kNode
00070   // mork_derived mNode_Derived; // depends on specific node subclass
00071   // mork_access  mNode_Access;  // kOpen, kClosing, kShut, or kDead
00072   // mork_usage   mNode_Usage;   // kHeap, kStack, kMember, kGlobal, kNone
00073   // mork_uses    mNode_Uses;    // refcount for strong refs
00074   // mork_refs    mNode_Refs;    // refcount for strong refs + weak refs
00075 
00076   // morkFactory* mObject_Factory;  // weak ref to suite factory
00077 
00078   // mork_seed  mCursor_Seed;
00079   // mork_pos   mCursor_Pos;
00080   // mork_bool  mCursor_DoFailOnSeedOutOfSync;
00081   // mork_u1    mCursor_Pad[ 3 ]; // explicitly pad to u4 alignment
00082 
00083   // morkTable*  mTableRowCursor_Table; // weak ref to table
00084 
00085 public: // state is public because the entire Mork system is private
00086     
00087 // { ===== begin morkNode interface =====
00088 public: // morkNode virtual methods
00089   virtual void CloseMorkNode(morkEnv* ev); // CloseSearchRowCursor()
00090   virtual ~morkSearchRowCursor(); // assert that close executed earlier
00091   
00092 public: // morkSearchRowCursor construction & destruction
00093   morkSearchRowCursor(morkEnv* ev, const morkUsage& inUsage,
00094     nsIMdbHeap* ioHeap, morkTable* ioTable, mork_pos inRowPos);
00095   void CloseSearchRowCursor(morkEnv* ev); // called by CloseMorkNode();
00096 
00097 private: // copying is not allowed
00098   morkSearchRowCursor(const morkSearchRowCursor& other);
00099   morkSearchRowCursor& operator=(const morkSearchRowCursor& other);
00100 
00101 public: // dynamic type identification
00102   // mork_bool IsSearchRowCursor() const
00103   // { return IsNode() && mNode_Derived == morkDerived_kSearchRowCursor; }
00104 // } ===== end morkNode methods =====
00105 
00106 public: // typing
00107   static void NonSearchRowCursorTypeError(morkEnv* ev);
00108 
00109 public: // uniquify
00110 
00111   morkUniqRowCursor* MakeUniqCursor(morkEnv* ev);
00112 
00113 public: // other search row cursor methods
00114 
00115   virtual mork_bool CanHaveDupRowMembers(morkEnv* ev);
00116   virtual mork_count GetMemberCount(morkEnv* ev);
00117 
00118 #if 0
00119   virtual orkinTableRowCursor* AcquireUniqueRowCursorHandle(morkEnv* ev);
00120 #endif
00121 
00122   // virtual mdb_pos NextRowOid(morkEnv* ev, mdbOid* outOid);
00123   virtual morkRow* NextRow(morkEnv* ev, mdbOid* outOid, mdb_pos* outPos);
00124 
00125 public: // typesafe refcounting inlines calling inherited morkNode methods
00126   static void SlotWeakSearchRowCursor(morkSearchRowCursor* me,
00127     morkEnv* ev, morkSearchRowCursor** ioSlot)
00128   { morkNode::SlotWeakNode((morkNode*) me, ev, (morkNode**) ioSlot); }
00129   
00130   static void SlotStrongSearchRowCursor(morkSearchRowCursor* me,
00131     morkEnv* ev, morkSearchRowCursor** ioSlot)
00132   { morkNode::SlotStrongNode((morkNode*) me, ev, (morkNode**) ioSlot); }
00133 };
00134 
00135 //3456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789
00136 
00137 #endif /* _MORKSEARCHROWCURSOR_ */