MWProParser.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 MW_PRO_PARSER
#  define MW_PRO_PARSER

#include <list>
#include <string>
#include <vector>

#include "MWAWDebug.hxx"
#include "MWAWEntry.hxx"
#include "MWAWInputStream.hxx"

#include "MWAWParser.hxx"

class WPXBinaryData;

class MWAWPosition;

namespace MWProParserInternal
{
struct State;
struct TextZoneData;
struct TextZone;
struct Token;
struct Zone;
class SubDocument;
}

class MWProStructures;
class MWProStructuresListenerState;

class MWProParser : public MWAWParser
{
  friend class MWProStructures;
  friend class MWProStructuresListenerState;
  friend class MWProParserInternal::SubDocument;

public:
  MWProParser(MWAWInputStreamPtr input, MWAWRSRCParserPtr rsrcParser, MWAWHeader *header);
  virtual ~MWProParser();

  bool checkHeader(MWAWHeader *header, bool strict=false);

  // the main parse function
  void parse(WPXDocumentInterface *documentInterface);

protected:
  void init();

  void createDocument(WPXDocumentInterface *documentInterface);

  bool createZones();

  bool getZoneData(WPXBinaryData &data, int blockId);

  bool getFreeZoneList(int blockId, std::vector<int> &blockLists);

  bool parseDataZone(int blockId, int type);

  bool parseTextZone(shared_ptr<MWProParserInternal::Zone> zone);

  bool readTextEntries(shared_ptr<MWProParserInternal::Zone> zone,
                       std::vector<MWAWEntry> &res, int textLength);
  bool readTextIds(shared_ptr<MWProParserInternal::Zone> zone,
                   std::vector<MWProParserInternal::TextZoneData> &res,
                   int textLength, int type);
  bool readTextTokens(shared_ptr<MWProParserInternal::Zone> zone,
                      std::vector<MWProParserInternal::Token> &res,
                      int textLength);

  std::vector<int> const &getBlocksCalledByToken() const;

  float pageHeight() const;
  int numColumns() const;

  void newPage(int number, bool softBreak=false);

  //
  // interface with MWProParserStructures
  //

  bool sendTextZone(int blockId, bool mainZone = false);

  int findNumHardBreaks(int blockId);

  bool sendPictureZone(int blockId, MWAWPosition const &pictPos,
                       WPXPropertyList extras = WPXPropertyList());

  bool sendTextBoxZone(int blockId, MWAWPosition const &pos,
                       WPXPropertyList extras = WPXPropertyList());

  bool sendEmptyFrameZone(MWAWPosition const &pos, WPXPropertyList extras);

  //
  // low level
  //

  bool readPrintInfo();

  bool readDocHeader();

#ifdef DEBUG

  void saveOriginal(MWAWInputStreamPtr input);
#endif

  bool sendPicture(shared_ptr<MWProParserInternal::Zone> zone, MWAWPosition pictPos, WPXPropertyList const &extras);

  bool sendText(shared_ptr<MWProParserInternal::TextZone> zone, bool mainZone = false);

  int findNumHardBreaks(shared_ptr<MWProParserInternal::TextZone> zone);

  void checkUnparsed();

protected:
  //
  // data
  //
  shared_ptr<MWProParserInternal::State> m_state;

  shared_ptr<MWProStructures> m_structures;
};
#endif
// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab: