Rename "libm-math" feature to "libm" for consistency (#4)

* Rename "libm-math" feature to "libm" for consistency
* Update changelog

.github/workflows/ci.yml

@@ -18,7 +18,7 @@ jobs:
     - name: Build no_std ab_glyph_rasterizer
       run: (cd rasterizer && cargo build --target thumbv6m-none-eabi --no-default-features --features libm)
     - name: Build no_std ab_glyph
-      run: (cd glyph && cargo build --target thumbv6m-none-eabi --no-default-features --features libm-math)
+      run: (cd glyph && cargo build --target thumbv6m-none-eabi --no-default-features --features libm)
 
   rustfmt:
     runs-on: ubuntu-latest

glyph/CHANGELOG.md

@@ -1,2 +1,7 @@
+# Unreleased
+* Add `_unscaled` suffix to  `Font` trait methods that deal with unscaled metrics.
+  This helps distinguish `ScaleFont`'s scaled metrics and can avoid unintended behaviour.
+* Rename "libm-math" -> "libm" for consistency with ab_glyph_rasterizer. 
+
 # 0.1
 * Implement fast glyph layout, outline & drawing primitives.

glyph/Cargo.toml

@@ -13,7 +13,8 @@ readme="README.md"
 owned_ttf_parser = { version = "0.5.1", default-features = false }
 ab_glyph_rasterizer = { version = "0.1.2", path = "../rasterizer", default-features = false }
 # no_std float stuff
-libm = { version = "0.2.1", optional = true }
+# renamed to enable a "libm" feature
+libm2 = { package = "libm", version = "0.2.1", optional = true }
 
 [dev-dependencies]
 # don't add any, instead use ./dev
@@ -23,4 +24,4 @@ default = ["std"]
 # Activates usage of std.
 std = ["owned_ttf_parser/default", "ab_glyph_rasterizer/default"]
 # Uses libm when not using std. This needs to be active in that case.
-libm-math = ["libm", "ab_glyph_rasterizer/libm"]
+libm = ["libm2", "ab_glyph_rasterizer/libm"]

glyph/README.md

@@ -21,7 +21,7 @@ if let Some(q) = font.outline_glyph(q_glyph) {
 ## no_std
 no_std environments are supported using `alloc` & [`libm`](https://github.com/rust-lang/libm).
 ```toml
-ab_glyph = { default-features = false, features = ["libm-math"] }
+ab_glyph = { default-features = false, features = ["libm"] }
 ```
 
 ## Comparison with [`rusttype`](https://gitlab.redox-os.org/redox-os/rusttype)

glyph/src/lib.rs

@@ -26,7 +26,7 @@ mod font;
 #[cfg(feature = "std")]
 mod font_arc;
 mod glyph;
-#[cfg(all(feature = "libm-math", not(feature = "std")))]
+#[cfg(all(feature = "libm", not(feature = "std")))]
 mod nostd_float;
 mod outlined;
 mod scale;

glyph/src/nostd_float.rs

@@ -1,3 +1,5 @@
+use libm2 as libm;
+
 /// Basic required float operations.
 pub(crate) trait FloatExt {
     fn floor(self) -> Self;

glyph/src/outlined.rs

@@ -1,4 +1,4 @@
-#[cfg(all(feature = "libm-math", not(feature = "std")))]
+#[cfg(all(feature = "libm", not(feature = "std")))]
 use crate::nostd_float::FloatExt;
 use crate::{point, Glyph, Point, PxScaleFactor};
 #[cfg(not(feature = "std"))]

test

@@ -10,6 +10,6 @@ cargo test
 cargo test --benches
 echo "==> no_std"
 (cd rasterizer && cargo build --target thumbv6m-none-eabi --no-default-features --features libm)
-(cd glyph && cargo build --target thumbv6m-none-eabi --no-default-features --features libm-math)
+(cd glyph && cargo build --target thumbv6m-none-eabi --no-default-features --features libm)
 echo "==> rustfmt"
 cargo fmt -- --check