ncurses 6.2 - patch 20200328
[ncurses.git] / menu / m_cursor.c
1 /****************************************************************************
2  * Copyright 2020 Thomas E. Dickey                                          *
3  * Copyright 1998-2009,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_cursor                                                          *
36 * Correctly position a menu's cursor                                       *
37 ***************************************************************************/
38
39 #include "menu.priv.h"
40
41 MODULE_ID("$Id: m_cursor.c,v 1.23 2020/02/02 23:34:34 tom Exp $")
42
43 /*---------------------------------------------------------------------------
44 |   Facility      :  libnmenu
45 |   Function      :  _nc_menu_cursor_pos
46 |
47 |   Description   :  Return position of logical cursor to current item
48 |
49 |   Return Values :  E_OK            - success
50 |                    E_BAD_ARGUMENT  - invalid menu
51 |                    E_NOT_POSTED    - Menu is not posted
52 +--------------------------------------------------------------------------*/
53 NCURSES_EXPORT(int)
54 _nc_menu_cursor_pos(const MENU * menu, const ITEM * item, int *pY, int *pX)
55 {
56   if (!menu || !pX || !pY)
57     return (E_BAD_ARGUMENT);
58   else
59     {
60       if ((ITEM *) 0 == item)
61         item = menu->curitem;
62       assert(item != (ITEM *) 0);
63
64       if (!(menu->status & _POSTED))
65         return (E_NOT_POSTED);
66
67       *pX = item->x * (menu->spc_cols + menu->itemlen);
68       *pY = (item->y - menu->toprow) * menu->spc_rows;
69     }
70   return (E_OK);
71 }
72
73 /*---------------------------------------------------------------------------
74 |   Facility      :  libnmenu
75 |   Function      :  pos_menu_cursor
76 |
77 |   Description   :  Position logical cursor to current item in menu
78 |
79 |   Return Values :  E_OK            - success
80 |                    E_BAD_ARGUMENT  - invalid menu
81 |                    E_NOT_POSTED    - Menu is not posted
82 +--------------------------------------------------------------------------*/
83 NCURSES_EXPORT(int)
84 pos_menu_cursor(const MENU * menu)
85 {
86   WINDOW *win, *sub;
87   int x = 0, y = 0;
88   int err = _nc_menu_cursor_pos(menu, (ITEM *) 0, &y, &x);
89
90   T((T_CALLED("pos_menu_cursor(%p)"), (const void *)menu));
91
92   if (E_OK == err)
93     {
94       win = Get_Menu_UserWin(menu);
95       sub = menu->usersub ? menu->usersub : win;
96       assert(win && sub);
97
98       if ((menu->opt & O_SHOWMATCH) && (menu->pindex > 0))
99         x += (menu->pindex + menu->marklen - 1);
100
101       wmove(sub, y, x);
102
103       if (win != sub)
104         {
105           wcursyncup(sub);
106           wsyncup(sub);
107           untouchwin(sub);
108         }
109     }
110   RETURN(err);
111 }
112
113 /* m_cursor.c ends here */