preview.c File Reference

Compose message preview. More...

#include "config.h"
#include <stdbool.h>
#include <stdio.h>
#include "private.h"
#include "mutt/lib.h"
#include "email/lib.h"
#include "core/lib.h"
#include "gui/lib.h"
#include "color/lib.h"
#include "key/lib.h"

Include dependency graph for preview.c:

Go to the source code of this file.

Data Structures
struct	PreviewWindowData
	Data to fill the Preview Window. More...
struct	PreviewFunction
	A message preview function. More...

Typedefs
typedef int(*	preview_function_t) (struct PreviewWindowData *wdata, const struct KeyEvent *event)

Functions
static void	preview_wdata_free (struct MuttWindow *win, void **ptr)
	Free the Preview Data - Implements MuttWindow::wdata_free() -.
static struct PreviewWindowData *	preview_wdata_new (void)
	Create new Preview Data.
static void	draw_preview (struct MuttWindow *win, struct PreviewWindowData *wdata)
	Write the message preview to the compose window.
static int	preview_color_observer (struct NotifyCallback *nc)
	Notification that a Color has changed - Implements observer_t -.
static int	preview_email_observer (struct NotifyCallback *nc)
	Notification that the Email has changed - Implements observer_t -.
static int	preview_window_observer (struct NotifyCallback *nc)
	Notification that a Window has changed - Implements observer_t -.
static int	preview_repaint (struct MuttWindow *win)
	Repaint the Window - Implements MuttWindow::repaint() -.
static int	preview_recalc (struct MuttWindow *win)
	Recalculate the Window data - Implements MuttWindow::recalc() -.
struct MuttWindow *	preview_window_new (struct Email *e, struct MuttWindow *bar)
	Create the preview window.
static int	preview_page_up (struct PreviewWindowData *wdata, const struct KeyEvent *event)
	Show the previous page of the message - Implements preview_function_t -.
static int	preview_page_down (struct PreviewWindowData *wdata, const struct KeyEvent *event)
	Show the next page of the message - Implements preview_function_t -.
int	preview_function_dispatcher (struct MuttWindow *win, const struct KeyEvent *event)
	Perform a preview function - Implements function_dispatcher_t -.

Variables
const long	MAX_PREVIEW_BODY_SIZE = 1024 * 1024 * 5
static const struct PreviewFunction	PreviewFunctions []
	All the functions that the preview window supports.

Detailed Description

Compose message preview.

Authors

• 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 preview.c.

Typedef Documentation

preview_function_t

typedef int(* preview_function_t) (struct PreviewWindowData *wdata, const struct KeyEvent *event)

Definition at line 100 of file preview.c.

Function Documentation

preview_wdata_new()

static struct PreviewWindowData * preview_wdata_new ( void )

static

Create new Preview Data.

Return values

ptr	New Preview Data

Definition at line 127 of file preview.c.

{
  struct PreviewWindowData *wdata = mutt_mem_calloc(1, sizeof(struct PreviewWindowData));
 
  return wdata;
}

Here is the call graph for this function:

Here is the caller graph for this function:

draw_preview()

static void draw_preview ( struct MuttWindow * win, struct PreviewWindowData * wdata )

static

Write the message preview to the compose window.

Parameters

win	Window to draw on
wdata	Preview Window data

Definition at line 139 of file preview.c.

{
  struct Email *e = wdata->email;
 
  // Reset preview window and status bar.
  mutt_window_clear(win);
  sbar_set_title(wdata->bar, _("-- Preview"));
 
  // Check for valid content type and disposition
  if ((e->body->disposition != DISP_INLINE) || (e->body->type != TYPE_TEXT))
  {
    mutt_error(_("Only inline attachments with content-type text/* can be previewed"));
    return;
  }
 
  // Ensure file isn't to too large.
  long file_size = mutt_file_get_size(e->body->filename);
  if (file_size > MAX_PREVIEW_BODY_SIZE)
  {
    mutt_error(_("Email too large to preview"));
    return;
  }
 
  FILE *fp = mutt_file_fopen(e->body->filename, "r");
  if (!fp)
  {
    mutt_perror("%s", e->body->filename);
    return;
  }
 
  wdata->more_content = false;
 
  int content_lines = 0; // number of (wrapped) content lines
  int row = 0;           // window row to print
  char *line = NULL;
  size_t line_len = 0;
  while ((line = mutt_file_read_line(line, &line_len, fp, NULL, MUTT_RL_NONE)))
  {
    size_t pos = 0;
    bool text_left = true;
    while (text_left)
    {
      /* Text wrapping loop
       *
       * Note: We need to do the text wrapping also for text outside the visible
       *       area to ensure the scrolling works correctly.
       */
 
      content_lines++;
 
      mutt_str_expand_tabs(&line, &line_len, 8);
 
      // Check how much of the string fits into the window width.
      size_t width = 0;
      size_t bytes = mutt_wstr_trunc(&line[pos], line_len - pos, win->state.cols, &width);
 
      // If it doesn't fill the full width we're done wrapping.
      if ((win->state.cols - width) > 0)
        text_left = false;
 
      // Only move the cursor and print if this line is currently visible.
      if ((content_lines >= wdata->scroll_offset) && (row < win->state.rows))
      {
        int rc = mutt_window_move(win, row, 0);
        if (rc == ERR)
          mutt_warning(_("Failed to move cursor!"));
 
        mutt_paddstr(win, win->state.cols, &line[pos]);
 
        row++;
      }
 
      // Advance position in string.
      pos += bytes;
    }
  }
 
  FREE(&line);
  mutt_file_fclose(&fp);
 
  // Store content_lines for boundary checking
  wdata->content_lines = content_lines;
 
  // Clamp scroll_offset to prevent empty pages
  // Maximum valid offset is when we can still show at least one line of content
  if (content_lines > 0)
  {
    int max_offset = MAX(0, content_lines - win->state.rows);
    if (wdata->scroll_offset > max_offset)
      wdata->scroll_offset = max_offset;
  }
 
  // Show the scroll percentage in the status bar
  if ((content_lines != 0) && (content_lines > win->state.rows))
  {
    char title[256] = { 0 };
    double percent = 100.0;
    if ((wdata->scroll_offset + row) < content_lines)
      percent = 100.0 / content_lines * (wdata->scroll_offset + row);
 
    // TODO: having the percentage right-aligned would be nice
    snprintf(title, sizeof(title), _("-- Preview (%.0f%%)"), percent);
    sbar_set_title(wdata->bar, title);
 
    if (content_lines > (wdata->scroll_offset + row))
      wdata->more_content = true;
  }
}

Here is the call graph for this function:

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

e	Email
bar	Preview Bar

Definition at line 359 of file preview.c.

{
  struct MuttWindow *win = mutt_window_new(WT_CUSTOM, MUTT_WIN_ORIENT_VERTICAL,
                                           MUTT_WIN_SIZE_MAXIMISE, MUTT_WIN_SIZE_UNLIMITED,
                                           MUTT_WIN_SIZE_UNLIMITED);
 
  mutt_color_observer_add(preview_color_observer, win);
  notify_observer_add(win->notify, NT_WINDOW, preview_window_observer, win);
  notify_observer_add(e->notify, NT_ALL, preview_email_observer, win);
 
  struct PreviewWindowData *wdata = preview_wdata_new();
  wdata->email = e;
  wdata->scroll_offset = 0;
  wdata->win = win;
  wdata->bar = bar;
 
  win->wdata = wdata;
  win->wdata_free = preview_wdata_free;
  win->recalc = preview_recalc;
  win->repaint = preview_repaint;
 
  return win;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

MAX_PREVIEW_BODY_SIZE

const long MAX_PREVIEW_BODY_SIZE = 1024 * 1024 * 5

Definition at line 72 of file preview.c.

PreviewFunctions

const struct PreviewFunction PreviewFunctions[]

static

Initial value:

= {
  
  { OP_PREVIEW_PAGE_DOWN, preview_page_down },
  { OP_PREVIEW_PAGE_UP,   preview_page_up   },
  { 0, NULL },
  
}

All the functions that the preview window supports.

Definition at line 428 of file preview.c.

                                                         {
  // clang-format off
  { OP_PREVIEW_PAGE_DOWN, preview_page_down },
  { OP_PREVIEW_PAGE_UP,   preview_page_up   },
  { 0, NULL },
  // clang-format on
};