Back to index

lightning-sunbird  0.9+nobinonly
morkSpace.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 _MORKSPACE_
00039 #define _MORKSPACE_ 1
00040 
00041 #ifndef _MORK_
00042 #include "mork.h"
00043 #endif
00044 
00045 #ifndef _MORKNODE_
00046 #include "morkNode.h"
00047 #endif
00048 
00049 #ifndef _MORKBEAD_
00050 #include "morkBead.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 #define morkSpace_kInitialSpaceSlots  /*i*/ 1024 /* default */
00060 #define morkDerived_kSpace  /*i*/ 0x5370 /* ascii 'Sp' */
00061 
00062 /*| morkSpace:
00063 |*/
00064 class morkSpace : public morkBead { // 
00065 
00066 // public: // slots inherited from morkNode (meant to inform only)
00067   // nsIMdbHeap*       mNode_Heap;
00068 
00069   // mork_base      mNode_Base;     // must equal morkBase_kNode
00070   // mork_derived   mNode_Derived;  // depends on specific node subclass
00071   
00072   // mork_access    mNode_Access;   // kOpen, kClosing, kShut, or kDead
00073   // mork_usage     mNode_Usage;    // kHeap, kStack, kMember, kGlobal, kNone
00074   // mork_able      mNode_Mutable;  // can this node be modified?
00075   // mork_load      mNode_Load;     // is this node clean or dirty?
00076   
00077   // mork_uses      mNode_Uses;     // refcount for strong refs
00078   // mork_refs      mNode_Refs;     // refcount for strong refs + weak refs
00079 
00080   // mork_color      mBead_Color;   // ID for this bead
00081 
00082 public: // bead color setter & getter replace obsolete member mTable_Id:
00083 
00084   mork_tid     SpaceScope() const { return mBead_Color; }
00085   void         SetSpaceScope(mork_scope inScope) { mBead_Color = inScope; }
00086 
00087 public: // state is public because the entire Mork system is private
00088 
00089   morkStore*  mSpace_Store; // weak ref to containing store
00090     
00091   mork_bool   mSpace_DoAutoIDs;    // whether db should assign member IDs
00092   mork_bool   mSpace_HaveDoneAutoIDs; // whether actually auto assigned IDs
00093   mork_bool   mSpace_CanDirty; // changes imply the store becomes dirty?
00094   mork_u1     mSpace_Pad;    // pad to u4 alignment
00095 
00096 public: // more specific dirty methods for space:
00097   void SetSpaceDirty() { this->SetNodeDirty(); }
00098   void SetSpaceClean() { this->SetNodeClean(); }
00099   
00100   mork_bool IsSpaceClean() const { return this->IsNodeClean(); }
00101   mork_bool IsSpaceDirty() const { return this->IsNodeDirty(); }
00102 
00103 // { ===== begin morkNode interface =====
00104 public: // morkNode virtual methods
00105   virtual void CloseMorkNode(morkEnv* ev); // CloseSpace() only if open
00106   virtual ~morkSpace(); // assert that CloseSpace() executed earlier
00107   
00108 public: // morkMap construction & destruction
00109   //morkSpace(morkEnv* ev, const morkUsage& inUsage, nsIMdbHeap* ioNodeHeap,
00110   //  const morkMapForm& inForm, nsIMdbHeap* ioSlotHeap);
00111   
00112   morkSpace(morkEnv* ev, const morkUsage& inUsage,mork_scope inScope, 
00113     morkStore* ioStore, nsIMdbHeap* ioNodeHeap, nsIMdbHeap* ioSlotHeap);
00114   void CloseSpace(morkEnv* ev); // called by CloseMorkNode();
00115 
00116 public: // dynamic type identification
00117   mork_bool IsSpace() const
00118   { return IsNode() && mNode_Derived == morkDerived_kSpace; }
00119 // } ===== end morkNode methods =====
00120 
00121 public: // other space methods
00122   
00123   mork_bool MaybeDirtyStoreAndSpace();
00124 
00125   static void NonAsciiSpaceScopeName(morkEnv* ev);
00126   static void NilSpaceStoreError(morkEnv* ev);
00127 
00128   morkPool* GetSpaceStorePool() const;
00129 
00130 public: // typesafe refcounting inlines calling inherited morkNode methods
00131   static void SlotWeakSpace(morkSpace* me,
00132     morkEnv* ev, morkSpace** ioSlot)
00133   { morkNode::SlotWeakNode((morkNode*) me, ev, (morkNode**) ioSlot); }
00134   
00135   static void SlotStrongSpace(morkSpace* me,
00136     morkEnv* ev, morkSpace** ioSlot)
00137   { morkNode::SlotStrongNode((morkNode*) me, ev, (morkNode**) ioSlot); }
00138 };
00139 
00140 //3456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789
00141 
00142 #endif /* _MORKSPACE_ */