ncurses 5.9 - patch 20111203
[ncurses.git] / menu / menu.priv.h
1 /****************************************************************************
2  * Copyright (c) 1998-2005,2009 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 /* $Id: menu.priv.h,v 1.23 2009/02/28 21:02:57 juergen Exp $ */
34
35 /***************************************************************************
36 * Module menu.priv.h                                                       *
37 * Top level private header file for all libnmenu modules                   *
38 ***************************************************************************/
39
40 #ifndef MENU_PRIV_H_incl
41 #define MENU_PRIV_H_incl 1
42
43 #include "curses.priv.h"
44 #include "mf_common.h"
45 #include "menu.h"
46
47 /* Backspace code */
48 #define BS (8)
49
50 extern NCURSES_EXPORT_VAR(ITEM) _nc_Default_Item;
51 extern NCURSES_EXPORT_VAR(MENU) _nc_Default_Menu;
52
53 /* Normalize item to default if none was given */
54 #define Normalize_Item( item ) ((item)=(item)?(item):&_nc_Default_Item)
55
56 /* Normalize menu to default if none was given */
57 #define Normalize_Menu( menu ) ((menu)=(menu)?(menu):&_nc_Default_Menu)
58
59 #define Get_Menu_Screen( menu ) (menu->userwin ? \
60                                  _nc_screen_of(menu->userwin) : CURRENT_SCREEN)
61
62 /* Get the user defined (framing) window of the menu */
63 #define Get_Menu_UserWin(menu) ((menu)->userwin ? \
64     (menu)->userwin : CURRENT_SCREEN->_stdscr)
65
66 /* Normalize menu window */
67 #define Get_Menu_Window(  menu ) \
68    ((menu)->usersub  ? (menu)->usersub  : Get_Menu_UserWin(menu))
69
70 /* menu specific status flags */
71 #define _LINK_NEEDED    (0x04)
72 #define _MARK_ALLOCATED (0x08)
73
74 #define ALL_MENU_OPTS (                 \
75                        O_ONEVALUE     | \
76                        O_SHOWDESC     | \
77                        O_ROWMAJOR     | \
78                        O_IGNORECASE   | \
79                        O_SHOWMATCH    | \
80                        O_NONCYCLIC    )
81
82 #define ALL_ITEM_OPTS (O_SELECTABLE)
83
84 /* Move to the window position of an item and draw it */
85 #define Move_And_Post_Item(menu,item) \
86   {wmove((menu)->win,(menu)->spc_rows*(item)->y,((menu)->itemlen+(menu)->spc_cols)*(item)->x);\
87    _nc_Post_Item((menu),(item));}
88
89 #define Move_To_Current_Item(menu,item) \
90   if ( (item) != (menu)->curitem)\
91     {\
92       Move_And_Post_Item(menu,item);\
93       Move_And_Post_Item(menu,(menu)->curitem);\
94     }
95
96 /* This macro ensures, that the item becomes visible, if possible with the
97    specified row as the top row of the window. If this is not possible,
98    the top row will be adjusted and the value is stored in the row argument.
99 */
100 #define Adjust_Current_Item(menu,row,item) \
101   { if ((item)->y < row) \
102       row = (item)->y;\
103     if ( (item)->y >= (row + (menu)->arows) )\
104       row = ( (item)->y < ((menu)->rows - row) ) ? \
105             (item)->y : (menu)->rows - (menu)->arows;\
106     _nc_New_TopRow_and_CurrentItem(menu,row,item); }
107
108 /* Reset the match pattern buffer */
109 #define Reset_Pattern(menu) \
110   { (menu)->pindex = 0; \
111     (menu)->pattern[0] = '\0'; }
112
113 #define UChar(c)        ((unsigned char)(c))
114
115 /* Internal functions. */
116 extern NCURSES_EXPORT(void) _nc_Draw_Menu (const MENU *);
117 extern NCURSES_EXPORT(void) _nc_Show_Menu (const MENU *);
118 extern NCURSES_EXPORT(void) _nc_Calculate_Item_Length_and_Width (MENU *);
119 extern NCURSES_EXPORT(int)  _nc_Calculate_Text_Width(const TEXT *);
120 extern NCURSES_EXPORT(void) _nc_Post_Item (const MENU *, const ITEM *);
121 extern NCURSES_EXPORT(bool) _nc_Connect_Items (MENU *, ITEM **);
122 extern NCURSES_EXPORT(void) _nc_Disconnect_Items (MENU *);
123 extern NCURSES_EXPORT(void) _nc_New_TopRow_and_CurrentItem (MENU *,int, ITEM *);
124 extern NCURSES_EXPORT(void) _nc_Link_Items (MENU *);
125 extern NCURSES_EXPORT(int)  _nc_Match_Next_Character_In_Item_Name (MENU*,int,ITEM**);
126 extern NCURSES_EXPORT(int)  _nc_menu_cursor_pos (const MENU* menu, const ITEM* item,
127                                 int* pY, int* pX);
128
129 #ifdef TRACE
130
131 #define returnItem(code)        TRACE_RETURN(code,item)
132 #define returnItemPtr(code)     TRACE_RETURN(code,item_ptr)
133 #define returnItemOpts(code)    TRACE_RETURN(code,item_opts)
134 #define returnMenu(code)        TRACE_RETURN(code,menu)
135 #define returnMenuHook(code)    TRACE_RETURN(code,menu_hook)
136 #define returnMenuOpts(code)    TRACE_RETURN(code,menu_opts)
137
138 extern NCURSES_EXPORT(ITEM *)       _nc_retrace_item (ITEM *);
139 extern NCURSES_EXPORT(ITEM **)      _nc_retrace_item_ptr (ITEM **);
140 extern NCURSES_EXPORT(Item_Options) _nc_retrace_item_opts (Item_Options);
141 extern NCURSES_EXPORT(MENU *)       _nc_retrace_menu (MENU *);
142 extern NCURSES_EXPORT(Menu_Hook)    _nc_retrace_menu_hook (Menu_Hook);
143 extern NCURSES_EXPORT(Menu_Options) _nc_retrace_menu_opts (Menu_Options);
144
145 #else /* !TRACE */
146
147 #define returnItem(code)        return code
148 #define returnItemPtr(code)     return code
149 #define returnItemOpts(code)    return code
150 #define returnMenu(code)        return code
151 #define returnMenuHook(code)    return code
152 #define returnMenuOpts(code)    return code
153
154 #endif /* TRACE/!TRACE */
155
156 #endif /* MENU_PRIV_H_incl */