notify.c File Reference

Dump all notifications. More...

#include "config.h"
#include <stddef.h>
#include "mutt/lib.h"
#include "config/lib.h"
#include "email/lib.h"
#include "core/lib.h"
#include "gui/lib.h"
#include "lib.h"
#include "color/lib.h"

Include dependency graph for notify.c:

Go to the source code of this file.

Functions
static void	notify_dump_account (struct NotifyCallback *nc)
	Dump account notification.
static void	notify_dump_color (struct NotifyCallback *nc)
	Dump color notification.
static void	notify_dump_command (struct NotifyCallback *nc)
	Dump command notification.
static void	notify_dump_config (struct NotifyCallback *nc)
	Dump config notification.
static void	notify_dump_mview (struct NotifyCallback *nc)
	Dump mailbox view notification.
static void	notify_dump_email (struct NotifyCallback *nc)
	Dump email notification.
static void	notify_dump_global (struct NotifyCallback *nc)
	Dump global notification.
static void	notify_dump_mailbox (struct NotifyCallback *nc)
	Dump mailbox notification.
static void	notify_dump_window_state (struct NotifyCallback *nc)
	Dump window state notification.
static void	notify_dump_window_focus (struct NotifyCallback *nc)
	Dump window focus notification.
int	debug_all_observer (struct NotifyCallback *nc)
	Debug observer for all notifications.

Variables
const struct Mapping	ColorFields []
	Mapping of colour names to their IDs.

Detailed Description

Dump all notifications.

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

Function Documentation

notify_dump_account()

static void notify_dump_account ( struct NotifyCallback * nc )

static

Dump account notification.

Parameters

nc	Notification callback

Definition at line 45 of file notify.c.

{
  struct EventAccount *ev_a = nc->event_data;
  struct Account *a = ev_a->account;
  if (!a)
    return;
 
  mutt_debug(LL_DEBUG1, "    Account: %p (%s) %s\n", (void *) a,
             name_mailbox_type(a->type), NONULL(a->name));
}

Here is the call graph for this function:

Here is the caller graph for this function:

notify_dump_color()

static void notify_dump_color ( struct NotifyCallback * nc )

static

Dump color notification.

Parameters

nc	Notification callback

Definition at line 60 of file notify.c.

{
  struct EventColor *ev_c = nc->event_data;
 
  const char *color = NULL;
 
  if (ev_c->cid == MT_COLOR_MAX)
    color = "ALL";
 
  if (!color)
    color = mutt_map_get_name(ev_c->cid, ColorFields);
 
  if (!color)
    color = "UNKNOWN";
 
  mutt_debug(LL_DEBUG1, "    Color: %s %s (%d)\n",
             (nc->event_subtype == NT_COLOR_SET) ? "set" : "reset", color, ev_c->cid);
}

Here is the call graph for this function:

Here is the caller graph for this function:

notify_dump_command()

static void notify_dump_command ( struct NotifyCallback * nc )

static

Dump command notification.

Parameters

nc	Notification callback

Definition at line 83 of file notify.c.

{
  struct Command *cmd = nc->event_data;
 
  mutt_debug(LL_DEBUG1, "    Command: %s, (%s)\n", cmd->name, name_command_id(cmd->id));
}

Here is the call graph for this function:

Here is the caller graph for this function:

notify_dump_config()

static void notify_dump_config ( struct NotifyCallback * nc )

static

Dump config notification.

Parameters

nc	Notification callback

Definition at line 94 of file notify.c.

{
  struct EventConfig *ev_c = nc->event_data;
 
  struct Buffer *value = buf_pool_get();
  cs_he_string_get(ev_c->sub->cs, ev_c->he, value);
  mutt_debug(LL_DEBUG1, "    Config: %s %s = %s\n",
             name_notify_config(nc->event_subtype), ev_c->name, buf_string(value));
  buf_pool_release(&value);
}

Here is the call graph for this function:

Here is the caller graph for this function:

notify_dump_mview()

static void notify_dump_mview ( struct NotifyCallback * nc )

static

Dump mailbox view notification.

Parameters

nc	Notification callback

Definition at line 109 of file notify.c.

{
  struct EventMview *ev_m = nc->event_data;
 
  const char *path = "NONE";
  if (ev_m->mv && ev_m->mv->mailbox)
    path = mailbox_path(ev_m->mv->mailbox);
 
  mutt_debug(LL_DEBUG1, "    MailboxView: %s %s\n",
             name_notify_mview(nc->event_subtype), path);
}

Here is the call graph for this function:

Here is the caller graph for this function:

notify_dump_email()

static void notify_dump_email ( struct NotifyCallback * nc )

static

Dump email notification.

Parameters

nc	Notification callback

Definition at line 125 of file notify.c.

{
  struct EventEmail *ev_e = nc->event_data;
 
  mutt_debug(LL_DEBUG1, "    Email: %d\n", ev_e->num_emails);
  for (size_t i = 0; i < ev_e->num_emails; i++)
  {
    mutt_debug(LL_DEBUG1, "        : %p\n", (void *) ev_e->emails[i]);
  }
}

Here is the caller graph for this function:

notify_dump_global()

static void notify_dump_global ( struct NotifyCallback * nc )

static

Dump global notification.

Parameters

nc	Notification callback

Definition at line 140 of file notify.c.

{
  mutt_debug(LL_DEBUG1, "    Global: %s\n", name_notify_global(nc->event_subtype));
}

Here is the call graph for this function:

Here is the caller graph for this function:

notify_dump_mailbox()

static void notify_dump_mailbox ( struct NotifyCallback * nc )

static

Dump mailbox notification.

Parameters

nc	Notification callback

Definition at line 149 of file notify.c.

{
  struct EventMailbox *ev_m = nc->event_data;
 
  struct Mailbox *m = ev_m->mailbox;
  const char *path = m ? mailbox_path(m) : "";
  mutt_debug(LL_DEBUG1, "    Mailbox: %s %s\n",
             name_notify_mailbox(nc->event_subtype), path);
}

Here is the call graph for this function:

Here is the caller graph for this function:

notify_dump_window_state()

static void notify_dump_window_state ( struct NotifyCallback * nc )

static

Dump window state notification.

Parameters

nc	Notification callback

Definition at line 163 of file notify.c.

{
  struct EventWindow *ev_w = nc->event_data;
  const struct MuttWindow *win = ev_w->win;
  WindowNotifyFlags flags = ev_w->flags;
 
  struct Buffer *buf = buf_pool_get();
 
  buf_add_printf(buf, "[%s] ", mutt_window_win_name(win));
 
  if (flags & WN_VISIBLE)
    buf_addstr(buf, "visible ");
  if (flags & WN_HIDDEN)
    buf_addstr(buf, "hidden ");
 
  if (flags & WN_MOVED)
  {
    buf_add_printf(buf, "moved (C%d,R%d)->(C%d,R%d) ", win->old.col_offset,
                   win->old.row_offset, win->state.col_offset, win->state.row_offset);
  }
 
  if (flags & WN_TALLER)
    buf_add_printf(buf, "taller [%d->%d] ", win->old.rows, win->state.rows);
  if (flags & WN_SHORTER)
    buf_add_printf(buf, "shorter [%d->%d] ", win->old.rows, win->state.rows);
  if (flags & WN_WIDER)
    buf_add_printf(buf, "wider [%d->%d] ", win->old.cols, win->state.cols);
  if (flags & WN_NARROWER)
    buf_add_printf(buf, "narrower [%d->%d] ", win->old.cols, win->state.cols);
 
  mutt_debug(LL_DEBUG1, "    Window: %s\n", buf_string(buf));
 
  buf_pool_release(&buf);
}

Here is the call graph for this function:

Here is the caller graph for this function:

notify_dump_window_focus()

static void notify_dump_window_focus ( struct NotifyCallback * nc )

static

Dump window focus notification.

Parameters

nc	Notification callback

Definition at line 202 of file notify.c.

{
  struct EventWindow *ev_w = nc->event_data;
  struct MuttWindow *win = ev_w->win;
 
  struct Buffer *buf = buf_pool_get();
 
  buf_addstr(buf, "Focus: ");
 
  if (win)
  {
    struct MuttWindow *dlg = dialog_find(win);
    if (dlg && (dlg != win))
      buf_add_printf(buf, "%s:", mutt_window_win_name(dlg));
 
    buf_add_printf(buf, "%s ", mutt_window_win_name(win));
 
    buf_add_printf(buf, "(C%d,R%d) [%dx%d]", win->state.col_offset,
                   win->state.row_offset, win->state.cols, win->state.rows);
  }
  else
  {
    buf_addstr(buf, "NONE");
  }
 
  mutt_debug(LL_DEBUG1, "    Window: %s\n", buf_string(buf));
 
  buf_pool_release(&buf);
}

Here is the call graph for this function:

Here is the caller graph for this function:

debug_all_observer()

int debug_all_observer

(

struct NotifyCallback *

nc

)

Debug observer for all notifications.

Parameters

nc	Notification callback

Return values

0

Always

Definition at line 237 of file notify.c.

{
  mutt_debug(LL_DEBUG1, "\033[1;31mNotification:\033[0m %s\n",
             name_notify_type(nc->event_type));
 
  switch (nc->event_type)
  {
    case NT_ACCOUNT:
      notify_dump_account(nc);
      break;
    case NT_COLOR:
      notify_dump_color(nc);
      break;
    case NT_COMMAND:
      notify_dump_command(nc);
      break;
    case NT_CONFIG:
      notify_dump_config(nc);
      break;
    case NT_MVIEW:
      notify_dump_mview(nc);
      break;
    case NT_EMAIL:
      notify_dump_email(nc);
      break;
    case NT_GLOBAL:
      notify_dump_global(nc);
      break;
    case NT_MAILBOX:
      notify_dump_mailbox(nc);
      break;
    case NT_RESIZE:
    case NT_TIMEOUT:
      break; // no other data
    case NT_WINDOW:
      if (nc->event_subtype == NT_WINDOW_STATE)
        notify_dump_window_state(nc);
      else if (nc->event_subtype == NT_WINDOW_FOCUS)
        notify_dump_window_focus(nc);
      break;
    default:
      mutt_debug(LL_DEBUG1, "    Event Type: %d\n", nc->event_type);
      mutt_debug(LL_DEBUG1, "    Event Sub-type: %d\n", nc->event_subtype);
      mutt_debug(LL_DEBUG1, "    Event Data: %p\n", nc->event_data);
      break;
  }
 
  mutt_debug(LL_DEBUG1, "    Global Data: %p\n", nc->global_data);
 
  mutt_debug(LL_DEBUG5, "debug done\n");
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

ColorFields

const struct Mapping ColorFields[]

extern

Mapping of colour names to their IDs.

Definition at line 55 of file commands.c.

                                     {
  // clang-format off
  { "attachment",                MT_COLOR_ATTACHMENT },
  { "attach_headers",            MT_COLOR_ATTACH_HEADERS },
  { "body",                      MT_COLOR_BODY },
  { "bold",                      MT_COLOR_BOLD },
  { "compose_header",            MT_COLOR_COMPOSE_HEADER },
  { "compose_security_both",     MT_COLOR_COMPOSE_SECURITY_BOTH },
  { "compose_security_encrypt",  MT_COLOR_COMPOSE_SECURITY_ENCRYPT },
  { "compose_security_none",     MT_COLOR_COMPOSE_SECURITY_NONE },
  { "compose_security_sign",     MT_COLOR_COMPOSE_SECURITY_SIGN },
  { "error",                     MT_COLOR_ERROR },
  { "hdrdefault",                MT_COLOR_HDRDEFAULT },
  { "header",                    MT_COLOR_HEADER },
  { "index",                     MT_COLOR_INDEX },
  { "index_author",              MT_COLOR_INDEX_AUTHOR },
  { "index_collapsed",           MT_COLOR_INDEX_COLLAPSED },
  { "index_date",                MT_COLOR_INDEX_DATE },
  { "index_flags",               MT_COLOR_INDEX_FLAGS },
  { "index_label",               MT_COLOR_INDEX_LABEL },
  { "index_number",              MT_COLOR_INDEX_NUMBER },
  { "index_size",                MT_COLOR_INDEX_SIZE },
  { "index_subject",             MT_COLOR_INDEX_SUBJECT },
  { "index_tag",                 MT_COLOR_INDEX_TAG },
  { "index_tags",                MT_COLOR_INDEX_TAGS },
  { "indicator",                 MT_COLOR_INDICATOR },
  { "italic",                    MT_COLOR_ITALIC },
  { "markers",                   MT_COLOR_MARKERS },
  { "message",                   MT_COLOR_MESSAGE },
  { "normal",                    MT_COLOR_NORMAL },
  { "options",                   MT_COLOR_OPTIONS },
  { "progress",                  MT_COLOR_PROGRESS },
  { "prompt",                    MT_COLOR_PROMPT },
  { "quoted0",                   MT_COLOR_QUOTED0 },
  { "quoted1",                   MT_COLOR_QUOTED1 },
  { "quoted2",                   MT_COLOR_QUOTED2 },
  { "quoted3",                   MT_COLOR_QUOTED3 },
  { "quoted4",                   MT_COLOR_QUOTED4 },
  { "quoted5",                   MT_COLOR_QUOTED5 },
  { "quoted6",                   MT_COLOR_QUOTED6 },
  { "quoted7",                   MT_COLOR_QUOTED7 },
  { "quoted8",                   MT_COLOR_QUOTED8 },
  { "quoted9",                   MT_COLOR_QUOTED9 },
  { "search",                    MT_COLOR_SEARCH },
  { "sidebar_background",        MT_COLOR_SIDEBAR_BACKGROUND },
  { "sidebar_divider",           MT_COLOR_SIDEBAR_DIVIDER },
  { "sidebar_flagged",           MT_COLOR_SIDEBAR_FLAGGED },
  { "sidebar_highlight",         MT_COLOR_SIDEBAR_HIGHLIGHT },
  { "sidebar_indicator",         MT_COLOR_SIDEBAR_INDICATOR },
  { "sidebar_new",               MT_COLOR_SIDEBAR_NEW },
  { "sidebar_ordinary",          MT_COLOR_SIDEBAR_ORDINARY },
  { "sidebar_spool_file",        MT_COLOR_SIDEBAR_SPOOL_FILE },
  { "sidebar_unread",            MT_COLOR_SIDEBAR_UNREAD },
  { "signature",                 MT_COLOR_SIGNATURE },
  { "status",                    MT_COLOR_STATUS },
  { "stripe_even",               MT_COLOR_STRIPE_EVEN},
  { "stripe_odd",                MT_COLOR_STRIPE_ODD},
  { "tilde",                     MT_COLOR_TILDE },
  { "tree",                      MT_COLOR_TREE },
  { "underline",                 MT_COLOR_UNDERLINE },
  { "warning",                   MT_COLOR_WARNING },
  // Deprecated
  { "quoted",                    MT_COLOR_QUOTED0 },
  { "sidebar_spoolfile",         MT_COLOR_SIDEBAR_SPOOL_FILE },
  { NULL, 0 },
  // clang-format on
};