node.h File Reference

Basic Expando Node. More...

#include <stdbool.h>
#include "mutt/lib.h"
#include "format.h"
#include "render.h"

Include dependency graph for node.h:

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

Go to the source code of this file.

Data Structures
struct	ExpandoFormat
	Formatting information for an Expando. More...
struct	ExpandoNode
	Basic Expando Node. More...

Enumerations
enum	ExpandoNodeType {   ENT_EMPTY = 0 , ENT_TEXT , ENT_EXPANDO , ENT_PADDING ,   ENT_CONDITION , ENT_CONDBOOL , ENT_CONDDATE , ENT_CONTAINER }
	Type of Expando Node. More...

Functions
	ARRAY_HEAD (ExpandoNodeArray, struct ExpandoNode *)
struct ExpandoNode *	node_new (void)
	Create a new empty ExpandoNode.
void	node_free (struct ExpandoNode **ptr)
	Free an ExpandoNode and its private data.
void	node_tree_free (struct ExpandoNode **ptr)
	Free a tree of ExpandoNodes.
void	node_append (struct ExpandoNode **root, struct ExpandoNode *new_node)
	Append an ExpandoNode to an existing node.
struct ExpandoNode *	node_get_child (const struct ExpandoNode *node, int index)
	Get a child of an ExpandoNode.
struct ExpandoNode *	node_last (struct ExpandoNode *node)
	Find the last Node in a tree.

Detailed Description

Basic Expando Node.

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

Enumeration Type Documentation

ExpandoNodeType

enum ExpandoNodeType

Type of Expando Node.

Enumerator
ENT_EMPTY	Empty.
ENT_TEXT	Plain text.
ENT_EXPANDO	Expando, e.g. 'n'.
ENT_PADDING	Padding: soft, hard, EOL.
ENT_CONDITION	True/False condition.
ENT_CONDBOOL	True/False boolean condition.
ENT_CONDDATE	True/False date condition.
ENT_CONTAINER	Container for other nodes.

Definition at line 35 of file node.h.

{
  ENT_EMPTY = 0,      
  ENT_TEXT,           
  ENT_EXPANDO,        
  ENT_PADDING,        
  ENT_CONDITION,      
  ENT_CONDBOOL,       
  ENT_CONDDATE,       
  ENT_CONTAINER,      
};

Function Documentation

ARRAY_HEAD()

ARRAY_HEAD	(	ExpandoNodeArray	,
		struct ExpandoNode *
	)

node_new()

struct ExpandoNode * node_new

(

void

)

Create a new empty ExpandoNode.

Return values

ptr	New ExpandoNode

Definition at line 39 of file node.c.

{
  return mutt_mem_calloc(1, sizeof(struct ExpandoNode));
}

Here is the call graph for this function:

Here is the caller graph for this function:

node_free()

void node_free

(

struct ExpandoNode **

ptr

)

Free an ExpandoNode and its private data.

Parameters

ptr	Node to free

Definition at line 48 of file node.c.

{
  if (!ptr || !*ptr)
    return;
 
  struct ExpandoNode *node = *ptr;
  if (node->ndata_free)
  {
    node->ndata_free(&node->ndata);
  }
 
  struct ExpandoNode **enp = NULL;
  ARRAY_FOREACH(enp, &node->children)
  {
    node_tree_free(enp);
  }
 
  FREE(&node->format);
 
  ARRAY_FREE(&node->children);
 
  FREE(ptr);
}

Here is the call graph for this function:

Here is the caller graph for this function:

node_tree_free()

void node_tree_free

(

struct ExpandoNode **

ptr

)

Free a tree of ExpandoNodes.

Parameters

ptr	Root of tree to free

Definition at line 76 of file node.c.

{
  if (!ptr || !*ptr)
    return;
 
  struct ExpandoNode *node = *ptr;
  while (node)
  {
    struct ExpandoNode *n = node;
    node = node->next;
    node_free(&n);
  }
 
  *ptr = NULL;
}

Here is the call graph for this function:

Here is the caller graph for this function:

node_append()

void node_append	(	struct ExpandoNode **	root,
		struct ExpandoNode *	new_node
	)

Append an ExpandoNode to an existing node.

Parameters

[in,out]	root	Existing node (may be NULL)
[in]	new_node	Node to add

Definition at line 116 of file node.c.

{
  if (!*root)
  {
    *root = new_node;
    return;
  }
 
  struct ExpandoNode *node = *root;
  while (node->next)
  {
    node = node->next;
  }
 
  node->next = new_node;
}

Here is the caller graph for this function:

node_get_child()

struct ExpandoNode * node_get_child	(	const struct ExpandoNode *	node,
		int	index
	)

Get a child of an ExpandoNode.

Parameters

node	Parent node
index	Index of child to get

Return values

ptr	Child node
NULL	No child, or index out of range

Definition at line 99 of file node.c.

{
  if (!node)
    return NULL;
 
  struct ExpandoNode **ptr = ARRAY_GET(&node->children, index);
  if (!ptr)
    return NULL;
 
  return *ptr;
}

Here is the caller graph for this function:

node_last()

struct ExpandoNode * node_last

(

struct ExpandoNode *

node

)

Find the last Node in a tree.

Parameters

node

Root Node

Return values

ptr

Last Node

Definition at line 138 of file node.c.

{
  if (!node)
    return NULL;
 
  while (true)
  {
    if (node->next)
    {
      node = node->next;
      continue;
    }
 
    size_t size = ARRAY_SIZE(&node->children);
    if (size == 0)
      break;
 
    struct ExpandoNode *last = node_get_child(node, size - 1);
    if (!last)
      break; // LCOV_EXCL_LINE
 
    node = last;
  }
 
  return node;
}

Here is the call graph for this function:

Here is the caller graph for this function: