Subversion Repositories HelenOS

Rev

Rev 2071 | 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 
 
38 
 
1630 palkovsky 39 
#define DEFAULT_FOREGROUND 0x0  /**< default console foreground color */
40 
#define DEFAULT_BACKGROUND 0xf0f0f0 /**< default console background color */
1487 cejka 41 
 
42 
typedef struct {
43 
    unsigned int bg_color;      /**< background color */
44 
    unsigned int fg_color;      /**< foreground color */
45 
} style_t;
46 
 
1525 cejka 47 
/** One field on screen. It contain one character and its attributes. */
1487 cejka 48 
typedef struct {
49 
    char character;         /**< Character itself */
50 
    style_t style;          /**< Character`s attributes */
51 
} keyfield_t;
52 
 
53 
/** Structure for buffering state of one virtual console.
54 
 */
55 
typedef struct {
56 
    keyfield_t *buffer;         /**< Screen content - characters and its style. Used as cyclyc buffer. */
57 
    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 */
59 
    style_t style;              /**< Current style */
60 
    unsigned int top_line;          /**< Points to buffer[][] line that will be printed at screen as the first line */
1575 cejka 61 
    unsigned char is_cursor_visible;    /**< Cursor state - default is visible */
1487 cejka 62 
} screenbuffer_t;
63 
 
1525 cejka 64 
/** 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
1649 cejka 66 
 * @param x position on screen
1525 cejka 67 
 * @param y position on screen
68 
 * @return  keyfield structure with character and its attributes on x,y
69 
 */
1487 cejka 70 
static inline keyfield_t *get_field_at(screenbuffer_t *scr, unsigned int x, unsigned int y)
71 
{
72 
    return scr->buffer + x + ((y + scr->top_line) % scr->size_y) * scr->size_x;
73 
}
74 
 
1525 cejka 75 
/** Compares two styles.
76 
 * @param s1 first style
77 
 * @param s2 second style
78 
 * @return nonzero on equality
79 
 */
1509 palkovsky 80 
static inline int style_same(style_t s1, style_t s2)
81 
{
82 
    return s1.fg_color == s2.fg_color && s1.bg_color == s2.bg_color;
83 
}
1487 cejka 84 
 
1509 palkovsky 85 
 
1525 cejka 86 
void screenbuffer_putchar(screenbuffer_t *scr, char c);
1487 cejka 87 
screenbuffer_t *screenbuffer_init(screenbuffer_t *scr, int size_x, int size_y);
88 
 
89 
void screenbuffer_clear(screenbuffer_t *scr);
90 
void screenbuffer_clear_line(screenbuffer_t *scr, unsigned int line);
91 
void screenbuffer_copy_buffer(screenbuffer_t *scr, keyfield_t *dest);
92 
void screenbuffer_goto(screenbuffer_t *scr, unsigned int x, unsigned int y);
1525 cejka 93 
void screenbuffer_set_style(screenbuffer_t *scr, unsigned int fg_color, unsigned int bg_color);
1487 cejka 94 
 
95 
#endif
96 
 
1649 cejka 97 
 
98 
/** @}
99 
 */
100