serial.c File Reference

Dump the details of an Expando Tree. More...

#include "config.h"
#include <limits.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include "mutt/lib.h"
#include "debug/lib.h"
#include "serial.h"
#include "expando.h"
#include "node.h"
#include "node_conddate.h"
#include "node_condition.h"
#include "node_padding.h"

Include dependency graph for serial.c:

Go to the source code of this file.

Functions
static void	dump_node (const struct ExpandoNode *node, struct Buffer *buf)
	Serialise an Expando Node.
static void	dump_did_uid (const struct ExpandoNode *node, struct Buffer *buf)
	Serialise the Domain ID and UID of an Expando Node.
static void	dump_node_condition (const struct ExpandoNode *node, struct Buffer *buf)
	Serialise a Condition Node.
static void	dump_node_condbool (const struct ExpandoNode *node, struct Buffer *buf)
	Serialise a Conditional Bool Node.
static void	dump_node_conddate (const struct ExpandoNode *node, struct Buffer *buf)
	Serialise a Conditional Date Node.
static void	dump_node_container (const struct ExpandoNode *node, struct Buffer *buf)
	Serialise a Container Node.
static void	dump_node_empty (const struct ExpandoNode *node, struct Buffer *buf)
	Serialise an Empty Node.
static void	dump_node_expando (const struct ExpandoNode *node, struct Buffer *buf)
	Serialise an Expando Node.
static void	dump_node_padding (const struct ExpandoNode *node, struct Buffer *buf)
	Serialise a Padding Node.
static void	dump_node_text (const struct ExpandoNode *node, struct Buffer *buf)
	Serialise a Text Node.
void	expando_serialise (const struct Expando *exp, struct Buffer *buf)
	Serialise an Expando into a string.

Detailed Description

Dump the details of an Expando Tree.

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 serial.c.

Function Documentation

dump_node()

static void dump_node ( const struct ExpandoNode * node, struct Buffer * buf )

static

Serialise an Expando Node.

Parameters

node	Expando Node
buf	Buffer for the result

Definition at line 270 of file serial.c.

{
  if (!node || !buf)
    return;
 
  switch (node->type)
  {
    case ENT_CONDITION:
      dump_node_condition(node, buf);
      break;
    case ENT_CONDBOOL:
      dump_node_condbool(node, buf);
      break;
    case ENT_CONDDATE:
      dump_node_conddate(node, buf);
      break;
    case ENT_CONTAINER:
      dump_node_container(node, buf);
      break;
    case ENT_EMPTY:
      dump_node_empty(node, buf);
      break;
    case ENT_EXPANDO:
      dump_node_expando(node, buf);
      break;
    case ENT_PADDING:
      dump_node_padding(node, buf);
      break;
    case ENT_TEXT:
      dump_node_text(node, buf);
      break;
    default:
      ASSERT(false);
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

dump_did_uid()

static void dump_did_uid ( const struct ExpandoNode * node, struct Buffer * buf )

static

Serialise the Domain ID and UID of an Expando Node.

Parameters

node	Expando Node
buf	Buffer for the result

Definition at line 50 of file serial.c.

{
  const char *did = name_expando_domain(node->did);
  const char *uid = name_expando_uid(node->did, node->uid);
  buf_add_printf(buf, "(%s,%s)", did, uid);
}

Here is the call graph for this function:

Here is the caller graph for this function:

dump_node_condition()

static void dump_node_condition ( const struct ExpandoNode * node, struct Buffer * buf )

static

Serialise a Condition Node.

Parameters

node	Expando Node
buf	Buffer for the result

Definition at line 62 of file serial.c.

{
  buf_addstr(buf, "<COND");
 
  // These shouldn't happen
  if (node->text)
    buf_add_printf(buf, ",text=%s", node->text);
 
  struct ExpandoNode *node_cond = node_get_child(node, ENC_CONDITION);
  struct ExpandoNode *node_true = node_get_child(node, ENC_TRUE);
  struct ExpandoNode *node_false = node_get_child(node, ENC_FALSE);
 
  ASSERT(node_cond);
  buf_addstr(buf, ":");
  dump_node(node_cond, buf);
  buf_addstr(buf, "|");
  dump_node(node_true, buf);
  buf_addstr(buf, "|");
  dump_node(node_false, buf);
 
  const struct ExpandoFormat *fmt = node->format;
  if (fmt)
  {
    const char *just = name_format_justify(fmt->justification);
    if (fmt->max_cols == INT_MAX)
      buf_add_printf(buf, ":{%d,MAX,%s,'%c'}", fmt->min_cols, just + 8, fmt->leader);
    else
      buf_add_printf(buf, ":{%d,%d,%s,'%c'}", fmt->min_cols, fmt->max_cols,
                     just + 8, fmt->leader);
  }
 
  buf_addstr(buf, ">");
}

Here is the call graph for this function:

Here is the caller graph for this function:

dump_node_condbool()

static void dump_node_condbool ( const struct ExpandoNode * node, struct Buffer * buf )

static

Serialise a Conditional Bool Node.

Parameters

node	Expando Node
buf	Buffer for the result

Definition at line 101 of file serial.c.

{
  buf_addstr(buf, "<BOOL");
  dump_did_uid(node, buf);
 
  ASSERT(node->ndata != NULL);
  ASSERT(node->ndata_free != NULL);
 
  buf_addstr(buf, ">");
}

Here is the call graph for this function:

Here is the caller graph for this function:

dump_node_conddate()

static void dump_node_conddate ( const struct ExpandoNode * node, struct Buffer * buf )

static

Serialise a Conditional Date Node.

Parameters

node	Expando Node
buf	Buffer for the result

Definition at line 117 of file serial.c.

{
  buf_addstr(buf, "<DATE:");
 
  dump_did_uid(node, buf);
 
  ASSERT(node->ndata);
  ASSERT(node->ndata_free);
  struct NodeCondDatePrivate *priv = node->ndata;
  buf_add_printf(buf, ":%d:%c", priv->count, priv->period);
 
  // These shouldn't happen
  if (node->text)
    buf_add_printf(buf, ",text=%s", node->text);
 
  buf_addstr(buf, ">");
}

Here is the call graph for this function:

Here is the caller graph for this function:

dump_node_container()

static void dump_node_container ( const struct ExpandoNode * node, struct Buffer * buf )

static

Serialise a Container Node.

Parameters

node	Expando Node
buf	Buffer for the result

Definition at line 140 of file serial.c.

{
  buf_addstr(buf, "<CONT:");
 
  struct ExpandoNode **np = NULL;
  ARRAY_FOREACH(np, &node->children)
  {
    if (!np || !*np)
      continue;
 
    dump_node(*np, buf);
  }
 
  buf_addstr(buf, ">");
}

Here is the call graph for this function:

Here is the caller graph for this function:

dump_node_empty()

static void dump_node_empty ( const struct ExpandoNode * node, struct Buffer * buf )

static

Serialise an Empty Node.

Parameters

node	Expando Node
buf	Buffer for the result

Definition at line 161 of file serial.c.

{
  buf_addstr(buf, "<EMPTY");
 
  // These shouldn't happen
  if (node->did != 0)
    buf_add_printf(buf, ",did=%d", node->did);
  if (node->uid != 0)
    buf_add_printf(buf, ",uid=%d", node->uid);
  if (node->text)
    buf_add_printf(buf, ",text=%s", node->text);
  if (node->ndata)
    buf_add_printf(buf, ",ndata=%p", node->ndata);
  if (node->ndata_free)
    buf_add_printf(buf, ",ndata_free=%p", (void *) (intptr_t) node->ndata_free);
 
  buf_addstr(buf, ">");
}

Here is the call graph for this function:

Here is the caller graph for this function:

dump_node_expando()

static void dump_node_expando ( const struct ExpandoNode * node, struct Buffer * buf )

static

Serialise an Expando Node.

Parameters

node	Expando Node
buf	Buffer for the result

Definition at line 185 of file serial.c.

{
  buf_addstr(buf, "<EXP:");
 
  if (node->text)
    buf_add_printf(buf, "'%s'", node->text);
 
  ASSERT(node->did != 0);
  ASSERT(node->uid != 0);
  dump_did_uid(node, buf);
 
  ASSERT(node->ndata);
  ASSERT(node->ndata_free);
 
  const struct ExpandoFormat *fmt = node->format;
  if (fmt)
  {
    const char *just = name_format_justify(fmt->justification);
    if (fmt->max_cols == INT_MAX)
      buf_add_printf(buf, ":{%d,MAX,%s,'%c'}", fmt->min_cols, just + 8, fmt->leader);
    else
      buf_add_printf(buf, ":{%d,%d,%s,'%c'}", fmt->min_cols, fmt->max_cols,
                     just + 8, fmt->leader);
  }
 
  buf_addstr(buf, ">");
}

Here is the call graph for this function:

Here is the caller graph for this function:

dump_node_padding()

static void dump_node_padding ( const struct ExpandoNode * node, struct Buffer * buf )

static

Serialise a Padding Node.

Parameters

node	Expando Node
buf	Buffer for the result

Definition at line 218 of file serial.c.

{
  buf_addstr(buf, "<PAD:");
 
  ASSERT(node->ndata);
  ASSERT(node->ndata_free);
  struct NodePaddingPrivate *priv = node->ndata;
 
  struct ExpandoNode *left = node_get_child(node, ENP_LEFT);
  struct ExpandoNode *right = node_get_child(node, ENP_RIGHT);
 
  const char *pt = name_expando_pad_type(priv->pad_type);
  pt += 4; // Skip "EPT_" prefix
  buf_add_printf(buf, "%s:", pt);
 
  ASSERT(node->text);
  buf_add_printf(buf, "'%s'", node->text);
 
  buf_addstr(buf, ":");
  dump_node(left, buf);
  buf_addstr(buf, "|");
  dump_node(right, buf);
 
  buf_addstr(buf, ">");
}

Here is the call graph for this function:

Here is the caller graph for this function:

dump_node_text()

static void dump_node_text ( const struct ExpandoNode * node, struct Buffer * buf )

static

Serialise a Text Node.

Parameters

node	Expando Node
buf	Buffer for the result

Definition at line 249 of file serial.c.

{
  buf_addstr(buf, "<TEXT:");
 
  ASSERT(node->text);
  buf_add_printf(buf, "'%s'", node->text);
 
  // These shouldn't happen
  if (node->ndata)
    buf_add_printf(buf, ",ndata=%p", node->ndata);
  if (node->ndata_free)
    buf_add_printf(buf, ",ndata_free=%p", (void *) (intptr_t) node->ndata_free);
 
  buf_addstr(buf, ">");
}

Here is the call graph for this function:

Here is the caller graph for this function:

expando_serialise()

void expando_serialise	(	const struct Expando *	exp,
		struct Buffer *	buf )

Serialise an Expando into a string.

Parameters

exp	Expando
buf	Buffer for the result

Definition at line 311 of file serial.c.

{
  if (!exp || !buf)
    return;
 
  dump_node(exp->node, buf);
}

Here is the call graph for this function: