osb/source/core/StarAssetPath.hpp

82 lines
3.1 KiB
C++
Raw Normal View History

2023-06-23 15:30:55 +00:00
#ifndef STAR_ASSET_PATH_HPP
#define STAR_ASSET_PATH_HPP
#include "StarDirectives.hpp"
2023-06-24 12:49:47 +00:00
#include "StarHash.hpp"
2023-06-24 15:16:40 +00:00
#include "StarDataStream.hpp"
2023-06-23 15:30:55 +00:00
namespace Star {
// Asset paths are not filesystem paths. '/' is always the directory separator,
// and it is not possible to escape any asset source directory. '\' is never a
// valid directory separator. All asset paths are considered case-insensitive.
//
// In addition to the path portion of the asset path, some asset types may also
// have a sub-path, which is always separated from the path portion of the asset
// by ':'. There can be at most 1 sub-path component.
//
// Image paths may also have a directives portion of the full asset path, which
// must come after the path and optional sub-path comopnent. The directives
// portion of the path starts with a '?', and '?' separates each subsquent
// directive.
struct AssetPath {
static AssetPath split(String const& path);
static String join(AssetPath const& path);
// Get / modify sub-path directly on a joined path string
static String setSubPath(String const& joinedPath, String const& subPath);
static String removeSubPath(String const& joinedPath);
// Get / modify directives directly on a joined path string
static String getDirectives(String const& joinedPath);
static String addDirectives(String const& joinedPath, String const& directives);
static String removeDirectives(String const& joinedPath);
// The base directory name for any given path, including the trailing '/'.
// Ignores sub-path and directives.
static String directory(String const& path);
// The file part of any given path, ignoring sub-path and directives. Path
// must be a file not a directory.
static String filename(String const& path);
// The file extension of a given file path, ignoring directives and
// sub-paths.
static String extension(String const& path);
// Computes an absolute asset path from a relative path relative to another
// asset. The sourcePath must be an absolute path (may point to a directory
// or an asset in a directory, and ignores ':' sub-path or ? directives),
// and the givenPath may be either an absolute *or* a relative path. If it
// is an absolute path, it is returned unchanged. If it is a relative path,
// then it is computed as relative to the directory component of the
// sourcePath.
static String relativeTo(String const& sourcePath, String const& givenPath);
2023-06-24 03:06:13 +00:00
AssetPath() = default;
2023-06-24 15:16:40 +00:00
AssetPath(const char* path);
2023-06-24 03:06:13 +00:00
AssetPath(String const& path);
2023-06-24 09:41:52 +00:00
AssetPath(String&& basePath, Maybe<String>&& subPath, DirectivesGroup&& directives);
AssetPath(const String& basePath, const Maybe<String>& subPath, const DirectivesGroup& directives);
2023-06-23 15:30:55 +00:00
String basePath;
Maybe<String> subPath;
2023-06-24 09:41:52 +00:00
DirectivesGroup directives;
2023-06-23 15:30:55 +00:00
bool operator==(AssetPath const& rhs) const;
};
2023-06-24 15:16:40 +00:00
DataStream& operator>>(DataStream& ds, AssetPath& path);
DataStream& operator<<(DataStream& ds, AssetPath const& path);
2023-06-23 15:30:55 +00:00
std::ostream& operator<<(std::ostream& os, AssetPath const& rhs);
2023-06-24 12:49:47 +00:00
template <>
struct hash<AssetPath> {
size_t operator()(AssetPath const& s) const;
};
2023-06-23 15:30:55 +00:00
}
template <> struct fmt::formatter<Star::AssetPath> : ostream_formatter {};
2023-06-23 15:30:55 +00:00
#endif