xehelper.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_XEHELPER_HXX
#define INCLUDED_SC_SOURCE_FILTER_INC_XEHELPER_HXX

#include <memory>
#include <string_view>

#include "ftools.hxx"
#include <rangelst.hxx>
#include "xladdress.hxx"
#include "xeroot.hxx"
#include "xlstring.hxx"

// Export progress bar ========================================================

class ScfProgressBar;

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

    void                Initialize();

    void                IncRowRecordCount();

    void                ActivateCreateRowsSegment();
    void                ActivateFinalRowsSegment();

    void                Progress();

private:
    typedef std::unique_ptr< ScfProgressBar > ScfProgressBarPtr;

    ScfProgressBarPtr   mxProgress;         
    ScfProgressBar*     mpSubProgress;      

    ScfProgressBar*     mpSubRowCreate;     
    ScfInt32Vec         maSubSegRowCreate;  

    ScfProgressBar*     mpSubRowFinal;      
    sal_Int32           mnSegRowFinal;      

    std::size_t         mnRowCount;         
};

// Calc->Excel cell address/range conversion ==================================

class XclExpAddressConverter : public XclAddressConverterBase
{
public:
    explicit            XclExpAddressConverter( const XclExpRoot& rRoot );

    // cell address -----------------------------------------------------------

    bool                CheckAddress( const ScAddress& rScPos, bool bWarn );

    bool                ConvertAddress( XclAddress& rXclPos,
                            const ScAddress& rScPos, bool bWarn );

    XclAddress          CreateValidAddress( const ScAddress& rScPos, bool bWarn );

    // cell range -------------------------------------------------------------

    bool                CheckRange( const ScRange& rScRange, bool bWarn );

    bool                ValidateRange( ScRange& rScRange, bool bWarn );

    bool                ConvertRange( XclRange& rXclRange, const ScRange& rScRange, bool bWarn );

    // cell range list --------------------------------------------------------

    void                ValidateRangeList( ScRangeList& rScRanges, bool bWarn );

    void                ConvertRangeList( XclRangeList& rXclRanges,
                            const ScRangeList& rScRanges, bool bWarn );
};

// EditEngine->String conversion ==============================================

class SvxURLField;
class XclExpHyperlink;

class XclExpHyperlinkHelper : protected XclExpRoot
{
public:
    typedef rtl::Reference< XclExpHyperlink > XclExpHyperlinkRef;

    explicit            XclExpHyperlinkHelper( const XclExpRoot& rRoot, const ScAddress& rScPos );
                        virtual ~XclExpHyperlinkHelper() override;

    OUString ProcessUrlField( const SvxURLField& rUrlField );

    bool                HasLinkRecord() const;
    XclExpHyperlinkRef  GetLinkRecord() const;

    bool         HasMultipleUrls() const { return mbMultipleUrls; }
    const OUString& GetUrlList() const { return maUrlList; }

private:
    XclExpHyperlinkRef  mxLinkRec;          
    ScAddress           maScPos;            
    OUString            maUrlList;          
    bool                mbMultipleUrls;     
};

class EditEngine;
class EditTextObject;
class SdrTextObj;
class ScPatternAttr;

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

    static XclExpStringRef CreateString(
                            const XclExpRoot& rRoot,
                            const OUString& rString,
                            XclStrFlags nFlags = XclStrFlags::NONE,
                            sal_uInt16 nMaxLen = EXC_STR_MAXLEN );

    static XclExpStringRef CreateString(
                            const XclExpRoot& rRoot,
                            sal_Unicode cChar,
                            XclStrFlags nFlags = XclStrFlags::NONE,
                            sal_uInt16 nMaxLen = EXC_STR_MAXLEN );

    static void         AppendString(
                            XclExpString& rXclString,
                            const XclExpRoot& rRoot,
                            const OUString& rString );

    static void         AppendChar(
                            XclExpString& rXclString,
                            const XclExpRoot& rRoot,
                            sal_Unicode cChar );

    static XclExpStringRef CreateCellString(
                            const XclExpRoot& rRoot,
                            const OUString& rString,
                            const ScPatternAttr* pCellAttr,
                            XclStrFlags nFlags = XclStrFlags::NONE,
                            sal_uInt16 nMaxLen = EXC_STR_MAXLEN );

    static XclExpStringRef CreateCellString(
                            const XclExpRoot& rRoot,
                            const EditTextObject& rEditText,
                            const ScPatternAttr* pCellAttr,
                            XclExpHyperlinkHelper& rLinkHelper,
                            XclStrFlags nFlags = XclStrFlags::NONE,
                            sal_uInt16 nMaxLen = EXC_STR_MAXLEN );

    static XclExpStringRef CreateString(
                            const XclExpRoot& rRoot,
                            const SdrTextObj& rTextObj,
                            XclStrFlags nFlags = XclStrFlags::NONE );

    static XclExpStringRef CreateString(
                            const XclExpRoot& rRoot,
                            const EditTextObject& rEditObj,
                            XclStrFlags nFlags = XclStrFlags::NONE );

    static sal_Int16    GetLeadingScriptType( const XclExpRoot& rRoot, const OUString& rString );
};

// Header/footer conversion ===================================================

class XclExpHFConverter : protected XclExpRoot
{
public:
    XclExpHFConverter(const XclExpHFConverter&) = delete;
    const XclExpHFConverter& operator=(const XclExpHFConverter&) = delete;

    explicit            XclExpHFConverter( const XclExpRoot& rRoot );

    void                GenerateString(
                            const EditTextObject* pLeftObj,
                            const EditTextObject* pCenterObj,
                            const EditTextObject* pRightObj );

    const OUString& GetHFString() const { return maHFString; }
    sal_Int32    GetTotalHeight() const { return mnTotalHeight; }

private:
    void                AppendPortion(
                            const EditTextObject* pTextObj,
                            sal_Unicode cPortionCode );

private:
    EditEngine&         mrEE;           
    OUString            maHFString;     
    sal_Int32           mnTotalHeight;  
};

// URL conversion =============================================================

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

    static OUString EncodeUrl( const XclExpRoot& rRoot, const OUString& rAbsUrl, const OUString* pTableName = nullptr );
    static OUString EncodeDde( std::u16string_view rApplic, std::u16string_view rTopic );
};

class ScMatrix;

class XclExpCachedMatrix
{
    void            GetDimensions( SCSIZE & nCols, SCSIZE & nRows ) const;
public:
    explicit        XclExpCachedMatrix( const ScMatrix& rMatrix );
                   ~XclExpCachedMatrix();

    std::size_t     GetSize() const;
    void            Save( XclExpStream& rStrm ) const;

private:
    const ScMatrix& mrMatrix;
};

#endif

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