SerialIO.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 SERIALIO_H
#define SERIALIO_H

#include "pedigree/kernel/debugger/DebuggerIO.h"
#include "pedigree/kernel/processor/types.h"

class Serial;

class SerialIO : public DebuggerIO
{
  public:
    SerialIO(Serial *pSerial);
    ~SerialIO();

    void setCliUpperLimit(size_t nlines);
    void setCliLowerLimit(size_t nlines);

    void enableCli();
    void disableCli();

    void cls();
    char getCharNonBlock();

    void readDimensions();

    void drawHorizontalLine(
        char c, size_t row, size_t colStart, size_t colEnd,
        DebuggerIO::Colour foreColour, DebuggerIO::Colour backColour);
    void drawVerticalLine(
        char c, size_t col, size_t rowStart, size_t rowEnd,
        DebuggerIO::Colour foreColour, DebuggerIO::Colour backColour);

    void drawString(
        const char *str, size_t row, size_t col, DebuggerIO::Colour foreColour,
        DebuggerIO::Colour backColour);

    size_t getWidth()
    {
        return m_nWidth;
    }
    size_t getHeight()
    {
        return m_nHeight;
    }

    void enableRefreshes();
    void disableRefreshes();
    void forceRefresh();

    char getChar();

    void initialise();
    void destroy();

  protected:
    void scroll();

    void moveCursor();

    void putChar(
        char c, DebuggerIO::Colour foreColour, DebuggerIO::Colour backColour);

    void
    startColour(DebuggerIO::Colour foreColour, DebuggerIO::Colour backColour);
    void endColour();

    void readCursor();
    void setCursor();
    void saveCursor();
    void unsaveCursor();

    size_t m_UpperCliLimit;  
    size_t m_LowerCliLimit;  

    size_t m_nWidth;
    size_t m_nHeight;

    size_t m_nCursorX;
    size_t m_nCursorY;
    size_t m_nOldCursorX;
    size_t m_nOldCursorY;

    DebuggerIO::Colour m_ForeColour;
    DebuggerIO::Colour m_BackColour;

    Serial *m_pSerial;

    bool m_bCli;

  private:
    SerialIO(const SerialIO &);
    SerialIO &operator=(const SerialIO &);
};

#endif