state.c File Reference

Keep track when processing files. More...

#include "config.h"
#include <inttypes.h>
#include <limits.h>
#include <stdarg.h>
#include <stdio.h>
#include <wchar.h>
#include "config/lib.h"
#include "core/lib.h"
#include "state.h"
#include "date.h"
#include "random.h"

Include dependency graph for state.c:

Go to the source code of this file.

Functions
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...
void	state_mark_attach (struct State *state)
	Write a unique marker around content. More...
void	state_mark_protected_header (struct State *state)
	Write a unique marker around protected headers. More...
void	state_attach_puts (struct State *state, const char *t)
	Write a string to the state. More...
static int	state_putwc (struct State *state, wchar_t wc)
	Write a wide character to the state. More...
int	state_putws (struct State *state, const wchar_t *ws)
	Write a wide string to the state. More...
void	state_prefix_putc (struct State *state, char c)
	Write a prefixed character to the state. More...
int	state_printf (struct State *state, const char *fmt,...)
	Write a formatted string to the State. More...
void	state_prefix_put (struct State *state, const char *buf, size_t buflen)
	Write a prefixed fixed-string to the State. 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.c.

Function Documentation

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:

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;
  const char *const c_pager = cs_subset_string(NeoMutt->sub, "pager");
  if ((state->flags & STATE_DISPLAY) && (!c_pager || mutt_str_equal(c_pager, "builtin")))
  {
    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.

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

Here is the call graph for this function:

Here is the caller graph for this function:

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 102 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_putwc()

static int state_putwc ( struct State *  state, wchar_t  wc  )

static

Write a wide character to the state.

Parameters

state	State to write to
wc	Wide character to write

Return values

0	Success
-1	Error

Definition at line 125 of file state.c.

{
  char mb[MB_LEN_MAX] = { 0 };
  int rc;
 
  rc = wcrtomb(mb, wc, NULL);
  if (rc < 0)
    return rc;
  if (fputs(mb, state->fp_out) == EOF)
    return -1;
  return 0;
}

Here is the caller graph for this function:

state_putws()

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 145 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_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 163 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,
			...
	)

Write a formatted string to the State.

Parameters

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

Return values

num	Number of characters written

Definition at line 185 of file state.c.

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

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 203 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: