| 1 | /****************************************************************************
|
|---|
| 2 | * Copyright (c) 1998-2004,2005 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.22 2005/01/16 01:02:23 tom 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 | /* Get the user defined (framing) window of the menu */
|
|---|
| 60 | #define Get_Menu_UserWin(menu) ((menu)->userwin ? (menu)->userwin : stdscr)
|
|---|
| 61 |
|
|---|
| 62 | /* Normalize menu window */
|
|---|
| 63 | #define Get_Menu_Window( menu ) \
|
|---|
| 64 | ((menu)->usersub ? (menu)->usersub : Get_Menu_UserWin(menu))
|
|---|
| 65 |
|
|---|
| 66 | /* menu specific status flags */
|
|---|
| 67 | #define _LINK_NEEDED (0x04)
|
|---|
| 68 | #define _MARK_ALLOCATED (0x08)
|
|---|
| 69 |
|
|---|
| 70 | #define ALL_MENU_OPTS ( \
|
|---|
| 71 | O_ONEVALUE | \
|
|---|
| 72 | O_SHOWDESC | \
|
|---|
| 73 | O_ROWMAJOR | \
|
|---|
| 74 | O_IGNORECASE | \
|
|---|
| 75 | O_SHOWMATCH | \
|
|---|
| 76 | O_NONCYCLIC )
|
|---|
| 77 |
|
|---|
| 78 | #define ALL_ITEM_OPTS (O_SELECTABLE)
|
|---|
| 79 |
|
|---|
| 80 | /* Move to the window position of an item and draw it */
|
|---|
| 81 | #define Move_And_Post_Item(menu,item) \
|
|---|
| 82 | {wmove((menu)->win,(menu)->spc_rows*(item)->y,((menu)->itemlen+(menu)->spc_cols)*(item)->x);\
|
|---|
| 83 | _nc_Post_Item((menu),(item));}
|
|---|
| 84 |
|
|---|
| 85 | #define Move_To_Current_Item(menu,item) \
|
|---|
| 86 | if ( (item) != (menu)->curitem)\
|
|---|
| 87 | {\
|
|---|
| 88 | Move_And_Post_Item(menu,item);\
|
|---|
| 89 | Move_And_Post_Item(menu,(menu)->curitem);\
|
|---|
| 90 | }
|
|---|
| 91 |
|
|---|
| 92 | /* This macro ensures, that the item becomes visible, if possible with the
|
|---|
| 93 | specified row as the top row of the window. If this is not possible,
|
|---|
| 94 | the top row will be adjusted and the value is stored in the row argument.
|
|---|
| 95 | */
|
|---|
| 96 | #define Adjust_Current_Item(menu,row,item) \
|
|---|
| 97 | { if ((item)->y < row) \
|
|---|
| 98 | row = (item)->y;\
|
|---|
| 99 | if ( (item)->y >= (row + (menu)->arows) )\
|
|---|
| 100 | row = ( (item)->y < ((menu)->rows - row) ) ? \
|
|---|
| 101 | (item)->y : (menu)->rows - (menu)->arows;\
|
|---|
| 102 | _nc_New_TopRow_and_CurrentItem(menu,row,item); }
|
|---|
| 103 |
|
|---|
| 104 | /* Reset the match pattern buffer */
|
|---|
| 105 | #define Reset_Pattern(menu) \
|
|---|
| 106 | { (menu)->pindex = 0; \
|
|---|
| 107 | (menu)->pattern[0] = '\0'; }
|
|---|
| 108 |
|
|---|
| 109 | #define UChar(c) ((unsigned char)(c))
|
|---|
| 110 |
|
|---|
| 111 | /* Internal functions. */
|
|---|
| 112 | extern NCURSES_EXPORT(void) _nc_Draw_Menu (const MENU *);
|
|---|
| 113 | extern NCURSES_EXPORT(void) _nc_Show_Menu (const MENU *);
|
|---|
| 114 | extern NCURSES_EXPORT(void) _nc_Calculate_Item_Length_and_Width (MENU *);
|
|---|
| 115 | extern NCURSES_EXPORT(int) _nc_Calculate_Text_Width(const TEXT *);
|
|---|
| 116 | extern NCURSES_EXPORT(void) _nc_Post_Item (const MENU *, const ITEM *);
|
|---|
| 117 | extern NCURSES_EXPORT(bool) _nc_Connect_Items (MENU *, ITEM **);
|
|---|
| 118 | extern NCURSES_EXPORT(void) _nc_Disconnect_Items (MENU *);
|
|---|
| 119 | extern NCURSES_EXPORT(void) _nc_New_TopRow_and_CurrentItem (MENU *,int, ITEM *);
|
|---|
| 120 | extern NCURSES_EXPORT(void) _nc_Link_Items (MENU *);
|
|---|
| 121 | extern NCURSES_EXPORT(int) _nc_Match_Next_Character_In_Item_Name (MENU*,int,ITEM**);
|
|---|
| 122 | extern NCURSES_EXPORT(int) _nc_menu_cursor_pos (const MENU* menu, const ITEM* item,
|
|---|
| 123 | int* pY, int* pX);
|
|---|
| 124 |
|
|---|
| 125 | #ifdef TRACE
|
|---|
| 126 |
|
|---|
| 127 | #define returnItem(code) TRACE_RETURN(code,item)
|
|---|
| 128 | #define returnItemPtr(code) TRACE_RETURN(code,item_ptr)
|
|---|
| 129 | #define returnItemOpts(code) TRACE_RETURN(code,item_opts)
|
|---|
| 130 | #define returnMenu(code) TRACE_RETURN(code,menu)
|
|---|
| 131 | #define returnMenuHook(code) TRACE_RETURN(code,menu_hook)
|
|---|
| 132 | #define returnMenuOpts(code) TRACE_RETURN(code,menu_opts)
|
|---|
| 133 |
|
|---|
| 134 | extern NCURSES_EXPORT(ITEM *) _nc_retrace_item (ITEM *);
|
|---|
| 135 | extern NCURSES_EXPORT(ITEM **) _nc_retrace_item_ptr (ITEM **);
|
|---|
| 136 | extern NCURSES_EXPORT(Item_Options) _nc_retrace_item_opts (Item_Options);
|
|---|
| 137 | extern NCURSES_EXPORT(MENU *) _nc_retrace_menu (MENU *);
|
|---|
| 138 | extern NCURSES_EXPORT(Menu_Hook) _nc_retrace_menu_hook (Menu_Hook);
|
|---|
| 139 | extern NCURSES_EXPORT(Menu_Options) _nc_retrace_menu_opts (Menu_Options);
|
|---|
| 140 |
|
|---|
| 141 | #else /* !TRACE */
|
|---|
| 142 |
|
|---|
| 143 | #define returnItem(code) return code
|
|---|
| 144 | #define returnItemPtr(code) return code
|
|---|
| 145 | #define returnItemOpts(code) return code
|
|---|
| 146 | #define returnMenu(code) return code
|
|---|
| 147 | #define returnMenuHook(code) return code
|
|---|
| 148 | #define returnMenuOpts(code) return code
|
|---|
| 149 |
|
|---|
| 150 | #endif /* TRACE/!TRACE */
|
|---|
| 151 |
|
|---|
| 152 | #endif /* MENU_PRIV_H_incl */
|
|---|
