FnGeolibCookInterfaceUtilsService.h

// Copyright (c) 2013 The Foundry Visionmongers Ltd. All Rights Reserved.

#ifndef FnGeolibCookInterfaceUtilsService_H
#define FnGeolibCookInterfaceUtilsService_H

#include <stdint.h>
#include <string>

#include "FnAttribute/FnAttribute.h"
#include "FnGeolib/op/FnGeolibCookInterface.h"
#include "FnPlatform/StringView.h"
#include "FnPlatform/internal/Portability.h"
#include "FnPluginSystem/FnPluginSystem.h"

#include "FnGeolibServices/FnGeolibServicesAPI.h"
#include "FnGeolibServices/ns.h"
#include "FnGeolibServices/suite/FnGeolibCookInterfaceUtilsSuite.h"

FNGEOLIBSERVICES_NAMESPACE_ENTER
{
    class BaseGlobalAttributeProvider;
    class BaseGlobalAttributeProviderLegacy;

    class FNGEOLIBSERVICES_API FnGeolibCookInterfaceUtils
    {
    public:
        struct MatchesCELInfo
        {
            bool matches;
            bool canMatchChildren;
        };

        static void matchesCEL(MatchesCELInfo & matchesCELInfo,
                const FNGEOLIBOP_NAMESPACE::GeolibCookInterface & interface,
                const FnAttribute::StringAttribute & cel,
                const std::string & inputLocationPath=std::string(),
                int inputIndex=kFnKatGeolibDefaultInput);

        static FnAttribute::GroupAttribute cookDaps(
                const FNGEOLIBOP_NAMESPACE::GeolibCookInterface & interface,
                const std::string & attrRoot,
                const std::string & inputLocationPath=std::string(),
                int inputIndex=kFnKatGeolibDefaultInput,
                const FnAttribute::Attribute & cookOrderAttr=FnAttribute::Attribute());

        struct BuildLocalsAndGlobalsInfo
        {
            FnAttribute::GroupAttribute locals;
            FnAttribute::GroupAttribute globals;
        };

        static BuildLocalsAndGlobalsInfo buildLocalsAndGlobals(
                const FNGEOLIBOP_NAMESPACE::GeolibCookInterface & interface,
                const std::string & attrRoot);

        static FnAttribute::Attribute getDefaultDapCookOrder();

        static FnAttribute::GroupAttribute resolveFileNamesWithinGroup(
                const FNGEOLIBOP_NAMESPACE::GeolibCookInterface & interface,
                const FnAttribute::GroupAttribute & inputGroup,
                const FnAttribute::StringAttribute & celAttr,
                int frameNumber);

        static FnAttribute::StringAttribute resolveFileNameInString(
                const FNGEOLIBOP_NAMESPACE::GeolibCookInterface & interface,
                const FnAttribute::StringAttribute & inputString,
                int frameNumber);

        static FnAttribute::Attribute getGlobalAttrGeneric(
            BaseGlobalAttributeProvider& provider,
            FnPlatform::StringView name,
            FnPlatform::StringView locationPath,
            bool* didAbortPtr = NULL);

        static FNKAT_DEPRECATED FnAttribute::Attribute getGlobalAttrGeneric(
            BaseGlobalAttributeProviderLegacy& provider,
            const std::string& name,
            const std::string& locationPath,
            bool* didAbortPtr = NULL);

    private:
        FnGeolibCookInterfaceUtils();

        static const FnGeolibCookInterfaceUtilsHostSuite_v2 * _getSuite();
    };

    class FNGEOLIBSERVICES_API BaseGlobalAttributeProvider
    {
    public:
        virtual ~BaseGlobalAttributeProvider() {}

        virtual FnGeolibGlobalAttributeProviderStatus getAttr(
            FnPlatform::StringView attrPath,
            FnAttribute::Attribute* attributeOut) = 0;
    };

    class FNGEOLIBSERVICES_API BaseGlobalAttributeProviderLegacy
    {
    public:
        virtual ~BaseGlobalAttributeProviderLegacy() {}

        FNKAT_DEPRECATED virtual FnGeolibGlobalAttributeProviderStatus
        provideAttribute(const std::string& attrPath,
                         const std::string& leafLocationPath,
                         int32_t relativeDepth,
                         FnAttribute::Attribute* attributeOut) = 0;
    };
}
FNGEOLIBSERVICES_NAMESPACE_EXIT

#endif // FnGeolibServicesCookInterfaceUtilsService_H