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 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628
//! Types for styled strings.
//!
//! A [`StyledString`][] is a [`String`][] with a [`Style`][] annotation. Accordingly, a
//! [`StyledStr`][] is a [`&str`][] with a [`Style`][] annotation, and a [`StyledCow`][] is either
//! a [`Cow<'_, str>`][] with a [`Style`][] annotation.
//!
//! A [`Style`][] is a combination of a [`FontFamily`][], a font size, a line spacing factor, a
//! [`Color`][] and a combination of [`Effect`][]s (bold or italic).
//!
//! # Example
//!
//! ```
//! use rckive_genpdf::style;
//! let style = style::Style::new().bold();
//! let ss1 = style::StyledStr::new("bold", style);
//! let ss2 = style::StyledStr::new("red", style::Color::Rgb(255, 0, 0));
//! ```
//!
//! [`Color`]: enum.Color.html
//! [`Effect`]: enum.Effect.html
//! [`FontFamily`]: ../fonts/struct.FontFamily.html
//! [`Style`]: struct.Style.html
//! [`StyledCow`]: struct.StyledCow.html
//! [`StyledStr`]: struct.StyledStr.html
//! [`StyledString`]: struct.StyledString.html
//! [`String`]: https://doc.rust-lang.org/std/string/struct.String.html
//! [`&str`]: https://doc.rust-lang.org/std/primitive.str.html
//! [`Cow<'_, str>`]: https://doc.rust-lang.org/std/borrow/enum.Cow.html
use std::borrow;
use std::iter;
use crate::fonts;
use crate::Mm;
/// A color, represented by RGB, CMYK or Greyscale values.
///
/// For all variants, the possible values range from 0 to 255.
///
/// # Examples
///
/// ```
/// let red = rckive_genpdf::style::Color::Rgb(255, 0, 0);
/// let cyan = rckive_genpdf::style::Color::Cmyk(255, 0, 0, 0);
/// let grey = rckive_genpdf::style::Color::Greyscale(127);
/// ```
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum Color {
/// An RGB color with red, green and blue values between 0 and 255.
Rgb(u8, u8, u8),
/// An CMYK color with cyan, magenta, yellow and key values between 0 and 255.
Cmyk(u8, u8, u8, u8),
/// A greyscale color with a value between 0 and 255.
Greyscale(u8),
}
impl From<Color> for printpdf::Color {
fn from(color: Color) -> printpdf::Color {
match color {
Color::Rgb(r, g, b) => printpdf::Color::Rgb(printpdf::Rgb::new(
f64::from(r) / 255.0,
f64::from(g) / 255.0,
f64::from(b) / 255.0,
None,
)),
Color::Cmyk(c, m, y, k) => printpdf::Color::Cmyk(printpdf::Cmyk::new(
f64::from(c) / 255.0,
f64::from(m) / 255.0,
f64::from(y) / 255.0,
f64::from(k) / 255.0,
None,
)),
Color::Greyscale(val) => {
printpdf::Color::Greyscale(printpdf::Greyscale::new(f64::from(val) / 255.0, None))
}
}
}
}
/// A text effect (bold or italic).
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum Effect {
/// Bold text.
Bold,
/// Italic text.
Italic,
}
/// A style annotation for a string.
///
/// The annotation consists of:
/// - a font family, see [`FontFamily`][] (defaults to the [`FontCache`][] default)
/// - a font size in points (defaults to 12)
/// - a line spacing factor, with 1 meaning single line spacing (defaults to 1)
/// - an outline color, see [`Color`][] (defaults to black)
/// - a combination of text effects, see [`Effect`][] (defaults to none)
///
/// All properties are optional. If they are not set, they can be inferred from parent styles or
/// from the defaults.
///
/// [`Color`]: enum.Color.html
/// [`Effect`]: enum.Effect.html
/// [`FontFamily`]: ../fonts/struct.FontFamily.html
/// [`FontCache`]: ../fonts/struct.FontCache.html
#[derive(Clone, Copy, Debug, Default, PartialEq)]
pub struct Style {
font_family: Option<fonts::FontFamily<fonts::Font>>,
font_size: Option<u8>,
line_spacing: Option<f64>,
color: Option<Color>,
is_bold: bool,
is_italic: bool,
}
impl Style {
/// Creates a new style without settings.
pub fn new() -> Style {
Style::default()
}
/// Merges the given style into this style.
pub fn merge(&mut self, style: impl Into<Style>) {
let style = style.into();
if let Some(font_family) = style.font_family {
self.font_family = Some(font_family);
};
if let Some(font_size) = style.font_size {
self.font_size = Some(font_size);
}
if let Some(color) = style.color {
self.color = Some(color);
}
if style.is_bold {
self.is_bold = true;
}
if style.is_italic {
self.is_italic = true;
}
}
/// Combines this style and the given style and returns the result.
pub fn and(mut self, style: impl Into<Style>) -> Style {
self.merge(style);
self
}
/// Creates a new style by combining the given styles.
pub fn combine(left: impl Into<Style>, right: impl Into<Style>) -> Style {
left.into().and(right)
}
/// Returns the outline color for this style, if set.
pub fn color(&self) -> Option<Color> {
self.color
}
/// Returns whether the bold text effect is set.
pub fn is_bold(&self) -> bool {
self.is_bold
}
/// Returns whether the italic text effect is set.
pub fn is_italic(&self) -> bool {
self.is_italic
}
/// Returns the font size for this style in points, or 12 if no font size is set.
pub fn font_size(&self) -> u8 {
self.font_size.unwrap_or(12)
}
/// Returns the line spacing factor for this style, or 1 if no line spacing factor is set.
pub fn line_spacing(&self) -> f64 {
self.line_spacing.unwrap_or(1.0)
}
/// Sets the bold effect for this style.
pub fn set_bold(&mut self) {
self.is_bold = true;
}
/// Sets the bold effect for this style and returns it.
pub fn bold(mut self) -> Style {
self.set_bold();
self
}
/// Sets the italic effect for this style.
pub fn set_italic(&mut self) {
self.is_italic = true;
}
/// Sets the italic effect for this style and returns it.
pub fn italic(mut self) -> Style {
self.set_italic();
self
}
/// Sets the font family for this style.
pub fn set_font_family(&mut self, font_family: fonts::FontFamily<fonts::Font>) {
self.font_family = Some(font_family);
}
/// Sets the font family for this style and returns it.
pub fn with_font_family(mut self, font_family: fonts::FontFamily<fonts::Font>) -> Style {
self.set_font_family(font_family);
self
}
/// Sets the line spacing factor for this style.
pub fn set_line_spacing(&mut self, line_spacing: f64) {
self.line_spacing = Some(line_spacing);
}
/// Sets the line spacing factor for this style and returns it.
pub fn with_line_spacing(mut self, line_spacing: f64) -> Style {
self.set_line_spacing(line_spacing);
self
}
/// Sets the font size in points for this style.
pub fn set_font_size(&mut self, font_size: u8) {
self.font_size = Some(font_size);
}
/// Sets the font size in points for this style and returns it.
pub fn with_font_size(mut self, font_size: u8) -> Style {
self.set_font_size(font_size);
self
}
/// Sets the outline color for this style.
pub fn set_color(&mut self, color: Color) {
self.color = Some(color);
}
/// Sets the outline color for this style and returns it.
pub fn with_color(mut self, color: Color) -> Self {
self.set_color(color);
self
}
/// Calculates the width of the given character with this style using the data in the given
/// font cache.
///
/// If the font family is set, it must have been created by the given [`FontCache`][].
///
/// [`FontCache`]: ../fonts/struct.FontCache.html
pub fn char_width(&self, font_cache: &fonts::FontCache, c: char) -> Mm {
self.font(font_cache)
.char_width(font_cache, c, self.font_size())
}
/// Returns the width of the empty space between the origin of the glyph bounding
/// box and the leftmost edge of the character, for this style using the given font cache.
///
/// If the font family is set, it must have been created by the given [`FontCache`][].
///
/// [`FontCache`]: ../fonts/struct.FontCache.html
pub fn char_left_side_bearing(&self, font_cache: &fonts::FontCache, c: char) -> Mm {
self.font(font_cache)
.char_left_side_bearing(font_cache, c, self.font_size())
}
/// Calculates the width of the given string with this style using the data in the given font
/// cache.
///
/// If the font family is set, it must have been created by the given [`FontCache`][].
///
/// [`FontCache`]: ../fonts/struct.FontCache.html
pub fn str_width(&self, font_cache: &fonts::FontCache, s: &str) -> Mm {
let font = self.font(font_cache);
font.str_width(font_cache, s, self.font_size())
}
/// Returns the font family for this style or the default font family using the given font
/// cache.
///
/// If the font family is set, it must have been created by the given [`FontCache`][].
///
/// [`FontCache`]: ../fonts/struct.FontCache.html
pub fn font_family(&self, font_cache: &fonts::FontCache) -> fonts::FontFamily<fonts::Font> {
self.font_family
.unwrap_or_else(|| font_cache.default_font_family())
}
/// Returns the font for this style using the given font cache.
///
/// If the font family is set, it must have been created by the given [`FontCache`][].
///
/// [`FontCache`]: ../fonts/struct.FontCache.html
pub fn font(&self, font_cache: &fonts::FontCache) -> fonts::Font {
self.font_family(font_cache).get(*self)
}
/// Calculates the line height for strings with this style using the data in the given font
/// cache.
///
/// If the font family is set, it must have been created by the given [`FontCache`][].
///
/// [`FontCache`]: ../fonts/struct.FontCache.html
pub fn line_height(&self, font_cache: &fonts::FontCache) -> Mm {
self.font(font_cache).get_line_height(self.font_size()) * self.line_spacing()
}
/// Calculate the metrics of the font for this style using the data in the given font cache.
///
/// If the font family is set, it must have been created by the given [`FontCache`][].
///
/// [`FontCache`]: ../fonts/struct.FontCache.html
pub fn metrics(&self, font_cache: &fonts::FontCache) -> fonts::Metrics {
let mut metrics = self.font(font_cache).metrics(self.font_size());
metrics.line_height *= self.line_spacing();
metrics
}
}
impl From<Color> for Style {
fn from(color: Color) -> Style {
Style::new().with_color(color)
}
}
impl From<Effect> for Style {
fn from(effect: Effect) -> Style {
let style = Style::new();
match effect {
Effect::Bold => style.bold(),
Effect::Italic => style.italic(),
}
}
}
impl From<fonts::FontFamily<fonts::Font>> for Style {
fn from(font_family: fonts::FontFamily<fonts::Font>) -> Style {
Style::new().with_font_family(font_family)
}
}
impl<T: Into<Style>> iter::Extend<T> for Style {
fn extend<I: IntoIterator<Item = T>>(&mut self, iter: I) {
for style in iter {
self.merge(style.into());
}
}
}
impl<T: Into<Style>> iter::FromIterator<T> for Style {
fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Style {
let mut style = Style::new();
style.extend(iter);
style
}
}
/// A [`String`][] with a [`Style`][] annotation.
///
/// # Example
///
/// ```
/// use rckive_genpdf::style;
/// let ss1 = style::StyledString::new("bold".to_owned(), style::Effect::Bold);
/// let ss2 = style::StyledString::new("red".to_owned(), style::Color::Rgb(255, 0, 0));
/// ```
///
/// [`Style`]: struct.Style.html
/// [`String`]: https://doc.rust-lang.org/std/string/struct.String.html
#[derive(Clone, Debug, Default)]
pub struct StyledString {
/// The annotated string.
pub s: String,
/// The style annotation.
pub style: Style,
}
impl StyledString {
/// Creates a new styled string from the given string and style.
pub fn new(s: impl Into<String>, style: impl Into<Style>) -> StyledString {
StyledString {
s: s.into(),
style: style.into(),
}
}
/// Calculates the width of the this string with this style using the data in the given font
/// cache.
///
/// If the font family is set for the style, it must have been created by the given
/// [`FontCache`][].
///
/// [`FontCache`]: ../fonts/struct.FontCache.html
pub fn width(&self, font_cache: &fonts::FontCache) -> Mm {
self.style.str_width(font_cache, &self.s)
}
}
impl From<String> for StyledString {
fn from(s: String) -> StyledString {
StyledString::new(s, Style::new())
}
}
impl<'a> From<&'a String> for StyledString {
fn from(s: &'a String) -> StyledString {
StyledString::from(s.to_owned())
}
}
impl<'a> From<&'a str> for StyledString {
fn from(s: &'a str) -> StyledString {
StyledString::from(s.to_owned())
}
}
/// A [`&str`][] with a [`Style`][] annotation.
///
/// # Example
///
/// ```
/// use rckive_genpdf::style;
/// let ss1 = style::StyledStr::new("bold", style::Effect::Bold);
/// let ss2 = style::StyledStr::new("red", style::Color::Rgb(255, 0, 0));
/// ```
///
/// [`Style`]: struct.Style.html
/// [`&str`]: https://doc.rust-lang.org/std/primitive.str.html
#[derive(Clone, Copy, Debug, Default)]
pub struct StyledStr<'s> {
/// The annotated string.
pub s: &'s str,
/// The style annotation.
pub style: Style,
}
impl<'s> StyledStr<'s> {
/// Creates a new styled string from the given string and style.
pub fn new(s: &'s str, style: impl Into<Style>) -> StyledStr<'s> {
StyledStr {
s,
style: style.into(),
}
}
/// Calculates the width of the this string with this style using the data in the given font
/// cache.
///
/// If the font family is set for the style, it must have been created by the given
/// [`FontCache`][].
///
/// [`FontCache`]: ../fonts/struct.FontCache.html
pub fn width(&self, font_cache: &fonts::FontCache) -> Mm {
self.style.str_width(font_cache, self.s)
}
}
impl<'s> From<&'s str> for StyledStr<'s> {
fn from(s: &'s str) -> StyledStr<'s> {
StyledStr::new(s, Style::new())
}
}
impl<'s> From<&'s String> for StyledStr<'s> {
fn from(s: &'s String) -> StyledStr<'s> {
StyledStr::new(s, Style::new())
}
}
impl<'s> From<&'s StyledString> for StyledStr<'s> {
fn from(s: &'s StyledString) -> StyledStr<'s> {
StyledStr::new(&s.s, s.style)
}
}
/// A [`Cow<'s, str>`][] with a [`Style`][] annotation.
///
/// # Example
///
/// ```
/// use rckive_genpdf::style;
/// let ss1 = style::StyledCow::new("bold", style::Effect::Bold);
/// let ss2 = style::StyledCow::new("red".to_owned(), style::Color::Rgb(255, 0, 0));
/// ```
///
/// [`Style`]: struct.Style.html
/// [`Cow<'s, str>`]: https://doc.rust-lang.org/std/borrow/enum.Cow.html
#[derive(Clone, Debug, Default)]
pub struct StyledCow<'s> {
/// The annotated string.
pub s: borrow::Cow<'s, str>,
/// The style annotation.
pub style: Style,
}
impl<'s> StyledCow<'s> {
/// Creates a new styled string from the given string and style.
pub fn new(s: impl Into<borrow::Cow<'s, str>>, style: impl Into<Style>) -> StyledCow<'s> {
StyledCow {
s: s.into(),
style: style.into(),
}
}
/// Calculates the width of the this string with this style using the data in the given font
/// cache.
///
/// If the font family is set for the style, it must have been created by the given
/// [`FontCache`][].
///
/// [`FontCache`]: ../fonts/struct.FontCache.html
pub fn width(&self, font_cache: &fonts::FontCache) -> Mm {
self.style.str_width(font_cache, self.s.as_ref())
}
}
impl<'s> From<&'s str> for StyledCow<'s> {
fn from(s: &'s str) -> StyledCow<'s> {
StyledCow::new(s, Style::new())
}
}
impl<'s> From<&'s String> for StyledCow<'s> {
fn from(s: &'s String) -> StyledCow<'s> {
StyledCow::new(s, Style::new())
}
}
impl<'s> From<String> for StyledCow<'s> {
fn from(s: String) -> StyledCow<'s> {
StyledCow::new(s, Style::new())
}
}
impl<'s> From<StyledStr<'s>> for StyledCow<'s> {
fn from(s: StyledStr<'s>) -> StyledCow<'s> {
StyledCow::new(s.s, s.style)
}
}
impl<'s> From<&'s StyledString> for StyledCow<'s> {
fn from(s: &'s StyledString) -> StyledCow<'s> {
StyledCow::new(&s.s, s.style)
}
}
impl<'s> From<StyledString> for StyledCow<'s> {
fn from(s: StyledString) -> StyledCow<'s> {
StyledCow::new(s.s, s.style)
}
}
/// A style for a line, used in styling borders and shapes.
///
/// The style consists of:
/// - the line thickness in millimeters (defaults to 0.1)
/// - the color of the line, see [`Color`][] (defaults to black)
///
/// Note that a line thickness of 0.0 does not make the line disappear, but rather makes it appear
/// 1px wide across all devices and resolutions.
///
/// [`Color`]: enum.Color.html
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct LineStyle {
thickness: Mm,
color: Color,
}
impl Default for LineStyle {
fn default() -> LineStyle {
LineStyle {
thickness: Mm::from(0.1),
color: Color::Rgb(0, 0, 0),
}
}
}
impl From<Color> for LineStyle {
fn from(color: Color) -> LineStyle {
LineStyle {
color,
..LineStyle::default()
}
}
}
impl LineStyle {
/// Creates a new line style with default values.
pub fn new() -> LineStyle {
LineStyle::default()
}
/// Sets the line thickness.
///
/// Setting this to 0.0 will not hide the line, rather it’s a special value that tells PDF
/// viewers to render the line as 1px regardless of the display size and zoom.
pub fn set_thickness(&mut self, thickness: impl Into<Mm>) {
self.thickness = thickness.into();
}
/// Sets the line thickness and returns the line style.
///
/// Setting this to 0.0 will not hide the line, rather it’s a special value that tells PDF
/// viewers to render the line as 1px regardless of the display size and zoom.
pub fn with_thickness(mut self, thickness: impl Into<Mm>) -> Self {
self.set_thickness(thickness);
self
}
/// Returns the line thickness.
pub fn thickness(&self) -> Mm {
self.thickness
}
/// Sets the line color.
pub fn set_color(&mut self, color: Color) {
self.color = color;
}
/// Sets the line color and returns the line style.
pub fn with_color(mut self, color: Color) -> Self {
self.set_color(color);
self
}
/// Returns the line color.
pub fn color(&self) -> Color {
self.color
}
}