uspace/lib/clui/include/nchoice.h

   1 /*
   2  * Copyright (c) 2015 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 libclui
  30  * @{
  31  */
  32 /**
  33  * @file Numerical choice
  34  */
  35
  36 #ifndef LIBCLUI_NCHOICE_H_
  37 #define LIBCLUI_NCHOICE_H_
  38
  39 #include <adt/list.h>
  40 #include <tinput.h>
  41
  42 typedef enum {
  43         /** This is the default option */
  44         ncf_default = 1
  45 } nchoice_flag_t;
  46
  47 typedef struct {
  48         /** Link to nchoice_t.opts */
  49         link_t lchoice;
  50         /** Option text */
  51         char *text;
  52         /** User argument */
  53         void *arg;
  54 } nchoice_opt_t;
  55
  56 typedef struct {
  57         /** Prompt text */
  58         char *prompt;
  59         /** Options */
  60         list_t opts; /* of nchoice_opt_t */
  61         /** Text input */
  62         tinput_t *tinput;
  63         /** Default option */
  64         nchoice_opt_t *def_opt;
  65 } nchoice_t;
  66
  67 extern errno_t nchoice_create(nchoice_t **);
  68 extern void nchoice_destroy(nchoice_t *);
  69 extern errno_t nchoice_set_prompt(nchoice_t *, const char *);
  70 extern errno_t nchoice_add(nchoice_t *, const char *, void *, nchoice_flag_t);
  71 extern errno_t nchoice_get(nchoice_t *, void **);
  72
  73 #endif
  74
  75 /** @}
  76  */