Module type Kwmacro.Surface

module type Surface = sig .. end

The type of surface syntax modules.

A module of this type encapsulates the knowledge of what a macro call looks like, and implements the application of macros to their arguments.

val parse : string -> string list

Parse a macro call into an argument list.

The parameter is a string matching a complete macro call.
Returns list of macro parameters; the zeroth element is the macro name

val substitute : (string -> string) -> string -> string

Replace all macro calls in a string with their expansions.

substitute replaces all macro calls in the string with the result of the function subst applied to the match. N.B. this is exactly (well, strictly less than) what Pcre.substitute does, so if you are using Pcre a suitable definition of this function would be:

let substitute subst str = Pcre.substitute ~rex ~subst str

for some compiled macro-call-matching regexp rex. See the Tutorial.