aboutsummaryrefslogtreecommitdiff
path: root/src/crepe/Asset.h
blob: cb413f46da5cfc3da4aa8c66b11e7a73f951bd87 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
#pragma once

#include <fstream>
#include <iostream>
#include <string>

namespace crepe {

/**
 * \brief Asset location helper
 *
 * This class is used to locate and canonicalize paths to game asset files, and
 * should *always* be used when retrieving files from disk.
 */
class Asset {
public:
	/**
	 * \param src  Unique identifier to asset
	 */
	Asset(const std::string & src);

public:
	/**
	 * \brief Get an input stream to the contents of this asset
	 * \return Input stream with file contents
	 */
	std::istream & get_stream();
	/**
	 * \brief Get the canonical path to this asset
	 * \return Canonical path to this asset
	 */
	const std::string & get_canonical() const;

private:
	//! Canonical path to asset
	const std::string src;
	//! File handle (stream)
	std::ifstream file;
};

} // namespace crepe