Subversion Repositories HelenOS

Rev

Rev 3022 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

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