/*
DSFML - The Simple and Fast Multimedia Library for D

Copyright (c) 2013 - 2015 Jeremy DeHaan (dehaan.jeremiah@gmail.com)

This software is provided 'as-is', without any express or implied warranty.
In no event will the authors be held liable for any damages arising from the use of this software.

Permission is granted to anyone to use this software for any purpose, including commercial applications,
and to alter it and redistribute it freely, subject to the following restrictions:

1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software.
If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required.

2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.

3. This notice may not be removed or altered from any source distribution
*/

module dsfml.graphics.text;

import dsfml.graphics.font;
import dsfml.graphics.glyph;
import dsfml.graphics.color;
import dsfml.graphics.rect;
import dsfml.graphics.transformable;
import dsfml.graphics.drawable;
import dsfml.graphics.texture;
import dsfml.graphics.vertexarray;
import dsfml.graphics.vertex;
import dsfml.graphics.rendertarget;
import dsfml.graphics.renderstates;
import dsfml.graphics.primitivetype;

import dsfml.system.vector2;

/++
 + Graphical text that can be drawn to a render target.
 + 
 + Text is a drawable class that allows to easily display some text with custom style and color on a render target.
 + 
 + It inherits all the functions from Transformable: position, rotation, scale, origin. It also adds text-specific properties such as the font to use, the character size, the font style (bold, italic, underlined), the global color and the text to display of course. It also provides convenience functions to calculate the graphical size of the text, or to get the global position of a given character.
 + 
 + Text works in combination with the Font class, which loads and provides the glyphs (visual characters) of a given font.
 + 
 + The separation of Font and Text allows more flexibility and better performances: indeed a Font is a heavy resource, and any operation on it is slow (often too slow for real-time applications). On the other side, a Text is a lightweight object which can combine the glyphs data and metrics of a Font to display any text on a render target.
 + 
 + It is important to note that the Text instance doesn't copy the font that it uses, it only keeps a reference to it. Thus, a Font must not be destructed while it is used by a Text (i.e. never write a function that uses a local Font instance for creating a text).
 + 
 + Authors: Laurent Gomila, Jeremy DeHaan
 + See_Also: http://sfml-dev.org/documentation/2.0/classsf_1_1Text.php#details
 +/
class Text : Drawable, Transformable
{
	/// Enumeration of the string drawing styles.
	enum Style
	{
		Regular = 0, /// Regular characters, no style
		Bold = 1 << 0, /// Bold characters
		Italic = 1 << 1, /// Italic characters
		Underlined = 1 << 2 /// Underlined characters
	}

	mixin NormalTransformable;

	private
	{
		dstring m_string;
		Rebindable!(const(Font)) m_font;
		uint m_characterSize;
		Style m_style;
		Color m_color;
		VertexArray m_vertices;
		FloatRect m_bounds;

		//used for caching the font texture
		uint lastSizeUsed = 0;
		Rebindable!(const(Texture)) lastTextureUsed;
	}

	this()
	{
		m_string = "";
		m_characterSize = 30;
		m_style = Style.Regular;
		m_color = Color(255,255,255);
		m_vertices = new VertexArray(PrimitiveType.Quads,0);
		m_bounds = FloatRect();
	}
	
	this(T)(immutable(T)[] text, const(Font) font, uint characterSize = 30)
		if (is(T == dchar)||is(T == wchar)||is(T == char))
	{
		import dsfml.system..string;

		m_string = stringConvert!(T, dchar)(text);
		m_characterSize = characterSize;
		m_style = Style.Regular;
		m_color = Color(255,255,255);
		m_vertices = new VertexArray(PrimitiveType.Quads,0);
		m_bounds = FloatRect();
		m_font = font;
		updateGeometry();
	}

	~this()
	{
		import dsfml.system.config;
		mixin(destructorOutput);
	}

	/**
	 * Get the character size.
	 * 
	 * Returns: Size of the characters, in pixels.
	 */
	uint getCharacterSize() const
	{
		return m_characterSize;
	}

	/**
	 * Get the global color of the text.
	 * 
	 * Returns: Global color of the text.
	 */
	Color getColor() const
	{
		return m_color;
	}

	/**
	 * Get thet text's font.
	 * 
	 * If the text has no font attached, a NULL pointer is returned. The returned reference is const, which means that you cannot modify the font when you get it from this function.
	 * 
	 * Returns: Text's font.
	 */
	const(Font) getFont() const
	{
		if(m_font is null)
		{
			return null;
		}
		else
		{
			return m_font;
		}
	}

	/**
	 * Get the global bounding rectangle of the entity.
	 * 
	 * The returned rectangle is in global coordinates, which means that it takes in account the transformations (translation, rotation, scale, ...) that are applied to the entity. In other words, this function returns the bounds of the sprite in the global 2D world's coordinate system.
	 * 
	 * Returns: Global bounding rectangle of the entity.
	 */
	FloatRect getGlobalBounds()
	{
		return getTransform().transformRect(getLocalBounds());
	}

	/**
	 * Get the local bounding rectangle of the entity.
	 * 
	 * The returned rectangle is in local coordinates, which means that it ignores the transformations (translation, rotation, scale, ...) that are applied to the entity. In other words, this function returns the bounds of the entity in the entity's coordinate system.
	 * 
	 * Returns: Local bounding rectangle of the entity.
	 */
	FloatRect getLocalBounds() const
	{
		return m_bounds;
	}

	//TODO: maybe a getString!dstring or getString!wstring etc template would be appropriate?
	/**
	 * Get the text's string.
	 * 
	 * The returned string is a dstring, a unicode type.
	 */
	immutable(T)[] getString(T=char)() const
		if (is(T == dchar)||is(T == wchar)||is(T == char))
	{
		import dsfml.system..string;
		return stringConvert!(dchar, T)(m_string);
	}

	/**
	 * Get the text's style.
	 * 
	 * Returns: Text's style.
	 */
	Style getStyle() const
	{
		return m_style;
	}

	/**
	 * Set the character size.
	 * 
	 * The default size is 30.
	 * 
	 * Params:
	 * 		size	= New character size, in pixels.
	 */
	void setCharacterSize(uint size)
	{
		m_characterSize = size;
		updateGeometry();
	}

	/**
	 * Set the global color of the text.
	 * 
	 * By default, the text's color is opaque white.
	 * 
	 * Params:
	 * 		color	= New color of the text.
	 */
	void setColor(Color color)
	{
		m_color = color;
		updateGeometry();
	}

	/**
	 * Set the text's font.
	 * 
	 * The font argument refers to a font that must exist as long as the text uses it. Indeed, the text doesn't store its own copy of the font, but rather keeps a pointer to the one that you passed to this function. If the font is destroyed and the text tries to use it, the behaviour is undefined.
	 * 
	 * Params:
	 * 		font	= New font
	 */
	void setFont(const(Font) font)
	{
		m_font = font;
		updateGeometry();
	}

	/**
	 * Set the text's string.
	 * 
	 * A text's string is empty by default.
	 * 
	 * Params:
	 * 		text	= New string
	 */
	void setString(T)(immutable(T)[] text)
		if (is(T == dchar)||is(T == wchar)||is(T == char))
	{
		import dsfml.system..string;
		m_string = stringConvert!(T,dchar)(text);
		updateGeometry();
	}

	//TODO: Does doing binary operations on Styles like the docs suggest actually work?
	/**
	 * Set the text's style.
	 * 
	 * You can pass a combination of one or more styles, for example Style.Bold | Text.Italic.
	 */
	void setStyle(Style style)
	{
		m_style = style;
		updateGeometry();
	}

	/**
	 * Draw the object to a render target.
	 * 
	 * Params:
	 *  		renderTarget =	Render target to draw to
	 *  		renderStates =	Current render states
	 */
	void draw(RenderTarget renderTarget, RenderStates renderStates)
	{
	    import std.stdio;
	    
		if ((m_font !is null) && (m_characterSize>0))
		{
			renderStates.transform *= getTransform();
			
			//only call getTexture if the size has changed
			if(m_characterSize != lastSizeUsed)
			{
				//update the size
				lastSizeUsed = m_characterSize;
				//grab the new texture
				lastTextureUsed = m_font.getTexture(m_characterSize);
			}
			
			//writeln("Update Geometry");
			updateGeometry();
			
			//writeln("Setting renderstates tecture");
			renderStates.texture =  m_font.getTexture(m_characterSize);
			
			if(renderStates.texture is null)
			{
			    //writeln("Texture don't exist!");
			}
			
			//writeln("Trying to draw!");
			renderTarget.draw(m_vertices, renderStates);
		}
	}

	/**
	 * Return the position of the index-th character.
	 * 
	 * This function computes the visual position of a character from its index in the string. The returned position is in global coordinates (translation, rotation, scale and origin are applied). If index is out of range, the position of the end of the string is returned.
	 * 
	 * Params:
	 * 		index	= Index of the character
	 * 
	 * Returns: Position of the character.
	 */
	Vector2f findCharacterPos(size_t index)
	{
		// Make sure that we have a valid font
		if(m_font is null)
		{
			return Vector2f(0,0);
		}
		
		// Adjust the index if it's out of range
		if(index > m_string.length)
		{
			index = m_string.length;
		}

		bool bold  = (m_style & Style.Bold) != 0;

		float hspace = cast(float)(m_font.getGlyph(' ', m_characterSize, bold).advance);
		float vspace = cast(float)(m_font.getLineSpacing(m_characterSize));
		
		Vector2f position;
		dchar prevChar = 0;
		for (size_t i = 0; i < index; ++i)
		{
			dchar curChar = m_string[i];
			
			// Apply the kerning offset
			position.x += cast(float)(m_font.getKerning(prevChar, curChar, m_characterSize));
			prevChar = curChar;
			
			// Handle special characters
			switch (curChar)
			{
				case ' ' : position.x += hspace; continue;
				case '\t' : position.x += hspace * 4; continue;
				case '\n' : position.y += vspace; position.x = 0; continue;
				case '\v' : position.y += vspace * 4; continue;
				default:
					break;
			}
			
			// For regular characters, add the advance offset of the glyph
			position.x += cast(float)(m_font.getGlyph(curChar, m_characterSize, bold).advance);
		}
		
		// Transform the position to global coordinates
		position = getTransform().transformPoint(position);
		
		return position;
	}

private:
	void updateGeometry()
	{
		import std.algorithm;

		// Clear the previous geometry
		m_vertices.clear();
		m_bounds = FloatRect();
		
		// No font: nothing to draw
		if (m_font is null)
			return;

		// No text: nothing to draw
		if (m_string.length == 0)
			return;
		// Compute values related to the text style
		bool bold = (m_style & Style.Bold) != 0;
		bool underlined = (m_style & Style.Underlined) != 0;
		float italic = (m_style & Style.Italic) ? 0.208f : 0f; // 12 degrees
		float underlineOffset = m_characterSize * 0.1f;
		float underlineThickness = m_characterSize * (bold ? 0.1f : 0.07f);
		
		// Precompute the variables needed by the algorithm
		float hspace = cast(float)(m_font.getGlyph(' ', m_characterSize, bold).advance);
		float vspace = cast(float)(m_font.getLineSpacing(m_characterSize));
		float x = 0f;
		float y = cast(float)(m_characterSize);
		
		// Create one quad for each character
		float minX = m_characterSize, minY = m_characterSize, maxX = 0, maxY = 0;
		dchar prevChar = 0;
		for (size_t i = 0; i < m_string.length; ++i)
		{
			dchar curChar = m_string[i];

			
			// Apply the kerning offset
			x += cast(float)(m_font.getKerning(prevChar, curChar, m_characterSize));

			prevChar = curChar;

			// If we're using the underlined style and there's a new line, draw a line
			if (underlined && (curChar == '\n'))
			{
				float top = y + underlineOffset;
				float bottom = top + underlineThickness;
				
				m_vertices.append(Vertex(Vector2f(0, top), m_color, Vector2f(1, 1)));
				m_vertices.append(Vertex(Vector2f(x, top), m_color, Vector2f(1, 1)));
				m_vertices.append(Vertex(Vector2f(x, bottom), m_color, Vector2f(1, 1)));
				m_vertices.append(Vertex(Vector2f(0, bottom), m_color, Vector2f(1, 1)));
			}
			
			// Handle special characters
			if ((curChar == ' ') || (curChar == '\t') || (curChar == '\n') || (curChar == '\v'))
			{
				// Update the current bounds (min coordinates)
				minX = min(minX, x);
				minY = min(minY, y);
				
				final switch (curChar)
				{
					case ' ' : x += hspace; break;
					case '\t' : x += hspace * 4; break;
					case '\n' : y += vspace; x = 0; break;
					case '\v' : y += vspace * 4; break;
				}
				
				// Update the current bounds (max coordinates)
				maxX = max(maxX, x);
				maxY = max(maxY, y);
				
				// Next glyph, no need to create a quad for whitespace
				continue;
			}



			// Extract the current glyph's description
			Glyph glyph = m_font.getGlyph(curChar, m_characterSize, bold);
			
			int left = glyph.bounds.left;
			int top = glyph.bounds.top;
			int right = glyph.bounds.left + glyph.bounds.width;
			int bottom = glyph.bounds.top + glyph.bounds.height;
			
			float u1 = cast(float)(glyph.textureRect.left);
			float v1 = cast(float)(glyph.textureRect.top);
			float u2 = cast(float)(glyph.textureRect.left + glyph.textureRect.width);
			float v2 = cast(float)(glyph.textureRect.top + glyph.textureRect.height);
			
			// Add a quad for the current character
			m_vertices.append(Vertex(Vector2f(x + left - italic * top, y + top), m_color, Vector2f(u1, v1)));
			m_vertices.append(Vertex(Vector2f(x + right - italic * top, y + top), m_color, Vector2f(u2, v1)));
			m_vertices.append(Vertex(Vector2f(x + right - italic * bottom, y + bottom), m_color, Vector2f(u2, v2)));
			m_vertices.append(Vertex(Vector2f(x + left - italic * bottom, y + bottom), m_color, Vector2f(u1, v2)));

			// Update the current bounds
			minX = min(minX, x + left - italic * bottom);
			maxX = max(maxX, x + right - italic * top);
			minY = min(minY, y + top);
			maxY = max(maxY, y + bottom);

			// Advance to the next character
			x += glyph.advance;
		}
		
		// If we're using the underlined style, add the last line
		if (underlined)
		{
			float top = y + underlineOffset;
			float bottom = top + underlineThickness;
			
			m_vertices.append(Vertex(Vector2f(0, top), m_color, Vector2f(1, 1)));
			m_vertices.append(Vertex(Vector2f(x, top), m_color, Vector2f(1, 1)));
			m_vertices.append(Vertex(Vector2f(x, bottom), m_color, Vector2f(1, 1)));
			m_vertices.append(Vertex(Vector2f(0, bottom), m_color, Vector2f(1, 1)));
		}
		
		// Update the bounding rectangle
		m_bounds.left = minX;
		m_bounds.top = minY;
		m_bounds.width = maxX - minX;
		m_bounds.height = maxY - minY;
	}
}

unittest
{
	version(DSFML_Unittest_Graphics)
	{
		import std.stdio;
		import dsfml.graphics.rendertexture;

		writeln("Unit test for Text");

		auto renderTexture = new RenderTexture();
		
		renderTexture.create(100,100);

		auto font = new Font();
		assert(font.loadFromFile("res/Warenhaus-Standard.ttf"));

		Text text;
		text = new Text("Sample String", font);

		string temp = text.getString();

		writeln(temp);

		renderTexture.clear();

		renderTexture.draw(text);

		renderTexture.display();

		//grab that texture for usage
		auto texture = renderTexture.getTexture();

		texture.copyToImage().saveToFile("Text.png");

		writeln();
	}
}