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