expando.h File Reference

Parsed Expando. More...

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

Include dependency graph for expando.h:

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

Go to the source code of this file.

Data Structures
struct	Expando
	Parsed Expando trees. More...

Functions
void	expando_free (struct Expando **ptr)
	Free an Expando object.
struct Expando *	expando_new (const char *format)
	Create an Expando from a string.
bool	expando_equal (const struct Expando *a, const struct Expando *b)
	Compare two expandos.
struct Expando *	expando_parse (const char *str, const struct ExpandoDefinition *defs, struct Buffer *err)
	Parse an Expando string.
int	expando_render (const struct Expando *exp, const struct ExpandoRenderData *rdata, void *data, MuttFormatFlags flags, int max_cols, struct Buffer *buf)
	Render an Expando + data into a string.

Detailed Description

Parsed 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 expando.h.

Function Documentation

expando_free()

void expando_free

(

struct Expando **

ptr

)

Free an Expando object.

Parameters

[out]

ptr

Expando to free

Definition at line 58 of file expando.c.

{
  if (!ptr || !*ptr)
    return;
 
  struct Expando *exp = *ptr;
 
  node_free(&exp->node);
  FREE(&exp->string);
 
  FREE(ptr);
}

Here is the call graph for this function:

Here is the caller graph for this function:

expando_new()

struct Expando * expando_new

(

const char *

format

)

Create an Expando from a string.

Parameters

format

Format string to parse

Return values

ptr	New Expando object

Definition at line 46 of file expando.c.

{
  struct Expando *exp = mutt_mem_calloc(1, sizeof(struct Expando));
  exp->string = mutt_str_dup(format);
  exp->node = node_container_new();
  return exp;
}

Here is the call graph for this function:

Here is the caller graph for this function:

expando_equal()

bool expando_equal	(	const struct Expando *	a,
		const struct Expando *	b
	)

Compare two expandos.

Parameters

a	First Expando
b	Second Expando

Return values

true	They are identical

Definition at line 143 of file expando.c.

{
  if (!a && !b) /* both empty */
    return true;
  if (!a ^ !b) /* one is empty, but not the other */
    return false;
 
  return mutt_str_equal(a->string, b->string);
}

Here is the call graph for this function:

Here is the caller graph for this function:

expando_parse()

struct Expando * expando_parse	(	const char *	str,
		const struct ExpandoDefinition *	defs,
		struct Buffer *	err
	)

Parse an Expando string.

Parameters

str	String to parse
defs	Data defining Expando
err	Buffer for error messages

Return values

ptr	New Expando

Definition at line 78 of file expando.c.

{
  if (!str || (*str == '\0') || !defs)
    return NULL;
 
  struct Expando *exp = expando_new(str);
 
  struct ExpandoParseError error = { 0 };
  const char *end = NULL;
  const char *start = exp->string;
 
  while (*start)
  {
    struct ExpandoNode *node = node_parse(start, NULL, CON_NO_CONDITION, &end, defs, &error);
    if (!node)
      break;
 
    node_add_child(exp->node, node);
    start = end;
  }
 
  if (error.position)
  {
    buf_strcpy(err, error.message);
    expando_free(&exp);
    return NULL;
  }
 
  // Optimise the tree layout
  node_padding_repad(&exp->node);
  node_container_collapse_all(&exp->node);
 
  return exp;
}

Here is the call graph for this function:

Here is the caller graph for this function:

expando_render()

int expando_render	(	const struct Expando *	exp,
		const struct ExpandoRenderData *	rdata,
		void *	data,
		MuttFormatFlags	flags,
		int	max_cols,
		struct Buffer *	buf
	)

Render an Expando + data into a string.

Parameters

[in]	exp	Expando containing the expando tree
[in]	rdata	Expando render data
[in]	data	Callback data
[in]	flags	Callback flags
[in]	max_cols	Number of screen columns (-1 means unlimited)
[out]	buf	Buffer in which to save string

Return values

num	Number of bytes written to buf and screen columns used

Definition at line 124 of file expando.c.

{
  if (!exp || !exp->node || !rdata)
    return 0;
 
  // Give enough space for a long command line
  if (max_cols == -1)
    max_cols = 8192;
 
  return node_render(exp->node, rdata, buf, max_cols, data, flags);
}

Here is the call graph for this function:

Here is the caller graph for this function: