Subversion Repositories HelenOS

Rev

Rev 1575 | Rev 1649 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

  1. /*
  2.  * Copyright (C) 2006 Josef 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.  
  29. #ifndef __SCREENBUFFER_H__
  30. #define __SCREENBUFFER_H__
  31.  
  32.  
  33. #define DEFAULT_FOREGROUND 0x0  /**< default console foreground color */
  34. #define DEFAULT_BACKGROUND 0xf0f0f0 /**< default console background color */
  35.  
  36. typedef struct {
  37.     unsigned int bg_color;      /**< background color */
  38.     unsigned int fg_color;      /**< foreground color */
  39. } style_t;
  40.  
  41. /** One field on screen. It contain one character and its attributes. */
  42. typedef struct {
  43.     char character;         /**< Character itself */
  44.     style_t style;          /**< Character`s attributes */
  45. } keyfield_t;
  46.  
  47. /** Structure for buffering state of one virtual console.
  48.  */
  49. typedef struct {
  50.     keyfield_t *buffer;         /**< Screen content - characters and its style. Used as cyclyc buffer. */
  51.     unsigned int size_x, size_y;        /**< Number of columns and rows */
  52.     unsigned int position_x, position_y;    /**< Coordinates of last printed character for determining cursor position */
  53.     style_t style;              /**< Current style */
  54.     unsigned int top_line;          /**< Points to buffer[][] line that will be printed at screen as the first line */
  55.     unsigned char is_cursor_visible;    /**< Cursor state - default is visible */
  56. } screenbuffer_t;
  57.  
  58. /** Returns keyfield for position on screen. Screenbuffer->buffer is cyclic buffer so we must couted in index of the topmost line.
  59.  * @param scr   screenbuffer
  60.  * @oaram x position on screen
  61.  * @param y position on screen
  62.  * @return  keyfield structure with character and its attributes on x,y
  63.  */
  64. static inline keyfield_t *get_field_at(screenbuffer_t *scr, unsigned int x, unsigned int y)
  65. {
  66.     return scr->buffer + x + ((y + scr->top_line) % scr->size_y) * scr->size_x;
  67. }
  68.  
  69. /** Compares two styles.
  70.  * @param s1 first style
  71.  * @param s2 second style
  72.  * @return nonzero on equality
  73.  */
  74. static inline int style_same(style_t s1, style_t s2)
  75. {
  76.     return s1.fg_color == s2.fg_color && s1.bg_color == s2.bg_color;
  77. }
  78.  
  79.  
  80. void screenbuffer_putchar(screenbuffer_t *scr, char c);
  81. screenbuffer_t *screenbuffer_init(screenbuffer_t *scr, int size_x, int size_y);
  82.  
  83. void screenbuffer_clear(screenbuffer_t *scr);
  84. void screenbuffer_clear_line(screenbuffer_t *scr, unsigned int line);
  85. void screenbuffer_copy_buffer(screenbuffer_t *scr, keyfield_t *dest);
  86. void screenbuffer_goto(screenbuffer_t *scr, unsigned int x, unsigned int y);
  87. void screenbuffer_set_style(screenbuffer_t *scr, unsigned int fg_color, unsigned int bg_color);
  88.  
  89. #endif
  90.  
  91.