xestring.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_XESTRING_HXX
#define INCLUDED_SC_SOURCE_FILTER_INC_XESTRING_HXX

#include <sal/config.h>

#include <string_view>

#include "xlstring.hxx"
#include "ftools.hxx"

class XclExpStream;
class XclExpXmlStream;

class XclExpString
{
public:
    // constructors -----------------------------------------------------------

    explicit            XclExpString(
                            XclStrFlags nFlags = XclStrFlags::NONE,
                            sal_uInt16 nMaxLen = EXC_STR_MAXLEN );

    explicit            XclExpString(
                            const OUString& rString,
                            XclStrFlags nFlags = XclStrFlags::NONE,
                            sal_uInt16 nMaxLen = EXC_STR_MAXLEN );

    // assign -----------------------------------------------------------------

    void                Assign(
                            const OUString& rString,
                            XclStrFlags nFlags = XclStrFlags::NONE,
                            sal_uInt16 nMaxLen = EXC_STR_MAXLEN );

    void                Assign( sal_Unicode cChar );

    void                AssignByte(
                            std::u16string_view rString,
                            rtl_TextEncoding eTextEnc,
                            XclStrFlags nFlags = XclStrFlags::NONE,
                            sal_uInt16 nMaxLen = EXC_STR_MAXLEN );

    // append -----------------------------------------------------------------

    void                Append( const OUString& rString );

    void                AppendByte( std::u16string_view rString, rtl_TextEncoding eTextEnc );
    void                AppendByte( sal_Unicode cChar, rtl_TextEncoding eTextEnc );

    // formatting runs --------------------------------------------------------

    void                AppendFormat( sal_uInt16 nChar, sal_uInt16 nFontIdx, bool bDropDuplicate = true );
    void                AppendTrailingFormat( sal_uInt16 nFontIdx );
    void                LimitFormatCount( sal_uInt16 nMaxCount );
    sal_uInt16          GetLeadingFont();
    sal_uInt16          RemoveLeadingFont();

    // get data ---------------------------------------------------------------

    sal_uInt16   Len() const { return mnLen; }
    bool         IsEmpty() const { return mnLen == 0; }
    bool         IsWrapped() const { return mbWrapped; }
    bool                IsEqual( const XclExpString& rCmp ) const;
    bool                IsLessThan( const XclExpString& rCmp ) const;

    bool         IsRich() const { return !maFormats.empty(); }
    sal_uInt16          GetFormatsCount() const;
    const XclFormatRunVec& GetFormats() const { return maFormats; }

    sal_uInt8           GetFlagField() const;
    sal_uInt16          GetHeaderSize() const;
    std::size_t         GetBufferSize() const;
    std::size_t         GetSize() const;

    sal_uInt16          GetChar( sal_uInt16 nCharIdx ) const;
    sal_uInt16          GetHash() const;

    const ScfUInt16Vec& GetUnicodeBuffer() const { return maUniBuffer; }

    // streaming --------------------------------------------------------------

    void                WriteLenField( XclExpStream& rStrm ) const;
    void                WriteFlagField( XclExpStream& rStrm ) const;
    void                WriteHeader( XclExpStream& rStrm ) const;
    void                WriteBuffer( XclExpStream& rStrm ) const;
    void                WriteFormats( XclExpStream& rStrm, bool bWriteSize = false ) const;
    void                Write( XclExpStream& rStrm ) const;

    void                WriteHeaderToMem( sal_uInt8* pnMem ) const;
    void                WriteBufferToMem( sal_uInt8* pnMem ) const;
    void                WriteToMem( sal_uInt8* pnMem ) const;

    void                WriteXml( XclExpXmlStream& rStrm ) const;

private:
    bool                IsWriteFlags() const;
    bool                IsWriteFormats() const;

    void                SetStrLen( sal_Int32 nNewLen );
    void                CharsToBuffer( const sal_Unicode* pcSource, sal_Int32 nBegin, sal_Int32 nLen );
    void                CharsToBuffer( const char* pcSource, sal_Int32 nBegin, sal_Int32 nLen );

    void                Init( sal_Int32 nCurrLen, XclStrFlags nFlags, sal_uInt16 nMaxLen, bool bBiff8 );
    void                Build(
                            const sal_Unicode* pcSource, sal_Int32 nCurrLen,
                            XclStrFlags nFlags, sal_uInt16 nMaxLen );
    void                Build(
                            const char* pcSource, sal_Int32 nCurrLen,
                            XclStrFlags nFlags, sal_uInt16 nMaxLen );

    void                InitAppend( sal_Int32 nAddLen );
    void                BuildAppend( const sal_Unicode* pcSource, sal_Int32 nAddLen );
    void                BuildAppend( const char* pcSource, sal_Int32 nAddLen );

    void                PrepareWrite( XclExpStream& rStrm, sal_uInt16 nBytes ) const;

private:
    ScfUInt16Vec        maUniBuffer;    
    ScfUInt8Vec         maCharBuffer;   
    XclFormatRunVec     maFormats;      
    sal_uInt16          mnLen;          
    sal_uInt16          mnMaxLen;       
    bool                mbIsBiff8;      
    bool                mbIsUnicode;    
    bool                mb8BitLen;      
    bool                mbSmartFlags;   
    bool                mbSkipFormats;  
    bool                mbWrapped;      
    bool                mbSkipHeader;   
};

inline bool operator==( const XclExpString& rLeft, const XclExpString& rRight )
{
    return rLeft.IsEqual( rRight );
}

inline bool operator!=( const XclExpString& rLeft, const XclExpString& rRight )
{
    return !(rLeft == rRight);
}

inline bool operator<( const XclExpString& rLeft, const XclExpString& rRight )
{
    return rLeft.IsLessThan( rRight );
}

inline XclExpStream& operator<<( XclExpStream& rStrm, const XclExpString& rString )
{
    rString.Write( rStrm );
    return rStrm;
}

#endif

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