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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
use std::path::Path;
use crate::{
DefaultResourceCache, FilesystemResourceReader, Map, ResourceCache, ResourceReader, Result,
Tileset,
};
#[cfg(feature = "world")]
use crate::World;
/// A type used for loading [`Map`]s and [`Tileset`]s.
///
/// Internally, it holds a [`ResourceCache`] that, as its name implies, caches intermediate loading
/// artifacts, most notably map tilesets.
///
/// It also contains a [`ResourceReader`] which is the object in charge of providing read handles
/// to files via a [`ResourcePath`](crate::ResourcePath).
///
/// ## Reasoning
/// This type is used for loading operations because they require a [`ResourceCache`] for
/// intermediate artifacts, so using a type for creation can ensure that the cache is reused if
/// loading more than one object is required.
#[derive(Debug, Clone, Default)]
pub struct Loader<
Cache: ResourceCache = DefaultResourceCache,
Reader: ResourceReader = FilesystemResourceReader,
> {
cache: Cache,
reader: Reader,
}
impl Loader {
/// Creates a new loader, creating a default resource cache and reader
/// ([`DefaultResourceCache`] & [`FilesystemResourceReader`] respectively) in the process.
pub fn new() -> Self {
Self {
cache: DefaultResourceCache::new(),
reader: FilesystemResourceReader::new(),
}
}
}
impl<Reader: ResourceReader> Loader<DefaultResourceCache, Reader> {
/// Creates a new loader using a specific reader and the default resource cache ([`DefaultResourceCache`]).
/// Shorthand for `Loader::with_cache_and_reader(DefaultResourceCache::new(), reader)`.
///
/// ## Example
/// ```
/// # fn main() -> tiled::Result<()> {
/// use std::{sync::Arc, path::Path};
///
/// use tiled::{Loader, ResourceCache};
///
/// let mut loader = Loader::with_reader(
/// // Specify the reader to use. We can use anything that implements `ResourceReader`, e.g. FilesystemResourceReader.
/// // Any function that has the same signature as `ResourceReader::read_from` also implements it.
/// // Here we define a reader that embeds the map at "assets/tiled_xml.csv" into the executable, and allow
/// // accessing it only through "/my-map.tmx"
/// // ALL maps, tilesets and templates will be read through this function, even if you don't explicitly load them
/// // (They can be dependencies of one you did want to load in the first place).
/// // Doing this embedding is useful for places where the OS filesystem is not available (e.g. WASM applications).
/// |path: &std::path::Path| -> std::io::Result<_> {
/// if path == std::path::Path::new("/my-map.tmx") {
/// Ok(std::io::Cursor::new(include_bytes!("../assets/tiled_csv.tmx")))
/// } else {
/// Err(std::io::ErrorKind::NotFound.into())
/// }
/// }
/// );
///
/// let map = loader.load_tmx_map("/my-map.tmx")?;
///
/// assert_eq!(
/// map.tilesets()[0].image.as_ref().unwrap().source,
/// Path::new("/tilesheet.png")
/// );
///
/// # Ok(())
/// # }
/// ```
pub fn with_reader(reader: Reader) -> Self {
Self {
cache: DefaultResourceCache::new(),
reader,
}
}
}
impl<Cache: ResourceCache, Reader: ResourceReader> Loader<Cache, Reader> {
/// Creates a new loader using a specific resource cache and reader. In most cases you won't
/// need a custom resource cache; If that is the case you can use [`Loader::with_reader()`] for
/// a less verbose version of this function.
///
/// ## Example
/// ```
/// # fn main() -> tiled::Result<()> {
/// use std::{sync::Arc, path::Path};
///
/// use tiled::{Loader, ResourceCache};
///
/// /// An example resource cache that doesn't actually cache any resources at all.
/// struct NoopResourceCache;
///
/// impl ResourceCache for NoopResourceCache {
/// fn get_tileset(
/// &self,
/// _path: impl AsRef<tiled::ResourcePath>,
/// ) -> Option<std::sync::Arc<tiled::Tileset>> {
/// None
/// }
///
/// fn get_template(
/// &self,
/// _path: impl AsRef<tiled::ResourcePath>,
/// ) -> Option<std::sync::Arc<tiled::Template>> {
/// None
/// }
///
/// fn insert_tileset(
/// &mut self,
/// _path: impl AsRef<tiled::ResourcePath>,
/// _tileset: Arc<tiled::Tileset>
/// ) {}
///
/// fn insert_template(
/// &mut self,
/// _path: impl AsRef<tiled::ResourcePath>,
/// _template: Arc<tiled::Template>
/// ) {}
/// }
///
/// let mut loader = Loader::with_cache_and_reader(
/// // Specify the resource cache to use. In this case, the one we defined earlier.
/// NoopResourceCache,
/// // Specify the reader to use. We can use anything that implements `ResourceReader`, e.g. FilesystemResourceReader.
/// // Any function that has the same signature as `ResourceReader::read_from` also implements it.
/// // Here we define a reader that embeds the map at "assets/tiled_xml.csv" into the executable, and allow
/// // accessing it only through "/my-map.tmx"
/// // ALL maps, tilesets and templates will be read through this function, even if you don't explicitly load them
/// // (They can be dependencies of one you did want to load in the first place).
/// // Doing this embedding is useful for places where the OS filesystem is not available (e.g. WASM applications).
/// |path: &std::path::Path| -> std::io::Result<_> {
/// if path == std::path::Path::new("/my-map.tmx") {
/// Ok(std::io::Cursor::new(include_bytes!("../assets/tiled_csv.tmx")))
/// } else {
/// Err(std::io::ErrorKind::NotFound.into())
/// }
/// }
/// );
///
/// let map = loader.load_tmx_map("/my-map.tmx")?;
///
/// assert_eq!(
/// map.tilesets()[0].image.as_ref().unwrap().source,
/// Path::new("/tilesheet.png")
/// );
///
/// # Ok(())
/// # }
/// ```
pub fn with_cache_and_reader(cache: Cache, reader: Reader) -> Self {
Self { cache, reader }
}
/// Parses a file hopefully containing a Tiled map and tries to parse it. All external files
/// will be loaded relative to the path given.
///
/// All intermediate objects such as map tilesets will be stored in the [internal loader cache].
///
/// [internal loader cache]: Loader::cache()
pub fn load_tmx_map(&mut self, path: impl AsRef<Path>) -> Result<Map> {
crate::parse::xml::parse_map(path.as_ref(), &mut self.reader, &mut self.cache)
}
/// Parses a file hopefully containing a Tiled tileset and tries to parse it. All external files
/// will be loaded relative to the path given.
///
/// Unless you specifically want to load a tileset, you won't need to call this function. If
/// you are trying to load a map, simply use [`Loader::load_tmx_map`].
///
/// ## Note
/// This function will **not** cache the tileset inside the internal [`ResourceCache`], since
/// in this context it is not an intermediate object.
pub fn load_tsx_tileset(&mut self, path: impl AsRef<Path>) -> Result<Tileset> {
crate::parse::xml::parse_tileset(path.as_ref(), &mut self.reader, &mut self.cache)
}
#[cfg(feature = "world")]
/// Parses a file hopefully containing a Tiled world.
///
/// The returned [`World`] provides the deserialized data from the world file. It does not load
/// any maps or tilesets.
/// ## Note
/// The ['WorldPattern`] struct provides [`WorldPattern::match_path`] and [`WorldPattern::match_paths`]
/// as utility functions to test paths and return parsed [`WorldMap`]s.
pub fn load_world(&mut self, path: impl AsRef<Path>) -> Result<World> {
crate::world::parse_world(path.as_ref(), &mut self.reader)
}
/// Returns a reference to the loader's internal [`ResourceCache`].
pub fn cache(&self) -> &Cache {
&self.cache
}
/// Returns a mutable reference to the loader's internal [`ResourceCache`].
pub fn cache_mut(&mut self) -> &mut Cache {
&mut self.cache
}
/// Returns a reference to the loader's internal [`ResourceReader`].
pub fn reader(&self) -> &Reader {
&self.reader
}
/// Returns a mutable reference to the loader's internal [`ResourceReader`].
pub fn reader_mut(&mut self) -> &mut Reader {
&mut self.reader
}
/// Consumes the loader and returns its internal [`ResourceCache`] and [`ResourceReader`].
pub fn into_inner(self) -> (Cache, Reader) {
(self.cache, self.reader)
}
}