office-gobmx/store/source/storlckb.hxx
2001-03-13 20:07:32 +00:00

337 lines
8.9 KiB
C++

/*************************************************************************
*
* $RCSfile: storlckb.hxx,v $
*
* $Revision: 1.2 $
*
* last change: $Author: mhu $ $Date: 2001-03-13 21:03:26 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source 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.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): Matthias Huetsch <matthias.huetsch@sun.com>
*
*
************************************************************************/
#ifndef _STORE_STORLCKB_HXX_
#define _STORE_STORLCKB_HXX_ "$Revision: 1.2 $"
#ifndef _SAL_TYPES_H_
#include <sal/types.h>
#endif
#ifndef _RTL_TEXTCVT_H_
#include <rtl/textcvt.h>
#endif
#ifndef _RTL_USTRING_H_
#include <rtl/ustring.h>
#endif
#ifndef _RTL_REF_HXX_
#include <rtl/ref.hxx>
#endif
#ifndef _STORE_OBJECT_HXX_
#include <store/object.hxx>
#endif
#ifndef _STORE_LOCKBYTE_HXX_
#include <store/lockbyte.hxx>
#endif
#ifndef _STORE_STORBASE_HXX_
#include <storbase.hxx>
#endif
#ifndef _STORE_STORPAGE_HXX_
#include <storpage.hxx>
#endif
namespace store
{
struct OStoreDataPageData;
struct OStoreDirectoryPageData;
struct OStoreIndirectionPageData;
/*========================================================================
*
* OStoreDirectory interface.
*
*======================================================================*/
class OStoreDirectory : public store::OStoreObject
{
public:
/** Construction.
*/
OStoreDirectory (void);
/** create (two-phase construction).
* @param pManager [in]
* @param pszPath [in]
* @param pszName [in]
* @param eAccessMode [in]
* @return store_E_None upon success.
*/
storeError create (
OStorePageManager *pManager,
rtl_uString *pPath,
rtl_uString *pName,
storeAccessMode eAccessMode);
/** iterate.
* @param rFindData [out]
* @return store_E_None upon success,
* store_E_NoMoreFiles upon end of iteration.
*/
storeError iterate (
storeFindData &rFindData);
/** IStoreHandle.
*/
virtual sal_Bool SAL_CALL isKindOf (sal_uInt32 nTypeId);
protected:
/** Destruction.
*/
virtual ~OStoreDirectory (void);
private:
/** IStoreHandle TypeId.
*/
static const sal_uInt32 m_nTypeId;
/** IStoreHandle query() template function specialization.
*/
friend inline OStoreDirectory*
SAL_CALL query (IStoreHandle *pHandle, OStoreDirectory*);
/** Representation.
*/
rtl::Reference<OStorePageManager> m_xManager;
typedef OStoreDirectoryPageData inode;
inode *m_pNode;
OStorePageDescriptor m_aDescr;
sal_uInt32 m_nPath;
rtl_TextToUnicodeConverter m_hTextCvt;
/** Not implemented.
*/
OStoreDirectory (const OStoreDirectory&);
OStoreDirectory& operator= (const OStoreDirectory&);
};
inline OStoreDirectory*
SAL_CALL query (IStoreHandle *pHandle, OStoreDirectory*)
{
if (pHandle && pHandle->isKindOf (OStoreDirectory::m_nTypeId))
{
// Handle is kind of OStoreDirectory.
return static_cast<OStoreDirectory*>(pHandle);
}
return 0;
}
/*========================================================================
*
* OStoreLockBytes interface.
*
*======================================================================*/
class OStoreLockBytes :
public store::OStoreObject,
public store::ILockBytes
{
public:
/** Construction.
*/
OStoreLockBytes (void);
/** create (two-phase construction).
* @param pManager [in]
* @param rNode [in]
* @param eMode [in]
* @return store_E_None upon success
*/
storeError create (
OStorePageManager *pManager,
rtl_uString *pPath,
rtl_uString *pName,
storeAccessMode eAccessMode);
/** Read at Offset into Buffer.
* @param nOffset [in]
* @param pBuffer [out]
* @param nBytes [in]
* @param rnDone [out]
* @return store_E_None upon success
*/
virtual storeError readAt (
sal_uInt32 nOffset,
void *pBuffer,
sal_uInt32 nBytes,
sal_uInt32 &rnDone);
/** Write at Offset from Buffer.
* @param nOffset [in]
* @param pBuffer [in]
* @param nBytes [in]
* @param rnDone [out]
* @return store_E_None upon success
*/
virtual storeError writeAt (
sal_uInt32 nOffset,
const void *pBuffer,
sal_uInt32 nBytes,
sal_uInt32 &rnDone);
/** flush.
* @return store_E_None upon success
*/
virtual storeError flush (void);
/** setSize.
* @param nSize [in]
* @return store_E_None upon success
*/
virtual storeError setSize (sal_uInt32 nSize);
/** stat.
* @paran rnSize [out]
* @return store_E_None upon success
*/
virtual storeError stat (sal_uInt32 &rnSize);
/** Lock range at Offset.
* @param nOffset [in]
* @param nBytes [in]
* @return store_E_None upon success
* store_E_LockingViolation
*/
virtual storeError lockRange (
sal_uInt32 nOffset,
sal_uInt32 nBytes);
/** Unlock range at Offset.
* @param nOffset [in]
* @param nBytes [in]
* @return store_E_None upon success
* store_E_LockingViolation
*/
virtual storeError unlockRange (
sal_uInt32 nOffset,
sal_uInt32 nBytes);
/** IStoreHandle.
*/
virtual sal_Bool SAL_CALL isKindOf (sal_uInt32 nMagic);
/** Delegate multiple inherited IReference.
*/
virtual oslInterlockedCount SAL_CALL acquire (void);
virtual oslInterlockedCount SAL_CALL release (void);
protected:
/** Destruction (OReference).
*/
virtual ~OStoreLockBytes (void);
private:
/** IStoreHandle TypeId.
*/
static const sal_uInt32 m_nTypeId;
/** IStoreHandle query() template specialization.
*/
friend inline OStoreLockBytes*
SAL_CALL query (IStoreHandle *pHandle, OStoreLockBytes*);
/** Representation.
*/
rtl::Reference<OStorePageManager> m_xManager;
typedef OStoreDataPageData data;
typedef OStoreDirectoryPageData inode;
typedef OStoreIndirectionPageData indirect;
inode *m_pNode;
data *m_pData;
indirect *m_pSingle;
indirect *m_pDouble;
indirect *m_pTriple;
sal_Bool m_bWriteable;
sal_uInt16 m_nPageSize;
/** Not implemented.
*/
OStoreLockBytes (const OStoreLockBytes&);
OStoreLockBytes& operator= (const OStoreLockBytes&);
};
inline OStoreLockBytes*
SAL_CALL query (IStoreHandle *pHandle, OStoreLockBytes*)
{
if (pHandle && pHandle->isKindOf (OStoreLockBytes::m_nTypeId))
{
// Handle is kind of OStoreLockBytes.
return static_cast<OStoreLockBytes*>(pHandle);
}
return 0;
}
/*========================================================================
*
* The End.
*
*======================================================================*/
} // namespace store
#endif /* !_STORE_STORLCKB_HXX_ */