Back to index

lightning-sunbird  0.9+nobinonly
morkYarn.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 _MORKYARN_
00039 #define _MORKYARN_ 1
00040 
00041 #ifndef _MORK_
00042 #include "mork.h"
00043 #endif
00044 
00045 //3456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789
00046 
00047 
00048 #define morkDerived_kYarn     /*i*/ 0x7952 /* ascii 'yR' */
00049 
00050 /*| morkYarn: a reference counted nsIMdbYarn C struct.  This is for use in those
00051 **| few cases where single instances of reference counted buffers are needed
00052 **| in Mork, and we expect few enough instances that overhead is not a factor
00053 **| in decided whether to use such a thing.
00054 |*/
00055 class morkYarn : public morkNode { // refcounted yarn
00056   
00057 // public: // slots inherited from morkNode (meant to inform only)
00058   // nsIMdbHeap*       mNode_Heap;
00059 
00060   // mork_base      mNode_Base;     // must equal morkBase_kNode
00061   // mork_derived   mNode_Derived;  // depends on specific node subclass
00062   
00063   // mork_access    mNode_Access;   // kOpen, kClosing, kShut, or kDead
00064   // mork_usage     mNode_Usage;    // kHeap, kStack, kMember, kGlobal, kNone
00065   // mork_able      mNode_Mutable;  // can this node be modified?
00066   // mork_load      mNode_Load;     // is this node clean or dirty?
00067   
00068   // mork_uses      mNode_Uses;     // refcount for strong refs
00069   // mork_refs      mNode_Refs;     // refcount for strong refs + weak refs
00070 
00071 public: // state is public because the entire Mork system is private
00072   mdbYarn  mYarn_Body;
00073   
00074 // { ===== begin morkNode interface =====
00075 public: // morkNode virtual methods
00076   virtual void CloseMorkNode(morkEnv* ev); // CloseYarn() only if open
00077   virtual ~morkYarn(); // assert that CloseYarn() executed earlier
00078   
00079 public: // morkYarn construction & destruction
00080   morkYarn(morkEnv* ev, const morkUsage& inUsage, nsIMdbHeap* ioHeap);
00081   void CloseYarn(morkEnv* ev); // called by CloseMorkNode();
00082 
00083 private: // copying is not allowed
00084   morkYarn(const morkYarn& other);
00085   morkYarn& operator=(const morkYarn& other);
00086 
00087 public: // dynamic type identification
00088   mork_bool IsYarn() const
00089   { return IsNode() && mNode_Derived == morkDerived_kYarn; }
00090 // } ===== end morkNode methods =====
00091 
00092 public: // typing
00093   static void NonYarnTypeError(morkEnv* ev);
00094 
00095 public: // typesafe refcounting inlines calling inherited morkNode methods
00096   static void SlotWeakYarn(morkYarn* me,
00097     morkEnv* ev, morkYarn** ioSlot)
00098   { morkNode::SlotWeakNode((morkNode*) me, ev, (morkNode**) ioSlot); }
00099   
00100   static void SlotStrongYarn(morkYarn* me,
00101     morkEnv* ev, morkYarn** ioSlot)
00102   { morkNode::SlotStrongNode((morkNode*) me, ev, (morkNode**) ioSlot); }
00103 };
00104 
00105 //3456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789
00106 
00107 #endif /* _MORKYARN_ */