dlg_compose.c File Reference

Compose Email Dialog. More...

#include "config.h"
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include "private.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 "attach/lib.h"
#include "envelope/lib.h"
#include "hooks/lib.h"
#include "index/lib.h"
#include "key/lib.h"
#include "menu/lib.h"
#include "ncrypt/lib.h"
#include "attach_data.h"
#include "cbar.h"
#include "functions.h"
#include "globals.h"
#include "mutt_logging.h"
#include "shared_data.h"

Include dependency graph for dlg_compose.c:

Go to the source code of this file.

Functions
static int	compose_recalc (struct MuttWindow *dlg)
	Recalculate the Window data - Implements MuttWindow::recalc() -.
static int	compose_config_observer (struct NotifyCallback *nc)
	Notification that a Config Variable has changed - Implements observer_t -.
static int	compose_email_observer (struct NotifyCallback *nc)
	Notification that an Email has changed - Implements observer_t -.
static int	compose_window_observer (struct NotifyCallback *nc)
	Notification that a Window has changed - Implements observer_t -.
static void	gen_attach_list (struct AttachCtx *actx, struct Body *b, int parent_type, int level)
	Generate the attachment list for the compose screen.
void	update_menu (struct AttachCtx *actx, struct Menu *menu, bool init)
	Redraw the compose window.
static struct MuttWindow *	compose_dlg_init (struct ConfigSubset *sub, struct Email *e, struct Buffer *fcc)
	Allocate the Windows for Compose.
int	dlg_compose (struct Email *e, struct Buffer *fcc, uint8_t flags, struct ConfigSubset *sub)
	Allow the user to edit the message envelope -.

Variables
static const struct Mapping	ComposeHelp []
	Help Bar for the Compose dialog.
static const struct Mapping	ComposeNewsHelp []
	Help Bar for the News Compose dialog.

Detailed Description

Compose Email Dialog.

Authors

• Richard Russon
• Pietro Cerutti
• Dennis Schön

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

Function Documentation

gen_attach_list()

static void gen_attach_list ( struct AttachCtx * actx, struct Body * b, int parent_type, int level )

static

Generate the attachment list for the compose screen.

Parameters

actx	Attachment context
b	Attachment
parent_type	Attachment type, e.g TYPE_MULTIPART
level	Nesting depth of attachment

Note

Recursion is limited to 20 levels to prevent stack overflow from deeply nested MIME structures.

Definition at line 261 of file dlg_compose.c.

{
  const int max_depth = 20;
 
  for (; b; b = b->next)
  {
    struct AttachPtr *ap = mutt_aptr_new();
    mutt_actx_add_attach(actx, ap);
    ap->body = b;
    b->aptr = ap;
    ap->parent_type = parent_type;
    ap->level = level;
    if ((level < max_depth) && (b->type == TYPE_MULTIPART) && b->parts &&
        (!(WithCrypto & APPLICATION_PGP) || !mutt_is_multipart_encrypted(b)))
    {
      gen_attach_list(actx, b->parts, b->type, level + 1);
    }
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

update_menu()

void update_menu	(	struct AttachCtx *	actx,
		struct Menu *	menu,
		bool	init )

Redraw the compose window.

Parameters

actx	Attachment context
menu	Current menu
init	If true, initialise the attachment list

Definition at line 287 of file dlg_compose.c.

{
  if (init)
  {
    gen_attach_list(actx, actx->email->body, -1, 0);
    mutt_attach_init(actx);
 
    struct ComposeAttachData *adata = menu->mdata;
    adata->actx = actx;
  }
 
  mutt_update_tree(actx);
 
  menu->max = actx->vcount;
  if (menu->max)
  {
    int index = menu_get_index(menu);
    if (index >= menu->max)
      menu_set_index(menu, menu->max - 1);
  }
  else
  {
    menu_set_index(menu, 0);
  }
 
  menu_queue_redraw(menu, MENU_REDRAW_INDEX);
}

Here is the call graph for this function:

Here is the caller graph for this function:

compose_dlg_init()

static struct MuttWindow * compose_dlg_init ( struct ConfigSubset * sub, struct Email * e, struct Buffer * fcc )

static

Allocate the Windows for Compose.

Parameters

sub	ConfigSubset
e	Email
fcc	Buffer to save FCC

Return values

ptr	Dialog containing nested Windows

Definition at line 322 of file dlg_compose.c.

{
  struct ComposeSharedData *shared = compose_shared_data_new();
  shared->sub = sub;
  shared->email = e;
 
  struct MuttWindow *dlg = mutt_window_new(WT_DLG_COMPOSE, MUTT_WIN_ORIENT_VERTICAL,
                                           MUTT_WIN_SIZE_MAXIMISE, MUTT_WIN_SIZE_UNLIMITED,
                                           MUTT_WIN_SIZE_UNLIMITED);
  dlg->wdata = shared;
  dlg->wdata_free = compose_shared_data_free;
  dlg->recalc = compose_recalc;
 
  struct MuttWindow *win_env = env_window_new(e, fcc, sub);
  struct MuttWindow *win_attach = attach_new(dlg, shared);
  struct MuttWindow *win_cbar = cbar_new(shared);
  struct MuttWindow *win_abar = sbar_new();
  sbar_set_title(win_abar, _("-- Attachments"));
  struct MuttWindow *win_preview_bar = sbar_new();
  sbar_set_title(win_preview_bar, _("-- Preview"));
  struct MuttWindow *win_preview = preview_window_new(e, win_preview_bar);
 
  const bool c_preview_above_attachments = cs_subset_bool(shared->sub, "compose_preview_above_attachments");
  const bool c_status_on_top = cs_subset_bool(sub, "status_on_top");
  if (c_status_on_top)
  {
    mutt_window_add_child(dlg, win_cbar);
    mutt_window_add_child(dlg, win_env);
    if (c_preview_above_attachments)
    {
      mutt_window_add_child(dlg, win_preview_bar);
      mutt_window_add_child(dlg, win_preview);
      mutt_window_add_child(dlg, win_abar);
      mutt_window_add_child(dlg, win_attach);
    }
    else
    {
      mutt_window_add_child(dlg, win_abar);
      mutt_window_add_child(dlg, win_attach);
      mutt_window_add_child(dlg, win_preview_bar);
      mutt_window_add_child(dlg, win_preview);
    }
  }
  else
  {
    mutt_window_add_child(dlg, win_env);
    if (c_preview_above_attachments)
    {
      mutt_window_add_child(dlg, win_preview_bar);
      mutt_window_add_child(dlg, win_preview);
      mutt_window_add_child(dlg, win_abar);
      mutt_window_add_child(dlg, win_attach);
    }
    else
    {
      mutt_window_add_child(dlg, win_abar);
      mutt_window_add_child(dlg, win_attach);
      mutt_window_add_child(dlg, win_preview_bar);
      mutt_window_add_child(dlg, win_preview);
    }
    mutt_window_add_child(dlg, win_cbar);
  }
 
  shared->win_preview_bar = win_preview_bar;
  shared->win_preview = win_preview;
  shared->win_attach_bar = win_abar;
 
  dlg->help_data = ComposeHelp;
  dlg->help_md = MdCompose;
 
  return dlg;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

ComposeHelp

const struct Mapping ComposeHelp[]

static

Initial value:

= {
  
  { N_("Send"),        OP_COMPOSE_SEND_MESSAGE },
  { N_("Abort"),       OP_EXIT },
  
  { N_("To"),          OP_ENVELOPE_EDIT_TO },
  
  { N_("CC"),          OP_ENVELOPE_EDIT_CC },
  
  { N_("Subj"),        OP_ENVELOPE_EDIT_SUBJECT },
  { N_("Attach file"), OP_ATTACHMENT_ATTACH_FILE },
  { N_("Descrip"),     OP_ATTACHMENT_EDIT_DESCRIPTION },
  { N_("Help"),        OP_HELP },
  { NULL, 0 },
  
}

Help Bar for the Compose dialog.

Definition at line 93 of file dlg_compose.c.

                                            {
  // clang-format off
  { N_("Send"),        OP_COMPOSE_SEND_MESSAGE },
  { N_("Abort"),       OP_EXIT },
  /* L10N: compose menu help line entry */
  { N_("To"),          OP_ENVELOPE_EDIT_TO },
  /* L10N: compose menu help line entry */
  { N_("CC"),          OP_ENVELOPE_EDIT_CC },
  /* L10N: compose menu help line entry */
  { N_("Subj"),        OP_ENVELOPE_EDIT_SUBJECT },
  { N_("Attach file"), OP_ATTACHMENT_ATTACH_FILE },
  { N_("Descrip"),     OP_ATTACHMENT_EDIT_DESCRIPTION },
  { N_("Help"),        OP_HELP },
  { NULL, 0 },
  // clang-format on
};

ComposeNewsHelp

const struct Mapping ComposeNewsHelp[]

static

Initial value:

= {
  
  { N_("Send"),        OP_COMPOSE_SEND_MESSAGE },
  { N_("Abort"),       OP_EXIT },
  { N_("Newsgroups"),  OP_ENVELOPE_EDIT_NEWSGROUPS },
  { N_("Subj"),        OP_ENVELOPE_EDIT_SUBJECT },
  { N_("Attach file"), OP_ATTACHMENT_ATTACH_FILE },
  { N_("Descrip"),     OP_ATTACHMENT_EDIT_DESCRIPTION },
  { N_("Help"),        OP_HELP },
  { NULL, 0 },
  
}

Help Bar for the News Compose dialog.

Definition at line 111 of file dlg_compose.c.

                                                {
  // clang-format off
  { N_("Send"),        OP_COMPOSE_SEND_MESSAGE },
  { N_("Abort"),       OP_EXIT },
  { N_("Newsgroups"),  OP_ENVELOPE_EDIT_NEWSGROUPS },
  { N_("Subj"),        OP_ENVELOPE_EDIT_SUBJECT },
  { N_("Attach file"), OP_ATTACHMENT_ATTACH_FILE },
  { N_("Descrip"),     OP_ATTACHMENT_EDIT_DESCRIPTION },
  { N_("Help"),        OP_HELP },
  { NULL, 0 },
  // clang-format on
};