resource.h

Go to the documentation of this file.

 
#pragma once
 
 
#include <promeki/config.h>
#if PROMEKI_ENABLE_CORE
#include <promeki/namespace.h>
#include <promeki/string.h>
#include <promeki/buffer.h>
#include <promeki/error.h>
#include <promeki/list.h>
#include <promeki/filepath.h>
#include <promeki/util.h>
 
// Forward declarations so this header does not pull in <cirf/types.h>
// — which keeps cirf an internal implementation detail of promeki
// and lets the cirf_runtime link stay PRIVATE. Consumers that want
// to dereference the pointers returned by findFile()/findFolder()
// can include <cirf/types.h> themselves; the header is installed
// alongside the libpromeki thirdparty headers.
struct cirf_file;
struct cirf_folder;
typedef struct cirf_file   cirf_file_t;
typedef struct cirf_folder cirf_folder_t;
 
PROMEKI_NAMESPACE_BEGIN
 
class Resource {
        public:
                static constexpr const char *Prefix = ":/";
 
                static bool isResourcePath(const String &path);
 
                static String stripPrefix(const String &path);
 
                static const cirf_file_t *findFile(const String &path);
 
                static const cirf_folder_t *findFolder(const String &path);
 
                static bool exists(const String &path);
 
                static Buffer data(const String &path, Error *err = nullptr);
 
                static String mime(const String &path);
 
                static size_t size(const String &path);
 
                static List<FilePath> listFiles(const String &path, Error *err = nullptr);
 
                static List<FilePath> listFolders(const String &path, Error *err = nullptr);
 
                static List<FilePath> listEntries(const String &path, Error *err = nullptr);
 
                static Error registerRoot(const cirf_folder_t *root, const String &prefix = String());
 
                static void unregisterRoot(const String &prefix);
};
 
#define PROMEKI_REGISTER_RESOURCES(NAME, PREFIX)                                                                       \
        namespace {                                                                                                    \
                struct PROMEKI_CONCAT(_promeki_resreg_, NAME) {                                                        \
                                PROMEKI_CONCAT(_promeki_resreg_, NAME)() {                                             \
                                        ::promeki::Resource::registerRoot(&NAME##_root, PREFIX);                       \
                                }                                                                                      \
                };                                                                                                     \
                static PROMEKI_CONCAT(_promeki_resreg_, NAME) PROMEKI_CONCAT(_promeki_resreg_inst_, NAME);             \
        }
 
PROMEKI_NAMESPACE_END
 
#endif // PROMEKI_ENABLE_CORE