ncurses 6.2 - patch 20200502
[ncurses.git] / ncurses / base / lib_slkinit.c
1 /****************************************************************************
2  * Copyright 2020 Thomas E. Dickey                                          *
3  * Copyright 1998-2009,2017 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: Zeyd M. Ben-Halim <zmbenhal@netcom.com> 1992,1995               *
32  *     and: Eric S. Raymond <esr@snark.thyrsus.com>                         *
33  *     and: Thomas E. Dickey                        1996-on                 *
34  *     and: Juergen Pfeifer                         2009                    *
35  ****************************************************************************/
36
37 /*
38  *      lib_slkinit.c
39  *      Soft key routines.
40  *      Initialize soft labels.  Called by the user before initscr().
41  */
42 #include <curses.priv.h>
43
44 MODULE_ID("$Id: lib_slkinit.c,v 1.15 2020/02/02 23:34:34 tom Exp $")
45
46 #ifdef USE_SP_RIPOFF
47 #define SoftkeyFormat SP_PARM->slk_format
48 #else
49 #define SoftkeyFormat _nc_globals.slk_format
50 #endif
51
52 NCURSES_EXPORT(int)
53 NCURSES_SP_NAME(slk_init) (NCURSES_SP_DCLx int format)
54 {
55     int code = ERR;
56
57     START_TRACE();
58     T((T_CALLED("slk_init(%p,%d)"), (void *) SP_PARM, format));
59
60     if (format >= 0
61         && format <= 3
62 #ifdef USE_SP_RIPOFF
63         && SP_PARM
64         && SP_PARM->_prescreen
65 #endif
66         && !SoftkeyFormat) {
67         SoftkeyFormat = 1 + format;
68         code = NCURSES_SP_NAME(_nc_ripoffline) (NCURSES_SP_ARGx
69                                                 -SLK_LINES(SoftkeyFormat),
70                                                 _nc_slk_initialize);
71     }
72     returnCode(code);
73 }
74
75 #if NCURSES_SP_FUNCS
76 NCURSES_EXPORT(int)
77 slk_init(int format)
78 {
79     int rc;
80     _nc_lock_global(prescreen);
81     START_TRACE();
82     rc = NCURSES_SP_NAME(slk_init) (CURRENT_SCREEN_PRE, format);
83     _nc_unlock_global(prescreen);
84     return rc;
85 }
86 #endif