/*
* Copyright (C) 2024 Linux Studio Plugins Project
* (C) 2024 Vladimir Sadovnikov
*
* This file is part of lsp-runtime-lib
* Created on: 23 окт. 2020 г.
*
* lsp-runtime-lib is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* any later version.
*
* lsp-runtime-lib is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with lsp-runtime-lib. If not, see .
*/
#ifndef LSP_PLUG_IN_IO_ILOADER_H_
#define LSP_PLUG_IN_IO_ILOADER_H_
#include
#include
#include
#include
#include
namespace lsp
{
namespace resource
{
/**
* Interface that allows to resolve the resource name and open input stream/sequence
* By default works like just a factory to the input file stream and input file sequence
*/
class ILoader
{
protected:
status_t nError;
public:
explicit ILoader();
ILoader(const ILoader &) = delete;
ILoader(ILoader &&) = delete;
virtual ~ILoader();
ILoader & operator = (const ILoader &) = delete;
ILoader & operator = (ILoader &&) = delete;
protected:
inline status_t set_error(status_t error) { return nError = error; }
public:
inline status_t last_error() const { return nError; }
/**
* Read contents of the resource associated with the name. Should be thread-safe to produce streams as it
* can be shared across different modules in different threads.
*
* @param name name of resource
* @return pointer to opened stream or NULL and error code is set
*/
virtual io::IInStream *read_stream(const char *name);
virtual io::IInStream *read_stream(const LSPString *name);
/**
* Read contents of the resource associated with the name. Should be thread-safe to produce streams as it
* can be shared across different modules in different threads.
*
* @note This is the main method to be overloaded.
*
* @param name name of resource
* @return pointer to opened stream or NULL and error code is set
*/
virtual io::IInStream *read_stream(const io::Path *name);
/**
* Read contents of the resource associated with the name. Should be thread-safe to produce streams as it
* can be shared across different modules in different threads.
*
* @param name name of resource
* @return pointer to opened stream or NULL and error code is set
*/
virtual io::IInSequence *read_sequence(const char *name, const char *charset = NULL);
virtual io::IInSequence *read_sequence(const LSPString *name, const char *charset = NULL);
virtual io::IInSequence *read_sequence(const io::Path *name, const char *charset = NULL);
/**
* Enumerate resources. Should be thread-safe as it can be called from different threads sharing the
* same resource.
*
* @param path the location of resources within resource tree
* @param list pointer to store list of resources. Resources should be
* free()'d by caller after use
* @return number of resources in list or negative error code
*/
virtual ssize_t enumerate(const char *path, resource_t **list);
virtual ssize_t enumerate(const LSPString *path, resource_t **list);
virtual ssize_t enumerate(const io::Path *path, resource_t **list);
};
} /* namespace resource */
} /* namespace lsp */
#endif /* LSP_PLUG_IN_IO_ILOADER_H_ */