Keep track when processing files. More...

#include <stdint.h>
#include <stdio.h>
#include <wchar.h>

Include dependency graph for state.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	State
	Keep track when processing files. More...

Macros
#define	MUTT_STATE_NO_FLAGS 0
	No flags are set. More...

#define	MUTT_DISPLAY (1 << 0)
	Output is displayed to the user. More...

#define	MUTT_VERIFY (1 << 1)
	Perform signature verification. More...

#define	MUTT_PENDINGPREFIX (1 << 2)
	Prefix to write, but character must follow. More...

#define	MUTT_WEED (1 << 3)
	Weed headers even when not in display mode. More...

#define	MUTT_CHARCONV (1 << 4)
	Do character set conversions. More...

#define	MUTT_PRINTING (1 << 5)
	Are we printing? - MUTT_DISPLAY "light". More...

#define	MUTT_REPLYING (1 << 6)
	Are we replying? More...

#define	MUTT_FIRSTDONE (1 << 7)
	The first attachment has been done. More...

#define	MUTT_DISPLAY_ATTACH (1 << 8)
	We are displaying an attachment. More...

#define	state_set_prefix(state) ((state)->flags \|= MUTT_PENDINGPREFIX)

#define	state_reset_prefix(state) ((state)->flags &= ~MUTT_PENDINGPREFIX)

#define	state_puts(STATE, STR) fputs(STR, (STATE)->fp_out)

#define	state_putc(STATE, STR) fputc(STR, (STATE)->fp_out)

Typedefs
typedef uint16_t	StateFlags
	Flags for State->flags, e.g. MUTT_DISPLAY. More...

Functions
void	state_attach_puts (struct State s, const char t)
	Write a string to the state. More...

void	state_mark_attach (struct State *s)
	Write a unique marker around content. More...

void	state_mark_protected_header (struct State *s)
	Write a unique marker around protected headers. More...

void	state_prefix_put (struct State s, const char buf, size_t buflen)
	Write a prefixed fixed-string to the State. More...

void	state_prefix_putc (struct State *s, char c)
	Write a prefixed character to the state. More...

int	state_printf (struct State s, const char fmt,...)
	Write a formatted string to the State. More...

int	state_putws (struct State s, const wchar_t ws)
	Write a wide string to the state. More...

const char *	state_attachment_marker (void)
	Get a unique (per-run) ANSI string to mark PGP messages in an email. More...

const char *	state_protected_header_marker (void)
	Get a unique (per-run) ANSI string to mark protected headers in an email. More...

Detailed Description

Keep track when processing files.

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

Macro Definition Documentation

◆ MUTT_STATE_NO_FLAGS

#define MUTT_STATE_NO_FLAGS 0

No flags are set.

Definition at line 31 of file state.h.

◆ MUTT_DISPLAY

#define MUTT_DISPLAY (1 << 0)

Output is displayed to the user.

Definition at line 32 of file state.h.

◆ MUTT_VERIFY

#define MUTT_VERIFY (1 << 1)

Perform signature verification.

Definition at line 33 of file state.h.

◆ MUTT_PENDINGPREFIX

#define MUTT_PENDINGPREFIX (1 << 2)

Prefix to write, but character must follow.

Definition at line 34 of file state.h.

◆ MUTT_WEED

#define MUTT_WEED (1 << 3)

Weed headers even when not in display mode.

Definition at line 35 of file state.h.

◆ MUTT_CHARCONV

#define MUTT_CHARCONV (1 << 4)

Do character set conversions.

Definition at line 36 of file state.h.

◆ MUTT_PRINTING

#define MUTT_PRINTING (1 << 5)

Are we printing? - MUTT_DISPLAY "light".

Definition at line 37 of file state.h.

◆ MUTT_REPLYING

#define MUTT_REPLYING (1 << 6)

Are we replying?

Definition at line 38 of file state.h.

◆ MUTT_FIRSTDONE

#define MUTT_FIRSTDONE (1 << 7)

The first attachment has been done.

Definition at line 39 of file state.h.

◆ MUTT_DISPLAY_ATTACH

#define MUTT_DISPLAY_ATTACH (1 << 8)

We are displaying an attachment.

Definition at line 40 of file state.h.

◆ state_set_prefix

#define state_set_prefix ( state ) ((state)->flags |= MUTT_PENDINGPREFIX)

Definition at line 54 of file state.h.

◆ state_reset_prefix

#define state_reset_prefix ( state ) ((state)->flags &= ~MUTT_PENDINGPREFIX)

Definition at line 55 of file state.h.

◆ state_puts

#define state_puts	(	STATE,
		STR
	)	fputs(STR, (STATE)->fp_out)

Definition at line 56 of file state.h.

◆ state_putc

#define state_putc	(	STATE,
		STR
	)	fputc(STR, (STATE)->fp_out)

Definition at line 57 of file state.h.

Typedef Documentation

◆ StateFlags

typedef uint16_t StateFlags

Flags for State->flags, e.g. MUTT_DISPLAY.

Definition at line 30 of file state.h.

Function Documentation

◆ state_attach_puts()

void state_attach_puts	(	struct State *	s,
		const char *	t
	)

Write a string to the state.

Parameters

s	State to write to
t	Text to write

Definition at line 100 of file state.c.

 {
   if (!s || !s->fp_out || !t)
     return;
  
   if (*t != '\n')
     state_mark_attach(s);
   while (*t)
   {
     state_putc(s, *t);
     if ((*t++ == '\n') && *t)
       if (*t != '\n')
         state_mark_attach(s);
   }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ state_mark_attach()

void state_mark_attach ( struct State * s )

Write a unique marker around content.

Parameters

s	State to write to

Definition at line 71 of file state.c.

 {
   if (!s || !s->fp_out)
     return;
   const char *const c_pager = cs_subset_string(NeoMutt->sub, "pager");
   if ((s->flags & MUTT_DISPLAY) && (!c_pager || mutt_str_equal(c_pager, "builtin")))
   {
     state_puts(s, state_attachment_marker());
   }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ state_mark_protected_header()

void state_mark_protected_header ( struct State * s )

Write a unique marker around protected headers.

Parameters

s	State to write to

Definition at line 86 of file state.c.

 {
   const char *const c_pager = cs_subset_string(NeoMutt->sub, "pager");
   if ((s->flags & MUTT_DISPLAY) && (!c_pager || mutt_str_equal(c_pager, "builtin")))
   {
     state_puts(s, state_protected_header_marker());
   }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ state_prefix_put()

void state_prefix_put	(	struct State *	s,
		const char *	buf,
		size_t	buflen
	)

Write a prefixed fixed-string to the State.

Parameters

s	State to write to
buf	String to write
buflen	Length of string

Definition at line 201 of file state.c.

 {
   if (s->prefix)
   {
     while (buflen--)
       state_prefix_putc(s, *buf++);
   }
   else
     fwrite(buf, buflen, 1, s->fp_out);
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ state_prefix_putc()

void state_prefix_putc	(	struct State *	s,
		char	c
	)

Write a prefixed character to the state.

Parameters

s	State to write to
c	Character to write

Definition at line 161 of file state.c.

 {
   if (s->flags & MUTT_PENDINGPREFIX)
   {
     state_reset_prefix(s);
     if (s->prefix)
       state_puts(s, s->prefix);
   }
  
   state_putc(s, c);
  
   if (c == '\n')
     state_set_prefix(s);
 }

Here is the caller graph for this function:

◆ state_printf()

int state_printf	(	struct State *	s,
		const char *	fmt,
			...
	)

Write a formatted string to the State.

Parameters

s	State to write to
fmt	printf format string
...	Arguments to formatting string

Return values

num	Number of characters written

Definition at line 183 of file state.c.

 {
   int rc;
   va_list ap;
  
   va_start(ap, fmt);
   rc = vfprintf(s->fp_out, fmt, ap);
   va_end(ap);
  
   return rc;
 }

Here is the caller graph for this function:

◆ state_putws()

int state_putws	(	struct State *	s,
		const wchar_t *	ws
	)

Write a wide string to the state.

Parameters

s	State to write to
ws	Wide string to write

Return values

0	Success
-1	Error

Definition at line 143 of file state.c.

 {
   const wchar_t *p = ws;
  
   while (p && (*p != L'\0'))
   {
     if (state_putwc(s, *p) < 0)
       return -1;
     p++;
   }
   return 0;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ state_attachment_marker()

const char* state_attachment_marker ( void )

Get a unique (per-run) ANSI string to mark PGP messages in an email.

Return values

ptr Marker

Definition at line 43 of file state.c.

 {
   static char marker[256] = { 0 };
   if (!marker[0])
   {
     snprintf(marker, sizeof(marker), "\033]9;%" PRIu64 "\a", mutt_rand64());
   }
   return marker;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ state_protected_header_marker()

const char* state_protected_header_marker ( void )

Get a unique (per-run) ANSI string to mark protected headers in an email.

Return values

ptr Marker

Definition at line 57 of file state.c.

 {
   static char marker[256] = { 0 };
   if (!marker[0])
   {
     snprintf(marker, sizeof(marker), "\033]8;%lld\a", (long long) mutt_date_epoch());
   }
   return marker;
 }

Here is the call graph for this function:

Here is the caller graph for this function:

Data Structures

Macros

Typedefs

Functions

Detailed Description

Macro Definition Documentation

◆ MUTT_STATE_NO_FLAGS

◆ MUTT_DISPLAY

◆ MUTT_VERIFY

◆ MUTT_PENDINGPREFIX

◆ MUTT_WEED

◆ MUTT_CHARCONV

◆ MUTT_PRINTING

◆ MUTT_REPLYING

◆ MUTT_FIRSTDONE

◆ MUTT_DISPLAY_ATTACH

◆ state_set_prefix

◆ state_reset_prefix

◆ state_puts

◆ state_putc

Typedef Documentation

◆ StateFlags

Function Documentation

◆ state_attach_puts()

◆ state_mark_attach()

◆ state_mark_protected_header()

◆ state_prefix_put()

◆ state_prefix_putc()

◆ state_printf()

◆ state_putws()

◆ state_attachment_marker()

◆ state_protected_header_marker()