xilink.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 <memory>
#include <map>
#include "xllink.hxx"
#include "xiroot.hxx"
#include "ftools.hxx"
#include <types.hxx>

namespace svl {

class SharedStringPool;

}

/* ============================================================================
Classes for import of different kinds of internal/external references.
- 3D cell and cell range links
- External cell and cell range links
- External defined names
- Add-in functions
- DDE links
- OLE object links
============================================================================ */

// Excel sheet indexes ========================================================

class XclImpTabInfo
{
public:
    // original Excel sheet names ---------------------------------------------

    void                AppendXclTabName( const OUString& rXclTabName, SCTAB nScTab );
    void                InsertScTab( SCTAB nScTab );

    SCTAB               GetScTabFromXclName( const OUString& rXclTabName ) const;

    // record creation order - TABID record -----------------------------------

    void                ReadTabid( XclImpStream& rStrm );

    sal_uInt16          GetCurrentIndex( sal_uInt16 nCreatedId, sal_uInt16 nMaxTabId ) const;

private:
    typedef ::std::map< OUString, SCTAB > XclTabNameMap;

    XclTabNameMap       maTabNames;     
    ScfUInt16Vec        maTabIdVec;     
};

// External names =============================================================

enum XclImpExtNameType
{
    xlExtName,                  
    xlExtAddIn,                 
    xlExtDDE,                   
    xlExtOLE,                   
    xlExtEuroConvert            
};

class XclImpCachedMatrix;
class ScTokenArray;
class XclImpSupbook;

class XclImpExtName
{
    class MOper
    {
    public:
        MOper(svl::SharedStringPool& rPool, XclImpStream& rStrm);
        const ScMatrix& GetCache() const;
    private:
        ScMatrixRef mxCached;
    };

public:
    explicit XclImpExtName( XclImpSupbook& rSupbook, XclImpStream& rStrm,
                            XclSupbookType eSubType, ExcelToSc* pFormulaConv );
    ~XclImpExtName();

    void                CreateDdeData( ScDocument& rDoc,
                            const OUString& rApplc, const OUString& rExtDoc ) const;

    void                CreateExtNameData( const ScDocument& rDoc, sal_uInt16 nFileId ) const;

    bool CreateOleData(const ScDocument& rDoc, const OUString& rUrl,
                       sal_uInt16& rFileId, OUString& rTabName, ScRange& rRange) const;

    bool                HasFormulaTokens() const;

    XclImpExtNameType GetType() const { return meType; }
    const OUString& GetName() const { return maName; }
    sal_uInt32   GetStorageId() const { return mnStorageId; }

private:
    typedef ::std::unique_ptr< XclImpCachedMatrix > XclImpCachedMatrixPtr;
    typedef ::std::unique_ptr< ScTokenArray >       TokenArrayPtr;

    XclImpCachedMatrixPtr  mxDdeMatrix;     
    std::unique_ptr<MOper> mpMOper;         
    TokenArrayPtr          mxArray;         
    OUString               maName;          
    sal_uInt32             mnStorageId;     
    XclImpExtNameType      meType;          
};

// Import link manager ========================================================

class XclImpLinkManagerImpl;

class XclImpLinkManager : protected XclImpRoot
{
public:
    explicit            XclImpLinkManager( const XclImpRoot& rRoot );
                        virtual ~XclImpLinkManager() override;

    void                ReadExternsheet( XclImpStream& rStrm );
    void                ReadSupbook( XclImpStream& rStrm );
    void                ReadXct( XclImpStream& rStrm );
    void                ReadCrn( XclImpStream& rStrm );
    void                ReadExternname( XclImpStream& rStrm, ExcelToSc* pFormulaConv );

    bool                IsSelfRef( sal_uInt16 nXtiIndex ) const;
    bool                GetScTabRange(
                            SCTAB& rnFirstScTab, SCTAB& rnLastScTab,
                            sal_uInt16 nXtiIndex ) const;
    const XclImpExtName* GetExternName( sal_uInt16 nXtiIndex, sal_uInt16 nExtName ) const;

    const OUString* GetSupbookUrl( sal_uInt16 nXtiIndex ) const;

    OUString GetSupbookTabName( sal_uInt16 nXti, sal_uInt16 nXtiTab ) const;

    bool                GetLinkData( OUString& rApplic, OUString& rTopic, sal_uInt16 nXtiIndex ) const;
    OUString       GetMacroName( sal_uInt16 nExtSheet, sal_uInt16 nExtName ) const;

private:
    typedef ::std::unique_ptr< XclImpLinkManagerImpl > XclImpLinkMgrImplPtr;
    XclImpLinkMgrImplPtr mxImpl;
};

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