store/source/stordir.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #pragma once
  21
  22 #include <sal/types.h>
  23
  24 #include <rtl/textcvt.h>
  25 #include <rtl/string.h>
  26 #include <rtl/ref.hxx>
  27
  28 #include "object.hxx"
  29 #include "storbase.hxx"
  30
  31 namespace store
  32 {
  33
  34 class OStorePageManager;
  35 struct OStoreDirectoryPageData;
  36
  37 class OStoreDirectory_Impl : public store::OStoreObject
  38 {
  39 public:
  40     OStoreDirectory_Impl();
  41
  42     /** create (two-phase construction).
  43      *  @param  pManager [in]
  44      *  @param  pPath [in]
  45      *  @param  pName [in]
  46      *  @param  eAccessMode [in]
  47      *  @return store_E_None upon success.
  48      */
  49     storeError create (
  50         OStorePageManager *pManager,
  51         rtl_String const  *pPath,
  52         rtl_String const  *pName,
  53         storeAccessMode    eAccessMode);
  54
  55     /** iterate.
  56      *  @param  rFindData [out]
  57      *  @return store_E_None        upon success,
  58      *          store_E_NoMoreFiles upon end of iteration.
  59      */
  60     storeError iterate (
  61         storeFindData &rFindData);
  62
  63     virtual bool isKindOf (sal_uInt32 nTypeId) override;
  64
  65 protected:
  66     virtual ~OStoreDirectory_Impl() override;
  67
  68 private:
  69     /** IStoreHandle TypeId.
  70      */
  71     static const sal_uInt32 m_nTypeId;
  72
  73     /** IStoreHandle query() template function specialization.
  74      */
  75     friend OStoreDirectory_Impl*
  76     SAL_CALL query<> (OStoreObject *pHandle, OStoreDirectory_Impl*);
  77
  78     typedef OStoreDirectoryPageData   inode;
  79     typedef PageHolderObject< inode > inode_holder_type;
  80
  81     rtl::Reference<OStorePageManager> m_xManager;
  82
  83     OStorePageDescriptor       m_aDescr;
  84     sal_uInt32                 m_nPath;
  85     rtl_TextToUnicodeConverter m_hTextCvt;
  86
  87     OStoreDirectory_Impl (const OStoreDirectory_Impl&) = delete;
  88     OStoreDirectory_Impl& operator= (const OStoreDirectory_Impl&) = delete;
  89 };
  90
  91 template<> inline OStoreDirectory_Impl*
  92 SAL_CALL query (OStoreObject *pHandle, SAL_UNUSED_PARAMETER OStoreDirectory_Impl*)
  93 {
  94     if (pHandle && pHandle->isKindOf (OStoreDirectory_Impl::m_nTypeId))
  95     {
  96         // Handle is kind of OStoreDirectory_Impl.
  97         return static_cast<OStoreDirectory_Impl*>(pHandle);
  98     }
  99     return nullptr;
 100 }
 101
 102 } // namespace store
 103
 104 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */