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 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
//! A simple solution for encoding common icon file-formats, such as `.ico`, `.icns` and _favicon_. //! //! This crate is mostly a wrapper for other libraries, unifying existing APIs into a single, cohesive //! interface. It serves as **[Iconiic's](https://github.com/warrengalyen/iconiic)** internal library. //! //! # Overview //! //! An _icon_ consists of a map between _keys_ and _images_. An _entry_ is a _key-value_ pair contained //! in an _icon_. //! //! **IconWriter** simply automates the process of re-scaling _images_, creating _entries_ and combining //! them into an _icon_. //! //! ## Keys //! //! Each _icon_ format is associated with a particular _key type_, which determines how //! _entries_ are labeled. Each _key_ can only be associated with a single _image_. //! //! For example, _icon_ formats that only differentiate _entries_ by the dimensions of their associated //! _images_ are labeled by _positive integers_, such as the `.ico` and `.icns` file-formats. //! //! On the other hand, _icon_ formats that distinguish their _entries_ by //! _[path](https://en.wikipedia.org/wiki/Path_%28computing%29)_, such as _png sequeces_ and //! _[FreeDesktop icon themes](https://specifications.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html)_ //! , are labeled by _path_. //! //! Note that, since the dimensions //! of the _images_ contained in an _entry_ are dictated by their associated _entries_, every _key_ //! must be convertible to a _positive integers_. Therefore, all _key types_ are required to implement //! `AsRef<u32>`. //! //! ## Resampling //! //! Pictures are scaled using resampling filters, which are represented by _functions that take a source_ //! _image and a size and return a re-scaled image_. //! //! This allows the users of this crate to provide their custom resampling filters. Common resampling //! filters are provided in the //! [`resample`](https://docs.rs/iconwriter/1.7.0/iconwriter/resample/index.html) module. //! //! # Examples //! //! ## General Usage //! //! The `Icon::add_entry` can be used to automatically resample //! _source images_ and converts them to _entries_ in an icon. //! //! ```rust, ignore //! use iconwriter::{Ico, Image, Icon, IconError}; //! //! fn example() -> Result<(), IconError> { //! let icon = Ico::new(); //! let src = Image::open("image.svg")?; //! icon.add_entry(resample::linear, &img, 32) //! } //! ``` //! //! ## Writing to Disk //! //! Implementors of the `Icon` trait can be written to any object //! that implements `io::Write` with the `Icon::write` method. //! //! ```rust, ignore //! use iconwriter::favicon::Favicon; //! use std::{io, fs::File}; //! //! fn example() -> io::Result<()> { //! let icon = Favicon::new(); //! //! // Process the icon ... //! //! let file = File::create("out.icns")?; //! icon.write(file) //! } //! ``` //! //! Alternatively, icons can be directly written to a file on //! disk with `Icon::save` method. //! //! ```rust, ignore //! use iconwriter::favicon::Favicon; //! use std::{io, fs::File}; //! //! fn example() -> io::Result<()> { //! let icon = Favicon::new(); //! //! /* Process the icon */ //! //! icon.save("./output/") //! } //! ``` pub extern crate image; pub extern crate resvg; use crate::usvg::Tree; use image::{DynamicImage, GenericImageView, ImageError}; pub use resvg::{ raqote, usvg::{self, XmlIndent, XmlOptions}, }; use std::{ convert::From, error, fmt::{self, Debug, Display, Formatter}, fs::File, io::{self, Write}, path::Path, }; pub mod favicon; pub mod icns; pub mod ico; pub mod resample; pub mod encode; #[cfg(test)] mod test; const STD_CAPACITY: usize = 7; const MISMATCHED_DIM_ERR: &str = "a resampling filter returned an image of dimensions other than the ones specified by it's arguments"; /// A generic representation of an icon encoder. pub trait Icon where Self: Sized, { type Key: AsSize + Send + Sync; /// Creates a new icon. /// /// # Example /// ```rust, ignore /// let icon = Ico::new(); /// ``` fn new() -> Self { Self::with_capacity(STD_CAPACITY) } /// Constructs a new, empty `Icon` with the specified capacity. /// The `capacity` argument designates the number of entries /// that will be allocated. /// /// # Example /// ```rust, ignore /// let icon = Ico::with_capacity(5); /// ``` fn with_capacity(capacity: usize) -> Self; /// Returns the number of _entries_ contained in the icon. fn len(&self) -> usize; /// Adds an individual entry to the icon. /// /// # Arguments /// /// * `filter` The resampling filter that will be used to re-scale `source`. /// * `source` A reference to the source image this entry will be based on. /// * `key` Information on the target entry. /// /// # Return Value /// /// * Returns `Err(IconError::AlreadyIncluded(_))` if the icon already contains /// an entry associated with `key`. /// * Returns `Err(IconError::Resample(_))` if the resampling filter provided in /// the `filter` argument fails produces results of dimensions other than the /// ones specified by `key`. /// * Otherwise returns `Ok(())`. /// /// # Example /// /// ```rust, ignore /// use iconwriter::{Ico, Image, Icon, IconError}; /// /// fn example() -> Result<(), IconError> { /// let icon = Ico::new(); /// let src = Image::open("image.svg")?; /// /// icon.add_entry(resample::linear, &img, 32) /// } /// ``` fn add_entry<F: FnMut(&DynamicImage, u32) -> io::Result<DynamicImage>>( &mut self, filter: F, source: &Image, key: Self::Key, ) -> Result<(), IconError<Self::Key>>; /// Adds a series of entries to the icon. /// /// # Arguments /// /// * `filter` The resampling filter that will be used to re-scale `source`. /// * `source` A reference to the source image this entry will be based on. /// * `keys` A container for the information on the target entries. /// /// # Return Value /// /// * Returns `Err(IconError::AlreadyIncluded(_))` if the icon already contains an /// entry associated with any of the items of `keys`. /// * Returns `Err(IconError::Resample(_))` if the resampling filter provided in /// the `filter` argument fails or produces results of dimensions other than the /// ones specified by the items of `keys`. /// * Otherwise returns `Ok(())`. /// /// # Example /// /// ```rust, ignore /// use iconwriter::{Icns, Image, Icon, IconError}; /// /// fn example() -> Result<(), IconError> { /// let icon = Icns::new(); /// let src = Image::open("image.svg")?; /// /// icon.add_entries( /// resample::linear, /// &src, /// vec![32, 64, 128] /// ) /// } /// ``` fn add_entries<F: FnMut(&DynamicImage, u32) -> io::Result<DynamicImage>, I: IntoIterator<Item = Self::Key>>( &mut self, mut filter: F, source: &Image, keys: I, ) -> Result<(), IconError<Self::Key>> { for key in keys { self.add_entry(|src, size| filter(src, size), source, key)?; } Ok(()) } /// Writes the contents of the icon to `w`. /// /// # Example /// /// ```rust, ignore /// use iconwriter::favicon::Favicon; /// use std::{io, fs::File}; /// /// fn example() -> io::Result<()> { /// let icon = Favicon::new(); /// /// /* Process the icon */ /// /// let file = File::create("out.icns")?; /// icon.write(file) /// } /// ``` fn write<W: Write>(&mut self, w: &mut W) -> io::Result<()>; /// Writes the contents of the icon to a file on disk. /// /// # Example /// /// ```rust, ignore /// use iconwriter::favicon::Favicon; /// use std::{io, fs::File}; /// /// fn example() -> io::Result<()> { /// let icon = Favicon::new(); /// /// /* Process the icon */ /// /// icon.save("./output/") /// } /// ``` fn save<P: AsRef<Path>>(&mut self, path: &P) -> io::Result<()> { let mut file = File::create(path.as_ref())?; self.write(&mut file) } } /// A trait for types that represent the dimesions of an icon. pub trait AsSize { fn as_size(&self) -> u32; } #[derive(Clone)] /// A uniun type for raster and vector graphics. pub enum Image { /// A generic raster image. Raster(DynamicImage), /// A svg-encoded vector image. Svg(Tree), } /// The error type for operations of the `Icon` trait. pub enum IconError<K: AsSize + Send + Sync> { /// The `Icon` instance already includes an entry associated with this key. AlreadyIncluded(K), /// A resampling error. Resample(ResampleError), } #[derive(Debug)] /// The error type for resampling operations. pub enum ResampleError { /// Generic I/O error. Io(io::Error), /// A resampling filter produced results of dimensions /// other the ones specified by it's arguments. MismatchedDimensions(u32, (u32, u32)), } impl Image { /// Attempts to create a `Image` from a given path. /// /// # Return Value /// /// * Returns `Ok(src)` if the file indicated by the `path` argument could be /// successfully parsed into an image. /// * Returns `Err(io::Error::from(io::ErrorKind::Other))` if the image allocation failed /// or if the file was not able to be accessed. /// * Returns `Err(io::Error::from(io::ErrorKind::InvalidInput))` if the image format is not /// supported by `iconwriter`. /// * Returns `Err(io::Error::from(io::ErrorKind::InvalidData))` otherwise. /// /// # Example /// ```rust, ignore /// let img = Image::open("source.png")?; /// ``` pub fn open<P: AsRef<Path>>(path: P) -> Result<Self, io::Error> { match image::open(&path) { Ok(img) => Ok(Image::from(img)), Err(ImageError::InsufficientMemory) => Err(io::Error::from(io::ErrorKind::Other)), Err(ImageError::IoError(err)) => Err(err), Err(ImageError::UnsupportedError(_)) => { match Tree::from_file(path, &usvg::Options::default()) { Ok(img) => Ok(Image::from(img)), Err(usvg::Error::InvalidFileSuffix) => { Err(io::Error::from(io::ErrorKind::InvalidInput)) } Err(usvg::Error::FileOpenFailed) => Err(io::Error::from(io::ErrorKind::Other)), _ => Err(io::Error::from(io::ErrorKind::InvalidData)), } } _ => Err(io::Error::from(io::ErrorKind::InvalidData)), } } /// Rasterizes the `Image` to a `DynamicImage`. /// /// For _raster graphics_ the moethod simply applies the resampling filter /// specified by the `filter` argument. For _vector graphics_, the method /// rasterizes the image to fit the dimensions specified `size` using /// linear interpolation and antialiasing. pub fn rasterize<F: FnMut(&DynamicImage, u32) -> io::Result<DynamicImage>>( &self, filter: F, size: u32, ) -> Result<DynamicImage, ResampleError> { match self { Self::Raster(ras) => resample::apply(filter, ras, size), Self::Svg(svg) => resample::svg(svg, size), } } /// Returns the width of the image in pixels. pub fn width(&self) -> f64 { match self { Image::Raster(ras) => ras.width() as f64, Image::Svg(svg) => svg.svg_node().view_box.rect.width(), } } /// Returns the height of the image in pixels. pub fn height(&self) -> f64 { match self { Image::Raster(ras) => ras.height() as f64, Image::Svg(svg) => svg.svg_node().view_box.rect.height(), } } /// Returns the dimensions of the image in pixels. pub fn dimensions(&self) -> (f64, f64) { (self.width(), self.height()) } } impl From<Tree> for Image { fn from(svg: Tree) -> Self { Image::Svg(svg) } } impl From<DynamicImage> for Image { fn from(bit: DynamicImage) -> Self { Image::Raster(bit) } } unsafe impl Send for Image {} unsafe impl Sync for Image {} impl<K: AsSize + Send + Sync> IconError<K> { /// Converts `self` to a `IconError<T>` using `f`. pub fn map<T: AsSize + Send + Sync, F: FnOnce(K) -> T>( self, f: F ) -> IconError<T> { match self { Self::AlreadyIncluded(e) => IconError::AlreadyIncluded(f(e)), Self::Resample(err) => IconError::Resample(err), } } } impl<K: AsSize + Send + Sync> Display for IconError<K> { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { match self { Self::AlreadyIncluded(_) => write!( f, "the icon already contains an entry associated with this key" ), Self::Resample(err) => <ResampleError as Display>::fmt(&err, f), } } } impl<K: AsSize + Send + Sync + Debug> Debug for IconError<K> { fn fmt(&self, f: &mut Formatter) -> fmt::Result { match self { Self::AlreadyIncluded(e) => write!(f, "Error::AlreadyIncluded({:?})", e), Self::Resample(err) => <ResampleError as Debug>::fmt(&err, f), } } } impl<K: AsSize + Send + Sync + Debug> error::Error for IconError<K> { fn source(&self) -> Option<&(dyn error::Error + 'static)> { if let Self::Resample(ref err) = self { err.source() } else { None } } } impl<K: AsSize + Send + Sync> From<ResampleError> for IconError<K> { fn from(err: ResampleError) -> Self { Self::Resample(err) } } impl<K: AsSize + Send + Sync> From<io::Error> for IconError<K> { fn from(err: io::Error) -> Self { Self::from(ResampleError::from(err)) } } impl<K: AsSize + Send + Sync> Into<io::Error> for IconError<K> { fn into(self) -> io::Error { if let Self::Resample(err) = self { err.into() } else { io::Error::from(io::ErrorKind::InvalidInput) } } } impl From<io::Error> for ResampleError { fn from(err: io::Error) -> Self { Self::Io(err) } } impl Display for ResampleError { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { match self { Self::Io(err) => write!(f, "{}", err), Self::MismatchedDimensions(s, (w, h)) => write!( f, "{0}: expected {1}x{1}, got {2}x{3}", MISMATCHED_DIM_ERR, s, w, h ), } } } impl error::Error for ResampleError { fn source(&self) -> Option<&(dyn error::Error + 'static)> { if let Self::Io(ref err) = self { Some(err) } else { None } } } impl Into<io::Error> for ResampleError { fn into(self) -> io::Error { match self { Self::Io(err) => err, Self::MismatchedDimensions(_, _) => io::Error::from(io::ErrorKind::InvalidData), } } }