fastserializer.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_SAX_SOURCE_TOOLS_FASTSERIALIZER_HXX
#define INCLUDED_SAX_SOURCE_TOOLS_FASTSERIALIZER_HXX
 
#include <com/sun/star/xml/sax/XFastTokenHandler.hpp>
#include <com/sun/star/io/XOutputStream.hpp>
 
#include <sax/fastattribs.hxx>
#include <sax/fshelper.hxx>
#include "CachedOutputStream.hxx"
 
#include <stack>
#include <string_view>
#include <map>
#include <memory>
 
namespace sax_fastparser {
 
struct TokenValue
{
    sal_Int32   nToken;
    const char *pValue;
    TokenValue(sal_Int32 _nToken, const char *_pValue) : nToken(_nToken), pValue(_pValue) {}
};
typedef std::vector<TokenValue> TokenValueList;
 
class FastSaxSerializer
{
    typedef css::uno::Sequence< ::sal_Int8 > Int8Sequence;
    typedef css::uno::Sequence< ::sal_Int32 > Int32Sequence;
 
public:
    explicit FastSaxSerializer(const css::uno::Reference< css::io::XOutputStream >& xOutputStream);
    ~FastSaxSerializer();
 
    css::uno::Reference< css::io::XOutputStream > const & getOutputStream() const;
    TokenValueList& getTokenValueList() { return maTokenValues; }
 
    void startDocument();
 
    void endDocument();
 
    void startFastElement( ::sal_Int32 Element, FastAttributeList const * pAttrList = nullptr );
 
    void endFastElement( ::sal_Int32 Element );
 
    void singleFastElement( ::sal_Int32 Element, FastAttributeList const * pAttrList = nullptr );
 
    // C++ helpers
    void writeId( ::sal_Int32 Element );
    OString getId( ::sal_Int32 Element );
 
    void write( double value );
    void write( std::u16string_view s, bool bEscape = false );
    void write( std::string_view s, bool bEscape = false );
    void write( const char* pStr, sal_Int32 nLen, bool bEscape = false );
 
    // strings with _xHHHH_ are escaped with _x005F unless this is disabled
    void setAllowXEscape(bool bSet) { mbXescape = bSet; }
 
public:
    void mark(sal_Int32 nTag, const Int32Sequence& rOrder);
 
    void mergeTopMarks(sal_Int32 nTag,
        sax_fastparser::MergeMarks eMergeType);
 
private:
    CachedOutputStream maCachedOutputStream;
    css::uno::Reference< css::xml::sax::XFastTokenHandler > mxFastTokenHandler;
 
    class ForMerge : public ForMergeBase
    {
        Int8Sequence maData;
        Int8Sequence maPostponed;
 
    public:
        sal_Int32 const m_Tag;
#ifdef DBG_UTIL
        // pending close tags, followed by pending open tags
        std::deque<sal_Int32> m_DebugEndedElements;
        std::deque<sal_Int32> m_DebugStartedElements;
        // ... and another buffer for maPostponed ...
        std::deque<sal_Int32> m_DebugPostponedEndedElements;
        std::deque<sal_Int32> m_DebugPostponedStartedElements;
#endif
 
        explicit ForMerge(sal_Int32 const nTag) : m_Tag(nTag) {}
 
        virtual void setCurrentElement( ::sal_Int32 /*nToken*/ ) {}
        virtual Int8Sequence& getData();
#if OSL_DEBUG_LEVEL > 0
        virtual void print();
#endif
 
        virtual void prepend( const Int8Sequence &rWhat );
        virtual void append( const css::uno::Sequence<sal_Int8> &rWhat ) override;
        void postpone( const Int8Sequence &rWhat );
 
    protected:
        void resetData( );
        static void merge( Int8Sequence &rTop, const Int8Sequence &rMerge, bool bAppend );
    };
 
    class ForSort : public ForMerge
    {
        std::map< ::sal_Int32, Int8Sequence > maData;
        sal_Int32 mnCurrentElement;
 
        Int32Sequence maOrder;
 
    public:
        ForSort(sal_Int32 const nTag, const Int32Sequence& rOrder)
            : ForMerge(nTag)
            , mnCurrentElement( 0 )
            , maOrder( rOrder )
        {}
 
        void setCurrentElement( ::sal_Int32 nToken ) override;
 
        virtual Int8Sequence& getData() override;
 
#if OSL_DEBUG_LEVEL > 0
        virtual void print() override;
#endif
 
        virtual void prepend( const Int8Sequence &rWhat ) override;
        virtual void append( const css::uno::Sequence<sal_Int8> &rWhat ) override;
    private:
        void sort();
    };
 
    std::stack< std::shared_ptr< ForMerge > > maMarkStack;
    bool mbMarkStackEmpty;
    // Would be better to use OStringBuffer instead of these two
    // but then we couldn't get the rtl_String* member :-(
    rtl_String *mpDoubleStr;
    sal_Int32 mnDoubleStrCapacity;
    TokenValueList maTokenValues;
    bool mbXescape;     
 
 
#ifdef DBG_UTIL
    std::stack<sal_Int32> m_DebugStartedElements;
#endif
 
    void writeTokenValueList();
    void writeFastAttributeList(FastAttributeList const & rAttrList);
 
    void writeBytes( const css::uno::Sequence< ::sal_Int8 >& aData );
    void writeBytes( const char* pStr, size_t nLen );
};
 
} // namespace sax_fastparser
 
#endif
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */