move.c File Reference

Change the Menu's position/selection. More...

#include "config.h"
#include <stdbool.h>
#include <stddef.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "gui/lib.h"
#include "lib.h"

Include dependency graph for move.c:

Go to the source code of this file.

Functions
MenuRedrawFlags	menu_set_and_notify (struct Menu *menu, int top, int index)
	Set the Menu selection/view and notify others.
static int	menu_drag_view (struct Menu *menu, int top, int index)
	Move the view around the selection.
static int	calc_fit_selection_to_view (struct Menu *menu, int top, int index)
	Move the selection into the view.
static int	calc_move_view (struct Menu *menu, int relative)
	Move the view.
MenuRedrawFlags	menu_move_selection (struct Menu *menu, int index)
	Move the selection, keeping within between [0, menu->max].
MenuRedrawFlags	menu_move_view_relative (struct Menu *menu, int relative)
	Move the view relatively.
void	menu_adjust (struct Menu *menu)
	Reapply the config to the Menu.
MenuRedrawFlags	menu_top_page (struct Menu *menu)
	Move the focus to the top of the page.
MenuRedrawFlags	menu_middle_page (struct Menu *menu)
	Move the focus to the centre of the page.
MenuRedrawFlags	menu_bottom_page (struct Menu *menu)
	Move the focus to the bottom of the page.
MenuRedrawFlags	menu_prev_entry (struct Menu *menu, int count)
	Move the focus to the previous item in the menu.
MenuRedrawFlags	menu_next_entry (struct Menu *menu, int count)
	Move the focus to the next item in the menu.
MenuRedrawFlags	menu_first_entry (struct Menu *menu, int count)
	Move the focus to the first entry in the menu.
MenuRedrawFlags	menu_last_entry (struct Menu *menu, int count)
	Move the focus to the last entry in the menu.
MenuRedrawFlags	menu_current_top (struct Menu *menu)
	Move the current selection to the top of the window.
MenuRedrawFlags	menu_current_middle (struct Menu *menu)
	Move the current selection to the centre of the window.
MenuRedrawFlags	menu_current_bottom (struct Menu *menu)
	Move the current selection to the bottom of the window.
MenuRedrawFlags	menu_half_up (struct Menu *menu, int count)
	Move the focus up half a page in the menu.
MenuRedrawFlags	menu_half_down (struct Menu *menu, int count)
	Move the focus down half a page in the menu.
MenuRedrawFlags	menu_prev_line (struct Menu *menu, int count)
	Move the view up one line, keeping the selection the same.
MenuRedrawFlags	menu_next_line (struct Menu *menu, int count)
	Move the view down one line, keeping the selection the same.
MenuRedrawFlags	menu_prev_page (struct Menu *menu, int count)
	Move the focus to the previous page in the menu.
MenuRedrawFlags	menu_next_page (struct Menu *menu, int count)
	Move the focus to the next page in the menu.

Detailed Description

Change the Menu's position/selection.

Authors

• Richard Russon

Copyright

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file move.c.

Function Documentation

menu_set_and_notify()

MenuRedrawFlags menu_set_and_notify	(	struct Menu *	menu,
		int	top,
		int	index )

Set the Menu selection/view and notify others.

Parameters

menu	Menu
top	Index of item at the top of the view
index	Selected item

Return values

enum	MenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 66 of file move.c.

{
  MenuRedrawFlags flags = MENU_REDRAW_NONE;
 
  if (top != menu->top)
  {
    menu->top = top;
    flags |= MENU_REDRAW_FULL;
  }
 
  if (index != menu->current)
  {
    menu->old_current = menu->current;
    menu->current = index;
 
    if (menu->redraw == MENU_REDRAW_NONE)
    {
      // If this is the only change
      flags |= MENU_REDRAW_MOTION;
    }
    else
    {
      // otherwise, redraw completely
      flags |= MENU_REDRAW_FULL;
    }
  }
 
  if (flags != MENU_REDRAW_NONE)
  {
    menu->redraw |= flags;
    menu->win->actions |= WA_REPAINT;
 
    mutt_debug(LL_NOTIFY, "NT_MENU\n");
    notify_send(menu->notify, NT_MENU, flags, NULL);
  }
  return flags;
}

Here is the call graph for this function:

Here is the caller graph for this function:

menu_drag_view()

static int menu_drag_view ( struct Menu * menu, int top, int index )

static

Move the view around the selection.

Parameters

menu	Menu
top	Index of item at the top of the view
index	Current selection

Return values

num

Top line

Definition at line 111 of file move.c.

{
  if (menu->max <= menu->page_len) // fewer entries than lines
    return 0;
 
  const int page = menu->page_len;
 
  short c_menu_context = cs_subset_number(menu->sub, "menu_context");
  c_menu_context = MIN(c_menu_context, (page / 2));
 
  const bool c_menu_scroll = cs_subset_bool(menu->sub, "menu_scroll");
  if (c_menu_scroll)
  {
    int bottom = top + page;
    // Scroll the view to make the selection visible
    if (index < top + c_menu_context) // scroll=YES, moving UP
      top = index - c_menu_context;
    else if (index >= (bottom - c_menu_context)) // scroll=YES, moving DOWN
      top = index - page + c_menu_context + 1;
  }
  else
  {
    if ((index < top) || (index >= (top + page)))
      top = (index / page) * page; // Round down to a page size
    int bottom = top + page;
 
    // Page up/down to make the selection visible
    if (index < (top + c_menu_context)) // scroll=NO, moving UP
      top = index - page + c_menu_context + 1;
    else if (index >= (bottom - c_menu_context)) // scroll=NO, moving DOWN
      top = index - c_menu_context;
  }
 
  if (top < 0)
    top = 0;
 
  // Tie the last entry to the bottom of the screen
  const bool c_menu_move_off = cs_subset_bool(menu->sub, "menu_move_off");
  if (!c_menu_move_off && (top >= (menu->max - page)))
  {
    top = menu->max - page;
  }
 
  return top;
}

Here is the call graph for this function:

Here is the caller graph for this function:

calc_fit_selection_to_view()

static int calc_fit_selection_to_view ( struct Menu * menu, int top, int index )

static

Move the selection into the view.

Parameters

menu	Menu
top	First entry visible in the view
index	Current selection

Return values

num

Index

Definition at line 164 of file move.c.

{
  short c_menu_context = cs_subset_number(menu->sub, "menu_context");
  c_menu_context = MIN(c_menu_context, (menu->page_len / 2));
 
  int min = top;
  if (top != 0)
    min += c_menu_context;
 
  int max = top + menu->page_len - 1;
  if (max < (menu->max - 1))
    max -= c_menu_context;
  else
    max = menu->max - 1;
 
  if (index < min)
    index = min;
  else if (index > max)
    index = max;
 
  return index;
}

Here is the call graph for this function:

Here is the caller graph for this function:

calc_move_view()

static int calc_move_view ( struct Menu * menu, int relative )

static

Move the view.

Parameters

menu	Menu
relative	Relative number of lines to move

Return values

num	Top line
0	Error

Definition at line 194 of file move.c.

{
  if (menu->max <= menu->page_len) // fewer entries than lines
    return 0;
 
  short c_menu_context = cs_subset_number(menu->sub, "menu_context");
  c_menu_context = MIN(c_menu_context, (menu->page_len / 2));
 
  int index = menu->current;
  if (index < c_menu_context)
    return 0;
 
  int top = menu->top + relative;
  if (top < 0)
    return 0;
 
  if ((menu->top + menu->page_len) < menu->max)
    return top;
 
  int max = menu->max - 1;
  const bool c_menu_move_off = cs_subset_bool(menu->sub, "menu_move_off");
  if (c_menu_move_off)
  {
    max -= c_menu_context;
  }
  else
  {
    max -= menu->page_len - 1;
  }
 
  if (top > max)
    top = max;
 
  return top;
}

Here is the call graph for this function:

Here is the caller graph for this function:

menu_move_selection()

MenuRedrawFlags menu_move_selection	(	struct Menu *	menu,
		int	index )

Move the selection, keeping within between [0, menu->max].

Parameters

menu	Menu
index	New selection

Return values

enum	MenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 236 of file move.c.

{
  if (menu->max == 0)
    return MENU_REDRAW_NONE;
 
  if (index < 0)
    index = 0;
  else if (index >= menu->max)
    index = menu->max - 1;
 
  int top = menu_drag_view(menu, menu->top, index);
 
  return menu_set_and_notify(menu, top, index);
}

Here is the call graph for this function:

Here is the caller graph for this function:

menu_move_view_relative()

MenuRedrawFlags menu_move_view_relative	(	struct Menu *	menu,
		int	relative )

Move the view relatively.

Parameters

menu	Menu
relative	Relative number of lines to move

Return values

enum	MenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 257 of file move.c.

{
  if (menu->max <= menu->page_len)
    return menu_move_selection(menu, menu->current + relative);
 
  const bool c_menu_move_off = cs_subset_bool(menu->sub, "menu_move_off");
 
  short c_menu_context = cs_subset_number(menu->sub, "menu_context");
  c_menu_context = MIN(c_menu_context, (menu->page_len / 2));
 
  // Move and range-check the view
  int top = menu->top + relative;
  if (top < 0)
  {
    top = 0;
  }
  else if (c_menu_move_off && (top >= (menu->max - c_menu_context)))
  {
    top = menu->max - c_menu_context - 1;
  }
  else if (!c_menu_move_off && ((top + menu->page_len) >= menu->max))
  {
    top = menu->max - menu->page_len;
  }
  if (top < 0)
    top = 0;
 
  // Move the selection on-screen
  int index = menu->current;
  if (index < top)
    index = top;
  else if (index >= (top + menu->page_len))
    index = top + menu->page_len - 1;
 
  // Check for top/bottom limits
  if (index < c_menu_context)
  {
    top = 0;
    index = menu->current;
  }
  else if (!c_menu_move_off && (index > (menu->max - c_menu_context)))
  {
    top = menu->max - menu->page_len;
    index = menu->current;
  }
 
  if (top == menu->top)
  {
    // Can't move the view; move the selection
    index = calc_fit_selection_to_view(menu, top, index + relative);
  }
  else if (index > (top + menu->page_len - c_menu_context - 1))
  {
    index = calc_fit_selection_to_view(menu, top, index + relative);
  }
  else
  {
    // Drag the selection into the view
    index = calc_fit_selection_to_view(menu, top, index);
  }
 
  return menu_set_and_notify(menu, top, index);
}

Here is the call graph for this function:

Here is the caller graph for this function:

menu_adjust()

void menu_adjust

(

struct Menu *

menu

)

Reapply the config to the Menu.

Parameters

menu

Menu

Definition at line 325 of file move.c.

{
  int top = calc_move_view(menu, 0);
  top = menu_drag_view(menu, top, menu->current);
 
  menu_set_and_notify(menu, top, menu->current);
}

Here is the call graph for this function:

Here is the caller graph for this function:

menu_top_page()

MenuRedrawFlags menu_top_page

(

struct Menu *

menu

)

Move the focus to the top of the page.

Parameters

menu	Current Menu

Return values

enum	MenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 339 of file move.c.

{
  return menu_move_selection(menu, menu->top);
}

Here is the call graph for this function:

Here is the caller graph for this function:

menu_middle_page()

MenuRedrawFlags menu_middle_page

(

struct Menu *

menu

)

Move the focus to the centre of the page.

Parameters

menu	Current Menu

Return values

enum	MenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 349 of file move.c.

{
  if (menu->max == 0)
  {
    mutt_error(_("No entries"));
    return MENU_REDRAW_NONE;
  }
 
  int i = menu->top + menu->page_len;
  if (i > (menu->max - 1))
    i = menu->max - 1;
 
  return menu_move_selection(menu, menu->top + (i - menu->top) / 2);
}

Here is the call graph for this function:

Here is the caller graph for this function:

menu_bottom_page()

MenuRedrawFlags menu_bottom_page

(

struct Menu *

menu

)

Move the focus to the bottom of the page.

Parameters

menu	Current Menu

Return values

enum	MenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 369 of file move.c.

{
  if (menu->max == 0)
  {
    mutt_error(_("No entries"));
    return MENU_REDRAW_NONE;
  }
 
  int index = menu->top + menu->page_len - 1;
  if (index > (menu->max - 1))
    index = menu->max - 1;
  return menu_move_selection(menu, index);
}

Here is the call graph for this function:

Here is the caller graph for this function:

menu_prev_entry()

MenuRedrawFlags menu_prev_entry	(	struct Menu *	menu,
		int	count )

Move the focus to the previous item in the menu.

Parameters

menu	Current Menu
count	Number of entries to move (0 = move by 1, show warning at boundary)

Return values

enum	MenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 389 of file move.c.

{
  if (count > 0)
    return menu_move_selection(menu, menu->current - count);
 
  if (menu->current > 0)
    return menu_move_selection(menu, menu->current - 1);
 
  mutt_message(_("You are on the first entry"));
  return MENU_REDRAW_NONE;
}

Here is the call graph for this function:

Here is the caller graph for this function:

menu_next_entry()

MenuRedrawFlags menu_next_entry	(	struct Menu *	menu,
		int	count )

Move the focus to the next item in the menu.

Parameters

menu	Current Menu
count	Number of entries to move (0 = move by 1, show warning at boundary)

Return values

enum	MenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 407 of file move.c.

{
  if (count > 0)
    return menu_move_selection(menu, menu->current + count);
 
  if (menu->current < (menu->max - 1))
    return menu_move_selection(menu, menu->current + 1);
 
  mutt_message(_("You are on the last entry"));
  return MENU_REDRAW_NONE;
}

Here is the call graph for this function:

Here is the caller graph for this function:

menu_first_entry()

MenuRedrawFlags menu_first_entry	(	struct Menu *	menu,
		int	count )

Move the focus to the first entry in the menu.

Parameters

menu	Current Menu
count	Jump to line N (1-based) if >0, otherwise go to first entry

Return values

enum	MenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 425 of file move.c.

{
  if (menu->max == 0)
  {
    mutt_error(_("No entries"));
    return MENU_REDRAW_NONE;
  }
 
  if (count > 0)
    return menu_move_selection(menu, count - 1);
 
  return menu_move_selection(menu, 0);
}

Here is the call graph for this function:

Here is the caller graph for this function:

menu_last_entry()

MenuRedrawFlags menu_last_entry	(	struct Menu *	menu,
		int	count )

Move the focus to the last entry in the menu.

Parameters

menu	Current Menu
count	Jump to line N (1-based) if >0, otherwise go to last entry

Return values

enum	MenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 445 of file move.c.

{
  if (menu->max == 0)
  {
    mutt_error(_("No entries"));
    return MENU_REDRAW_NONE;
  }
 
  if (count > 0)
    return menu_move_selection(menu, count - 1);
 
  return menu_move_selection(menu, menu->max - 1);
}

Here is the call graph for this function:

Here is the caller graph for this function:

menu_current_top()

MenuRedrawFlags menu_current_top

(

struct Menu *

menu

)

Move the current selection to the top of the window.

Parameters

menu	Current Menu

Return values

enum	MenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 465 of file move.c.

{
  if (menu->max == 0)
  {
    mutt_error(_("No entries"));
    return MENU_REDRAW_NONE;
  }
 
  short c_menu_context = cs_subset_number(menu->sub, "menu_context");
  if (c_menu_context > (menu->page_len / 2))
    return MENU_REDRAW_NONE;
 
  c_menu_context = MIN(c_menu_context, (menu->page_len / 2));
  return menu_move_view_relative(menu, menu->current - menu->top - c_menu_context);
}

Here is the call graph for this function:

Here is the caller graph for this function:

menu_current_middle()

MenuRedrawFlags menu_current_middle

(

struct Menu *

menu

)

Move the current selection to the centre of the window.

Parameters

menu	Current Menu

Return values

enum	MenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 486 of file move.c.

{
  if (menu->max == 0)
  {
    mutt_error(_("No entries"));
    return MENU_REDRAW_NONE;
  }
 
  short c_menu_context = cs_subset_number(menu->sub, "menu_context");
  if (c_menu_context > (menu->page_len / 2))
    return MENU_REDRAW_NONE;
 
  return menu_move_view_relative(menu, menu->current - (menu->top + (menu->page_len / 2)));
}

Here is the call graph for this function:

Here is the caller graph for this function:

menu_current_bottom()

MenuRedrawFlags menu_current_bottom

(

struct Menu *

menu

)

Move the current selection to the bottom of the window.

Parameters

menu	Current Menu

Return values

enum	MenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 506 of file move.c.

{
  if (menu->max == 0)
  {
    mutt_error(_("No entries"));
    return MENU_REDRAW_NONE;
  }
 
  short c_menu_context = cs_subset_number(menu->sub, "menu_context");
  if (c_menu_context > (menu->page_len / 2))
    return MENU_REDRAW_NONE;
 
  c_menu_context = MIN(c_menu_context, (menu->page_len / 2));
  return menu_move_view_relative(menu, 0 - (menu->top + menu->page_len - 1 -
                                            menu->current - c_menu_context));
}

Here is the call graph for this function:

Here is the caller graph for this function:

menu_half_up()

MenuRedrawFlags menu_half_up	(	struct Menu *	menu,
		int	count )

Move the focus up half a page in the menu.

Parameters

menu	Current Menu
count	Number of half-pages to move (0 = move by 1)

Return values

enum	MenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 529 of file move.c.

{
  return menu_move_view_relative(menu, 0 - MAX(count, 1) * (menu->page_len / 2));
}

Here is the call graph for this function:

Here is the caller graph for this function:

menu_half_down()

MenuRedrawFlags menu_half_down	(	struct Menu *	menu,
		int	count )

Move the focus down half a page in the menu.

Parameters

menu	Current Menu
count	Number of half-pages to move (0 = move by 1)

Return values

enum	MenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 540 of file move.c.

{
  return menu_move_view_relative(menu, MAX(count, 1) * (menu->page_len / 2));
}

Here is the call graph for this function:

Here is the caller graph for this function:

menu_prev_line()

MenuRedrawFlags menu_prev_line	(	struct Menu *	menu,
		int	count )

Move the view up one line, keeping the selection the same.

Parameters

menu	Current Menu
count	Number of lines to scroll (0 = scroll by 1, show warning at boundary)

Return values

enum	MenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 551 of file move.c.

{
  MenuRedrawFlags flags = menu_move_view_relative(menu, 0 - MAX(count, 1));
  if ((count == 0) && (flags == MENU_REDRAW_NONE))
    mutt_message(_("You can't scroll up farther"));
  return flags;
}

Here is the call graph for this function:

Here is the caller graph for this function:

menu_next_line()

MenuRedrawFlags menu_next_line	(	struct Menu *	menu,
		int	count )

Move the view down one line, keeping the selection the same.

Parameters

menu	Current Menu
count	Number of lines to scroll (0 = scroll by 1, show warning at boundary)

Return values

enum	MenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 565 of file move.c.

{
  MenuRedrawFlags flags = menu_move_view_relative(menu, MAX(count, 1));
  if ((count == 0) && (flags == MENU_REDRAW_NONE))
    mutt_message(_("You can't scroll down farther"));
  return flags;
}

Here is the call graph for this function:

Here is the caller graph for this function:

menu_prev_page()

MenuRedrawFlags menu_prev_page	(	struct Menu *	menu,
		int	count )

Move the focus to the previous page in the menu.

Parameters

menu	Current Menu
count	Number of pages to move (0 = move by 1)

Return values

enum	MenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 579 of file move.c.

{
  return menu_move_view_relative(menu, 0 - MAX(count, 1) * menu->page_len);
}

Here is the call graph for this function:

Here is the caller graph for this function:

menu_next_page()

MenuRedrawFlags menu_next_page	(	struct Menu *	menu,
		int	count )

Move the focus to the next page in the menu.

Parameters

menu	Current Menu
count	Number of pages to move (0 = move by 1)

Return values

enum	MenuRedrawFlags, e.g. MENU_REDRAW_CURRENT

Definition at line 590 of file move.c.

{
  return menu_move_view_relative(menu, MAX(count, 1) * menu->page_len);
}

Here is the call graph for this function:

Here is the caller graph for this function: