#include <stdint.h>

Include dependency graph for node_text.h:

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

Typedefs
typedef uint8_t	NodeTextTermFlags

Enumerations
enum	NodeTextTermFlag { NTE_NONE = 0 , NTE_AMPERSAND = 1U << 0 , NTE_GREATER = 1U << 1 , NTE_QUESTION = 1U << 2 }
	Special characters that end a text string. More...

Functions
struct ExpandoNode *	node_text_new (const char *text)
	Create a new Text ExpandoNode.

struct ExpandoNode *	node_text_parse (const char str, NodeTextTermFlags term_chars, const char *parsed_until)
	Extract a block of text.

Detailed Description

Expando Node for Text.

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

Typedef Documentation

◆ NodeTextTermFlags

typedef uint8_t NodeTextTermFlags

Definition at line 39 of file node_text.h.

Enumeration Type Documentation

◆ NodeTextTermFlag

enum NodeTextTermFlag

Special characters that end a text string.

Enumerator
NTE_NONE	No flags are set.
NTE_AMPERSAND	'&' Ampersand
NTE_GREATER	'>' Greater than
NTE_QUESTION	'?' Question mark

Definition at line 32 of file node_text.h.

{
  NTE_NONE      =        0,  
  NTE_AMPERSAND = 1U <<  0,  
  NTE_GREATER   = 1U <<  1,  
  NTE_QUESTION  = 1U <<  2,  
};

Function Documentation

◆ node_text_new()

struct ExpandoNode * node_text_new ( const char * text )

Create a new Text ExpandoNode.

Parameters

text	Text to store

Return values

ptr	New Text ExpandoNode

Note: The text will be copied

Definition at line 59 of file node_text.c.

{
  struct ExpandoNode *node = node_new();
 
  node->type = ENT_TEXT;
  node->text = mutt_str_dup(text);
  node->render = node_text_render;
 
  return node;
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ node_text_parse()

struct ExpandoNode * node_text_parse	(	const char *	str,
		NodeTextTermFlags	term_chars,
		const char **	parsed_until )

Extract a block of text.

Parameters

[in]	str	String to parse
[in]	term_chars	Terminator characters, e.g. NTE_GREATER
[out]	parsed_until	First character after parsed text

Return values

ptr	New Text ExpandoNode

Parse as much text as possible until the end of the line, or a terminator character is matched.

May return NULL if a terminator character is found immediately.

Note: \ before a character makes it literal; %% is interpreted as a literal % character; '' is always special

Definition at line 86 of file node_text.c.

{
  if (!str || (str[0] == '\0') || !parsed_until)
    return NULL;
 
  struct Buffer *text = buf_pool_get();
 
  while (str[0] != '\0')
  {
    if (str[0] == '\\') // Literal character
    {
      if (str[1] == '\0')
      {
        buf_addch(text, '\\');
        str++;
        break;
      }
 
      buf_addch(text, str[1]);
      str += 2;
      continue;
    }
 
    if ((str[0] == '%') && (str[1] == '%')) // Literal %
    {
      buf_addch(text, '%');
      str += 2;
      continue;
    }
 
    if (str[0] == '%') // '%' is always special
      break;
 
    if ((str[0] == '&') && (term_chars & NTE_AMPERSAND))
      break;
 
    if ((str[0] == '>') && (term_chars & NTE_GREATER))
      break;
 
    if ((str[0] == '?') && (term_chars & NTE_QUESTION))
      break;
 
    buf_addch(text, str[0]); // Plain text
    str++;
  }
 
  *parsed_until = str; // First unused character
 
  struct ExpandoNode *node = NULL;
  if (!buf_is_empty(text))
    node = node_text_new(buf_string(text));
 
  buf_pool_release(&text);
 
  return node;
}