Utility.h

Go to the documentation of this file.

//-
// ================================================================================================
// Copyright 2024 Autodesk, Inc.  All rights reserved.
//
// Use of this software is subject to the terms of the Autodesk license agreement provided
// at the time of installation or download, or which otherwise accompanies this software in
// either electronic or hard copy form.
// ================================================================================================
//+
 
 
#ifndef BIFROSTGRAPH_EXECUTOR_UTILITY_H
#define BIFROSTGRAPH_EXECUTOR_UTILITY_H
 
#include <BifrostGraph/Executor/internal/ExecutorExport.h>
#include <BifrostGraph/Executor/internal/PropagateConstPtr.h>
 
#include <BifrostGraph/Executor/Factory.h>
#include <BifrostGraph/Executor/Types.h>
 
#include <Amino/Core/Array.h>
#include <Amino/Core/Ptr.h>
#include <Amino/Core/String.h>
 
#include <cstdint>
 
namespace Amino {
class Type;
class Value;
} // namespace Amino
 
namespace BifrostGraph {
namespace Executor {
namespace Utility {
 
 
BIFROSTGRAPH_EXECUTOR_SHARED_DECL Amino::String getTypeName(const Amino::Type& type) noexcept;
 
BIFROSTGRAPH_EXECUTOR_SHARED_DECL Amino::String getInnermostElementTypeName(
    const Amino::Type& type) noexcept;
 
BIFROSTGRAPH_EXECUTOR_SHARED_DECL bool isArrayType(const Amino::Type& type) noexcept;
 
BIFROSTGRAPH_EXECUTOR_SHARED_DECL Amino::String getEnv(const Amino::String& evName) noexcept;
 
BIFROSTGRAPH_EXECUTOR_SHARED_DECL bool getEnvBool(const Amino::String& evName) noexcept;
 
BIFROSTGRAPH_EXECUTOR_SHARED_DECL std::int32_t getEnvInt(const Amino::String& evName,
                                                         std::int32_t defaultValue) noexcept;
 
// clang-format off
// clang-format on
class BIFROSTGRAPH_EXECUTOR_SHARED_DECL ConfigEnv final {
protected:
    ConfigEnv() noexcept;
 
public:
    EXECUTOR_DECLARE_MAKE_OWNER_FRIENDSHIP();
 
    ~ConfigEnv() noexcept;
 
    bool isValid() const noexcept;
 
    bool hasKey(const Amino::String& key) const noexcept;
 
    const StringArray& values(const Amino::String& key) const noexcept;
 
private:
    ConfigEnv(const ConfigEnv&)            = delete;
    ConfigEnv(ConfigEnv&&)                 = delete;
    ConfigEnv& operator=(const ConfigEnv&) = delete;
    ConfigEnv& operator=(ConfigEnv&&)      = delete;
 
private:
    class Impl;
    BifrostGraph::Executor::Internal::PropagateConstPtr<Impl, Internal::Owned::kYes> m_impl;
};
 
BIFROSTGRAPH_EXECUTOR_SHARED_DECL Amino::String getLibraryPrefix() noexcept;
 
BIFROSTGRAPH_EXECUTOR_SHARED_DECL Amino::String getLibraryExtension() noexcept;
 
BIFROSTGRAPH_EXECUTOR_SHARED_DECL Amino::String getNormalizedPath(
    const Amino::String& path) noexcept;
 
} // namespace Utility
} // namespace Executor
} // namespace BifrostGraph
 
#endif