ec_interpolate_crack_macro

March 26, 2020 Contributors

Name

ec_interpolate_crack_macro — Return the name and argument portions of a macro string

Synopsis

#include "misc/expand_string.h"

| int **ec_interpolate_crack_macro** ( | input, |   |
|   | style, |   |
|   | namestart, |   |
|   | nameend, |   |
|   | argstart, |   |
|   | argend); |   |

const string * <var class="pdparam">input</var>;
int <var class="pdparam">style</var>;
const char ** <var class="pdparam">namestart</var>;
const char ** <var class="pdparam">nameend</var>;
const char ** <var class="pdparam">argstart</var>;
const char ** <var class="pdparam">argend</var>;

Description

This function returns the name and argument portions of a macro string.

A helper function for getting at the name and argument pieces of a macro from inside an ec_interpolator_func. This is required because there are multiple styles of macro placeholders in the various Message Systems’ products/ Additionally, macro styles may be expanded in the future.

Parameters

input

The input parameter to the interpolator function.

style

The placeholder style detected by the parser.

namestart

Set to point to the first character of the macro. name.

nameend

Set to point to the character after the last character of the macro name.

argstart

Set to point to the first character of the argument, or NULL if not present.

argend

Set to point to the character after the last character of the macro argument, or NULL if not present.

Return Values

This function returns non-zero if successful; on error it returns zero.

Threading

It is legal to call this function in any thread.