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

//!
//! Crate to load and cache themed icons.
//!
//! # Examples
//!
//! * Using a global [`IconLoader`](IconLoader) object to load icons from the systems `hicolor` icon theme:
//! ```no_run
//! use icon_loader::icon_loader_hicolor;
//!
//! if let Some(icon) = icon_loader_hicolor().load_icon("audio-headphones") {
//!     let path = icon.file_for_size(64).path();
//! }
//! ```
//!
//! * Loading icons from the default icon theme set in KDE:
//! ```no_run
//! use icon_loader::IconLoader;
//!
//! let loader = IconLoader::new_kde().unwrap();
//!
//! if let Some(icon) = loader.load_icon("audio-headphones") {
//!     let path = icon.file_for_size(64).path();
//! }
//! ```
//!
//! * Loading icons from a custom theme in a provided folder:
//! ```no_run
//! use icon_loader::IconLoader;
//!
//! let mut loader = IconLoader::new();
//! loader.set_search_paths(&["path_to_your_icon_theme"]);
//! loader.set_theme_name_provider("name_of_your_icon_theme");
//! loader.update_theme_name().unwrap();
//!
//! if let Some(icon) = loader.load_icon("icon_name") {
//!     let path = icon.file_for_size(32).path();
//! }
//! ```

#![deny(
    missing_docs,
    missing_debug_implementations,
    missing_copy_implementations,
    trivial_casts,
    trivial_numeric_casts
)]
#![forbid(unsafe_code, unstable_features)]

mod error;
mod icon;
mod loader;
mod search_paths;
mod theme_name_provider;

pub use error::{Error, ProviderError, Result};
pub use icon::{Icon, IconDir, IconFile, IconFileType, IconSizeType};
pub use loader::*;
pub use search_paths::SearchPaths;
pub use theme_name_provider::ThemeNameProvider;

use std::sync::OnceLock;

/// This function returns a reference to a global [`IconLoader`](IconLoader) object with default settings.
pub fn icon_loader_hicolor() -> &'static IconLoader {
    static LOADER: OnceLock<IconLoader> = OnceLock::new();

    LOADER.get_or_init(IconLoader::new)
}