src/input.h

Thu, 10 Apr 2014 12:10:09 +0200

author
Mike Becker <universe@uap-core.de>
date
Thu, 10 Apr 2014 12:10:09 +0200
changeset 37
bcf624518909
parent 35
6c64b7a073af
child 55
54ea19938d57
permissions
-rw-r--r--

minor improvements by using macros

     1 /*
     2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
     3  *
     4  * Copyright 2014 Mike Becker. 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 are met:
     8  *
     9  *   1. Redistributions of source code must retain the above copyright
    10  *      notice, this list of conditions and the following disclaimer.
    11  *
    12  *   2. 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  *
    16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    17  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    19  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
    20  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
    21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
    22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
    23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
    25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
    26  * POSSIBILITY OF SUCH DAMAGE.
    27  *
    28  */
    30 #ifndef INPUT_H
    31 #define	INPUT_H
    33 #include <stdlib.h>
    34 #include <ncurses.h>
    36 #ifdef	__cplusplus
    37 extern "C" {
    38 #endif
    40 int prompt_yesno(char *msg);
    43 /**
    44  * Asynchronous variant of mvwgetnstr().
    45  * 
    46  * Needs halfdelay mode enabled!
    47  * 
    48  * @param w the window
    49  * @param y the window y position
    50  * @param x the window x position
    51  * @param str the buffer for the read string
    52  * @param pos a pointer to the object containing the current buffer position
    53  * @param len the length of the buffer
    54  * @return 0 if reading is in progress and 1 when a complete line is read
    55  */
    56 int mvwasyncgetnstr(WINDOW* w,int y,int x,char *str,size_t *pos,size_t len);
    58 /**
    59  * Asynchronous variant of mvgetnstr().
    60  * 
    61  * Needs halfdelay mode enabled!
    62  * 
    63  * @param y the window y position
    64  * @param x the window x position
    65  * @param str the buffer for the read string
    66  * @param pos a pointer to the object containing the current buffer position
    67  * @param len the length of the buffer
    68  * @return 0 if reading is in progress and 1 when a complete line is read
    69  */
    70 #define mvasyncgetnstr(y,x,str,pos,len) mvwasyncgetnstr(stdscr,y,x,str,pos,len)
    72 /**
    73  * Asynchronous variant of getnstr().
    74  * 
    75  * Needs halfdelay mode enabled!
    76  * 
    77  * @param str the buffer for the read string
    78  * @param pos a pointer to the object containing the current buffer position
    79  * @param len the length of the buffer
    80  * @return 0 if reading is in progress and 1 when a complete line is read
    81  */
    82 #define asyncgetnstr(str,pos,len) mvwasyncgetnstr(stdscr, getcury(stdscr), \
    83     getcurx(stdscr), str, pos, len)
    86 #ifdef	__cplusplus
    87 }
    88 #endif
    90 #endif	/* INPUT_H */

mercurial