SectionTemplate.h

Go to the documentation of this file.

/****
 * Sming Framework Project - Open Source framework for high efficiency native ESP8266 development.
 * Created 2015 by Skurydin Alexey
 * http://github.com/SmingHub/Sming
 * All files of the Sming Core are provided under the LGPL v3 license.
 *
 * SectionTemplate.h
 *
 * @author mikee47 <mike@sillyhouse.net> Nov 2020
 *
 ****/

#pragma once

#include "SectionStream.h"
#include "TemplateStream.h"
#include <Data/BitSet.h>
#include "../Format.h"

#define SECTION_TEMPLATE_COMMAND_MAP(XX)                                                                               \
    XX(Qas_int, "{!int:A} Output A as integer")                                                                        \
    XX(Qas_float, "{!float:A} Output A as float")                                                                      \
    XX(Qas_string, "{!string:A} Output A as quoted string")                                                            \
    XX(Qmime_type, "{!mime_type:A} Get MIME type string for a filename")                                               \
    XX(Qreplace, "{!replace:A:B:C} Copy of A with all occurrences of B replaced with C")                               \
    XX(Qlength, "{!length:A} Number of characters in A")                                                               \
    XX(Qpad,                                                                                                           \
       "{!pad:A:B:C} Copy of A padded to at least B characters with C (default is space). Use -ve B to left-pad. C")   \
    XX(Qrepeat, "{!repeat:A:B} Repeat A, number of iterations is B")                                                   \
    XX(Qkb, "{!kb:A} Convert A to KB")                                                                                 \
    XX(Qifdef, "{!ifdef:A} emit block if A is not zero-length")                                                        \
    XX(Qifndef, "{!ifdef:A} emit block if A is zero-length")                                                           \
    XX(Qifeq, "{!ifeq:A:B} emit block if A == B")                                                                      \
    XX(Qifneq, "{!ifneq:A:B} emit block if A != B")                                                                    \
    XX(Qifgt, "{!ifgt:A:B} emit block if A > B")                                                                       \
    XX(Qiflt, "{!iflt:A:B} emit block if A < B")                                                                       \
    XX(Qifge, "{!ifge:A:B} emit block if A >= B")                                                                      \
    XX(Qifle, "{!ifle:A:B} emit block if A <= B")                                                                      \
    XX(Qifbtw, "{!ifbtw:A:B:C} emit block if B <= A <= C")                                                             \
    XX(Qifin, "{!ifin:A:B} emit block if A contains B")                                                                \
    XX(Qifnin, "{!ifin:A:B} emit block if A does not contain B")                                                       \
    XX(Qelse, "{!else}")                                                                                               \
    XX(Qendif, "{!endif}")                                                                                             \
    XX(Qadd, "{!add:A:B} A + B")                                                                                       \
    XX(Qsub, "{!sub:A:B} A - B")                                                                                       \
    XX(Qgoto, "{!goto:A} move to section A")                                                                           \
    XX(Qcount, "{!count:A} emit number of records in section A")                                                       \
    XX(Qindex, "{!index:A} emit current record index for section A")

#define SECTION_TEMPLATE_FIELD_MAP(XX)                                                                                 \
    XX(section, "{$section} Current section index")                                                                    \
    XX(record, "{$record} Current record index")

class SectionTemplate : public TemplateStream
{
public:
    enum class Command {
        Qunknown = 0,
#define XX(name, comment) name,
        SECTION_TEMPLATE_COMMAND_MAP(XX)
#undef XX
    };

    enum class Field {
        unknown = 0,
#define XX(name, comment) name,
        SECTION_TEMPLATE_FIELD_MAP(XX)
#undef XX
    };

    SectionTemplate(IDataSourceStream* source, uint8_t maxSections = 5);

    using GetValue = Delegate<String(const char* name)>;

    using NextRecord = SectionStream::NextRecord;

    void onGetValue(GetValue callback)
    {
        getValueCallback = callback;
    }

    void setFormatter(Formatter& formatter)
    {
        activeFormatter = &formatter;
    }

    Formatter& formatter() const
    {
        return *activeFormatter;
    }

    MimeType getMimeType() const override
    {
        return activeFormatter->mimeType();
    }

    const SectionStream& stream() const
    {
        return sectionStream;
    }

    int sectionIndex() const
    {
        return sectionStream.sectionIndex();
    }

    uint8_t sectionCount() const
    {
        return sectionStream.count();
    }

    int recordIndex() const
    {
        return sectionStream.recordIndex();
    }

    bool gotoSection(uint8_t index);

    void onNextRecord(NextRecord callback)
    {
        nextRecordCallback = callback;
    }

    String evaluate(char*& expr) override;
    String getValue(const char* name) override;

protected:
    virtual bool nextRecord()
    {
        if(nextRecordCallback) {
            return nextRecordCallback();
        }

        // By default, emit section once
        return recordIndex() < 0;
    }

private:
    String openTag(bool enable);
    String closeTag();
    String elseTag();

    SectionStream sectionStream;
    Formatter* activeFormatter;
    GetValue getValueCallback;
    NextRecord nextRecordCallback;
    BitSet32 conditionalFlags; // Enable state for each level
    uint8_t conditionalLevel{0};
    int8_t newSection{-1};
};