xmltooling 3.2.4

Classes | Public Member Functions | Static Public Attributes | List of all members
xmltooling::TemplateEngine Class Reference

Simple template replacement engine. More...

`#include <xmltooling/util/TemplateEngine.h>`

Collaboration diagram for xmltooling::TemplateEngine:
[legend]

## Classes
class | TemplateParameters
| Interface to parameters to plug into templates. More...

## Public Member Functions
| TemplateEngine ()
| Default constructor.
void | setTagPrefix (const char *tagPrefix)
| Sets the tag name to use when locating template replacement tags.
virtual void | run (std::istream &is, std::ostream &os, const TemplateParameters &parameters, const XMLToolingException *e=0) const
| Processes template from an input stream and executes replacements and conditional logic based on parameters.

## Static Public Attributes
static std::string | unsafe_chars
| List of non-built-in characters considered "unsafe" and requiring HTML encoding.

## Detailed Description

Simple template replacement engine.

Supports the following:

- <mlp key/>
- <mlpif key> stuff </mlpif>
- <mlpifnot key> stuff </mlpifnot>
- <mlpfor key> stuff </mlpfor>
- <mlp $name/> (in for loop only)
- <mlp $value/> (in for loop only)

The default tag prefix is "mlp". This can be overridden for compatibility.

## Member Function Documentation

## ◆ run()

virtual void xmltooling::TemplateEngine::run | ( | std::istream & | is,
|  | std::ostream & | os,
|  | const TemplateParameters & | parameters,
|  | const XMLToolingException * | e = 0 ) const
| virtual

Processes template from an input stream and executes replacements and conditional logic based on parameters.

Parameters

  is | input stream providing template
  os | output stream to send results of executing template
  parameters | parameters to plug into template
  e | optional exception to extract parameters from

## ◆ setTagPrefix()

void xmltooling::TemplateEngine::setTagPrefix | ( | const char * | tagPrefix | ) |

Sets the tag name to use when locating template replacement tags.

Parameters

  tagPrefix | base prefix for tags

## Member Data Documentation

## ◆ unsafe_chars

std::string xmltooling::TemplateEngine::unsafe_chars
| static

List of non-built-in characters considered "unsafe" and requiring HTML encoding.

The default set is #%&():[]\`{}

The documentation for this class was generated from the following file:

- xmltooling/util/TemplateEngine.h