stordir.hxx 3.21 KB
Newer Older
1
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
Michael Meeks's avatar
Michael Meeks committed
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
/*
 * 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 .
 */
19

20 21
#ifndef INCLUDED_STORE_SOURCE_STORDIR_HXX
#define INCLUDED_STORE_SOURCE_STORDIR_HXX
22 23 24 25 26 27 28 29 30 31 32 33 34

#include <sal/types.h>

#include <rtl/textcvt.h>
#include <rtl/string.h>
#include <rtl/ref.hxx>

#include "object.hxx"
#include "storbase.hxx"

namespace store
{

35
class OStorePageManager;
36 37 38 39 40 41 42
struct OStoreDirectoryPageData;

class OStoreDirectory_Impl : public store::OStoreObject
{
public:
    /** Construction.
     */
43
    OStoreDirectory_Impl();
44 45 46 47 48 49 50 51 52 53

    /** create (two-phase construction).
     *  @param  pManager [in]
     *  @param  pPath [in]
     *  @param  pName [in]
     *  @param  eAccessMode [in]
     *  @return store_E_None upon success.
     */
    storeError create (
        OStorePageManager *pManager,
54 55
        rtl_String const  *pPath,
        rtl_String const  *pName,
56 57 58 59 60 61 62 63 64 65 66 67
        storeAccessMode    eAccessMode);

    /** iterate.
     *  @param  rFindData [out]
     *  @return store_E_None        upon success,
     *          store_E_NoMoreFiles upon end of iteration.
     */
    storeError iterate (
        storeFindData &rFindData);

    /** IStoreHandle.
     */
68
    virtual bool isKindOf (sal_uInt32 nTypeId) override;
69 70 71 72

protected:
    /** Destruction.
     */
73
    virtual ~OStoreDirectory_Impl() override;
74 75 76 77 78 79 80 81 82

private:
    /** IStoreHandle TypeId.
     */
    static const sal_uInt32 m_nTypeId;

    /** IStoreHandle query() template function specialization.
     */
    friend OStoreDirectory_Impl*
Noel Grandin's avatar
Noel Grandin committed
83
    SAL_CALL query<> (OStoreObject *pHandle, OStoreDirectory_Impl*);
84 85 86 87 88 89 90 91 92 93 94 95

    /** Representation.
     */
    typedef OStoreDirectoryPageData   inode;
    typedef PageHolderObject< inode > inode_holder_type;

    rtl::Reference<OStorePageManager> m_xManager;

    OStorePageDescriptor       m_aDescr;
    sal_uInt32                 m_nPath;
    rtl_TextToUnicodeConverter m_hTextCvt;

96 97
    OStoreDirectory_Impl (const OStoreDirectory_Impl&) = delete;
    OStoreDirectory_Impl& operator= (const OStoreDirectory_Impl&) = delete;
98 99 100
};

template<> inline OStoreDirectory_Impl*
Noel Grandin's avatar
Noel Grandin committed
101
SAL_CALL query (OStoreObject *pHandle, SAL_UNUSED_PARAMETER OStoreDirectory_Impl*)
102 103 104 105 106 107
{
    if (pHandle && pHandle->isKindOf (OStoreDirectory_Impl::m_nTypeId))
    {
        // Handle is kind of OStoreDirectory_Impl.
        return static_cast<OStoreDirectory_Impl*>(pHandle);
    }
108
    return nullptr;
109 110 111 112
}

} // namespace store

113
#endif // INCLUDED_STORE_SOURCE_STORDIR_HXX
114

115
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */