3d50cf42c1f9b5ca5507ef00a70b85e8bdbfc838
[ncurses.git] / menu / m_pattern.c
1 /****************************************************************************
2  * Copyright (c) 1998-2002,2003 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 /***************************************************************************
34 * Module m_pattern                                                         *
35 * Pattern matching handling                                                *
36 ***************************************************************************/
37
38 #include "menu.priv.h"
39
40 MODULE_ID("$Id: m_pattern.c,v 1.9 2003/12/06 17:22:10 tom Exp $")
41
42 /*---------------------------------------------------------------------------
43 |   Facility      :  libnmenu  
44 |   Function      :  char *menu_pattern(const MENU *menu)
45 |   
46 |   Description   :  Return the value of the pattern buffer.
47 |
48 |   Return Values :  NULL          - if there is no pattern buffer allocated
49 |                    EmptyString   - if there is a pattern buffer but no
50 |                                    pattern is stored
51 |                    PatternString - as expected
52 +--------------------------------------------------------------------------*/
53 NCURSES_EXPORT(char *)
54 menu_pattern (const MENU * menu)
55 {
56   return (char *)(menu ? (menu->pattern ? menu->pattern : "") : 0);
57 }
58
59 /*---------------------------------------------------------------------------
60 |   Facility      :  libnmenu  
61 |   Function      :  int set_menu_pattern(MENU *menu, const char *p)
62 |   
63 |   Description   :  Set the match pattern for a menu and position to the
64 |                    first item that matches.
65 |
66 |   Return Values :  E_OK              - success
67 |                    E_BAD_ARGUMENT    - invalid menu or pattern pointer
68 |                    E_NOT_CONNECTED   - no items connected to menu
69 |                    E_BAD_STATE       - menu in user hook routine
70 |                    E_NO_MATCH        - no item matches pattern
71 +--------------------------------------------------------------------------*/
72 NCURSES_EXPORT(int)
73 set_menu_pattern (MENU *menu, const char *p)
74 {
75   ITEM *matchitem;
76   int   matchpos;
77   
78   if (!menu || !p)      
79     RETURN(E_BAD_ARGUMENT);
80   
81   if (!(menu->items))
82     RETURN(E_NOT_CONNECTED);
83   
84   if ( menu->status & _IN_DRIVER )
85     RETURN(E_BAD_STATE);
86   
87   Reset_Pattern(menu);
88   
89   if (!(*p))
90     {
91       pos_menu_cursor(menu);
92       RETURN(E_OK);
93     }
94   
95   if (menu->status & _LINK_NEEDED) 
96     _nc_Link_Items(menu);
97   
98   matchpos  = menu->toprow;
99   matchitem = menu->curitem;
100   assert(matchitem);
101   
102   while(*p)
103     {
104       if ( !isprint((unsigned char)(*p)) || 
105           (_nc_Match_Next_Character_In_Item_Name(menu,*p,&matchitem) != E_OK) )
106         {
107           Reset_Pattern(menu);
108           pos_menu_cursor(menu);
109           RETURN(E_NO_MATCH);
110         }
111       p++;
112     }                   
113   
114   /* This is reached if there was a match. So we position to the new item */
115   Adjust_Current_Item(menu,matchpos,matchitem);
116   RETURN(E_OK);
117 }
118
119 /* m_pattern.c ends here */