xelink.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 "xerecord.hxx"
#include "xeroot.hxx"
#include <externalrefmgr.hxx>
#include <memory>
#include <o3tl/typed_flags_set.hxx>

struct ScSingleRefData;
struct ScComplexRefData;
struct XclExpRefLogEntry;

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

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

enum class ExcTabBufFlags : sal_uInt8 {
    NONE     = 0x00,
    Ignore   = 0x01,     
    Extern   = 0x02,     
    SkipMask = 0x03,     
    Visible  = 0x10,     
    Selected = 0x20,     
    Mirrored = 0x40      
};
namespace o3tl {
    template<> struct typed_flags<ExcTabBufFlags> : is_typed_flags<ExcTabBufFlags, 0x73> {};
}

class XclExpTabInfo : protected XclExpRoot
{
public:
    explicit            XclExpTabInfo( const XclExpRoot& rRoot );

    bool                IsExportTab( SCTAB nScTab ) const;
    bool                IsExternalTab( SCTAB nScTab ) const;
    bool                IsVisibleTab( SCTAB nScTab ) const;
    bool                IsSelectedTab( SCTAB nScTab ) const;
    bool                IsDisplayedTab( SCTAB nScTab ) const;
    bool                IsMirroredTab( SCTAB nScTab ) const;
    OUString       GetScTabName( SCTAB nScTab ) const;

    sal_uInt16          GetXclTab( SCTAB nScTab ) const;

    SCTAB               GetRealScTab( SCTAB nSortedScTab ) const;

    SCTAB        GetScTabCount() const { return mnScCnt; }

    sal_uInt16   GetXclTabCount() const { return mnXclCnt; }
    sal_uInt16   GetXclExtTabCount() const { return mnXclExtCnt; }
    sal_uInt16   GetXclSelectedCount() const { return mnXclSelCnt; }

    sal_uInt16   GetDisplayedXclTab() const { return mnDisplXclTab; }
    sal_uInt16   GetFirstVisXclTab() const { return mnFirstVisXclTab; }

private:
    bool                GetFlag( SCTAB nScTab, ExcTabBufFlags nFlags ) const;
    void                SetFlag( SCTAB nScTab, ExcTabBufFlags nFlags, bool bSet = true );

    void                CalcXclIndexes();
    void                CalcSortedIndexes();

private:
    struct XclExpTabInfoEntry
    {
        OUString            maScName;
        sal_uInt16          mnXclTab;
        ExcTabBufFlags      mnFlags;
        explicit     XclExpTabInfoEntry() : mnXclTab( 0 ), mnFlags( ExcTabBufFlags::NONE ) {}
    };

    typedef ::std::vector< SCTAB >              ScTabVec;

    std::vector< XclExpTabInfoEntry >
                        maTabInfoVec;       

    SCTAB               mnScCnt;            
    sal_uInt16          mnXclCnt;           
    sal_uInt16          mnXclExtCnt;        
    sal_uInt16          mnXclSelCnt;        
    sal_uInt16          mnDisplXclTab;      
    sal_uInt16          mnFirstVisXclTab;   

    ScTabVec            maFromSortedVec;    
    ScTabVec            maToSortedVec;      
};

// Export link manager ========================================================

class XclExpLinkManagerImpl;

class XclExpLinkManager : public XclExpRecordBase, protected XclExpRoot
{
public:
    explicit            XclExpLinkManager( const XclExpRoot& rRoot );
    virtual             ~XclExpLinkManager() override;

    void                FindExtSheet( sal_uInt16& rnExtSheet,
                            sal_uInt16& rnXclTab, SCTAB nScTab,
                            XclExpRefLogEntry* pRefLogEntry = nullptr );
    void                FindExtSheet( sal_uInt16& rnExtSheet,
                            sal_uInt16& rnFirstXclTab, sal_uInt16& rnLastXclTab,
                            SCTAB nFirstScTab, SCTAB nLastScTab,
                            XclExpRefLogEntry* pRefLogEntry );
    sal_uInt16          FindExtSheet( sal_Unicode cCode );

    void                FindExtSheet( sal_uInt16 nFileId, const OUString& rTabName, sal_uInt16 nXclTabSpan,
                                      sal_uInt16& rnExtSheet, sal_uInt16& rnFirstSBTab, sal_uInt16& rnLastSBTab,
                                      XclExpRefLogEntry* pRefLogEntry );

    void StoreCell( const ScSingleRefData& rRef, const ScAddress& rPos );
    void StoreCellRange( const ScComplexRefData& rRef, const ScAddress& rPos );

    void StoreCell( sal_uInt16 nFileId, const OUString& rTabName, const ScAddress& rPos );

    void StoreCellRange( sal_uInt16 nFileId, const OUString& rTabName, const ScRange& rRange );

    bool                InsertAddIn(
                            sal_uInt16& rnExtSheet, sal_uInt16& rnExtName,
                            const OUString& rName );
    bool                InsertEuroTool(
                            sal_uInt16& rnExtSheet, sal_uInt16& rnExtName,
                            const OUString& rName );
    bool                InsertDde(
                            sal_uInt16& rnExtSheet, sal_uInt16& rnExtName,
                            const OUString& rApplic, const OUString& rTopic, const OUString& rItem );

    bool                InsertExtName(
                            sal_uInt16& rnExtSheet, sal_uInt16& rnExtName, const OUString& rUrl,
                            const OUString& rName, const ScExternalRefCache::TokenArrayRef& rArray );

    virtual void        Save( XclExpStream& rStrm ) override;

    virtual void        SaveXml( XclExpXmlStream& rStrm ) override;

private:
    typedef std::shared_ptr< XclExpLinkManagerImpl > XclExpLinkMgrImplPtr;
    XclExpLinkMgrImplPtr mxImpl;
};

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