Text expander context, used to encapsulate the logic to expand a given text template. More...

#include <textutils.h>

Data Fields
void *	log_ctx
	log context to pass to the function, used for logging and for accessing the context for the function

const FFExpandTextFunction *	functions
	list of functions to use to expand sequences in the format FUNCTION_NAME{PARAMS}

unsigned int	functions_nb
	number of functions

Detailed Description

Text expander context, used to encapsulate the logic to expand a given text template.

A backslash character @samp{\} in a text template, followed by any character, always expands to the second character. Sequences of the form %{FUNCTION_NAME[:PARAMS]} are expanded using a function defined in the object. The text between the braces is a function name, possibly followed by arguments separated by ':'. If the arguments contain special characters or delimiters (':' or '}'), they should be escaped.

Definition at line 66 of file textutils.h.

Field Documentation

◆ log_ctx

void* FFExpandTextContext::log_ctx

log context to pass to the function, used for logging and for accessing the context for the function

Definition at line 71 of file textutils.h.

Referenced by ff_expand_text_function(), and ff_expand_text_function_internal().

◆ functions

const FFExpandTextFunction* FFExpandTextContext::functions

list of functions to use to expand sequences in the format FUNCTION_NAME{PARAMS}

Definition at line 77 of file textutils.h.

Referenced by ff_expand_text_function_internal().

◆ functions_nb

unsigned int FFExpandTextContext::functions_nb

number of functions

Definition at line 82 of file textutils.h.