WebSVN – HelenOS – Diff – /trunk/uspace/console/screenbuffer.c


/*
 * Copyright (C) 2006 Josef Cejka
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
/** @addtogroup console
 * @{
 */
/** @file
 */
 
#include <screenbuffer.h>
#include <malloc.h>
#include <unistd.h>
 
/** Store one character to screenbuffer. Its position is determined by
 * scr->position_x and scr->position_y.
 *
 * @param scr   screenbuffer
 * @param c stored character
 */
void screenbuffer_putchar(screenbuffer_t *scr, char c)
{
    keyfield_t *field;
   
    field = get_field_at(scr, scr->position_x, scr->position_y);
 
    field->character = c;
    field->style = scr->style;
}
 
/** Initilize screenbuffer. Allocate space for screen content in accordance to given size.
 * @param scr       initialized screenbuffer
 * @param size_x    width in characters    
 * @param size_y    height in characters
 * @return pointer to screenbuffer (same as scr parameter) or NULL
 */
screenbuffer_t *screenbuffer_init(screenbuffer_t *scr, int size_x, int size_y)
{
    scr->buffer = (keyfield_t *) malloc(sizeof(keyfield_t) * size_x * size_y);
    if (!scr->buffer) {
        return NULL;
    }
   
    scr->size_x = size_x;
    scr->size_y = size_y;
    scr->style.fg_color = DEFAULT_FOREGROUND;
    scr->style.bg_color = DEFAULT_BACKGROUND;
    scr->is_cursor_visible = 1;
   
    screenbuffer_clear(scr);
   
    return scr;
}
 
/** Clear screenbuffer.
 * @param scr screenbuffer
 */
void screenbuffer_clear(screenbuffer_t *scr)
{
    unsigned int i;
   
    for (i = 0; i < (scr->size_x * scr->size_y); i++) {
        scr->buffer[i].character = ' ';
        scr->buffer[i].style = scr->style;
    }
 
    scr->top_line = 0;
    scr->position_y = 0;
    scr->position_x = 0;
}
 
/** Clear one buffer line.
 * @param scr
 * @param line One buffer line (not a screen line!)
 */
void screenbuffer_clear_line(screenbuffer_t *scr, unsigned int line)
{
    unsigned int i;
   
    for (i = 0; i < scr->size_x; i++) {
        scr->buffer[i + line * scr->size_x].character = ' ';
        scr->buffer[i + line * scr->size_x].style = scr->style;
    }
}
 
/** Copy content buffer from screenbuffer to given memory.
 * @param scr   source screenbuffer
 * @param dest  destination
 */
void screenbuffer_copy_buffer(screenbuffer_t *scr, keyfield_t *dest)
{
    unsigned int i;
   
    for (i = 0; i < scr->size_x * scr->size_y; i++) {
        dest[i] = scr->buffer[i];
    }
}
 
/** Set new cursor position in screenbuffer.
 * @param scr
 * @param x
 * @param y
 */
void screenbuffer_goto(screenbuffer_t *scr, unsigned int x, unsigned int y)
{
    scr->position_x = x % scr->size_x;
    scr->position_y = y % scr->size_y;
}
 
/** Set new style.
 * @param scr
 * @param fg_color
 * @param bg_color
 */
void screenbuffer_set_style(screenbuffer_t *scr, unsigned int fg_color, unsigned int bg_color)
{
    scr->style.fg_color = fg_color;
    scr->style.bg_color = bg_color;
}
 
 
/** @}
 */
 
 

Rev 1787	Rev 2069
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	#include <screenbuffer.h>	35	#include <screenbuffer.h>
36	#include <malloc.h>	36	#include <malloc.h>
37	#include <unistd.h>	37	#include <unistd.h>
38		38
39	/** Store one character to screenbuffer. Its position is determined by scr->position_x and scr->position_y.	39	/** Store one character to screenbuffer. Its position is determined by
-		40	* scr->position_x and scr->position_y.
-		41	*
40	* @param scr screenbuffer	42	* @param scr screenbuffer
41	* @param c stored character	43	* @param c stored character
42	*/	44	*/
43	void screenbuffer_putchar(screenbuffer_t *scr, char c)	45	void screenbuffer_putchar(screenbuffer_t *scr, char c)
44	{	46	{
45	keyfield_t *field;	47	keyfield_t *field;
46		48
47	field = get_field_at(scr, scr->position_x, scr->position_y);	49	field = get_field_at(scr, scr->position_x, scr->position_y);
48		50
49	field->character = c;	51	field->character = c;
50	field->style = scr->style;	52	field->style = scr->style;
51	}	53	}
52		54
53	/** Initilize screenbuffer. Allocate space for screen content in accordance to given size.	55	/** Initilize screenbuffer. Allocate space for screen content in accordance to given size.
54	* @param scr initialized screenbuffer	56	* @param scr initialized screenbuffer
55	* @param size_x width in characters	57	* @param size_x width in characters
56	* @param size_y height in characters	58	* @param size_y height in characters
57	* @return pointer to screenbuffer (same as scr parameter) or NULL	59	* @return pointer to screenbuffer (same as scr parameter) or NULL
58	*/	60	*/
59	screenbuffer_t screenbuffer_init(screenbuffer_t scr, int size_x, int size_y)	61	screenbuffer_t screenbuffer_init(screenbuffer_t scr, int size_x, int size_y)
60	{	62	{
61	if ((scr->buffer = (keyfield_t )malloc(sizeof(keyfield_t) size_x * size_y)) == NULL) {	63	scr->buffer = (keyfield_t ) malloc(sizeof(keyfield_t) size_x * size_y);
-		64	if (!scr->buffer) {
62	return NULL;	65	return NULL;
63	}	66	}
64		67
65	scr->size_x = size_x;	68	scr->size_x = size_x;
66	scr->size_y = size_y;	69	scr->size_y = size_y;
67	scr->style.fg_color = DEFAULT_FOREGROUND;	70	scr->style.fg_color = DEFAULT_FOREGROUND;
68	scr->style.bg_color = DEFAULT_BACKGROUND;	71	scr->style.bg_color = DEFAULT_BACKGROUND;
69	scr->is_cursor_visible = 1;	72	scr->is_cursor_visible = 1;
70		73
71	screenbuffer_clear(scr);	74	screenbuffer_clear(scr);
72		75
73	return scr;	76	return scr;
74	}	77	}
75		78
76	/** Clear screenbuffer.	79	/** Clear screenbuffer.
77	* @param scr screenbuffer	80	* @param scr screenbuffer
78	*/	81	*/
79	void screenbuffer_clear(screenbuffer_t *scr)	82	void screenbuffer_clear(screenbuffer_t *scr)
80	{	83	{
81	unsigned int i;	84	unsigned int i;
82		85
83	for (i = 0; i < (scr->size_x * scr->size_y); i++) {	86	for (i = 0; i < (scr->size_x * scr->size_y); i++) {
84	scr->buffer[i].character = ' ';	87	scr->buffer[i].character = ' ';
85	scr->buffer[i].style = scr->style;	88	scr->buffer[i].style = scr->style;
86	}	89	}
87		90
88	scr->top_line = 0;	91	scr->top_line = 0;
89	scr->position_y = 0;	92	scr->position_y = 0;
90	scr->position_x = 0;	93	scr->position_x = 0;
91	}	94	}
92		95
93	/** Clear one buffer line.	96	/** Clear one buffer line.
94	* @param scr	97	* @param scr
95	* @param line One buffer line (not a screen line!)	98	* @param line One buffer line (not a screen line!)
96	*/	99	*/
97	void screenbuffer_clear_line(screenbuffer_t *scr, unsigned int line)	100	void screenbuffer_clear_line(screenbuffer_t *scr, unsigned int line)
98	{	101	{
99	unsigned int i;	102	unsigned int i;
100		103
101	for (i = 0; i < scr->size_x; i++) {	104	for (i = 0; i < scr->size_x; i++) {
102	scr->buffer[i + line*scr->size_x].character = ' ';	105	scr->buffer[i + line * scr->size_x].character = ' ';
103	scr->buffer[i + line*scr->size_x].style = scr->style;	106	scr->buffer[i + line * scr->size_x].style = scr->style;
104	}	107	}
105	}	108	}
106		109
107	/** Copy content buffer from screenbuffer to given memory.	110	/** Copy content buffer from screenbuffer to given memory.
108	* @param scr source screenbuffer	111	* @param scr source screenbuffer
109	* @param dest destination	112	* @param dest destination
110	*/	113	*/
111	void screenbuffer_copy_buffer(screenbuffer_t scr, keyfield_t dest)	114	void screenbuffer_copy_buffer(screenbuffer_t scr, keyfield_t dest)
112	{	115	{
113	unsigned int i;	116	unsigned int i;
114		117
115	for (i = 0; i < scr->size_x * scr->size_y; i++) {	118	for (i = 0; i < scr->size_x * scr->size_y; i++) {
116	dest[i] = scr->buffer[i];	119	dest[i] = scr->buffer[i];
117	}	120	}
118	}	121	}
119		122
120	/** Set new cursor position in screenbuffer.	123	/** Set new cursor position in screenbuffer.
121	* @param scr	124	* @param scr
122	* @param x	125	* @param x
123	* @param y	126	* @param y
124	*/	127	*/
125	void screenbuffer_goto(screenbuffer_t *scr, unsigned int x, unsigned int y)	128	void screenbuffer_goto(screenbuffer_t *scr, unsigned int x, unsigned int y)
126	{	129	{
127	scr->position_x = x % scr->size_x;	130	scr->position_x = x % scr->size_x;
128	scr->position_y = y % scr->size_y;	131	scr->position_y = y % scr->size_y;
129	}	132	}
130		133
131	/** Set new style.	134	/** Set new style.
132	* @param scr	135	* @param scr
133	* @param fg_color	136	* @param fg_color
134	* @param bg_color	137	* @param bg_color
135	*/	138	*/
136	void screenbuffer_set_style(screenbuffer_t *scr, unsigned int fg_color, unsigned int bg_color)	139	void screenbuffer_set_style(screenbuffer_t *scr, unsigned int fg_color, unsigned int bg_color)
137	{	140	{
138	scr->style.fg_color = fg_color;	141	scr->style.fg_color = fg_color;
139	scr->style.bg_color = bg_color;	142	scr->style.bg_color = bg_color;
140	}	143	}
141		144
142		145
143	/** @}	146	/** @}
144	*/	147	*/
145		-
146		148

Subversion Repositories HelenOS

(root)/trunk/uspace/console/screenbuffer.c @ 2071 – Rev 1787 → 2069