src/zserio/Walker.h

Source
#ifndef ZSERIO_WALKER_H_INC
#define ZSERIO_WALKER_H_INC

#include <algorithm>
#include <functional>
#include <regex>

#include "zserio/IReflectableData.h"
#include "zserio/ITypeInfo.h"
#include "zserio/IWalkFilter.h"
#include "zserio/IWalkObserver.h"
#include "zserio/String.h"
#include "zserio/StringConvertUtil.h"
#include "zserio/TypeInfoUtil.h"
#include "zserio/Vector.h"
#include "zserio/WalkerConst.h"

namespace zserio
{

template <typename ALLOC>
class BasicDefaultWalkFilter;

/**
 * Walker through zserio objects, based on generated type info (see -withTypeInfoCode) and
 * reflectable interface (see -withReflectionCode).
 */
template <typename ALLOC = std::allocator<uint8_t>>
class BasicWalker
{
public:
    /**
     * Constructor using default walk filter.
     *
     * \param walkObserver Observer to use during walking.
     */
    explicit BasicWalker(IBasicWalkObserver<ALLOC>& walkObserver);

    /**
     * Constructor.
     *
     * \param walkObserver Observer to use during walking.
     * \param walkFilter Walk filter to use.
     */
    BasicWalker(IBasicWalkObserver<ALLOC>& walkObserver, IBasicWalkFilter<ALLOC>& walkFilter);

    /**
     * Method generated by default.
     */
    ~BasicWalker() = default;

    /**
     * Copying and moving is disallowed!
     * \{
     */
    BasicWalker(const BasicWalker& other) = delete;
    BasicWalker& operator=(const BasicWalker& other) = delete;

    BasicWalker(BasicWalker&& other) = delete;
    BasicWalker& operator=(BasicWalker&& other) = delete;
    /**
     * \}
     */

    /**
     * Walks given reflectable zserio compound object.
     *
     * \param compound Zserio compound object to walk.
     */
    void walk(const IBasicReflectableDataConstPtr<ALLOC>& compound);

private:
    void walkFields(
            const IBasicReflectableDataConstPtr<ALLOC>& compound, const IBasicTypeInfo<ALLOC>& typeInfo);
    bool walkField(
            const IBasicReflectableDataConstPtr<ALLOC>& reflectable, const BasicFieldInfo<ALLOC>& fieldInfo);
    bool walkFieldValue(const IBasicReflectableDataConstPtr<ALLOC>& reflectable,
            const BasicFieldInfo<ALLOC>& fieldInfo, size_t elementIndex = WALKER_NOT_ELEMENT);

    IBasicWalkObserver<ALLOC>& m_walkObserver;
    BasicDefaultWalkFilter<ALLOC> m_defaultWalkFilter;
    IBasicWalkFilter<ALLOC>& m_walkFilter;
};

/**
 * Default walk observer which just does nothing.
 */
template <typename ALLOC = std::allocator<uint8_t>>
class BasicDefaultWalkObserver : public IBasicWalkObserver<ALLOC>
{
public:
    /**
     * Method generated by default.
     * \{
     */
    BasicDefaultWalkObserver() = default;
    ~BasicDefaultWalkObserver() override = default;
    /**
     * \}
     */

    /**
     * Copying and moving is disallowed!
     * \{
     */
    BasicDefaultWalkObserver(const BasicDefaultWalkObserver& other) = delete;
    BasicDefaultWalkObserver& operator=(const BasicDefaultWalkObserver& other) = delete;

    BasicDefaultWalkObserver(BasicDefaultWalkObserver&& other) = delete;
    BasicDefaultWalkObserver& operator=(BasicDefaultWalkObserver&& other) = delete;
    /**
     * \}
     */

    void beginRoot(const IBasicReflectableDataConstPtr<ALLOC>&) override
    {}
    void endRoot(const IBasicReflectableDataConstPtr<ALLOC>&) override
    {}

    void beginArray(const IBasicReflectableDataConstPtr<ALLOC>&, const BasicFieldInfo<ALLOC>&) override
    {}
    void endArray(const IBasicReflectableDataConstPtr<ALLOC>&, const BasicFieldInfo<ALLOC>&) override
    {}

    void beginCompound(
            const IBasicReflectableDataConstPtr<ALLOC>&, const BasicFieldInfo<ALLOC>&, size_t) override
    {}
    void endCompound(const IBasicReflectableDataConstPtr<ALLOC>&, const BasicFieldInfo<ALLOC>&, size_t) override
    {}

    void visitValue(const IBasicReflectableDataConstPtr<ALLOC>&, const BasicFieldInfo<ALLOC>&, size_t) override
    {}
};

/**
 * Default walk filter which filters nothing.
 */
template <typename ALLOC = std::allocator<uint8_t>>
class BasicDefaultWalkFilter : public IBasicWalkFilter<ALLOC>
{
public:
    /**
     * Method generated by default.
     * \{
     */
    BasicDefaultWalkFilter() = default;
    ~BasicDefaultWalkFilter() override = default;
    /**
     * \}
     */

    /**
     * Copying and moving is disallowed!
     * \{
     */
    BasicDefaultWalkFilter(const BasicDefaultWalkFilter& other) = delete;
    BasicDefaultWalkFilter& operator=(const BasicDefaultWalkFilter& other) = delete;

    BasicDefaultWalkFilter(BasicDefaultWalkFilter&& other) = delete;
    BasicDefaultWalkFilter& operator=(BasicDefaultWalkFilter&& other) = delete;
    /**
     * \}
     */

    bool beforeArray(const IBasicReflectableDataConstPtr<ALLOC>&, const BasicFieldInfo<ALLOC>&) override
    {
        return true;
    }

    bool afterArray(const IBasicReflectableDataConstPtr<ALLOC>&, const BasicFieldInfo<ALLOC>&) override
    {
        return true;
    }

    bool beforeCompound(
            const IBasicReflectableDataConstPtr<ALLOC>&, const BasicFieldInfo<ALLOC>&, size_t) override
    {
        return true;
    }

    bool afterCompound(
            const IBasicReflectableDataConstPtr<ALLOC>&, const BasicFieldInfo<ALLOC>&, size_t) override
    {
        return true;
    }

    bool beforeValue(const IBasicReflectableDataConstPtr<ALLOC>&, const BasicFieldInfo<ALLOC>&, size_t) override
    {
        return true;
    }

    bool afterValue(const IBasicReflectableDataConstPtr<ALLOC>&, const BasicFieldInfo<ALLOC>&, size_t) override
    {
        return true;
    }
};

/**
 * Walk filter which allows to walk only to the given maximum depth.
 */
template <typename ALLOC = std::allocator<uint8_t>>
class BasicDepthWalkFilter : public IBasicWalkFilter<ALLOC>
{
public:
    /**
     * Constructor.
     *
     * \param maxDepth Maximum depth to walk to.
     */
    explicit BasicDepthWalkFilter(size_t maxDepth);

    /**
     * Method generated by default.
     */
    ~BasicDepthWalkFilter() override = default;

    /**
     * Copying is disallowed!
     * \{
     */
    BasicDepthWalkFilter(const BasicDepthWalkFilter& other) = delete;
    BasicDepthWalkFilter& operator=(const BasicDepthWalkFilter& other) = delete;

    BasicDepthWalkFilter(BasicDepthWalkFilter&& other) = delete;
    BasicDepthWalkFilter& operator=(BasicDepthWalkFilter&& other) = delete;
    /**
     * \}
     */

    bool beforeArray(
            const IBasicReflectableDataConstPtr<ALLOC>& array, const BasicFieldInfo<ALLOC>& fieldInfo) override;
    bool afterArray(
            const IBasicReflectableDataConstPtr<ALLOC>& array, const BasicFieldInfo<ALLOC>& fieldInfo) override;

    bool beforeCompound(const IBasicReflectableDataConstPtr<ALLOC>& compound,
            const BasicFieldInfo<ALLOC>& fieldInfo, size_t elementIndex) override;
    bool afterCompound(const IBasicReflectableDataConstPtr<ALLOC>& compound,
            const BasicFieldInfo<ALLOC>& fieldInfo, size_t elementIndex) override;

    bool beforeValue(const IBasicReflectableDataConstPtr<ALLOC>& value, const BasicFieldInfo<ALLOC>& fieldInfo,
            size_t elementIndex) override;
    bool afterValue(const IBasicReflectableDataConstPtr<ALLOC>& value, const BasicFieldInfo<ALLOC>& fieldInfo,
            size_t elementIndex) override;

private:
    bool enterDepthLevel();
    bool leaveDepthLevel();

    size_t m_maxDepth;
    size_t m_depth;
};

/**
 * Walk filter which allows to walk only paths matching the given regex.
 *
 * The path is constructed from field names within the root object, thus the root object itself
 * is not part of the path.
 *
 * Array elements have the index appended to the path so that e.g. "compound.arrayField[0]" will match
 * only the first element in the array "arrayField".
 */
template <typename ALLOC = std::allocator<uint8_t>>
class BasicRegexWalkFilter : public IBasicWalkFilter<ALLOC>
{
public:
    /**
     * Constructor.
     *
     * \param pathRegex Path regex to use for filtering.
     */
    explicit BasicRegexWalkFilter(const char* pathRegex, const ALLOC& allocator = ALLOC());

    /**
     * Method generated by default.
     */
    ~BasicRegexWalkFilter() override = default;

    /**
     * Copying is disallowed!
     * \{
     */
    BasicRegexWalkFilter(const BasicRegexWalkFilter& other) = delete;
    BasicRegexWalkFilter& operator=(const BasicRegexWalkFilter& other) = delete;

    BasicRegexWalkFilter(BasicRegexWalkFilter&& other) = delete;
    BasicRegexWalkFilter& operator=(BasicRegexWalkFilter&& other) = delete;
    /**
     * \}
     */

    bool beforeArray(
            const IBasicReflectableDataConstPtr<ALLOC>& array, const BasicFieldInfo<ALLOC>& fieldInfo) override;
    bool afterArray(
            const IBasicReflectableDataConstPtr<ALLOC>& array, const BasicFieldInfo<ALLOC>& fieldInfo) override;

    bool beforeCompound(const IBasicReflectableDataConstPtr<ALLOC>& compound,
            const BasicFieldInfo<ALLOC>& fieldInfo, size_t elementIndex) override;
    bool afterCompound(const IBasicReflectableDataConstPtr<ALLOC>& compound,
            const BasicFieldInfo<ALLOC>& fieldInfo, size_t elementIndex) override;

    bool beforeValue(const IBasicReflectableDataConstPtr<ALLOC>& value, const BasicFieldInfo<ALLOC>& fieldInfo,
            size_t elementIndex) override;
    bool afterValue(const IBasicReflectableDataConstPtr<ALLOC>& value, const BasicFieldInfo<ALLOC>& fieldInfo,
            size_t elementIndex) override;

private:
    using StringType = BasicString<RebindAlloc<ALLOC, char>>;

    void appendPath(const BasicFieldInfo<ALLOC>& fieldInfo, size_t elementIndex);
    void popPath(const BasicFieldInfo<ALLOC>& fieldInfo, size_t elementIndex);
    StringType getCurrentPath() const;
    bool matchSubtree(
            const IBasicReflectableDataConstPtr<ALLOC>& value, const BasicFieldInfo<ALLOC>& fieldInfo) const;

    typename IBasicWalkFilter<ALLOC>::Path m_currentPath;
    std::regex m_pathRegex;
    ALLOC m_allocator; // TODO[Mi-L@]: Check how std::regex_match allocates when results are omitted!
};

/**
 * Walk filter which allows to walk only to the given maximum array length.
 */
template <typename ALLOC = std::allocator<uint8_t>>
class BasicArrayLengthWalkFilter : public IBasicWalkFilter<ALLOC>
{
public:
    /**
     * Constructor.
     *
     * \param maxArrayLength Maximum array length to walk to.
     */
    explicit BasicArrayLengthWalkFilter(size_t maxArrayLength);

    /**
     * Method generated by default.
     */
    ~BasicArrayLengthWalkFilter() override = default;

    /**
     * Copying and moving is disallowed!
     * \{
     */
    BasicArrayLengthWalkFilter(const BasicArrayLengthWalkFilter& other) = delete;
    BasicArrayLengthWalkFilter& operator=(const BasicArrayLengthWalkFilter& other) = delete;

    BasicArrayLengthWalkFilter(BasicArrayLengthWalkFilter&& other) = delete;
    BasicArrayLengthWalkFilter& operator=(BasicArrayLengthWalkFilter&& other) = delete;
    /**
     * \}
     */

    bool beforeArray(
            const IBasicReflectableDataConstPtr<ALLOC>& array, const BasicFieldInfo<ALLOC>& fieldInfo) override;
    bool afterArray(
            const IBasicReflectableDataConstPtr<ALLOC>& array, const BasicFieldInfo<ALLOC>& fieldInfo) override;

    bool beforeCompound(const IBasicReflectableDataConstPtr<ALLOC>& compound,
            const BasicFieldInfo<ALLOC>& fieldInfo, size_t elementIndex) override;
    bool afterCompound(const IBasicReflectableDataConstPtr<ALLOC>& compound,
            const BasicFieldInfo<ALLOC>& fieldInfo, size_t elementIndex) override;

    bool beforeValue(const IBasicReflectableDataConstPtr<ALLOC>& value, const BasicFieldInfo<ALLOC>& fieldInfo,
            size_t elementIndex) override;
    bool afterValue(const IBasicReflectableDataConstPtr<ALLOC>& value, const BasicFieldInfo<ALLOC>& fieldInfo,
            size_t elementIndex) override;

private:
    bool filterArrayElement(size_t elementIndex);

    size_t m_maxArrayLength;
};

/**
 * Walk filter which implements composition of particular filters.
 *
 * The filters are called sequentially and logical and is applied on theirs results.
 * Note that all filters are always called.
 */
template <typename ALLOC = std::allocator<uint8_t>>
class BasicAndWalkFilter : public IBasicWalkFilter<ALLOC>
{
public:
    using WalkFilterRef = std::reference_wrapper<IBasicWalkFilter<ALLOC>>;
    using WalkFilters = Vector<WalkFilterRef, RebindAlloc<ALLOC, WalkFilterRef>>;

    /**
     * Constructor.
     *
     * \param walkFilters List of filters to use in composition.
     */
    explicit BasicAndWalkFilter(const WalkFilters& walkFilters);

    /**
     * Method generated by default.
     */
    ~BasicAndWalkFilter() override = default;

    /**
     * Copying and moving is disallowed!
     * \{
     */
    BasicAndWalkFilter(const BasicAndWalkFilter& other) = delete;
    BasicAndWalkFilter& operator=(const BasicAndWalkFilter& other) = delete;

    BasicAndWalkFilter(BasicAndWalkFilter&& other) = delete;
    BasicAndWalkFilter& operator=(BasicAndWalkFilter&& other) = delete;
    /**
     * \}
     */

    bool beforeArray(
            const IBasicReflectableDataConstPtr<ALLOC>& array, const BasicFieldInfo<ALLOC>& fieldInfo) override;
    bool afterArray(
            const IBasicReflectableDataConstPtr<ALLOC>& array, const BasicFieldInfo<ALLOC>& fieldInfo) override;

    bool beforeCompound(const IBasicReflectableDataConstPtr<ALLOC>& compound,
            const BasicFieldInfo<ALLOC>& fieldInfo, size_t elementIndex) override;
    bool afterCompound(const IBasicReflectableDataConstPtr<ALLOC>& compound,
            const BasicFieldInfo<ALLOC>& fieldInfo, size_t elementIndex) override;

    bool beforeValue(const IBasicReflectableDataConstPtr<ALLOC>& value, const BasicFieldInfo<ALLOC>& fieldInfo,
            size_t elementIndex) override;
    bool afterValue(const IBasicReflectableDataConstPtr<ALLOC>& value, const BasicFieldInfo<ALLOC>& fieldInfo,
            size_t elementIndex) override;

private:
    template <typename FILTER_FUNC, typename... ARGS>
    bool applyFilters(FILTER_FUNC filterFunc, ARGS... args)
    {
        bool result = true;
        for (IBasicWalkFilter<ALLOC>& walkFilter : m_walkFilters)
        {
            result &= (walkFilter.*filterFunc)(args...);
        }
        return result;
    }

    WalkFilters m_walkFilters;
};

/** Typedefs to walker related classes provided for convenience - using default std::allocator<uint8_t>. */
/** \{ */
using Walker = BasicWalker<>;
using DefaultWalkObserver = BasicDefaultWalkObserver<>;
using DefaultWalkFilter = BasicDefaultWalkFilter<>;
using DepthWalkFilter = BasicDepthWalkFilter<>;
using RegexWalkFilter = BasicRegexWalkFilter<>;
using ArrayLengthWalkFilter = BasicArrayLengthWalkFilter<>;
using AndWalkFilter = BasicAndWalkFilter<>;
/** \} */

template <typename ALLOC>
BasicWalker<ALLOC>::BasicWalker(IBasicWalkObserver<ALLOC>& walkObserver) :
        m_walkObserver(walkObserver),
        m_walkFilter(m_defaultWalkFilter)
{}

template <typename ALLOC>
BasicWalker<ALLOC>::BasicWalker(IBasicWalkObserver<ALLOC>& walkObserver, IBasicWalkFilter<ALLOC>& walkFilter) :
        m_walkObserver(walkObserver),
        m_walkFilter(walkFilter)
{}

template <typename ALLOC>
void BasicWalker<ALLOC>::walk(const IBasicReflectableDataConstPtr<ALLOC>& compound)
{
    if (!compound)
    {
        throw CppRuntimeException("Walker: Root object cannot be NULL!");
    }

    const IBasicTypeInfo<ALLOC>& typeInfo = compound->getTypeInfo();
    if (!TypeInfoUtil::isCompound(typeInfo.getSchemaType()))
    {
        throw CppRuntimeException("Walker: Root object '")
                << typeInfo.getSchemaName() << "' is not a compound type!";
    }

    m_walkObserver.beginRoot(compound);
    walkFields(compound, typeInfo);
    m_walkObserver.endRoot(compound);
}

template <typename ALLOC>
void BasicWalker<ALLOC>::walkFields(
        const IBasicReflectableDataConstPtr<ALLOC>& compound, const IBasicTypeInfo<ALLOC>& typeInfo)
{
    if (TypeInfoUtil::hasChoice(typeInfo.getSchemaType()))
    {
        std::string_view compoundChoice = compound->getChoice();
        if (!compoundChoice.empty())
        {
            Span<const BasicFieldInfo<ALLOC>> fields = typeInfo.getFields();
            auto fieldsIt = std::find_if(
                    fields.begin(), fields.end(), [compoundChoice](const BasicFieldInfo<ALLOC>& fieldInfo) {
                        return fieldInfo.schemaName == compoundChoice;
                    });
            if (fieldsIt != fields.end())
            {
                walkField(compound->getField(compoundChoice), *fieldsIt);
            }
        }
        // else uninitialized or empty branch
    }
    else
    {
        for (const BasicFieldInfo<ALLOC>& fieldInfo : typeInfo.getFields())
        {
            if (!walkField(compound->getField(fieldInfo.schemaName), fieldInfo))
            {
                break;
            }
        }
    }
}

template <typename ALLOC>
bool BasicWalker<ALLOC>::walkField(
        const IBasicReflectableDataConstPtr<ALLOC>& reflectable, const BasicFieldInfo<ALLOC>& fieldInfo)
{
    if (reflectable && fieldInfo.isArray87)
    {
        if (m_walkFilter.beforeArray(reflectable, fieldInfo))
        {
            m_walkObserver.beginArray(reflectable, fieldInfo);
            for (size_t i = 0; i < reflectable->size(); ++i13)
            {
                if (!walkFieldValue(reflectable->at(i), fieldInfo, i))
                {
                    break;
                }
            }
            m_walkObserver.endArray(reflectable, fieldInfo);
        }
        return m_walkFilter.afterArray(reflectable, fieldInfo);
    }
    else
    {
        return walkFieldValue(reflectable, fieldInfo);
    }
}

template <typename ALLOC>
bool BasicWalker<ALLOC>::walkFieldValue(const IBasicReflectableDataConstPtr<ALLOC>& reflectable,
        const BasicFieldInfo<ALLOC>& fieldInfo, size_t elementIndex)
{
    const IBasicTypeInfo<ALLOC>& typeInfo = fieldInfo.typeInfo;
    if (reflectable && TypeInfoUtil::isCompound(typeInfo.getSchemaType())91)
    {
        if (m_walkFilter.beforeCompound(reflectable, fieldInfo, elementIndex))
        {
            m_walkObserver.beginCompound(reflectable, fieldInfo, elementIndex);
            walkFields(reflectable, typeInfo);
            m_walkObserver.endCompound(reflectable, fieldInfo, elementIndex);
        }
        return m_walkFilter.afterCompound(reflectable, fieldInfo, elementIndex);
    }
    else
    {
        if (m_walkFilter.beforeValue(reflectable, fieldInfo, elementIndex))
        {
            m_walkObserver.visitValue(reflectable, fieldInfo, elementIndex);
        }
        return m_walkFilter.afterValue(reflectable, fieldInfo, elementIndex);
    }
}

template <typename ALLOC>
BasicDepthWalkFilter<ALLOC>::BasicDepthWalkFilter(size_t maxDepth) :
        m_maxDepth(maxDepth),
        m_depth(1)
{}

template <typename ALLOC>
bool BasicDepthWalkFilter<ALLOC>::beforeArray(
        const IBasicReflectableDataConstPtr<ALLOC>&, const BasicFieldInfo<ALLOC>&)
{
    return enterDepthLevel();
}

template <typename ALLOC>
bool BasicDepthWalkFilter<ALLOC>::afterArray(
        const IBasicReflectableDataConstPtr<ALLOC>&, const BasicFieldInfo<ALLOC>&)
{
    return leaveDepthLevel();
}

template <typename ALLOC>
bool BasicDepthWalkFilter<ALLOC>::beforeCompound(
        const IBasicReflectableDataConstPtr<ALLOC>&, const BasicFieldInfo<ALLOC>&, size_t)
{
    return enterDepthLevel();
}

template <typename ALLOC>
bool BasicDepthWalkFilter<ALLOC>::afterCompound(
        const IBasicReflectableDataConstPtr<ALLOC>&, const BasicFieldInfo<ALLOC>&, size_t)
{
    return leaveDepthLevel();
}

template <typename ALLOC>
bool BasicDepthWalkFilter<ALLOC>::beforeValue(
        const IBasicReflectableDataConstPtr<ALLOC>&, const BasicFieldInfo<ALLOC>&, size_t)
{
    return m_depth <= m_maxDepth;
}

template <typename ALLOC>
bool BasicDepthWalkFilter<ALLOC>::afterValue(
        const IBasicReflectableDataConstPtr<ALLOC>&, const BasicFieldInfo<ALLOC>&, size_t)
{
    return true;
}

template <typename ALLOC>
bool BasicDepthWalkFilter<ALLOC>::enterDepthLevel()
{
    const bool enter = (m_depth <= m_maxDepth);
    m_depth += 1;
    return enter;
}

template <typename ALLOC>
bool BasicDepthWalkFilter<ALLOC>::leaveDepthLevel()
{
    m_depth -= 1;
    return true;
}

namespace detail
{

template <typename PATH, typename ALLOC>
BasicString<RebindAlloc<ALLOC, char>> getCurrentPathImpl(const PATH& currentPath, const ALLOC& allocator)
{
    BasicString<RebindAlloc<ALLOC, char>> currentPathStr(allocator);
    for (auto it = currentPath.begin(); it != currentPath.end(); ++it49)
    {
        if (!currentPathStr.empty())
        {
            currentPathStr += ".";
        }
        currentPathStr += *it;
    }
    return currentPathStr;
}

template <typename PATH, typename ALLOC>
void appendPathImpl(
        PATH& currentPath, const BasicFieldInfo<ALLOC>& fieldInfo, size_t elementIndex, const ALLOC& allocator)
{
    if (elementIndex == WALKER_NOT_ELEMENT)
    {
        currentPath.emplace_back(fieldInfo.schemaName.data(), fieldInfo.schemaName.size());
    }
    else
    {
        currentPath.back() =
                toString(fieldInfo.schemaName, allocator) + "[" + toString(elementIndex, allocator) + "]";
    }
}

template <typename PATH, typename ALLOC>
void popPathImpl(
        PATH& currentPath, const BasicFieldInfo<ALLOC>& fieldInfo, size_t elementIndex, const ALLOC& allocator)
{
    if (elementIndex == WALKER_NOT_ELEMENT)
    {
        currentPath.pop_back();
    }
    else
    {
        currentPath.back() = toString(fieldInfo.schemaName, allocator);
    }
}

template <typename ALLOC>
class SubtreeRegexWalkFilter : public IBasicWalkFilter<ALLOC>
{
public:
    SubtreeRegexWalkFilter(const typename IBasicWalkFilter<ALLOC>::Path& currentPath,
            const std::regex& pathRegex, const ALLOC& allocator) :
            m_currentPath(currentPath),
            m_pathRegex(pathRegex),
            m_allocator(allocator)
    {}

    bool matches()
    {
        return m_matches;
    }

    bool beforeArray(
            const IBasicReflectableDataConstPtr<ALLOC>&, const BasicFieldInfo<ALLOC>& fieldInfo) override
    {
        m_currentPath.emplace_back(fieldInfo.schemaName.data(), fieldInfo.schemaName.size());
        m_matches = std::regex_match(getCurrentPath(), m_pathRegex);

        // terminate when the match is already found (note that array is never null here)
        return !m_matches;
    }

    bool afterArray(const IBasicReflectableDataConstPtr<ALLOC>&, const BasicFieldInfo<ALLOC>&) override
    {
        m_currentPath.pop_back();
        return !m_matches; // terminate when the match is already found
    }

    bool beforeCompound(const IBasicReflectableDataConstPtr<ALLOC>&, const BasicFieldInfo<ALLOC>& fieldInfo,
            size_t elementIndex) override
    {
        appendPath(fieldInfo, elementIndex);
        m_matches = std::regex_match(getCurrentPath(), m_pathRegex);

        // terminate when the match is already found (note that compound is never null here)
        return !m_matches;
    }

    bool afterCompound(const IBasicReflectableDataConstPtr<ALLOC>&, const BasicFieldInfo<ALLOC>& fieldInfo,
            size_t elementIndex) override
    {
        popPath(fieldInfo, elementIndex);
        return !m_matches; // terminate when the match is already found
    }

    bool beforeValue(const IBasicReflectableDataConstPtr<ALLOC>&, const BasicFieldInfo<ALLOC>& fieldInfo,
            size_t elementIndex) override
    {
        appendPath(fieldInfo, elementIndex);
        m_matches = std::regex_match(getCurrentPath(), m_pathRegex);

        return !m_matches; // terminate when the match is already found
    }

    bool afterValue(const IBasicReflectableDataConstPtr<ALLOC>&, const BasicFieldInfo<ALLOC>& fieldInfo,
            size_t elementIndex) override
    {
        popPath(fieldInfo, elementIndex);
        return !m_matches; // terminate when the match is already found
    }

private:
    BasicString<RebindAlloc<ALLOC, char>> getCurrentPath() const
    {
        return detail::getCurrentPathImpl(m_currentPath, m_allocator);
    }

    void appendPath(const BasicFieldInfo<ALLOC>& fieldInfo, size_t elementIndex)
    {
        detail::appendPathImpl(m_currentPath, fieldInfo, elementIndex, m_allocator);
    }

    void popPath(const BasicFieldInfo<ALLOC>& fieldInfo, size_t elementIndex)
    {
        detail::popPathImpl(m_currentPath, fieldInfo, elementIndex, m_allocator);
    }

    typename IBasicWalkFilter<ALLOC>::Path m_currentPath;
    std::regex m_pathRegex;
    ALLOC m_allocator;
    bool m_matches = false;
};

} // namespace detail

template <typename ALLOC>
BasicRegexWalkFilter<ALLOC>::BasicRegexWalkFilter(const char* pathRegex, const ALLOC& allocator) :
        m_pathRegex(pathRegex),
        m_allocator(allocator)
{}

template <typename ALLOC>
bool BasicRegexWalkFilter<ALLOC>::beforeArray(
        const IBasicReflectableDataConstPtr<ALLOC>& array, const BasicFieldInfo<ALLOC>& fieldInfo)
{
    m_currentPath.emplace_back(fieldInfo.schemaName.data(), fieldInfo.schemaName.size());

    if (std::regex_match(getCurrentPath(), m_pathRegex))
    {
        return true; // the array itself matches
    }

    for (size_t i = 0; 3i < array->size(); ++i6)
    {
        m_currentPath.back() =
                toString(fieldInfo.schemaName, m_allocator) + "[" + toString(i, m_allocator) + "]";

        if (matchSubtree(array->at(i), fieldInfo))
        {
            return true;
        }
    }

    m_currentPath.back() = toString(fieldInfo.schemaName, m_allocator);

    return false;
}

template <typename ALLOC>
bool BasicRegexWalkFilter<ALLOC>::afterArray(
        const IBasicReflectableDataConstPtr<ALLOC>&, const BasicFieldInfo<ALLOC>&)
{
    m_currentPath.pop_back();
    return true;
}

template <typename ALLOC>
bool BasicRegexWalkFilter<ALLOC>::beforeCompound(const IBasicReflectableDataConstPtr<ALLOC>& compound,
        const BasicFieldInfo<ALLOC>& fieldInfo, size_t elementIndex)
{
    appendPath(fieldInfo, elementIndex);
    if (std::regex_match(getCurrentPath(), m_pathRegex))
    {
        return true; // the compound itself matches
    }

    return matchSubtree(compound, fieldInfo);
}

template <typename ALLOC>
bool BasicRegexWalkFilter<ALLOC>::afterCompound(const IBasicReflectableDataConstPtr<ALLOC>&,
        const BasicFieldInfo<ALLOC>& fieldInfo, size_t elementIndex)
{
    popPath(fieldInfo, elementIndex);
    return true;
}

template <typename ALLOC>
bool BasicRegexWalkFilter<ALLOC>::beforeValue(const IBasicReflectableDataConstPtr<ALLOC>& value,
        const BasicFieldInfo<ALLOC>& fieldInfo, size_t elementIndex)
{
    appendPath(fieldInfo, elementIndex);
    return matchSubtree(value, fieldInfo);
}

template <typename ALLOC>
bool BasicRegexWalkFilter<ALLOC>::afterValue(const IBasicReflectableDataConstPtr<ALLOC>&,
        const BasicFieldInfo<ALLOC>& fieldInfo, size_t elementIndex)
{
    popPath(fieldInfo, elementIndex);
    return true;
}

template <typename ALLOC>
void BasicRegexWalkFilter<ALLOC>::appendPath(const BasicFieldInfo<ALLOC>& fieldInfo, size_t elementIndex)
{
    detail::appendPathImpl(m_currentPath, fieldInfo, elementIndex, m_allocator);
}

template <typename ALLOC>
void BasicRegexWalkFilter<ALLOC>::popPath(const BasicFieldInfo<ALLOC>& fieldInfo, size_t elementIndex)
{
    detail::popPathImpl(m_currentPath, fieldInfo, elementIndex, m_allocator);
}

template <typename ALLOC>
BasicString<RebindAlloc<ALLOC, char>> BasicRegexWalkFilter<ALLOC>::getCurrentPath() const
{
    return detail::getCurrentPathImpl(m_currentPath, m_allocator);
}

template <typename ALLOC>
bool BasicRegexWalkFilter<ALLOC>::matchSubtree(
        const IBasicReflectableDataConstPtr<ALLOC>& value, const BasicFieldInfo<ALLOC>& fieldInfo) const
{
    if (value != nullptr && TypeInfoUtil::isCompound(fieldInfo.typeInfo.getSchemaType())13)
    {
        // is a not null compound, try to find match within its subtree
        BasicDefaultWalkObserver<ALLOC> defaultObserver;
        detail::SubtreeRegexWalkFilter<ALLOC> subtreeFilter(m_currentPath, m_pathRegex, m_allocator);
        BasicWalker<ALLOC> walker(defaultObserver, subtreeFilter);
        walker.walk(value);
        return subtreeFilter.matches();
    }
    else
    {
        // try to match a simple value or null compound
        return std::regex_match(getCurrentPath(), m_pathRegex);
    }
}

template <typename ALLOC>
BasicArrayLengthWalkFilter<ALLOC>::BasicArrayLengthWalkFilter(size_t maxArrayLength) :
        m_maxArrayLength(maxArrayLength)
{}

template <typename ALLOC>
bool BasicArrayLengthWalkFilter<ALLOC>::beforeArray(
        const IBasicReflectableDataConstPtr<ALLOC>&, const BasicFieldInfo<ALLOC>&)
{
    return true;
}

template <typename ALLOC>
bool BasicArrayLengthWalkFilter<ALLOC>::afterArray(
        const IBasicReflectableDataConstPtr<ALLOC>&, const BasicFieldInfo<ALLOC>&)
{
    return true;
}

template <typename ALLOC>
bool BasicArrayLengthWalkFilter<ALLOC>::beforeCompound(
        const IBasicReflectableDataConstPtr<ALLOC>&, const BasicFieldInfo<ALLOC>&, size_t elementIndex)
{
    return filterArrayElement(elementIndex);
}

template <typename ALLOC>
bool BasicArrayLengthWalkFilter<ALLOC>::afterCompound(
        const IBasicReflectableDataConstPtr<ALLOC>&, const BasicFieldInfo<ALLOC>&, size_t elementIndex)
{
    return filterArrayElement(elementIndex);
}

template <typename ALLOC>
bool BasicArrayLengthWalkFilter<ALLOC>::beforeValue(
        const IBasicReflectableDataConstPtr<ALLOC>&, const BasicFieldInfo<ALLOC>&, size_t elementIndex)
{
    return filterArrayElement(elementIndex);
}

template <typename ALLOC>
bool BasicArrayLengthWalkFilter<ALLOC>::afterValue(
        const IBasicReflectableDataConstPtr<ALLOC>&, const BasicFieldInfo<ALLOC>&, size_t elementIndex)
{
    return filterArrayElement(elementIndex);
}

template <typename ALLOC>
bool BasicArrayLengthWalkFilter<ALLOC>::filterArrayElement(size_t elementIndex)
{
    return elementIndex == WALKER_NOT_ELEMENT ? true4 : elementIndex < m_maxArrayLength6;
}

template <typename ALLOC>
BasicAndWalkFilter<ALLOC>::BasicAndWalkFilter(const WalkFilters& walkFilters) :
        m_walkFilters(walkFilters)
{}

template <typename ALLOC>
bool BasicAndWalkFilter<ALLOC>::beforeArray(
        const IBasicReflectableDataConstPtr<ALLOC>& array, const BasicFieldInfo<ALLOC>& fieldInfo)
{
    return applyFilters(&IBasicWalkFilter<ALLOC>::beforeArray, array, fieldInfo);
}

template <typename ALLOC>
bool BasicAndWalkFilter<ALLOC>::afterArray(
        const IBasicReflectableDataConstPtr<ALLOC>& array, const BasicFieldInfo<ALLOC>& fieldInfo)
{
    return applyFilters(&IBasicWalkFilter<ALLOC>::afterArray, array, fieldInfo);
}

template <typename ALLOC>
bool BasicAndWalkFilter<ALLOC>::beforeCompound(const IBasicReflectableDataConstPtr<ALLOC>& compound,
        const BasicFieldInfo<ALLOC>& fieldInfo, size_t elementIndex)
{
    return applyFilters(&IBasicWalkFilter<ALLOC>::beforeCompound, compound, fieldInfo, elementIndex);
}

template <typename ALLOC>
bool BasicAndWalkFilter<ALLOC>::afterCompound(const IBasicReflectableDataConstPtr<ALLOC>& compound,
        const BasicFieldInfo<ALLOC>& fieldInfo, size_t elementIndex)
{
    return applyFilters(&IBasicWalkFilter<ALLOC>::afterCompound, compound, fieldInfo, elementIndex);
}

template <typename ALLOC>
bool BasicAndWalkFilter<ALLOC>::beforeValue(const IBasicReflectableDataConstPtr<ALLOC>& value,
        const BasicFieldInfo<ALLOC>& fieldInfo, size_t elementIndex)
{
    return applyFilters(&IBasicWalkFilter<ALLOC>::beforeValue, value, fieldInfo, elementIndex);
}

template <typename ALLOC>
bool BasicAndWalkFilter<ALLOC>::afterValue(const IBasicReflectableDataConstPtr<ALLOC>& value,
        const BasicFieldInfo<ALLOC>& fieldInfo, size_t elementIndex)
{
    return applyFilters(&IBasicWalkFilter<ALLOC>::afterValue, value, fieldInfo, elementIndex);
}

} // namespace zserio

#endif // ZSERIO_WALKER_H_INC

Coverage Report

Created: 2025-07-31 16:33