Expando Parse API

Custom function to parse a format string into a Node. More...

Functions
struct ExpandoNode *	parse_folder_date (const char *str, const char **parsed_until, int did, int uid, ExpandoParserFlags flags, struct ExpandoParseError *error)
	Parse a Date Expando - Implements ExpandoDefinition::parse() -.
struct ExpandoNode *	node_condbool_parse (const char *str, const char **parsed_until, const struct ExpandoDefinition *defs, ExpandoParserFlags flags, struct ExpandoParseError *error)
	Parse a CondBool format string - Implements ExpandoDefinition::parse() -.
struct ExpandoNode *	node_conddate_parse (const char *str, const char **parsed_until, int did, int uid, struct ExpandoParseError *error)
	Parse a CondDate format string - Implements ExpandoDefinition::parse() -.
struct ExpandoNode *	node_padding_parse (const char *str, const char **parsed_until, int did, int uid, ExpandoParserFlags flags, struct ExpandoParseError *error)
	Parse a Padding Expando - Implements ExpandoDefinition::parse() -.
struct ExpandoNode *	parse_index_date_recv_local (const char *str, const char **parsed_until, int did, int uid, ExpandoParserFlags flags, struct ExpandoParseError *error)
	Parse a Date Expando - Implements ExpandoDefinition::parse() -.
struct ExpandoNode *	parse_index_date_local (const char *str, const char **parsed_until, int did, int uid, ExpandoParserFlags flags, struct ExpandoParseError *error)
	Parse a Date Expando - Implements ExpandoDefinition::parse() -.
struct ExpandoNode *	parse_index_date (const char *str, const char **parsed_until, int did, int uid, ExpandoParserFlags flags, struct ExpandoParseError *error)
	Parse a Date Expando - Implements ExpandoDefinition::parse() -.
struct ExpandoNode *	parse_index_hook (const char *str, const char **parsed_until, int did, int uid, ExpandoParserFlags flags, struct ExpandoParseError *error)
	Parse an index-hook - Implements ExpandoDefinition::parse() -.
struct ExpandoNode *	parse_tags_transformed (const char *str, const char **parsed_until, int did, int uid, ExpandoParserFlags flags, struct ExpandoParseError *error)
	Parse a Tags-Transformed Expando - Implements ExpandoDefinition::parse() -.
struct ExpandoNode *	parse_subject (const char *str, const char **parsed_until, int did, int uid, ExpandoParserFlags flags, struct ExpandoParseError *error)
	Parse a Subject Expando - Implements ExpandoDefinition::parse() -.
struct ExpandoNode *	parse_pgp_date (const char *str, const char **parsed_until, int did, int uid, ExpandoParserFlags flags, struct ExpandoParseError *error)
	Parse a Date Expando - Implements ExpandoDefinition::parse() -.

Detailed Description

Custom function to parse a format string into a Node.

Parameters

[in]	str	Format String to parse
[in,out]	parsed_until	First character after the parsed string
[in]	did	Domain ID of the data
[in]	uid	Unique ID of the data
[out]	error	Place for error message

Return values

ptr	Parsed Node

Function Documentation

parse_folder_date()

struct ExpandoNode * parse_folder_date	(	const char *	str,
		const char **	parsed_until,
		int	did,
		int	uid,
		ExpandoParserFlags	flags,
		struct ExpandoParseError *	error
	)

Parse a Date Expando - Implements ExpandoDefinition::parse() -.

Parse a custom Expando of the form, "%[string]". The "string" will be passed to strftime().

Definition at line 62 of file config.c.

{
  if (flags & EP_CONDITIONAL)
  {
    return node_conddate_parse(str + 1, parsed_until, did, uid, error);
  }
 
  return node_expando_parse_enclosure(str, parsed_until, did, uid, ']', error);
}

Here is the call graph for this function:

node_condbool_parse()

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

Parse a CondBool format string - Implements ExpandoDefinition::parse() -.

Definition at line 66 of file node_condbool.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));
 
  while (definition && definition->short_name)
  {
    if (mutt_str_equal(definition->short_name, expando))
    {
      if (definition->parse)
      {
        return definition->parse(str, parsed_until, definition->did,
                                 definition->uid, flags, error);
      }
      else
      {
        *parsed_until = expando_end;
        return node_condbool_new(format_end, expando_end, 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);
  return NULL;
}

Here is the call graph for this function:

Here is the caller graph for this function:

node_conddate_parse()

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

Parse a CondDate format string - Implements ExpandoDefinition::parse() -.

Definition at line 148 of file node_conddate.c.

{
  int count = 1;
  char period = '\0';
 
  if (isdigit(*str))
  {
    unsigned short number = 0;
    const char *end_ptr = mutt_str_atous(str, &number);
 
    // NOTE(g0mb4): str is NOT null-terminated
    if (!end_ptr || (number == USHRT_MAX))
    {
      error->position = str;
      snprintf(error->message, sizeof(error->message), _("Invalid number: %s"), str);
      return NULL;
    }
 
    count = number;
    str = end_ptr;
  };
 
  // Allowed periods: year, month, week, day, hour, minute
  if (!strchr("ymwdHM", *str))
  {
    error->position = str;
    snprintf(error->message, sizeof(error->message),
             // L10N: The 'ymwdHM' should not be translated
             _("Invalid time period: '%c', must be one of 'ymwdHM'"), *str);
    return NULL;
  }
 
  period = *str;
  *parsed_until = str + 1;
 
  return node_conddate_new(count, period, did, uid);
}

Here is the call graph for this function:

Here is the caller graph for this function:

node_padding_parse()

struct ExpandoNode * node_padding_parse	(	const char *	str,
		const char **	parsed_until,
		int	did,
		int	uid,
		ExpandoParserFlags	flags,
		struct ExpandoParseError *	error
	)

Parse a Padding Expando - Implements ExpandoDefinition::parse() -.

Parse a Padding Expando of the form, "%|X", "%>X" or "%*X", where the character 'X' will be used to fill the space.

Definition at line 232 of file node_padding.c.

{
  if (flags & EP_CONDITIONAL)
  {
    snprintf(error->message, sizeof(error->message),
             // L10N: Conditional Expandos can only depend on other Expandos
             //       e.g. "%<X?apple>" displays "apple" if "%X" is true.
             _("Padding cannot be used as a condition"));
    error->position = str;
    return NULL;
  }
 
  enum ExpandoPadType pt = 0;
  if (*str == '|')
  {
    pt = EPT_FILL_EOL;
  }
  else if (*str == '>')
  {
    pt = EPT_HARD_FILL;
  }
  else if (*str == '*')
  {
    pt = EPT_SOFT_FILL;
  }
  else
  {
    return NULL;
  }
  str++;
 
  const size_t consumed = mutt_mb_charlen(str, NULL);
 
  *parsed_until = str + consumed;
  return node_padding_new(pt, str, str + consumed);
}

Here is the call graph for this function:

parse_index_date_recv_local()

struct ExpandoNode * parse_index_date_recv_local	(	const char *	str,
		const char **	parsed_until,
		int	did,
		int	uid,
		ExpandoParserFlags	flags,
		struct ExpandoParseError *	error
	)

Parse a Date Expando - Implements ExpandoDefinition::parse() -.

Parse a custom Expando of the form, "%(string)". The "string" will be passed to strftime().

Definition at line 163 of file mutt_config.c.

{
  if (flags & EP_CONDITIONAL)
  {
    return node_conddate_parse(str + 1, parsed_until, did, uid, error);
  }
 
  return node_expando_parse_enclosure(str, parsed_until, did, uid, ')', error);
}

Here is the call graph for this function:

parse_index_date_local()

struct ExpandoNode * parse_index_date_local	(	const char *	str,
		const char **	parsed_until,
		int	did,
		int	uid,
		ExpandoParserFlags	flags,
		struct ExpandoParseError *	error
	)

Parse a Date Expando - Implements ExpandoDefinition::parse() -.

Parse a custom expando of the form, "%[string]". The "string" will be passed to strftime().

Definition at line 181 of file mutt_config.c.

{
  if (flags & EP_CONDITIONAL)
  {
    return node_conddate_parse(str + 1, parsed_until, did, uid, error);
  }
 
  return node_expando_parse_enclosure(str, parsed_until, did, uid, ']', error);
}

Here is the call graph for this function:

parse_index_date()

struct ExpandoNode * parse_index_date	(	const char *	str,
		const char **	parsed_until,
		int	did,
		int	uid,
		ExpandoParserFlags	flags,
		struct ExpandoParseError *	error
	)

Parse a Date Expando - Implements ExpandoDefinition::parse() -.

Parse a custom Expando of the form, "%{string}". The "string" will be passed to strftime().

Definition at line 199 of file mutt_config.c.

{
  if (flags & EP_CONDITIONAL)
  {
    return node_conddate_parse(str + 1, parsed_until, did, uid, error);
  }
 
  return node_expando_parse_enclosure(str, parsed_until, did, uid, '}', error);
}

Here is the call graph for this function:

parse_index_hook()

struct ExpandoNode * parse_index_hook	(	const char *	str,
		const char **	parsed_until,
		int	did,
		int	uid,
		ExpandoParserFlags	flags,
		struct ExpandoParseError *	error
	)

Parse an index-hook - Implements ExpandoDefinition::parse() -.

Parse a custom Expando of the form, "%@name@". The "name" will be looked up as an index-hook, then the result parsed as an Expando.

Definition at line 218 of file mutt_config.c.

{
  if (flags & EP_CONDITIONAL)
  {
    snprintf(error->message, sizeof(error->message),
             _("index-hook cannot be used as a condition"));
    error->position = str;
    return NULL;
  }
 
  return node_expando_parse_enclosure(str, parsed_until, did, uid, '@', error);
}

Here is the call graph for this function:

parse_tags_transformed()

struct ExpandoNode * parse_tags_transformed	(	const char *	str,
		const char **	parsed_until,
		int	did,
		int	uid,
		ExpandoParserFlags	flags,
		struct ExpandoParseError *	error
	)

Parse a Tags-Transformed Expando - Implements ExpandoDefinition::parse() -.

Parse a custom expando of the form, "%G?" where '?' is an alphabetic character.

Definition at line 238 of file mutt_config.c.

{
  // Let the basic expando parser do the work
  flags |= EP_NO_CUSTOM_PARSE;
  struct ExpandoNode *node = node_expando_parse(str, parsed_until,
                                                IndexFormatDef, flags, error);
 
  // but adjust the node to take one more character
  node->end++;
  (*parsed_until)++;
 
  return node;
}

Here is the call graph for this function:

parse_subject()

struct ExpandoNode * parse_subject	(	const char *	str,
		const char **	parsed_until,
		int	did,
		int	uid,
		ExpandoParserFlags	flags,
		struct ExpandoParseError *	error
	)

Parse a Subject Expando - Implements ExpandoDefinition::parse() -.

Parse a Subject Expando, "%s", into two separate Nodes. One for the tree, one for the subject.

Definition at line 260 of file mutt_config.c.

{
  // Let the basic expando parser do the work
  flags |= EP_NO_CUSTOM_PARSE;
  struct ExpandoNode *node_subj = node_expando_parse(str, parsed_until,
                                                     IndexFormatDef, flags, error);
 
  struct ExpandoNode *node_tree = node_expando_new(node_subj->start, node_subj->end,
                                                   NULL, ED_ENVELOPE, ED_ENV_THREAD_TREE);
  node_tree->next = node_subj;
 
  // Move the formatting info to the container
  struct ExpandoNode *node_cont = node_container_new();
  node_cont->format = node_subj->format;
  node_subj->format = NULL;
 
  ARRAY_ADD(&node_cont->children, node_tree);
  return node_cont;
}

Here is the call graph for this function:

parse_pgp_date()

struct ExpandoNode * parse_pgp_date	(	const char *	str,
		const char **	parsed_until,
		int	did,
		int	uid,
		ExpandoParserFlags	flags,
		struct ExpandoParseError *	error
	)

Parse a Date Expando - Implements ExpandoDefinition::parse() -.

Parse a custom Expando of the form, "%[string]". The "string" will be passed to strftime().

Definition at line 62 of file config.c.

{
  if (flags & EP_CONDITIONAL)
  {
    return node_conddate_parse(str + 1, parsed_until, did, uid, error);
  }
 
  return node_expando_parse_enclosure(str, parsed_until, did, uid, ']', error);
}

Here is the call graph for this function: