mutt_history.c File Reference

Read/write command history from/to a file. More...

#include "config.h"
#include <stdbool.h>
#include <stdio.h>
#include "mutt/mutt.h"
#include "config/lib.h"
#include "gui/lib.h"
#include "mutt.h"
#include "mutt_history.h"
#include "format_flags.h"
#include "globals.h"
#include "keymap.h"
#include "mutt_menu.h"
#include "muttlib.h"
#include "opcodes.h"

Include dependency graph for mutt_history.c:

Go to the source code of this file.

Functions
static const char *	history_format_str (char *buf, size_t buflen, size_t col, int cols, char op, const char *src, const char *prec, const char *if_str, const char *else_str, unsigned long data, MuttFormatFlags flags)
	Format a string for the history list - Implements format_t. More...
static void	history_make_entry (char *buf, size_t buflen, struct Menu *menu, int line)
	Format a menu item for the history list - Implements Menu::menu_make_entry() More...
static void	history_menu (char *buf, size_t buflen, char **matches, int match_count)
	Select an item from a history list. More...
void	mutt_hist_complete (char *buf, size_t buflen, enum HistoryClass hclass)
	Complete a string from a history list. More...
int	mutt_hist_observer (struct NotifyCallback *nc)
	Listen for config changes affecting the history - Implements observer_t() More...

Variables
static const struct Mapping	HistoryHelp []

Detailed Description

Read/write command history from/to a file.

Authors

• Michael R. Elkins

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

Function Documentation

history_format_str()

static const char* history_format_str ( char *  buf, size_t  buflen, size_t  col, int  cols, char  op, const char *  src, const char *  prec, const char *  if_str, const char *  else_str, unsigned long  data, MuttFormatFlags  flags  )

static

Format a string for the history list - Implements format_t.

Expando	Description
%s	History match

Definition at line 59 of file mutt_history.c.

{
  char *match = (char *) data;

  switch (op)
  {
    case 's':
      mutt_format_s(buf, buflen, prec, match);
      break;
  }

  return src;
}

Here is the call graph for this function:

Here is the caller graph for this function:

history_make_entry()

static void history_make_entry ( char *  buf, size_t  buflen, struct Menu *  menu, int  line  )

static

Format a menu item for the history list - Implements Menu::menu_make_entry()

Definition at line 79 of file mutt_history.c.

{
  char *entry = ((char **) menu->data)[line];

  mutt_expando_format(buf, buflen, 0, menu->win_index->state.cols, "%s", history_format_str,
                      (unsigned long) entry, MUTT_FORMAT_ARROWCURSOR);
}

Here is the call graph for this function:

Here is the caller graph for this function:

history_menu()

static void history_menu ( char *  buf, size_t  buflen, char **  matches, int  match_count  )

static

Select an item from a history list.

Parameters

[in]	buf	Buffer in which to save string
[in]	buflen	Buffer length
[out]	matches	Items to choose from
[in]	match_count	Number of items

Definition at line 94 of file mutt_history.c.

{
  bool done = false;
  char helpstr[1024];
  char title[256];

  snprintf(title, sizeof(title), _("History '%s'"), buf);

  struct MuttWindow *dlg =
      mutt_window_new(MUTT_WIN_ORIENT_VERTICAL, MUTT_WIN_SIZE_MAXIMISE,
                      MUTT_WIN_SIZE_UNLIMITED, MUTT_WIN_SIZE_UNLIMITED);
  dlg->type = WT_DIALOG;
  struct MuttWindow *index =
      mutt_window_new(MUTT_WIN_ORIENT_VERTICAL, MUTT_WIN_SIZE_MAXIMISE,
                      MUTT_WIN_SIZE_UNLIMITED, MUTT_WIN_SIZE_UNLIMITED);
  index->type = WT_INDEX;
  struct MuttWindow *ibar = mutt_window_new(
      MUTT_WIN_ORIENT_VERTICAL, MUTT_WIN_SIZE_FIXED, 1, MUTT_WIN_SIZE_UNLIMITED);
  ibar->type = WT_INDEX_BAR;

  if (C_StatusOnTop)
  {
    mutt_window_add_child(dlg, ibar);
    mutt_window_add_child(dlg, index);
  }
  else
  {
    mutt_window_add_child(dlg, index);
    mutt_window_add_child(dlg, ibar);
  }

  dialog_push(dlg);

  struct Menu *menu = mutt_menu_new(MENU_GENERIC);

  menu->pagelen = index->state.rows;
  menu->win_index = index;
  menu->win_ibar = ibar;

  menu->menu_make_entry = history_make_entry;
  menu->title = title;
  menu->help = mutt_compile_help(helpstr, sizeof(helpstr), MENU_GENERIC, HistoryHelp);
  mutt_menu_push_current(menu);

  menu->max = match_count;
  menu->data = matches;

  while (!done)
  {
    switch (mutt_menu_loop(menu))
    {
      case OP_GENERIC_SELECT_ENTRY:
        mutt_str_strfcpy(buf, matches[menu->current], buflen);
        /* fall through */

      case OP_EXIT:
        done = true;
        break;
    }
  }

  mutt_menu_pop_current(menu);
  mutt_menu_free(&menu);
  dialog_pop();
  mutt_window_free(&dlg);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_hist_complete()

void mutt_hist_complete	(	char *	buf,
		size_t	buflen,
		enum HistoryClass	hclass
	)

Complete a string from a history list.

Parameters

buf	Buffer in which to save string
buflen	Buffer length
hclass	History list to use

Definition at line 167 of file mutt_history.c.

{
  char **matches = mutt_mem_calloc(C_History, sizeof(char *));
  int match_count = mutt_hist_search(buf, hclass, matches);
  if (match_count)
  {
    if (match_count == 1)
      mutt_str_strfcpy(buf, matches[0], buflen);
    else
      history_menu(buf, buflen, matches, match_count);
  }
  FREE(&matches);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_hist_observer()

int mutt_hist_observer

(

struct NotifyCallback *

nc

)

Listen for config changes affecting the history - Implements observer_t()

Definition at line 184 of file mutt_history.c.

{
  if (!nc->event_data)
    return -1;
  if (nc->event_type != NT_CONFIG)
    return 0;

  struct EventConfig *ec = nc->event_data;

  if (mutt_str_strcmp(ec->name, "history") != 0)
    return 0;

  mutt_hist_init();
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

HistoryHelp

const struct Mapping HistoryHelp[]

static

Initial value:

= {
  { N_("Exit"), OP_EXIT },
  { N_("Select"), OP_GENERIC_SELECT_ENTRY },
  { N_("Search"), OP_SEARCH },
  { N_("Help"), OP_HELP },
  { NULL, 0 },
}

Definition at line 44 of file mutt_history.c.