MWAWContentListener.hxx

Go to the documentation of this file.

/* -*- Mode: C++; c-default-style: "k&r"; indent-tabs-mode: nil; tab-width: 2; c-basic-offset: 2 -*- */

/* libmwaw
* Version: MPL 2.0 / LGPLv2+
*
* The contents of this file are subject to the Mozilla Public License Version
* 2.0 (the "License"); you may not use this file except in compliance with
* the License or as specified alternatively below. You may obtain a copy of
* the License at http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* Major Contributor(s):
* Copyright (C) 2002 William Lachance (wrlach@gmail.com)
* Copyright (C) 2002,2004 Marc Maurer (uwog@uwog.net)
* Copyright (C) 2004-2006 Fridrich Strba (fridrich.strba@bluewin.ch)
* Copyright (C) 2006, 2007 Andrew Ziem
* Copyright (C) 2011, 2012 Alonso Laurent (alonso@loria.fr)
*
*
* All Rights Reserved.
*
* 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 or later (the "LGPLv2+"),
* in which case the provisions of the LGPLv2+ are applicable
* instead of those above.
*/

#ifndef MWAW_CONTENT_LISTENER_H
#define MWAW_CONTENT_LISTENER_H

#include <vector>

#include <libwpd/libwpd.h>

#include "libmwaw_internal.hxx"

class WPXBinaryData;
class WPXDocumentInterface;
class WPXString;
class WPXPropertyListVector;

class MWAWCell;
class MWAWFont;
class MWAWInputStream;
class MWAWList;
class MWAWPageSpan;
class MWAWParagraph;
class MWAWParserState;
class MWAWPosition;
class MWAWSection;
class MWAWSubDocument;

typedef shared_ptr<MWAWInputStream> MWAWInputStreamPtr;
typedef shared_ptr<MWAWSubDocument> MWAWSubDocumentPtr;

namespace MWAWContentListenerInternal
{
struct DocumentState;
struct State;
}

class MWAWContentListener
{
public:
  enum BreakType { PageBreak=0, SoftPageBreak, ColumnBreak };

  MWAWContentListener(MWAWParserState &parserState, std::vector<MWAWPageSpan> const &pageList, WPXDocumentInterface *documentInterface);
  virtual ~MWAWContentListener();

  void setDocumentLanguage(std::string locale);

  void startDocument();
  void endDocument(bool sendDelayedSubDoc=true);

  void handleSubDocument(MWAWSubDocumentPtr subDocument, libmwaw::SubDocumentType subDocumentType);
  bool isSubDocumentOpened(libmwaw::SubDocumentType &subdocType) const;

  // ------ page --------
  bool isPageSpanOpened() const;
  MWAWPageSpan const &getPageSpan();

  // ------ header/footer --------
  bool insertHeader(MWAWSubDocumentPtr subDocument, WPXPropertyList const &extras);
  bool insertFooter(MWAWSubDocumentPtr subDocument, WPXPropertyList const &extras);
  bool isHeaderFooterOpened() const;

  // ------ text data -----------

  void insertChar(uint8_t character);
  void insertCharacter(unsigned char c);
  int insertCharacter(unsigned char c, MWAWInputStreamPtr &input, long endPos=-1);
  void insertUnicode(uint32_t character);
  void insertUnicodeString(WPXString const &str);

  void insertTab();
  void insertEOL(bool softBreak=false);
  void insertBreak(BreakType breakType);

  // ------ text format -----------
  void setFont(MWAWFont const &font);
  MWAWFont const &getFont() const;

  // ------ paragraph format -----------
  bool isParagraphOpened() const;
  void setParagraph(MWAWParagraph const &paragraph);
  MWAWParagraph const &getParagraph() const;

  // ------- fields ----------------
  void insertField(MWAWField const&field);

  // ------- subdocument -----------------
  void insertNote(MWAWNote const &note, MWAWSubDocumentPtr &subDocument);

  void insertComment(MWAWSubDocumentPtr &subDocument);

  void insertPicture(MWAWPosition const &pos, const WPXBinaryData &binaryData,
                     std::string type="image/pict",
                     WPXPropertyList frameExtras=WPXPropertyList());
  void insertTextBox(MWAWPosition const &pos, MWAWSubDocumentPtr subDocument,
                     WPXPropertyList frameExtras=WPXPropertyList(),
                     WPXPropertyList textboxExtras=WPXPropertyList());

  // ------- table -----------------
  void openTable(std::vector<float> const &colWidth, WPXUnit unit,
                 WPXPropertyList tableExtras=WPXPropertyList());
  void closeTable();
  void openTableRow(float h, WPXUnit unit, bool headerRow=false);
  void closeTableRow();
  void openTableCell(MWAWCell const &cell, WPXPropertyList const &extras);
  void closeTableCell();
  void addEmptyTableCell(Vec2i const &pos, Vec2i span=Vec2i(1,1));

  // ------- section ---------------
  bool isSectionOpened() const;
  MWAWSection const &getSection() const;
  bool openSection(MWAWSection const &section);
  bool closeSection();

protected:
  void _openSection();
  void _closeSection();

  void _openPageSpan(bool sendHeaderFooters=true);
  void _closePageSpan();

  void _startSubDocument();
  void _endSubDocument();

  void _handleFrameParameters( WPXPropertyList &propList, MWAWPosition const &pos);
  bool openFrame(MWAWPosition const &pos, WPXPropertyList extras=WPXPropertyList());
  void closeFrame();


  void _openParagraph();
  void _closeParagraph();
  void _appendParagraphProperties(WPXPropertyList &propList, const bool isListElement=false);
  void _resetParagraphState(const bool isListElement=false);

  void _openListElement();
  void _closeListElement();
  void _changeList();
  int _getListId() const;

  void _openSpan();
  void _closeSpan();

  void _flushText();
  void _flushDeferredTabs();

  void _insertBreakIfNecessary(WPXPropertyList &propList);

  shared_ptr<MWAWContentListenerInternal::State> _pushParsingState();
  void _popParsingState();

protected:
  shared_ptr<MWAWContentListenerInternal::DocumentState> m_ds;
  shared_ptr<MWAWContentListenerInternal::State> m_ps;
  std::vector<shared_ptr<MWAWContentListenerInternal::State> > m_psStack;
  MWAWParserState &m_parserState;
  WPXDocumentInterface *m_documentInterface;

private:
  MWAWContentListener(const MWAWContentListener &);
  MWAWContentListener &operator=(const MWAWContentListener &);
};

typedef shared_ptr<MWAWContentListener> MWAWContentListenerPtr;

#endif
// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab: