Subversion Repositories HelenOS

Rev

Rev 4348 | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 4348 Rev 4691
Line 25... Line 25...
25
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
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.
26
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27
 */
27
 */
28
 
28
 
29
/** @addtogroup console
29
/** @addtogroup console
30
 * @{
30
 * @{
31
 */
31
 */
32
/** @file
32
/** @file
33
 */
33
 */
34
 
34
 
35
#ifndef __SCREENBUFFER_H__
35
#ifndef SCREENBUFFER_H__
36
#define __SCREENBUFFER_H__
36
#define SCREENBUFFER_H__
37
 
37
 
38
#include <stdint.h>
38
#include <stdint.h>
39
#include <sys/types.h>
39
#include <sys/types.h>
-
 
40
#include <bool.h>
40
 
41
 
41
#define DEFAULT_FOREGROUND 0x0  /**< default console foreground color */
42
#define DEFAULT_FOREGROUND  0x0       /**< default console foreground color */
42
#define DEFAULT_BACKGROUND 0xf0f0f0 /**< default console background color */
43
#define DEFAULT_BACKGROUND  0xf0f0f0  /**< default console background color */
43
 
44
 
44
typedef struct {
45
typedef struct {
45
    uint8_t style;
46
    uint8_t style;
46
} attr_style_t;
47
} attr_style_t;
47
 
48
 
Line 50... Line 51...
50
    uint8_t bg_color;
51
    uint8_t bg_color;
51
    uint8_t flags;
52
    uint8_t flags;
52
} attr_idx_t;
53
} attr_idx_t;
53
 
54
 
54
typedef struct {
55
typedef struct {
55
    uint32_t bg_color;      /**< background color */
56
    uint32_t bg_color;  /**< background color */
56
    uint32_t fg_color;      /**< foreground color */
57
    uint32_t fg_color;  /**< foreground color */
57
} attr_rgb_t;
58
} attr_rgb_t;
58
 
59
 
59
typedef struct {
60
typedef struct {
60
    enum {
61
    enum {
61
        at_style,
62
        at_style,
Line 64... Line 65...
64
    } t;
65
    } t;
65
    union {
66
    union {
66
        attr_style_t s;
67
        attr_style_t s;
67
        attr_idx_t i;
68
        attr_idx_t i;
68
        attr_rgb_t r;
69
        attr_rgb_t r;
69
    } a;
70
    } a;
70
} attrs_t;
71
} attrs_t;
71
 
72
 
72
/** One field on screen. It contain one character and its attributes. */
73
/** One field on screen. It contain one character and its attributes. */
73
typedef struct {
74
typedef struct {
74
    wchar_t character;      /**< Character itself */
75
    wchar_t character;  /**< Character itself */
75
    attrs_t attrs;          /**< Character`s attributes */
76
    attrs_t attrs;      /**< Character attributes */
76
} keyfield_t;
77
} keyfield_t;
77
 
78
 
78
/** Structure for buffering state of one virtual console.
79
/** Structure for buffering state of one virtual console.
79
 */
80
 */
80
typedef struct {
81
typedef struct {
-
 
82
    keyfield_t *buffer;      /**< Screen content - characters and
81
    keyfield_t *buffer;         /**< Screen content - characters and their attributes. Used as a circular buffer. */
83
                                  their attributes (used as a circular buffer) */
82
    unsigned int size_x, size_y;        /**< Number of columns and rows */
84
    size_t size_x;           /**< Number of columns  */
-
 
85
    size_t size_y;           /**< Number of rows */
-
 
86
   
83
    unsigned int position_x, position_y;    /**< Coordinates of last printed character for determining cursor position */
87
    /** Coordinates of last printed character for determining cursor position */
-
 
88
    size_t position_x;
-
 
89
    size_t position_y;
-
 
90
   
84
    attrs_t attrs;              /**< Current attributes. */
91
    attrs_t attrs;           /**< Current attributes. */
-
 
92
    size_t top_line;         /**< Points to buffer[][] line that will
85
    unsigned int top_line;          /**< Points to buffer[][] line that will be printed at screen as the first line */
93
                                  be printed at screen as the first line */
86
    unsigned char is_cursor_visible;    /**< Cursor state - default is visible */
94
    bool is_cursor_visible;  /**< Cursor state - default is visible */
87
} screenbuffer_t;
95
} screenbuffer_t;
88
 
96
 
-
 
97
/** Returns keyfield for position on screen
-
 
98
 *
89
/** Returns keyfield for position on screen. Screenbuffer->buffer is cyclic buffer so we must couted in index of the topmost line.
99
 * Screenbuffer->buffer is cyclic buffer so we
-
 
100
 * must couted in index of the topmost line.
-
 
101
 *
90
 * @param scr   screenbuffer
102
 * @param scr Screenbuffer
91
 * @param x position on screen
103
 * @param x   Position on screen
92
 * @param y position on screen
104
 * @param y   Position on screen
-
 
105
 *
93
 * @return  keyfield structure with character and its attributes on x,y
106
 * @return Keyfield structure with character and its attributes on x, y
-
 
107
 *
94
 */
108
 */
95
static inline keyfield_t *get_field_at(screenbuffer_t *scr, unsigned int x, unsigned int y)
109
static inline keyfield_t *get_field_at(screenbuffer_t *scr, size_t x, size_t y)
96
{
110
{
97
    return scr->buffer + x + ((y + scr->top_line) % scr->size_y) * scr->size_x;
111
    return scr->buffer + x + ((y + scr->top_line) % scr->size_y) * scr->size_x;
98
}
112
}
99
 
113
 
100
/** Compares two sets of attributes.
114
/** Compares two sets of attributes.
-
 
115
 *
101
 * @param s1 first style
116
 * @param s1 First style
102
 * @param s2 second style
117
 * @param s2 Second style
-
 
118
 *
103
 * @return nonzero on equality
119
 * @return Nonzero on equality
-
 
120
 *
104
 */
121
 */
105
static inline int attrs_same(attrs_t a1, attrs_t a2)
122
static inline int attrs_same(attrs_t a1, attrs_t a2)
106
{
123
{
107
    if (a1.t != a2.t) return 0;
124
    if (a1.t != a2.t)
-
 
125
        return 0;
108
 
126
   
109
    switch (a1.t) {
127
    switch (a1.t) {
-
 
128
    case at_style:
110
    case at_style: return a1.a.s.style == a2.a.s.style;
129
        return (a1.a.s.style == a2.a.s.style);
-
 
130
    case at_idx:
111
    case at_idx: return a1.a.i.fg_color == a2.a.i.fg_color &&
131
        return (a1.a.i.fg_color == a2.a.i.fg_color)
112
        a1.a.i.bg_color == a2.a.i.bg_color &&
132
            && (a1.a.i.bg_color == a2.a.i.bg_color)
113
        a1.a.i.flags == a2.a.i.flags;
133
            && (a1.a.i.flags == a2.a.i.flags);
-
 
134
    case at_rgb:
114
    case at_rgb: return a1.a.r.fg_color == a2.a.r.fg_color &&
135
        return (a1.a.r.fg_color == a2.a.r.fg_color)
115
        a1.a.r.bg_color == a2.a.r.bg_color;
136
            && (a1.a.r.bg_color == a2.a.r.bg_color);
116
    }
137
    }
-
 
138
   
-
 
139
    return 0;
117
}
140
}
118
 
141
 
119
 
142
 
120
void screenbuffer_putchar(screenbuffer_t *scr, wchar_t c);
143
void screenbuffer_putchar(screenbuffer_t *scr, wchar_t c);
121
screenbuffer_t *screenbuffer_init(screenbuffer_t *scr, int size_x, int size_y);
144
screenbuffer_t *screenbuffer_init(screenbuffer_t *scr, size_t size_x, size_t size_y);
122
 
145
 
123
void screenbuffer_clear(screenbuffer_t *scr);
146
void screenbuffer_clear(screenbuffer_t *scr);
124
void screenbuffer_clear_line(screenbuffer_t *scr, unsigned int line);
147
void screenbuffer_clear_line(screenbuffer_t *scr, size_t line);
125
void screenbuffer_copy_buffer(screenbuffer_t *scr, keyfield_t *dest);
148
void screenbuffer_copy_buffer(screenbuffer_t *scr, keyfield_t *dest);
126
void screenbuffer_goto(screenbuffer_t *scr, unsigned int x, unsigned int y);
149
void screenbuffer_goto(screenbuffer_t *scr, size_t x, size_t y);
127
void screenbuffer_set_style(screenbuffer_t *scr, int style);
150
void screenbuffer_set_style(screenbuffer_t *scr, uint8_t style);
128
void screenbuffer_set_color(screenbuffer_t *scr, unsigned int fg_color,
151
void screenbuffer_set_color(screenbuffer_t *scr, uint8_t fg_color,
129
    unsigned int bg_color, unsigned int attr);
152
    uint8_t bg_color, uint8_t attr);
130
void screenbuffer_set_rgb_color(screenbuffer_t *scr, unsigned int fg_color,
153
void screenbuffer_set_rgb_color(screenbuffer_t *scr, uint32_t fg_color,
131
    unsigned int bg_color);
154
    uint32_t bg_color);
132
 
155
 
133
#endif
156
#endif
134
 
157
 
135
 
-
 
136
/** @}
158
/** @}
137
 */
159
 */
138
 
-