dlg_pattern.c File Reference

Pattern Selection Dialog. More...

#include "config.h"
#include <stddef.h>
#include <stdbool.h>
#include <stdint.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 "menu/lib.h"
#include "format_flags.h"
#include "functions.h"
#include "keymap.h"
#include "mutt_logging.h"
#include "muttlib.h"
#include "opcodes.h"

Include dependency graph for dlg_pattern.c:

Go to the source code of this file.

Functions
static const char *	pattern_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, intptr_t data, MuttFormatFlags flags)
	Format a string for the pattern completion menu - Implements format_t -. More...
static void	make_pattern_entry (struct Menu *menu, char *buf, size_t buflen, int num)
	Create a line for the Pattern Completion menu - Implements Menu::make_entry() -. More...
static void	free_pattern_menu (struct Menu *menu, void **ptr)
	Free the Pattern Completion menu - Implements Menu::mdata_free() -. More...
static struct Menu *	create_pattern_menu (struct MuttWindow *dlg)
	Create the Pattern Completion menu. More...
static int	pattern_config_observer (struct NotifyCallback *nc)
	Notification that a Config Variable has changed - Implements observer_t -. More...
static int	pattern_window_observer (struct NotifyCallback *nc)
	Notification that a Window has changed - Implements observer_t -. More...
bool	dlg_select_pattern (char *buf, size_t buflen)
	Show menu to select a Pattern. More...

Variables
static const struct Mapping	PatternHelp []
	Help Bar for the Pattern selection dialog. More...

Detailed Description

Pattern Selection Dialog.

Authors

• Michael R. Elkins
• Pietro Cerutti

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

Function Documentation

create_pattern_menu()

static struct Menu * create_pattern_menu ( struct MuttWindow *  dlg )

static

Create the Pattern Completion menu.

Parameters

dlg	Dialog holding the Menu

Return values

ptr

New Menu

Definition at line 170 of file dlg_pattern.c.

{
  int num_entries = 0, i = 0;
  struct Buffer *entrybuf = NULL;
 
  while (Flags[num_entries].tag)
    num_entries++;
  /* Add three more hard-coded entries */
  num_entries += 3;
  struct PatternEntry *entries = mutt_mem_calloc(num_entries, sizeof(struct PatternEntry));
 
  struct Menu *menu = dlg->wdata;
  menu->make_entry = make_pattern_entry;
  menu->mdata = entries;
  menu->mdata_free = free_pattern_menu;
  menu->max = num_entries;
 
  struct MuttWindow *sbar = window_find_child(dlg, WT_STATUS_BAR);
  // L10N: Pattern completion menu title
  sbar_set_title(sbar, _("Patterns"));
 
  entrybuf = buf_pool_get();
  while (Flags[i].tag)
  {
    entries[i].num = i + 1;
 
    buf_printf(entrybuf, "~%c", (char) Flags[i].tag);
    entries[i].tag = mutt_str_dup(buf_string(entrybuf));
 
    switch (Flags[i].eat_arg)
    {
      case EAT_REGEX:
        /* L10N:
           Pattern Completion Menu argument type: a regular expression
        */
        buf_add_printf(entrybuf, " %s", _("EXPR"));
        break;
      case EAT_RANGE:
      case EAT_MESSAGE_RANGE:
        /* L10N:
           Pattern Completion Menu argument type: a numeric range.
           Used by ~m, ~n, ~X, ~z.
        */
        buf_add_printf(entrybuf, " %s", _("RANGE"));
        break;
      case EAT_DATE:
        /* L10N:
           Pattern Completion Menu argument type: a date range
           Used by ~d, ~r.
        */
        buf_add_printf(entrybuf, " %s", _("DATERANGE"));
        break;
      case EAT_QUERY:
        /* L10N:
           Pattern Completion Menu argument type: a query
           Used by ~I.
        */
        buf_add_printf(entrybuf, " %s", _("QUERY"));
        break;
      default:
        break;
    }
    entries[i].expr = mutt_str_dup(buf_string(entrybuf));
    entries[i].desc = mutt_str_dup(_(Flags[i].desc));
 
    i++;
  }
 
  /* Add struct MuttThread patterns manually.
   * Note we allocated 3 extra slots for these above. */
 
  /* L10N:
     Pattern Completion Menu argument type: a nested pattern.
     Used by ~(), ~<(), ~>().
  */
  const char *patternstr = _("PATTERN");
 
  entries[i].num = i + 1;
  entries[i].tag = mutt_str_dup("~()");
  buf_printf(entrybuf, "~(%s)", patternstr);
  entries[i].expr = mutt_str_dup(buf_string(entrybuf));
  // L10N: Pattern Completion Menu description for ~()
  entries[i].desc = mutt_str_dup(_("messages in threads containing messages matching PATTERN"));
  i++;
 
  entries[i].num = i + 1;
  entries[i].tag = mutt_str_dup("~<()");
  buf_printf(entrybuf, "~<(%s)", patternstr);
  entries[i].expr = mutt_str_dup(buf_string(entrybuf));
  // L10N: Pattern Completion Menu description for ~<()
  entries[i].desc = mutt_str_dup(_("messages whose immediate parent matches PATTERN"));
  i++;
 
  entries[i].num = i + 1;
  entries[i].tag = mutt_str_dup("~>()");
  buf_printf(entrybuf, "~>(%s)", patternstr);
  entries[i].expr = mutt_str_dup(buf_string(entrybuf));
  // L10N: Pattern Completion Menu description for ~>()
  entries[i].desc = mutt_str_dup(_("messages having an immediate child matching PATTERN"));
 
  buf_pool_release(&entrybuf);
 
  return menu;
}

Here is the call graph for this function:

Here is the caller graph for this function:

dlg_select_pattern()

bool dlg_select_pattern	(	char *	buf,
		size_t	buflen
	)

Show menu to select a Pattern.

Parameters

buf	Buffer for the selected Pattern
buflen	Length of buffer

Return values

true	A selection was made

Definition at line 335 of file dlg_pattern.c.

{
  struct MuttWindow *dlg = simple_dialog_new(MENU_GENERIC, WT_DLG_PATTERN, PatternHelp);
  struct Menu *menu = create_pattern_menu(dlg);
 
  struct PatternData pd = { false, false, buf, buflen, menu };
  dlg->wdata = &pd;
 
  // NT_COLOR is handled by the SimpleDialog
  notify_observer_add(NeoMutt->notify, NT_CONFIG, pattern_config_observer, menu);
  notify_observer_add(menu->win->notify, NT_WINDOW, pattern_window_observer, menu->win);
 
  // ---------------------------------------------------------------------------
  // Event Loop
  int op = OP_NULL;
  do
  {
    menu_tagging_dispatcher(menu->win, op);
    window_redraw(NULL);
 
    struct KeyEvent event = km_dokey_event(MENU_GENERIC);
    if (event.ch == 'q')
      op = OP_EXIT;
    else
      op = event.op;
 
    mutt_debug(LL_DEBUG1, "Got op %s (%d)\n", opcodes_get_name(op), op);
    if (op < 0)
      continue;
    if (op == OP_NULL)
    {
      km_error_key(MENU_GENERIC);
      continue;
    }
    mutt_clear_error();
 
    int rc = pattern_function_dispatcher(dlg, op);
 
    if (rc == FR_UNKNOWN)
      rc = menu_function_dispatcher(menu->win, op);
    if (rc == FR_UNKNOWN)
      rc = global_function_dispatcher(NULL, op);
  } while (!pd.done);
  // ---------------------------------------------------------------------------
 
  simple_dialog_free(&dlg);
  return pd.selection;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

PatternHelp

const struct Mapping PatternHelp[]

static

Initial value:

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

Help Bar for the Pattern selection dialog.

Definition at line 89 of file dlg_pattern.c.