/home/runner/work/EX-Display/EX-Display/DisplayInterface.h

Go to the documentation of this file.

/*
 *  © 2025 Peter Cole
 *  © 2024 Peter Cole
 *
 *  This is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  It is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this code.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef DISPLAYINTERFACE_H
#define DISPLAYINTERFACE_H
 
#include "Logger.h"
#include "Screen.h"
 
struct RowAttributes {
  bool colourSet;      
  bool isUnderlined;   
  bool isLine;         
  bool alwaysTicker;   
  bool neverTicker;    
  uint16_t textColour; 
};
 
class DisplayInterface {
public:
  virtual void begin() = 0;
 
  virtual void clearScreen() = 0;
 
  virtual void displayScreen(Screen *screen) = 0;
 
  virtual void displayStartupInfo(const char *version) = 0;
 
  virtual void displayFormattedRow(uint8_t row, uint8_t column, RowAttributes attributes, const char *text,
                                   bool append) = 0;
 
  void setNext(DisplayInterface *display);
 
  DisplayInterface *getNext();
 
  void setLogger(Logger *logger);
 
  void setId(uint8_t displayId);
 
  uint8_t getId();
 
  void setScreenId(int screenId);
 
  int getScreenId();
 
  int getCSPin();
 
  void setNeedsRedraw(bool redraw);
 
  bool needsRedraw();
 
  void formatRow(int row, const char *text);
 
  virtual ~DisplayInterface() = default;
 
protected:
  DisplayInterface *_next = nullptr;
  uint16_t _textColour;
  uint16_t _backgroundColour;
  Logger *_logger = nullptr;
  uint8_t _displayId = 0;
  int _screenId = -1;
  uint8_t _rotation = 0;
  uint8_t _textSize = 1;
  uint8_t _maxRow = 0;
  uint8_t _maxColumn = 0;
  uint8_t _fontHeight = 0;
  uint8_t _fontWidth = 0;
  int _csPin = -1;
  bool _needsRedraw = true;
 
  RowAttributes _sanitiseAttributes(RowAttributes attributes);
 
  bool _isModifier(char check);
 
  RowAttributes _setAttribute(RowAttributes attributes, char modifier, uint16_t colour = 0xFFFF);
 
  bool _isRGB(const char *colour);
 
  uint16_t _convertRGBtoRGB565(const char *colour);
};
 
#endif // DISPLAYINTERFACE_H