/* mbed TextLCD Library, for a 4-bit LCD based on HD44780
 * Copyright (c) 2007-2010, sford, http://mbed.org
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

// ported for LPCXpresso
// by S.Fuchita (soramimi) http://www.soramimi.jp/


#ifndef LPC_TEXTLCD_H
#define LPC_TEXTLCD_H

#include "lbed.h"

/** A TextLCD interface for driving 4-bit HD44780-based LCDs
 *
 * Currently supports 16x2, 20x2 and 20x4 panels
 *
 * @code
 * #include "mbed.h"
 * #include "TextLCD.h"
 * 
 * TextLCD lcd(p10, p12, p15, p16, p29, p30); // rs, e, d4-d7
 * 
 * int main() {
 *     lcd.printf("Hello World!\n");
 * }
 * @endcode
 */
class TextLCD : public Print {
public:

	/** LCD panel format */
	enum LCDType {
	LCD16x2     /**< 16x2 LCD panel (default) */
	, LCD16x2B  /**< 16x2 LCD panel alternate addressing */
	, LCD20x2   /**< 20x2 LCD panel */
	, LCD20x4   /**< 20x4 LCD panel */
	};

	/** Create a TextLCD interface
	*
	* @param rs    Instruction/data control line
	* @param e     Enable line (clock)
	* @param d4-d7 Data lines for using as a 4-bit interface
	* @param type  Sets the panel size/addressing mode (default = LCD16x2)
	*/
	TextLCD(PinName rs, PinName e, PinName d4, PinName d5, PinName d6, PinName d7, LCDType type = LCD16x2);

#if 0 // DOXYGEN_ONLY
	/** Write a character to the LCD
	*
	* @param c The character to write to the display
	*/
	int putc(int c);

	/** Write a formated string to the LCD
	*
	* @param format A printf-style format string, followed by the
	*               variables to use in formating the string.
	*/
	int printf(const char* format, ...);
#endif

	/** Locate to a screen column and row
	*
	* @param column  The horizontal position from the left, indexed from 0
	* @param row     The vertical position from the top, indexed from 0
	*/
	void locate(int column, int row);

	/** Clear the screen and locate to 0,0 */
	void cls();

	int rows();
	int columns();

	void putc(int c)
	{
		_putc(c);
	}

protected:

	// Stream implementation functions
	virtual int _putc(int value);
	virtual int _getc();
	virtual int write(const char c) {
		_putc(c);
		return 1;
	}
	int address(int column, int row);
	void character(int column, int row, int c);
	void writeByte(int value);
	void writeCommand(int command);
	void writeData(int data);

	DigitalOut _rs, _e;
	BusOut _d;
	LCDType _type;

	int _column;
	int _row;
};

#endif

