Subversion Repositories HelenOS

Rev

Rev 3386 | Rev 4263 | 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 
 
4153 mejdrech 38 
#include <stdint.h>
1487 cejka 39 
 
1630 palkovsky 40 
#define DEFAULT_FOREGROUND 0x0  /**< default console foreground color */
41 
#define DEFAULT_BACKGROUND 0xf0f0f0 /**< default console background color */
1487 cejka 42 
 
43 
typedef struct {
4153 mejdrech 44 
    uint8_t style;
45 
} attr_style_t;
1487 cejka 46 
 
4153 mejdrech 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 {
54 
    uint32_t bg_color;      /**< background 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;
69 
} attrs_t;
70 
 
1525 cejka 71 
/** One field on screen. It contain one character and its attributes. */
1487 cejka 72 
typedef struct {
73 
    char character;         /**< Character itself */
4153 mejdrech 74 
    attrs_t attrs;          /**< Character`s attributes */
1487 cejka 75 
} keyfield_t;
76 
 
77 
/** Structure for buffering state of one virtual console.
78 
 */
79 
typedef struct {
4153 mejdrech 80 
    keyfield_t *buffer;         /**< Screen content - characters and their attributes. Used as a circular buffer. */
1487 cejka 81 
    unsigned int size_x, size_y;        /**< Number of columns and rows */
82 
    unsigned int position_x, position_y;    /**< Coordinates of last printed character for determining cursor position */
4153 mejdrech 83 
    attrs_t attrs;              /**< Current attributes. */
1487 cejka 84 
    unsigned int top_line;          /**< Points to buffer[][] line that will be printed at screen as the first line */
1575 cejka 85 
    unsigned char is_cursor_visible;    /**< Cursor state - default is visible */
1487 cejka 86 
} screenbuffer_t;
87 
 
1525 cejka 88 
/** Returns keyfield for position on screen. Screenbuffer->buffer is cyclic buffer so we must couted in index of the topmost line.
89 
 * @param scr   screenbuffer
1649 cejka 90 
 * @param x position on screen
1525 cejka 91 
 * @param y position on screen
92 
 * @return  keyfield structure with character and its attributes on x,y
93 
 */
1487 cejka 94 
static inline keyfield_t *get_field_at(screenbuffer_t *scr, unsigned int x, unsigned int y)
95 
{
96 
    return scr->buffer + x + ((y + scr->top_line) % scr->size_y) * scr->size_x;
97 
}
98 
 
4153 mejdrech 99 
/** Compares two sets of attributes.
1525 cejka 100 
 * @param s1 first style
101 
 * @param s2 second style
102 
 * @return nonzero on equality
103 
 */
4153 mejdrech 104 
static inline int attrs_same(attrs_t a1, attrs_t a2)
1509 palkovsky 105 
{
4153 mejdrech 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;
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 
    }
1509 palkovsky 116 
}
1487 cejka 117 
 
1509 palkovsky 118 
 
1525 cejka 119 
void screenbuffer_putchar(screenbuffer_t *scr, char c);
1487 cejka 120 
screenbuffer_t *screenbuffer_init(screenbuffer_t *scr, int size_x, int size_y);
121 
 
122 
void screenbuffer_clear(screenbuffer_t *scr);
123 
void screenbuffer_clear_line(screenbuffer_t *scr, unsigned int line);
124 
void screenbuffer_copy_buffer(screenbuffer_t *scr, keyfield_t *dest);
125 
void screenbuffer_goto(screenbuffer_t *scr, unsigned int x, unsigned int y);
4153 mejdrech 126 
void screenbuffer_set_style(screenbuffer_t *scr, int style);
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);
1487 cejka 131 
 
132 
#endif
133 
 
1649 cejka 134 
 
135 
/** @}
136 
 */
137