NeoMutt  2024-12-12-14-g7b49f7
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
private.h File Reference

Compose Private Data. More...

#include "config.h"
#include <stdbool.h>
+ Include dependency graph for private.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

struct MuttWindowattach_new (struct MuttWindow *parent, struct ComposeSharedData *shared)
 Create the Attachments Menu.
 
unsigned long cum_attachs_size (struct ConfigSubset *sub, struct ComposeAttachData *adata)
 Cumulative Attachments Size.
 
void update_menu (struct AttachCtx *actx, struct Menu *menu, bool init)
 Redraw the compose window.
 
void attachment_size_fixed (struct MuttWindow *win)
 Make the Attachment Window fixed-size.
 
void attachment_size_max (struct MuttWindow *win)
 Make the Attachment Window maximised.
 
struct MuttWindowpreview_window_new (struct Email *e, struct MuttWindow *bar)
 Create the preview window.
 
int preview_function_dispatcher (struct MuttWindow *win, int op)
 Perform a preview function - Implements function_dispatcher_t -.
 

Detailed Description

Compose Private Data.

Authors
  • Richard Russon
  • Dennis Schön

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 private.h.

Function Documentation

◆ attach_new()

struct MuttWindow * attach_new ( struct MuttWindow parent,
struct ComposeSharedData shared 
)

Create the Attachments Menu.

Parameters
parentParent Window
sharedShared compose data

Definition at line 267 of file attach.c.

268{
269 struct MuttWindow *win_attach = menu_window_new(MENU_COMPOSE, NeoMutt->sub);
270
271 struct ComposeAttachData *adata = attach_data_new(shared->email);
272
273 shared->adata = adata;
274
275 // NT_COLOR is handled by the Menu Window
279
280 struct Menu *menu = win_attach->wdata;
281 menu->page_len = win_attach->state.rows;
282 menu->win = win_attach;
283
285 menu->tag = compose_attach_tag;
286 menu->mdata = adata;
288 adata->menu = menu;
289
290 return win_attach;
291}
struct ComposeAttachData * attach_data_new(struct Email *e)
Create new Compose Attach Data.
Definition: attach_data.c:54
static int attach_window_observer(struct NotifyCallback *nc)
Notification that a Window has changed - Implements observer_t -.
Definition: attach.c:168
static int compose_make_entry(struct Menu *menu, int line, int max_cols, struct Buffer *buf)
Format an Attachment for the Menu - Implements Menu::make_entry() -.
Definition: attach.c:218
void attach_data_free(struct Menu *menu, void **ptr)
Free the Compose Attach Data - Implements Menu::mdata_free() -.
Definition: attach_data.c:37
static int compose_attach_tag(struct Menu *menu, int sel, int act)
Tag an attachment - Implements Menu::tag() -.
Definition: attach.c:202
static int attach_email_observer(struct NotifyCallback *nc)
Notification that the Email has changed - Implements observer_t -.
Definition: attach.c:127
static int attach_config_observer(struct NotifyCallback *nc)
Notification that a Config Variable has changed - Implements observer_t -.
Definition: dlg_attach.c:108
struct MuttWindow * menu_window_new(enum MenuType type, struct ConfigSubset *sub)
Create a new Menu Window.
Definition: window.c:140
bool notify_observer_add(struct Notify *notify, enum NotifyType type, observer_t callback, void *global_data)
Add an observer to an object.
Definition: notify.c:191
@ NT_WINDOW
MuttWindow has changed, NotifyWindow, EventWindow.
Definition: notify_type.h:57
@ NT_CONFIG
Config has changed, NotifyConfig, EventConfig.
Definition: notify_type.h:43
@ NT_EMAIL
Email has changed, NotifyEmail, EventEmail.
Definition: notify_type.h:44
Data to fill the Compose Attach Window.
Definition: attach_data.h:33
struct Menu * menu
Menu displaying the attachments.
Definition: attach_data.h:35
struct ComposeAttachData * adata
Attachments.
Definition: shared_data.h:40
struct Email * email
Email being composed.
Definition: shared_data.h:39
struct Notify * notify
Notifications: NotifyConfig, EventConfig.
Definition: subset.h:52
struct Notify * notify
Notifications: NotifyEmail, EventEmail.
Definition: email.h:73
Definition: lib.h:79
struct MuttWindow * win
Window holding the Menu.
Definition: lib.h:86
void(* mdata_free)(struct Menu *menu, void **ptr)
Definition: lib.h:161
int(* tag)(struct Menu *menu, int sel, int act)
Definition: lib.h:131
int(* make_entry)(struct Menu *menu, int line, int max_cols, struct Buffer *buf)
Definition: lib.h:106
void * mdata
Private data.
Definition: lib.h:147
int page_len
Number of entries per screen.
Definition: lib.h:84
struct WindowState state
Current state of the Window.
Definition: mutt_window.h:127
void * wdata
Private data.
Definition: mutt_window.h:145
struct Notify * notify
Notifications: NotifyWindow, EventWindow.
Definition: mutt_window.h:138
Container for Accounts, Notifications.
Definition: neomutt.h:42
struct ConfigSubset * sub
Inherited config items.
Definition: neomutt.h:46
short rows
Number of rows, can be MUTT_WIN_SIZE_UNLIMITED.
Definition: mutt_window.h:62
@ MENU_COMPOSE
Compose an email.
Definition: type.h:42
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ cum_attachs_size()

unsigned long cum_attachs_size ( struct ConfigSubset sub,
struct ComposeAttachData adata 
)

Cumulative Attachments Size.

Parameters
subConfig Subset
adataAttachment data
Return values
numBytes in attachments

Returns the total number of bytes used by the attachments in the attachment list after content-transfer-encodings have been applied.

Definition at line 85 of file attach.c.

86{
87 if (!adata || !adata->actx)
88 return 0;
89
90 size_t s = 0;
91 struct Content *info = NULL;
92 struct Body *b = NULL;
93 struct AttachCtx *actx = adata->actx;
94 struct AttachPtr **idx = actx->idx;
95
96 for (unsigned short i = 0; i < actx->idxlen; i++)
97 {
98 b = idx[i]->body;
99
100 if (!b->content)
101 b->content = mutt_get_content_info(b->filename, b, sub);
102
103 info = b->content;
104 if (info)
105 {
106 switch (b->encoding)
107 {
109 s += 3 * (info->lobin + info->hibin) + info->ascii + info->crlf;
110 break;
111 case ENC_BASE64:
112 s += (4 * (info->lobin + info->hibin + info->ascii + info->crlf)) / 3;
113 break;
114 default:
115 s += info->lobin + info->hibin + info->ascii + info->crlf;
116 break;
117 }
118 }
119 }
120
121 return s;
122}
struct Content * mutt_get_content_info(const char *fname, struct Body *b, struct ConfigSubset *sub)
Analyze file to determine MIME encoding to use.
Definition: content_info.c:188
@ ENC_BASE64
Base-64 encoded text.
Definition: mime.h:52
@ ENC_QUOTED_PRINTABLE
Quoted-printable text.
Definition: mime.h:51
A set of attachments.
Definition: attach.h:63
struct AttachPtr ** idx
Array of attachments.
Definition: attach.h:67
short idxlen
Number of attachmentes.
Definition: attach.h:68
An email to which things will be attached.
Definition: attach.h:35
struct Body * body
Attachment.
Definition: attach.h:36
The body of an email.
Definition: body.h:36
struct Content * content
Detailed info about the content of the attachment.
Definition: body.h:70
unsigned int encoding
content-transfer-encoding, ContentEncoding
Definition: body.h:41
char * filename
When sending a message, this is the file to which this structure refers.
Definition: body.h:59
struct AttachCtx * actx
Set of attachments.
Definition: attach_data.h:34
Info about an attachment.
Definition: content.h:35
long crlf
\r and \n characters
Definition: content.h:39
long hibin
8-bit characters
Definition: content.h:36
long ascii
Number of ascii chars.
Definition: content.h:40
long lobin
Unprintable 7-bit chars (eg., control chars)
Definition: content.h:37
+ 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
actxAttachment context
menuCurrent menu
initIf true, initialise the attachment list

Definition at line 282 of file dlg_compose.c.

283{
284 if (init)
285 {
286 gen_attach_list(actx, actx->email->body, -1, 0);
287 mutt_attach_init(actx);
288
289 struct ComposeAttachData *adata = menu->mdata;
290 adata->actx = actx;
291 }
292
294
295 menu->max = actx->vcount;
296 if (menu->max)
297 {
298 int index = menu_get_index(menu);
299 if (index >= menu->max)
301 }
302 else
303 {
305 }
306
308}
static void gen_attach_list(struct AttachCtx *actx, struct Body *b, int parent_type, int level)
Generate the attachment list for the compose screen.
Definition: dlg_compose.c:258
#define MENU_REDRAW_INDEX
Redraw the index.
Definition: lib.h:56
void menu_queue_redraw(struct Menu *menu, MenuRedrawFlags redraw)
Queue a request for a redraw.
Definition: menu.c:184
int menu_get_index(struct Menu *menu)
Get the current selection in the Menu.
Definition: menu.c:160
MenuRedrawFlags menu_set_index(struct Menu *menu, int index)
Set the current selection in the Menu.
Definition: menu.c:174
void mutt_attach_init(struct AttachCtx *actx)
Create a new Attachment context.
Definition: recvattach.c:1189
void mutt_update_tree(struct AttachCtx *actx)
Refresh the list of attachments.
Definition: recvattach.c:122
short vcount
The number of virtual attachments.
Definition: attach.h:72
struct Email * email
Used by recvattach for updating.
Definition: attach.h:64
struct Body * body
List of MIME parts.
Definition: email.h:69
int max
Number of entries in the menu.
Definition: lib.h:81
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ attachment_size_fixed()

void attachment_size_fixed ( struct MuttWindow win)

Make the Attachment Window fixed-size.

Parameters
winAttachment Window

Definition at line 297 of file attach.c.

298{
299 if (!win || (win->size == MUTT_WIN_SIZE_FIXED))
300 return;
301
303 win->recalc = attach_recalc;
304}
static int attach_recalc(struct MuttWindow *win)
Recalculate the Window data - Implements MuttWindow::recalc() -.
Definition: attach.c:242
@ MUTT_WIN_SIZE_FIXED
Window has a fixed size.
Definition: mutt_window.h:48
int(* recalc)(struct MuttWindow *win)
Definition: mutt_window.h:173
enum MuttWindowSize size
Type of Window, e.g. MUTT_WIN_SIZE_FIXED.
Definition: mutt_window.h:131
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ attachment_size_max()

void attachment_size_max ( struct MuttWindow win)

Make the Attachment Window maximised.

Parameters
winAttachment Window

Definition at line 310 of file attach.c.

311{
312 if (!win || (win->size == MUTT_WIN_SIZE_MAXIMISE))
313 return;
314
316 win->recalc = NULL;
317}
@ MUTT_WIN_SIZE_MAXIMISE
Window wants as much space as possible.
Definition: mutt_window.h:49
+ Here is the caller graph for this function:

◆ preview_window_new()

struct MuttWindow * preview_window_new ( struct Email e,
struct MuttWindow bar 
)

Create the preview window.

Parameters
eEmail
barPreview Bar

Definition at line 339 of file preview.c.

340{
344
348
349 struct PreviewWindowData *wdata = preview_wdata_new();
350 wdata->email = e;
351 wdata->scroll_offset = 0;
352 wdata->win = win;
353 wdata->bar = bar;
354
355 win->wdata = wdata;
359
360 return win;
361}
void mutt_color_observer_add(observer_t callback, void *global_data)
Add an observer.
Definition: notify.c:61
static int preview_email_observer(struct NotifyCallback *nc)
Notification that the Email has changed - Implements observer_t -.
Definition: preview.c:262
static int preview_window_observer(struct NotifyCallback *nc)
Notification that a Window has changed - Implements observer_t -.
Definition: preview.c:279
static int preview_color_observer(struct NotifyCallback *nc)
Notification that a Color has changed - Implements observer_t -.
Definition: preview.c:231
static int preview_recalc(struct MuttWindow *win)
Recalculate the Window data - Implements MuttWindow::recalc() -.
Definition: preview.c:324
static int preview_repaint(struct MuttWindow *win)
Repaint the Window - Implements MuttWindow::repaint() -.
Definition: preview.c:312
static void preview_wdata_free(struct MuttWindow *win, void **ptr)
Free the Preview Data - Implements MuttWindow::wdata_free() -.
Definition: preview.c:110
struct MuttWindow * mutt_window_new(enum WindowType type, enum MuttWindowOrientation orient, enum MuttWindowSize size, int cols, int rows)
Create a new Window.
Definition: mutt_window.c:182
@ WT_CUSTOM
Window with a custom drawing function.
Definition: mutt_window.h:95
@ MUTT_WIN_ORIENT_VERTICAL
Window uses all available vertical space.
Definition: mutt_window.h:39
#define MUTT_WIN_SIZE_UNLIMITED
Use as much space as possible.
Definition: mutt_window.h:53
@ NT_ALL
Register for all notifications.
Definition: notify_type.h:35
static struct PreviewWindowData * preview_wdata_new(void)
Create new Preview Data.
Definition: preview.c:122
int(* repaint)(struct MuttWindow *win)
Definition: mutt_window.h:187
void(* wdata_free)(struct MuttWindow *win, void **ptr)
Definition: mutt_window.h:159
Data to fill the Preview Window.
Definition: preview.c:78
struct MuttWindow * win
Window holding the message preview.
Definition: preview.c:81
struct MuttWindow * bar
Status bar above the preview window.
Definition: preview.c:82
int scroll_offset
Scroll offset.
Definition: preview.c:80
struct Email * email
Email being composed.
Definition: preview.c:79
+ Here is the call graph for this function:
+ Here is the caller graph for this function: