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