xicontent.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_SC_SOURCE_FILTER_INC_XICONTENT_HXX
#define INCLUDED_SC_SOURCE_FILTER_INC_XICONTENT_HXX

#include <rangelst.hxx>
#include "xistring.hxx"
#include "xiroot.hxx"
#include <validat.hxx>
#include <tabprotection.hxx>

#include <map>
#include <vector>
#include <memory>

class ErrCode;
struct XclRange;

/* ============================================================================
Classes to import the big Excel document contents (related to several cells or
globals for the document).
- Shared
 tables
- Hyperlinks
- Label ranges
- Conditional formatting
- Data validation
- Web queries
- Stream decryption
============================================================================ */

// Shared string table ========================================================

class XclImpSst : protected XclImpRoot
{
public:
    explicit            XclImpSst( const XclImpRoot& rRoot );

    void                ReadSst( XclImpStream& rStrm );

    const XclImpString* GetString( sal_uInt32 nSstIndex ) const;

private:
    typedef ::std::vector< XclImpString > XclImpStringVec;
    XclImpStringVec     maStrings;          
};

// Hyperlinks =================================================================

class XclImpHyperlink
{
public:
    XclImpHyperlink(const XclImpHyperlink&) = delete;
    const XclImpHyperlink& operator=(const XclImpHyperlink&) = delete;
    XclImpHyperlink() = delete;

    static void         ReadHlink( XclImpStream& rStrm );

    static OUString     ReadEmbeddedData( XclImpStream& rStrm );

    static void InsertUrl( XclImpRoot& rRoot, const XclRange& rXclRange, const OUString& rUrl );

    static void         ConvertToValidTabName(OUString& rName);
};

// Label ranges ===============================================================

class XclImpLabelranges
{
public:
    XclImpLabelranges(const XclImpLabelranges&) = delete;
    const XclImpLabelranges& operator=(const XclImpLabelranges&) = delete;
    XclImpLabelranges() = delete;
    static void         ReadLabelranges( XclImpStream& rStrm );
};

// Conditional formatting =====================================================

class XclImpCondFormat : protected XclImpRoot
{
public:
    explicit            XclImpCondFormat( const XclImpRoot& rRoot, sal_uInt32 nFormatIndex );
    virtual             ~XclImpCondFormat() override;

    void                ReadCondfmt( XclImpStream& rStrm );
    void                ReadCF( XclImpStream& rStrm );

    void                Apply();

private:
    typedef ::std::unique_ptr< ScConditionalFormat > ScCondFmtPtr;

    ScRangeList         maRanges;           
    ScCondFmtPtr        mxScCondFmt;        
    sal_uInt32          mnFormatIndex;      
    sal_uInt16          mnCondCount;        
    sal_uInt16          mnCondIndex;        
};

class XclImpCondFormatManager : protected XclImpRoot
{
public:
    explicit            XclImpCondFormatManager( const XclImpRoot& rRoot );

    void                ReadCondfmt( XclImpStream& rStrm );
    void                ReadCF( XclImpStream& rStrm );

    void                Apply();

private:
    std::vector< std::unique_ptr<XclImpCondFormat> >
                        maCondFmtList;      
};

// Data Validation ============================================================

class XclImpValidationManager : protected XclImpRoot
{
public:
    explicit            XclImpValidationManager( const XclImpRoot& rRoot );

    static void         ReadDval( XclImpStream& rStrm );
    void                ReadDV( XclImpStream& rStrm );

    void                Apply();
private:
    struct DVItem
    {
        ScRangeList         maRanges;
        ScValidationData    maValidData;

        explicit DVItem ( const ScRangeList& rRanges, const ScValidationData& rValidData );
    };
    typedef std::vector< std::unique_ptr<DVItem> > DVItemList;

    DVItemList maDVItems;
};

// Web queries ================================================================

class XclImpWebQuery
{
public:
    explicit            XclImpWebQuery( const ScRange& rDestRange );

    void                ReadParamqry( XclImpStream& rStrm );
    void                ReadWqstring( XclImpStream& rStrm );
    void                ReadWqsettings( XclImpStream& rStrm );
    void                ReadWqtables( XclImpStream& rStrm );

    void                Apply( ScDocument& rDoc, const OUString& rFilterName );

private:
    enum XclImpWebQueryMode
    {
        xlWQUnknown,                
        xlWQDocument,               
        xlWQAllTables,              
        xlWQSpecTables              
    };

    OUString            maURL;          
    OUString            maTables;       
    ScRange             maDestRange;    
    XclImpWebQueryMode  meMode;         
    sal_uInt16          mnRefresh;      
};

class XclImpWebQueryBuffer : protected XclImpRoot
{
public:
    explicit            XclImpWebQueryBuffer( const XclImpRoot& rRoot );

    void                ReadQsi( XclImpStream& rStrm );
    void                ReadParamqry( XclImpStream& rStrm );
    void                ReadWqstring( XclImpStream& rStrm );
    void                ReadWqsettings( XclImpStream& rStrm );
    void                ReadWqtables( XclImpStream& rStrm );

    void                Apply();

private:
    typedef std::vector< XclImpWebQuery > XclImpWebQueryList;
    XclImpWebQueryList  maWQList;       
};

// Decryption =================================================================

class XclImpDecryptHelper
{
public:
    XclImpDecryptHelper(const XclImpDecryptHelper&) = delete;
    const XclImpDecryptHelper& operator=(const XclImpDecryptHelper&) = delete;
    XclImpDecryptHelper() = delete;

    static const ErrCode&      ReadFilepass( XclImpStream& rStrm );
};

// Document protection ========================================================

class XclImpDocProtectBuffer : protected XclImpRoot
{
public:
    explicit            XclImpDocProtectBuffer( const XclImpRoot& rRoot );

    void                ReadDocProtect( XclImpStream& rStrm );

    void                ReadWinProtect( XclImpStream& rStrm );

    void                ReadPasswordHash( XclImpStream& rStrm );

    void                Apply() const;

private:
    sal_uInt16      mnPassHash;
    bool            mbDocProtect:1;
    bool            mbWinProtect:1;
};

// Sheet protection ===========================================================

class XclImpSheetProtectBuffer : protected XclImpRoot
{
public:
    explicit            XclImpSheetProtectBuffer( const XclImpRoot& rRoot );

    void                ReadProtect( XclImpStream& rStrm, SCTAB nTab );

    void                ReadOptions( XclImpStream& rStrm, SCTAB nTab );

    void                AppendEnhancedProtection( const ScEnhancedProtection & rProt, SCTAB nTab );

    void                ReadPasswordHash( XclImpStream& rStrm, SCTAB nTab );

    void                Apply() const;

private:
    struct Sheet
    {
        bool        mbProtected;
        sal_uInt16  mnPasswordHash;
        sal_uInt16  mnOptions;
        ::std::vector< ScEnhancedProtection >  maEnhancedProtections;

        Sheet();
        Sheet(const Sheet& r);
    };

    Sheet* GetSheetItem( SCTAB nTab );

private:
    typedef ::std::map<SCTAB, Sheet> ProtectedSheetMap;
    ProtectedSheetMap   maProtectedSheets;
};

#endif

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