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