state.h File Reference

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:

Go to the source code of this file.

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

Macros
#define	state_set_prefix(state)
#define	state_reset_prefix(state)
#define	state_puts(STATE, STR)
#define	state_putc(STATE, STR)

Typedefs
typedef uint16_t	StateFlags

Enumerations
enum	StateFlag {   STATE_NONE = 0 , STATE_DISPLAY = 1U << 0 , STATE_VERIFY = 1U << 1 , STATE_PENDINGPREFIX = 1U << 2 ,   STATE_WEED = 1U << 3 , STATE_CHARCONV = 1U << 4 , STATE_PRINTING = 1U << 5 , STATE_REPLYING = 1U << 6 ,   STATE_FIRSTDONE = 1U << 7 , STATE_DISPLAY_ATTACH = 1U << 8 , STATE_PAGER = 1U << 9 }
	Flags for State->flags. More...

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_set_prefix

#define state_set_prefix

(

state

)

Value:

((state)->flags |= STATE_PENDINGPREFIX)

Definition at line 62 of file state.h.

state_reset_prefix

#define state_reset_prefix

(

state

)

Value:

((state)->flags &= ~STATE_PENDINGPREFIX)

Definition at line 63 of file state.h.

state_puts

#define state_puts	(		STATE,
			STR )

Value:

fputs(STR, (STATE)->fp_out)

Definition at line 64 of file state.h.

state_putc

#define state_putc	(		STATE,
			STR )

Value:

fputc(STR, (STATE)->fp_out)

Definition at line 65 of file state.h.

Typedef Documentation

StateFlags

typedef uint16_t StateFlags

Definition at line 48 of file state.h.

Enumeration Type Documentation

StateFlag

enum StateFlag

Flags for State->flags.

Enumerator
STATE_NONE	No flags are set.
STATE_DISPLAY	Output is displayed to the user.
STATE_VERIFY	Perform signature verification.
STATE_PENDINGPREFIX	Prefix to write, but character must follow.
STATE_WEED	Weed headers even when not in display mode.
STATE_CHARCONV	Do character set conversions.
STATE_PRINTING	Are we printing? - STATE_DISPLAY "light".
STATE_REPLYING	Are we replying?
STATE_FIRSTDONE	The first attachment has been done.
STATE_DISPLAY_ATTACH	We are displaying an attachment.
STATE_PAGER	Output will be displayed in the Pager.

Definition at line 34 of file state.h.

{
  STATE_NONE           =       0,  
  STATE_DISPLAY        = 1U << 0,  
  STATE_VERIFY         = 1U << 1,  
  STATE_PENDINGPREFIX  = 1U << 2,  
  STATE_WEED           = 1U << 3,  
  STATE_CHARCONV       = 1U << 4,  
  STATE_PRINTING       = 1U << 5,  
  STATE_REPLYING       = 1U << 6,  
  STATE_FIRSTDONE      = 1U << 7,  
  STATE_DISPLAY_ATTACH = 1U << 8,  
  STATE_PAGER          = 1U << 9,  
};

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 104 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 73 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 88 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 211 of file state.c.

{
  if (!state || !state->fp_out || !buf)
    return;
 
  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 168 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,
			... )

Here is the call graph for this function:

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 147 of file state.c.

{
  if (!state || !state->fp_out)
    return -1;
 
  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 45 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 59 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: