ncurses 6.2 - patch 20210619
[ncurses.git] / menu / m_scale.c
1 /****************************************************************************
2  * Copyright 2020,2021 Thomas E. Dickey                                     *
3  * Copyright 1998-2004,2010 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_scale                                                           *
36 * Menu scaling routine                                                     *
37 ***************************************************************************/
38
39 #include "menu.priv.h"
40
41 MODULE_ID("$Id: m_scale.c,v 1.14 2021/06/17 21:20:30 tom Exp $")
42
43 /*---------------------------------------------------------------------------
44 |   Facility      :  libnmenu
45 |   Function      :  int scale_menu(const MENU *menu)
46 |
47 |   Description   :  Returns the minimum window size necessary for the
48 |                    subwindow of menu.
49 |
50 |   Return Values :  E_OK                  - success
51 |                    E_BAD_ARGUMENT        - invalid menu pointer
52 |                    E_NOT_CONNECTED       - no items are connected to menu
53 +--------------------------------------------------------------------------*/
54 MENU_EXPORT(int)
55 scale_menu(const MENU *menu, int *rows, int *cols)
56 {
57   T((T_CALLED("scale_menu(%p,%p,%p)"),
58      (const void *)menu,
59      (void *)rows,
60      (void *)cols));
61
62   if (!menu)
63     RETURN(E_BAD_ARGUMENT);
64
65   if (menu->items && *(menu->items))
66     {
67       if (rows)
68         *rows = menu->height;
69       if (cols)
70         *cols = menu->width;
71       RETURN(E_OK);
72     }
73   else
74     RETURN(E_NOT_CONNECTED);
75 }
76
77 /* m_scale.c ends here */