AbstractRecipe.h

Go to the documentation of this file.

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *     http://aws.amazon.com/apache2.0/
 *
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */

#ifndef ACSDKMANUFACTORY_INTERNAL_ABSTRACTRECIPE_H_
#define ACSDKMANUFACTORY_INTERNAL_ABSTRACTRECIPE_H_

#include <AVSCommon/Utils/TypeIndex.h>

namespace alexaClientSDK {
namespace acsdkManufactory {
namespace internal {

class RuntimeManufactory;

class AbstractRecipe {
public:
    using ProduceInstanceFunction =
        void* (*)(std::shared_ptr<AbstractRecipe> recipe, RuntimeManufactory& runtimeManufactory, void* cachedValue);

    using DeleteInstanceFunction = void (*)(void*);

    enum RecipeType {
        FACTORY,
        FUNCTION,
        ADD_INSTANCE
    };

    enum CachedInstanceLifecycle {
        INSTANCE,
        PRIMARY,
        RETAINED,
        REQUIRED,
        UNIQUE,
        UNLOADABLE,
    };

    virtual ~AbstractRecipe() = default;

    virtual bool isEquivalent(const std::shared_ptr<AbstractRecipe>& recipe) const = 0;

    RecipeType getRecipeType() const;

    CachedInstanceLifecycle getLifecycle() const;

    ProduceInstanceFunction getProduceInstanceFunction() const;

    DeleteInstanceFunction getDeleteInstanceFunction() const;

    std::vector<avsCommon::utils::TypeIndex>::const_iterator begin() const;

    std::vector<avsCommon::utils::TypeIndex>::const_iterator end() const;

protected:
    std::vector<avsCommon::utils::TypeIndex> m_dependencies;

    ProduceInstanceFunction m_produceFunction;

    DeleteInstanceFunction m_deleteFunction;

    RecipeType m_recipeType;

    CachedInstanceLifecycle m_objectLifecycle;
};

inline AbstractRecipe::RecipeType AbstractRecipe::getRecipeType() const {
    return m_recipeType;
}

inline AbstractRecipe::CachedInstanceLifecycle AbstractRecipe::getLifecycle() const {
    return m_objectLifecycle;
}

inline AbstractRecipe::ProduceInstanceFunction AbstractRecipe::getProduceInstanceFunction() const {
    return m_produceFunction;
}

inline AbstractRecipe::DeleteInstanceFunction AbstractRecipe::getDeleteInstanceFunction() const {
    return m_deleteFunction;
}

inline std::vector<avsCommon::utils::TypeIndex>::const_iterator AbstractRecipe::begin() const {
    return m_dependencies.begin();
}

inline std::vector<avsCommon::utils::TypeIndex>::const_iterator AbstractRecipe::end() const {
    return m_dependencies.end();
}

}  // namespace internal
}  // namespace acsdkManufactory
}  // namespace alexaClientSDK

#endif  // ACSDKMANUFACTORY_INTERNAL_ABSTRACTRECIPE_H_