Adding upstream version 4:24.2.0.upstream/4%24.2.0

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 194 insertions, 0 deletions

diff --git a/forms/source/component/GroupManager.hxx b/forms/source/component/GroupManager.hxx
new file mode 100644
index 0000000000..4cefd7ac3a
--- /dev/null
+++ b/forms/source/component/GroupManager.hxx
@@ -0,0 +1,194 @@
+/* -*- 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 <com/sun/star/awt/XControlModel.hpp>
+#include <com/sun/star/beans/XPropertySet.hpp>
+#include <com/sun/star/beans/XPropertyChangeListener.hpp>
+#include <com/sun/star/container/XContainerListener.hpp>
+#include <com/sun/star/container/XContainer.hpp>
+#include <cppuhelper/implbase.hxx>
+
+#include <map>
+#include <memory>
+#include <vector>
+
+/*
+ * The GroupManager listens at the StarForm for FormComponent insertion and removal as well as
+ * its properties "Name" and "TabIndex" and updates its Group using this information.
+ *
+ * The GroupManager manages a Group in which all Controls are sorted by TabIndex.
+ * It also manages an array of Groups, in which each FormComponent is assigned a
+ * Group according to its name.
+ * Each Group is activated using a Map, if they contain more than one element.
+ *
+ * The Groups manage the FormComponents internally using two arrays.
+ * In the GroupCompArray the Components are sorted by TabIndex and insertion position.
+ * Because this array is accessed via the FormComponent, we also have the GroupCompAccessArray
+ * in which the FormComponents are sorted by their storage address.
+ * Every element of the GroupCompArray has a pointer to the GroupCompArray.
+ */
+namespace frm
+{
+
+
+    template <class ELEMENT, class LESS_COMPARE>
+    sal_Int32 insert_sorted(::std::vector<ELEMENT>& _rArray, const ELEMENT& _rNewElement, const LESS_COMPARE& _rCompareOp)
+    {
+        typename ::std::vector<ELEMENT>::iterator aInsertPos = ::std::lower_bound(
+            _rArray.begin(),
+            _rArray.end(),
+            _rNewElement,
+            _rCompareOp
+        );
+        aInsertPos = _rArray.insert(aInsertPos, _rNewElement);
+        return aInsertPos - _rArray.begin();
+    }
+
+    template <class ELEMENT, class LESS_COMPARE>
+    bool seek_entry(const ::std::vector<ELEMENT>& _rArray, const ELEMENT& _rNewElement, sal_Int32& nPos, const LESS_COMPARE& _rCompareOp)
+    {
+        typename ::std::vector<ELEMENT>::const_iterator aExistentPos = ::std::lower_bound(
+            _rArray.begin(),
+            _rArray.end(),
+            _rNewElement,
+            _rCompareOp
+        );
+        if ((aExistentPos != _rArray.end()) && (*aExistentPos == _rNewElement))
+        {   // we have a valid "lower or equal" element and it's really "equal"
+            nPos = aExistentPos - _rArray.begin();
+            return true;
+        }
+        nPos = -1;
+        return false;
+    }
+
+
+class OGroupComp
+{
+    css::uno::Reference< css::beans::XPropertySet>    m_xComponent;
+    css::uno::Reference< css::awt::XControlModel>     m_xControlModel;
+    sal_Int32   m_nPos;
+    sal_Int16   m_nTabIndex;
+
+    friend class OGroupCompLess;
+
+public:
+    OGroupComp(const css::uno::Reference< css::beans::XPropertySet>& rxElement, sal_Int32 nInsertPos );
+    OGroupComp();
+
+    bool operator==( const OGroupComp& rComp ) const;
+
+    const css::uno::Reference< css::beans::XPropertySet>& GetComponent() const { return m_xComponent; }
+    const css::uno::Reference< css::awt::XControlModel>&   GetControlModel() const { return m_xControlModel; }
+
+    sal_Int32   GetPos() const { return m_nPos; }
+    sal_Int16   GetTabIndex() const { return m_nTabIndex; }
+};
+
+
+class OGroupComp;
+class OGroupCompAcc
+{
+    css::uno::Reference< css::beans::XPropertySet>    m_xComponent;
+
+    OGroupComp                                      m_aGroupComp;
+
+    friend class OGroupCompAccLess;
+
+public:
+    OGroupCompAcc(const css::uno::Reference< css::beans::XPropertySet>& rxElement, OGroupComp _aGroupComp );
+
+    bool operator==( const OGroupCompAcc& rCompAcc ) const;
+
+    const OGroupComp&   GetGroupComponent() const { return m_aGroupComp; }
+};
+
+class OGroup final
+{
+    std::vector<OGroupComp>    m_aCompArray;
+    std::vector<OGroupCompAcc> m_aCompAccArray;
+
+    OUString    m_aGroupName;
+    sal_uInt16  m_nInsertPos; // The insertion position of the GroupComps is determined by the Group
+
+    friend class OGroupLess;
+
+public:
+    explicit OGroup(OUString sGroupName);
+
+    const OUString& GetGroupName() const { return m_aGroupName; }
+    css::uno::Sequence< css::uno::Reference< css::awt::XControlModel>  > GetControlModels() const;
+
+    void InsertComponent( const css::uno::Reference< css::beans::XPropertySet>& rxElement );
+    void RemoveComponent( const css::uno::Reference< css::beans::XPropertySet>& rxElement );
+    sal_uInt16 Count() const { return sal::static_int_cast< sal_uInt16 >(m_aCompArray.size()); }
+    const css::uno::Reference< css::beans::XPropertySet>& GetObject( sal_uInt16 nP ) const
+        { return m_aCompArray[nP].GetComponent(); }
+};
+
+typedef std::map<OUString, OGroup> OGroupArr;
+typedef std::vector<OGroupArr::iterator> OActiveGroups;
+
+
+class OGroupManager : public ::cppu::WeakImplHelper< css::beans::XPropertyChangeListener, css::container::XContainerListener>
+{
+    std::unique_ptr<OGroup>
+                    m_pCompGroup;           // Sort all Components by TabIndices
+    OGroupArr       m_aGroupArr;            // Sort all Components by group
+    OActiveGroups   m_aActiveGroupMap;      // This map contains all indices of all groups with more than 1 element
+
+    css::uno::Reference< css::container::XContainer >
+                    m_xContainer;
+
+    // Helper functions
+    void InsertElement( const css::uno::Reference< css::beans::XPropertySet>& rxElement );
+    void RemoveElement( const css::uno::Reference< css::beans::XPropertySet>& rxElement );
+    void removeFromGroupMap(const OUString& _sGroupName,const css::uno::Reference< css::beans::XPropertySet>& _xSet);
+
+public:
+    explicit OGroupManager(const css::uno::Reference< css::container::XContainer >& _rxContainer);
+    virtual ~OGroupManager() override;
+
+// css::lang::XEventListener
+    virtual void SAL_CALL disposing(const css::lang::EventObject& _rSource) override;
+
+// css::beans::XPropertyChangeListener
+    virtual void SAL_CALL propertyChange(const css::beans::PropertyChangeEvent& evt) override;
+
+// css::container::XContainerListener
+    virtual void SAL_CALL elementInserted(const css::container::ContainerEvent& _rEvent) override;
+    virtual void SAL_CALL elementRemoved(const css::container::ContainerEvent& _rEvent) override;
+    virtual void SAL_CALL elementReplaced(const css::container::ContainerEvent& _rEvent) override;
+
+// Other functions
+    sal_Int32 getGroupCount() const;
+    void getGroup(sal_Int32 nGroup, css::uno::Sequence< css::uno::Reference< css::awt::XControlModel> >& _rGroup, OUString& Name);
+    void getGroupByName(const OUString& Name, css::uno::Sequence< css::uno::Reference< css::awt::XControlModel> >& _rGroup);
+    css::uno::Sequence< css::uno::Reference< css::awt::XControlModel> > getControlModels() const;
+
+    static OUString GetGroupName( const css::uno::Reference< css::beans::XPropertySet>& xComponent );
+};
+
+
+}   // namespace frm
+
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */