uspace/srv/hid/output/output.h

   1 /*
   2  * Copyright (c) 2024 Jiri Svoboda
   3  * Copyright (c) 2011 Martin Decky
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  *
  10  * - Redistributions of source code must retain the above copyright
  11  *   notice, this list of conditions and the following disclaimer.
  12  * - Redistributions in binary form must reproduce the above copyright
  13  *   notice, this list of conditions and the following disclaimer in the
  14  *   documentation and/or other materials provided with the distribution.
  15  * - The name of the author may not be used to endorse or promote products
  16  *   derived from this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 /** @addtogroup output
  31  * @{
  32  */
  33
  34 #ifndef OUTPUT_OUTPUT_H_
  35 #define OUTPUT_OUTPUT_H_
  36
  37 #include <adt/list.h>
  38 #include <stdbool.h>
  39 #include <loc.h>
  40 #include <io/console.h>
  41 #include <io/style.h>
  42 #include <io/color.h>
  43 #include <io/chargrid.h>
  44
  45 #define NAME  "output"
  46
  47 struct outdev;
  48
  49 typedef struct {
  50         errno_t (*yield)(struct outdev *dev);
  51         errno_t (*claim)(struct outdev *dev);
  52
  53         void (*get_dimensions)(struct outdev *dev, sysarg_t *cols,
  54             sysarg_t *rows);
  55         console_caps_t (*get_caps)(struct outdev *dev);
  56
  57         void (*cursor_update)(struct outdev *dev, sysarg_t prev_col,
  58             sysarg_t prev_row, sysarg_t col, sysarg_t row, bool visible);
  59         void (*char_update)(struct outdev *dev, sysarg_t col, sysarg_t row);
  60         void (*flush)(struct outdev *dev);
  61 } outdev_ops_t;
  62
  63 typedef struct outdev {
  64         link_t link;
  65
  66         sysarg_t cols;
  67         sysarg_t rows;
  68         char_attrs_t attrs;
  69
  70         chargrid_t *backbuf;
  71         sysarg_t top_row;
  72
  73         outdev_ops_t ops;
  74         void *data;
  75 } outdev_t;
  76
  77 extern outdev_t *outdev_register(outdev_ops_t *, void *);
  78
  79 #endif
  80
  81 /** @}
  82  */