WPSContentListener.h

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */
/* libwps
 * Version: MPL 2.0 / LGPLv2.1+
 *
 * 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/.
 *
 * Major Contributor(s):
 * Copyright (C) 2006, 2007 Andrew Ziem
 * Copyright (C) 2006 Fridrich Strba (fridrich.strba@bluewin.ch)
 * Copyright (C) 2003-2005 William Lachance (william.lachance@sympatico.ca)
 * Copyright (C) 2003 Marc Maurer (uwog@uwog.net)
 *
 * For minor contributions see the git repository.
 *
 * Alternatively, the contents of this file may be used under the terms
 * of the GNU Lesser General Public License Version 2.1 or later
 * (LGPLv2.1+), in which case the provisions of the LGPLv2.1+ are
 * applicable instead of those above.
 *
 * For further information visit http://libwps.sourceforge.net
 */
 
#ifndef WPSCONTENTLISTENER_H
#define WPSCONTENTLISTENER_H
 
#include <vector>
 
#include <librevenge/librevenge.h>
 
#include "libwps_internal.h"
 
#include "WPSListener.h"
 
class WPSGraphicShape;
class WPSGraphicStyle;
class WPSList;
class WPSPageSpan;
struct WPSParagraph;
struct WPSTabStop;
 
struct WPSContentParsingState;
struct WPSDocumentParsingState;
 
class WPSContentListener final : public WPSListener
{
public:
        WPSContentListener(std::vector<WPSPageSpan> const &pageList, librevenge::RVNGTextInterface *documentInterface);
        ~WPSContentListener() final;
 
        void setDocumentLanguage(int lcid) final;
        void setMetaData(const librevenge::RVNGPropertyList &list);
 
        void startDocument();
        void endDocument();
        void handleSubDocument(WPSSubDocumentPtr &subDocument, libwps::SubDocumentType subDocumentType);
        bool isHeaderFooterOpened() const;
 
        // ------ text data -----------

        void insertCharacter(uint8_t character) final;
        void insertUnicode(uint32_t character) final;
        void insertUnicodeString(librevenge::RVNGString const &str) final;
 
        void insertTab() final;
        void insertEOL(bool softBreak=false) final;
        void insertBreak(const uint8_t breakType) final;
 
        // ------ text format -----------
        void setFont(const WPSFont &font) final;
        WPSFont const &getFont() const final;
 
        // ------ paragraph format -----------
        bool isParagraphOpened() const final;
        void setParagraph(const WPSParagraph &para) final;
        WPSParagraph const &getParagraph() const final;
 
        // ------ list format -----------
        void setCurrentList(std::shared_ptr<WPSList> list);
        std::shared_ptr<WPSList> getCurrentList() const;
 
        // ------- fields ----------------
        void insertField(WPSField const &field) final;
 
        // ------- subdocument -----------------
        enum NoteType { FOOTNOTE, ENDNOTE };
        void insertNote(const NoteType noteType, WPSSubDocumentPtr &subDocument);
        void insertLabelNote(const NoteType noteType, librevenge::RVNGString const &label, WPSSubDocumentPtr &subDocument);
        void insertComment(WPSSubDocumentPtr &subDocument);

        void insertPicture(WPSPosition const &pos, const librevenge::RVNGBinaryData &binaryData,
                           std::string const &type="image/pict",
                           librevenge::RVNGPropertyList frameExtras=librevenge::RVNGPropertyList());
        void insertPicture(WPSPosition const &pos, WPSGraphicShape const &shape, WPSGraphicStyle const &style);
        void insertObject(WPSPosition const &pos, const WPSEmbeddedObject &obj,
                          librevenge::RVNGPropertyList frameExtras=librevenge::RVNGPropertyList());

        void insertTextBox(WPSPosition const &pos, WPSSubDocumentPtr subDocument,
                           librevenge::RVNGPropertyList frameExtras=librevenge::RVNGPropertyList());
        bool openGroup(WPSPosition const &pos) final;
        void closeGroup() final;
 
        // ------- table -----------------
        void openTable(std::vector<float> const &colWidth, librevenge::RVNGUnit unit);
        void closeTable();
        void openTableRow(float h, librevenge::RVNGUnit unit, bool headerRow=false);
        void closeTableRow();
        void openTableCell(WPSCell const &cell, librevenge::RVNGPropertyList const &extras=librevenge::RVNGPropertyList());
        void closeTableCell();
        void addEmptyTableCell(Vec2i const &pos, Vec2i span=Vec2i(1,1));
 
        // ------- section ---------------
        bool isSectionOpened() const;
        int getSectionNumColumns() const;
        bool openSection(std::vector<int> colsWidth=std::vector<int>(), librevenge::RVNGUnit unit=librevenge::RVNG_INCH);
        bool closeSection();
 
protected:
        void _openSection();
        void _closeSection();
 
        void _openPageSpan();
        void _closePageSpan();
        void _updatePageSpanDependent(bool set);
 
        void _startSubDocument();
        void _endSubDocument();
 
        void _handleFrameParameters(librevenge::RVNGPropertyList &propList, WPSPosition const &pos);
        bool _openFrame(WPSPosition const &pos, librevenge::RVNGPropertyList extras=librevenge::RVNGPropertyList());
        void _closeFrame();
 
        void _openParagraph();
        void _closeParagraph();
        void _appendParagraphProperties(librevenge::RVNGPropertyList &propList, const bool isListElement=false);
        void _resetParagraphState(const bool isListElement=false);
 
        void _openListElement();
        void _closeListElement();
        void _changeList();
 
        void _openSpan();
        void _closeSpan();
 
        void _flushText();
        void _flushDeferredTabs();
 
        void _insertBreakIfNecessary(librevenge::RVNGPropertyList &propList);

        std::shared_ptr<WPSContentParsingState> _pushParsingState();
        void _popParsingState();
 
protected:
        std::shared_ptr<WPSDocumentParsingState> m_ds; // main parse state
        std::shared_ptr<WPSContentParsingState> m_ps; // parse state
        std::vector<std::shared_ptr<WPSContentParsingState> > m_psStack;
        librevenge::RVNGTextInterface *m_documentInterface;
 
private:
        WPSContentListener(const WPSContentListener &);
        WPSContentListener &operator=(const WPSContentListener &);
};
 
#endif
/* vim:set shiftwidth=4 softtabstop=4 noexpandtab: */