/* -*- 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.
*/

/*
 * Parser to HanMac Word text document
 *
 */
#ifndef HAN_MAC_WRD_K_TEXT
#  define HAN_MAC_WRD_K_TEXT

#include <map>

#include "libmwaw_internal.hxx"
#include "MWAWDebug.hxx"

namespace HanMacWrdKTextInternal
{
struct Paragraph;
struct Token;
struct State;
}

struct HanMacWrdKZone;
class HanMacWrdKParser;

/** \brief the main class to read the text part of HanMac Word file
 *
 *
 *
 */
class HanMacWrdKText
{
  friend class HanMacWrdKParser;
public:
  //! constructor
  explicit HanMacWrdKText(HanMacWrdKParser &parser);
  //! destructor
  virtual ~HanMacWrdKText();

  /** returns the file version */
  int version() const;

  /** returns the number of pages */
  int numPages() const;

protected:
  //! send the main text zone
  bool sendMainText();
  //! send a text zone
  bool sendText(long id, long subId, MWAWListenerPtr listener=MWAWListenerPtr());
  //! check if we can send a textzone as graphic
  bool canSendTextAsGraphic(long id, long subId);
  //! sends the data which have not yet been sent to the listener
  void flushExtra();
  //! update the text zone type with map id->type
  void updateTextZoneTypes(std::map<long,int> const &idTypeMap);
  //! compute the number of pages present in a zone
  int computeNumPages(HanMacWrdKZone const &zone) const;
  //! returns the list of zoneId which corresponds to the token
  std::vector<long> const &getTokenIdList() const;
  //! return sthe header/footer id
  void getHeaderFooterId(long &headerId, long &footerId) const;

  //
  // intermediate level
  //

  /** try to read a text zone (type 1)*/
  bool readTextZone(std::shared_ptr<HanMacWrdKZone> zone);
  /** try to read the fonts name zone (type 5)*/
  bool readFontNames(std::shared_ptr<HanMacWrdKZone> zone);
  /** try to read the style zone (type 3) */
  bool readStyles(std::shared_ptr<HanMacWrdKZone> zone);
  /** try to read a section info zone (type 4)*/
  bool readSections(std::shared_ptr<HanMacWrdKZone> zone);

  /** try to send a text zone (type 1)*/
  bool sendText(HanMacWrdKZone &zone, MWAWListenerPtr listener=MWAWListenerPtr());
  /** check if we can send a textzone has graphic */
  bool canSendTextAsGraphic(HanMacWrdKZone &zone);

  //
  // low level
  //
  /** try to read a font in a text zone */
  bool readFont(HanMacWrdKZone const &zone, MWAWFont &font) const;

  /** try to read a paragraph in a text zone */
  bool readParagraph(HanMacWrdKZone const &zone, HanMacWrdKTextInternal::Paragraph &para) const;
  /** send the ruler properties */
  void setProperty(HanMacWrdKTextInternal::Paragraph const &para, float width);

  /** try to read an token in a text zone */
  bool readToken(HanMacWrdKZone const &zone, HanMacWrdKTextInternal::Token &token) const;

private:
  HanMacWrdKText(HanMacWrdKText const &orig) = delete;
  HanMacWrdKText &operator=(HanMacWrdKText const &orig) = delete;

protected:
  //
  // data
  //
  //! the parser state
  MWAWParserStatePtr m_parserState;

  //! the state
  std::shared_ptr<HanMacWrdKTextInternal::State> m_state;

  //! the main parser;
  HanMacWrdKParser *m_mainParser;
};
#endif
// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab: