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
// Copyright 2020 Tibor Schneider
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//! Pango markup language support
//! https://developer.gnome.org/pygtk/stable/pango-markup-language.html
use std::collections::HashMap;
use std::fmt;
/// Structure for writing Pango markup spans
#[derive(Debug, Clone)]
pub struct Pango<'a> {
content: &'a str,
options: HashMap<&'static str, &'a str>,
}
impl<'a> Pango<'a> {
/// Generate a new pango class
///
/// # Usage
///
/// ```
/// use rofi::pango;
/// let t = pango::Pango::new("test").build();
/// assert_eq!(t, "test");
/// ```
pub fn new(content: &'a str) -> Pango<'_> {
Pango {
content,
options: HashMap::new(),
}
}
/// Generate a new pango class with options capacity
///
/// # Usage
///
/// ```
/// use rofi::pango;
/// let t = pango::Pango::with_capacity("test", 0).build();
/// assert_eq!(t, "test");
/// ```
pub fn with_capacity(content: &'a str, size: usize) -> Pango<'_> {
Pango {
content,
options: HashMap::with_capacity(size),
}
}
/// Generate the pango string
///
/// # Usage
///
/// ```
/// use rofi::pango;
/// let t = pango::Pango::new("test")
/// .slant_style(pango::SlantStyle::Italic)
/// .size(pango::FontSize::Small)
/// .build();
/// assert!(t == "<span style='italic' size='small'>test</span>" ||
/// t == "<span size='small' style='italic'>test</span>");
/// ```
pub fn build(&mut self) -> String {
self.to_string()
}
/// Generates a pango string based on the options, but with a different
/// content.
///
/// ```
/// use rofi::pango;
/// let mut p = pango::Pango::new("");
/// p.slant_style(pango::SlantStyle::Italic);
/// p.size(pango::FontSize::Small);
/// let t = p.build_content("test");
/// assert!(t == "<span style='italic' size='small'>test</span>" ||
/// t == "<span size='small' style='italic'>test</span>");
/// ```
pub fn build_content(&self, content: &str) -> String {
self.to_string_with_content(content)
}
/// Set the font
///
/// # Usage
///
/// ```
/// use rofi::pango;
/// let t = pango::Pango::new("test")
/// .font_description("Sans Italic 12")
/// .build();
/// assert_eq!(t, "<span font_desc='Sans Italic 12'>test</span>");
/// ```
pub fn font_description(&mut self, font: &'a str) -> &mut Self {
self.options.insert("font_desc", font);
self
}
/// set the font family
///
/// # Usage
///
/// ```
/// use rofi::pango;
/// let t = pango::Pango::new("test")
/// .font_family(pango::FontFamily::Monospace)
/// .build();
/// assert_eq!(t, "<span face='monospace'>test</span>");
/// ```
pub fn font_family(&mut self, family: FontFamily) -> &mut Self {
self.options.insert(
"face",
match family {
FontFamily::Normal => "normal",
FontFamily::Sans => "sans",
FontFamily::Serif => "serif",
FontFamily::Monospace => "monospace",
},
);
self
}
/// Set the size of the font, relative to the configured font size
///
/// # Usage
///
/// ```
/// use rofi::pango;
/// let t = pango::Pango::new("test")
/// .size(pango::FontSize::Huge)
/// .build();
/// assert_eq!(t, "<span size='x-large'>test</span>");
/// ```
pub fn size(&mut self, size: FontSize) -> &mut Self {
self.options.insert(
"size",
match size {
FontSize::VeryTiny => "xx-small",
FontSize::Tiny => "x-small",
FontSize::Small => "small",
FontSize::Normal => "medium",
FontSize::Large => "large",
FontSize::Huge => "x-large",
FontSize::VeryHuge => "xx-large",
FontSize::Smaller => "smaller",
FontSize::Larger => "larger",
},
);
self
}
/// Set the slant style (italic / oblique / normal)
///
/// # Usage
///
/// ```
/// use rofi::pango;
/// let t = pango::Pango::new("test")
/// .slant_style(pango::SlantStyle::Oblique)
/// .build();
/// assert_eq!(t, "<span style='oblique'>test</span>");
/// ```
pub fn slant_style(&mut self, style: SlantStyle) -> &mut Self {
self.options.insert(
"style",
match style {
SlantStyle::Normal => "normal",
SlantStyle::Oblique => "oblique",
SlantStyle::Italic => "italic",
},
);
self
}
/// Set the font weight
///
/// # Usage
///
/// ```
/// use rofi::pango;
/// let t = pango::Pango::new("test")
/// .weight(pango::Weight::Bold)
/// .build();
/// assert_eq!(t, "<span weight='bold'>test</span>");
/// ```
pub fn weight(&mut self, weight: Weight) -> &mut Self {
self.options.insert(
"weight",
match weight {
Weight::Thin => "100",
Weight::UltraLight => "ultralight",
Weight::Light => "light",
Weight::Normal => "normal",
Weight::Medium => "500",
Weight::SemiBold => "600",
Weight::Bold => "bold",
Weight::UltraBold => "ultrabold",
Weight::Heavy => "heavy",
Weight::UltraHeavy => "1000",
},
);
self
}
/// Set the alpha of the text
/// Important: alpha must be fo the form: XX%, where XX is a number between 0 and 100.
///
/// # Usage
///
/// ```
/// use rofi::pango;
/// let t = pango::Pango::new("test")
/// .alpha("50%")
/// .build();
/// assert_eq!(t, "<span alpha='50%'>test</span>");
/// ```
pub fn alpha(&mut self, alpha: &'a str) -> &mut Self {
self.options.insert("alpha", alpha);
self
}
/// Use smallcaps
///
/// # Usage
///
/// ```
/// use rofi::pango;
/// let t = pango::Pango::new("test")
/// .small_caps()
/// .build();
/// assert_eq!(t, "<span variant='smallcaps'>test</span>");
/// ```
pub fn small_caps(&mut self) -> &mut Self {
self.options.insert("variant", "smallcaps");
self
}
/// Set the stretch (expanded or condensed)
///
/// # Usage
///
/// ```
/// use rofi::pango;
/// let t = pango::Pango::new("test")
/// .stretch(pango::FontStretch::Condensed)
/// .build();
/// assert_eq!(t, "<span stretch='condensed'>test</span>");
/// ```
pub fn stretch(&mut self, stretch: FontStretch) -> &mut Self {
self.options.insert(
"stretch",
match stretch {
FontStretch::UltraCondensed => "ultracondensed",
FontStretch::ExtraCondensed => "extracondensed",
FontStretch::Condensed => "condensed",
FontStretch::SemiCondensed => "semicondensed",
FontStretch::Normal => "normal",
FontStretch::SemiExpanded => "semiexpanded",
FontStretch::Expanded => "expanded",
FontStretch::ExtraExpanded => "extraexpanded",
FontStretch::UltraExpanded => "ultraexpanded",
},
);
self
}
/// Set the foreground color
///
/// # Usage
///
/// ```
/// use rofi::pango;
/// let t = pango::Pango::new("test")
/// .fg_color("#00FF00")
/// .build();
/// assert_eq!(t, "<span foreground='#00FF00'>test</span>");
/// ```
pub fn fg_color(&mut self, color: &'a str) -> &mut Self {
self.options.insert("foreground", color);
self
}
/// Set the background color
///
/// # Usage
///
/// ```
/// use rofi::pango;
/// let t = pango::Pango::new("test")
/// .bg_color("#00FF00")
/// .build();
/// assert_eq!(t, "<span background='#00FF00'>test</span>");
/// ```
pub fn bg_color(&mut self, color: &'a str) -> &mut Self {
self.options.insert("background", color);
self
}
/// Set the underline style
///
/// # Usage
///
/// ```
/// use rofi::pango;
/// let t = pango::Pango::new("test")
/// .underline(pango::Underline::Double)
/// .build();
/// assert_eq!(t, "<span underline='double'>test</span>");
/// ```
pub fn underline(&mut self, underline: Underline) -> &mut Self {
self.options.insert(
"underline",
match underline {
Underline::None => "none",
Underline::Single => "single",
Underline::Double => "double",
Underline::Low => "low",
},
);
self
}
/// set the font to strike through
///
/// # Usage
///
/// ```
/// use rofi::pango;
/// let t = pango::Pango::new("test")
/// .strike_through()
/// .build();
/// assert_eq!(t, "<span strikethrough='true'>test</span>");
/// ```
pub fn strike_through(&mut self) -> &mut Self {
self.options.insert("strikethrough", "true");
self
}
fn to_string_with_content(&self, content: &str) -> String {
if self.options.is_empty() {
content.to_string()
} else {
format!(
"<span {}>{}</span>",
self.options
.iter()
.map(|(k, v)| format!("{}='{}'", k, v))
.collect::<Vec<String>>()
.join(" "),
content
)
}
}
}
/// Enumeration over all available font families
#[derive(Debug, Clone, Copy)]
pub enum FontFamily {
/// Normal font
Normal,
/// Sans Serif font
Sans,
/// Font including serif
Serif,
/// Monospaced font
Monospace,
}
/// Enumeration over all avaliable font sizes
#[derive(Debug, Clone, Copy)]
pub enum FontSize {
/// Very tiny font size, corresponsds to xx-small
VeryTiny,
/// Tiny font size, corresponds to x-small
Tiny,
/// Small font size, corresponds to small
Small,
/// Normal font size (default), corresponds to medium
Normal,
/// Large font size, corresponds to large
Large,
/// Huge font size, corresponds to x-large
Huge,
/// Very huge font size, corresponds to xx-large
VeryHuge,
/// Relative font size, makes content smaller than the parent
Smaller,
/// Relative font size, makes content larger than the parent
Larger,
}
/// Enumeration over all possible slant styles
#[derive(Debug, Clone, Copy)]
pub enum SlantStyle {
/// No slant
Normal,
/// Oblique, normal font skewed
Oblique,
/// Italic font, (different face)
Italic,
}
/// Enumeration over all possible weights
#[derive(Debug, Clone, Copy)]
pub enum Weight {
/// Thin weight (=100)
Thin,
/// Ultralight weight (=200)
UltraLight,
/// Light weight (=300)
Light,
/// Normal weight (=400)
Normal,
/// Medium weight (=500)
Medium,
/// SemiBold weight (=600)
SemiBold,
/// Bold weight (=700)
Bold,
/// Ultrabold weight (=800)
UltraBold,
/// Heavy (=900)
Heavy,
/// UltraHeavy weight (=1000)
UltraHeavy,
}
/// enumeration over all possible font stretch modes
#[derive(Debug, Clone, Copy)]
pub enum FontStretch {
/// UltraCondensed, letters are extremely close together
UltraCondensed,
/// ExtraCondensed, letters are very close together
ExtraCondensed,
/// Condensed, letters are close together
Condensed,
/// SemiCondensed, letters somewhat are close together
SemiCondensed,
/// Normal, normal spacing as defined by the font
Normal,
/// SemiExpanded, letters somewhat are far apart
SemiExpanded,
/// Expanded, letters somewhat far apart
Expanded,
/// ExtraExpanded, letters very far apart
ExtraExpanded,
/// UltraExpanded, letters extremely far apart
UltraExpanded,
}
/// enumeration over all possible underline modes
#[derive(Debug, Clone, Copy)]
pub enum Underline {
/// No underline mode
None,
/// Single, normal underline
Single,
/// Double
Double,
/// Low, only the lower line of double is drawn
Low,
}
impl<'a> fmt::Display for Pango<'a> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
if self.options.is_empty() {
write!(f, "{}", self.content)
} else {
write!(f, "<span")?;
for (k, v) in self.options.iter() {
write!(f, " {}='{}'", k, v)?;
}
write!(f, ">{}</span>", self.content)
}
}
}