storpage.hxx

Go to the documentation of this file.

/* -*- 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 .
 */
 
#pragma once
 
#include <sal/types.h>
#include <rtl/string.h>
 
#include "object.hxx"
 
#include "storbase.hxx"
#include "storbios.hxx"
#include "stortree.hxx"
 
namespace store
{
 
class ILockBytes;
struct OStoreDirectoryPageData;
class  OStoreDirectoryPageObject;
 
class OStorePageManager : public store::OStorePageBIOS
{
public:
    OStorePageManager();
 
    virtual storeError initialize (
        ILockBytes *    pLockBytes,
        storeAccessMode eAccessMode,
        sal_uInt16 &    rnPageSize) override;
 
    inline bool isValid() const;
 
    static storeError namei (
        const rtl_String *pPath,
        const rtl_String *pName,
        OStorePageKey    &rKey);
 
    storeError iget (
        OStoreDirectoryPageObject & rPage, // [out]
        sal_uInt32                  nAttrib,
        const rtl_String *          pPath,
        const rtl_String *          pName,
        storeAccessMode             eMode);
 
    storeError iterate (
        OStorePageKey &  rKey,
        OStorePageLink & rLink,
        sal_uInt32 &     rAttrib);
 
    storeError remove (
        const OStorePageKey &rKey);
 
    virtual bool isKindOf (sal_uInt32 nTypeId) override;
 
protected:
    virtual ~OStorePageManager() override;
 
private:
    typedef OStorePageBIOS            base;
    typedef OStorePageManager         self;
 
    typedef OStoreBTreeEntry          entry;
    typedef OStoreBTreeNodeData       page;
    typedef OStoreBTreeNodeObject     node;
 
    typedef OStoreDirectoryPageData   inode;
    typedef PageHolderObject< inode > inode_holder_type;
 
    static const sal_uInt32 m_nTypeId;
 
    friend OStorePageManager*
    SAL_CALL query<> (OStoreObject *pHandle, OStorePageManager*);
 
    OStoreBTreeRootObject m_aRoot;
 
    storeError load_dirpage_Impl(
        const OStorePageKey       &rKey,
        OStoreDirectoryPageObject &rPage);
 
    storeError save_dirpage_Impl(
        const OStorePageKey       &rKey,
        OStoreDirectoryPageObject &rPage);
 
    storeError find_lookup (
        OStoreBTreeNodeObject & rNode,
        sal_uInt16 &            rIndex,
        OStorePageKey const &   rKey);
 
    storeError remove_Impl (entry & rEntry);
 
    OStorePageManager (const OStorePageManager&) = delete;
    OStorePageManager& operator= (const OStorePageManager&) = delete;
};
 
inline bool OStorePageManager::isValid() const
{
    return base::isValid();
}
 
template<> inline OStorePageManager*
SAL_CALL query (OStoreObject *pHandle, SAL_UNUSED_PARAMETER OStorePageManager*)
{
    if (pHandle && pHandle->isKindOf (OStorePageManager::m_nTypeId))
    {
        // Handle is kind of OStorePageManager.
        return static_cast<OStorePageManager*>(pHandle);
    }
    return nullptr;
}
 
} // namespace store
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */