ncurses 5.0
[ncurses.git] / menu / menu.priv.h
1 /****************************************************************************
2  * Copyright (c) 1998 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 <juergen.pfeifer@gmx.net> 1995,1997            *
31  ****************************************************************************/
32
33 /***************************************************************************
34 * Module menu.priv.h                                                       *
35 * Top level private header file for all libnmenu modules                   *
36 ***************************************************************************/
37
38 #include "mf_common.h"
39 #include "menu.h"
40
41 /* Backspace code */
42 #define BS (8)
43
44 extern ITEM _nc_Default_Item;
45 extern MENU _nc_Default_Menu;
46
47 /* Normalize item to default if none was given */
48 #define Normalize_Item( item ) ((item)=(item)?(item):&_nc_Default_Item)
49
50 /* Normalize menu to default if none was given */
51 #define Normalize_Menu( menu ) ((menu)=(menu)?(menu):&_nc_Default_Menu)
52
53 /* Get the user defined (framing) window of the menu */
54 #define Get_Menu_UserWin(menu) ((menu)->userwin ? (menu)->userwin : stdscr)
55
56 /* Normalize menu window */
57 #define Get_Menu_Window(  menu ) \
58    ((menu)->usersub  ? (menu)->usersub  : Get_Menu_UserWin(menu))
59
60 /* menu specific status flags */
61 #define _LINK_NEEDED    (0x04)
62 #define _MARK_ALLOCATED (0x08)
63
64 #define ALL_MENU_OPTS (                 \
65                        O_ONEVALUE     | \
66                        O_SHOWDESC     | \
67                        O_ROWMAJOR     | \
68                        O_IGNORECASE   | \
69                        O_SHOWMATCH    | \
70                        O_NONCYCLIC    )
71
72 #define ALL_ITEM_OPTS (O_SELECTABLE)
73
74 /* Move to the window position of an item and draw it */
75 #define Move_And_Post_Item(menu,item) \
76   {wmove((menu)->win,(menu)->spc_rows*(item)->y,((menu)->itemlen+(menu)->spc_cols)*(item)->x);\
77    _nc_Post_Item((menu),(item));}
78
79 #define Move_To_Current_Item(menu,item) \
80   if ( (item) != (menu)->curitem)\
81     {\
82       Move_And_Post_Item(menu,item);\
83       Move_And_Post_Item(menu,(menu)->curitem);\
84     }
85
86 /* This macro ensures, that the item becomes visible, if possible with the
87    specified row as the top row of the window. If this is not possible,
88    the top row will be adjusted and the value is stored in the row argument.
89 */
90 #define Adjust_Current_Item(menu,row,item) \
91   { if ((item)->y < row) \
92       row = (item)->y;\
93     if ( (item)->y >= (row + (menu)->arows) )\
94       row = ( (item)->y < ((menu)->rows - row) ) ? \
95             (item)->y : (menu)->rows - (menu)->arows;\
96     _nc_New_TopRow_and_CurrentItem(menu,row,item); }
97
98 /* Reset the match pattern buffer */
99 #define Reset_Pattern(menu) \
100   { (menu)->pindex = 0; \
101     (menu)->pattern[0] = '\0'; }
102
103 /* Internal functions. */
104 extern void _nc_Draw_Menu(const MENU *);
105 extern void _nc_Show_Menu(const MENU *);
106 extern void _nc_Calculate_Item_Length_and_Width(MENU *);
107 extern void _nc_Post_Item(const MENU *, const ITEM *);
108 extern bool _nc_Connect_Items(MENU *, ITEM **);
109 extern void _nc_Disconnect_Items(MENU *);
110 extern void _nc_New_TopRow_and_CurrentItem(MENU *,int, ITEM *);
111 extern void _nc_Link_Items(MENU *);
112 extern int  _nc_Match_Next_Character_In_Item_Name(MENU*,int,ITEM**);
113 extern int  _nc_menu_cursor_pos(const MENU* menu, const ITEM* item,
114                                 int* pY, int* pX);