1171390e214c8fae89aca191d12a0e315b42207c
[ncurses.git] / menu / m_pattern.c
1 /****************************************************************************
2  * Copyright (c) 1998-2005,2006 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.15 2006/11/04 18:46:39 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   static char empty[] = "";
57
58   T((T_CALLED("menu_pattern(%p)"), menu));
59   returnPtr(menu ? (menu->pattern ? menu->pattern : empty) : 0);
60 }
61
62 /*---------------------------------------------------------------------------
63 |   Facility      :  libnmenu  
64 |   Function      :  int set_menu_pattern(MENU *menu, const char *p)
65 |   
66 |   Description   :  Set the match pattern for a menu and position to the
67 |                    first item that matches.
68 |
69 |   Return Values :  E_OK              - success
70 |                    E_BAD_ARGUMENT    - invalid menu or pattern pointer
71 |                    E_BAD_STATE       - menu in user hook routine
72 |                    E_NOT_CONNECTED   - no items connected to menu
73 |                    E_NO_MATCH        - no item matches pattern
74 +--------------------------------------------------------------------------*/
75 NCURSES_EXPORT(int)
76 set_menu_pattern(MENU * menu, const char *p)
77 {
78   ITEM *matchitem;
79   int matchpos;
80
81   T((T_CALLED("set_menu_pattern(%p,%s)"), menu, _nc_visbuf(p)));
82
83   if (!menu || !p)
84     RETURN(E_BAD_ARGUMENT);
85
86   if (!(menu->items))
87     RETURN(E_NOT_CONNECTED);
88
89   if (menu->status & _IN_DRIVER)
90     RETURN(E_BAD_STATE);
91
92   Reset_Pattern(menu);
93
94   if (!(*p))
95     {
96       pos_menu_cursor(menu);
97       RETURN(E_OK);
98     }
99
100   if (menu->status & _LINK_NEEDED)
101     _nc_Link_Items(menu);
102
103   matchpos = menu->toprow;
104   matchitem = menu->curitem;
105   assert(matchitem);
106
107   while (*p)
108     {
109       if (!isprint(UChar(*p)) ||
110           (_nc_Match_Next_Character_In_Item_Name(menu, *p, &matchitem) != E_OK))
111         {
112           Reset_Pattern(menu);
113           pos_menu_cursor(menu);
114           RETURN(E_NO_MATCH);
115         }
116       p++;
117     }
118
119   /* This is reached if there was a match. So we position to the new item */
120   Adjust_Current_Item(menu, matchpos, matchitem);
121   RETURN(E_OK);
122 }
123
124 /* m_pattern.c ends here */