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
//! Data related to individual glyphs.
pub mod builder;
mod codepoints;
mod parse;
mod serialize;
#[cfg(test)]
mod tests;
use std::path::{Path, PathBuf};
#[cfg(feature = "kurbo")]
use crate::error::ConvertContourError;
use crate::error::{ErrorKind, GlifLoadError, GlifWriteError, StoreError};
use crate::name::Name;
use crate::names::NameList;
use crate::shared_types::PUBLIC_OBJECT_LIBS_KEY;
use crate::{Color, Guideline, Identifier, Line, Plist, WriteOptions};
pub use codepoints::Codepoints;
/// A glyph, loaded from a [`.glif` file][glif].
///
/// Norad can load glif version 1.0 and 2.0, and can save 2.0 only.
///
/// [glif]: http://unifiedfontobject.org/versions/ufo3/glyphs/glif/
#[derive(Debug, Clone, PartialEq)]
pub struct Glyph {
/// The name of the glyph.
pub(crate) name: Name,
/// Glyph height.
pub height: f64,
/// Glyph width.
pub width: f64,
/// A collection of glyph Unicode code points.
///
/// The first entry defines the primary Unicode value for this glyph.
pub codepoints: Codepoints,
/// Arbitrary glyph note.
pub note: Option<String>,
/// A collection of glyph guidelines.
pub guidelines: Vec<Guideline>,
/// A collection of glyph anchors.
pub anchors: Vec<Anchor>,
/// A collection of glyph components.
pub components: Vec<Component>,
/// A collection of glyph contours.
pub contours: Vec<Contour>,
/// Glyph image data.
pub image: Option<Image>,
/// Glyph library data.
pub lib: Plist,
}
impl Glyph {
/// Attempt to parse a `Glyph` from a [`.glif`] at the provided path.
///
/// [`.glif`]: http://unifiedfontobject.org/versions/ufo3/glyphs/glif/
pub fn load(path: impl AsRef<Path>) -> Result<Self, GlifLoadError> {
let path = path.as_ref();
let names = NameList::default();
Glyph::load_with_names(path, &names)
}
/// THIS IS NOT STABLE API!
///
/// (exposed for benchmarking only)
#[doc(hidden)]
pub fn parse_raw(xml: &[u8]) -> Result<Self, GlifLoadError> {
let names = NameList::default();
parse::GlifParser::from_xml(xml, Some(&names))
}
/// Attempt to load the glyph at `path`, reusing names from the `NameList`.
///
/// This uses string interning to reuse allocations when a glyph name
/// occurs multiple times (such as in components or in different layers).
pub(crate) fn load_with_names(path: &Path, names: &NameList) -> Result<Self, GlifLoadError> {
std::fs::read(path)
.map_err(GlifLoadError::Io)
.and_then(|data| parse::GlifParser::from_xml(&data, Some(names)))
}
#[doc(hidden)]
pub fn save<P: AsRef<Path>>(&self, path: P) -> Result<(), GlifWriteError> {
let path = path.as_ref();
let opts = WriteOptions::default();
self.save_with_options(path, &opts)
}
pub(crate) fn save_with_options(
&self,
path: &Path,
opts: &WriteOptions,
) -> Result<(), GlifWriteError> {
if self.lib.contains_key(PUBLIC_OBJECT_LIBS_KEY) {
return Err(GlifWriteError::PreexistingPublicObjectLibsKey);
}
let data = self.encode_xml_with_options(opts)?;
close_already::fs::write(path, data).map_err(GlifWriteError::Io)?;
Ok(())
}
/// Returns a new, "empty" [`Glyph`] with the given `name`.
///
/// # Panics
///
/// panics if `name` is empty or if it contains any [control characters].
///
/// [control characters]: https://unifiedfontobject.org/versions/ufo3/conventions/#controls
pub fn new(name: &str) -> Self {
Glyph::new_impl(Name::new_raw(name))
}
// this impl lets the crate pass an explicit `Name`, which is reused between
// multiple layers and components
pub(crate) fn new_impl(name: Name) -> Self {
Glyph {
name,
height: 0.0,
width: 0.0,
codepoints: Default::default(),
note: None,
guidelines: Vec::new(),
anchors: Vec::new(),
components: Vec::new(),
contours: Vec::new(),
image: None,
lib: Plist::new(),
}
}
/// Returns the name of the glyph.
pub fn name(&self) -> &Name {
&self.name
}
/// Returns true if [`Glyph`] contains one or more [`Component`]s.
pub fn has_component(&self) -> bool {
!self.components.is_empty()
}
/// Returns the number of [`Component`]s in the Glyph.
pub fn component_count(&self) -> usize {
self.components.len()
}
/// Returns true if the Glyph contains one or more [`Component`]s with base
/// glyph name `basename`.
pub fn has_component_with_base(&self, basename: &str) -> bool {
self.components.iter().any(|x| *x.base == *basename)
}
/// Returns an iterator over immutable [`Component`] references filtered by base glyph name.
pub fn get_components_with_base<'b, 'a: 'b>(
&'a self,
basename: &'b str,
) -> impl Iterator<Item = &'a Component> + 'b {
self.components.iter().filter(move |x| *x.base == *basename)
}
/// Move libs from the lib's `public.objectLibs` into the actual objects.
/// The key will be removed from the glyph lib.
fn load_object_libs(&mut self) -> Result<(), GlifLoadError> {
// Use a macro to reduce boilerplate, to avoid having to mess with the typing system.
macro_rules! transfer_lib {
($object:expr, $object_libs:expr) => {
if let Some(id) = $object.identifier().map(|v| v.as_str()) {
if let Some(lib) = $object_libs.remove(id) {
let lib = lib
.into_dictionary()
.ok_or(GlifLoadError::ObjectLibMustBeDictionary(id.into()))?;
$object.replace_lib(lib);
}
}
};
}
let mut object_libs = match self.lib.remove(PUBLIC_OBJECT_LIBS_KEY) {
Some(lib) => {
lib.into_dictionary().ok_or(GlifLoadError::PublicObjectLibsMustBeDictionary)?
}
None => return Ok(()),
};
for anchor in &mut self.anchors {
transfer_lib!(anchor, object_libs);
}
for guideline in &mut self.guidelines {
transfer_lib!(guideline, object_libs);
}
for contour in &mut self.contours {
transfer_lib!(contour, object_libs);
for point in &mut contour.points {
transfer_lib!(point, object_libs);
}
}
for component in &mut self.components {
transfer_lib!(component, object_libs);
}
Ok(())
}
/// Dump guideline libs into a Plist.
fn dump_object_libs(&self) -> Plist {
let mut object_libs = Plist::default();
let mut dump_lib = |id: Option<&Identifier>, lib: &Plist| {
let id = id.map(|id| id.as_str().to_string());
object_libs.insert(id.unwrap(), plist::Value::Dictionary(lib.clone()));
};
for anchor in &self.anchors {
if let Some(lib) = anchor.lib() {
dump_lib(anchor.identifier(), lib);
}
}
for guideline in &self.guidelines {
if let Some(lib) = guideline.lib() {
dump_lib(guideline.identifier(), lib);
}
}
for contour in &self.contours {
if let Some(lib) = contour.lib() {
dump_lib(contour.identifier(), lib);
}
for point in &contour.points {
if let Some(lib) = point.lib() {
dump_lib(point.identifier(), lib);
}
}
}
for component in &self.components {
if let Some(lib) = component.lib() {
dump_lib(component.identifier(), lib);
}
}
object_libs
}
}
/// A reference position in a glyph, such as for attaching accents.
///
/// See the [Anchor section] of the UFO spec for more information.
///
/// [Anchor section]: https://unifiedfontobject.org/versions/ufo3/glyphs/glif/#anchor
#[derive(Debug, Clone, PartialEq)]
pub struct Anchor {
/// Anchor x coordinate value.
pub x: f64,
/// Anchor y coordinate value.
pub y: f64,
/// Optional arbitrary name for the anchor.
pub name: Option<Name>,
/// Optional anchor color.
pub color: Option<Color>,
/// Optional unique identifier for the anchor within the glyph.
///
/// This attribute is only required when a lib is present and should otherwise only be added as needed.
identifier: Option<Identifier>,
/// Optional anchor lib for arbitary data.
lib: Option<Plist>,
}
/// A reference to another glyph, to be included in this glyph's outline.
#[derive(Debug, Clone, PartialEq)]
pub struct Component {
/// The name of the base glyph used in the component.
pub base: Name,
/// Component affine transormation definition.
pub transform: AffineTransform,
/// Optional unique identifier for the component within the glyph.
///
/// This attribute is only required when a lib is present and should otherwise only
/// be added as needed.
identifier: Option<Identifier>,
/// Optional lib for arbitary component data.
lib: Option<Plist>,
}
/// A single open or closed bezier path segment.
#[derive(Debug, Clone, Default, PartialEq)]
pub struct Contour {
/// A collection of contour points.
pub points: Vec<ContourPoint>,
/// Unique identifier for the contour within the glyph.
///
/// This attribute is only required when a lib is present and should otherwise only
/// be added as needed.
identifier: Option<Identifier>,
/// Optional lib for arbitary contour data.
lib: Option<Plist>,
}
impl Contour {
/// Whether the contour is closed.
pub fn is_closed(&self) -> bool {
self.points.first().map_or(true, |v| v.typ != PointType::Move)
}
/// Converts the `Contour` to a [`kurbo::BezPath`].
#[cfg(feature = "kurbo")]
pub fn to_kurbo(&self) -> Result<kurbo::BezPath, ConvertContourError> {
let mut path = kurbo::BezPath::new();
let mut offs = std::collections::VecDeque::new();
let mut points = if self.is_closed() {
// Add end-of-contour offcurves to queue
let rotate = self
.points
.iter()
.rev()
.position(|pt| pt.typ != PointType::OffCurve)
.map(|idx| self.points.len() - 1 - idx);
self.points.iter().cycle().skip(rotate.unwrap_or(0)).take(self.points.len() + 1)
} else {
#[allow(clippy::iter_skip_zero)]
self.points.iter().cycle().skip(0).take(self.points.len())
};
if let Some(start) = points.next() {
path.move_to(start.to_kurbo());
}
for pt in points {
let kurbo_point = pt.to_kurbo();
match pt.typ {
PointType::Move => path.move_to(kurbo_point),
PointType::Line => path.line_to(kurbo_point),
PointType::OffCurve => offs.push_back(kurbo_point),
PointType::Curve => {
match offs.make_contiguous() {
[] => return Err(ConvertContourError::new(ErrorKind::BadPoint)),
[p1] => path.quad_to(*p1, kurbo_point),
[p1, p2] => path.curve_to(*p1, *p2, kurbo_point),
_ => return Err(ConvertContourError::new(ErrorKind::TooManyOffCurves)),
};
offs.clear();
}
PointType::QCurve => {
while let Some(pt) = offs.pop_front() {
if let Some(next) = offs.front() {
let implied_point = pt.midpoint(*next);
path.quad_to(pt, implied_point);
} else {
path.quad_to(pt, kurbo_point);
}
}
offs.clear();
}
}
}
Ok(path)
}
}
/// A single point in a [`Contour`].
#[derive(Debug, Clone, PartialEq)]
pub struct ContourPoint {
/// Contour point x coordinate value.
pub x: f64,
/// Contour point y coordinate value.
pub y: f64,
/// Contour point type.
pub typ: PointType,
/// Whether a smooth curvature should be maintained at this point. Must not be set for off-curve points.
pub smooth: bool,
/// Optional contour point name.
pub name: Option<Name>,
/// Optional unique identifier for the point within the glyph.
///
/// This attribute is only required when a lib is present and should otherwise only be added as needed.
identifier: Option<Identifier>,
/// Optional lib for arbitary contour point data.
lib: Option<Plist>,
}
/// Possible types of points that can exist in a [`Contour`].
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum PointType {
/// A point of this type must be the first in a contour. The reverse is not true:
/// a contour does not necessarily start with a move point. When a contour
/// does start with a move point, it signifies the beginning of an open contour.
/// A closed contour does not start with a move and is defined as a cyclic
/// list of points, with no predominant start point. There is always a next
/// point and a previous point. For this purpose the list of points can be
/// seen as endless in both directions. The actual list of points can be
/// rotated arbitrarily (by removing the first N points and appending
/// them at the end) while still describing the same outline.
Move,
/// Draw a straight line from the previous point to this point.
/// The previous point must be a move, a line, a curve or a qcurve.
/// It must not be an offcurve.
Line,
/// This point is part of a curve segment that goes up to the next point
/// that is either a curve or a qcurve.
OffCurve,
/// Draw a cubic bezier curve from the last non-offcurve point to this point.
/// The number of offcurve points can be zero, one or two.
/// If the number of offcurve points is zero, a straight line is drawn.
/// If it is one, a quadratic curve is drawn.
/// If it is two, a regular cubic bezier is drawn.
Curve,
/// Similar to curve, but uses quadratic curves, using the TrueType
/// “implied on-curve points” principle.
QCurve,
}
/// FromStr trait implementation for [`PointType`].
impl std::str::FromStr for PointType {
type Err = ErrorKind;
fn from_str(s: &str) -> Result<Self, Self::Err> {
match s {
"move" => Ok(PointType::Move),
"line" => Ok(PointType::Line),
"offcurve" => Ok(PointType::OffCurve),
"curve" => Ok(PointType::Curve),
"qcurve" => Ok(PointType::QCurve),
_other => Err(ErrorKind::UnknownPointType),
}
}
}
/// Display trait implementation for [`PointType`].
impl std::fmt::Display for PointType {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
PointType::Move => write!(f, "move"),
PointType::Line => write!(f, "line"),
PointType::OffCurve => write!(f, "offcurve"),
PointType::Curve => write!(f, "curve"),
PointType::QCurve => write!(f, "qcurve"),
}
}
}
/// A 2D affine transformation.
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct AffineTransform {
/// x-scale value.
pub x_scale: f64,
/// xy-scale value.
pub xy_scale: f64,
/// yx-scale value.
pub yx_scale: f64,
/// y-scale value.
pub y_scale: f64,
/// x-offset value.
pub x_offset: f64,
/// y-offset value.
pub y_offset: f64,
}
impl Anchor {
/// Returns a new [`Anchor`] given `x` and `y` coordinate values.
pub fn new(
x: f64,
y: f64,
name: Option<Name>,
color: Option<Color>,
identifier: Option<Identifier>,
lib: Option<Plist>,
) -> Self {
let mut this = Self { x, y, name, color, identifier: None, lib: None };
if let Some(id) = identifier {
this.replace_identifier(id);
}
if let Some(lib) = lib {
this.replace_lib(lib);
}
this
}
/// Returns a reference to the anchor's lib.
pub fn lib(&self) -> Option<&Plist> {
self.lib.as_ref()
}
/// Returns a mutable reference to the anchor's lib.
pub fn lib_mut(&mut self) -> Option<&mut Plist> {
self.lib.as_mut()
}
/// Replaces the actual lib by the lib given in parameter, returning the old
/// lib if present. Sets a new UUID v4 identifier if none is set already.
pub fn replace_lib(&mut self, lib: Plist) -> Option<Plist> {
if self.identifier.is_none() {
self.identifier.replace(Identifier::from_uuidv4());
}
self.lib.replace(lib)
}
/// Takes the lib out of the anchor, leaving a None in its place.
pub fn take_lib(&mut self) -> Option<Plist> {
self.lib.take()
}
/// Returns a reference to the anchor's identifier.
pub fn identifier(&self) -> Option<&Identifier> {
self.identifier.as_ref()
}
/// Replaces the actual identifier by the identifier given in parameter,
/// returning the old identifier if present.
pub fn replace_identifier(&mut self, id: Identifier) -> Option<Identifier> {
self.identifier.replace(id)
}
}
impl Contour {
/// Returns a new [`Contour`] given a vector of contour points.
pub fn new(
points: Vec<ContourPoint>,
identifier: Option<Identifier>,
lib: Option<Plist>,
) -> Self {
let mut this = Self { points, identifier: None, lib: None };
if let Some(id) = identifier {
this.replace_identifier(id);
}
if let Some(lib) = lib {
this.replace_lib(lib);
}
this
}
/// Returns a reference to the contour's lib.
pub fn lib(&self) -> Option<&Plist> {
self.lib.as_ref()
}
/// Returns a mutable reference to the contour's lib.
pub fn lib_mut(&mut self) -> Option<&mut Plist> {
self.lib.as_mut()
}
/// Replaces the actual lib by the lib given in parameter, returning the old
/// lib if present. Sets a new UUID v4 identifier if none is set already.
pub fn replace_lib(&mut self, lib: Plist) -> Option<Plist> {
if self.identifier.is_none() {
self.identifier.replace(Identifier::from_uuidv4());
}
self.lib.replace(lib)
}
/// Takes the lib out of the contour, leaving a None in its place.
pub fn take_lib(&mut self) -> Option<Plist> {
self.lib.take()
}
/// Returns a reference to the contour's identifier.
pub fn identifier(&self) -> Option<&Identifier> {
self.identifier.as_ref()
}
/// Replaces the actual identifier by the identifier given in parameter,
/// returning the old identifier if present.
pub fn replace_identifier(&mut self, id: Identifier) -> Option<Identifier> {
self.identifier.replace(id)
}
}
impl ContourPoint {
/// Returns a new [`ContourPoint`] given an `x` coordinate value,
/// `y` coordinate value, point type, and smooth definition.
pub fn new(
x: f64,
y: f64,
typ: PointType,
smooth: bool,
name: Option<Name>,
identifier: Option<Identifier>,
lib: Option<Plist>,
) -> Self {
let mut this = Self { x, y, typ, smooth, name, identifier: None, lib: None };
if let Some(id) = identifier {
this.replace_identifier(id);
}
if let Some(lib) = lib {
this.replace_lib(lib);
}
this
}
/// Returns a reference to the contour's lib.
pub fn lib(&self) -> Option<&Plist> {
self.lib.as_ref()
}
/// Returns a mutable reference to the contour's lib.
pub fn lib_mut(&mut self) -> Option<&mut Plist> {
self.lib.as_mut()
}
/// Replaces the actual lib by the lib given in parameter, returning the old
/// lib if present. Sets a new UUID v4 identifier if none is set already.
pub fn replace_lib(&mut self, lib: Plist) -> Option<Plist> {
if self.identifier.is_none() {
self.identifier.replace(Identifier::from_uuidv4());
}
self.lib.replace(lib)
}
/// Takes the lib out of the contour, leaving a None in its place.
pub fn take_lib(&mut self) -> Option<Plist> {
self.lib.take()
}
/// Returns a reference to the contour's identifier.
pub fn identifier(&self) -> Option<&Identifier> {
self.identifier.as_ref()
}
/// Replaces the actual identifier by the identifier given in parameter,
/// returning the old identifier if present.
pub fn replace_identifier(&mut self, id: Identifier) -> Option<Identifier> {
self.identifier.replace(id)
}
/// Returns a [`kurbo::Point`] with this `ContourPoint`'s coordinates.
#[cfg(feature = "kurbo")]
pub fn to_kurbo(&self) -> kurbo::Point {
kurbo::Point::new(self.x, self.y)
}
/// Applies a transformation matrix to the point's coordinates
pub fn transform(&mut self, transform: AffineTransform) {
let new_x = transform.x_scale * self.x + transform.yx_scale * self.y + transform.x_offset;
let new_y = transform.xy_scale * self.x + transform.y_scale * self.y + transform.y_offset;
self.x = new_x;
self.y = new_y;
}
}
impl Component {
/// Returns a new [`Component`] given a base glyph name and affine transformation definition.
///
/// The 'name' argument should be taken from an existing glyph in the same layer.
pub fn new(
base: Name,
transform: AffineTransform,
identifier: Option<Identifier>,
lib: Option<Plist>,
) -> Self {
let mut this = Self { base, transform, identifier: None, lib: None };
if let Some(id) = identifier {
this.replace_identifier(id);
}
if let Some(lib) = lib {
this.replace_lib(lib);
}
this
}
/// Returns a reference to the component's lib.
pub fn lib(&self) -> Option<&Plist> {
self.lib.as_ref()
}
/// Returns a mutable reference to the component's lib.
pub fn lib_mut(&mut self) -> Option<&mut Plist> {
self.lib.as_mut()
}
/// Replaces the actual lib by the lib given in parameter, returning the old
/// lib if present. Sets a new UUID v4 identifier if none is set already.
pub fn replace_lib(&mut self, lib: Plist) -> Option<Plist> {
if self.identifier.is_none() {
self.identifier.replace(Identifier::from_uuidv4());
}
self.lib.replace(lib)
}
/// Takes the lib out of the component, leaving a None in its place.
pub fn take_lib(&mut self) -> Option<Plist> {
self.lib.take()
}
/// Returns a reference to the component's identifier.
pub fn identifier(&self) -> Option<&Identifier> {
self.identifier.as_ref()
}
/// Replaces the actual identifier by the identifier given in parameter,
/// returning the old identifier if present.
pub fn replace_identifier(&mut self, id: Identifier) -> Option<Identifier> {
self.identifier.replace(id)
}
}
impl AffineTransform {
/// [1 0 0 1 0 0]; the identity transformation.
fn identity() -> Self {
AffineTransform {
x_scale: 1.0,
xy_scale: 0.,
yx_scale: 0.,
y_scale: 1.0,
x_offset: 0.,
y_offset: 0.,
}
}
}
impl std::default::Default for AffineTransform {
fn default() -> Self {
Self::identity()
}
}
/// An image included in a glyph.
#[derive(Debug, Clone, PartialEq)]
pub struct Image {
/// The name of the image file. Must be a base file name, no subdirectories involved.
file_name: PathBuf,
/// Optional image color.
pub color: Option<Color>,
/// Affine transformation.
pub transform: AffineTransform,
}
impl Image {
/// Create a new image.
pub fn new(
file_name: PathBuf,
color: Option<Color>,
transform: AffineTransform,
) -> Result<Self, StoreError> {
// Note: Mostly mirrors [`Self::validate_entry`].
if file_name.as_os_str().is_empty() {
return Err(StoreError::EmptyPath);
}
if file_name.is_absolute() {
return Err(StoreError::PathIsAbsolute);
}
if file_name.parent().map_or(false, |p| !p.as_os_str().is_empty()) {
return Err(StoreError::Subdir);
}
Ok(Self { file_name, color, transform })
}
/// Returns the file name of the image.
pub fn file_name(&self) -> &Path {
self.file_name.as_path()
}
}
#[cfg(feature = "kurbo")]
impl From<AffineTransform> for kurbo::Affine {
fn from(src: AffineTransform) -> kurbo::Affine {
kurbo::Affine::new([
src.x_scale,
src.xy_scale,
src.yx_scale,
src.y_scale,
src.x_offset,
src.y_offset,
])
}
}
#[cfg(feature = "kurbo")]
impl From<kurbo::Affine> for AffineTransform {
fn from(src: kurbo::Affine) -> AffineTransform {
let coeffs = src.as_coeffs();
AffineTransform {
x_scale: coeffs[0],
xy_scale: coeffs[1],
yx_scale: coeffs[2],
y_scale: coeffs[3],
x_offset: coeffs[4],
y_offset: coeffs[5],
}
}
}