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

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

2 files changed, 403 insertions, 0 deletions

diff --git a/framework/source/classes/framecontainer.cxx b/framework/source/classes/framecontainer.cxx
new file mode 100644
index 000000000..a23e3633e
--- /dev/null
+++ b/framework/source/classes/framecontainer.cxx
@@ -0,0 +1,293 @@
+/* -*- 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 .
+ */
+
+#include <framework/framecontainer.hxx>
+
+#include <com/sun/star/frame/FrameSearchFlag.hpp>
+
+#include <vcl/svapp.hxx>
+#include <comphelper/sequence.hxx>
+#include <sal/log.hxx>
+
+namespace framework
+{
+/**-***************************************************************************************************************
+    @short      initialize an empty container
+    @descr      The container will be empty then - special features (e.g. the async quit mechanism) are disabled.
+
+    @threadsafe not necessary - it's not a singleton
+ *****************************************************************************************************************/
+FrameContainer::FrameContainer()
+/*DEPRECATEME
+        , m_bAsyncQuit   ( sal_False                                      ) // default must be "disabled"!
+        , m_aAsyncCall   ( LINK( this, FrameContainer, implts_asyncQuit ) )
+*/
+{
+}
+
+/**-***************************************************************************************************************
+    @short      deinitialize may a filled container
+    @descr      Special features (if the currently are running) will be disabled and we free all used other resources.
+
+    @threadsafe not necessary - it's not a singleton
+ *****************************************************************************************************************/
+FrameContainer::~FrameContainer()
+{
+    // Don't forget to free memory!
+    m_aContainer.clear();
+    m_xActiveFrame.clear();
+}
+
+/**-***************************************************************************************************************
+    @short      append a new frame to the container
+    @descr      We accept the incoming frame only, if it is a valid reference and doesn't exist already.
+
+    @param      xFrame
+                    frame, which should be added to this container
+                    Must be a valid reference.
+
+    @threadsafe yes
+ *****************************************************************************************************************/
+void FrameContainer::append(const css::uno::Reference<css::frame::XFrame>& xFrame)
+{
+    if (xFrame.is() && !exist(xFrame))
+    {
+        SolarMutexGuard g;
+        m_aContainer.push_back(xFrame);
+    }
+}
+
+/**-***************************************************************************************************************
+    @short      remove a frame from the container
+    @descr      In case we remove the last frame and our internal special feature (the async quit mechanism)
+                was enabled by the desktop instance, we start it.
+
+    @param      xFrame
+                    frame, which should be deleted from this container
+                    Must be a valid reference.
+
+    @threadsafe yes
+ *****************************************************************************************************************/
+void FrameContainer::remove(const css::uno::Reference<css::frame::XFrame>& xFrame)
+{
+    SolarMutexGuard g;
+
+    TFrameContainer::iterator aSearchedItem
+        = ::std::find(m_aContainer.begin(), m_aContainer.end(), xFrame);
+    if (aSearchedItem != m_aContainer.end())
+    {
+        m_aContainer.erase(aSearchedItem);
+
+        // If removed frame was the current active frame - reset state variable.
+        if (m_xActiveFrame == xFrame)
+            m_xActiveFrame.clear();
+    }
+}
+
+/**-***************************************************************************************************************
+    @short      check if the given frame currently exist inside the container
+    @param      xFrame
+                    reference to the queried frame
+
+    @return     <TRUE/> if frame is part of this container
+                <FALSE/> otherwise
+
+    @threadsafe yes
+ *****************************************************************************************************************/
+bool FrameContainer::exist(const css::uno::Reference<css::frame::XFrame>& xFrame) const
+{
+    SolarMutexGuard g;
+    return (::std::find(m_aContainer.begin(), m_aContainer.end(), xFrame) != m_aContainer.end());
+}
+
+/**-***************************************************************************************************************
+    @short      delete all existing items of the container
+    @threadsafe yes
+ *****************************************************************************************************************/
+void FrameContainer::clear()
+{
+    SolarMutexGuard g;
+    // Clear the container ...
+    m_aContainer.clear();
+    // ... and don't forget to reset the active frame.
+    // It's a reference to a valid container-item.
+    // But no container item => no active frame!
+    m_xActiveFrame.clear();
+}
+
+/**-***************************************************************************************************************
+    @short      returns count of all current existing frames
+    @deprecated This value can't be guaranteed for multithreading environments.
+                So it will be marked as deprecated and should be replaced by "getAllElements()".
+
+    @return     the count of existing container items
+
+    @threadsafe yes
+ *****************************************************************************************************************/
+sal_uInt32 FrameContainer::getCount() const
+{
+    SolarMutexGuard g;
+    return static_cast<sal_uInt32>(m_aContainer.size());
+}
+
+/**-***************************************************************************************************************
+    @short      returns one item of this container
+    @deprecated This value can't be guaranteed for multithreading environments.
+                So it will be marked as deprecated and should be replaced by "getAllElements()".
+
+    @param      nIndex
+                    a value between 0 and (getCount()-1) to address one container item
+
+    @return     a reference to a frame inside the container, which match with given index
+
+    @threadsafe yes
+ *****************************************************************************************************************/
+css::uno::Reference<css::frame::XFrame> FrameContainer::operator[](sal_uInt32 nIndex) const
+{
+    css::uno::Reference<css::frame::XFrame> xFrame;
+    try
+    {
+        // Get element form container WITH automatic test of ranges!
+        // If index not valid, an out_of_range exception is thrown.
+        SolarMutexGuard g;
+        xFrame = m_aContainer.at(nIndex);
+    }
+    catch (const std::out_of_range&)
+    {
+        // The index is not valid for current container-content - we must handle this case!
+        // We can return the default value ...
+        SAL_INFO("fwk", "FrameContainer::operator[]: Exception caught: std::out_of_range");
+    }
+    return xFrame;
+}
+
+/**-***************************************************************************************************************
+    @short      returns a snapshot of all currently existing frames inside this container
+    @descr      Should be used to replace the deprecated functions getCount()/operator[]!
+
+    @return     a list of all frame references inside this container
+
+    @threadsafe yes
+ *****************************************************************************************************************/
+css::uno::Sequence<css::uno::Reference<css::frame::XFrame>> FrameContainer::getAllElements() const
+{
+    SolarMutexGuard g;
+    return comphelper::containerToSequence(m_aContainer);
+}
+
+/**-***************************************************************************************************************
+    @short      set the given frame as  the new active one inside this container
+    @descr      We accept this frame only, if it's already a part of this container.
+
+    @param      xFrame
+                    reference to the new active frame
+                    Must be a valid reference and already part of this container.
+
+    @threadsafe yes
+ *****************************************************************************************************************/
+void FrameContainer::setActive(const css::uno::Reference<css::frame::XFrame>& xFrame)
+{
+    if (!xFrame.is() || exist(xFrame))
+    {
+        SolarMutexGuard g;
+        m_xActiveFrame = xFrame;
+    }
+}
+
+/**-***************************************************************************************************************
+    @short      return the current active frame of this container
+    @descr      Value can be null in case the frame was removed from the container and nobody
+                from outside decide which of all others should be the new one...
+
+    @return     a reference to the current active frame
+                Value can be NULL!
+
+    @threadsafe yes
+ *****************************************************************************************************************/
+css::uno::Reference<css::frame::XFrame> FrameContainer::getActive() const
+{
+    SolarMutexGuard g;
+    return m_xActiveFrame;
+}
+
+/**-***************************************************************************************************************
+    @short      implements a simple search based on current container items
+    @descr      It can be used for findFrame() and implements a deep down search.
+
+    @param      sName
+                    target name, which is searched
+
+    @return     reference to the found frame or NULL if not.
+
+    @threadsafe yes
+ *****************************************************************************************************************/
+css::uno::Reference<css::frame::XFrame>
+FrameContainer::searchOnAllChildrens(const OUString& sName) const
+{
+    SolarMutexGuard g;
+    // Step over all child frames. But if direct child isn't the right one search on his children first - before
+    // you go to next direct child of this container!
+    css::uno::Reference<css::frame::XFrame> xSearchedFrame;
+    for (auto const& container : m_aContainer)
+    {
+        if (container->getName() == sName)
+        {
+            xSearchedFrame = container;
+            break;
+        }
+        else
+        {
+            xSearchedFrame = container->findFrame(sName, css::frame::FrameSearchFlag::CHILDREN);
+            if (xSearchedFrame.is())
+                break;
+        }
+    }
+    return xSearchedFrame;
+}
+
+/**-***************************************************************************************************************
+    @short      implements a simple search based on current container items
+    @descr      It can be used for findFrame() and search on members of this container only!
+
+    @param      sName
+                    target name, which is searched
+
+    @return     reference to the found frame or NULL if not.
+
+    @threadsafe yes
+ *****************************************************************************************************************/
+css::uno::Reference<css::frame::XFrame>
+FrameContainer::searchOnDirectChildrens(std::u16string_view sName) const
+{
+    SolarMutexGuard g;
+    css::uno::Reference<css::frame::XFrame> xSearchedFrame;
+    for (auto const& container : m_aContainer)
+    {
+        if (container->getName() == sName)
+        {
+            xSearchedFrame = container;
+            break;
+        }
+    }
+    return xSearchedFrame;
+}
+
+} //  namespace framework
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/framework/source/classes/taskcreator.cxx b/framework/source/classes/taskcreator.cxx
new file mode 100644
index 000000000..151322e1e
--- /dev/null
+++ b/framework/source/classes/taskcreator.cxx
@@ -0,0 +1,110 @@
+/* -*- 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 .
+ */
+
+#include <classes/taskcreator.hxx>
+#include <services.h>
+#include <taskcreatordefs.hxx>
+
+#include <com/sun/star/frame/Desktop.hpp>
+#include <com/sun/star/frame/TaskCreator.hpp>
+#include <com/sun/star/lang/XSingleServiceFactory.hpp>
+#include <com/sun/star/beans/NamedValue.hpp>
+#include <utility>
+
+namespace framework{
+
+/*-****************************************************************************************************
+    @short      initialize instance with necessary information
+    @descr      We need a valid uno service manager to create or instantiate new services.
+                All other information to create frames or tasks come in on right interface methods.
+
+    @param      xContext
+                    points to the valid uno service manager
+*//*-*****************************************************************************************************/
+TaskCreator::TaskCreator( css::uno::Reference< css::uno::XComponentContext > xContext )
+    : m_xContext    (std::move( xContext ))
+{
+}
+
+/*-****************************************************************************************************
+    @short      deinitialize instance
+    @descr      We should release all used resource which are not needed any longer.
+*//*-*****************************************************************************************************/
+TaskCreator::~TaskCreator()
+{
+}
+
+/*-****************************************************************************************************
+    TODO document me
+*//*-*****************************************************************************************************/
+css::uno::Reference< css::frame::XFrame > TaskCreator::createTask( const OUString& sName, const utl::MediaDescriptor& rDescriptor )
+{
+    css::uno::Reference< css::lang::XSingleServiceFactory > xCreator;
+
+    try
+    {
+        xCreator.set( m_xContext->getServiceManager()->createInstanceWithContext(IMPLEMENTATIONNAME_FWK_TASKCREATOR, m_xContext), css::uno::UNO_QUERY_THROW);
+    }
+    catch(const css::uno::Exception&)
+    {}
+
+    // no catch here ... without a task creator service we can't open ANY document window within the office.
+    // That's IMHO not a good idea. Then we should accept the stacktrace showing us the real problem.
+    // BTW: The used fallback creator service (IMPLEMENTATIONNAME_FWK_TASKCREATOR) is implemented in the same
+    // library then these class here ... Why we should not be able to create it ?
+    if ( ! xCreator.is())
+        xCreator = css::frame::TaskCreator::create(m_xContext);
+
+    css::uno::Sequence< css::uno::Any > lArgs(6);
+    auto plArgs = lArgs.getArray();
+    css::beans::NamedValue              aArg;
+
+    aArg.Name    = ARGUMENT_PARENTFRAME;
+    aArg.Value <<= css::uno::Reference< css::frame::XFrame >( css::frame::Desktop::create( m_xContext ), css::uno::UNO_QUERY_THROW);
+    plArgs[0]   <<= aArg;
+
+    aArg.Name    = ARGUMENT_CREATETOPWINDOW;
+    aArg.Value <<= true;
+    plArgs[1]   <<= aArg;
+
+    aArg.Name    = ARGUMENT_MAKEVISIBLE;
+    aArg.Value <<= false;
+    plArgs[2]   <<= aArg;
+
+    aArg.Name    = ARGUMENT_SUPPORTPERSISTENTWINDOWSTATE;
+    aArg.Value <<= true;
+    plArgs[3]   <<= aArg;
+
+    aArg.Name    = ARGUMENT_FRAMENAME;
+    aArg.Value <<= sName;
+    plArgs[4]   <<= aArg;
+
+    bool bHidden
+        = rDescriptor.getUnpackedValueOrDefault("HiddenForConversion", false);
+    aArg.Name = "HiddenForConversion";
+    aArg.Value <<= bHidden;
+    plArgs[5] <<= aArg;
+
+    css::uno::Reference< css::frame::XFrame > xTask(xCreator->createInstanceWithArguments(lArgs), css::uno::UNO_QUERY_THROW);
+    return xTask;
+}
+
+} // namespace framework
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */