ncurses 6.2 - patch 20200321
[ncurses.git] / menu / m_spacing.c
1 /****************************************************************************
2  * Copyright 2020 Thomas E. Dickey                                          *
3  * Copyright 1998-2010,2012 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:  Juergen Pfeifer, 1995,1997                                    *
32  ****************************************************************************/
33
34 /***************************************************************************
35 * Module m_spacing                                                         *
36 * Routines to handle spacing between entries                               *
37 ***************************************************************************/
38
39 #include "menu.priv.h"
40
41 MODULE_ID("$Id: m_spacing.c,v 1.20 2020/02/02 23:34:34 tom Exp $")
42
43 #define MAX_SPC_DESC ((TABSIZE) ? (TABSIZE) : 8)
44 #define MAX_SPC_COLS ((TABSIZE) ? (TABSIZE) : 8)
45 #define MAX_SPC_ROWS (3)
46
47 /*---------------------------------------------------------------------------
48 |   Facility      :  libnmenu
49 |   Function      :  int set_menu_spacing(MENU *menu,int desc, int r, int c);
50 |
51 |   Description   :  Set the spacing between entries
52 |
53 |   Return Values :  E_OK                 - on success
54 +--------------------------------------------------------------------------*/
55 NCURSES_EXPORT(int)
56 set_menu_spacing(MENU * menu, int s_desc, int s_row, int s_col)
57 {
58   MENU *m;                      /* split for ATAC workaround */
59
60   T((T_CALLED("set_menu_spacing(%p,%d,%d,%d)"),
61      (void *)menu, s_desc, s_row, s_col));
62
63   m = Normalize_Menu(menu);
64
65   assert(m);
66   if (m->status & _POSTED)
67     RETURN(E_POSTED);
68
69   if (((s_desc < 0) || (s_desc > MAX_SPC_DESC)) ||
70       ((s_row < 0) || (s_row > MAX_SPC_ROWS)) ||
71       ((s_col < 0) || (s_col > MAX_SPC_COLS)))
72     RETURN(E_BAD_ARGUMENT);
73
74   m->spc_desc = (short)(s_desc ? s_desc : 1);
75   m->spc_rows = (short)(s_row ? s_row : 1);
76   m->spc_cols = (short)(s_col ? s_col : 1);
77   _nc_Calculate_Item_Length_and_Width(m);
78
79   RETURN(E_OK);
80 }
81
82 /*---------------------------------------------------------------------------
83 |   Facility      :  libnmenu
84 |   Function      :  int menu_spacing (const MENU *,int *,int *,int *);
85 |
86 |   Description   :  Retrieve info about spacing between the entries
87 |
88 |   Return Values :  E_OK             - on success
89 +--------------------------------------------------------------------------*/
90 NCURSES_EXPORT(int)
91 menu_spacing(const MENU * menu, int *s_desc, int *s_row, int *s_col)
92 {
93   const MENU *m;                /* split for ATAC workaround */
94
95   T((T_CALLED("menu_spacing(%p,%p,%p,%p)"),
96      (const void *)menu,
97      (void *)s_desc,
98      (void *)s_row,
99      (void *)s_col));
100
101   m = Normalize_Menu(menu);
102
103   assert(m);
104   if (s_desc)
105     *s_desc = m->spc_desc;
106   if (s_row)
107     *s_row = m->spc_rows;
108   if (s_col)
109     *s_col = m->spc_cols;
110
111   RETURN(E_OK);
112 }
113
114 /* m_spacing.c ends here */