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

 */

/* Define some classes used to store a Cell

 */

#ifndef WPS_CELL_H

#  define WPS_CELL_H

#include <iostream>

#include <vector>

#include "libwps_internal.h"

#include "WPSFont.h"

/** a structure used to defined the cell format */

class WPSCellFormat

{

public:

  /** the default horizontal alignement.

  \note actually mainly used for table/spreadsheet cell, FULL is not yet implemented */

  enum HorizontalAlignment { HALIGN_LEFT, HALIGN_RIGHT, HALIGN_CENTER,

                             HALIGN_FULL, HALIGN_DEFAULT

                           };

  /** the default vertical alignement. */

  enum VerticalAlignment { VALIGN_TOP, VALIGN_CENTER, VALIGN_BOTTOM, VALIGN_DEFAULT };

  /** the wrapping */

  enum Wrapping { WRAP_WRAP, WRAP_NO_WRAP, WRAP_DEFAULT };

  /** the different types of cell's field */

  enum FormatType { F_TEXT, F_BOOLEAN, F_NUMBER, F_DATE, F_TIME, F_UNKNOWN };

  /*   subformat:

            NUMBER             DATE                 TIME               TEXT

    0 :    default           default[3/2/2000]  default[10:03:00]    default

    1 :    decimal

    2 :    exponential

    3 :    percent

    4 :    money

    5 :    thousand

    6 :    fixed

    7 :    fraction

   */

  //! constructor

  WPSCellFormat()

    : m_font()

    , m_hAlign(HALIGN_DEFAULT)

    , m_vAlign(VALIGN_DEFAULT)

    , m_wrapping(WRAP_DEFAULT)

    , m_rotation(0)

    , m_bordersList()

    , m_format(F_UNKNOWN)

    , m_subFormat(0)

    , m_DTFormat("")

    , m_digits(-1000)

    , m_protected(false)

    , m_backgroundColor(WPSColor::white()) { }

  WPSCellFormat(WPSCellFormat const &)=default;

  WPSCellFormat &operator=(WPSCellFormat const &)=default;

  //! destructor

  virtual ~WPSCellFormat();

  //! returns true if this is a basic format style

  bool hasBasicFormat() const

  {

    return m_format==F_TEXT || m_format==F_UNKNOWN;

  }

  //! returns a value type

  std::string getValueType() const;

  //! add to the propList

  void addTo(librevenge::RVNGPropertyList &propList) const;

  //! get the number style

  bool getNumberingProperties(librevenge::RVNGPropertyList &propList) const;

  //! returns the font

  WPSFont const &getFont() const

  {

    return m_font;

  }

  //! sets the font

  void setFont(WPSFont const &font)

  {

    m_font=font;

  }

  //! returns the horizontal alignement

  HorizontalAlignment hAlignment() const

  {

    return m_hAlign;

  }

  //! sets the horizontal alignement

  void setHAlignment(HorizontalAlignment align)

  {

    m_hAlign = align;

  }

  //! returns the vertical alignement

  VerticalAlignment vAlignment() const

  {

    return m_vAlign;

  }

  //! sets the vertical alignement

  void setVAlignment(VerticalAlignment align)

  {

    m_vAlign = align;

  }

  //! returns the wrapping

  Wrapping wrapping() const

  {

    return m_wrapping;

  }

  //! sets the wrapping

  void setWrapping(Wrapping align)

  {

    m_wrapping = align;

  }

  //! returns the text rotation angle

  int getTextRotation() const

  {

    return m_rotation;

  }

  //! sets the text rotation angle

  void setTextRotation(int rotation)

  {

    m_rotation = rotation;

  }

  //! returns the format type

  FormatType getFormat() const

  {

    return m_format;

  }

  //! returns the subformat type

  int getSubFormat() const

  {

    return m_subFormat;

  }

  //! returns the date/time format ( if set)

  std::string getDTFormat() const

  {

    return m_DTFormat;

  }

  //! sets the format type

  void setFormat(FormatType form, int subForm=0)

  {

    m_format = form;

    m_subFormat = subForm;

  }

  //! sets the format type

  void setDTFormat(FormatType form, std::string const &dtFormat="")

  {

    m_format = form;

    m_subFormat = 0;

    m_DTFormat = dtFormat;

  }

  //! returns the number of digits ( for a number)

  int digits() const

  {

    return m_digits;

  }

  //! set the number of digits ( for a number)

  void setDigits(int newDigit)

  {

    m_digits = newDigit;

  }

  //! returns true if the cell is protected

  bool isProtected() const

  {

    return m_protected;

  }

  //! returns true if the cell is protected

  void setProtected(bool fl)

  {

    m_protected = fl;

  }

  //! return true if the cell has some border

  bool hasBorders() const

  {

    return m_bordersList.size() != 0;

  }

  //! return the cell border: libwps::LeftBit | ...

  std::vector<WPSBorder> const &borders() const

  {

    return m_bordersList;

  }

  //! reset the border

  void resetBorders()

  {

    m_bordersList.resize(0);

  }

  //! sets the cell border: wh=WPSBorder::LeftBit|...

  void setBorders(int wh, WPSBorder const &border);

  //! sets the cell borders

  void setBorders(std::vector<WPSBorder> const &newBorders)

  {

    m_bordersList=newBorders;

  }

  //! returns the background color

  WPSColor backgroundColor() const

  {

    return m_backgroundColor;

  }

  //! set the background color

  void setBackgroundColor(WPSColor const &color)

  {

    m_backgroundColor = color;

  }

  //! a comparison  function

  int compare(WPSCellFormat const &cell, bool onlyNumbering=false) const;

  //! operator<<

  friend std::ostream &operator<<(std::ostream &o, WPSCellFormat const &cell);

  //! a comparaison structure used to store data

  struct CompareFormat

  {

    //! constructor

    CompareFormat() {}

    //! comparaison function

    bool operator()(WPSCellFormat const &c1, WPSCellFormat const &c2) const

    {

      return c1.compare(c2, true) < 0;

    }

  };

protected:

  //! convert a DTFormat in a propertyList

  static bool convertDTFormat(std::string const &dtFormat, librevenge::RVNGPropertyListVector &propListVector);

  //! the cell font ( used in spreadsheet code )

  WPSFont m_font;

  //! the cell alignement : by default nothing

  HorizontalAlignment m_hAlign;

  //! the cell vertical alignement : by default nothing

  VerticalAlignment m_vAlign;

  //! the wrapping : by default nothing

  Wrapping m_wrapping;

  //! the text rotation

  int m_rotation;

  //! the cell border WPSBorder::Pos

  std::vector<WPSBorder> m_bordersList;

  //! the cell format : by default unknown

  FormatType m_format;

  //! the sub format

  int m_subFormat;

  //! a date/time format ( using a subset of strftime format )

  std::string m_DTFormat;

  //! the number of digits

  int m_digits;

  //! cell protected

  bool m_protected;

  //! the backgroung color

  WPSColor m_backgroundColor;

};

class WPSTable;

/** a structure used to defined the cell position, and a format */

class WPSCell : public WPSCellFormat

{

  friend class WPSTable;

public:

  //! constructor

  WPSCell()

    : WPSCellFormat()

    , m_box()

    , m_verticalSet(true)

    , m_position(0,0)

    , m_numberCellSpanned(1,1) {}

  WPSCell(WPSCell const &)=default;

  WPSCell &operator=(WPSCell const &)=default;

  //! destructor

  ~WPSCell() override;

  //! add to the propList

  void addTo(librevenge::RVNGPropertyList &propList) const;

  //! set the bounding box (units in point)

  void setBox(WPSBox2f const &b)

  {

    m_box = b;

  }

  //! return the bounding box

  WPSBox2f const &box() const

  {

    return m_box;

  }

  //! returns true if the vertical is fixed

  bool isVerticalSet() const

  {

    return m_verticalSet;

  }

  //! fixes or not the vertical size

  void setVerticalSet(bool verticalSet)

  {

    m_verticalSet = verticalSet;

  }

  //! position  accessor

  Vec2i &position()

  {

    return m_position;

  }

  //! position  accessor

  Vec2i const &position() const

  {

    return m_position;

  }

  //! set the cell positions :  0,0 -> A1, 0,1 -> A2

  void setPosition(Vec2i posi)

  {

    m_position = posi;

  }

  //! returns the number of spanned cells

  Vec2i const &numSpannedCells() const

  {

    return m_numberCellSpanned;

  }

  //! sets the number of spanned cells : Vec2i(1,1) means 1 cellule

  void setNumSpannedCells(Vec2i numSpanned)

  {

    m_numberCellSpanned=numSpanned;

  }

  //! call when a cell must be send

  virtual bool send(WPSListenerPtr &listener) = 0;

  //! call when the content of a cell must be send

  virtual bool sendContent(WPSListenerPtr &listener) = 0;

  //! operator<<

  friend std::ostream &operator<<(std::ostream &o, WPSCell const &cell);

protected:

  //! a comparaison structure used retrieve the rows and the columns

  struct Compare

  {

    explicit Compare(int dim)

      : m_coord(dim) {}

    //! small structure to define a cell point

    struct Point

    {

      Point(int wh, WPSCell const *cell)

        : m_which(wh)

        , m_cell(cell) {}

      float getPos(int coord) const

      {

        if (m_which)

          return m_cell->box().max()[coord];

        return m_cell->box().min()[coord];

      }

      float getSize(int coord) const

      {

        return m_cell->box().size()[coord];

      }

      int m_which;

      WPSCell const *m_cell;

    };

    //! comparaison function

    bool operator()(Point const &c1, Point const &c2) const

    {

      float diffF = c1.getPos(m_coord)-c2.getPos(m_coord);

      if (diffF < 0) return true;

      if (diffF > 0) return false;

      int diff = c2.m_which - c1.m_which;

      if (diff) return (diff < 0);

      diffF = c1.m_cell->box().size()[m_coord]

              - c2.m_cell->box().size()[m_coord];

      if (diffF < 0) return true;

      if (diffF > 0) return false;

      if (c1.m_cell->m_verticalSet != c2.m_cell->m_verticalSet) return c1.m_cell->m_verticalSet;

#ifdef _WIN64

      return ((__int64)c1.m_cell < (__int64)c2.m_cell);

#else

      return long(c1.m_cell) < long(c2.m_cell);

#endif

    }

    //! the coord to compare

    int m_coord;

  };

  /** the cell bounding box (unit in point)*/

  WPSBox2f m_box;

  /** true if y size is fixed */

  bool m_verticalSet;

  //! the cell row and column : 0,0 -> A1, 0,1 -> A2

  Vec2i m_position;

  //! the cell spanned : by default (1,1)

  Vec2i m_numberCellSpanned;

};

#endif

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