src/menu.c

   1 /* Pulldown menu code.
   2    Copyright (C) 1994 Miguel de Icaza.
   3
   4    This program is free software; you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation; either version 2 of the License, or
   7    (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program; if not, write to the Free Software
  16    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  17
  18 #include <config.h>
  19 #include <string.h>
  20 #include <stdarg.h>
  21 #include <sys/types.h>
  22 #include <ctype.h>
  23 #include "global.h"
  24 #include "tty.h"
  25 #include "menu.h"
  26 #include "help.h"
  27 #include "dialog.h"
  28 #include "color.h"
  29 #include "main.h"
  30 #include "mouse.h"
  31 #include "win.h"
  32 #include "key.h"        /* For mi_getch() */
  33
  34 int menubar_visible = 1;        /* This is the new default */
  35
  36 static void
  37 menu_scan_hotkey (Menu *menu)
  38 {
  39     char *cp = strchr (menu->name, '&');
  40
  41     if (cp != NULL && cp[1] != '\0') {
  42         g_strlcpy (cp, cp + 1, strlen (cp));
  43         menu->hotkey = tolower (*cp);
  44     } else
  45         menu->hotkey = 0;
  46 }
  47
  48 Menu *
  49 create_menu (char *name, menu_entry *entries, int count, char *help_node)
  50 {
  51     Menu *menu;
  52     char *cp;
  53
  54     menu = (Menu *) g_malloc (sizeof (*menu));
  55     menu->count = count;
  56     menu->max_entry_len = 20;
  57     menu->entries = entries;
  58
  59     if (entries != (menu_entry*) NULL) {
  60         register menu_entry* mp;
  61         for (mp = entries; count--; mp++) {
  62             if (mp->text[0] != '\0') {
  63 #ifdef ENABLE_NLS
  64                 mp->text = _(mp->text);
  65 #endif /* ENABLE_NLS */
  66                 cp = strchr (mp->text,'&');
  67
  68                 if (cp != NULL && *(cp+1) != '\0') {
  69                     mp->hot_key = tolower (*(cp+1));
  70                     menu->max_entry_len = max (strlen (mp->text) - 1,
  71                         menu->max_entry_len);
  72                 } else {
  73                     menu->max_entry_len = max (strlen (mp->text),
  74                         menu->max_entry_len);
  75                 }
  76             }
  77         }
  78     }
  79
  80     menu->name = g_strdup (name);
  81     menu_scan_hotkey(menu);
  82     menu->start_x = 0;
  83     menu->help_node = g_strdup (help_node);
  84     return menu;
  85 }
  86
  87 static void menubar_drop_compute (WMenu *menubar)
  88 {
  89     menubar->max_entry_len = menubar->menu [menubar->selected]->max_entry_len;
  90 }
  91
  92 static void menubar_paint_idx (WMenu *menubar, int idx, int color)
  93 {
  94     const Menu *menu = menubar->menu [menubar->selected];
  95     const int y = 2 + idx;
  96         int x = menubar-> menu[menubar->selected]->start_x;
  97
  98         if (x + menubar->max_entry_len + 3 > menubar->widget.cols)
  99                 x = menubar->widget.cols - menubar->max_entry_len - 3;
 100
 101     widget_move (&menubar->widget, y, x);
 102     attrset (color);
 103     hline (' ', menubar->max_entry_len+2);
 104     if (!*menu->entries [idx].text) {
 105         attrset (SELECTED_COLOR);
 106         widget_move (&menubar->widget, y, x + 1);
 107         hline (slow_terminal ? ' ' : ACS_HLINE, menubar->max_entry_len);
 108     } else {
 109         unsigned char *text;
 110
 111         addch((unsigned char)menu->entries [idx].first_letter);
 112         for (text = menu->entries [idx].text; *text; text++)
 113         {
 114                 if (*text != '&')
 115                     addch(*text);
 116                 else {
 117                     attrset (color == MENU_SELECTED_COLOR ?
 118                         MENU_HOTSEL_COLOR : MENU_HOT_COLOR);
 119                     addch(*(++text));
 120                     attrset(color);
 121                 }
 122         }
 123     }
 124     widget_move (&menubar->widget, y, x + 1);
 125 }
 126
 127 static inline void menubar_draw_drop (WMenu *menubar)
 128 {
 129     const int count = (menubar->menu [menubar->selected])->count;
 130     int   i;
 131     int   sel = menubar->subsel;
 132     int   column = menubar-> menu[menubar->selected]->start_x - 1;
 133
 134         if (column + menubar->max_entry_len + 4 > menubar->widget.cols)
 135                 column = menubar->widget.cols - menubar->max_entry_len - 4;
 136
 137     attrset (SELECTED_COLOR);
 138     draw_box (menubar->widget.parent,
 139               menubar->widget.y+1, menubar->widget.x + column,
 140               count+2, menubar->max_entry_len + 4);
 141
 142     column++;
 143     for (i = 0; i < count; i++){
 144         if (i == sel)
 145             continue;
 146         menubar_paint_idx (menubar, i, MENU_ENTRY_COLOR);
 147     }
 148     menubar_paint_idx (menubar, sel, MENU_SELECTED_COLOR);
 149 }
 150
 151 static void menubar_draw (WMenu *menubar)
 152 {
 153     const int items = menubar->items;
 154     int   i;
 155
 156     /* First draw the complete menubar */
 157     attrset (SELECTED_COLOR);
 158     widget_move (&menubar->widget, 0, 0);
 159
 160     /* ncurses bug: it should work with hline but it does not */
 161     for (i =  menubar->widget.cols; i; i--)
 162         addch (' ');
 163
 164     attrset (SELECTED_COLOR);
 165     /* Now each one of the entries */
 166     for (i = 0; i < items; i++){
 167         if (menubar->active)
 168             attrset(i == menubar->selected?MENU_SELECTED_COLOR:SELECTED_COLOR);
 169         widget_move (&menubar->widget, 0, menubar->menu [i]->start_x);
 170         printw ("%s", menubar->menu [i]->name);
 171     }
 172
 173     if (menubar->dropped)
 174         menubar_draw_drop (menubar);
 175     else
 176         widget_move (&menubar->widget, 0,
 177                 menubar-> menu[menubar->selected]->start_x);
 178 }
 179
 180 static inline void menubar_remove (WMenu *menubar)
 181 {
 182     menubar->subsel = 0;
 183     if (menubar->dropped){
 184         menubar->dropped = 0;
 185         do_refresh ();
 186         menubar->dropped = 1;
 187     }
 188 }
 189
 190 static void menubar_left (WMenu *menu)
 191 {
 192     menubar_remove (menu);
 193     menu->selected = (menu->selected - 1) % menu->items;
 194     if (menu->selected < 0)
 195         menu->selected = menu->items -1;
 196     menubar_drop_compute (menu);
 197     menubar_draw (menu);
 198 }
 199
 200 static void menubar_right (WMenu *menu)
 201 {
 202     menubar_remove (menu);
 203     menu->selected = (menu->selected + 1) % menu->items;
 204     menubar_drop_compute (menu);
 205     menubar_draw (menu);
 206 }
 207
 208 static void
 209 menubar_finish (WMenu *menubar)
 210 {
 211     menubar->dropped = 0;
 212     menubar->active = 0;
 213     menubar->widget.lines = 1;
 214     widget_want_hotkey (menubar->widget, 0);
 215
 216     dlg_select_by_id (menubar->widget.parent, menubar->previous_widget);
 217     do_refresh ();
 218 }
 219
 220 static void menubar_drop (WMenu *menubar, int selected)
 221 {
 222     menubar->dropped = 1;
 223     menubar->selected = selected;
 224     menubar->subsel = 0;
 225     menubar_drop_compute (menubar);
 226     menubar_draw (menubar);
 227 }
 228
 229 static void menubar_execute (WMenu *menubar, int entry)
 230 {
 231     const Menu *menu = menubar->menu [menubar->selected];
 232     const callfn call_back = menu->entries [entry].call_back;
 233
 234     is_right = menubar->selected != 0;
 235
 236     /* This used to be the other way round, i.e. first callback and
 237        then menubar_finish. The new order (hack?) is needed to make
 238        change_panel () work which is used in quick_view_cmd () -- Norbert
 239     */
 240     menubar_finish (menubar);
 241     (*call_back) ();
 242     do_refresh ();
 243 }
 244
 245 static void menubar_move (WMenu *menubar, int step)
 246 {
 247     const Menu *menu = menubar->menu [menubar->selected];
 248
 249     menubar_paint_idx (menubar, menubar->subsel, MENU_ENTRY_COLOR);
 250     do {
 251         menubar->subsel += step;
 252         if (menubar->subsel < 0)
 253             menubar->subsel = menu->count - 1;
 254
 255         menubar->subsel %= menu->count;
 256     } while  (!menu->entries [menubar->subsel].call_back);
 257     menubar_paint_idx (menubar, menubar->subsel, MENU_SELECTED_COLOR);
 258 }
 259
 260 static int menubar_handle_key (WMenu *menubar, int key)
 261 {
 262     int   i;
 263
 264     /* Lowercase */
 265     if (key < 256 && isalpha (key)) /* Linux libc.so.5.x.x bug fix */
 266         key = tolower (key);
 267
 268     if (is_abort_char (key)){
 269         menubar_finish (menubar);
 270         return 1;
 271     }
 272
 273     if (key == KEY_F(1)) {
 274         if (menubar->dropped) {
 275             interactive_display (NULL,
 276                     (menubar->menu [menubar->selected])->help_node);
 277         } else {
 278             interactive_display (NULL, "[Menu Bar]");
 279         }
 280         menubar_draw (menubar);
 281         return 1;
 282     }
 283
 284     if (key == KEY_LEFT || key == XCTRL('b')){
 285         menubar_left (menubar);
 286         return 1;
 287     } else if (key == KEY_RIGHT || key == XCTRL ('f')){
 288         menubar_right (menubar);
 289         return 1;
 290     }
 291
 292     if (!menubar->dropped){
 293         const int items = menubar->items;
 294         for (i = 0; i < items; i++){
 295             const Menu *menu = menubar->menu [i];
 296
 297             if (menu->hotkey == key){
 298                 menubar_drop (menubar, i);
 299                 return 1;
 300             }
 301         }
 302         if (key == KEY_ENTER || key == XCTRL ('n') || key == KEY_DOWN
 303             || key == '\n'){
 304             menubar_drop (menubar, menubar->selected);
 305             return 1;
 306         }
 307         return 1;
 308     } else {
 309         const int selected = menubar->selected;
 310         const Menu *menu = menubar->menu [selected];
 311         const int items = menu->count;
 312
 313         for (i = 0; i < items; i++){
 314             if (!menu->entries [i].call_back)
 315                 continue;
 316
 317                 if (key != menu->entries [i].hot_key)
 318                         continue;
 319
 320             menubar_execute (menubar, i);
 321             return 1;
 322         }
 323
 324         if (key == KEY_ENTER || key == '\n'){
 325             menubar_execute (menubar, menubar->subsel);
 326             return 1;
 327         }
 328
 329
 330         if (key == KEY_DOWN || key == XCTRL ('n'))
 331             menubar_move (menubar, 1);
 332
 333         if (key == KEY_UP || key == XCTRL ('p'))
 334             menubar_move (menubar, -1);
 335     }
 336     return 0;
 337 }
 338
 339 static cb_ret_t
 340 menubar_callback (WMenu *menubar, widget_msg_t msg, int parm)
 341 {
 342     switch (msg) {
 343         /* We do not want the focus unless we have been activated */
 344     case WIDGET_FOCUS:
 345         if (!menubar->active)
 346             return MSG_NOT_HANDLED;
 347
 348         widget_want_cursor (menubar->widget, 1);
 349
 350         /* Trick to get all the mouse events */
 351         menubar->widget.lines = LINES;
 352
 353         /* Trick to get all of the hotkeys */
 354         widget_want_hotkey (menubar->widget, 1);
 355         menubar->subsel = 0;
 356         menubar_drop_compute (menubar);
 357         menubar_draw (menubar);
 358         return MSG_HANDLED;
 359
 360         /* We don't want the buttonbar to activate while using the menubar */
 361     case WIDGET_HOTKEY:
 362     case WIDGET_KEY:
 363         if (menubar->active) {
 364             menubar_handle_key (menubar, parm);
 365             return MSG_HANDLED;
 366         } else
 367             return MSG_NOT_HANDLED;
 368
 369     case WIDGET_CURSOR:
 370         /* Put the cursor in a suitable place */
 371         return MSG_NOT_HANDLED;
 372
 373     case WIDGET_UNFOCUS:
 374         if (menubar->active)
 375             return MSG_NOT_HANDLED;
 376         else {
 377             widget_want_cursor (menubar->widget, 0);
 378             return MSG_HANDLED;
 379         }
 380
 381     case WIDGET_DRAW:
 382         if (menubar_visible)
 383             menubar_draw (menubar);
 384         return MSG_HANDLED;
 385
 386     default:
 387         return default_proc (msg, parm);
 388     }
 389 }
 390
 391 static int
 392 menubar_event    (Gpm_Event *event, WMenu *menubar)
 393 {
 394     int was_active;
 395     int new_selection;
 396     int left_x, right_x, bottom_y;
 397
 398     if (!(event->type & (GPM_UP|GPM_DOWN|GPM_DRAG)))
 399         return MOU_NORMAL;
 400
 401     if (!menubar->dropped){
 402         menubar->previous_widget = menubar->widget.parent->current->dlg_id;
 403         menubar->active = 1;
 404         menubar->dropped = 1;
 405         was_active = 0;
 406     } else
 407         was_active = 1;
 408
 409     /* Mouse operations on the menubar */
 410     if (event->y == 1 || !was_active){
 411         if (event->type & GPM_UP)
 412             return MOU_NORMAL;
 413
 414         new_selection = 0;
 415         while (new_selection < menubar->items
 416                 && event->x > menubar->menu[new_selection]->start_x
 417         )
 418                 new_selection++;
 419
 420         if (new_selection) /* Don't set the invalid value -1 */
 421                 --new_selection;
 422
 423         if (!was_active){
 424             menubar->selected = new_selection;
 425             dlg_select_widget (menubar->widget.parent, menubar);
 426             menubar_drop_compute (menubar);
 427             menubar_draw (menubar);
 428             return MOU_NORMAL;
 429         }
 430
 431         menubar_remove (menubar);
 432
 433         menubar->selected = new_selection;
 434
 435         menubar_drop_compute (menubar);
 436         menubar_draw (menubar);
 437         return MOU_NORMAL;
 438     }
 439
 440     if (!menubar->dropped)
 441         return MOU_NORMAL;
 442
 443     /* Ignore the events on anything below the third line */
 444     if (event->y <= 2)
 445         return MOU_NORMAL;
 446
 447     /* Else, the mouse operation is on the menus or it is not */
 448         left_x = menubar->menu[menubar->selected]->start_x;
 449         right_x = left_x + menubar->max_entry_len + 4;
 450         if (right_x > menubar->widget.cols)
 451         {
 452                 left_x = menubar->widget.cols - menubar->max_entry_len - 3;
 453                 right_x = menubar->widget.cols - 1;
 454         }
 455
 456     bottom_y = (menubar->menu [menubar->selected])->count + 3;
 457
 458     if ((event->x > left_x) && (event->x < right_x) && (event->y < bottom_y)){
 459         int pos = event->y - 3;
 460
 461         if (!menubar->menu [menubar->selected]->entries [pos].call_back)
 462             return MOU_NORMAL;
 463
 464         menubar_paint_idx (menubar, menubar->subsel, MENU_ENTRY_COLOR);
 465         menubar->subsel = pos;
 466         menubar_paint_idx (menubar, menubar->subsel, MENU_SELECTED_COLOR);
 467
 468         if (event->type & GPM_UP)
 469             menubar_execute (menubar, pos);
 470     } else
 471         if (event->type & GPM_DOWN)
 472             menubar_finish (menubar);
 473
 474     return MOU_NORMAL;
 475 }
 476
 477 /*
 478  * Properly space menubar items. Should be called when menubar is created
 479  * and also when widget width is changed (i.e. upon xterm resize).
 480  */
 481 void
 482 menubar_arrange(WMenu* menubar)
 483 {
 484         register int i, start_x = 1;
 485         int items = menubar->items;
 486
 487 #ifndef RESIZABLE_MENUBAR
 488         int gap = 3;
 489
 490         for (i = 0; i < items; i++)
 491         {
 492                 int len = strlen(menubar->menu[i]->name);
 493                 menubar->menu[i]->start_x = start_x;
 494                 start_x += len + gap;
 495         }
 496
 497 #else /* RESIZABLE_MENUBAR */
 498
 499         int gap = menubar->widget.cols - 2;
 500
 501         /* First, calculate gap between items... */
 502         for (i = 0; i < items; i++)
 503         {
 504                 /* preserve length here, to be used below */
 505                 gap -= (menubar->menu[i]->start_x = strlen(menubar->menu[i]->name));
 506         }
 507
 508         gap /= (items - 1);
 509
 510         if (gap <= 0)
 511         {
 512                 /* We are out of luck - window is too narrow... */
 513                 gap = 1;
 514         }
 515
 516         /* ...and now fix start positions of menubar items */
 517         for (i = 0; i < items; i++)
 518         {
 519                 int len = menubar->menu[i]->start_x;
 520                 menubar->menu[i]->start_x = start_x;
 521                 start_x += len + gap;
 522         }
 523 #endif /* RESIZABLE_MENUBAR */
 524 }
 525
 526 void
 527 destroy_menu (Menu *menu)
 528 {
 529     g_free (menu->name);
 530     g_free (menu->help_node);
 531     g_free (menu);
 532 }
 533
 534 WMenu *
 535 menubar_new (int y, int x, int cols, Menu *menu[], int items)
 536 {
 537     WMenu *menubar = g_new0 (WMenu, 1); /* FIXME: subsel used w/o being set */
 538
 539     init_widget (&menubar->widget, y, x, 1, cols,
 540                  (callback_fn) menubar_callback,
 541                  (mouse_h) menubar_event);
 542     menubar->menu = menu;
 543     menubar->active = 0;
 544     menubar->dropped = 0;
 545     menubar->items = items;
 546     menubar->selected = 0;
 547     widget_want_cursor (menubar->widget, 0);
 548     menubar_arrange (menubar);
 549
 550     return menubar;
 551 }