include/comphelper/enumhelper.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 #ifndef INCLUDED_COMPHELPER_ENUMHELPER_HXX
  21 #define INCLUDED_COMPHELPER_ENUMHELPER_HXX
  22
  23 #include <com/sun/star/container/XEnumeration.hpp>
  24 #include <com/sun/star/lang/XEventListener.hpp>
  25 #include <comphelper/comphelperdllapi.h>
  26 #include <cppuhelper/implbase.hxx>
  27 #include <mutex>
  28 #include <variant>
  29 #include <vector>
  30
  31 namespace com::sun::star::container { class XIndexAccess; }
  32 namespace com::sun::star::container { class XNameAccess; }
  33
  34 namespace comphelper
  35 {
  36
  37 /** provides a com.sun.star.container::XEnumeration access based
  38     on an object implementing the com.sun.star.container::XNameAccess interface
  39 */
  40 class COMPHELPER_DLLPUBLIC OEnumerationByName final :
  41                          public ::cppu::WeakImplHelper< css::container::XEnumeration ,
  42                                                           css::lang::XEventListener    >
  43 {
  44     std::variant<css::uno::Sequence< OUString >, std::vector<OUString>> m_aNames;
  45     css::uno::Reference< css::container::XNameAccess >  m_xAccess;
  46     sal_Int32                                           m_nPos;
  47     bool                                                m_bListening;
  48     std::mutex m_aLock;
  49
  50 public:
  51     OEnumerationByName(css::uno::Reference< css::container::XNameAccess > _xAccess);
  52     OEnumerationByName(css::uno::Reference< css::container::XNameAccess > _xAccess,
  53                        std::vector<OUString>             _aNames  );
  54     virtual ~OEnumerationByName() override;
  55
  56     virtual sal_Bool SAL_CALL hasMoreElements(  ) override;
  57     virtual css::uno::Any SAL_CALL nextElement(  ) override;
  58
  59     virtual void SAL_CALL disposing(const css::lang::EventObject& aEvent) override;
  60
  61 private:
  62     sal_Int32 getLength() const;
  63     const OUString& getElement(sal_Int32 nIndex) const;
  64     COMPHELPER_DLLPRIVATE void impl_startDisposeListening();
  65     COMPHELPER_DLLPRIVATE void impl_stopDisposeListening();
  66 };
  67
  68 /** provides a com.sun.star.container::XEnumeration access based
  69     on an object implementing the com.sun.star.container::XNameAccess interface
  70 */
  71 class COMPHELPER_DLLPUBLIC OEnumerationByIndex final :
  72                           public ::cppu::WeakImplHelper< css::container::XEnumeration ,
  73                                                            css::lang::XEventListener    >
  74 {
  75     css::uno::Reference< css::container::XIndexAccess > m_xAccess;
  76     sal_Int32                                         m_nPos;
  77     bool                                          m_bListening;
  78     std::mutex m_aLock;
  79
  80 public:
  81     OEnumerationByIndex(css::uno::Reference< css::container::XIndexAccess > _xAccess);
  82     virtual ~OEnumerationByIndex() override;
  83
  84     virtual sal_Bool SAL_CALL hasMoreElements(  ) override;
  85     virtual css::uno::Any SAL_CALL nextElement(  ) override;
  86
  87     virtual void SAL_CALL disposing(const css::lang::EventObject& aEvent) override;
  88
  89 private:
  90     COMPHELPER_DLLPRIVATE void impl_startDisposeListening();
  91     COMPHELPER_DLLPRIVATE void impl_stopDisposeListening();
  92 };
  93
  94 // this is the way that works for ENABLE_LTO with MSVC 2013
  95 class SAL_DLLPUBLIC_TEMPLATE OAnyEnumeration_BASE
  96     : public ::cppu::WeakImplHelper<css::container::XEnumeration> {};
  97
  98 /** provides a com.sun.star.container::XEnumeration
  99     for an outside set vector of Any's.
 100
 101 */
 102 class COMPHELPER_DLLPUBLIC OAnyEnumeration final :
 103                                            public OAnyEnumeration_BASE
 104 {
 105     sal_Int32                         m_nPos;
 106     css::uno::Sequence< css::uno::Any > m_lItems;
 107     std::mutex m_aLock;
 108
 109 public:
 110     OAnyEnumeration(const css::uno::Sequence< css::uno::Any >& lItems);
 111     virtual ~OAnyEnumeration() override;
 112
 113     virtual sal_Bool SAL_CALL hasMoreElements(  ) override;
 114     virtual css::uno::Any SAL_CALL nextElement(  ) override;
 115
 116 };
 117
 118 }
 119
 120 #endif // INCLUDED_COMPHELPER_ENUMHELPER_HXX
 121
 122 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */