interceptionhelper.hxx

Go to the documentation of this file.

/* -*- 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/frame/XDispatchProviderInterception.hpp>
#include <com/sun/star/frame/XDispatchProviderInterceptor.hpp>
#include <com/sun/star/frame/XDispatchProvider.hpp>
#include <com/sun/star/frame/XDispatch.hpp>
#include <com/sun/star/frame/XFrame.hpp>
#include <com/sun/star/frame/DispatchDescriptor.hpp>
 
#include <rtl/ref.hxx>
#include <tools/wldcrd.hxx>
#include <cppuhelper/implbase.hxx>
#include <cppuhelper/weakref.hxx>
 
#include <deque>
#include <string_view>
 
namespace framework{
 
class DispatchProvider;
 
class InterceptionHelper final : public  ::cppu::WeakImplHelper<
                                     css::frame::XDispatchProvider,
                                     css::frame::XDispatchProviderInterception,
                                     css::lang::XEventListener >
{
 
    // structs, helper
 
    struct InterceptorInfo
    {
        css::uno::Reference< css::frame::XDispatchProvider > xInterceptor;
 
        css::uno::Sequence< OUString > lURLPattern;
    };
 
    class InterceptorList : public ::std::deque< InterceptorInfo >
    {
        public:
 
            iterator findByReference(const css::uno::Reference< css::frame::XDispatchProviderInterceptor >& xInterceptor)
            {
                iterator pIt;
                for (pIt=begin(); pIt!=end(); ++pIt)
                {
                    if (pIt->xInterceptor == xInterceptor)
                        return pIt;
                }
                return end();
            }
 
            iterator findByPattern(std::u16string_view sURL)
            {
                for (iterator pIt=begin(); pIt!=end(); ++pIt)
                {
                    for (const OUString& pattern : pIt->lURLPattern)
                    {
                        WildCard aPattern(pattern);
                        if (aPattern.Matches(sURL))
                            return pIt;
                    }
                }
                return end();
            }
    };
 
    // member
 
    private:
 
        css::uno::WeakReference< css::frame::XFrame > m_xOwnerWeak;
 
        rtl::Reference< DispatchProvider > m_xSlave;
 
        InterceptorList m_lInterceptionRegs;
 
    // native interface
 
    public:
 
        InterceptionHelper(const css::uno::Reference< css::frame::XFrame >&            xOwner,
                           rtl::Reference< DispatchProvider >  xSlave);
 
    private:
 
        virtual ~InterceptionHelper() override;
 
    // uno interface
 
    public:
 
        // XDispatchProvider
 
        virtual css::uno::Reference< css::frame::XDispatch > SAL_CALL queryDispatch(const css::util::URL&  aURL            ,
                                                                                    const OUString& sTargetFrameName,
                                                                                          sal_Int32        nSearchFlags    ) override;
 
        // XDispatchProvider
 
        virtual css::uno::Sequence< css::uno::Reference< css::frame::XDispatch > > SAL_CALL queryDispatches(const css::uno::Sequence< css::frame::DispatchDescriptor >& lDescriptor) override;
 
        // XDispatchProviderInterception
 
        virtual void SAL_CALL registerDispatchProviderInterceptor(const css::uno::Reference< css::frame::XDispatchProviderInterceptor >& xInterceptor) override;
 
        // XDispatchProviderInterception
 
        virtual void SAL_CALL releaseDispatchProviderInterceptor( const css::uno::Reference< css::frame::XDispatchProviderInterceptor >& xInterceptor ) override;
 
        // XEventListener
 
        virtual void SAL_CALL disposing(const css::lang::EventObject& aEvent) override;
 
        rtl::Reference<DispatchProvider> GetSlave() const { return m_xSlave; }
 
}; // class InterceptionHelper
 
} // namespace framework
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */