dlg_pattern.c

Go to the documentation of this file.

 
#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"
 
const struct ExpandoRenderData PatternRenderData[];
 
static const struct Mapping PatternHelp[] = {
  // clang-format off
  { N_("Exit"),   OP_EXIT },
  { N_("Select"), OP_GENERIC_SELECT_ENTRY },
  { N_("Help"),   OP_HELP },
  { NULL, 0 },
  // clang-format on
};
 
void pattern_d(const struct ExpandoNode *node, void *data,
               MuttFormatFlags flags, struct Buffer *buf)
{
  const struct PatternEntry *entry = data;
 
  const char *s = entry->desc;
  buf_strcpy(buf, s);
}
 
void pattern_e(const struct ExpandoNode *node, void *data,
               MuttFormatFlags flags, struct Buffer *buf)
{
  const struct PatternEntry *entry = data;
 
  const char *s = entry->expr;
  buf_strcpy(buf, s);
}
 
long pattern_n_num(const struct ExpandoNode *node, void *data, MuttFormatFlags flags)
{
  const struct PatternEntry *entry = data;
 
  return entry->num;
}
 
static int pattern_make_entry(struct Menu *menu, int line, int max_cols, struct Buffer *buf)
{
  struct PatternEntry *entry = &((struct PatternEntry *) menu->mdata)[line];
 
  const bool c_arrow_cursor = cs_subset_bool(menu->sub, "arrow_cursor");
  if (c_arrow_cursor)
  {
    const char *const c_arrow_string = cs_subset_string(menu->sub, "arrow_string");
    max_cols -= (mutt_strwidth(c_arrow_string) + 1);
  }
 
  const struct Expando *c_pattern_format = cs_subset_expando(NeoMutt->sub, "pattern_format");
  return expando_filter(c_pattern_format, PatternRenderData, entry,
                        MUTT_FORMAT_ARROWCURSOR, max_cols, buf);
}
 
static void free_pattern_menu(struct Menu *menu, void **ptr)
{
  struct PatternEntry *entries = *ptr;
 
  for (size_t i = 0; i < menu->max; i++)
  {
    FREE(&entries[i].tag);
    FREE(&entries[i].expr);
    FREE(&entries[i].desc);
  }
 
  FREE(ptr);
}
 
static struct Menu *create_pattern_menu(struct MuttWindow *dlg)
{
  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 = pattern_make_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;
}
 
static int pattern_config_observer(struct NotifyCallback *nc)
{
  if (nc->event_type != NT_CONFIG)
    return 0;
  if (!nc->global_data || !nc->event_data)
    return -1;
 
  struct EventConfig *ev_c = nc->event_data;
 
  if (!mutt_str_equal(ev_c->name, "pattern_format"))
    return 0;
 
  struct Menu *menu = nc->global_data;
  menu_queue_redraw(menu, MENU_REDRAW_FULL);
  mutt_debug(LL_DEBUG5, "config done, request WA_RECALC, MENU_REDRAW_FULL\n");
 
  return 0;
}
 
static int pattern_window_observer(struct NotifyCallback *nc)
{
  if (nc->event_type != NT_WINDOW)
    return 0;
  if (!nc->global_data || !nc->event_data)
    return -1;
  if (nc->event_subtype != NT_WINDOW_DELETE)
    return 0;
 
  struct MuttWindow *win_menu = nc->global_data;
  struct EventWindow *ev_w = nc->event_data;
  if (ev_w->win != win_menu)
    return 0;
 
  struct Menu *menu = win_menu->wdata;
 
  notify_observer_remove(NeoMutt->sub->notify, pattern_config_observer, menu);
  notify_observer_remove(win_menu->notify, pattern_window_observer, win_menu);
 
  mutt_debug(LL_DEBUG5, "window delete done\n");
  return 0;
}
 
bool dlg_pattern(char *buf, size_t buflen)
{
  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->sub->notify, NT_CONFIG, pattern_config_observer, menu);
  notify_observer_add(menu->win->notify, NT_WINDOW, pattern_window_observer, menu->win);
 
  struct MuttWindow *old_focus = window_set_focus(menu->win);
  // ---------------------------------------------------------------------------
  // Event Loop
  int op = OP_NULL;
  do
  {
    menu_tagging_dispatcher(menu->win, op);
    window_redraw(NULL);
 
    op = km_dokey(MENU_DIALOG, GETCH_NO_FLAGS);
    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);
  // ---------------------------------------------------------------------------
 
  window_set_focus(old_focus);
  simple_dialog_free(&dlg);
  return pd.selection;
}
 
const struct ExpandoRenderData PatternRenderData[] = {
  // clang-format off
  { 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 },
  // clang-format on
};