summaryrefslogtreecommitdiff
path: root/lib/libmenu/m_driver.c
blob: 1e6b599d7ac0b6740fbc4418b88288a32bb5305a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
/*	$OpenBSD: m_driver.c,v 1.5 1999/01/22 03:45:06 millert Exp $	*/

/****************************************************************************
 * Copyright (c) 1998 Free Software Foundation, Inc.                        *
 *                                                                          *
 * Permission is hereby granted, free of charge, to any person obtaining a  *
 * copy of this software and associated documentation files (the            *
 * "Software"), to deal in the Software without restriction, including      *
 * without limitation the rights to use, copy, modify, merge, publish,      *
 * distribute, distribute with modifications, sublicense, and/or sell       *
 * copies of the Software, and to permit persons to whom the Software is    *
 * furnished to do so, subject to the following conditions:                 *
 *                                                                          *
 * The above copyright notice and this permission notice shall be included  *
 * in all copies or substantial portions of the Software.                   *
 *                                                                          *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
 * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
 *                                                                          *
 * Except as contained in this notice, the name(s) of the above copyright   *
 * holders shall not be used in advertising or otherwise to promote the     *
 * sale, use or other dealings in this Software without prior written       *
 * authorization.                                                           *
 ****************************************************************************/

/****************************************************************************
 *   Author: Juergen Pfeifer <Juergen.Pfeifer@T-Online.de> 1995,1997        *
 ****************************************************************************/

/***************************************************************************
* Module m_driver                                                          *
* Central dispatching routine                                              *
***************************************************************************/

#include "menu.priv.h"

MODULE_ID("$From: m_driver.c,v 1.15 1999/01/07 23:23:04 juergen Exp $")

/* Macros */

/* Remove the last character from the match pattern buffer */
#define Remove_Character_From_Pattern(menu) \
  (menu)->pattern[--((menu)->pindex)] = '\0'

/* Add a new character to the match pattern buffer */
#define Add_Character_To_Pattern(menu,ch) \
  { (menu)->pattern[((menu)->pindex)++] = (ch);\
    (menu)->pattern[(menu)->pindex] = '\0'; }

/*---------------------------------------------------------------------------
|   Facility      :  libnmenu
|   Function      :  static bool Is_Sub_String(
|                           bool IgnoreCaseFlag,
|                           const char *part,
|                           const char *string)
|
|   Description   :  Checks whether or not part is a substring of string.
|
|   Return Values :  TRUE   - if it is a substring
|                    FALSE  - if it is not a substring
+--------------------------------------------------------------------------*/
static bool Is_Sub_String(
			  bool  IgnoreCaseFlag,
			  const char *part,
			  const char *string
			 )
{
  assert( part && string );
  if ( IgnoreCaseFlag )
    {
      while(*string && *part)
	{
	  if (toupper(*string++)!=toupper(*part)) break;
	  part++;
	}
    }
  else
    {
      while( *string && *part )
	if (*part != *string++) break;
      part++;
    }
  return ( (*part) ? FALSE : TRUE );
}

/*---------------------------------------------------------------------------
|   Facility      :  libnmenu
|   Function      :  int _nc_Match_Next_Character_In_Item_Name(
|                           MENU *menu,
|                           int  ch,
|                           ITEM **item)
|
|   Description   :  This internal routine is called for a menu positioned
|                    at an item with three different classes of characters:
|                       - a printable character; the character is added to
|                         the current pattern and the next item matching
|                         this pattern is searched.
|                       - NUL; the pattern stays as it is and the next item
|                         matching the pattern is searched
|                       - BS; the pattern stays as it is and the previous
|                         item matching the pattern is searched
|
|                       The item parameter contains on call a pointer to
|                       the item where the search starts. On return - if
|                       a match was found - it contains a pointer to the
|                       matching item.
|
|   Return Values :  E_OK        - an item matching the pattern was found
|                    E_NO_MATCH  - nothing found
+--------------------------------------------------------------------------*/
int _nc_Match_Next_Character_In_Item_Name(MENU *menu, int ch, ITEM **item)
{
  bool found = FALSE, passed = FALSE;
  int  idx, last;

  assert( menu && item && *item);
  idx = (*item)->index;

  if (ch && ch!=BS)
    {
      /* if we become to long, we need no further checking : there can't be
	 a match ! */
      if ((menu->pindex+1) > menu->namelen)
	RETURN(E_NO_MATCH);

      Add_Character_To_Pattern(menu,ch);
      /* we artificially position one item back, because in the do...while
	 loop we start with the next item. This means, that with a new
	 pattern search we always start the scan with the actual item. If
	 we do a NEXT_PATTERN oder PREV_PATTERN search, we start with the
	 one after or before the actual item. */
      if (--idx < 0)
	idx = menu->nitems-1;
    }

  last = idx;			/* this closes the cycle */

  do{
    if (ch==BS)
      {			/* we have to go backward */
	if (--idx < 0)
	  idx = menu->nitems-1;
      }
    else
      {			/* otherwise we always go forward */
	if (++idx >= menu->nitems)
	  idx = 0;
      }
    if (Is_Sub_String((menu->opt & O_IGNORECASE) != 0,
		      menu->pattern,
		      menu->items[idx]->name.str)
	)
      found = TRUE;
    else
      passed = TRUE;
  } while (!found && (idx != last));

  if (found)
    {
      if (!((idx==(*item)->index) && passed))
	{
	  *item = menu->items[idx];
	  RETURN(E_OK);
	}
      /* This point is reached, if we fully cycled through the item list
	 and the only match we found is the starting item. With a NEXT_PATTERN
	 or PREV_PATTERN scan this means, that there was no additional match.
	 If we searched with an expanded new pattern, we should never reach
	 this point, because if the expanded pattern matches also the actual
	 item we will find it in the first attempt (passed==FALSE) and we
	 will never cycle through the whole item array.
	 */
      assert( ch==0 || ch==BS );
    }
  else
    {
      if (ch && ch!=BS && menu->pindex>0)
	{
	  /* if we had no match with a new pattern, we have to restore it */
	  Remove_Character_From_Pattern(menu);
	}
    }
  RETURN(E_NO_MATCH);
}

/*---------------------------------------------------------------------------
|   Facility      :  libnmenu
|   Function      :  int menu_driver(MENU *menu, int c)
|
|   Description   :  Central dispatcher for the menu. Translates the logical
|                    request 'c' into a menu action.
|
|   Return Values :  E_OK            - success
|                    E_BAD_ARGUMENT  - invalid menu pointer
|                    E_BAD_STATE     - menu is in user hook routine
|                    E_NOT_POSTED    - menu is not posted
+--------------------------------------------------------------------------*/
int menu_driver(MENU * menu, int   c)
{
#define NAVIGATE(dir) \
  if (!item->dir)\
     result = E_REQUEST_DENIED;\
  else\
     item = item->dir

  int result = E_OK;
  ITEM *item;
  int my_top_row, rdiff;

  if (!menu)
    RETURN(E_BAD_ARGUMENT);

  if ( menu->status & _IN_DRIVER )
    RETURN(E_BAD_STATE);
  if ( !( menu->status & _POSTED ) )
    RETURN(E_NOT_POSTED);

  item = menu->curitem;

    my_top_row = menu->toprow;
    assert(item);

    if ((c > KEY_MAX) && (c<=MAX_MENU_COMMAND))
      {
	if (!((c==REQ_BACK_PATTERN)
	      || (c==REQ_NEXT_MATCH) || (c==REQ_PREV_MATCH)))
	  {
	    assert( menu->pattern );
	    Reset_Pattern(menu);
	  }

	switch(c)
	  {
	  case REQ_LEFT_ITEM:
	    /*=================*/
	    NAVIGATE(left);
	    break;

	  case REQ_RIGHT_ITEM:
	    /*==================*/
	    NAVIGATE(right);
	    break;

	  case REQ_UP_ITEM:
	    /*===============*/
	    NAVIGATE(up);
	    break;

	  case REQ_DOWN_ITEM:
	    /*=================*/
	    NAVIGATE(down);
	    break;

	  case REQ_SCR_ULINE:
	    /*=================*/
	  if (my_top_row == 0 || !(item->up))
	      result = E_REQUEST_DENIED;
	    else
	      {
		--my_top_row;
		item = item->up;
	      }
	    break;

	  case REQ_SCR_DLINE:
	    /*=================*/
	  if ((my_top_row + menu->arows >= menu->rows) || !(item->down))
	      {
		/* only if the menu has less items than rows, we can deny the
		   request. Otherwise the epilogue of this routine adjusts the
		   top row if necessary */
		result = E_REQUEST_DENIED;
	      }
	  else {
	    my_top_row++;
	      item = item->down;
	  }
	    break;

	  case REQ_SCR_DPAGE:
	    /*=================*/
	  rdiff = menu->rows - (menu->arows + my_top_row);
	    if (rdiff > menu->arows)
	      rdiff = menu->arows;
	  if (rdiff<=0)
	      result = E_REQUEST_DENIED;
	    else
	      {
		my_top_row += rdiff;
	      while(rdiff-- > 0 && item!=(ITEM*)0)
		  item = item->down;
	      }
	    break;

	  case REQ_SCR_UPAGE:
	    /*=================*/
	  rdiff = (menu->arows < my_top_row) ? menu->arows : my_top_row;
	  if (rdiff<=0)
	      result = E_REQUEST_DENIED;
	    else
	      {
		my_top_row -= rdiff;
	      while(rdiff-- && item!=(ITEM*)0)
		  item = item->up;
	      }
	    break;

	  case REQ_FIRST_ITEM:
	    /*==================*/
	    item = menu->items[0];
	    break;

	  case REQ_LAST_ITEM:
	    /*=================*/
	    item = menu->items[menu->nitems-1];
	    break;

	  case REQ_NEXT_ITEM:
	    /*=================*/
	    if ((item->index+1)>=menu->nitems)
	      {
		if (menu->opt & O_NONCYCLIC)
		  result = E_REQUEST_DENIED;
		else
		  item = menu->items[0];
	      }
	    else
	      item = menu->items[item->index + 1];
	    break;

	  case REQ_PREV_ITEM:
	    /*=================*/
	    if (item->index<=0)
	      {
		if (menu->opt & O_NONCYCLIC)
		  result = E_REQUEST_DENIED;
		else
		  item = menu->items[menu->nitems-1];
	      }
	    else
	      item = menu->items[item->index - 1];
	    break;

	  case REQ_TOGGLE_ITEM:
	    /*===================*/
	    if (menu->opt & O_ONEVALUE)
	      {
		result = E_REQUEST_DENIED;
	      }
	    else
	      {
		if (menu->curitem->opt & O_SELECTABLE)
		  {
		    menu->curitem->value = !menu->curitem->value;
		    Move_And_Post_Item(menu,menu->curitem);
		    _nc_Show_Menu(menu);
		  }
		else
		  result = E_NOT_SELECTABLE;
	      }
	    break;

	  case REQ_CLEAR_PATTERN:
	    /*=====================*/
	    /* already cleared in prologue */
	    break;

	  case REQ_BACK_PATTERN:
	    /*====================*/
	    if (menu->pindex>0)
	      {
		assert(menu->pattern);
		Remove_Character_From_Pattern(menu);
		pos_menu_cursor( menu );
	      }
	    else
	      result = E_REQUEST_DENIED;
	    break;

	  case REQ_NEXT_MATCH:
	    /*==================*/
	    assert(menu->pattern);
	    if (menu->pattern[0])
	      result = _nc_Match_Next_Character_In_Item_Name(menu,0,&item);
	    else
	      {
		if ((item->index+1)<menu->nitems)
		  item=menu->items[item->index+1];
		else
		  {
		    if (menu->opt & O_NONCYCLIC)
		      result = E_REQUEST_DENIED;
		    else
		      item = menu->items[0];
		  }
	      }
	    break;

	  case REQ_PREV_MATCH:
	    /*==================*/
	    assert(menu->pattern);
	    if (menu->pattern[0])
	      result = _nc_Match_Next_Character_In_Item_Name(menu,BS,&item);
	    else
	      {
		if (item->index)
		  item = menu->items[item->index-1];
		else
		  {
		    if (menu->opt & O_NONCYCLIC)
		      result = E_REQUEST_DENIED;
		    else
		      item = menu->items[menu->nitems-1];
		  }
	      }
	    break;

	  default:
	    /*======*/
	    result = E_UNKNOWN_COMMAND;
	    break;
	  }
      }
    else
      {				/* not a command */
	if ( !(c & ~((int)MAX_REGULAR_CHARACTER)) && isprint(c) )
	  result = _nc_Match_Next_Character_In_Item_Name( menu, c, &item );
#ifdef NCURSES_MOUSE_VERSION
        else if (KEY_MOUSE == c)
	  {
	    MEVENT	event;
	    WINDOW* uwin = Get_Menu_UserWin(menu);

	    getmouse(&event);
	    if ((event.bstate & (BUTTON1_CLICKED         |
				 BUTTON1_DOUBLE_CLICKED  |
				 BUTTON1_TRIPLE_CLICKED   ))
	     && wenclose(uwin,event.y, event.x))
	      { /* we react only if the click was in the userwin, that means
		 * inside the menu display area or at the decoration window.
		 */
		WINDOW* sub = Get_Menu_Window(menu);
		int ry = event.y, rx = event.x; /* screen coordinates */

		result = E_REQUEST_DENIED;
		if (mouse_trafo(&ry,&rx,FALSE))
		  { /* rx, ry are now "curses" coordinates */
		    if (ry < sub->_begy)
		      { /* we clicked above the display region; this is
			 * interpreted as "scroll up" request
			 */
			if (event.bstate & BUTTON1_CLICKED)
			  result = menu_driver(menu,REQ_SCR_ULINE);
			else if (event.bstate & BUTTON1_DOUBLE_CLICKED)
			  result = menu_driver(menu,REQ_SCR_UPAGE);
			else if (event.bstate & BUTTON1_TRIPLE_CLICKED)
			  result = menu_driver(menu,REQ_FIRST_ITEM);
			RETURN(result);
		      }
		    else if (ry >= sub->_begy + sub->_maxy)
		      { /* we clicked below the display region; this is
			 * interpreted as "scroll down" request
			 */
			if (event.bstate & BUTTON1_CLICKED)
			  result = menu_driver(menu,REQ_SCR_DLINE);
			else if (event.bstate & BUTTON1_DOUBLE_CLICKED)
			  result = menu_driver(menu,REQ_SCR_DPAGE);
			else if (event.bstate & BUTTON1_TRIPLE_CLICKED)
			  result = menu_driver(menu,REQ_LAST_ITEM);
			RETURN(result);
		      }
		    else if (wenclose(sub,event.y,event.x))
		      { /* Inside the area we try to find the hit item */
			int i,x,y,err;
			ry = event.y; rx = event.x;
			if (wmouse_trafo(sub,&ry,&rx,FALSE))
			  {
			    for(i=0;i<menu->nitems;i++)
			      {
				err = _nc_menu_cursor_pos(menu,menu->items[i],
							  &y, &x);
				if (E_OK==err)
				  {
				    if ((ry==y)       &&
					(rx>=x)       &&
					(rx < x + menu->itemlen))
				      {
					item = menu->items[i];
					result = E_OK;
					break;
				      }
				  }
			      }
			    if (E_OK==result)
			      { /* We found an item, now we can handle the click.
				 * A single click just positions the menu cursor
				 * to the clicked item. A double click toggles
				 * the item.
				 */
				if (event.bstate & BUTTON1_DOUBLE_CLICKED)
				  {
				    _nc_New_TopRow_and_CurrentItem(menu,
								   my_top_row,
								   item);
				    menu_driver(menu,REQ_TOGGLE_ITEM);
				    result = E_UNKNOWN_COMMAND;
				  }
			      }
			  }
		      }
		  }
	      }
	    else
	        result = E_REQUEST_DENIED;
	  }
#endif /* NCURSES_MOUSE_VERSION */
	else
	  result = E_UNKNOWN_COMMAND;
      }

  if (E_OK==result)
    {
    /* Adjust the top row if it turns out that the current item unfortunately
       doesn't appear in the menu window */
    if ( item->y < my_top_row )
      my_top_row = item->y;
    else if ( item->y >= (my_top_row + menu->arows) )
      my_top_row = item->y - menu->arows + 1;

    _nc_New_TopRow_and_CurrentItem( menu, my_top_row, item );

    }

  RETURN(result);
}

/* m_driver.c ends here */