xref: /openbsd/lib/libmenu/m_pad.c (revision 379777c0)
1 /* $OpenBSD: m_pad.c,v 1.6 2023/10/17 09:52:10 nicm Exp $ */
2 
3 /****************************************************************************
4  * Copyright 2020,2021 Thomas E. Dickey                                     *
5  * Copyright 1998-2010,2012 Free Software Foundation, Inc.                  *
6  *                                                                          *
7  * Permission is hereby granted, free of charge, to any person obtaining a  *
8  * copy of this software and associated documentation files (the            *
9  * "Software"), to deal in the Software without restriction, including      *
10  * without limitation the rights to use, copy, modify, merge, publish,      *
11  * distribute, distribute with modifications, sublicense, and/or sell       *
12  * copies of the Software, and to permit persons to whom the Software is    *
13  * furnished to do so, subject to the following conditions:                 *
14  *                                                                          *
15  * The above copyright notice and this permission notice shall be included  *
16  * in all copies or substantial portions of the Software.                   *
17  *                                                                          *
18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
21  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
22  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
23  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
24  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
25  *                                                                          *
26  * Except as contained in this notice, the name(s) of the above copyright   *
27  * holders shall not be used in advertising or otherwise to promote the     *
28  * sale, use or other dealings in this Software without prior written       *
29  * authorization.                                                           *
30  ****************************************************************************/
31 
32 /****************************************************************************
33  *   Author:  Juergen Pfeifer, 1995,1997                                    *
34  ****************************************************************************/
35 
36 /***************************************************************************
37 * Module m_pad                                                             *
38 * Control menus padding character                                          *
39 ***************************************************************************/
40 
41 #include "menu.priv.h"
42 
43 MODULE_ID("$Id: m_pad.c,v 1.6 2023/10/17 09:52:10 nicm Exp $")
44 
45 /* Macro to redraw menu if it is posted and changed */
46 #define Refresh_Menu(menu) \
47    if ( (menu) && ((menu)->status & _POSTED) )\
48    {\
49       _nc_Draw_Menu( menu );\
50       _nc_Show_Menu( menu ); \
51    }
52 
53 /*---------------------------------------------------------------------------
54 |   Facility      :  libnmenu
55 |   Function      :  int set_menu_pad(MENU* menu, int pad)
56 |
57 |   Description   :  Set the character to be used to separate the item name
58 |                    from its description. This must be a printable
59 |                    character.
60 |
61 |   Return Values :  E_OK              - success
62 |                    E_BAD_ARGUMENT    - an invalid value has been passed
63 +--------------------------------------------------------------------------*/
64 MENU_EXPORT(int)
65 set_menu_pad(MENU *menu, int pad)
66 {
67   bool do_refresh = (menu != (MENU *)0);
68 
69   T((T_CALLED("set_menu_pad(%p,%d)"), (void *)menu, pad));
70 
71   if (!isprint(UChar(pad)))
72     RETURN(E_BAD_ARGUMENT);
73 
74   Normalize_Menu(menu);
75   menu->pad = (unsigned char)pad;
76 
77   if (do_refresh)
78     Refresh_Menu(menu);
79 
80   RETURN(E_OK);
81 }
82 
83 /*---------------------------------------------------------------------------
84 |   Facility      :  libnmenu
85 |   Function      :  int menu_pad(const MENU *menu)
86 |
87 |   Description   :  Return the value of the padding character
88 |
89 |   Return Values :  The pad character
90 +--------------------------------------------------------------------------*/
91 MENU_EXPORT(int)
92 menu_pad(const MENU *menu)
93 {
94   T((T_CALLED("menu_pad(%p)"), (const void *)menu));
95   returnCode(Normalize_Menu(menu)->pad);
96 }
97 
98 /* m_pad.c ends here */
99