dlg_pattern.c File Reference

Pattern Selection Dialog. More...

#include "config.h"
#include <stdbool.h>
#include <stddef.h>
#include "private.h"
#include "mutt/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "gui/lib.h"
#include "lib.h"
#include "expando/lib.h"
#include "key/lib.h"
#include "menu/lib.h"
#include "functions.h"
#include "mutt_logging.h"
#include "pattern_data.h"

Include dependency graph for dlg_pattern.c:

Go to the source code of this file.

Functions
void	pattern_d (const struct ExpandoNode *node, void *data, MuttFormatFlags flags, struct Buffer *buf)
	Pattern: pattern description - Implements ExpandoRenderData::get_string() -.
void	pattern_e (const struct ExpandoNode *node, void *data, MuttFormatFlags flags, struct Buffer *buf)
	Pattern: pattern expression - Implements ExpandoRenderData::get_string() -.
long	pattern_n_num (const struct ExpandoNode *node, void *data, MuttFormatFlags flags)
	Pattern: Index number - Implements ExpandoRenderData::get_number() -.
static int	pattern_make_entry (struct Menu *menu, int line, int max_cols, struct Buffer *buf)
	Create a Pattern for the Menu - Implements Menu::make_entry() -.
static void	create_pattern_entries (struct PatternEntryArray *pea)
	Create the Pattern Entries.
static int	pattern_config_observer (struct NotifyCallback *nc)
	Notification that a Config Variable has changed - Implements observer_t -.
static int	pattern_window_observer (struct NotifyCallback *nc)
	Notification that a Window has changed - Implements observer_t -.
bool	dlg_pattern (struct Buffer *buf)
	Show menu to select a Pattern -.

Variables
const struct ExpandoRenderData	PatternRenderData []
	Callbacks for Pattern Expandos.
static const struct Mapping	PatternHelp []
	Help Bar for the Pattern selection dialog.

Detailed Description

Pattern Selection Dialog.

Authors

• Pietro Cerutti
• Richard Russon
• Tóth János

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_entries()

static void create_pattern_entries ( struct PatternEntryArray *  pea )

static

Create the Pattern Entries.

Parameters

pea	Pattern Entry Array to fill

Definition at line 160 of file dlg_pattern.c.

{
  int num_entries = 0;
  while (Flags[num_entries].tag != 0)
    num_entries++;
 
  /* Add three more hard-coded entries */
  ARRAY_RESERVE(pea, num_entries + 3);
 
  struct Buffer *buf = buf_pool_get();
 
  struct PatternEntry entry = { 0 };
  for (int i = 0; Flags[i].tag != '\0'; i++)
  {
    entry.num = i + 1;
 
    buf_printf(buf, "~%c", Flags[i].tag);
    entry.tag = buf_strdup(buf);
 
    switch (Flags[i].eat_arg)
    {
      case EAT_REGEX:
        /* L10N:
           Pattern Completion Menu argument type: a regular expression
        */
        buf_add_printf(buf, " %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(buf, " %s", _("RANGE"));
        break;
      case EAT_DATE:
        /* L10N:
           Pattern Completion Menu argument type: a date range
           Used by ~d, ~r.
        */
        buf_add_printf(buf, " %s", _("DATERANGE"));
        break;
      case EAT_QUERY:
        /* L10N:
           Pattern Completion Menu argument type: a query
           Used by ~I.
        */
        buf_add_printf(buf, " %s", _("QUERY"));
        break;
      default:
        break;
    }
 
    entry.expr = buf_strdup(buf);
    entry.desc = mutt_str_dup(_(Flags[i].desc));
 
    ARRAY_ADD(pea, entry);
  }
 
  /* 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");
 
  entry.num = ARRAY_SIZE(pea) + 1;
  entry.tag = mutt_str_dup("~()");
  buf_printf(buf, "~(%s)", patternstr);
  entry.expr = buf_strdup(buf);
  // L10N: Pattern Completion Menu description for ~()
  entry.desc = mutt_str_dup(_("messages in threads containing messages matching PATTERN"));
  ARRAY_ADD(pea, entry);
 
  entry.num = ARRAY_SIZE(pea) + 1;
  entry.tag = mutt_str_dup("~<()");
  buf_printf(buf, "~<(%s)", patternstr);
  entry.expr = buf_strdup(buf);
  // L10N: Pattern Completion Menu description for ~<()
  entry.desc = mutt_str_dup(_("messages whose immediate parent matches PATTERN"));
  ARRAY_ADD(pea, entry);
 
  entry.num = ARRAY_SIZE(pea) + 1;
  entry.tag = mutt_str_dup("~>()");
  buf_printf(buf, "~>(%s)", patternstr);
  entry.expr = buf_strdup(buf);
  // L10N: Pattern Completion Menu description for ~>()
  entry.desc = mutt_str_dup(_("messages having an immediate child matching PATTERN"));
  ARRAY_ADD(pea, entry);
 
  buf_pool_release(&buf);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

PatternRenderData

const struct ExpandoRenderData PatternRenderData

Initial value:

= {
  
  { ED_PATTERN, ED_PAT_DESCRIPTION, pattern_d,     NULL },
  { ED_PATTERN, ED_PAT_EXPRESION,   pattern_e,     NULL },
  { ED_PATTERN, ED_PAT_NUMBER,      NULL,          pattern_n_num },
  { -1, -1, NULL, NULL },
  
}

Callbacks for Pattern Expandos.

See also

PatternFormatDef, ExpandoDataGlobal, ExpandoDataPattern

Definition at line 86 of file dlg_pattern.c.

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.