Stream which performs variable-value substitution on-the-fly. More...

#include <TemplateStream.h>

Inheritance diagram for TemplateStream:
[legend]
Collaboration diagram for TemplateStream:
[legend]

Public Types

using Variables = HashMap< String, String >
 
using GetValueDelegate = Delegate< String(const char *name)>
 

Public Member Functions

 TemplateStream (IDataSourceStream *stream, bool owned=true)
 Create a template stream. More...
 
 ~TemplateStream ()
 
StreamType getStreamType () const override
 Get the stream type. More...
 
uint16_t readMemoryBlock (char *data, int bufSize) override
 Read a block of memory. More...
 
int seekFrom (int offset, SeekOrigin origin) override
 Change position in stream. More...
 
bool isFinished () override
 Check if all data has been read. More...
 
void setVar (const String &name, const String &value)
 Set value of a variable in the template file. More...
 
void setVars (const Variables &vars)
 Set multiple variables in the template file. More...
 
Variablesvariables ()
 Get the template variables. More...
 
String getName () const override
 Returns name of the resource. More...
 
void onGetValue (GetValueDelegate callback)
 Set a callback to obtain variable values. More...
 
void enableOutput (bool enable)
 During processing applications may suppress output of certain sections by calling this method from within the getValue callback. More...
 
bool isOutputEnabled () const
 
void setDoubleBraces (bool enable)
 Use two braces {{X}} to mark tags. More...
 
virtual String evaluate (char *&expr)
 
virtual String getValue (const char *name)
 Fetch a templated value. More...
 
- Public Member Functions inherited from IDataSourceStream
virtual bool isValid () const
 Determine if the stream object contains valid data. More...
 
size_t readBytes (char *buffer, size_t length) override
 Read chars from stream into buffer. More...
 
int read () override
 Read one character and moves the stream pointer. More...
 
int peek () override
 Read a character without advancing the stream pointer. More...
 
virtual bool seek (int len)
 Move read cursor. More...
 
virtual int available ()
 Return the total length of the stream. More...
 
size_t write (uint8_t charToWrite) override
 From Stream class: We don't write using this stream. More...
 
int length ()
 Return the total length of the stream. More...
 
void flush () override
 
virtual String id () const
 Returns unique id of the resource. More...
 
virtual MimeType getMimeType () const
 Get MIME type for stream content. More...
 
String readString (size_t maxLen) override
 Overrides Stream method for more efficient reading. More...
 
virtual bool moveString (String &s)
 Memory-based streams may be able to move content into a String. More...
 
- Public Member Functions inherited from Stream
 Stream ()
 
void setTimeout (unsigned long timeout)
 Set maximum milliseconds to wait for stream data, default is 1 second. More...
 
bool find (const char *target)
 Read data from the stream until the target string is found. More...
 
bool find (const char *target, size_t length)
 Read data from the stream until the target string of given length is found. More...
 
bool findUntil (const char *target, const char *terminator)
 As find() but search ends if the terminator string is found. More...
 
bool findUntil (const char *target, size_t targetLen, const char *terminate, size_t termLen)
 As findUntil(const char*, const char*) but search ends if the terminate string is found. More...
 
long parseInt ()
 Returns the first valid (long) integer value from the current position. More...
 
float parseFloat ()
 float version of parseInt More...
 
size_t readBytesUntil (char terminator, char *buffer, size_t length)
 As readBytes() with terminator character. More...
 
String readStringUntil (char terminator)
 
virtual int indexOf (char c)
 
- Public Member Functions inherited from Print
virtual ~Print ()
 
int getWriteError ()
 Gets last error. More...
 
void clearWriteError ()
 Clears the last write error. More...
 
size_t write (const char *str)
 Writes a c-string to output stream. More...
 
virtual size_t write (const uint8_t *buffer, size_t size)
 Writes characters from a buffer to output stream. More...
 
size_t write (const char *buffer, size_t size)
 Writes characters from a buffer to output stream. More...
 
size_t print (char c)
 Prints a single character to output stream. More...
 
size_t print (const char str[])
 Prints a c-string to output stream. More...
 
size_t print (double num, int digits=2)
 Print a floating-point number to output stream. More...
 
size_t print (const Printable &p)
 Prints a Printable object to output stream. More...
 
size_t print (const String &s)
 Prints a String to output stream. More...
 
size_t println ()
 Prints a newline to output stream. More...
 
size_t println (const char str[])
 Prints a c-string to output stream, appending newline. More...
 
size_t println (char c)
 Prints a single character to output stream, appending newline. More...
 
size_t println (double num, int digits=2)
 Print a floating-point number to output stream, appending newline. More...
 
size_t println (const Printable &p)
 Prints a Printable object to output stream, appending newline. More...
 
size_t println (const String &s)
 Prints a String to output stream, appending newline. More...
 
size_t printf (const char *fmt,...) __attribute__((format(printf
 Prints a formatted c-string to output stream. More...
 
size_t print (unsigned long num, int base=DEC)
 
size_t print (const unsigned long long &num, int base=DEC)
 
size_t print (long, int base=DEC)
 
size_t print (const long long &, int base=DEC)
 
size_t print (unsigned int num, int base=DEC)
 
size_t print (unsigned char num, int base=DEC)
 
size_t print (int num, int base=DEC)
 
size_t println (unsigned char num, int base=DEC)
 
size_t println (unsigned int num, int base=DEC)
 
size_t println (unsigned long num, int base=DEC)
 
size_t println (const unsigned long long &num, int base=DEC)
 
size_t println (int num, int base=DEC)
 
size_t println (long num, int base=DEC)
 
size_t println (const long long &num, int base=DEC)
 

Additional Inherited Members

- Protected Member Functions inherited from Stream
int timedRead ()
 
int timedPeek ()
 
int peekNextDigit ()
 returns the next numeric digit in the stream or -1 if timeout More...
 
long parseInt (char skipChar)
 Like regular parseInt() but the given skipChar is ignored. More...
 
float parseFloat (char skipChar)
 Like parseInt(skipChar) for float. More...
 
- Protected Member Functions inherited from Print
void setWriteError (int err=1)
 
- Protected Attributes inherited from Stream
uint16_t receiveTimeout = 1000
 number of milliseconds to wait for the next char before aborting timed read More...
 

Detailed Description

Stream which performs variable-value substitution on-the-fly.

Template uses {varname} style markers which are replaced as the stream is read.

Member Typedef Documentation

◆ GetValueDelegate

using TemplateStream::GetValueDelegate = Delegate<String(const char* name)>

◆ Variables

Constructor & Destructor Documentation

◆ TemplateStream()

TemplateStream::TemplateStream ( IDataSourceStream stream,
bool  owned = true 
)
inline

Create a template stream.

Parameters
streamsource of template data
ownedIf true (default) then stream will be destroyed when complete

◆ ~TemplateStream()

TemplateStream::~TemplateStream ( )
inline

Member Function Documentation

◆ enableOutput()

void TemplateStream::enableOutput ( bool  enable)
inline

During processing applications may suppress output of certain sections by calling this method from within the getValue callback.

◆ evaluate()

virtual String TemplateStream::evaluate ( char *&  expr)
virtual

Reimplemented in SectionTemplate.

◆ getName()

String TemplateStream::getName ( ) const
inlineoverridevirtual

Returns name of the resource.

Return values
String
Note
Commonly used to obtain name of file

Reimplemented from IDataSourceStream.

◆ getStreamType()

StreamType TemplateStream::getStreamType ( ) const
inlineoverridevirtual

Get the stream type.

Return values
StreamTypeThe stream type.

Reimplemented from IDataSourceStream.

◆ getValue()

virtual String TemplateStream::getValue ( const char *  name)
virtual

Fetch a templated value.

Parameters
nameThe variable name
Return values
Stringvalue, invalid to emit tag unprocessed

Reimplemented in SectionTemplate, IFS::DirectoryTemplate, and IFS::HtmlDirectoryTemplate.

◆ isFinished()

bool TemplateStream::isFinished ( )
inlineoverridevirtual

Check if all data has been read.

Return values
boolTrue on success.

Implements IDataSourceStream.

◆ isOutputEnabled()

bool TemplateStream::isOutputEnabled ( ) const
inline

◆ onGetValue()

void TemplateStream::onGetValue ( GetValueDelegate  callback)
inline

Set a callback to obtain variable values.

Parameters
callbackInvoked only if variable name not found in map

◆ readMemoryBlock()

uint16_t TemplateStream::readMemoryBlock ( char *  data,
int  bufSize 
)
overridevirtual

Read a block of memory.

Parameters
dataPointer to the data to be read
bufSizeQuantity of chars to read
Return values
uint16_tQuantity of chars read
Todo:
Should IDataSourceStream::readMemoryBlock return same data type as its bufSize param?

Implements IDataSourceStream.

◆ seekFrom()

int TemplateStream::seekFrom ( int  offset,
SeekOrigin  origin 
)
overridevirtual

Change position in stream.

Parameters
offset
origin
Return values
Newposition, < 0 on error
Note
This method is implemented by streams which support random seeking, such as files and memory streams.

Reimplemented from IDataSourceStream.

◆ setDoubleBraces()

void TemplateStream::setDoubleBraces ( bool  enable)
inline

Use two braces {{X}} to mark tags.

Parameters
enabletrue: use two braces, false (default): single brace only

◆ setVar()

void TemplateStream::setVar ( const String name,
const String value 
)
inline

Set value of a variable in the template file.

Parameters
nameName of variable
valueValue to assign to the variable
Note
Sets and existing variable or adds a new variable if variable does not already exist

◆ setVars()

void TemplateStream::setVars ( const Variables vars)
inline

Set multiple variables in the template file.

Parameters
varsTemplate Variables

◆ variables()

Variables& TemplateStream::variables ( )
inline

Get the template variables.

Return values
TemplateVariablesReference to the template variables

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