Library.h

Go to the documentation of this file.

//-
// ================================================================================================
// Copyright 2025 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_LIBRARY_H
#define BIFROSTGRAPH_EXECUTOR_LIBRARY_H
 
#include <BifrostGraph/Executor/internal/ExecutorExport.h>
#include <BifrostGraph/Executor/internal/PropagateConstPtr.h>
 
#include <BifrostGraph/Executor/Factory.h>
#include <BifrostGraph/Executor/Owner.h>
#include <BifrostGraph/Executor/Types.h>
 
#include <Amino/Core/String.h>
 
//-------------------------------------------------------------------------------------------------
// Forward declarations
//-------------------------------------------------------------------------------------------------
 
namespace BifrostGraph {
namespace Executor {
 
class Workspace;
 
namespace Private {
class LibraryImpl;
class IRestrictedLibraryServices;
} // namespace Private
 
 
//-------------------------------------------------------------------------------------------------
// CLASS Library
//-------------------------------------------------------------------------------------------------
 
class BIFROSTGRAPH_EXECUTOR_SHARED_DECL Library final {
protected:
    //---------------------------------------------------------------------------------------------
    // Initialization
    //---------------------------------------------------------------------------------------------
 
    explicit Library(const Amino::String& name) noexcept;
 
    explicit Library(Uninitialized uninitialized) noexcept;
 
    EXECUTOR_DECLARE_MAKE_OWNER_FRIENDSHIP();
 
    friend class Workspace;
 
public:
    ~Library() noexcept;
 
    bool isValid() const noexcept;
 
    static Library& getInvalid() noexcept;
 
    //---------------------------------------------------------------------------------------------
    // Resources Services
    //---------------------------------------------------------------------------------------------
 
    bool loadDefinitionFile(const Amino::String& filePath, StringArray& nameList) noexcept;
 
    bool saveDefinitionFile(const Amino::String& filePath) noexcept;
 
    //---------------------------------------------------------------------------------------------
    // IRestrictedLibraryServices
    //---------------------------------------------------------------------------------------------
 
    const Private::IRestrictedLibraryServices& getRestrictedServices() const noexcept;
    Private::IRestrictedLibraryServices&       getRestrictedServices() noexcept;
 
private:
    Library(const Library&)            = delete;
    Library(Library&&)                 = delete;
    Library& operator=(const Library&) = delete;
    Library& operator=(Library&&)      = delete;
 
private:
    Internal::PropagateConstPtr<Private::LibraryImpl, Internal::Owned::kYes> m_impl;
    static Library                                                           s_invalid;
};
 
} // namespace Executor
} // namespace BifrostGraph
 
#endif // BIFROSTGRAPH_EXECUTOR_LIBRARY_H