/*****************************************************************************
 *                                                                           *
 *                                    C G A                                  *
 *                                                                           *
 *---------------------------------------------------------------------------*
 * Beschreibung:    Mit Hilfe dieser Klasse kann man auf den Bildschirm des  *
 *                  PCs zugreifen. Der Zugriff erfolgt direkt auf der Hard-  *
 *                  wareebene, d.h. ueber den Bildschirmspeicher und den     *
 *                  I/O-Ports der Grafikkarte.                               *
 *                                                                           *
 * Autor:           Olaf Spinczyk, TU Dortmund                               *
 *                  Aenderungen von Michael Schoettner, HHU, 21.8.2016       *
 *****************************************************************************/
#ifndef __CGA_include__
#define __CGA_include__

#include "kernel/IOport.h"
#include "user/lib/Array.h"

class CGA {
private:
    // Copy Konstrutkor unterbinden
    CGA(const CGA& copy) = delete;

    IOport index_port;  // Auswahl eines Register der Grafikkarte
    IOport data_port;   // Lese-/Schreib-Zugriff auf Register der Grafikk.

public:
    static const unsigned int CGA_START = 0xb8000U;

    // Konstruktur mit Initialisierung der Ports
    CGA() : index_port(0x3d4), data_port(0x3d5) {
        this->setpos(0, 0);
    }

    // Konstanten fuer die moeglichen Farben im Attribut-Byte.
    typedef enum {
        BLACK,
        BLUE,
        GREEN,
        CYAN,
        RED,
        MAGENTA,
        BROWN,
        LIGHT_GREY,
        DARK_GREY,
        LIGHT_BLUE,
        LIGHT_GREEN,
        LIGHT_CYAN,
        LIGHT_RED,
        LIGHT_MAGENTA,
        YELLOW,
        WHITE
    } color;

    // Standardzeichenfarbe
    enum { STD_ATTR = BLACK << 4 | LIGHT_GREY };

    // Groesse des Bildschirms (25 Zeilen, 80 Spalten)
    enum { ROWS = 25,
           COLUMNS = 80 };

    // Easier access to memory (also easier copying of lines/pages etc)
    typedef struct {
        char cga_char;
        unsigned char cga_attribute;
    } cga_char_t;

    typedef struct {
        // Can use these arrays since they don't have memory overhead (except for the methods that are elsewhere)
        bse::array<cga_char_t, COLUMNS> cga_line;
    } cga_line_t;

    typedef struct {
        bse::array<cga_line_t, ROWS> cga_page;
    } cga_page_t;

    // Setzen des Cursors in Spalte x und Zeile y.
    void setpos(unsigned int x, unsigned int y);

    // Abfragen der Cursorpostion
    void getpos(unsigned int& x, unsigned int& y) const;

    // Anzeige eines Zeichens mit Attribut an einer bestimmten Stelle
    static void show(unsigned int x, unsigned int y, char character, unsigned char attrib = STD_ATTR);

    // Anzeige mehrerer Zeichen ab der aktuellen Cursorposition
    virtual void print(char* string, unsigned int n, unsigned char attrib = STD_ATTR);

    // Verschiebt den Bildschirminhalt um eine Zeile nach oben.
    // Neue Zeile am unteren Bildrand mit Leerzeichen fuellen
    virtual void scrollup();

    // Lösche den Textbildschirm
    virtual void clear();

    // Hilfsfunktion zur Erzeugung eines Attribut-Bytes
    static unsigned char attribute(CGA::color bg, CGA::color fg, bool blink);
};

#endif