/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ /* * This file is part of the LibreOffice project. * * This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. * * This file incorporates work covered by the following license notice: * * Licensed to the Apache Software Foundation (ASF) under one or more * contributor license agreements. See the NOTICE file distributed * with this work for additional information regarding copyright * ownership. The ASF licenses this file to you under the Apache * License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 . */ #ifndef INCLUDED_STORE_STORE_HXX #define INCLUDED_STORE_STORE_HXX #include #include #include #include #include namespace store { /*======================================================================== * * OStoreStream interface. * *======================================================================*/ class OStoreStream { public: /** Construction. */ inline OStoreStream() : m_hImpl (nullptr) {} /** Destruction. */ inline ~OStoreStream() { if (m_hImpl) (void) store_releaseHandle (m_hImpl); } /** Copy construction. */ inline OStoreStream (OStoreStream const & rhs) : m_hImpl (rhs.m_hImpl) { if (m_hImpl) (void) store_acquireHandle (m_hImpl); } /** Assignment. */ inline OStoreStream & operator= (OStoreStream const & rhs) { if (rhs.m_hImpl) (void) store_acquireHandle (rhs.m_hImpl); if (m_hImpl) (void) store_releaseHandle (m_hImpl); m_hImpl = rhs.m_hImpl; return *this; } /** Construction from Stream Handle. */ inline explicit OStoreStream (storeStreamHandle Handle) : m_hImpl (Handle) { if (m_hImpl) (void) store_acquireHandle (m_hImpl); } /** Open the stream. @see store_openStream() */ inline storeError create ( storeFileHandle hFile, rtl::OUString const & rPath, rtl::OUString const & rName, storeAccessMode eMode) { if (m_hImpl) { (void) store_releaseHandle (m_hImpl); m_hImpl = nullptr; } return store_openStream (hFile, rPath.pData, rName.pData, eMode, &m_hImpl); } /** Read from the stream. @see store_readStream() */ inline storeError readAt ( sal_uInt32 nOffset, void * pBuffer, sal_uInt32 nBytes, sal_uInt32 & rnDone) { if (!m_hImpl) return store_E_InvalidHandle; return store_readStream (m_hImpl, nOffset, pBuffer, nBytes, &rnDone); } /** Write to the stream. @see store_writeStream() */ inline storeError writeAt ( sal_uInt32 nOffset, void const * pBuffer, sal_uInt32 nBytes, sal_uInt32 & rnDone) { if (!m_hImpl) return store_E_InvalidHandle; return store_writeStream (m_hImpl, nOffset, pBuffer, nBytes, &rnDone); } private: /** Representation. */ storeStreamHandle m_hImpl; }; /*======================================================================== * * OStoreDirectory interface. * *======================================================================*/ class OStoreDirectory { public: /** Construction. */ inline OStoreDirectory() : m_hImpl (nullptr) {} /** Destruction. */ inline ~OStoreDirectory() { if (m_hImpl) (void) store_releaseHandle (m_hImpl); } /** Copy construction. */ inline OStoreDirectory (OStoreDirectory const & rhs) : m_hImpl (rhs.m_hImpl) { if (m_hImpl) (void) store_acquireHandle (m_hImpl); } /** Assignment. */ inline OStoreDirectory & operator= (OStoreDirectory const & rhs) { if (rhs.m_hImpl) (void) store_acquireHandle (rhs.m_hImpl); if (m_hImpl) (void) store_releaseHandle (m_hImpl); m_hImpl = rhs.m_hImpl; return *this; } /** Construction from Directory Handle. */ inline explicit OStoreDirectory (storeDirectoryHandle Handle) : m_hImpl (Handle) { if (m_hImpl) (void) store_acquireHandle (m_hImpl); } /** Open the directory. @see store_openDirectory() */ inline storeError create ( storeFileHandle hFile, rtl::OUString const & rPath, rtl::OUString const & rName, storeAccessMode eMode) { if (m_hImpl) { (void) store_releaseHandle (m_hImpl); m_hImpl = nullptr; } return store_openDirectory (hFile, rPath.pData, rName.pData, eMode, &m_hImpl); } /** Directory iterator type. @see first() @see next() */ typedef storeFindData iterator; /** Find first directory entry. @see store_findFirst() */ inline storeError first (iterator& it) { if (!m_hImpl) return store_E_InvalidHandle; return store_findFirst (m_hImpl, &it); } /** Find next directory entry. @see store_findNext() */ inline storeError next (iterator& it) { if (!m_hImpl) return store_E_InvalidHandle; return store_findNext (m_hImpl, &it); } private: /** Representation. */ storeDirectoryHandle m_hImpl; }; /*======================================================================== * * OStoreFile interface. * *======================================================================*/ class OStoreFile { public: /** Construction. */ inline OStoreFile() : m_hImpl (nullptr) {} /** Destruction. */ inline ~OStoreFile() { if (m_hImpl) (void) store_releaseHandle (m_hImpl); } /** Copy construction. */ inline OStoreFile (OStoreFile const & rhs) : m_hImpl (rhs.m_hImpl) { if (m_hImpl) (void) store_acquireHandle (m_hImpl); } /** Assignment. */ inline OStoreFile & operator= (OStoreFile const & rhs) { if (rhs.m_hImpl) (void) store_acquireHandle (rhs.m_hImpl); if (m_hImpl) (void) store_releaseHandle (m_hImpl); m_hImpl = rhs.m_hImpl; return *this; } /** Construction from File Handle. */ inline explicit OStoreFile (storeFileHandle Handle) : m_hImpl (Handle) { if (m_hImpl) (void) store_acquireHandle (m_hImpl); } /** Conversion into File Handle. */ inline operator storeFileHandle() const { return m_hImpl; } /** Check for a valid File Handle. @return sal_True if valid, sal_False otherwise. */ inline bool isValid() const { return (m_hImpl != nullptr); } /** Open the file. @see store_openFile() */ inline storeError create ( rtl::OUString const & rFilename, storeAccessMode eAccessMode, sal_uInt16 nPageSize = STORE_DEFAULT_PAGESIZE) { if (m_hImpl) { (void) store_releaseHandle (m_hImpl); m_hImpl = nullptr; } return store_openFile (rFilename.pData, eAccessMode, nPageSize, &m_hImpl); } /** Open the temporary file in memory. @see store_createMemoryFile() */ inline storeError createInMemory ( sal_uInt16 nPageSize = STORE_DEFAULT_PAGESIZE) { if (m_hImpl) { (void) store_releaseHandle (m_hImpl); m_hImpl = nullptr; } return store_createMemoryFile (nPageSize, &m_hImpl); } /** Close the file. @see store_closeFile() */ inline void close() { if (m_hImpl) { (void) store_closeFile (m_hImpl); m_hImpl = nullptr; } } /** Flush the file. @see store_flushFile() */ inline storeError flush() const { if (!m_hImpl) return store_E_InvalidHandle; return store_flushFile (m_hImpl); } /** Remove a file entry. @see store_remove() */ inline storeError remove ( rtl::OUString const & rPath, rtl::OUString const & rName) { if (!m_hImpl) return store_E_InvalidHandle; return store_remove (m_hImpl, rPath.pData, rName.pData); } private: /** Representation. */ storeFileHandle m_hImpl; }; /*======================================================================== * * The End. * *======================================================================*/ } // namespace store #endif /* ! INCLUDED_STORE_STORE_HXX */ /* vim:set shiftwidth=4 softtabstop=4 expandtab: */