/*
Copyright (C) 2011 Elvis Stansvik <elvstone@gmail.com>

For general Scribus (>=1.3.2) copyright and licensing information please refer
to the COPYING file provided with the program. Following this notice may exist
a copyright and/or license notice that predates the release of Scribus 1.3.2
for which a new license (GPL+exception) is in place.
*/

#ifndef TABLECELL_H
#define TABLECELL_H

#include <QDebug>
#include <QExplicitlySharedDataPointer>
#include <QRectF>
#include <QSharedData>
#include <QString>

#include "scribusapi.h"

#include "commonstrings.h"
#include "pageitem_textframe.h"
#include "styles/cellstyle.h"

class PageItem_Table;
class ScPainter;

/**
 * Shared data class for TableCell.
 */
class TableCellData : public QSharedData
{
public:
	/// Constructs data for an invalid cell.
	TableCellData() :
		isValid(false),
		row(-1),
		column(-1),
		rowSpan(-1),
		columnSpan(-1),
		textFrame(0),
		table(0) {}
	/// Constructs data from data in @a other.
	TableCellData(const TableCellData& other) : QSharedData(other),
		isValid(other.isValid),
		row(other.row),
		column(other.column),
		rowSpan(other.rowSpan),
		columnSpan(other.columnSpan),
		textFrame(other.textFrame),
		style(other.style),
		table(other.table) {}
	/// Destroys the cell data.
	~TableCellData()
	{
		delete textFrame;
	}

public:
	/// Cell valid state.
	bool isValid;
	/// Row of the table the cell is in.
	int row;
	/// Column of the table the cell is in.
	int column;
	/// Number of rows the cell spans.
	int rowSpan;
	/// Number of columns the cell spans.
	int columnSpan;

	/// Text frame of the cell.
	PageItem_TextFrame *textFrame;
	/// Style of the cell.
	CellStyle style;
	/// Table containing the cell.
	PageItem_Table *table;
};

/**
 * The TableCell class represents a cell in a table.
 * <p>
 * It provides an interface for setting and getting cell properties. A cell may be
 * marked as invalid if the row or column containing the cell is removed. The valid
 * state of a cell may be queried using the <code>isValid()</code> function.
 * <p>
 * Text content may be set on the cell using <code>setText()</code>. If you want
 * higher fidelity control over the cell content, retrieve its associated text frame
 * with <code>textFrame()</code> and work with that.
 * <p>
 * A cell has a bounding rectangle. This is the rectangle on the table grid containing
 * the cell. It may be queried using the <code>boundingRect()</code> function.
 * <p>
 * A cell also has a content rectangle. This is the bounding rect of the cell adjusted
 * for any cell paddings and borders. It may be queried using the <code>contentRect()</code>
 * function.
 */
class SCRIBUS_API TableCell
{
public:
	/**
	 * Constructs a new invalid table cell.
	 *
	 * The cell will report a row, column, row span and column span of <code>-1</code>. This
	 * behavior is relied upon in places such as the painting code, so don't change it.
	 */
	TableCell() : d(new TableCellData) { setValid(false); }

	/// Construct a new table cell as a shallow copy of @a other.
	TableCell(const TableCell& other) : d(other.d) {}

	/// Returns <code>true</code> if this cell is equal to @a other.
	bool operator==(const TableCell& other) const { return other.d == d; }

	/// Returns <code>true</code> if this cell is not equal to @a other.
	bool operator!=(const TableCell& other) const { return !(other == *this); }

	/// Returns <code>true</code> if this cell is valid.
	bool isValid() const { return d->isValid && d->table; }

	/// Returns the row in the table that contains this cell.
	int row() const { return d->row; }

	/// Returns the column in the table that contains this cell.
	int column() const { return d->column; }

	/// Returns the number of rows this cell spans.
	int rowSpan() const { return d->rowSpan; }

	/// Returns the number of columns this cell spans.
	int columnSpan() const { return d->columnSpan; }

	/// Returns the bounding rectangle of this cell.
	QRectF boundingRect() const;

	/// Returns the content rectangle of this cell.
	QRectF contentRect() const;

	/// Sets the fill color of this cell to @a color.
	void setFillColor(const QString& color) { d->style.setFillColor(color); }

	/// Returns the fill color of this cell.
	QString fillColor() const { return d->style.fillColor(); }

	/// Sets the fill color of this cell to @a color.
	void setFillShade(const double& shade) { d->style.setFillShade(shade); }

	/// Returns the fill color of this cell.
	double fillShade() const { return d->style.fillShade(); }

	/// Sets the left border of this cell to @a border.
	void setLeftBorder(const TableBorder& border);

	/// Returns the left border of this cell.
	TableBorder leftBorder() const { return d->style.leftBorder(); }

	/// Sets the right border of this cell to @a border.
	void setRightBorder(const TableBorder& border);

	/// Returns the right border of this cell.
	TableBorder rightBorder() const { return d->style.rightBorder(); }

	/// Sets the top border of this cell to @a border.
	void setTopBorder(const TableBorder& border);

	/// Returns the top border of this cell.
	TableBorder topBorder() const { return d->style.topBorder(); }

	/// Sets the bottom border of this cell to @a border.
	void setBottomBorder(const TableBorder& border);

	/// Returns the bottom border of this cell.
	TableBorder bottomBorder() const { return d->style.bottomBorder(); }

	/// Sets the left padding of this cell to @a padding.
	void setLeftPadding(double padding);

	/// Returns the left padding of this cell.
	double leftPadding() const { return d->style.leftPadding(); }

	/// Sets the right padding of this cell to @a padding.
	void setRightPadding(double padding);

	/// Returns the right padding of this cell.
	double rightPadding() const { return d->style.rightPadding(); }

	/// Sets the top padding of this cell to @a padding.
	void setTopPadding(double padding);

	/// Returns the top padding of this cell.
	double topPadding() const { return d->style.topPadding(); }

	/// Sets the bottom padding of this cell to @a padding.
	void setBottomPadding(double padding);

	/// Returns the bottom padding of this cell.
	double bottomPadding() const { return d->style.bottomPadding(); }

	/// Sets the cell style for this cell to @a style.
	void setStyle(const QString& style);

	void unsetDirectFormatting();

	/// Returns the named cell style for this cell.
	const CellStyle& style() const { return d->style; }

	/// Returns the cell style name for this cell.
	QString styleName() const { return d->style.parent(); }

	/// Sets the text for this cell to @a text.
	void setText(const QString& text);

	/// Returns the text frame for this cell.
	PageItem_TextFrame* textFrame() const { return d->textFrame; }

	/// Returns the cell as a string. Useful for debugging. The format is subject to change.
	QString asString() const;

private:
	/**
	 * Construct a new valid table cell at @a row, @a column in the table @a table.
	 * The new cell will span <code>1</code> row and <code>1</code> column.
	 */
	TableCell(int row, int column, PageItem_Table *table);

	/// Set the row of the table that contains this cell to @a row.
	void setRow(int row) { d->row = row; }
	/// Set the column of the table that contains this cell to @a row.
	void setColumn(int column) { d->column = column; }
	/// Set the number of rows this cell is spanning to @a rowSpan.
	void setRowSpan(int rowSpan) { d->rowSpan = rowSpan; }
	/// Set the number of columns this cell is spanning to @a columnSpan.
	void setColumnSpan(int columnSpan) { d->columnSpan = columnSpan; }
	/// Sets the valid state of the cell to @a isValid.
	void setValid(bool isValid) { d->isValid = isValid; }
	/// Updates the size and position of the cell text frame.
	void updateContent();

	/// "Move" the cell down by @a numRows. E.g. increase its row by @a numRows.
	void moveDown(int numRows) { d->row += numRows; }
	/// "Move" the cell up by @a numRows. E.g. decrease its row by @a numRows.
	void moveUp(int numRows) { d->row -= numRows; }
	/// "Move" the cell right by @a numColumns. E.g. increase its column by @a numColumns.
	void moveRight(int numColumns) { d->column += numColumns; }
	/// "Move" the cell left by @a numColumns. E.g. decrease its column by @a numColumns.
	void moveLeft(int numColumns) { d->column -= numColumns; }

	/// Returns the maximum border width found along left side of cell.
	double maxLeftBorderWidth() const;
	/// Returns the maximum border width found along right side of cell.
	double maxRightBorderWidth() const;
	/// Returns the maximum border width found along top side of cell.
	double maxTopBorderWidth() const;
	/// Returns the maximum border width found along bottom side of cell.
	double maxBottomBorderWidth() const;

private:
	friend class PageItem_Table;
	QExplicitlySharedDataPointer<TableCellData> d;
};
Q_DECLARE_TYPEINFO(TableCell, Q_MOVABLE_TYPE);

inline uint qHash(const TableCell& cell)
{
	return (cell.row() << 16) ^ cell.column();
}

QDebug operator<<(QDebug debug, const TableCell& cell);

#endif // TABLECELL_H
