Register VFS Mapping

Queries the user for the location of an externally sourced file. More...

Collaboration diagram for Register VFS Mapping:

Classes
struct	echomap::RegisterVFSMappingNotification
	A notification to indicate a new VFS mapping from an external source. More...

Functions
static void	echomap::ActionControllerBase< Derived >::register_vfs_mapping (const std::size_t project_id, const std::filesystem::path &external)
	Invokes the Register VFS Mapping.
EMSCRIPTEN_KEEPALIVE int	echomap_on_register_vfs_mapping (const std::size_t project_id, const char *const external, const char *const internal) noexcept
	Services the Register VFS Mapping callback for Emscripten.
static void	echomap::JSActionController::register_vfs_mapping_impl (std::size_t project_id, const std::filesystem::path &external)
	Invokes the JS function for Register VFS Mapping.
static void	echomap::NativeActionController::register_vfs_mapping_impl (std::size_t project_id, const std::filesystem::path &external)
	Invokes the native function for Register VFS Mapping.

Detailed Description

Queries the user for the location of an externally sourced file.

Function Documentation

echomap_on_register_vfs_mapping()

EMSCRIPTEN_KEEPALIVE int echomap_on_register_vfs_mapping ( const std::size_t project_id, const char *const external, const char *const internal )

noexcept

Services the Register VFS Mapping callback for Emscripten.

Parameters

project_id	The ID of the Project that owns the destination Signal.
external	The path of the external file being mapped into the VFS.
internal	The path of the VFS file.

Returns

Zero status to indicate success; non-zero to indicate failure.

Definition at line 127 of file JSActionController.cpp.

{
    using namespace echomap;
 
    if (external == nullptr || internal == nullptr)
        return 2;
 
    try {
        JSActionController::notify<RegisterVFSMappingNotification>(project_id, external, internal);
        return 0;
    } catch (const ConfigurationError& error) {
        LOG_F_ERROR("Could not load path {} due to error: {}", internal, error.what());
        return 3;
    } catch (const std::exception& error) {
        LOG_F_ERROR("Could not load path {} due to unexpected error: {}", internal, error.what());
        return 4;
    } catch (...) {
        LOG_F_ERROR("Could not load path {} due to unknown error.", internal);
        return 5;
    }
}

register_vfs_mapping()

template<typename Derived>

void echomap::ActionControllerBase< Derived >::register_vfs_mapping ( const std::size_t project_id, const std::filesystem::path & external )

inlinestatic

Invokes the Register VFS Mapping.

Parameters

project_id	The ID of the Project that owns the destination Signal.
external	The path of the external file being mapped into the VFS.

Definition at line 106 of file ActionControllerBase.hpp.

    {
        Derived::register_vfs_mapping_impl(project_id, external);
    }

register_vfs_mapping_impl() [1/2]

void echomap::JSActionController::register_vfs_mapping_impl ( std::size_t project_id, const std::filesystem::path & external )

staticprivate

Invokes the JS function for Register VFS Mapping.

Parameters

project_id	The ID of the Project that owns the destination Signal.
external	The path of the external file being mapped into the VFS.

Definition at line 74 of file JSActionController.cpp.

{
    js::register_vfs_mapping(project_id, external.c_str());
}

register_vfs_mapping_impl() [2/2]

void echomap::NativeActionController::register_vfs_mapping_impl ( std::size_t project_id, const std::filesystem::path & external )

staticprivate

Invokes the native function for Register VFS Mapping.

Parameters

project_id	The ID of the Project that owns the destination Signal.
external	The path of the external file being mapped into the VFS.

Definition at line 25 of file NativeActionController.cpp.

{
    std::ignore = project_id;
    std::ignore = external;
 
    throw std::runtime_error(
            "The NativeActionController received a request to query for VFS mappings, which are not applicable on the "
            "native platform."
    );
}