Subversion Repositories HelenOS

Rev

Rev 2787 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
1487 cejka 1 
/*
2071 jermar 2 
 * Copyright (c) 2006 Josef Cejka
1487 cejka 3 
 * All rights reserved.
4 
 *
5 
 * Redistribution and use in source and binary forms, with or without
6 
 * modification, are permitted provided that the following conditions
7 
 * are met:
8 
 *
9 
 * - Redistributions of source code must retain the above copyright
10 
 *   notice, this list of conditions and the following disclaimer.
11 
 * - Redistributions in binary form must reproduce the above copyright
12 
 *   notice, this list of conditions and the following disclaimer in the
13 
 *   documentation and/or other materials provided with the distribution.
14 
 * - The name of the author may not be used to endorse or promote products
15 
 *   derived from this software without specific prior written permission.
16 
 *
17 
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 
 */
28 
 
1649 cejka 29 
/** @addtogroup console
30 
 * @{
31 
 */
32 
/** @file
33 
 */
34 
 
1487 cejka 35 
#ifndef __SCREENBUFFER_H__
36 
#define __SCREENBUFFER_H__
37 
 
4377 svoboda 38 
#include <stdint.h>
39 
#include <sys/types.h>
1487 cejka 40 
 
1630 palkovsky 41 
#define DEFAULT_FOREGROUND 0x0  /**< default console foreground color */
42 
#define DEFAULT_BACKGROUND 0xf0f0f0 /**< default console background color */
1487 cejka 43 
 
44 
typedef struct {
4377 svoboda 45 
    uint8_t style;
46 
} attr_style_t;
1487 cejka 47 
 
4377 svoboda 48 
typedef struct {
49 
    uint8_t fg_color;
50 
    uint8_t bg_color;
51 
    uint8_t flags;
52 
} attr_idx_t;
53 
 
54 
typedef struct {
55 
    uint32_t bg_color;      /**< background color */
56 
    uint32_t fg_color;      /**< foreground color */
57 
} attr_rgb_t;
58 
 
59 
typedef struct {
60 
    enum {
61 
        at_style,
62 
        at_idx,
63 
        at_rgb
64 
    } t;
65 
    union {
66 
        attr_style_t s;
67 
        attr_idx_t i;
68 
        attr_rgb_t r;
69 
    } a;
70 
} attrs_t;
71 
 
1525 cejka 72 
/** One field on screen. It contain one character and its attributes. */
1487 cejka 73 
typedef struct {
4377 svoboda 74 
    wchar_t character;      /**< Character itself */
75 
    attrs_t attrs;          /**< Character`s attributes */
1487 cejka 76 
} keyfield_t;
77 
 
78 
/** Structure for buffering state of one virtual console.
79 
 */
80 
typedef struct {
4377 svoboda 81 
    keyfield_t *buffer;         /**< Screen content - characters and their attributes. Used as a circular buffer. */
1487 cejka 82 
    unsigned int size_x, size_y;        /**< Number of columns and rows */
83 
    unsigned int position_x, position_y;    /**< Coordinates of last printed character for determining cursor position */
4377 svoboda 84 
    attrs_t attrs;              /**< Current attributes. */
1487 cejka 85 
    unsigned int top_line;          /**< Points to buffer[][] line that will be printed at screen as the first line */
1575 cejka 86 
    unsigned char is_cursor_visible;    /**< Cursor state - default is visible */
1487 cejka 87 
} screenbuffer_t;
88 
 
1525 cejka 89 
/** Returns keyfield for position on screen. Screenbuffer->buffer is cyclic buffer so we must couted in index of the topmost line.
90 
 * @param scr   screenbuffer
1649 cejka 91 
 * @param x position on screen
1525 cejka 92 
 * @param y position on screen
93 
 * @return  keyfield structure with character and its attributes on x,y
94 
 */
4377 svoboda 95 
static inline keyfield_t *get_field_at(screenbuffer_t *scr, unsigned int x, unsigned int y)
1487 cejka 96 
{
97 
    return scr->buffer + x + ((y + scr->top_line) % scr->size_y) * scr->size_x;
98 
}
99 
 
4377 svoboda 100 
/** Compares two sets of attributes.
1525 cejka 101 
 * @param s1 first style
102 
 * @param s2 second style
103 
 * @return nonzero on equality
104 
 */
4377 svoboda 105 
static inline int attrs_same(attrs_t a1, attrs_t a2)
1509 palkovsky 106 
{
4377 svoboda 107 
    if (a1.t != a2.t) return 0;
108 
 
109 
    switch (a1.t) {
110 
    case at_style: return a1.a.s.style == a2.a.s.style;
111 
    case at_idx: return a1.a.i.fg_color == a2.a.i.fg_color &&
112 
        a1.a.i.bg_color == a2.a.i.bg_color &&
113 
        a1.a.i.flags == a2.a.i.flags;
114 
    case at_rgb: return a1.a.r.fg_color == a2.a.r.fg_color &&
115 
        a1.a.r.bg_color == a2.a.r.bg_color;
116 
    }
1509 palkovsky 117 
}
1487 cejka 118 
 
1509 palkovsky 119 
 
4377 svoboda 120 
void screenbuffer_putchar(screenbuffer_t *scr, wchar_t c);
1487 cejka 121 
screenbuffer_t *screenbuffer_init(screenbuffer_t *scr, int size_x, int size_y);
122 
 
123 
void screenbuffer_clear(screenbuffer_t *scr);
124 
void screenbuffer_clear_line(screenbuffer_t *scr, unsigned int line);
125 
void screenbuffer_copy_buffer(screenbuffer_t *scr, keyfield_t *dest);
126 
void screenbuffer_goto(screenbuffer_t *scr, unsigned int x, unsigned int y);
4377 svoboda 127 
void screenbuffer_set_style(screenbuffer_t *scr, int style);
128 
void screenbuffer_set_color(screenbuffer_t *scr, unsigned int fg_color,
129 
    unsigned int bg_color, unsigned int attr);
130 
void screenbuffer_set_rgb_color(screenbuffer_t *scr, unsigned int fg_color,
131 
    unsigned int bg_color);
1487 cejka 132 
 
133 
#endif
134 
 
1649 cejka 135 
 
136 
/** @}
137 
 */
138