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 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036
//! Defines the [PdfFont] struct, exposing functionality related to a single font used to
//! render text in a `PdfDocument`.
use crate::bindgen::{FPDF_FONT, FPDF_FONT_TRUETYPE, FPDF_FONT_TYPE1};
use crate::bindings::PdfiumLibraryBindings;
use crate::document::PdfDocument;
use crate::error::{PdfiumError, PdfiumInternalError};
use crate::font_glyphs::PdfFontGlyphs;
use crate::points::PdfPoints;
use crate::prelude::PdfFontBuiltin;
use crate::utils::mem::create_byte_buffer;
use bitflags::bitflags;
use std::io::Read;
use std::os::raw::{c_char, c_int, c_uint};
#[cfg(not(target_arch = "wasm32"))]
use std::fs::File;
#[cfg(not(target_arch = "wasm32"))]
use std::path::Path;
#[cfg(target_arch = "wasm32")]
use wasm_bindgen::JsCast;
#[cfg(target_arch = "wasm32")]
use wasm_bindgen_futures::JsFuture;
#[cfg(target_arch = "wasm32")]
use js_sys::{ArrayBuffer, Uint8Array};
#[cfg(target_arch = "wasm32")]
use web_sys::{window, Blob, Response};
// The following dummy declaration is used only when running cargo doc.
// It allows documentation of WASM-specific functionality to be included
// in documentation generated on non-WASM targets.
#[cfg(doc)]
struct Blob;
bitflags! {
pub(crate) struct FpdfFontDescriptorFlags: u32 {
const FIXED_PITCH_BIT_1 = 0b00000000000000000000000000000001;
const SERIF_BIT_2 = 0b00000000000000000000000000000010;
const SYMBOLIC_BIT_3 = 0b00000000000000000000000000000100;
const SCRIPT_BIT_4 = 0b00000000000000000000000000001000;
const NON_SYMBOLIC_BIT_6 = 0b00000000000000000000000000100000;
const ITALIC_BIT_7 = 0b00000000000000000000000001000000;
const ALL_CAP_BIT_17 = 0b00000000000000010000000000000000;
const SMALL_CAP_BIT_18 = 0b00000000000000100000000000000000;
const FORCE_BOLD_BIT_19 = 0b00000000000001000000000000000000;
}
}
/// The weight of a [PdfFont]. Typical values are 400 (normal) and 700 (bold).
#[derive(Copy, Clone, Debug, PartialEq)]
pub enum PdfFontWeight {
Weight100,
Weight200,
Weight300,
Weight400Normal,
Weight500,
Weight600,
Weight700Bold,
Weight800,
Weight900,
/// Any font weight value that falls outside the typical 100 - 900 value range.
Custom(u32),
}
impl PdfFontWeight {
pub(crate) fn from_pdfium(value: c_int) -> Option<PdfFontWeight> {
match value {
-1 => None,
100 => Some(PdfFontWeight::Weight100),
200 => Some(PdfFontWeight::Weight200),
300 => Some(PdfFontWeight::Weight300),
400 => Some(PdfFontWeight::Weight400Normal),
500 => Some(PdfFontWeight::Weight500),
600 => Some(PdfFontWeight::Weight600),
700 => Some(PdfFontWeight::Weight700Bold),
800 => Some(PdfFontWeight::Weight800),
900 => Some(PdfFontWeight::Weight900),
other => Some(PdfFontWeight::Custom(other as u32)),
}
}
}
/// A single font used to render text in a [PdfDocument].
///
/// The PDF specification defines 14 built-in fonts that can be used in any PDF file without
/// font embedding. Additionally, custom fonts can be directly embedded into any PDF file as
/// a data stream.
pub struct PdfFont<'a> {
built_in: Option<PdfFontBuiltin>,
handle: FPDF_FONT,
bindings: &'a dyn PdfiumLibraryBindings,
glyphs: PdfFontGlyphs<'a>,
is_font_memory_loaded: bool,
}
impl<'a> PdfFont<'a> {
#[inline]
pub(crate) fn from_pdfium(
handle: FPDF_FONT,
bindings: &'a dyn PdfiumLibraryBindings,
built_in: Option<PdfFontBuiltin>,
is_font_memory_loaded: bool,
) -> Self {
PdfFont {
built_in,
handle,
bindings,
glyphs: PdfFontGlyphs::from_pdfium(handle, bindings),
is_font_memory_loaded,
}
}
/// Creates a new [PdfFont] from the given given built-in font argument.
///
/// This function is now deprecated and will be removed in release 0.9.0.
/// Use the `PdfFonts::new_built_in()` function instead.
#[deprecated(
since = "0.8.1",
note = "This function has been moved. Use the PdfFonts::new_built_in() function instead."
)]
#[doc(hidden)]
#[inline]
pub fn new_built_in(document: &'a PdfDocument<'a>, font: PdfFontBuiltin) -> PdfFont<'a> {
Self::from_pdfium(
document
.bindings()
.FPDFText_LoadStandardFont(document.handle(), font.to_pdf_font_name()),
document.bindings(),
Some(font),
true,
)
}
/// Creates a new [PdfFont] for the built-in "Times-Roman" font.
///
/// This function is now deprecated and will be removed in release 0.9.0.
/// Use the `PdfFonts::times_roman()` function instead.
#[deprecated(
since = "0.8.1",
note = "This function has been moved. Use the PdfFonts::times_roman() function instead."
)]
#[doc(hidden)]
#[inline]
pub fn times_roman(document: &'a PdfDocument<'a>) -> PdfFont<'a> {
#[allow(deprecated)]
Self::new_built_in(document, PdfFontBuiltin::TimesRoman)
}
/// Creates a new [PdfFont] for the built-in "Times-Bold" font.
///
/// This function is now deprecated and will be removed in release 0.9.0.
/// Use the `PdfFonts::times_bold()` function instead.
#[deprecated(
since = "0.8.1",
note = "This function has been moved. Use the PdfFonts::times_bold() function instead."
)]
#[doc(hidden)]
#[inline]
pub fn times_bold(document: &'a PdfDocument<'a>) -> PdfFont<'a> {
#[allow(deprecated)]
Self::new_built_in(document, PdfFontBuiltin::TimesBold)
}
/// Creates a new [PdfFont] for the built-in "Times-Italic" font.
///
/// This function is now deprecated and will be removed in release 0.9.0.
/// Use the `PdfFonts::times_italic()` function instead.
#[deprecated(
since = "0.8.1",
note = "This function has been moved. Use the PdfFonts::times_italic() function instead."
)]
#[doc(hidden)]
#[inline]
pub fn times_italic(document: &'a PdfDocument<'a>) -> PdfFont<'a> {
#[allow(deprecated)]
Self::new_built_in(document, PdfFontBuiltin::TimesItalic)
}
/// Creates a new [PdfFont] for the built-in "Times-BoldItalic" font.
///
/// This function is now deprecated and will be removed in release 0.9.0.
/// Use the `PdfFonts::times_bold_italic()` function instead.
#[deprecated(
since = "0.8.1",
note = "This function has been moved. Use the PdfFonts::times_bold_italic() function instead."
)]
#[doc(hidden)]
#[inline]
pub fn times_bold_italic(document: &'a PdfDocument<'a>) -> PdfFont<'a> {
#[allow(deprecated)]
Self::new_built_in(document, PdfFontBuiltin::TimesBoldItalic)
}
/// Creates a new [PdfFont] for the built-in "Helvetica" font.
///
/// This function is now deprecated and will be removed in release 0.9.0.
/// Use the `PdfFonts::helvetica()` function instead.
#[deprecated(
since = "0.8.1",
note = "This function has been moved. Use the PdfFonts::helvetica() function instead."
)]
#[doc(hidden)]
#[inline]
pub fn helvetica(document: &'a PdfDocument<'a>) -> PdfFont<'a> {
#[allow(deprecated)]
Self::new_built_in(document, PdfFontBuiltin::Helvetica)
}
/// Creates a new [PdfFont] for the built-in "Helvetica-Bold" font.
///
/// This function is now deprecated and will be removed in release 0.9.0.
/// Use the `PdfFonts::helvetica_bold()` function instead.
#[deprecated(
since = "0.8.1",
note = "This function has been moved. Use the PdfFonts::helvetica_bold() function instead."
)]
#[doc(hidden)]
#[inline]
pub fn helvetica_bold(document: &'a PdfDocument<'a>) -> PdfFont<'a> {
#[allow(deprecated)]
Self::new_built_in(document, PdfFontBuiltin::HelveticaBold)
}
/// Creates a new [PdfFont] for the built-in "Helvetica-Oblique" font.
///
/// This function is now deprecated and will be removed in release 0.9.0.
/// Use the `PdfFonts::helvetica_oblique()` function instead.
#[deprecated(
since = "0.8.1",
note = "This function has been moved. Use the PdfFonts::helvetica_oblique() function instead."
)]
#[doc(hidden)]
#[inline]
pub fn helvetica_oblique(document: &'a PdfDocument<'a>) -> PdfFont<'a> {
#[allow(deprecated)]
Self::new_built_in(document, PdfFontBuiltin::HelveticaOblique)
}
/// Creates a new [PdfFont] for the built-in "Helvetica-BoldOblique" font.
///
/// This function is now deprecated and will be removed in release 0.9.0.
/// Use the `PdfFonts::helvetica_bold_oblique()` function instead.
#[deprecated(
since = "0.8.1",
note = "This function has been moved. Use the PdfFonts::helvetica_bold_oblique() function instead."
)]
#[doc(hidden)]
#[inline]
pub fn helvetica_bold_oblique(document: &'a PdfDocument<'a>) -> PdfFont<'a> {
#[allow(deprecated)]
Self::new_built_in(document, PdfFontBuiltin::HelveticaBoldOblique)
}
/// Creates a new [PdfFont] for the built-in "Courier" font.
///
/// This function is now deprecated and will be removed in release 0.9.0.
/// Use the `PdfFonts::courier()` function instead.
#[deprecated(
since = "0.8.1",
note = "This function has been moved. Use the PdfFonts::courier() function instead."
)]
#[doc(hidden)]
#[inline]
pub fn courier(document: &'a PdfDocument<'a>) -> PdfFont<'a> {
#[allow(deprecated)]
Self::new_built_in(document, PdfFontBuiltin::Courier)
}
/// Creates a new [PdfFont] for the built-in "Courier-Bold" font.
///
/// This function is now deprecated and will be removed in release 0.9.0.
/// Use the `PdfFonts::courier_bold()` function instead.
#[deprecated(
since = "0.8.1",
note = "This function has been moved. Use the PdfFonts::courier_bold() function instead."
)]
#[doc(hidden)]
#[inline]
pub fn courier_bold(document: &'a PdfDocument<'a>) -> PdfFont<'a> {
#[allow(deprecated)]
Self::new_built_in(document, PdfFontBuiltin::CourierBold)
}
/// Creates a new [PdfFont] for the built-in "Courier-Oblique" font.
///
/// This function is now deprecated and will be removed in release 0.9.0.
/// Use the `PdfFonts::courier_oblique()` function instead.
#[deprecated(
since = "0.8.1",
note = "This function has been moved. Use the PdfFonts::courier_oblique() function instead."
)]
#[doc(hidden)]
#[inline]
pub fn courier_oblique(document: &'a PdfDocument<'a>) -> PdfFont<'a> {
#[allow(deprecated)]
Self::new_built_in(document, PdfFontBuiltin::CourierOblique)
}
/// Creates a new [PdfFont] for the built-in "Courier-BoldOblique" font.
///
/// This function is now deprecated and will be removed in release 0.9.0.
/// Use the `PdfFonts::courier_bold_oblique()` function instead.
#[deprecated(
since = "0.8.1",
note = "This function has been moved. Use the PdfFonts::courier_bold_oblique() function instead."
)]
#[doc(hidden)]
#[inline]
pub fn courier_bold_oblique(document: &'a PdfDocument<'a>) -> PdfFont<'a> {
#[allow(deprecated)]
Self::new_built_in(document, PdfFontBuiltin::CourierBoldOblique)
}
/// Creates a new [PdfFont] for the built-in "Symbol" font.
///
/// This function is now deprecated and will be removed in release 0.9.0.
/// Use the `PdfFonts::symbol()` function instead.
#[deprecated(
since = "0.8.1",
note = "This function has been moved. Use the PdfFonts::symbol() function instead."
)]
#[doc(hidden)]
#[inline]
pub fn symbol(document: &'a PdfDocument<'a>) -> PdfFont<'a> {
#[allow(deprecated)]
Self::new_built_in(document, PdfFontBuiltin::Symbol)
}
/// Creates a new [PdfFont] for the built-in "ZapfDingbats" font.
///
/// This function is now deprecated and will be removed in release 0.9.0.
/// Use the `PdfFonts::zapf_dingbats()` function instead.
#[deprecated(
since = "0.8.1",
note = "This function has been moved. Use the PdfFonts::zapf_dingbats() function instead."
)]
#[doc(hidden)]
#[inline]
pub fn zapf_dingbats(document: &'a PdfDocument<'a>) -> PdfFont<'a> {
#[allow(deprecated)]
Self::new_built_in(document, PdfFontBuiltin::ZapfDingbats)
}
/// Attempts to load a Type 1 font file from the given file path.
///
/// Set the `is_cid_font` parameter to `true` if the given font is keyed by
/// 16-bit character ID (CID), indicating that it supports an extended glyphset of
/// 65,535 glyphs. This is typically the case with fonts that support Asian character sets
/// or right-to-left languages.
///
/// This function is not available when compiling to WASM. You have several options for
/// loading font data in WASM:
/// * Use the [PdfFont::load_type1_from_fetch()] function to download font data from a
/// URL using the browser's built-in `fetch()` API. This function is only available when
/// compiling to WASM.
/// * Use the [PdfFont::load_type1_from_blob()] function to load font data from a
/// Javascript File or Blob object (such as a File object returned from an HTML
/// `<input type="file">` element). This function is only available when compiling to WASM.
/// * Use the [PdfFont::load_type1_from_reader()] function to load font data from any
/// valid Rust reader.
/// * Use another method to retrieve the bytes of the target font over the network,
/// then load those bytes into Pdfium using the [PdfFont::new_type1_from_bytes()] function.
/// * Embed the bytes of the desired font directly into the compiled WASM module
/// using the `include_bytes!()` macro.
///
/// This function is now deprecated and will be removed in release 0.9.0.
/// Use the `PdfFonts::load_type1_from_file()` function instead.
#[deprecated(
since = "0.8.1",
note = "This function has been moved. Use the PdfFonts::load_type1_from_file() function instead."
)]
#[doc(hidden)]
#[cfg(not(target_arch = "wasm32"))]
pub fn load_type1_from_file(
document: &'a PdfDocument<'a>,
path: &(impl AsRef<Path> + ?Sized),
is_cid_font: bool,
) -> Result<PdfFont<'a>, PdfiumError> {
#[allow(deprecated)]
Self::load_type1_from_reader(
document,
File::open(path).map_err(PdfiumError::IoError)?,
is_cid_font,
)
}
/// Attempts to load a Type 1 font file from the given reader.
///
/// Set the `is_cid_font` parameter to `true` if the given font is keyed by
/// 16-bit character ID (CID), indicating that it supports an extended glyphset of
/// 65,535 glyphs. This is typically the case with fonts that support Asian character sets
/// or right-to-left languages.
///
/// This function is now deprecated and will be removed in release 0.9.0.
/// Use the `PdfFonts::load_type1_from_reader()` function instead.
#[deprecated(
since = "0.8.1",
note = "This function has been moved. Use the PdfFonts::load_type1_from_reader() function instead."
)]
#[doc(hidden)]
pub fn load_type1_from_reader(
document: &'a PdfDocument<'a>,
mut reader: impl Read,
is_cid_font: bool,
) -> Result<PdfFont<'a>, PdfiumError> {
let mut bytes = Vec::new();
reader
.read_to_end(&mut bytes)
.map_err(PdfiumError::IoError)?;
#[allow(deprecated)]
Self::new_type1_from_bytes(document, bytes.as_slice(), is_cid_font)
}
/// Attempts to load a Type 1 font file from the given URL.
/// The Javascript `fetch()` API is used to download data over the network.
///
/// Set the `is_cid_font` parameter to `true` if the given font is keyed by
/// 16-bit character ID (CID), indicating that it supports an extended glyphset of
/// 65,535 glyphs. This is typically the case with fonts that support Asian character sets
/// or right-to-left languages.
///
/// This function is only available when compiling to WASM.
///
/// This function is now deprecated and will be removed in release 0.9.0.
/// Use the `PdfFonts::load_type1_from_fetch()` function instead.
#[deprecated(
since = "0.8.1",
note = "This function has been moved. Use the PdfFonts::load_type1_from_fetch() function instead."
)]
#[doc(hidden)]
#[cfg(any(doc, target_arch = "wasm32"))]
pub async fn load_type1_from_fetch(
document: &'a PdfDocument<'a>,
url: impl ToString,
is_cid_font: bool,
) -> Result<PdfFont<'a>, PdfiumError> {
if let Some(window) = window() {
let fetch_result = JsFuture::from(window.fetch_with_str(url.to_string().as_str()))
.await
.map_err(PdfiumError::WebSysFetchError)?;
debug_assert!(fetch_result.is_instance_of::<Response>());
let response: Response = fetch_result
.dyn_into()
.map_err(|_| PdfiumError::WebSysInvalidResponseError)?;
let blob: Blob =
JsFuture::from(response.blob().map_err(PdfiumError::WebSysFetchError)?)
.await
.map_err(PdfiumError::WebSysFetchError)?
.into();
#[allow(deprecated)]
Self::load_type1_from_blob(document, blob, is_cid_font).await
} else {
Err(PdfiumError::WebSysWindowObjectNotAvailable)
}
}
/// Attempts to load a Type 1 font from the given Blob.
/// A File object returned from a FileList is a suitable Blob:
///
/// ```text
/// <input id="filePicker" type="file">
///
/// const file = document.getElementById('filePicker').files[0];
/// ```
///
/// Set the `is_cid_font` parameter to `true` if the given font is keyed by
/// 16-bit character ID (CID), indicating that it supports an extended glyphset of
/// 65,535 glyphs. This is typically the case with fonts that support Asian character sets
/// or right-to-left languages.
///
/// This function is only available when compiling to WASM.
///
/// This function is now deprecated and will be removed in release 0.9.0.
/// Use the `PdfFonts::load_type1_from_blob()` function instead.
#[deprecated(
since = "0.8.1",
note = "This function has been moved. Use the PdfFonts::load_type1_from_blob() function instead."
)]
#[doc(hidden)]
#[cfg(any(doc, target_arch = "wasm32"))]
pub async fn load_type1_from_blob(
document: &'a PdfDocument<'a>,
blob: Blob,
is_cid_font: bool,
) -> Result<PdfFont<'a>, PdfiumError> {
let array_buffer: ArrayBuffer = JsFuture::from(blob.array_buffer())
.await
.map_err(PdfiumError::WebSysFetchError)?
.into();
let u8_array: Uint8Array = Uint8Array::new(&array_buffer);
let bytes: Vec<u8> = u8_array.to_vec();
#[allow(deprecated)]
Self::new_type1_from_bytes(document, bytes.as_slice(), is_cid_font)
}
/// Attempts to load the given byte data as a Type 1 font file.
///
/// Set the `is_cid_font` parameter to `true` if the given font is keyed by
/// 16-bit character ID (CID), indicating that it supports an extended glyphset of
/// 65,535 glyphs. This is typically the case with fonts that support Asian character sets
/// or right-to-left languages.
///
/// This function is now deprecated and will be removed in release 0.9.0.
/// Use the `PdfFonts::load_type1_from_bytes()` function instead.
#[deprecated(
since = "0.8.1",
note = "This function has been moved. Use the PdfFonts::load_type1_from_bytes() function instead."
)]
#[doc(hidden)]
pub fn new_type1_from_bytes(
document: &'a PdfDocument<'a>,
font_data: &[u8],
is_cid_font: bool,
) -> Result<PdfFont<'a>, PdfiumError> {
Self::new_font_from_bytes(document, font_data, FPDF_FONT_TYPE1, is_cid_font)
}
/// Attempts to load a TrueType font file from the given file path.
///
/// Set the `is_cid_font` parameter to `true` if the given font is keyed by
/// 16-bit character ID (CID), indicating that it supports an extended glyphset of
/// 65,535 glyphs. This is typically the case with fonts that support Asian character sets
/// or right-to-left languages.
///
/// This function is not available when compiling to WASM. You have several options for
/// loading font data in WASM:
/// * Use the [PdfFont::load_true_type_from_fetch()] function to download font data from a
/// URL using the browser's built-in `fetch()` API. This function is only available when
/// compiling to WASM.
/// * Use the [PdfFont::load_true_type_from_blob()] function to load font data from a
/// Javascript `File` or `Blob` object (such as a `File` object returned from an HTML
/// `<input type="file">` element). This function is only available when compiling to WASM.
/// * Use the [PdfFont::load_true_type_from_reader()] function to load font data from any
/// valid Rust reader.
/// * Use another method to retrieve the bytes of the target font over the network,
/// then load those bytes into Pdfium using the [PdfFont::new_true_type_from_bytes()] function.
/// * Embed the bytes of the desired font directly into the compiled WASM module
/// using the `include_bytes!()` macro.
///
/// This function is now deprecated and will be removed in release 0.9.0.
/// Use the `PdfFonts::load_true_type_from_file()` function instead.
#[deprecated(
since = "0.8.1",
note = "This function has been moved. Use the PdfFonts::load_true_type_from_file() function instead."
)]
#[doc(hidden)]
#[cfg(not(target_arch = "wasm32"))]
pub fn load_true_type_from_file(
document: &'a PdfDocument<'a>,
path: &(impl AsRef<Path> + ?Sized),
is_cid_font: bool,
) -> Result<PdfFont<'a>, PdfiumError> {
#[allow(deprecated)]
Self::load_true_type_from_reader(
document,
File::open(path).map_err(PdfiumError::IoError)?,
is_cid_font,
)
}
/// Attempts to load a TrueType font file from the given reader.
///
/// Set the `is_cid_font` parameter to `true` if the given font is keyed by
/// 16-bit character ID (CID), indicating that it supports an extended glyphset of
/// 65,535 glyphs. This is typically the case with fonts that support Asian character sets
/// or right-to-left languages.
///
/// This function is now deprecated and will be removed in release 0.9.0.
/// Use the `PdfFonts::load_true_type_from_reader()` function instead.
#[deprecated(
since = "0.8.1",
note = "This function has been moved. Use the PdfFonts::load_true_type_from_reader() function instead."
)]
#[doc(hidden)]
pub fn load_true_type_from_reader(
document: &'a PdfDocument<'a>,
mut reader: impl Read,
is_cid_font: bool,
) -> Result<PdfFont<'a>, PdfiumError> {
let mut bytes = Vec::new();
reader
.read_to_end(&mut bytes)
.map_err(PdfiumError::IoError)?;
#[allow(deprecated)]
Self::new_true_type_from_bytes(document, bytes.as_slice(), is_cid_font)
}
/// Attempts to load a TrueType font file from the given URL.
/// The Javascript `fetch()` API is used to download data over the network.
///
/// Set the `is_cid_font` parameter to `true` if the given font is keyed by
/// 16-bit character ID (CID), indicating that it supports an extended glyphset of
/// 65,535 glyphs. This is typically the case with fonts that support Asian character sets
/// or right-to-left languages.
///
/// This function is only available when compiling to WASM.
///
/// This function is now deprecated and will be removed in release 0.9.0.
/// Use the `PdfFonts::load_true_type_from_fetch()` function instead.
#[deprecated(
since = "0.8.1",
note = "This function has been moved. Use the PdfFonts::load_true_type_from_fetch() function instead."
)]
#[doc(hidden)]
#[cfg(any(doc, target_arch = "wasm32"))]
pub async fn load_true_type_from_fetch(
document: &'a PdfDocument<'a>,
url: impl ToString,
is_cid_font: bool,
) -> Result<PdfFont<'a>, PdfiumError> {
if let Some(window) = window() {
let fetch_result = JsFuture::from(window.fetch_with_str(url.to_string().as_str()))
.await
.map_err(PdfiumError::WebSysFetchError)?;
debug_assert!(fetch_result.is_instance_of::<Response>());
let response: Response = fetch_result
.dyn_into()
.map_err(|_| PdfiumError::WebSysInvalidResponseError)?;
let blob: Blob =
JsFuture::from(response.blob().map_err(PdfiumError::WebSysFetchError)?)
.await
.map_err(PdfiumError::WebSysFetchError)?
.into();
#[allow(deprecated)]
Self::load_true_type_from_blob(document, blob, is_cid_font).await
} else {
Err(PdfiumError::WebSysWindowObjectNotAvailable)
}
}
/// Attempts to load a TrueType font from the given `Blob`.
/// A `File` object returned from a `FileList` is a suitable `Blob`:
///
/// ```text
/// <input id="filePicker" type="file">
///
/// const file = document.getElementById('filePicker').files[0];
/// ```
///
/// Set the `is_cid_font` parameter to `true` if the given font is keyed by
/// 16-bit character ID (CID), indicating that it supports an extended glyphset of
/// 65,535 glyphs. This is typically the case with fonts that support Asian character sets
/// or right-to-left languages.
///
/// This function is only available when compiling to WASM.
///
/// This function is now deprecated and will be removed in release 0.9.0.
/// Use the `PdfFonts::load_true_type_from_blob()` function instead.
#[deprecated(
since = "0.8.1",
note = "This function has been moved. Use the PdfFonts::load_true_type_from_blob() function instead."
)]
#[doc(hidden)]
#[cfg(any(doc, target_arch = "wasm32"))]
pub async fn load_true_type_from_blob(
document: &'a PdfDocument<'a>,
blob: Blob,
is_cid_font: bool,
) -> Result<PdfFont<'a>, PdfiumError> {
let array_buffer: ArrayBuffer = JsFuture::from(blob.array_buffer())
.await
.map_err(PdfiumError::WebSysFetchError)?
.into();
let u8_array: Uint8Array = Uint8Array::new(&array_buffer);
let bytes: Vec<u8> = u8_array.to_vec();
#[allow(deprecated)]
Self::new_true_type_from_bytes(document, bytes.as_slice(), is_cid_font)
}
/// Attempts to load the given byte data as a TrueType font file.
///
/// Set the `is_cid_font` parameter to `true` if the given font is keyed by
/// 16-bit character ID (CID), indicating that it supports an extended glyphset of
/// 65,535 glyphs. This is typically the case with fonts that support Asian character sets
/// or right-to-left languages.
///
/// This function is now deprecated and will be removed in release 0.9.0.
/// Use the `PdfFonts::load_true_type_from_bytes()` function instead.
#[deprecated(
since = "0.8.1",
note = "This function has been moved. Use the PdfFonts::load_true_type_from_bytes() function instead."
)]
#[doc(hidden)]
pub fn new_true_type_from_bytes(
document: &'a PdfDocument<'a>,
font_data: &[u8],
is_cid_font: bool,
) -> Result<PdfFont<'a>, PdfiumError> {
Self::new_font_from_bytes(document, font_data, FPDF_FONT_TRUETYPE, is_cid_font)
}
#[inline]
pub(crate) fn new_font_from_bytes(
document: &'a PdfDocument<'a>,
font_data: &[u8],
font_type: c_uint,
is_cid_font: bool,
) -> Result<PdfFont<'a>, PdfiumError> {
let handle = document.bindings().FPDFText_LoadFont(
document.handle(),
font_data.as_ptr(),
font_data.len() as c_uint,
font_type as c_int,
document.bindings().bool_to_pdfium(is_cid_font),
);
if handle.is_null() {
Err(PdfiumError::PdfiumLibraryInternalError(
PdfiumInternalError::Unknown,
))
} else {
Ok(PdfFont::from_pdfium(
handle,
document.bindings(),
None,
true,
))
}
}
/// Returns the internal `FPDF_FONT` handle for this [PdfFont].
#[inline]
pub(crate) fn handle(&self) -> FPDF_FONT {
self.handle
}
/// Returns the [PdfiumLibraryBindings] used by this [PdfFont].
#[inline]
pub fn bindings(&self) -> &'a dyn PdfiumLibraryBindings {
self.bindings
}
/// Returns the name of this [PdfFont].
pub fn name(&self) -> String {
// Retrieving the font name from Pdfium is a two-step operation. First, we call
// FPDFFont_GetFontName() with a null buffer; this will retrieve the length of
// the font name in bytes. If the length is zero, then there is no font name.
// If the length is non-zero, then we reserve a byte buffer of the given
// length and call FPDFFont_GetFontName() again with a pointer to the buffer;
// this will write the font name into the buffer. Unlike most text handling in
// Pdfium, font names are returned in UTF-8 format.
let buffer_length =
self.bindings
.FPDFFont_GetFontName(self.handle, std::ptr::null_mut(), 0);
if buffer_length == 0 {
// The font name is not present.
return String::new();
}
let mut buffer = create_byte_buffer(buffer_length as usize);
let result = self.bindings.FPDFFont_GetFontName(
self.handle,
buffer.as_mut_ptr() as *mut c_char,
buffer_length,
);
assert_eq!(result, buffer_length);
String::from_utf8(buffer)
// Trim any trailing nulls. All strings returned from Pdfium are generally terminated
// by one null byte.
.map(|str| str.trim_end_matches(char::from(0)).to_owned())
.unwrap_or_else(|_| String::new())
}
/// Returns the weight of this [PdfFont].
///
/// Pdfium may not reliably return the correct value of this property for built-in fonts.
pub fn weight(&self) -> Result<PdfFontWeight, PdfiumError> {
PdfFontWeight::from_pdfium(self.bindings.FPDFFont_GetWeight(self.handle)).ok_or(
PdfiumError::PdfiumLibraryInternalError(PdfiumInternalError::Unknown),
)
}
/// Returns the italic angle of this [PdfFont]. The italic angle is the angle,
/// expressed in degrees counter-clockwise from the vertical, of the dominant vertical
/// strokes of the font. The value is zero for non-italic fonts, and negative for fonts
/// that slope to the right (as almost all italic fonts do).
///
/// Pdfium may not reliably return the correct value of this property for built-in fonts.
pub fn italic_angle(&self) -> Result<i32, PdfiumError> {
let mut angle = 0;
if self.bindings.is_true(
self.bindings
.FPDFFont_GetItalicAngle(self.handle, &mut angle),
) {
Ok(angle)
} else {
Err(PdfiumError::PdfiumLibraryInternalError(
PdfiumInternalError::Unknown,
))
}
}
/// Returns the ascent of this [PdfFont] for the given font size. The ascent is the maximum
/// height above the baseline reached by glyphs in this font, excluding the height of glyphs
/// for accented characters.
pub fn ascent(&self, font_size: PdfPoints) -> Result<PdfPoints, PdfiumError> {
let mut ascent = 0.0;
if self.bindings.is_true(self.bindings.FPDFFont_GetAscent(
self.handle,
font_size.value,
&mut ascent,
)) {
Ok(PdfPoints::new(ascent))
} else {
Err(PdfiumError::PdfiumLibraryInternalError(
PdfiumInternalError::Unknown,
))
}
}
/// Returns the descent of this [PdfFont] for the given font size. The descent is the
/// maximum distance below the baseline reached by glyphs in this font, expressed as a
/// negative points value.
pub fn descent(&self, font_size: PdfPoints) -> Result<PdfPoints, PdfiumError> {
let mut descent = 0.0;
if self.bindings.is_true(self.bindings.FPDFFont_GetDescent(
self.handle,
font_size.value,
&mut descent,
)) {
Ok(PdfPoints::new(descent))
} else {
Err(PdfiumError::PdfiumLibraryInternalError(
PdfiumInternalError::Unknown,
))
}
}
/// Returns the raw font descriptor bitflags for the containing [PdfFont].
#[inline]
fn get_flags_bits(&self) -> FpdfFontDescriptorFlags {
FpdfFontDescriptorFlags::from_bits_truncate(
self.bindings.FPDFFont_GetFlags(self.handle) as u32
)
}
/// Returns `true` if all the glyphs in this [PdfFont] have the same width.
///
/// Pdfium may not reliably return the correct value of this flag for built-in fonts.
pub fn is_fixed_pitch(&self) -> bool {
self.get_flags_bits()
.contains(FpdfFontDescriptorFlags::FIXED_PITCH_BIT_1)
}
/// Returns `true` if the glyphs in this [PdfFont] have variable widths.
///
/// Pdfium may not reliably return the correct value of this flag for built-in fonts.
#[inline]
pub fn is_proportional_pitch(&self) -> bool {
!self.is_fixed_pitch()
}
/// Returns `true` if one or more glyphs in this [PdfFont] have serifs - short strokes
/// drawn at an angle on the top or bottom of glyph stems to decorate the glyphs.
/// For example, Times New Roman is a serif font.
///
/// Pdfium may not reliably return the correct value of this flag for built-in fonts.
pub fn is_serif(&self) -> bool {
self.get_flags_bits()
.contains(FpdfFontDescriptorFlags::SERIF_BIT_2)
}
/// Returns `true` if no glyphs in this [PdfFont] have serifs - short strokes
/// drawn at an angle on the top or bottom of glyph stems to decorate the glyphs.
/// For example, Helvetica is a sans-serif font.
///
/// Pdfium may not reliably return the correct value of this flag for built-in fonts.
#[inline]
pub fn is_sans_serif(&self) -> bool {
!self.is_serif()
}
/// Returns `true` if this [PdfFont] contains glyphs outside the Adobe standard Latin
/// character set.
///
/// This classification of non-symbolic and symbolic fonts is peculiar to PDF. A font may
/// contain additional characters that are used in Latin writing systems but are outside the
/// Adobe standard Latin character set; PDF considers such a font to be symbolic.
///
/// Pdfium may not reliably return the correct value of this flag for built-in fonts.
pub fn is_symbolic(&self) -> bool {
// This flag bit and the non-symbolic flag bit cannot both be set or both be clear.
self.get_flags_bits()
.contains(FpdfFontDescriptorFlags::SYMBOLIC_BIT_3)
}
/// Returns `true` if this [PdfFont] does not contain glyphs outside the Adobe standard
/// Latin character set.
///
/// This classification of non-symbolic and symbolic fonts is peculiar to PDF. A font may
/// contain additional characters that are used in Latin writing systems but are outside the
/// Adobe standard Latin character set; PDF considers such a font to be symbolic.
///
/// Pdfium may not reliably return the correct value of this flag for built-in fonts.
pub fn is_non_symbolic(&self) -> bool {
// This flag bit and the symbolic flag bit cannot both be set or both be clear.
self.get_flags_bits()
.contains(FpdfFontDescriptorFlags::NON_SYMBOLIC_BIT_6)
}
/// Returns `true` if the glyphs in this [PdfFont] are designed to resemble cursive handwriting.
///
/// Pdfium may not reliably return the correct value of this flag for built-in fonts.
pub fn is_cursive(&self) -> bool {
self.get_flags_bits()
.contains(FpdfFontDescriptorFlags::SCRIPT_BIT_4)
}
/// Returns `true` if the glyphs in this [PdfFont] include dominant vertical strokes
/// that are slanted.
///
/// The designed vertical stroke angle can be retrieved using the [PdfFont::italic_angle()] function.
///
/// Pdfium may not reliably return the correct value of this flag for built-in fonts.
pub fn is_italic(&self) -> bool {
self.get_flags_bits()
.contains(FpdfFontDescriptorFlags::ITALIC_BIT_7)
}
/// Returns `true` if this [PdfFont] contains no lowercase letters by design.
///
/// Pdfium may not reliably return the correct value of this flag for built-in fonts.
pub fn is_all_caps(&self) -> bool {
self.get_flags_bits()
.contains(FpdfFontDescriptorFlags::ALL_CAP_BIT_17)
}
/// Returns `true` if the lowercase letters in this [PdfFont] have the same shapes as the
/// corresponding uppercase letters but are sized proportionally so they have the same size
/// and stroke weight as lowercase glyphs in the same typeface family.
///
/// Pdfium may not reliably return the correct value of this flag for built-in fonts.
pub fn is_small_caps(&self) -> bool {
self.get_flags_bits()
.contains(FpdfFontDescriptorFlags::SMALL_CAP_BIT_18)
}
/// Returns `true` if bold glyphs in this [PdfFont] are painted with extra pixels
/// at very small font sizes.
///
/// Typically when glyphs are painted at small sizes on low-resolution devices, individual strokes
/// of bold glyphs may appear only one pixel wide. Because this is the minimum width of a pixel
/// based device, individual strokes of non-bold glyphs may also appear as one pixel wide
/// and therefore cannot be distinguished from bold glyphs. If this flag is set, individual
/// strokes of bold glyphs may be thickened at small font sizes.
///
/// Pdfium may not reliably return the correct value of this flag for built-in fonts.
pub fn is_bold_reenforced(&self) -> bool {
self.get_flags_bits()
.contains(FpdfFontDescriptorFlags::FORCE_BOLD_BIT_19)
}
/// Returns `true` if this [PdfFont] is an instance of one of the 14 built-in fonts
/// provided as part of the PDF specification.
#[inline]
pub fn is_built_in(&self) -> bool {
self.built_in.is_some()
}
/// Returns the [PdfFontBuiltin] type of this built-in font, or `None` if this font is
/// not one of the 14 built-in fonts provided as part of the PDF specification.
#[inline]
pub fn built_in(&self) -> Option<PdfFontBuiltin> {
self.built_in
}
/// Returns a collection of all the [PdfFontGlyphs] defined for this [PdfFont] in the containing
/// `PdfDocument`.
///
/// Note that documents typically include only the specific glyphs they need from any given font,
/// not the entire font glyphset. This is a PDF feature known as font subsetting. The collection
/// of glyphs returned by this function may therefore not cover the entire font glyphset.
#[inline]
pub fn glyphs(&self) -> &PdfFontGlyphs {
self.glyphs.initialize_len();
&self.glyphs
}
}
impl<'a> Drop for PdfFont<'a> {
/// Closes this [PdfFont], releasing held memory.
#[inline]
fn drop(&mut self) {
// The documentation for FPDFText_LoadFont() and FPDFText_LoadStandardFont() both state
// that the font loaded by the function can be closed by calling FPDFFont_Close().
// I had taken this to mean that _any_ FPDF_Font handle returned from a Pdfium function
// should be closed via FPDFFont_Close(), but testing suggests this is not the case;
// rather, it is only fonts specifically loaded by calling FPDFText_LoadFont() or
// FPDFText_LoadStandardFont() that need to be actively closed.
// In other words, retrieving a handle to a font that already exists in a document evidently
// does not allocate any additional resources, so we don't need to free anything.
// (Indeed, if we try to, Pdfium segfaults.)
if self.is_font_memory_loaded {
self.bindings.FPDFFont_Close(self.handle);
}
}
}