node_expando.h File Reference

Expando Node for an Expando. More...

#include <stdbool.h>
#include "definition.h"
#include "render.h"

Include dependency graph for node_expando.h:

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

Go to the source code of this file.

Data Structures
struct	NodeExpandoPrivate
	Private data for an Expando. More...

Functions
struct ExpandoNode *	node_expando_new (const char *start, const char *end, struct ExpandoFormat *fmt, int did, int uid)
	Create a new Expando ExpandoNode.
void	node_expando_set_color (const struct ExpandoNode *node, int cid)
	Set the colour for an Expando.
void	node_expando_set_has_tree (const struct ExpandoNode *node, bool has_tree)
	Set the has_tree flag for an Expando.
struct ExpandoNode *	node_expando_parse (const char *s, const char **parsed_until, const struct ExpandoDefinition *defs, ExpandoParserFlags flags, struct ExpandoParseError *error)
	Parse an Expando format string.
int	node_expando_render (const struct ExpandoNode *node, const struct ExpandoRenderData *rdata, struct Buffer *buf, int max_cols, void *data, MuttFormatFlags flags)
	Render an Expando Node - Implements ExpandoNode::render() -.
struct ExpandoNode *	node_expando_parse_enclosure (const char *s, const char **parsed_until, int did, int uid, char terminator, struct ExpandoParseError *error)
	Parse an enclosed Expando.
const char *	skip_classic_expando (const char *s, const struct ExpandoDefinition *defs)
	Skip over the text of an Expando.

Detailed Description

Expando Node for an Expando.

Authors

• Tóth János
• 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 node_expando.h.

Function Documentation

node_expando_new()

struct ExpandoNode * node_expando_new	(	const char *	start,
		const char *	end,
		struct ExpandoFormat *	fmt,
		int	did,
		int	uid
	)

Create a new Expando ExpandoNode.

Parameters

start	Start of Expando string
end	End of Expando string
fmt	Formatting data
did	Domain ID
uid	Unique ID

Return values

ptr	New Expando ExpandoNode

Definition at line 81 of file node_expando.c.

{
  struct ExpandoNode *node = node_new();
 
  node->type = ENT_EXPANDO;
  node->start = start;
  node->end = end;
 
  node->did = did;
  node->uid = uid;
  node->render = node_expando_render;
 
  node->format = fmt;
 
  node->ndata = node_expando_private_new();
  node->ndata_free = node_expando_private_free;
 
  return node;
}

Here is the call graph for this function:

Here is the caller graph for this function:

node_expando_set_color()

void node_expando_set_color	(	const struct ExpandoNode *	node,
		int	cid
	)

Set the colour for an Expando.

Parameters

node	Node to alter
cid	Colour

Definition at line 107 of file node_expando.c.

{
  if (!node || (node->type != ENT_EXPANDO) || !node->ndata)
    return;
 
  struct NodeExpandoPrivate *priv = node->ndata;
 
  priv->color = cid;
}

Here is the caller graph for this function:

node_expando_set_has_tree()

void node_expando_set_has_tree	(	const struct ExpandoNode *	node,
		bool	has_tree
	)

Set the has_tree flag for an Expando.

Parameters

node	Node to alter
has_tree	Flag to set

Definition at line 122 of file node_expando.c.

{
  if (!node || (node->type != ENT_EXPANDO) || !node->ndata)
    return;
 
  struct NodeExpandoPrivate *priv = node->ndata;
 
  priv->has_tree = has_tree;
}

Here is the caller graph for this function:

node_expando_parse()

struct ExpandoNode * node_expando_parse	(	const char *	str,
		const char **	parsed_until,
		const struct ExpandoDefinition *	defs,
		ExpandoParserFlags	flags,
		struct ExpandoParseError *	error
	)

Parse an Expando format string.

Parameters

[in]	str	String to parse
[out]	parsed_until	First character after parsed string
[in]	defs	Expando definitions
[in]	flags	Flag for conditional expandos
[out]	error	Buffer for errors

Return values

ptr	New ExpandoNode

Definition at line 238 of file node_expando.c.

{
  const struct ExpandoDefinition *definition = defs;
 
  const char *format_end = skip_until_classic_expando(str);
  const char *expando_end = skip_classic_expando(format_end, defs);
  char expando[128] = { 0 };
  const int expando_len = expando_end - format_end;
  mutt_strn_copy(expando, format_end, expando_len, sizeof(expando));
 
  struct ExpandoFormat *fmt = parse_format(str, format_end, error);
  if (error->position)
  {
    FREE(&fmt);
    return NULL;
  }
 
  while (definition && definition->short_name)
  {
    if (mutt_str_equal(definition->short_name, expando))
    {
      if (definition->parse && !(flags & EP_NO_CUSTOM_PARSE))
      {
        FREE(&fmt);
        return definition->parse(str, parsed_until, definition->did,
                                 definition->uid, flags, error);
      }
      else
      {
        *parsed_until = expando_end;
        return node_expando_new(format_end, expando_end, fmt, definition->did,
                                definition->uid);
      }
    }
 
    definition++;
  }
 
  error->position = format_end;
  // L10N: e.g. "Unknown expando: %Q"
  snprintf(error->message, sizeof(error->message), _("Unknown expando: %%%.*s"),
           expando_len, format_end);
  FREE(&fmt);
  return NULL;
}

Here is the call graph for this function:

Here is the caller graph for this function:

node_expando_parse_enclosure()

struct ExpandoNode * node_expando_parse_enclosure	(	const char *	str,
		const char **	parsed_until,
		int	did,
		int	uid,
		char	terminator,
		struct ExpandoParseError *	error
	)

Parse an enclosed Expando.

Parameters

str	String to parse
parsed_until	First character after the parsed string
did	Domain ID
uid	Unique ID
terminator	Terminating character
error	Buffer for errors

Return values

ptr	New ExpandoNode

Definition at line 297 of file node_expando.c.

{
  const char *format_end = skip_until_classic_expando(str);
 
  format_end++; // skip opening char
 
  const char *expando_end = skip_until_ch(format_end, terminator);
 
  if (*expando_end != terminator)
  {
    error->position = expando_end;
    snprintf(error->message, sizeof(error->message),
             // L10N: Expando is missing a terminator character
             //       e.g. "%[..." is missing the final ']'
             _("Expando is missing terminator: '%c'"), terminator);
    return NULL;
  }
 
  // revert skipping for fmt
  struct ExpandoFormat *fmt = parse_format(str, format_end - 1, error);
  if (error->position)
  {
    FREE(&fmt);
    return NULL;
  }
 
  *parsed_until = expando_end + 1;
  return node_expando_new(format_end, expando_end, fmt, did, uid);
}

Here is the call graph for this function:

Here is the caller graph for this function:

skip_classic_expando()

const char * skip_classic_expando	(	const char *	str,
		const struct ExpandoDefinition *	defs
	)

Skip over the text of an Expando.

Parameters

str	Starting place
defs	Expando definitions

Return values

ptr	Character after Expando, or end-of-string

Definition at line 145 of file helpers.c.

{
  assert(str);
  if (*str == '\0')
    return str;
 
  const struct ExpandoDefinition *definitions = defs;
 
  while (definitions && definitions->short_name)
  {
    const bool is_two_char = mutt_str_len(definitions->short_name) == 2;
    const char *name = definitions->short_name;
 
    if (is_two_char && (name[0] == *str) && (name[1] == *(str + 1)))
    {
      str++;
      break;
    }
 
    definitions++;
  }
 
  str++;
  return str;
}

Here is the call graph for this function:

Here is the caller graph for this function: