CommandStation-EX/Display.h

/*
 *  © 2021, Chris Harlow, Neil McKechnie. All rights reserved.
 *
 *  This file is part of CommandStation-EX
 *
 *  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 CommandStation.  If not, see <https://www.gnu.org/licenses/>.
 */
#ifndef Display_h
#define Display_h
#include <Arduino.h>
#include "defines.h"
#include "DisplayInterface.h"

// Allow maximum message length to be overridden from config.h
#if !defined(MAX_MSG_SIZE)
#define MAX_MSG_SIZE 20 
#endif

// Set default scroll mode (overridable in config.h)
#if !defined(SCROLLMODE) 
#define SCROLLMODE 1
#endif

// This class is created in Display_Implementation.h

class Display : public DisplayInterface {
public:
  Display(DisplayDevice *deviceDriver);
  static const int MAX_CHARACTER_ROWS = 8;
  static const int MAX_CHARACTER_COLS = MAX_MSG_SIZE;
  static const long DISPLAY_SCROLL_TIME = 3000;  // 3 seconds
  static const uint8_t ROW_INITIAL = 255;

private:
  DisplayDevice *_deviceDriver;

  unsigned long lastScrollTime = 0;
  uint8_t hotRow = 0;
  uint8_t hotCol = 0;
  uint8_t topRow = 0;
  uint8_t slot = 0;
  uint8_t rowFirst = ROW_INITIAL;
  uint8_t rowNext = ROW_INITIAL;
  uint8_t charIndex = 0;
  char buffer[MAX_CHARACTER_COLS + 1];
  char* bufferPointer = 0;
  bool noMoreRowsToDisplay = false;
  uint16_t numCharacterRows;
  uint16_t numCharacterColumns = MAX_CHARACTER_COLS;

  char rowBuffer[MAX_CHARACTER_ROWS][MAX_CHARACTER_COLS+1];

public:
  void begin() override;  
  void _clear() override;
  void _setRow(uint8_t line) override;
  size_t _write(uint8_t b) override;
  void _refresh() override;
  void _displayLoop() override;
  Display *loop2(bool force);
  bool findNextNonBlankRow();

};

#endif