module_query.hxx

Go to the documentation of this file.

 
#pragma once
#include <ice/array.hxx>
#include <ice/stringid.hxx>
#include <ice/module_info.hxx>
#include <ice/module_concepts.hxx>
 
namespace ice
{
 
    struct ModuleQuery
    {
        virtual ~ModuleQuery() noexcept = default;

        virtual bool query_api(
            ice::StringID_Arg api_name,
            ice::u32 version,
            ice::ModuleAPI& out_api
        ) const noexcept;

        virtual bool query_apis(
            ice::StringID_Arg api_name,
            ice::u32 version,
            ice::ModuleAPI* out_array,
            ice::u32* inout_array_size
        ) const noexcept = 0;

        template<typename Type> requires (ice::concepts::APIType<Type>)
        bool query_api(Type& api_struct) const noexcept;

        template<typename Type> requires (ice::concepts::APIType<Type>)
        bool query_apis(ice::Array<Type>& out_apis) const noexcept;
    };
 
    inline bool ModuleQuery::query_api(
        ice::StringID_Arg api_name,
        ice::u32 api_version,
        ice::ModuleAPI& out_api
    ) const noexcept
    {
        ice::u32 idx = 1;
        return query_apis(api_name, api_version, &out_api, &idx);
    }
 
    template<typename Type> requires (ice::concepts::APIType<Type>)
    inline bool ModuleQuery::query_api(Type& api_struct) const noexcept
    {
        ice::ModuleAPI api_info;
        bool const found = this->query_api(Type::Constant_APIName, Type::Constant_APIVersion, api_info);
        if (found)
        {
            api_struct = *reinterpret_cast<Type*>(api_info.api_ptr);
        }
        return found;
    }
 
    template<typename Type> requires (ice::concepts::APIType<Type>)
    bool ModuleQuery::query_apis(ice::Array<Type>& out_apis) const noexcept
    {
        ice::u32 num_apis = 0;
        if (query_apis(Type::Constant_APIName, Type::Constant_APIVersion, nullptr, &num_apis))
        {
            // ICE_LOG_IF(
            //     num_apis > 10,
            //     ice::LogSeverity::Warning, ice::LogTag::Engine,
            //     "More than 10 APIs of type {} where queried ({}).\n"
            //     "Use 'query_apis(ice::StringID_Arg, ice::u32, ice::ModuleAPI*, ice::u32*)' instead to avoid truncating results.",
            //     num_apis, Type::Constant_APIName
            // );
 
            ice::ModuleAPI temp_tab[10];
            query_apis(Type::Constant_APIName, Type::Constant_APIVersion, temp_tab, &num_apis);
 
            // Fill the array with the found APIs
            out_apis.reserve(num_apis);
            for (ice::u32 idx = 0; idx < num_apis; ++idx)
            {
                out_apis.push_back(*reinterpret_cast<Type*>(temp_tab[idx].api_ptr));
            }
        }
        return num_apis > 0;
    }
 
} // namespace ice