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.
Graphics/TextDisplay.h@0:e67bf8f398ee, 2015-08-23 (annotated)
- Committer:
- jloreto
- Date:
- Sun Aug 23 15:50:19 2015 +0000
- Revision:
- 0:e67bf8f398ee
This program is to test MCU Friend shield based on LGDP4535 in Nucleo-F411RE board.; Libraries modified from Unigraphic Library
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| jloreto | 0:e67bf8f398ee | 1 | /* mbed TextDisplay Library Base Class |
| jloreto | 0:e67bf8f398ee | 2 | * Copyright (c) 2007-2009 sford |
| jloreto | 0:e67bf8f398ee | 3 | * Released under the MIT License: http://mbed.org/license/mit |
| jloreto | 0:e67bf8f398ee | 4 | * |
| jloreto | 0:e67bf8f398ee | 5 | * A common base class for Text displays |
| jloreto | 0:e67bf8f398ee | 6 | * To port a new display, derive from this class and implement |
| jloreto | 0:e67bf8f398ee | 7 | * the constructor (setup the display), character (put a character |
| jloreto | 0:e67bf8f398ee | 8 | * at a location), rows and columns (number of rows/cols) functions. |
| jloreto | 0:e67bf8f398ee | 9 | * Everything else (locate, printf, putc, cls) will come for free |
| jloreto | 0:e67bf8f398ee | 10 | * |
| jloreto | 0:e67bf8f398ee | 11 | * The model is the display will wrap at the right and bottom, so you can |
| jloreto | 0:e67bf8f398ee | 12 | * keep writing and will always get valid characters. The location is |
| jloreto | 0:e67bf8f398ee | 13 | * maintained internally to the class to make this easy |
| jloreto | 0:e67bf8f398ee | 14 | */ |
| jloreto | 0:e67bf8f398ee | 15 | |
| jloreto | 0:e67bf8f398ee | 16 | #ifndef MBED_TEXTDISPLAY_H |
| jloreto | 0:e67bf8f398ee | 17 | #define MBED_TEXTDISPLAY_H |
| jloreto | 0:e67bf8f398ee | 18 | |
| jloreto | 0:e67bf8f398ee | 19 | #include "mbed.h" |
| jloreto | 0:e67bf8f398ee | 20 | |
| jloreto | 0:e67bf8f398ee | 21 | /** A common base class for Text displays |
| jloreto | 0:e67bf8f398ee | 22 | */ |
| jloreto | 0:e67bf8f398ee | 23 | class TextDisplay : public Stream { |
| jloreto | 0:e67bf8f398ee | 24 | public: |
| jloreto | 0:e67bf8f398ee | 25 | |
| jloreto | 0:e67bf8f398ee | 26 | // functions needing implementation in derived implementation class |
| jloreto | 0:e67bf8f398ee | 27 | // ---------------------------------------------------------------- |
| jloreto | 0:e67bf8f398ee | 28 | /** Create a TextDisplay interface |
| jloreto | 0:e67bf8f398ee | 29 | * @param name The name used in the path to access the strean through the filesystem |
| jloreto | 0:e67bf8f398ee | 30 | */ |
| jloreto | 0:e67bf8f398ee | 31 | TextDisplay(const char *name = NULL); |
| jloreto | 0:e67bf8f398ee | 32 | |
| jloreto | 0:e67bf8f398ee | 33 | /** output a character at the given position |
| jloreto | 0:e67bf8f398ee | 34 | * |
| jloreto | 0:e67bf8f398ee | 35 | * @param column column where charater must be written |
| jloreto | 0:e67bf8f398ee | 36 | * @param row where character must be written |
| jloreto | 0:e67bf8f398ee | 37 | * @param c the character to be written to the TextDisplay |
| jloreto | 0:e67bf8f398ee | 38 | * @note this method may be overridden in a derived class. |
| jloreto | 0:e67bf8f398ee | 39 | */ |
| jloreto | 0:e67bf8f398ee | 40 | virtual void character(int column, int row, int c) = 0; |
| jloreto | 0:e67bf8f398ee | 41 | |
| jloreto | 0:e67bf8f398ee | 42 | /** return number of rows on TextDisplay |
| jloreto | 0:e67bf8f398ee | 43 | * @result number of rows |
| jloreto | 0:e67bf8f398ee | 44 | * @note this method must be supported in the derived class. |
| jloreto | 0:e67bf8f398ee | 45 | */ |
| jloreto | 0:e67bf8f398ee | 46 | virtual int rows() = 0; |
| jloreto | 0:e67bf8f398ee | 47 | |
| jloreto | 0:e67bf8f398ee | 48 | /** return number of columns on TextDisplay |
| jloreto | 0:e67bf8f398ee | 49 | * @result number of columns |
| jloreto | 0:e67bf8f398ee | 50 | * @note this method must be supported in the derived class. |
| jloreto | 0:e67bf8f398ee | 51 | */ |
| jloreto | 0:e67bf8f398ee | 52 | virtual int columns() = 0; |
| jloreto | 0:e67bf8f398ee | 53 | |
| jloreto | 0:e67bf8f398ee | 54 | // functions that come for free, but can be overwritten |
| jloreto | 0:e67bf8f398ee | 55 | // ---------------------------------------------------- |
| jloreto | 0:e67bf8f398ee | 56 | /** redirect output from a stream (stoud, sterr) to display |
| jloreto | 0:e67bf8f398ee | 57 | * @param stream stream that shall be redirected to the TextDisplay |
| jloreto | 0:e67bf8f398ee | 58 | * @note this method may be overridden in a derived class. |
| jloreto | 0:e67bf8f398ee | 59 | * @returns true if the claim succeeded. |
| jloreto | 0:e67bf8f398ee | 60 | */ |
| jloreto | 0:e67bf8f398ee | 61 | virtual bool claim (FILE *stream); |
| jloreto | 0:e67bf8f398ee | 62 | |
| jloreto | 0:e67bf8f398ee | 63 | /** clear the entire screen |
| jloreto | 0:e67bf8f398ee | 64 | * @note this method may be overridden in a derived class. |
| jloreto | 0:e67bf8f398ee | 65 | */ |
| jloreto | 0:e67bf8f398ee | 66 | virtual void cls(); |
| jloreto | 0:e67bf8f398ee | 67 | |
| jloreto | 0:e67bf8f398ee | 68 | /** locate the cursor at a character position. |
| jloreto | 0:e67bf8f398ee | 69 | * Based on the currently active font, locate the cursor on screen. |
| jloreto | 0:e67bf8f398ee | 70 | * @note this method may be overridden in a derived class. |
| jloreto | 0:e67bf8f398ee | 71 | * @param column is the horizontal offset from the left side. |
| jloreto | 0:e67bf8f398ee | 72 | * @param row is the vertical offset from the top. |
| jloreto | 0:e67bf8f398ee | 73 | */ |
| jloreto | 0:e67bf8f398ee | 74 | virtual void locate(int column, int row); |
| jloreto | 0:e67bf8f398ee | 75 | |
| jloreto | 0:e67bf8f398ee | 76 | /** set the foreground color |
| jloreto | 0:e67bf8f398ee | 77 | * @note this method may be overridden in a derived class. |
| jloreto | 0:e67bf8f398ee | 78 | * @param color is color to use for foreground drawing. |
| jloreto | 0:e67bf8f398ee | 79 | */ |
| jloreto | 0:e67bf8f398ee | 80 | virtual void foreground(uint16_t colour); |
| jloreto | 0:e67bf8f398ee | 81 | |
| jloreto | 0:e67bf8f398ee | 82 | /** set the background color |
| jloreto | 0:e67bf8f398ee | 83 | * @note this method may be overridden in a derived class. |
| jloreto | 0:e67bf8f398ee | 84 | * @param color is color to use for background drawing. |
| jloreto | 0:e67bf8f398ee | 85 | */ |
| jloreto | 0:e67bf8f398ee | 86 | virtual void background(uint16_t colour); |
| jloreto | 0:e67bf8f398ee | 87 | |
| jloreto | 0:e67bf8f398ee | 88 | // putc (from Stream) |
| jloreto | 0:e67bf8f398ee | 89 | // printf (from Stream) |
| jloreto | 0:e67bf8f398ee | 90 | |
| jloreto | 0:e67bf8f398ee | 91 | protected: |
| jloreto | 0:e67bf8f398ee | 92 | |
| jloreto | 0:e67bf8f398ee | 93 | virtual int _putc(int value); |
| jloreto | 0:e67bf8f398ee | 94 | virtual int _getc(); |
| jloreto | 0:e67bf8f398ee | 95 | |
| jloreto | 0:e67bf8f398ee | 96 | // character location |
| jloreto | 0:e67bf8f398ee | 97 | int _column; |
| jloreto | 0:e67bf8f398ee | 98 | int _row; |
| jloreto | 0:e67bf8f398ee | 99 | |
| jloreto | 0:e67bf8f398ee | 100 | // colours |
| jloreto | 0:e67bf8f398ee | 101 | volatile uint16_t _foreground; |
| jloreto | 0:e67bf8f398ee | 102 | volatile uint16_t _background; |
| jloreto | 0:e67bf8f398ee | 103 | char *_path; |
| jloreto | 0:e67bf8f398ee | 104 | }; |
| jloreto | 0:e67bf8f398ee | 105 | |
| jloreto | 0:e67bf8f398ee | 106 | #endif |