uspace/srv/hid/input/layout.h

   1 /*
   2  * Copyright (c) 2009 Jiri Svoboda
   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 /** @addtogroup inputgen generic
  30  * @brief Keyboard layout interface.
  31  * @ingroup input
  32  * @{
  33  */
  34 /** @file
  35  */
  36
  37 #ifndef KBD_LAYOUT_H_
  38 #define KBD_LAYOUT_H_
  39
  40 #include <io/console.h>
  41
  42 /** Layout instance state */
  43 typedef struct layout {
  44         /** Ops structure */
  45         struct layout_ops *ops;
  46
  47         /* Layout-private data */
  48         void *layout_priv;
  49 } layout_t;
  50
  51 /** Layout ops */
  52 typedef struct layout_ops {
  53         errno_t (*create)(layout_t *);
  54         void (*destroy)(layout_t *);
  55         wchar_t (*parse_ev)(layout_t *, kbd_event_t *);
  56 } layout_ops_t;
  57
  58 extern layout_ops_t us_qwerty_ops;
  59 extern layout_ops_t us_dvorak_ops;
  60 extern layout_ops_t cz_ops;
  61 extern layout_ops_t ar_ops;
  62
  63 extern layout_t *layout_create(layout_ops_t *);
  64 extern void layout_destroy(layout_t *);
  65 extern wchar_t layout_parse_ev(layout_t *, kbd_event_t *);
  66
  67 #endif
  68
  69 /**
  70  * @}
  71  */