Andrea Faustinelli / espresso-for-geeks-master

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

espresso-for-geeks-master/C12832_lcd/TextDisplay.h@0:0decfa3e2ba3, 2019-07-31 (annotated)

Committer:
Faustinelli
Date:
Wed Jul 31 06:50:07 2019 +0000
Revision:
0:0decfa3e2ba3
complet

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Faustinelli 0:0decfa3e2ba3 1 /* mbed TextDisplay Library Base Class
Faustinelli 0:0decfa3e2ba3 2 * Copyright (c) 2007-2009 sford
Faustinelli 0:0decfa3e2ba3 3 * Released under the MIT License: http://mbed.org/license/mit
Faustinelli 0:0decfa3e2ba3 4 *
Faustinelli 0:0decfa3e2ba3 5 * A common base class for Text displays
Faustinelli 0:0decfa3e2ba3 6 * To port a new display, derive from this class and implement
Faustinelli 0:0decfa3e2ba3 7 * the constructor (setup the display), character (put a character
Faustinelli 0:0decfa3e2ba3 8 * at a location), rows and columns (number of rows/cols) functions.
Faustinelli 0:0decfa3e2ba3 9 * Everything else (locate, printf, putc, cls) will come for free
Faustinelli 0:0decfa3e2ba3 10 *
Faustinelli 0:0decfa3e2ba3 11 * The model is the display will wrap at the right and bottom, so you can
Faustinelli 0:0decfa3e2ba3 12 * keep writing and will always get valid characters. The location is
Faustinelli 0:0decfa3e2ba3 13 * maintained internally to the class to make this easy
Faustinelli 0:0decfa3e2ba3 14 */
Faustinelli 0:0decfa3e2ba3 15
Faustinelli 0:0decfa3e2ba3 16 #ifndef MBED_TEXTDISPLAY_H
Faustinelli 0:0decfa3e2ba3 17 #define MBED_TEXTDISPLAY_H
Faustinelli 0:0decfa3e2ba3 18
Faustinelli 0:0decfa3e2ba3 19 #include "mbed.h"
Faustinelli 0:0decfa3e2ba3 20
Faustinelli 0:0decfa3e2ba3 21 class TextDisplay : public Stream {
Faustinelli 0:0decfa3e2ba3 22 public:
Faustinelli 0:0decfa3e2ba3 23
Faustinelli 0:0decfa3e2ba3 24 // functions needing implementation in derived implementation class
Faustinelli 0:0decfa3e2ba3 25 /** Create a TextDisplay interface
Faustinelli 0:0decfa3e2ba3 26 *
Faustinelli 0:0decfa3e2ba3 27 * @param name The name used in the path to access the strean through the filesystem
Faustinelli 0:0decfa3e2ba3 28 */
Faustinelli 0:0decfa3e2ba3 29 TextDisplay(const char *name = NULL);
Faustinelli 0:0decfa3e2ba3 30
Faustinelli 0:0decfa3e2ba3 31 /** output a character at the given position
Faustinelli 0:0decfa3e2ba3 32 *
Faustinelli 0:0decfa3e2ba3 33 * @param column column where charater must be written
Faustinelli 0:0decfa3e2ba3 34 * @param row where character must be written
Faustinelli 0:0decfa3e2ba3 35 * @param c the character to be written to the TextDisplay
Faustinelli 0:0decfa3e2ba3 36 */
Faustinelli 0:0decfa3e2ba3 37 virtual void character(int column, int row, int c) = 0;
Faustinelli 0:0decfa3e2ba3 38
Faustinelli 0:0decfa3e2ba3 39 /** return number if rows on TextDisplay
Faustinelli 0:0decfa3e2ba3 40 * @result number of rows
Faustinelli 0:0decfa3e2ba3 41 */
Faustinelli 0:0decfa3e2ba3 42 virtual int rows() = 0;
Faustinelli 0:0decfa3e2ba3 43
Faustinelli 0:0decfa3e2ba3 44 /** return number if columns on TextDisplay
Faustinelli 0:0decfa3e2ba3 45 * @result number of rows
Faustinelli 0:0decfa3e2ba3 46 */
Faustinelli 0:0decfa3e2ba3 47 virtual int columns() = 0;
Faustinelli 0:0decfa3e2ba3 48
Faustinelli 0:0decfa3e2ba3 49 // functions that come for free, but can be overwritten
Faustinelli 0:0decfa3e2ba3 50
Faustinelli 0:0decfa3e2ba3 51 /** redirect output from a stream (stoud, sterr) to display
Faustinelli 0:0decfa3e2ba3 52 * @param stream stream that shall be redirected to the TextDisplay
Faustinelli 0:0decfa3e2ba3 53 */
Faustinelli 0:0decfa3e2ba3 54 virtual bool claim (FILE *stream);
Faustinelli 0:0decfa3e2ba3 55
Faustinelli 0:0decfa3e2ba3 56 /** clear screen
Faustinelli 0:0decfa3e2ba3 57 */
Faustinelli 0:0decfa3e2ba3 58 virtual void cls();
Faustinelli 0:0decfa3e2ba3 59 virtual void locate(int column, int row);
Faustinelli 0:0decfa3e2ba3 60 virtual void foreground(uint16_t colour);
Faustinelli 0:0decfa3e2ba3 61 virtual void background(uint16_t colour);
Faustinelli 0:0decfa3e2ba3 62 // putc (from Stream)
Faustinelli 0:0decfa3e2ba3 63 // printf (from Stream)
Faustinelli 0:0decfa3e2ba3 64
Faustinelli 0:0decfa3e2ba3 65 protected:
Faustinelli 0:0decfa3e2ba3 66
Faustinelli 0:0decfa3e2ba3 67 virtual int _putc(int value);
Faustinelli 0:0decfa3e2ba3 68 virtual int _getc();
Faustinelli 0:0decfa3e2ba3 69
Faustinelli 0:0decfa3e2ba3 70 // character location
Faustinelli 0:0decfa3e2ba3 71 uint16_t _column;
Faustinelli 0:0decfa3e2ba3 72 uint16_t _row;
Faustinelli 0:0decfa3e2ba3 73
Faustinelli 0:0decfa3e2ba3 74 // colours
Faustinelli 0:0decfa3e2ba3 75 uint16_t _foreground;
Faustinelli 0:0decfa3e2ba3 76 uint16_t _background;
Faustinelli 0:0decfa3e2ba3 77 char *_path;
Faustinelli 0:0decfa3e2ba3 78 };
Faustinelli 0:0decfa3e2ba3 79
Faustinelli 0:0decfa3e2ba3 80 #endif