DebuggerIO.h

/*
 * Copyright (c) 2008-2014, Pedigree Developers
 *
 * Please see the CONTRIB file in the root of the source tree for a full
 * list of contributors.
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */
 
#ifndef DEBUGGER_IO_H
#define DEBUGGER_IO_H
#include "pedigree/kernel/processor/types.h"
#include "pedigree/kernel/utilities/StaticString.h"
 
#include <config.h>
 
#define COMMAND_MAX 256
class DebuggerCommand;
 
class DebuggerIO {
 public:
  enum Colour {
    Black = 0,
    Blue = 1,
    Green = 2,
    Cyan = 3,
    Red = 4,
    Magenta = 5,
    Orange = 6,
    LightGrey = 7,
    DarkGrey = 8,
    LightBlue = 9,
    LightGreen = 10,
    LightCyan = 11,
    LightRed = 12,
    LightMagenta = 13,
    Yellow = 14,
    White = 15
  };
 
  DebuggerIO() : m_bReady(true), m_pCommand(), m_bRefreshesEnabled(true) {}
  virtual ~DebuggerIO() {}
 
  virtual void initialise() = 0;
  virtual void destroy() = 0;
 
  virtual void setCliUpperLimit(size_t nlines) = 0;
  virtual void setCliLowerLimit(size_t nlines) = 0;
 
  virtual void cls() = 0;
 
  virtual char getCharNonBlock() = 0;
 
  virtual void enableCli() = 0;
  virtual void disableCli() = 0;
 
  virtual void writeCli(const char* str, Colour foreColour, Colour backColour);
  virtual void writeCli(char ch, DebuggerIO::Colour foreColour, DebuggerIO::Colour backColour);
  virtual bool readCli(HugeStaticString& str, DebuggerCommand* pAutoComplete);
 
  virtual void drawHorizontalLine(char c, size_t row, size_t colStart, size_t colEnd,
                                  Colour foreColour, Colour backColour) = 0;
  virtual void drawVerticalLine(char c, size_t col, size_t rowStart, size_t rowEnd,
                                Colour foreColour, Colour backColour) = 0;
 
  virtual void drawString(const char* str, size_t row, size_t col, Colour foreColour,
                          Colour backColour) = 0;
 
  virtual size_t getWidth() = 0;
  virtual size_t getHeight() = 0;
 
  virtual void enableRefreshes() = 0;
  virtual void disableRefreshes() = 0;
  virtual void forceRefresh() = 0;
 
  virtual void readDimensions() = 0;
 
  virtual char getChar() = 0;
 
 protected:
  virtual void putChar(char c, DebuggerIO::Colour foreColour, DebuggerIO::Colour backColour) = 0;
 
  virtual void scroll() = 0;
 
  virtual void moveCursor() = 0;
 
  bool m_bReady;
 
  char m_pCommand[COMMAND_MAX];
 
  bool m_bRefreshesEnabled;
};
 
#endif