Back to index

lightning-sunbird  0.9+nobinonly
morkCell.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 _MORKCELL_
00039 #define _MORKCELL_ 1
00040 
00041 #ifndef _MORK_
00042 #include "mork.h"
00043 #endif
00044 
00045 //3456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789
00046 
00047 #define morkDelta_kShift 8 /* 8 bit shift */
00048 #define morkDelta_kChangeMask 0x0FF /* low 8 bit mask */
00049 #define morkDelta_kColumnMask (~ (mork_column) morkDelta_kChangeMask)
00050 #define morkDelta_Init(self,cl,ch) ((self) = ((cl)<<morkDelta_kShift) | (ch))
00051 #define morkDelta_Change(self) ((mork_change) ((self) & morkDelta_kChangeMask))
00052 #define morkDelta_Column(self) ((self) >> morkDelta_kShift)
00053 
00054 class morkCell { // minimal cell format
00055 
00056 public:
00057   mork_delta   mCell_Delta;   // encoding of both column and change
00058   morkAtom*    mCell_Atom;    // content in this cell
00059   
00060 public:
00061   morkCell() : mCell_Delta( 0 ), mCell_Atom( 0 ) { }
00062 
00063   morkCell(const morkCell& c)
00064   : mCell_Delta( c.mCell_Delta ), mCell_Atom( c.mCell_Atom ) { }
00065   
00066   // note if ioAtom is non-nil, caller needs to call ioAtom->AddCellUse():
00067   morkCell(mork_column inCol, mork_change inChange, morkAtom* ioAtom)
00068   {
00069     morkDelta_Init(mCell_Delta, inCol,inChange);
00070     mCell_Atom = ioAtom;
00071   }
00072 
00073   // note if ioAtom is non-nil, caller needs to call ioAtom->AddCellUse():
00074   void Init(mork_column inCol, mork_change inChange, morkAtom* ioAtom)
00075   {
00076     morkDelta_Init(mCell_Delta,inCol,inChange);
00077     mCell_Atom = ioAtom;
00078   }
00079   
00080   mork_column  GetColumn() const { return morkDelta_Column(mCell_Delta); }
00081   mork_change  GetChange() const { return morkDelta_Change(mCell_Delta); }
00082   
00083   mork_bool IsCellClean() const { return GetChange() == morkChange_kNil; }
00084   mork_bool IsCellDirty() const { return GetChange() != morkChange_kNil; }
00085 
00086   void SetCellClean(); // set change to kNil
00087   void SetCellDirty(); // set change to kAdd
00088   
00089   void SetCellColumnDirty(mork_column inCol)
00090   { this->SetColumnAndChange(inCol, morkChange_kAdd); }
00091   
00092   void SetCellColumnClean(mork_column inCol)
00093   { this->SetColumnAndChange(inCol, morkChange_kNil); }
00094   
00095   void         SetColumnAndChange(mork_column inCol, mork_change inChange)
00096   { morkDelta_Init(mCell_Delta, inCol, inChange); }
00097     
00098   morkAtom*  GetAtom() { return mCell_Atom; }
00099   
00100   void       SetAtom(morkEnv* ev, morkAtom* ioAtom, morkPool* ioPool);
00101   // SetAtom() "acquires" the new ioAtom if non-nil, by calling AddCellUse()
00102   // to increase the refcount, and puts ioAtom into mCell_Atom.  If the old
00103   // atom in mCell_Atom is non-nil, then it is "released" first by a call to
00104   // CutCellUse(), and if the use count then becomes zero, then the old atom
00105   // is deallocated by returning it to the pool ioPool.  (And this is
00106   // why ioPool is a parameter to this method.)  Note that ioAtom can be nil
00107   // to cause the cell to refer to nothing, and the old atom in mCell_Atom
00108   // can also be nil, and all the atom refcounting is handled correctly.
00109   //
00110   // Note that if ioAtom was just created, it typically has a zero use count
00111   // before calling SetAtom().  But use count is one higher after SetAtom().
00112   
00113   void       SetYarn(morkEnv* ev, const mdbYarn* inYarn, morkStore* ioStore);
00114   
00115   void       AliasYarn(morkEnv* ev, mdbYarn* outYarn) const;
00116   void       GetYarn(morkEnv* ev, mdbYarn* outYarn) const;
00117 };
00118 
00119 //3456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789
00120 
00121 #endif /* _MORKCELL_ */