/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ /* ***** BEGIN LICENSE BLOCK ***** * Version: NPL 1.1/GPL 2.0/LGPL 2.1 * * The contents of this file are subject to the Netscape Public License * Version 1.1 (the "License"); you may not use this file except in * compliance with the License. You may obtain a copy of the License at * http://www.mozilla.org/NPL/ * * Software distributed under the License is distributed on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License * for the specific language governing rights and limitations under the * License. * * The Original Code is mozilla.org code. * * The Initial Developer of the Original Code is * Netscape Communications Corporation. * Portions created by the Initial Developer are Copyright (C) 1999 * the Initial Developer. All Rights Reserved. * * Contributor(s): * * * Alternatively, the contents of this file may be used under the terms of * either the GNU General Public License Version 2 or later (the "GPL"), or * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), * in which case the provisions of the GPL or the LGPL are applicable instead * of those above. If you wish to allow use of your version of this file only * under the terms of either the GPL or the LGPL, and not to allow others to * use your version of this file under the terms of the NPL, indicate your * decision by deleting the provisions above and replace them with the notice * and other provisions required by the GPL or the LGPL. If you do not delete * the provisions above, a recipient may use your version of this file under * the terms of any one of the NPL, the GPL or the LGPL. * * ***** END LICENSE BLOCK ***** */ #ifndef _ORKINROWCELLCURSOR_ #define _ORKINROWCELLCURSOR_ 1 #ifndef _MDB_ #include "mdb.h" #endif #ifndef _MORK_ #include "mork.h" #endif #ifndef _MORKNODE_ #include "morkNode.h" #endif #ifndef _MORKHANDLE_ #include "morkHandle.h" #endif #ifndef _MORKROWCELLCURSOR_ #include "morkRowCellCursor.h" #endif //3456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789 #define morkMagic_kRowCellCursor 0x52634375 /* ascii 'RcCu' */ /*| orkinRowCellCursor: cursor class for iterating row cells **| **|| row: the cursor is associated with a specific row, which can be **| set to a different row (which resets the position to -1 so the **| next cell acquired is the first in the row. **| **|| NextCell: get the next cell in the row and return its position and **| a new instance of a nsIMdbCell to represent this next cell. |*/ class orkinRowCellCursor : public morkHandle, public nsIMdbRowCellCursor { // nsIMdbCursor // { ===== begin morkNode interface ===== public: // morkNode virtual methods // virtual void CloseMorkNode(morkEnv* ev); // morkHandle is fine virtual ~orkinRowCellCursor(); // morkHandle destructor does everything protected: // construction is protected (use the static Make() method) orkinRowCellCursor(morkEnv* ev, // note morkUsage is always morkUsage_kPool morkHandleFace* ioFace, // must not be nil, cookie for this handle morkRowCellCursor* ioObject); // must not be nil, the object for this handle // void CloseHandle(morkEnv* ev); // don't need to specialize closing private: // copying is not allowed orkinRowCellCursor(const morkHandle& other); orkinRowCellCursor& operator=(const morkHandle& other); // public: // dynamic type identification // mork_bool IsHandle() const // // { return IsNode() && mNode_Derived == morkDerived_kHandle; } // } ===== end morkNode methods ===== protected: // morkHandle memory management operators void* operator new(size_t inSize, morkPool& ioPool, morkZone& ioZone, morkEnv* ev) { return ioPool.NewHandle(ev, inSize, &ioZone); } void* operator new(size_t inSize, morkPool& ioPool, morkEnv* ev) { return ioPool.NewHandle(ev, inSize, (morkZone*) 0); } void* operator new(size_t inSize, morkHandleFace* ioFace) { MORK_USED_1(inSize); return ioFace; } public: // construction: static orkinRowCellCursor* MakeRowCellCursor(morkEnv* ev, morkRowCellCursor* ioObject); public: // utilities: morkEnv* CanUseRowCellCursor(nsIMdbEnv* mev, mork_bool inMutable, mdb_err* outErr, morkRow** outRow) const; public: // type identification mork_bool IsOrkinRowCellCursor() const { return mHandle_Magic == morkMagic_kRowCellCursor; } mork_bool IsOrkinRowCellCursorHandle() const { return this->IsHandle() && this->IsOrkinRowCellCursor(); } NS_DECL_ISUPPORTS // { ===== begin nsIMdbObject methods ===== // { ----- begin attribute methods ----- NS_IMETHOD IsFrozenMdbObject(nsIMdbEnv* ev, mdb_bool* outIsReadonly); // same as nsIMdbPort::GetIsPortReadonly() when this object is inside a port. // } ----- end attribute methods ----- // { ----- begin factory methods ----- NS_IMETHOD GetMdbFactory(nsIMdbEnv* ev, nsIMdbFactory** acqFactory); // } ----- end factory methods ----- // { ----- begin ref counting for well-behaved cyclic graphs ----- NS_IMETHOD GetWeakRefCount(nsIMdbEnv* ev, // weak refs mdb_count* outCount); NS_IMETHOD GetStrongRefCount(nsIMdbEnv* ev, // strong refs mdb_count* outCount); NS_IMETHOD AddWeakRef(nsIMdbEnv* ev); NS_IMETHOD AddStrongRef(nsIMdbEnv* ev); NS_IMETHOD CutWeakRef(nsIMdbEnv* ev); NS_IMETHOD CutStrongRef(nsIMdbEnv* ev); NS_IMETHOD CloseMdbObject(nsIMdbEnv* ev); // called at strong refs zero NS_IMETHOD IsOpenMdbObject(nsIMdbEnv* ev, mdb_bool* outOpen); // } ----- end ref counting ----- // } ===== end nsIMdbObject methods ===== // { ===== begin nsIMdbCursor methods ===== // { ----- begin attribute methods ----- NS_IMETHOD GetCount(nsIMdbEnv* ev, mdb_count* outCount); // readonly NS_IMETHOD GetSeed(nsIMdbEnv* ev, mdb_seed* outSeed); // readonly NS_IMETHOD SetPos(nsIMdbEnv* ev, mdb_pos inPos); // mutable NS_IMETHOD GetPos(nsIMdbEnv* ev, mdb_pos* outPos); NS_IMETHOD SetDoFailOnSeedOutOfSync(nsIMdbEnv* ev, mdb_bool inFail); NS_IMETHOD GetDoFailOnSeedOutOfSync(nsIMdbEnv* ev, mdb_bool* outFail); // } ----- end attribute methods ----- // } ===== end nsIMdbCursor methods ===== // { ===== begin nsIMdbRowCellCursor methods ===== // { ----- begin attribute methods ----- NS_IMETHOD SetRow(nsIMdbEnv* ev, nsIMdbRow* ioRow); // sets pos to -1 NS_IMETHOD GetRow(nsIMdbEnv* ev, nsIMdbRow** acqRow); // } ----- end attribute methods ----- // { ----- begin cell creation methods ----- NS_IMETHOD MakeCell( // get cell at current pos in the row nsIMdbEnv* ev, // context mdb_column* outColumn, // column for this particular cell mdb_pos* outPos, // position of cell in row sequence nsIMdbCell** acqCell); // the cell at inPos // } ----- end cell creation methods ----- // { ----- begin cell seeking methods ----- NS_IMETHOD SeekCell( // same as SetRow() followed by MakeCell() nsIMdbEnv* ev, // context mdb_pos inPos, // position of cell in row sequence mdb_column* outColumn, // column for this particular cell nsIMdbCell** acqCell); // the cell at inPos // } ----- end cell seeking methods ----- // { ----- begin cell iteration methods ----- NS_IMETHOD NextCell( // get next cell in the row nsIMdbEnv* ev, // context nsIMdbCell* ioCell, // changes to the next cell in the iteration mdb_column* outColumn, // column for this particular cell mdb_pos* outPos); // position of cell in row sequence NS_IMETHOD PickNextCell( // get next cell in row within filter set nsIMdbEnv* ev, // context nsIMdbCell* ioCell, // changes to the next cell in the iteration const mdbColumnSet* inFilterSet, // col set of actual caller interest mdb_column* outColumn, // column for this particular cell mdb_pos* outPos); // position of cell in row sequence // Note that inFilterSet should not have too many (many more than 10?) // cols, since this might imply a potential excessive consumption of time // over many cursor calls when looking for column and filter intersection. // } ----- end cell iteration methods ----- // } ===== end nsIMdbRowCellCursor methods ===== }; //3456789_123456789_123456789_123456789_123456789_123456789_123456789_123456789 #endif /* _ORKINROWCELLCURSOR_ */