cfonts 1.3.0

Sexy ANSI fonts for the console
Documentation 
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

//! The contents of this module is all about getting information about our font
extern crate serde_json;
use serde::Deserialize;

use std::collections::HashMap;

use crate::color::color;
use crate::config::{Colors, Fonts, Options};
use crate::debug::{d, Dt};

/// The shape of our font data
#[derive(Deserialize)]
pub struct Font {
	/// The name of our font
	pub name: String,
	/// The version of this font
	pub version: String,
	/// The homepage of this font
	pub homepage: String,
	/// The supported colors of this font
	pub colors: usize,
	/// The output lines this font needs
	pub lines: usize,
	/// The buffer to be printed at the start of each new line
	pub buffer: Vec<String>,
	/// The letter space of this font
	pub letterspace: Vec<String>,
	/// The letter space size of this font
	pub letterspace_size: usize,
	/// A hashmap of all supported letters
	pub chars: HashMap<String, Vec<String>>,
}

/// Function to embed the data of our font files into our binary
///
/// ```rust
/// extern crate cfonts;
///
/// use cfonts::{ Options, Fonts };
/// use cfonts::font::{load_all_fonts, get};
///
/// let mut options = Options::default();
/// options.font = Fonts::FontChrome;
///
/// let fonts = load_all_fonts(); // our HashMap of all font files content
/// let this_font = get(&fonts, &options);
/// assert_eq!(this_font.name, String::from("chrome"));
/// ```
pub fn load_all_fonts() -> HashMap<Fonts, &'static str> {
	let mut fonts = HashMap::new();

	let font_content = include_str!("../fonts/console.json");
	fonts.insert(Fonts::FontConsole, font_content);

	let font_content = include_str!("../fonts/block.json");
	fonts.insert(Fonts::FontBlock, font_content);

	let font_content = include_str!("../fonts/simpleBlock.json");
	fonts.insert(Fonts::FontSimpleBlock, font_content);

	let font_content = include_str!("../fonts/simple.json");
	fonts.insert(Fonts::FontSimple, font_content);

	let font_content = include_str!("../fonts/3d.json");
	fonts.insert(Fonts::Font3d, font_content);

	let font_content = include_str!("../fonts/simple3d.json");
	fonts.insert(Fonts::FontSimple3d, font_content);

	let font_content = include_str!("../fonts/chrome.json");
	fonts.insert(Fonts::FontChrome, font_content);

	let font_content = include_str!("../fonts/huge.json");
	fonts.insert(Fonts::FontHuge, font_content);

	let font_content = include_str!("../fonts/shade.json");
	fonts.insert(Fonts::FontShade, font_content);

	let font_content = include_str!("../fonts/slick.json");
	fonts.insert(Fonts::FontSlick, font_content);

	let font_content = include_str!("../fonts/grid.json");
	fonts.insert(Fonts::FontGrid, font_content);

	let font_content = include_str!("../fonts/pallet.json");
	fonts.insert(Fonts::FontPallet, font_content);

	let font_content = include_str!("../fonts/tiny.json");
	fonts.insert(Fonts::FontTiny, font_content);

	fonts
}

/// Function to get the data of the font chosen
///
/// ```rust
/// extern crate cfonts;
///
/// use cfonts::{ Options, Fonts };
/// use cfonts::font::{load_all_fonts, get};
///
/// let mut options = Options::default();
/// options.font = Fonts::FontChrome;
///
/// let fonts = load_all_fonts();
/// let this_font = get(&fonts, &options);
/// assert_eq!(this_font.name, String::from("chrome"));
/// ```
///
/// Even the `console` font has a file you can request now:
///
/// ```rust
/// extern crate cfonts;
///
/// use cfonts::{ Options, Fonts };
/// use cfonts::font::{load_all_fonts, get};
///
/// let mut options = Options::default();
/// options.font = Fonts::FontConsole;
///
/// let fonts = load_all_fonts();
/// let this_font = get(&fonts, &options);
/// assert_eq!(this_font.chars.get("D").unwrap(), &vec![String::from("d")]);
/// ```
pub fn get(fonts: &HashMap<Fonts, &'static str>, options: &Options) -> Font {
	d("font::get()", 5, Dt::Head, options, &mut std::io::stdout());
	d(&format!("font::get()\noptions.font{:?}", options.font), 5, Dt::Log, options, &mut std::io::stdout());
	let data = fonts.get(&options.font).unwrap();

	serde_json::from_str(data).unwrap_or_else(|error| {
		panic!(
			"JSON parsing error encountered for: \"{}\"\nError: {}",
			color(&format!("{:?}", options.font), Colors::Red),
			color(&format!("{}", error), Colors::Yellow)
		)
	})
}