/* -*- 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) 2009, 2011 Alonso Laurent (alonso@loria.fr)

 * Copyright (C) 2006, 2007 Andrew Ziem

 * Copyright (C) 2004-2006 Fridrich Strba (fridrich.strba@bluewin.ch)

 * Copyright (C) 2004 Marc Maurer (uwog@uwog.net)

 * Copyright (C) 2003-2005 William Lachance (william.lachance@sympatico.ca)

 *

 * 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 WPS4_GRAPH

#  define WPS4_GRAPH

#include <map>

#include <vector>

#include "libwps_internal.h"

#include "WPSDebug.h"

class WPS4Parser;

namespace WPS4GraphInternal

{

struct State;

}

////////////////////////////////////////////////////////////

//

// class to parse the object

//

////////////////////////////////////////////////////////////

/** \brief the main class to read/store picture in a Pc MS Works document v1-4

 *

 * This class must be associated with a WPS4Parser.

 * \note As the pictures seems always be given with character' position, many functions

 * which exists to maintain the same structures that exist(will) in WPS8TextGraph class

 * do almost nothing.

 */

class WPS4Graph

{

  friend class WPS4Parser;

public:

  //! constructor given the main parser of the MN0 zone

  explicit WPS4Graph(WPS4Parser &parser);

  //! destructor

  ~WPS4Graph();

  //! sets the listener

  void setListener(WPSContentListenerPtr &listen)

  {

    m_listener = listen;

  }

  /** computes the position of all found figures.

   *

   * In reality, as all the pictures seemed to be given with characters positions,

   * it does almost nothing, ie it only updates some internal bool to know the picture which

   * have been sent to the listener.

   */

  void computePositions() const;

  //! returns the number page where we find a picture. In practice, 0/1

  int numPages() const;

protected:

  //! returns the file version

  int version() const;

  //! store a list of object

  void storeObjects(std::map<int, WPSEmbeddedObject> const &objectsMap);

  /** tries to find a picture in the zone pointed by \a entry

   * \return the object id or -1 if find nothing

   * \note the content of this zone is mainly unknown,

   * so this function may failed to retrieved valid data

   */

  int readObject(RVNGInputStreamPtr input, WPSEntry const &entry);

  //! sends an object with identificator \a id as a character to a given pposition

  void sendObject(WPSPosition const &position, int id);

  /** send all the objects of a given page:

   * \param page if page < 0, sends all the pictures which have not been used,

   *

   * As all the pictures seemed to be given with characters positions, this

   * function only does something if page < 0.

   */

  void sendObjects(int page);

  //! returns the debug file

  libwps::DebugFile &ascii()

  {

    return m_asciiFile;

  }

private:

  WPS4Graph(WPS4Graph const &orig) = delete;

  WPS4Graph &operator=(WPS4Graph const &orig) = delete;

protected:

  //! the listener

  WPSContentListenerPtr m_listener;

  //! the main parser

  WPS4Parser &m_mainParser;

  //! the state

  mutable std::shared_ptr<WPS4GraphInternal::State> m_state;

  //! the ascii file

  libwps::DebugFile &m_asciiFile;

};

#endif

/* vim:set shiftwidth=4 softtabstop=4 noexpandtab: */