ncurses 6.2 - patch 20200816
[ncurses.git] / ncurses / base / keybound.c
1 /****************************************************************************
2  * Copyright 2020 Thomas E. Dickey                                          *
3  * Copyright 1999-2009,2011 Free Software Foundation, Inc.                  *
4  *                                                                          *
5  * Permission is hereby granted, free of charge, to any person obtaining a  *
6  * copy of this software and associated documentation files (the            *
7  * "Software"), to deal in the Software without restriction, including      *
8  * without limitation the rights to use, copy, modify, merge, publish,      *
9  * distribute, distribute with modifications, sublicense, and/or sell       *
10  * copies of the Software, and to permit persons to whom the Software is    *
11  * furnished to do so, subject to the following conditions:                 *
12  *                                                                          *
13  * The above copyright notice and this permission notice shall be included  *
14  * in all copies or substantial portions of the Software.                   *
15  *                                                                          *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23  *                                                                          *
24  * Except as contained in this notice, the name(s) of the above copyright   *
25  * holders shall not be used in advertising or otherwise to promote the     *
26  * sale, use or other dealings in this Software without prior written       *
27  * authorization.                                                           *
28  ****************************************************************************/
29
30 /****************************************************************************
31  *  Author: Thomas E. Dickey                        1999-on                 *
32  *     and: Juergen Pfeifer                         2009                    *
33  ****************************************************************************/
34
35 #include <curses.priv.h>
36
37 MODULE_ID("$Id: keybound.c,v 1.12 2020/02/02 23:34:34 tom Exp $")
38
39 /*
40  * Returns the count'th string definition which is associated with the
41  * given keycode.  The result is malloc'd, must be freed by the caller.
42  */
43 NCURSES_EXPORT(char *)
44 NCURSES_SP_NAME(keybound) (NCURSES_SP_DCLx int code, int count)
45 {
46     char *result = 0;
47
48     T((T_CALLED("keybound(%p, %d,%d)"), (void *) SP_PARM, code, count));
49     if (SP_PARM != 0 && code >= 0) {
50         result = _nc_expand_try(SP_PARM->_keytry,
51                                 (unsigned) code,
52                                 &count,
53                                 (size_t) 0);
54     }
55     returnPtr(result);
56 }
57
58 #if NCURSES_SP_FUNCS
59 NCURSES_EXPORT(char *)
60 keybound(int code, int count)
61 {
62     return NCURSES_SP_NAME(keybound) (CURRENT_SCREEN, code, count);
63 }
64 #endif