Keep track when processing files. More...

#include <stddef.h>
#include <stdint.h>
#include <stdio.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	STATE_NO_FLAGS 0
	No flags are set.

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

#define	STATE_VERIFY (1 << 1)
	Perform signature verification.

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

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

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

#define	STATE_PRINTING (1 << 5)
	Are we printing? - STATE_DISPLAY "light".

#define	STATE_REPLYING (1 << 6)
	Are we replying?

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

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

#define	STATE_PAGER (1 << 9)
	Output will be displayed in the Pager.

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

#define	state_reset_prefix(state) ((state)->flags &= ~STATE_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. STATE_DISPLAY.

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

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

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

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

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

int	state_printf (struct State state, const char fmt,...) __attribute__((__format__(__printf__

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

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

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

Detailed Description

Keep track when processing files.

Authors

Richard Russon
Pietro Cerutti

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

◆ STATE_NO_FLAGS

#define STATE_NO_FLAGS 0

No flags are set.

Definition at line 32 of file state.h.

◆ STATE_DISPLAY

#define STATE_DISPLAY (1 << 0)

Output is displayed to the user.

Definition at line 33 of file state.h.

◆ STATE_VERIFY

#define STATE_VERIFY (1 << 1)

Perform signature verification.

Definition at line 34 of file state.h.

◆ STATE_PENDINGPREFIX

#define STATE_PENDINGPREFIX (1 << 2)

Prefix to write, but character must follow.

Definition at line 35 of file state.h.

◆ STATE_WEED

#define STATE_WEED (1 << 3)

Weed headers even when not in display mode.

Definition at line 36 of file state.h.

◆ STATE_CHARCONV

#define STATE_CHARCONV (1 << 4)

Do character set conversions.

Definition at line 37 of file state.h.

◆ STATE_PRINTING

#define STATE_PRINTING (1 << 5)

Are we printing? - STATE_DISPLAY "light".

Definition at line 38 of file state.h.

◆ STATE_REPLYING

#define STATE_REPLYING (1 << 6)

Are we replying?

Definition at line 39 of file state.h.

◆ STATE_FIRSTDONE

#define STATE_FIRSTDONE (1 << 7)

The first attachment has been done.

Definition at line 40 of file state.h.

◆ STATE_DISPLAY_ATTACH

#define STATE_DISPLAY_ATTACH (1 << 8)

We are displaying an attachment.

Definition at line 41 of file state.h.

◆ STATE_PAGER

#define STATE_PAGER (1 << 9)

Output will be displayed in the Pager.

Definition at line 42 of file state.h.

◆ state_set_prefix

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

Definition at line 56 of file state.h.

◆ state_reset_prefix

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

Definition at line 57 of file state.h.

◆ state_puts

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

Definition at line 58 of file state.h.

◆ state_putc

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

Definition at line 59 of file state.h.

Typedef Documentation

◆ StateFlags

typedef uint16_t StateFlags

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

Definition at line 31 of file state.h.

Function Documentation

◆ state_attach_puts()

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

Write a string to the state.

Parameters

state	State to write to
t	Text to write

Definition at line 103 of file state.c.

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

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 * state )

Write a unique marker around content.

Parameters

state State to write to

Definition at line 72 of file state.c.

{
  if (!state || !state->fp_out)
    return;
 
  if ((state->flags & (STATE_DISPLAY | STATE_PAGER)) == (STATE_DISPLAY | STATE_PAGER))
  {
    state_puts(state, 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 * state )

Write a unique marker around protected headers.

Parameters

state State to write to

Definition at line 87 of file state.c.

{
  if (!state || !state->fp_out)
    return;
 
  if ((state->flags & (STATE_DISPLAY | STATE_PAGER)) == (STATE_DISPLAY | STATE_PAGER))
  {
    state_puts(state, 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 *	state,
		const char *	buf,
		size_t	buflen
	)

Write a prefixed fixed-string to the State.

Parameters

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

Definition at line 204 of file state.c.

{
  if (state->prefix)
  {
    while (buflen--)
      state_prefix_putc(state, *buf++);
  }
  else
  {
    fwrite(buf, buflen, 1, state->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 *	state,
		char	c
	)

Write a prefixed character to the state.

Parameters

state	State to write to
c	Character to write

Definition at line 164 of file state.c.

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

Here is the caller graph for this function:

◆ state_printf()

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

◆ state_putws()

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

Write a wide string to the state.

Parameters

state	State to write to
ws	Wide string to write

Return values

0	Success
-1	Error

Definition at line 146 of file state.c.

{
  const wchar_t *p = ws;
 
  while (p && (*p != L'\0'))
  {
    if (state_putwc(state, *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 44 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 58 of file state.c.

{
  static char marker[256] = { 0 };
  if (!marker[0])
  {
    snprintf(marker, sizeof(marker), "\033]8;%lld\a", (long long) mutt_date_now());
  }
  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

◆ STATE_NO_FLAGS

◆ STATE_DISPLAY

◆ STATE_VERIFY

◆ STATE_PENDINGPREFIX

◆ STATE_WEED

◆ STATE_CHARCONV

◆ STATE_PRINTING

◆ STATE_REPLYING

◆ STATE_FIRSTDONE

◆ STATE_DISPLAY_ATTACH

◆ STATE_PAGER

◆ 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()