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
#![deny(missing_docs)]
//! A wrapper around [freedesktop.org's Fontconfig library][homepage], for locating fonts on a UNIX
//! like systems such as Linux and FreeBSD. Requires Fontconfig to be installed. Alternatively,
//! set the environment variable `RUST_FONTCONFIG_DLOPEN=on` or enable the `dlopen` Cargo feature
//! to load the library at runtime rather than link at build time (useful for cross compiling).
//!
//! See the [Fontconfig developer reference][1] for more information.
//!
//! [1]: http://www.freedesktop.org/software/fontconfig/fontconfig-devel/t1.html
//! [homepage]: https://www.freedesktop.org/wiki/Software/fontconfig/
//!
//! Dependencies
//! ============
//!
//! * Arch Linux: `fontconfig`
//! * Debian-based systems: `libfontconfig1-dev`
//! * FreeBSD: `fontconfig`
//! * Void Linux: `fontconfig-devel`
//!
//! Usage
//! -----
//!
//! ```
//! use fontconfig::Fontconfig;
//!
//! fn main() {
//! let fc = Fontconfig::new().unwrap();
//! // `Fontconfig::find()` returns `Option` (will rarely be `None` but still could be)
//! let font = fc.find("freeserif", None).unwrap();
//! // `name` is a `String`, `path` is a `Path`
//! println!("Name: {}\nPath: {}", font.name, font.path.display());
//! }
//! ```
//!
//! ### Cargo Features
//!
//! | Feature | Description | Default Enabled | Extra Dependencies |
//! |---------------|-----------------------------------|:---------------:|-----------------------|
//! | `dlopen` | [dlopen] libfontconfig at runtime | ❌ | |
//!
//! The `dlopen` feature enables building this crate without dynamically linking to the Fontconfig C
//! library at link time. Instead, Fontconfig will be dynamically loaded at runtime with the
//! [dlopen] function. This can be useful in cross-compiling situations as you don't need to have a
//! version of Fontcofig available for the target platform available at compile time.
//!
//! [dlopen]: https://pubs.opengroup.org/onlinepubs/9699919799/functions/dlopen.html
use fontconfig_sys as sys;
use fontconfig_sys::ffi_dispatch;
#[cfg(feature = "dlopen")]
use sys::statics::{LIB, LIB_RESULT};
#[cfg(not(feature = "dlopen"))]
use sys::*;
use std::ffi::{c_int, CStr, CString};
use std::marker::PhantomData;
use std::mem;
use std::os::raw::c_char;
use std::path::PathBuf;
use std::ptr;
use std::str::FromStr;
pub use sys::constants::*;
use sys::{FcBool, FcPattern};
#[allow(non_upper_case_globals)]
const FcTrue: FcBool = 1;
#[allow(non_upper_case_globals, dead_code)]
const FcFalse: FcBool = 0;
/// Handle obtained after Fontconfig has been initialised.
pub struct Fontconfig {
_initialised: (),
}
/// Error type returned from Pattern::format.
///
/// The error holds the name of the unknown format.
#[derive(Debug)]
pub struct UnknownFontFormat(pub String);
/// The format of a font matched by Fontconfig.
#[derive(Eq, PartialEq)]
#[allow(missing_docs)]
pub enum FontFormat {
TrueType,
Type1,
BDF,
PCF,
Type42,
CIDType1,
CFF,
PFR,
WindowsFNT,
}
impl Fontconfig {
/// Initialise Fontconfig and return a handle allowing further interaction with the API.
///
/// If Fontconfig fails to initialise, returns `None`.
pub fn new() -> Option<Self> {
#[cfg(feature = "dlopen")]
if LIB_RESULT.is_err() {
return None;
}
if unsafe { ffi_dispatch!(LIB, FcInit,) == FcTrue } {
Some(Fontconfig { _initialised: () })
} else {
None
}
}
/// Find a font of the given `family` (e.g. Dejavu Sans, FreeSerif),
/// optionally filtering by `style`. Both fields are case-insensitive.
pub fn find(&self, family: &str, style: Option<&str>) -> Option<Font> {
Font::find(self, family, style)
}
}
/// A very high-level view of a font, only concerned with the name and its file location.
///
/// ##Example
/// ```rust
/// use fontconfig::{Font, Fontconfig};
///
/// let fc = Fontconfig::new().unwrap();
/// let font = fc.find("sans-serif", Some("italic")).unwrap();
/// println!("Name: {}\nPath: {}", font.name, font.path.display());
/// ```
pub struct Font {
/// The true name of this font
pub name: String,
/// The location of this font on the filesystem.
pub path: PathBuf,
/// The index of the font within the file.
pub index: Option<i32>,
}
impl Font {
fn find(fc: &Fontconfig, family: &str, style: Option<&str>) -> Option<Font> {
let mut pat = Pattern::new(fc);
let family = CString::new(family).ok()?;
pat.add_string(FC_FAMILY, &family);
if let Some(style) = style {
let style = CString::new(style).ok()?;
pat.add_string(FC_STYLE, &style);
}
let font_match = pat.font_match();
font_match.name().and_then(|name| {
font_match.filename().map(|filename| Font {
name: name.to_owned(),
path: PathBuf::from(filename),
index: font_match.face_index(),
})
})
}
#[allow(dead_code)]
fn print_debug(&self) {
println!(
"Name: {}\nPath: {}\nIndex: {:?}",
self.name,
self.path.display(),
self.index
);
}
}
/// A safe wrapper around fontconfig's `FcPattern`.
#[repr(C)]
pub struct Pattern<'fc> {
/// Raw pointer to `FcPattern`
pat: *mut FcPattern,
fc: &'fc Fontconfig,
}
impl<'fc> Pattern<'fc> {
/// Create a new empty `Pattern`.
pub fn new(fc: &Fontconfig) -> Pattern {
let pat = unsafe { ffi_dispatch!(LIB, FcPatternCreate,) };
assert!(!pat.is_null());
Pattern { pat, fc }
}
/// Create a `Pattern` from a raw fontconfig FcPattern pointer.
///
/// The pattern is referenced.
///
/// **Safety:** The pattern pointer must be valid/non-null.
pub unsafe fn from_pattern(fc: &Fontconfig, pat: *mut FcPattern) -> Pattern {
ffi_dispatch!(LIB, FcPatternReference, pat);
Pattern { pat, fc }
}
/// Add a key-value pair of type `String` to this pattern.
///
/// See useful keys in the [fontconfig reference][1].
///
/// [1]: http://www.freedesktop.org/software/fontconfig/fontconfig-devel/x19.html
pub fn add_string(&mut self, name: &CStr, val: &CStr) {
unsafe {
ffi_dispatch!(
LIB,
FcPatternAddString,
self.pat,
name.as_ptr(),
val.as_ptr() as *const u8
);
}
}
/// Add a key-value pair of type `Int` to this pattern
///
/// See useful keys in the [fontconfig reference][1].
///
/// [1]: http://www.freedesktop.org/software/fontconfig/fontconfig-devel/x19.html
pub fn add_integer(&mut self, name: &CStr, val: c_int) {
unsafe {
ffi_dispatch!(LIB, FcPatternAddInteger, self.pat, name.as_ptr(), val);
}
}
/// Get string the value for a key from this pattern.
pub fn get_string<'a>(&'a self, name: &'a CStr) -> Option<&'a str> {
unsafe {
let mut ret: *mut sys::FcChar8 = ptr::null_mut();
if ffi_dispatch!(
LIB,
FcPatternGetString,
self.pat,
name.as_ptr(),
0,
&mut ret as *mut _
) == sys::FcResultMatch
{
let cstr = CStr::from_ptr(ret as *const c_char);
Some(cstr.to_str().unwrap())
} else {
None
}
}
}
/// Get the integer value for a key from this pattern.
pub fn get_int(&self, name: &CStr) -> Option<i32> {
unsafe {
let mut ret: i32 = 0;
if ffi_dispatch!(
LIB,
FcPatternGetInteger,
self.pat,
name.as_ptr(),
0,
&mut ret as *mut i32
) == sys::FcResultMatch
{
Some(ret)
} else {
None
}
}
}
/// Print this pattern to stdout with all its values.
pub fn print(&self) {
unsafe {
ffi_dispatch!(LIB, FcPatternPrint, &*self.pat);
}
}
fn default_substitute(&mut self) {
unsafe {
ffi_dispatch!(LIB, FcDefaultSubstitute, self.pat);
}
}
fn config_substitute(&mut self) {
unsafe {
ffi_dispatch!(
LIB,
FcConfigSubstitute,
ptr::null_mut(),
self.pat,
sys::FcMatchPattern
);
}
}
/// Get the best available match for this pattern, returned as a new pattern.
pub fn font_match(&mut self) -> Pattern {
self.default_substitute();
self.config_substitute();
unsafe {
let mut res = sys::FcResultNoMatch;
Pattern::from_pattern(
self.fc,
ffi_dispatch!(LIB, FcFontMatch, ptr::null_mut(), self.pat, &mut res),
)
}
}
/// Get the "fullname" (human-readable name) of this pattern.
pub fn name(&self) -> Option<&str> {
self.get_string(FC_FULLNAME)
}
/// Get the "file" (path on the filesystem) of this font pattern.
pub fn filename(&self) -> Option<&str> {
self.get_string(FC_FILE)
}
/// Get the "index" (The index of the font within the file) of this pattern.
pub fn face_index(&self) -> Option<i32> {
self.get_int(FC_INDEX)
}
/// Get the "slant" (Italic, oblique or roman) of this pattern.
pub fn slant(&self) -> Option<i32> {
self.get_int(FC_SLANT)
}
/// Get the "weight" (Light, medium, demibold, bold or black) of this pattern.
pub fn weight(&self) -> Option<i32> {
self.get_int(FC_WEIGHT)
}
/// Get the "width" (Condensed, normal or expanded) of this pattern.
pub fn width(&self) -> Option<i32> {
self.get_int(FC_WIDTH)
}
/// Get the "fontformat" ("TrueType" "Type 1" "BDF" "PCF" "Type 42" "CID Type 1" "CFF" "PFR" "Windows FNT") of this pattern.
pub fn format(&self) -> Result<FontFormat, UnknownFontFormat> {
self.get_string(FC_FONTFORMAT)
.ok_or_else(|| UnknownFontFormat(String::new()))
.and_then(|format| format.parse())
}
/// Returns a raw pointer to underlying `FcPattern`.
pub fn as_ptr(&self) -> *const FcPattern {
self.pat
}
/// Returns an unsafe mutable pointer to the underlying `FcPattern`.
pub fn as_mut_ptr(&mut self) -> *mut FcPattern {
self.pat
}
}
impl<'fc> std::fmt::Debug for Pattern<'fc> {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
let fcstr = unsafe { ffi_dispatch!(LIB, FcNameUnparse, self.pat) };
let fcstr = unsafe { CStr::from_ptr(fcstr as *const c_char) };
let result = write!(f, "{:?}", fcstr);
unsafe { ffi_dispatch!(LIB, FcStrFree, fcstr.as_ptr() as *mut u8) };
result
}
}
impl<'fc> Clone for Pattern<'fc> {
fn clone(&self) -> Self {
let clone = unsafe { ffi_dispatch!(LIB, FcPatternDuplicate, self.pat) };
Pattern {
pat: clone,
fc: self.fc,
}
}
}
impl<'fc> Drop for Pattern<'fc> {
fn drop(&mut self) {
unsafe {
ffi_dispatch!(LIB, FcPatternDestroy, self.pat);
}
}
}
impl Pattern<'_> {
/// Get the languages set of this pattern.
pub fn lang_set(&self) -> Option<StrList<'_>> {
unsafe {
let mut ret: *mut sys::FcLangSet = ptr::null_mut();
if ffi_dispatch!(
LIB,
FcPatternGetLangSet,
self.pat,
FC_LANG.as_ptr(),
0,
&mut ret as *mut _
) == sys::FcResultMatch
{
let ss: *mut sys::FcStrSet = ffi_dispatch!(LIB, FcLangSetGetLangs, ret);
let lang_strs: *mut sys::FcStrList = ffi_dispatch!(LIB, FcStrListCreate, ss);
Some(StrList::from_raw(self.fc, lang_strs))
} else {
None
}
}
}
}
/// Wrapper around `FcStrList`
///
/// The wrapper implements `Iterator` so it can be iterated directly, filtered etc.
/// **Note:** Any entries in the `StrList` that are not valid UTF-8 will be skipped.
///
/// ```
/// use fontconfig::{Fontconfig, Pattern};
///
/// let fc = Fontconfig::new().expect("unable to init Fontconfig");
///
/// // Find fonts that support japanese
/// let fonts = fontconfig::list_fonts(&Pattern::new(&fc), None);
/// let ja_fonts: Vec<_> = fonts
/// .iter()
/// .filter(|p| p.lang_set().map_or(false, |mut langs| langs.any(|l| l == "ja")))
/// .collect();
/// ```
pub struct StrList<'a> {
list: *mut sys::FcStrList,
_life: PhantomData<&'a sys::FcStrList>,
}
impl<'a> StrList<'a> {
unsafe fn from_raw(_: &Fontconfig, raw_list: *mut sys::FcStrSet) -> Self {
Self {
list: raw_list,
_life: PhantomData,
}
}
}
impl<'a> Drop for StrList<'a> {
fn drop(&mut self) {
unsafe { ffi_dispatch!(LIB, FcStrListDone, self.list) };
}
}
impl<'a> Iterator for StrList<'a> {
type Item = &'a str;
fn next(&mut self) -> Option<&'a str> {
let lang_str: *mut sys::FcChar8 = unsafe { ffi_dispatch!(LIB, FcStrListNext, self.list) };
if lang_str.is_null() {
None
} else {
match unsafe { CStr::from_ptr(lang_str as *const c_char) }.to_str() {
Ok(s) => Some(s),
_ => self.next(),
}
}
}
}
/// Wrapper around `FcFontSet`.
pub struct FontSet<'fc> {
fcset: *mut sys::FcFontSet,
fc: &'fc Fontconfig,
}
impl<'fc> FontSet<'fc> {
/// Create a new, empty `FontSet`.
pub fn new(fc: &Fontconfig) -> FontSet {
let fcset = unsafe { ffi_dispatch!(LIB, FcFontSetCreate,) };
FontSet { fcset, fc }
}
/// Wrap an existing `FcFontSet`.
///
/// The returned wrapper assumes ownership of the `FcFontSet`.
///
/// **Safety:** The font set pointer must be valid/non-null.
pub unsafe fn from_raw(fc: &Fontconfig, raw_set: *mut sys::FcFontSet) -> FontSet {
FontSet { fcset: raw_set, fc }
}
/// Add a `Pattern` to this `FontSet`.
pub fn add_pattern(&mut self, pat: Pattern) {
unsafe {
ffi_dispatch!(LIB, FcFontSetAdd, self.fcset, pat.pat);
mem::forget(pat);
}
}
/// Print this `FontSet` to stdout.
pub fn print(&self) {
unsafe { ffi_dispatch!(LIB, FcFontSetPrint, self.fcset) };
}
/// Iterate the fonts (as `Patterns`) in this `FontSet`.
pub fn iter(&self) -> impl Iterator<Item = Pattern<'_>> {
let patterns = unsafe {
let fontset = self.fcset;
std::slice::from_raw_parts((*fontset).fonts, (*fontset).nfont as usize)
};
patterns
.iter()
.map(move |&pat| unsafe { Pattern::from_pattern(self.fc, pat) })
}
}
impl<'fc> Drop for FontSet<'fc> {
fn drop(&mut self) {
unsafe { ffi_dispatch!(LIB, FcFontSetDestroy, self.fcset) }
}
}
/// Return a `FontSet` containing Fonts that match the supplied `pattern` and `objects`.
pub fn list_fonts<'fc>(pattern: &Pattern<'fc>, objects: Option<&ObjectSet>) -> FontSet<'fc> {
let os = objects.map(|o| o.fcset).unwrap_or(ptr::null_mut());
unsafe {
let raw_set = ffi_dispatch!(LIB, FcFontList, ptr::null_mut(), pattern.pat, os);
FontSet::from_raw(pattern.fc, raw_set)
}
}
/// Returns a [`FontSet`] containing fonts sorted by closeness to the supplied `pattern`. If `trim` is true, elements in
/// the list which don't include Unicode coverage not provided by earlier elements in the list are elided.
///
/// See the [fontconfig reference][1] for more details.
///
/// [1]: https://www.freedesktop.org/software/fontconfig/fontconfig-devel/fcfontsort.html
pub fn sort_fonts<'fc>(pattern: &Pattern<'fc>, trim: bool) -> FontSet<'fc> {
// FcFontSort always returns a (possibly empty) set so we don't need to check this.
let mut res = sys::FcResultNoMatch;
let unicode_coverage = ptr::null_mut();
let config = ptr::null_mut();
unsafe {
let raw_set = ffi_dispatch!(
LIB,
FcFontSort,
config,
pattern.pat,
trim as FcBool,
unicode_coverage,
&mut res
);
FontSet::from_raw(pattern.fc, raw_set)
}
}
/// Wrapper around `FcObjectSet`.
pub struct ObjectSet {
fcset: *mut sys::FcObjectSet,
}
impl ObjectSet {
/// Create a new, empty `ObjectSet`.
pub fn new(_: &Fontconfig) -> ObjectSet {
let fcset = unsafe { ffi_dispatch!(LIB, FcObjectSetCreate,) };
assert!(!fcset.is_null());
ObjectSet { fcset }
}
/// Wrap an existing `FcObjectSet`.
///
/// The `FcObjectSet` must not be null. This method assumes ownership of the `FcObjectSet`.
///
/// **Safety:** The object set pointer must be valid/non-null.
pub unsafe fn from_raw(_: &Fontconfig, raw_set: *mut sys::FcObjectSet) -> ObjectSet {
ObjectSet { fcset: raw_set }
}
/// Add a string to the `ObjectSet`.
pub fn add(&mut self, name: &CStr) {
let res = unsafe { ffi_dispatch!(LIB, FcObjectSetAdd, self.fcset, name.as_ptr()) };
assert_eq!(res, FcTrue);
}
}
impl Drop for ObjectSet {
fn drop(&mut self) {
unsafe { ffi_dispatch!(LIB, FcObjectSetDestroy, self.fcset) }
}
}
impl FromStr for FontFormat {
type Err = UnknownFontFormat;
fn from_str(s: &str) -> Result<Self, Self::Err> {
match s {
"TrueType" => Ok(FontFormat::TrueType),
"Type 1" => Ok(FontFormat::Type1),
"BDF" => Ok(FontFormat::BDF),
"PCF" => Ok(FontFormat::PCF),
"Type 42" => Ok(FontFormat::Type42),
"CID Type 1" => Ok(FontFormat::CIDType1),
"CFF" => Ok(FontFormat::CFF),
"PFR" => Ok(FontFormat::PFR),
"Windows FNT" => Ok(FontFormat::WindowsFNT),
_ => Err(UnknownFontFormat(s.to_string())),
}
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn it_works() {
assert!(Fontconfig::new().is_some())
}
#[test]
fn test_find_font() {
let fc = Fontconfig::new().unwrap();
fc.find("dejavu sans", None).unwrap().print_debug();
fc.find("dejavu sans", Some("oblique"))
.unwrap()
.print_debug();
}
#[test]
fn test_iter_and_print() {
let fc = Fontconfig::new().unwrap();
let fontset = list_fonts(&Pattern::new(&fc), None);
for pattern in fontset.iter() {
println!("{:?}", pattern.name());
}
// Ensure that the set can be iterated again
assert!(fontset.iter().count() > 0);
}
#[test]
fn iter_lang_set() {
let fc = Fontconfig::new().unwrap();
let mut pat = Pattern::new(&fc);
let family = CString::new("dejavu sans").unwrap();
pat.add_string(FC_FAMILY, &family);
let pattern = pat.font_match();
for lang in pattern.lang_set().unwrap() {
println!("{:?}", lang);
}
// Test find
assert!(pattern
.lang_set()
.unwrap()
.find(|&lang| lang == "za")
.is_some());
// Test collect
let langs = pattern.lang_set().unwrap().collect::<Vec<_>>();
assert!(langs.iter().find(|&&l| l == "ie").is_some());
}
}