Expando Render API

Render an Expando. More...

Functions
int	node_condbool_render (const struct ExpandoNode *node, const struct ExpandoRenderCallback *erc, struct Buffer *buf, int max_cols, void *data, MuttFormatFlags flags)
	Callback for every bool node - Implements ExpandoNode::render() -.
int	node_conddate_render (const struct ExpandoNode *node, const struct ExpandoRenderCallback *erc, struct Buffer *buf, int max_cols, void *data, MuttFormatFlags flags)
	Render a CondDate Node - Implements ExpandoNode::render() -.
static int	node_condition_render (const struct ExpandoNode *node, const struct ExpandoRenderCallback *erc, struct Buffer *buf, int max_cols, void *data, MuttFormatFlags flags)
	Render a Conditional Node - Implements ExpandoNode::render() -.
int	node_container_render (const struct ExpandoNode *node, const struct ExpandoRenderCallback *erc, struct Buffer *buf, int max_cols, void *data, MuttFormatFlags flags)
	Callback for a Container Node - Implements ExpandoNode::render() -.
int	node_expando_render (const struct ExpandoNode *node, const struct ExpandoRenderCallback *erc, struct Buffer *buf, int max_cols, void *data, MuttFormatFlags flags)
	Render an Expando Node - Implements ExpandoNode::render() -.
int	node_padding_render_eol (const struct ExpandoNode *node, const struct ExpandoRenderCallback *erc, struct Buffer *buf, int max_cols, void *data, MuttFormatFlags flags)
	Render End-of-Line Padding - Implements ExpandoNode::render() -.
int	node_padding_render_hard (const struct ExpandoNode *node, const struct ExpandoRenderCallback *erc, struct Buffer *buf, int max_cols, void *data, MuttFormatFlags flags)
	Render Hard Padding - Implements ExpandoNode::render() -.
int	node_padding_render_soft (const struct ExpandoNode *node, const struct ExpandoRenderCallback *erc, struct Buffer *buf, int max_cols, void *data, MuttFormatFlags flags)
	Render Soft Padding - Implements ExpandoNode::render() -.
static int	node_text_render (const struct ExpandoNode *node, const struct ExpandoRenderCallback *erc, struct Buffer *buf, int max_cols, void *data, MuttFormatFlags flags)
	Render a Text Node - Implements ExpandoNode::render() -.

Detailed Description

Render an Expando.

Parameters

[in]	node	Node to render
[in]	erc	Expando Render Callback functions
[out]	buf	Buffer in which to save string
[in]	max_cols	Maximum number of screen columns to use
[in]	data	Private data
[in]	flags	Flags, see MuttFormatFlags

Return values

num	Number of screen columns used

Function Documentation

node_condbool_render()

int node_condbool_render	(	const struct ExpandoNode *	node,
		const struct ExpandoRenderCallback *	erc,
		struct Buffer *	buf,
		int	max_cols,
		void *	data,
		MuttFormatFlags	flags
	)

Callback for every bool node - Implements ExpandoNode::render() -.

Definition at line 41 of file node_condbool.c.

{
  ASSERT(node->type == ENT_CONDBOOL);
 
  const struct ExpandoRenderCallback *erc_match = find_get_number(erc, node->did, node->uid);
  if (erc_match)
  {
    const long num = erc_match->get_number(node, data, flags);
    return (num != 0); // bool-ify
  }
 
  erc_match = find_get_string(erc, node->did, node->uid);
  if (erc_match)
  {
    struct Buffer *buf_str = buf_pool_get();
    erc_match->get_string(node, data, flags, buf_str);
    const size_t len = buf_len(buf_str);
    buf_pool_release(&buf_str);
 
    return (len > 0); // bool-ify
  }
 
  return 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

node_conddate_render()

int node_conddate_render	(	const struct ExpandoNode *	node,
		const struct ExpandoRenderCallback *	erc,
		struct Buffer *	buf,
		int	max_cols,
		void *	data,
		MuttFormatFlags	flags
	)

Render a CondDate Node - Implements ExpandoNode::render() -.

Definition at line 169 of file node_conddate.c.

{
  ASSERT(node->type == ENT_CONDDATE);
 
  const struct ExpandoRenderCallback *erc_match = find_get_number(erc, node->did, node->uid);
  ASSERT(erc_match && "Unknown UID");
 
  const long t_test = erc_match->get_number(node, data, flags);
 
  const struct NodeCondDatePrivate *priv = node->ndata;
 
  time_t t_cutoff;
  if (priv->count == 0)
    t_cutoff = cutoff_this(priv->period);
  else
    t_cutoff = cutoff_number(priv->period, priv->count);
 
  return (t_test > t_cutoff); // bool-ify
}

Here is the call graph for this function:

Here is the caller graph for this function:

node_condition_render()

static int node_condition_render ( const struct ExpandoNode *  node, const struct ExpandoRenderCallback *  erc, struct Buffer *  buf, int  max_cols, void *  data, MuttFormatFlags  flags  )

static

Render a Conditional Node - Implements ExpandoNode::render() -.

Definition at line 49 of file node_condition.c.

{
  ASSERT(node->type == ENT_CONDITION);
 
  const struct ExpandoNode *node_cond = node_get_child(node, ENC_CONDITION);
 
  // Discard any text returned, just use the return value as a bool
  struct Buffer *buf_cond = buf_pool_get();
  int rc_cond = node_cond->render(node_cond, erc, buf_cond, max_cols, data, flags);
 
  int rc = 0;
  buf_reset(buf_cond);
 
  if (rc_cond == true)
  {
    const struct ExpandoNode *node_true = node_get_child(node, ENC_TRUE);
    rc = node_render(node_true, erc, buf_cond, max_cols, data, flags);
  }
  else
  {
    const struct ExpandoNode *node_false = node_get_child(node, ENC_FALSE);
    rc = node_render(node_false, erc, buf_cond, max_cols, data, flags);
  }
 
  const struct ExpandoFormat *fmt = node->format;
  if (!fmt)
  {
    buf_addstr(buf, buf_string(buf_cond));
    buf_pool_release(&buf_cond);
    return rc;
  }
 
  struct Buffer *tmp = buf_pool_get();
 
  int min_cols = MAX(fmt->min_cols, fmt->max_cols);
  min_cols = MIN(min_cols, max_cols);
  if (fmt->max_cols >= 0)
    max_cols = MIN(max_cols, fmt->max_cols);
  rc = format_string(tmp, min_cols, max_cols, fmt->justification, ' ',
                     buf_string(buf_cond), buf_len(buf_cond), true);
  if (fmt->lower)
    buf_lower_special(tmp);
 
  buf_addstr(buf, buf_string(tmp));
  buf_pool_release(&tmp);
  buf_pool_release(&buf_cond);
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

node_container_render()

int node_container_render	(	const struct ExpandoNode *	node,
		const struct ExpandoRenderCallback *	erc,
		struct Buffer *	buf,
		int	max_cols,
		void *	data,
		MuttFormatFlags	flags
	)

Callback for a Container Node - Implements ExpandoNode::render() -.

Definition at line 43 of file node_container.c.

{
  ASSERT(node->type == ENT_CONTAINER);
 
  const struct ExpandoFormat *fmt = node->format;
  if (fmt && (fmt->max_cols != -1))
    max_cols = MIN(max_cols, fmt->max_cols);
 
  int total_cols = 0;
 
  struct Buffer *tmp = buf_pool_get();
  struct ExpandoNode **enp = NULL;
  ARRAY_FOREACH(enp, &node->children)
  {
    if (total_cols >= max_cols)
      break;
    total_cols += node_render(*enp, erc, tmp, max_cols - total_cols, data, flags);
  }
 
  struct Buffer *tmp2 = buf_pool_get();
  if (fmt)
  {
    int max = max_cols;
    if (fmt->max_cols >= 0)
      max = MIN(max_cols, fmt->max_cols);
    int min = MIN(fmt->min_cols, max);
 
    total_cols = format_string(tmp2, min, max, fmt->justification, ' ',
                               buf_string(tmp), buf_len(tmp), true);
 
    if (fmt->lower)
      buf_lower_special(tmp2);
  }
  else
  {
    total_cols = format_string(tmp2, 0, max_cols, JUSTIFY_LEFT, ' ',
                               buf_string(tmp), buf_len(tmp), true);
  }
  buf_addstr(buf, buf_string(tmp2));
  buf_pool_release(&tmp2);
 
  buf_pool_release(&tmp);
  return total_cols;
}

Here is the call graph for this function:

Here is the caller graph for this function:

node_expando_render()

int node_expando_render	(	const struct ExpandoNode *	node,
		const struct ExpandoRenderCallback *	erc,
		struct Buffer *	buf,
		int	max_cols,
		void *	data,
		MuttFormatFlags	flags
	)

Render an Expando Node - Implements ExpandoNode::render() -.

Definition at line 404 of file node_expando.c.

{
  ASSERT(node->type == ENT_EXPANDO);
 
  struct Buffer *buf_expando = buf_pool_get();
  struct Buffer *buf_format = buf_pool_get();
 
  const struct ExpandoFormat *fmt = node->format;
  const struct NodeExpandoPrivate *priv = node->ndata;
 
  // ---------------------------------------------------------------------------
  // Numbers and strings get treated slightly differently. We prefer strings.
  // This allows dates to be stored as 1729850182, but displayed as "2024-10-25".
 
  const struct ExpandoRenderCallback *erc_match = find_get_string(erc, node->did, node->uid);
  if (erc_match)
  {
    erc_match->get_string(node, data, flags, buf_expando);
 
    if (fmt && fmt->lower)
      buf_lower_special(buf_expando);
  }
  else
  {
    erc_match = find_get_number(erc, node->did, node->uid);
    ASSERT(erc_match && "Unknown UID");
 
    const long num = erc_match->get_number(node, data, flags);
 
    int precision = 1;
 
    if (fmt)
    {
      precision = fmt->max_cols;
      if ((precision < 0) && (fmt->leader == '0'))
        precision = fmt->min_cols;
    }
 
    if (num < 0)
      precision--; // Allow space for the '-' sign
 
    buf_printf(buf_expando, "%.*ld", precision, num);
  }
 
  // ---------------------------------------------------------------------------
 
  int max = max_cols;
  int min = 0;
 
  if (fmt)
  {
    min = fmt->min_cols;
    if (fmt->max_cols > 0)
      max = MIN(max_cols, fmt->max_cols);
  }
 
  const enum FormatJustify just = fmt ? fmt->justification : JUSTIFY_LEFT;
 
  int total_cols = format_string(buf_format, min, max, just, ' ', buf_string(buf_expando),
                                 buf_len(buf_expando), priv->has_tree);
 
  if (!buf_is_empty(buf_format))
  {
    if (priv->color > -1)
      add_color(buf, priv->color);
 
    buf_addstr(buf, buf_string(buf_format));
 
    if (priv->color > -1)
      add_color(buf, MT_COLOR_INDEX);
  }
 
  buf_pool_release(&buf_format);
  buf_pool_release(&buf_expando);
 
  return total_cols;
}

Here is the call graph for this function:

Here is the caller graph for this function:

node_padding_render_eol()

int node_padding_render_eol	(	const struct ExpandoNode *	node,
		const struct ExpandoRenderCallback *	erc,
		struct Buffer *	buf,
		int	max_cols,
		void *	data,
		MuttFormatFlags	flags
	)

Render End-of-Line Padding - Implements ExpandoNode::render() -.

Definition at line 105 of file node_padding.c.

{
  struct ExpandoNode *left = node_get_child(node, ENP_LEFT);
 
  int total_cols = node_render(left, erc, buf, max_cols, data, flags);
 
  total_cols += pad_string(node, buf, max_cols - total_cols);
 
  return total_cols;
}

Here is the call graph for this function:

Here is the caller graph for this function:

node_padding_render_hard()

int node_padding_render_hard	(	const struct ExpandoNode *	node,
		const struct ExpandoRenderCallback *	erc,
		struct Buffer *	buf,
		int	max_cols,
		void *	data,
		MuttFormatFlags	flags
	)

Render Hard Padding - Implements ExpandoNode::render() -.

Text to the left of the padding is hard and will be preserved if possible. Text to the right of the padding will be truncated.

Definition at line 124 of file node_padding.c.

{
  struct Buffer *buf_left = buf_pool_get();
  struct Buffer *buf_pad = buf_pool_get();
  struct Buffer *buf_right = buf_pool_get();
 
  int cols_used = 0;
 
  struct ExpandoNode *left = node_get_child(node, ENP_LEFT);
  if (left)
    cols_used += node_render(left, erc, buf_left, max_cols - cols_used, data, flags);
 
  struct ExpandoNode *right = node_get_child(node, ENP_RIGHT);
  if (right)
    cols_used += node_render(right, erc, buf_right, max_cols - cols_used, data, flags);
 
  if (max_cols > cols_used)
    cols_used += pad_string(node, buf_pad, max_cols - cols_used);
 
  buf_addstr(buf, buf_string(buf_left));
  buf_addstr(buf, buf_string(buf_pad));
  buf_addstr(buf, buf_string(buf_right));
 
  buf_pool_release(&buf_left);
  buf_pool_release(&buf_pad);
  buf_pool_release(&buf_right);
 
  return cols_used;
}

Here is the call graph for this function:

Here is the caller graph for this function:

node_padding_render_soft()

int node_padding_render_soft	(	const struct ExpandoNode *	node,
		const struct ExpandoRenderCallback *	erc,
		struct Buffer *	buf,
		int	max_cols,
		void *	data,
		MuttFormatFlags	flags
	)

Render Soft Padding - Implements ExpandoNode::render() -.

Text to the right of the padding is hard and will be preserved if possible. Text to the left of the padding will be truncated.

Definition at line 162 of file node_padding.c.

{
  struct Buffer *buf_left = buf_pool_get();
  struct Buffer *buf_pad = buf_pool_get();
  struct Buffer *buf_right = buf_pool_get();
 
  int cols_used = 0;
 
  struct ExpandoNode *right = node_get_child(node, ENP_RIGHT);
  if (right)
    cols_used += node_render(right, erc, buf_right, max_cols - cols_used, data, flags);
 
  struct ExpandoNode *left = node_get_child(node, ENP_LEFT);
  if (left)
    cols_used += node_render(left, erc, buf_left, max_cols - cols_used, data, flags);
 
  if (max_cols > cols_used)
    cols_used += pad_string(node, buf_pad, max_cols - cols_used);
 
  buf_addstr(buf, buf_string(buf_left));
  buf_addstr(buf, buf_string(buf_pad));
  buf_addstr(buf, buf_string(buf_right));
 
  buf_pool_release(&buf_left);
  buf_pool_release(&buf_pad);
  buf_pool_release(&buf_right);
 
  return cols_used;
}

Here is the call graph for this function:

Here is the caller graph for this function:

node_text_render()

static int node_text_render ( const struct ExpandoNode *  node, const struct ExpandoRenderCallback *  erc, struct Buffer *  buf, int  max_cols, void *  data, MuttFormatFlags  flags  )

static

Render a Text Node - Implements ExpandoNode::render() -.

Definition at line 42 of file node_text.c.

{
  ASSERT(node->type == ENT_TEXT);
 
  return format_string(buf, 0, max_cols, JUSTIFY_LEFT, ' ', node->text,
                       mutt_str_len(node->text), false);
}

Here is the call graph for this function:

Here is the caller graph for this function: