store/source/storlckb.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: storlckb.hxx,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _STORE_STORLCKB_HXX_
  32 #define _STORE_STORLCKB_HXX_ "$Revision: 1.6.8.1 $"
  33
  34 #include "sal/types.h"
  35
  36 #include "rtl/ustring.h"
  37 #include "rtl/ref.hxx"
  38
  39 #include "object.hxx"
  40 #include "storbase.hxx"
  41 #include "storpage.hxx"
  42
  43 namespace store
  44 {
  45
  46 struct OStoreDataPageData;
  47 struct OStoreDirectoryPageData;
  48
  49 /*========================================================================
  50  *
  51  * OStoreLockBytes interface.
  52  *
  53  *======================================================================*/
  54 class OStoreLockBytes : public store::OStoreObject
  55 {
  56 public:
  57     /** Construction.
  58      */
  59     OStoreLockBytes (void);
  60
  61     /** create (two-phase construction).
  62      *  @param  pManager [in]
  63      *  @param  pPath [in]
  64      *  @param  pName [in]
  65      *  @param  eMode [in]
  66      *  @return store_E_None upon success
  67      */
  68     storeError create (
  69         OStorePageManager *pManager,
  70         rtl_String        *pPath,
  71         rtl_String        *pName,
  72         storeAccessMode    eAccessMode);
  73
  74     /** Read at Offset into Buffer.
  75      *  @param  nOffset [in]
  76      *  @param  pBuffer [out]
  77      *  @param  nBytes [in]
  78      *  @param  rnDone [out]
  79      *  @return store_E_None upon success
  80      */
  81     storeError readAt (
  82         sal_uInt32  nOffset,
  83         void       *pBuffer,
  84         sal_uInt32  nBytes,
  85         sal_uInt32 &rnDone);
  86
  87     /** Write at Offset from Buffer.
  88      *  @param  nOffset [in]
  89      *  @param  pBuffer [in]
  90      *  @param  nBytes [in]
  91      *  @param  rnDone [out]
  92      *  @return store_E_None upon success
  93      */
  94     storeError writeAt (
  95         sal_uInt32  nOffset,
  96         const void *pBuffer,
  97         sal_uInt32  nBytes,
  98         sal_uInt32 &rnDone);
  99
 100     /** flush.
 101      *  @return store_E_None upon success
 102      */
 103     storeError flush (void);
 104
 105     /** setSize.
 106      *  @param  nSize [in]
 107      *  @return store_E_None upon success
 108      */
 109     storeError setSize (sal_uInt32 nSize);
 110
 111     /** stat.
 112      *  @paran  rnSize [out]
 113      *  @return store_E_None upon success
 114      */
 115     storeError stat (sal_uInt32 &rnSize);
 116
 117     /** IStoreHandle.
 118      */
 119     virtual sal_Bool SAL_CALL isKindOf (sal_uInt32 nMagic);
 120
 121 protected:
 122     /** Destruction (OReference).
 123      */
 124     virtual ~OStoreLockBytes (void);
 125
 126 private:
 127     /** IStoreHandle TypeId.
 128      */
 129     static const sal_uInt32 m_nTypeId;
 130
 131     /** IStoreHandle query() template specialization.
 132      */
 133     friend OStoreLockBytes*
 134     SAL_CALL query<> (IStoreHandle *pHandle, OStoreLockBytes*);
 135
 136     /** Representation.
 137      */
 138     rtl::Reference<OStorePageManager> m_xManager;
 139
 140     typedef OStoreDataPageData        data;
 141     typedef OStoreDirectoryPageData   inode;
 142
 143     typedef PageHolderObject< inode > inode_holder_type;
 144     inode_holder_type                 m_xNode;
 145
 146     bool m_bWriteable;
 147
 148     /** Not implemented.
 149      */
 150     OStoreLockBytes (const OStoreLockBytes&);
 151     OStoreLockBytes& operator= (const OStoreLockBytes&);
 152 };
 153
 154 template<> inline OStoreLockBytes*
 155 SAL_CALL query (IStoreHandle *pHandle, OStoreLockBytes*)
 156 {
 157     if (pHandle && pHandle->isKindOf (OStoreLockBytes::m_nTypeId))
 158     {
 159         // Handle is kind of OStoreLockBytes.
 160         return static_cast<OStoreLockBytes*>(pHandle);
 161     }
 162     return 0;
 163 }
 164
 165 /*========================================================================
 166  *
 167  * The End.
 168  *
 169  *======================================================================*/
 170
 171 } // namespace store
 172
 173 #endif /* !_STORE_STORLCKB_HXX_ */
 174