importutils.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/.
 */
#ifndef INCLUDED_OOX_MATHML_IMPORTUTILS_HXX
#define INCLUDED_OOX_MATHML_IMPORTUTILS_HXX
 
#include <map>
#include <string_view>
#include <vector>
 
#include <com/sun/star/uno/Reference.hxx>
#include <oox/dllapi.h>
#include <oox/token/tokens.hxx>
#include <rtl/ustring.hxx>
#include <sal/types.h>
 
namespace com::sun::star
{
namespace xml::sax
{
class XFastAttributeList;
}
}
 
namespace oox::formulaimport
{
// used to differentiate between tags that opening or closing
const int TAG_OPENING = 1 << 29;
const int TAG_CLOSING = 1 << 30;
 
// you probably want to #define these to something shorter in the .cxx file,
// but they must be done as macros, otherwise they wouldn't be usable for case values,
// and macros cannot be namespaced
#define XML_STREAM_OPENING(token) (TAG_OPENING | token)
#define XML_STREAM_CLOSING(token) (TAG_CLOSING | token)
 
class OOX_DLLPUBLIC XmlStream
{
public:
    XmlStream();
    // One could theoretically use oox::AttributeList, but that complains if the passed reference is empty,
    // which would be complicated to avoid here. Also, parsers apparently reuse the same instance of XFastAttributeList,
    // which means using oox::AttributeList would make them all point to the one instance.
    struct OOX_DLLPUBLIC AttributeList
    {
        OUString& operator[](int token);
        OUString attribute(int token, const OUString& def) const;
        bool attribute(int token, bool def) const;
        sal_Unicode attribute(int token, sal_Unicode def) const;
        // when adding more attribute() overloads, add also to XmlStream itself
    protected:
        std::map<int, OUString> attrs;
    };
    struct OOX_DLLPUBLIC Tag
    {
        Tag(int token = XML_TOKEN_INVALID,
            const css::uno::Reference<css::xml::sax::XFastAttributeList>& attributes
            = css::uno::Reference<css::xml::sax::XFastAttributeList>());
        Tag(int token, AttributeList attribs);
        int token; 
        AttributeList attributes;
        OUString text;
        OUString attribute(int token, const OUString& def = OUString()) const;
        bool attribute(int token, bool def) const;
        sal_Unicode attribute(int token, sal_Unicode def) const;
        // when adding more attribute() overloads, add also to XmlStream::AttributeList and inline below
        operator bool() const;
    };
    bool atEnd() const;
    Tag currentTag() const;
    int currentToken() const;
    void moveToNextTag();
    Tag ensureOpeningTag(int token);
    Tag checkOpeningTag(int token);
    void ensureClosingTag(int token);
    bool findTag(int token);
    void handleUnexpectedTag();
 
protected:
    Tag checkTag(int token, bool optional);
    bool findTagInternal(int token, bool silent);
    void skipElementInternal(int token, bool silent);
    std::vector<Tag> tags;
    unsigned int pos;
};
 
class OOX_DLLPUBLIC XmlStreamBuilder : public XmlStream
{
public:
    void appendOpeningTag(int token,
                          const css::uno::Reference<css::xml::sax::XFastAttributeList>& attributes
                          = css::uno::Reference<css::xml::sax::XFastAttributeList>());
    void appendOpeningTag(int token, const AttributeList& attribs);
    void appendClosingTag(int token);
    // appends the characters after the last appended token
    void appendCharacters(std::u16string_view characters);
};
 
inline OUString XmlStream::Tag::attribute(int t, const OUString& def) const
{
    return attributes.attribute(t, def);
}
 
inline bool XmlStream::Tag::attribute(int t, bool def) const
{
    return attributes.attribute(t, def);
}
 
inline sal_Unicode XmlStream::Tag::attribute(int t, sal_Unicode def) const
{
    return attributes.attribute(t, def);
}
 
} // namespace
 
#endif
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */