helpbar.c File Reference

Help Bar. More...

#include "config.h"
#include <stdbool.h>
#include <stddef.h>
#include <stdio.h>
#include "private.h"
#include "mutt/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "gui/lib.h"
#include "lib.h"
#include "color/lib.h"
#include "key/lib.h"
#include "menu/lib.h"

Include dependency graph for helpbar.c:

Go to the source code of this file.

Functions
static bool	make_help (char *buf, size_t buflen, const char *txt, enum MenuType menu, int op)
	Create one entry for the Help Bar.
static char *	compile_help (char *buf, size_t buflen, enum MenuType menu, const struct Mapping *items)
	Create the text for the help menu.
static int	helpbar_recalc (struct MuttWindow *win)
	Recalculate the display of the Help Bar - Implements MuttWindow::recalc() -.
static int	helpbar_repaint (struct MuttWindow *win)
	Redraw the Help Bar - Implements MuttWindow::repaint() -.
static int	helpbar_binding_observer (struct NotifyCallback *nc)
	Notification that a Key Binding has changed - Implements observer_t -.
static int	helpbar_color_observer (struct NotifyCallback *nc)
	Notification that a Color has changed - Implements observer_t -.
static int	helpbar_config_observer (struct NotifyCallback *nc)
	Notification that a Config Variable has changed - Implements observer_t -.
static int	helpbar_window_observer (struct NotifyCallback *nc)
	Notification that a Window has changed - Implements observer_t -.
struct MuttWindow *	helpbar_new (void)
	Create the Help Bar Window.

Detailed Description

Help Bar.

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 helpbar.c.

Function Documentation

make_help()

static bool make_help ( char *  buf, size_t  buflen, const char *  txt, enum MenuType  menu, int  op  )

static

Create one entry for the Help Bar.

Parameters

buf	Buffer for the result
buflen	Length of buffer
txt	Text part, e.g. "delete"
menu	Current Menu, e.g. MENU_PAGER
op	Operation, e.g. OP_DELETE

Return values

true	The keybinding exists

This will return something like: "d:delete"

Definition at line 92 of file helpbar.c.

{
  char tmp[128] = { 0 };
 
  if (km_expand_key(tmp, sizeof(tmp), km_find_func(menu, op)) ||
      km_expand_key(tmp, sizeof(tmp), km_find_func(MENU_GENERIC, op)))
  {
    snprintf(buf, buflen, "%s:%s", tmp, txt);
    return true;
  }
 
  buf[0] = '\0';
  return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

compile_help()

static char * compile_help ( char *  buf, size_t  buflen, enum MenuType  menu, const struct Mapping *  items  )

static

Create the text for the help menu.

Parameters

buf	Buffer for the result
buflen	Length of buffer
menu	Current Menu, e.g. MENU_PAGER
items	Map of functions to display in the Help Bar

Return values

ptr	Buffer containing result

Definition at line 115 of file helpbar.c.

{
  char *pbuf = buf;
 
  for (int i = 0; items[i].name && (buflen > 2); i++)
  {
    if (!make_help(pbuf, buflen, _(items[i].name), menu, items[i].value))
      continue;
 
    const size_t len = mutt_str_len(pbuf);
    pbuf += len;
    buflen -= len;
 
    *pbuf++ = ' ';
    *pbuf++ = ' ';
    buflen -= 2;
  }
  return buf;
}

Here is the call graph for this function:

Here is the caller graph for this function:

helpbar_new()

struct MuttWindow * helpbar_new

(

void

)

Create the Help Bar Window.

Return values

ptr	New Window

Note

The Window can be freed with mutt_window_free().

Definition at line 333 of file helpbar.c.

{
  struct MuttWindow *win = mutt_window_new(WT_HELP_BAR, MUTT_WIN_ORIENT_VERTICAL,
                                           MUTT_WIN_SIZE_FIXED,
                                           MUTT_WIN_SIZE_UNLIMITED, 1);
  win->state.visible = cs_subset_bool(NeoMutt->sub, "help");
 
  win->recalc = helpbar_recalc;
  win->repaint = helpbar_repaint;
 
  win->wdata = helpbar_wdata_new();
  win->wdata_free = helpbar_wdata_free;
 
  mutt_color_observer_add(helpbar_color_observer, win);
  notify_observer_add(NeoMutt->notify, NT_BINDING, helpbar_binding_observer, win);
  notify_observer_add(NeoMutt->sub->notify, NT_CONFIG, helpbar_config_observer, win);
  notify_observer_add(RootWindow->notify, NT_WINDOW, helpbar_window_observer, win);
  return win;
}

Here is the call graph for this function:

Here is the caller graph for this function: