/*
 * *****************************************************************************
 * file name : term_control.h
 * author    : Hung Q. Ngo
 * description: a few functions which output terminal control escape sequences
 * *****************************************************************************
 */

#ifndef _TERM_CONTROL_H
#define _TERM_CONTROL_H

#include <string>

// the attributes
enum term_attrib_t {
    DEFAULT_ATTRIB = '0',
    BRIGHT    = '1',
    DIM       = '2',
    UNDERLINE = '4',
    BLINK     = '5',
    REVERSE   = '7',
    HIDDEN    = '8'
};

// the colors, background or foreground
enum term_colors_t {
    BLACK   = '0',
    RED     = '1',
    GREEN   = '2',
    YELLOW  = '3',
    BLUE    = '4',
    MAGENTA = '5',
    CYAN    = '6',
    WHITE   = '7',
    DEFAULT_COLOR = '9'
};


/**
 * -----------------------------------------------------------------------------
 * term_cc() outputs the corresponding terminal control escape sequence (TCES)
 *
 * usage:
 * cout << term_cc(YELLOW) << "This text is yellow\n" << term_cc();
 *
 * term_clear() outputs the TCES which clears the screen
 * -----------------------------------------------------------------------------
 */
std::string term_cc(term_colors_t fg=DEFAULT_COLOR, 
                    term_colors_t bg=DEFAULT_COLOR, 
                    term_attrib_t attr=DEFAULT_ATTRIB);

std::string term_clear();

#endif