vbaproject.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 .
 */

#ifndef INCLUDED_OOX_OLE_VBAPROJECT_HXX
#define INCLUDED_OOX_OLE_VBAPROJECT_HXX

#include <functional>
#include <map>
#include <string_view>

#include <com/sun/star/uno/Reference.hxx>
#include <oox/dllapi.h>
#include <oox/helper/refmap.hxx>
#include <oox/helper/refvector.hxx>
#include <rtl/ustring.hxx>
#include <sal/types.h>

namespace com::sun::star {
    namespace container { class XNameContainer; }
    namespace frame { class XModel; }
    namespace script { class XLibraryContainer; }
    namespace script::vba { class XVBAMacroResolver; }
    namespace uno { class XComponentContext; }
    namespace uno { class XInterface; }
    namespace io { class XInputStream; }
}

namespace oox {
    class GraphicHelper;
    class StorageBase;
}

namespace oox::ole {

class VbaModule;

class VbaFilterConfig
{
public:
    explicit            VbaFilterConfig(
                            const css::uno::Reference< css::uno::XComponentContext >& rxContext,
                            std::u16string_view rConfigCompName );
                        ~VbaFilterConfig();

    bool                isImportVba() const;
    bool                isImportVbaExecutable() const;
    bool                isExportVba() const;

private:
    css::uno::Reference< css::uno::XInterface >
                        mxConfigAccess;
};


class OOX_DLLPUBLIC VbaMacroAttacherBase
{
public:
    explicit            VbaMacroAttacherBase( const OUString& rMacroName );
    virtual             ~VbaMacroAttacherBase();

    void                resolveAndAttachMacro(
                            const css::uno::Reference< css::script::vba::XVBAMacroResolver >& rxResolver );

private:
    virtual void        attachMacro( const OUString& rScriptUrl ) = 0;

private:
    OUString     maMacroName;
};

typedef std::shared_ptr< VbaMacroAttacherBase > VbaMacroAttacherRef;


class OOX_DLLPUBLIC VbaProject : public VbaFilterConfig
{
public:
    explicit            VbaProject(
                            const css::uno::Reference< css::uno::XComponentContext >& rxContext,
                            const css::uno::Reference< css::frame::XModel >& rxDocModel,
                            std::u16string_view rConfigCompName );
    virtual             ~VbaProject();

    void                importVbaProject(
                            StorageBase& rVbaPrjStrg,
                            const GraphicHelper& rGraphicHelper );

    bool                importVbaProject(
                            StorageBase& rVbaPrjStrg );

    void                importVbaData(const css::uno::Reference<css::io::XInputStream>& xInputStream);

    void                readVbaModules( StorageBase& rVbaPrjStrg );
    void                importModulesAndForms( StorageBase& rVbaPrjStrg, const GraphicHelper& rGraphicHelper );
    void                registerMacroAttacher( const VbaMacroAttacherRef& rxAttacher );

    void                attachMacros();

    void                setOleOverridesSink( css::uno::Reference< css::container::XNameContainer > const & rxOleOverridesSink ){ mxOleOverridesSink = rxOleOverridesSink; }

protected:
    void                addDummyModule( const OUString& rName, sal_Int32 nType );

    virtual void        prepareImport();

private:
                        VbaProject( const VbaProject& ) = delete;
    VbaProject&         operator=( const VbaProject& ) = delete;

    css::uno::Reference< css::script::XLibraryContainer >
                        getLibraryContainer( sal_Int32 nPropId );
    css::uno::Reference< css::container::XNameContainer >
                        openLibrary( sal_Int32 nPropId );
    css::uno::Reference< css::container::XNameContainer > const &
                        createBasicLibrary();
    css::uno::Reference< css::container::XNameContainer > const &
                        createDialogLibrary();

    void                importVba(
                            StorageBase& rVbaPrjStrg,
                            const GraphicHelper& rGraphicHelper );

    void                copyStorage( StorageBase& rVbaPrjStrg );

private:
    typedef RefVector< VbaMacroAttacherBase >           MacroAttacherVector;
    typedef ::std::map< OUString, sal_Int32 >    DummyModuleMap;

    css::uno::Reference< css::uno::XComponentContext >
                        mxContext;          
    css::uno::Reference< css::frame::XModel >
                        mxDocModel;         
    css::uno::Reference< css::container::XNameContainer >
                        mxBasicLib;         
    css::uno::Reference< css::container::XNameContainer >
                        mxDialogLib;        
    MacroAttacherVector maMacroAttachers;   
    DummyModuleMap      maDummyModules;     
    OUString            maPrjName;          
    css::uno::Reference< css::container::XNameContainer >
                        mxOleOverridesSink;
    typedef RefMap< OUString, VbaModule > VbaModuleMap;
    VbaModuleMap        maModules;
    VbaModuleMap        maModulesByStrm;
};


} // namespace oox::ole

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */