Version 1.1

LICENSE.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Viktor Chlumsky
+Copyright (c) 2020 - 2024 Viktor Chlumsky
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

artery-font/artery-font.h

@@ -6,5 +6,5 @@
 #include "structures.h"
 #include "serialization.h"
 
-// ARTERY ENGINE ATLAS FONT FORMAT LIBRARY v1.0
+// ARTERY ENGINE ATLAS FONT FORMAT LIBRARY v1.1
-// Author: Viktor Chlumsky (c) 2020
+// Author: Viktor Chlumsky (c) 2020 - 2024

artery-font/serialization.h

@@ -7,10 +7,13 @@
 
 namespace artery_font {
 
-template <int (*READ)(void *, int, void *), typename REAL, template <typename> class LIST, class BYTE_ARRAY, class STRING>
+typedef int ReadFunction(void *dst, int limit, void *userData);
+typedef int WriteFunction(const void *src, int length, void *userData);
+
+template <ReadFunction READ, typename REAL, template <typename> class LIST, class BYTE_ARRAY, class STRING>
 bool decode(ArteryFont<REAL, LIST, BYTE_ARRAY, STRING> &font, void *userData);
 
-template <int (*WRITE)(const void *, int, void *), typename REAL, template <typename> class LIST, class BYTE_ARRAY, class STRING>
+template <WriteFunction WRITE, typename REAL, template <typename> class LIST, class BYTE_ARRAY, class STRING>
 bool encode(const ArteryFont<REAL, LIST, BYTE_ARRAY, STRING> &font, void *userData);
 
 }

artery-font/serialization.hpp

@@ -81,11 +81,11 @@ template <typename REAL>
 uint32 realTypeCode();
 
 template <>
-uint32 realTypeCode<float>() {
+inline uint32 realTypeCode<float>() {
     return 0x14u;
 }
 template <>
-uint32 realTypeCode<double>() {
+inline uint32 realTypeCode<double>() {
     return 0x18u;
 }
 
@@ -97,7 +97,7 @@ inline uint32 paddedLength(uint32 len) {
 
 template <class STRING>
 uint32 paddedStringLength(const STRING &str) {
-    uint32 len = str.length();
+    uint32 len = (uint32) str.length();
     return paddedLength(len+(len > 0));
 }
 
@@ -105,18 +105,18 @@ uint32 paddedStringLength(const STRING &str) {
 
 #ifndef __BIG_ENDIAN__
 
-template <int (*READ)(void *, int, void *), typename REAL, template <typename> class LIST, class BYTE_ARRAY, class STRING>
+template <ReadFunction READ, typename REAL, template <typename> class LIST, class BYTE_ARRAY, class STRING>
 bool decode(ArteryFont<REAL, LIST, BYTE_ARRAY, STRING> &font, void *userData) {
     uint32 totalLength = 0;
     uint32 prevLength = 0;
     uint32 checksum = crc32Init();
     byte dump[4];
     #define ARTERY_FONT_DECODE_READ(target, len) { \
-        if (READ((void *) (target), (len), userData) != (len)) \
+        if (READ((target), (len), userData) != int(len)) \
             return false; \
         totalLength += (len); \
-        for (int i = 0; i < int(len); ++i) \
+        for (int _i = 0; _i < int(len); ++_i) \
-            checksum = crc32Update(checksum, ((const byte *) (const void *) (target))[i]); \
+            checksum = crc32Update(checksum, reinterpret_cast<const byte *>(target)[_i]); \
     }
     #define ARTERY_FONT_DECODE_REALIGN() { \
         if (totalLength&0x03u) { \
@@ -129,7 +129,7 @@ bool decode(ArteryFont<REAL, LIST, BYTE_ARRAY, STRING> &font, void *userData) {
             LIST<char> characters((len)+1); \
             ARTERY_FONT_DECODE_READ((char *) characters, (len)+1); \
             ((char *) characters)[len] = '\0'; \
-            (str) = STRING((const char *) characters, uint32(len)); \
+            (str) = STRING((const char *) characters, int(len)); \
             ARTERY_FONT_DECODE_REALIGN(); \
         } else \
             (str) = STRING(); \
@@ -156,8 +156,8 @@ bool decode(ArteryFont<REAL, LIST, BYTE_ARRAY, STRING> &font, void *userData) {
         imageCount = header.imageCount;
         appendixCount = header.appendixCount;
         font.variants = LIST<FontVariant<REAL, LIST, STRING> >(header.variantCount);
-        font.images = LIST<Image<BYTE_ARRAY, STRING> >(header.imageCount);
+        font.images = LIST<FontImage<BYTE_ARRAY, STRING> >(header.imageCount);
-        font.appendices = LIST<Appendix<BYTE_ARRAY, STRING> >(header.appendixCount);
+        font.appendices = LIST<FontAppendix<BYTE_ARRAY, STRING> >(header.appendixCount);
         variantsLength = header.variantsLength;
         imagesLength = header.imagesLength;
         appendicesLength = header.appendicesLength;
@@ -187,7 +187,7 @@ bool decode(ArteryFont<REAL, LIST, BYTE_ARRAY, STRING> &font, void *userData) {
     prevLength = totalLength;
     // Read images
     for (int i = 0; i < imageCount; ++i) {
-        Image<BYTE_ARRAY, STRING> &image = font.images[i];
+        FontImage<BYTE_ARRAY, STRING> &image = font.images[i];
         internal::ImageHeader header;
         ARTERY_FONT_DECODE_READ(&header, sizeof(header));
         image.flags = header.flags;
@@ -211,7 +211,7 @@ bool decode(ArteryFont<REAL, LIST, BYTE_ARRAY, STRING> &font, void *userData) {
     prevLength = totalLength;
     // Read appendices
     for (int i = 0; i < appendixCount; ++i) {
-        Appendix<BYTE_ARRAY, STRING> &appendix = font.appendices[i];
+        FontAppendix<BYTE_ARRAY, STRING> &appendix = font.appendices[i];
         internal::AppendixHeader header;
         ARTERY_FONT_DECODE_READ(&header, sizeof(header));
         ARTERY_FONT_DECODE_READ_STRING(appendix.metadata, header.metadataLength);
@@ -228,9 +228,9 @@ bool decode(ArteryFont<REAL, LIST, BYTE_ARRAY, STRING> &font, void *userData) {
         ARTERY_FONT_DECODE_READ(&footer, sizeof(footer)-sizeof(footer.checksum));
         if (footer.magicNo != ARTERY_FONT_FOOTER_MAGIC_NO)
             return false;
-        uint32 prevChecksum = checksum;
+        uint32 finalChecksum = checksum;
         ARTERY_FONT_DECODE_READ(&footer.checksum, sizeof(footer.checksum));
-        if (footer.checksum != prevChecksum)
+        if (footer.checksum != finalChecksum)
             return false;
         if (totalLength != footer.totalLength)
             return false;
@@ -241,28 +241,28 @@ bool decode(ArteryFont<REAL, LIST, BYTE_ARRAY, STRING> &font, void *userData) {
     #undef ARTERY_FONT_DECODE_READ_STRING
 }
 
-template <int (*WRITE)(const void *, int, void *), typename REAL, template <typename> class LIST, class BYTE_ARRAY, class STRING>
+template <WriteFunction WRITE, typename REAL, template <typename> class LIST, class BYTE_ARRAY, class STRING>
 bool encode(const ArteryFont<REAL, LIST, BYTE_ARRAY, STRING> &font, void *userData) {
     uint32 totalLength = 0;
     uint32 checksum = crc32Init();
     const byte padding[4] = { };
     #define ARTERY_FONT_ENCODE_WRITE(data, len) { \
-        if (WRITE((const void *) (data), (len), userData) != (len)) \
+        if (WRITE((data), (len), userData) != int(len)) \
             return false; \
         totalLength += (len); \
-        for (int i = 0; i < int(len); ++i) \
+        for (int _i = 0; _i < int(len); ++_i) \
-            checksum = crc32Update(checksum, ((const byte *) (const void *) (data))[i]); \
+            checksum = crc32Update(checksum, reinterpret_cast<const byte *>(data)[_i]); \
     }
     #define ARTERY_FONT_ENCODE_REALIGN() { \
         if (totalLength&0x03u) { \
-            uint32 len = 0x04u-(totalLength&0x03u); \
+            uint32 _len = 0x04u-(totalLength&0x03u); \
-            ARTERY_FONT_ENCODE_WRITE(padding, len); \
+            ARTERY_FONT_ENCODE_WRITE(padding, _len); \
         } \
     }
     #define ARTERY_FONT_ENCODE_WRITE_STRING(str) { \
-        uint32 len = (str).length(); \
+        uint32 len = (uint32) (str).length(); \
-        if ((len) > 0) { \
+        if (len > 0) { \
-            ARTERY_FONT_ENCODE_WRITE((const char *) (str), (len)); \
+            ARTERY_FONT_ENCODE_WRITE((const char *) (str), len); \
             ARTERY_FONT_ENCODE_WRITE(padding, 1) \
             ARTERY_FONT_ENCODE_REALIGN(); \
         } \
@@ -280,12 +280,12 @@ bool encode(const ArteryFont<REAL, LIST, BYTE_ARRAY, STRING> &font, void *userDa
         header.realType = internal::realTypeCode<REAL>();
         memset(header.reserved, 0, sizeof(header.reserved));
         header.metadataFormat = (uint32) font.metadataFormat;
-        header.metadataLength = font.metadata.length();
+        header.metadataLength = (uint32) font.metadata.length();
-        header.variantCount = variantCount = font.variants.length();
+        header.variantCount = variantCount = (int) font.variants.length();
         header.variantsLength = 0;
-        header.imageCount = imageCount = font.images.length();
+        header.imageCount = imageCount = (int) font.images.length();
         header.imagesLength = 0;
-        header.appendixCount = appendixCount = font.appendices.length();
+        header.appendixCount = appendixCount = (int) font.appendices.length();
         header.appendicesLength = 0;
         memset(header.reserved2, 0, sizeof(header.reserved2));
         for (int i = 0; i < variantCount; ++i) {
@@ -293,20 +293,20 @@ bool encode(const ArteryFont<REAL, LIST, BYTE_ARRAY, STRING> &font, void *userDa
             header.variantsLength += sizeof(internal::FontVariantHeader<REAL>);
             header.variantsLength += internal::paddedStringLength(variant.name);
             header.variantsLength += internal::paddedStringLength(variant.metadata);
-            header.variantsLength += variant.glyphs.length()*sizeof(Glyph<REAL>);
+            header.variantsLength += (uint32) (variant.glyphs.length()*sizeof(Glyph<REAL>));
-            header.variantsLength += variant.kernPairs.length()*sizeof(KernPair<REAL>);
+            header.variantsLength += (uint32) (variant.kernPairs.length()*sizeof(KernPair<REAL>));
         }
         for (int i = 0; i < imageCount; ++i) {
-            const Image<BYTE_ARRAY, STRING> &image = font.images[i];
+            const FontImage<BYTE_ARRAY, STRING> &image = font.images[i];
             header.imagesLength += sizeof(internal::ImageHeader);
             header.imagesLength += internal::paddedStringLength(image.metadata);
-            header.imagesLength += internal::paddedLength(image.data.length());
+            header.imagesLength += internal::paddedLength((uint32) image.data.length());
         }
         for (int i = 0; i < appendixCount; ++i) {
-            const Appendix<BYTE_ARRAY, STRING> &appendix = font.appendices[i];
+            const FontAppendix<BYTE_ARRAY, STRING> &appendix = font.appendices[i];
             header.appendicesLength += sizeof(internal::AppendixHeader);
             header.appendicesLength += internal::paddedStringLength(appendix.metadata);
-            header.appendicesLength += internal::paddedLength(appendix.data.length());
+            header.appendicesLength += internal::paddedLength((uint32) appendix.data.length());
         }
         ARTERY_FONT_ENCODE_WRITE(&header, sizeof(header));
         ARTERY_FONT_ENCODE_WRITE_STRING(font.metadata);
@@ -323,10 +323,10 @@ bool encode(const ArteryFont<REAL, LIST, BYTE_ARRAY, STRING> &font, void *userDa
         header.fallbackGlyph = variant.fallbackGlyph;
         memset(header.reserved, 0, sizeof(header.reserved));
         memcpy(header.metrics, &variant.metrics, sizeof(header.metrics));
-        header.nameLength = variant.name.length();
+        header.nameLength = (uint32) variant.name.length();
-        header.metadataLength = variant.metadata.length();
+        header.metadataLength = (uint32) variant.metadata.length();
-        header.glyphCount = variant.glyphs.length();
+        header.glyphCount = (uint32) variant.glyphs.length();
-        header.kernPairCount = variant.kernPairs.length();
+        header.kernPairCount = (uint32) variant.kernPairs.length();
         ARTERY_FONT_ENCODE_WRITE(&header, sizeof(header));
         ARTERY_FONT_ENCODE_WRITE_STRING(variant.name);
         ARTERY_FONT_ENCODE_WRITE_STRING(variant.metadata);
@@ -335,7 +335,7 @@ bool encode(const ArteryFont<REAL, LIST, BYTE_ARRAY, STRING> &font, void *userDa
     }
     // Write images
     for (int i = 0; i < imageCount; ++i) {
-        const Image<BYTE_ARRAY, STRING> &image = font.images[i];
+        const FontImage<BYTE_ARRAY, STRING> &image = font.images[i];
         internal::ImageHeader header;
         header.flags = image.flags;
         header.encoding = (uint32) image.encoding;
@@ -349,8 +349,8 @@ bool encode(const ArteryFont<REAL, LIST, BYTE_ARRAY, STRING> &font, void *userDa
         header.childImages = image.childImages;
         header.textureFlags = image.textureFlags;
         memset(header.reserved, 0, sizeof(header.reserved));
-        header.metadataLength = image.metadata.length();
+        header.metadataLength = (uint32) image.metadata.length();
-        header.dataLength = image.data.length();
+        header.dataLength = (uint32) image.data.length();
         ARTERY_FONT_ENCODE_WRITE(&header, sizeof(header));
         ARTERY_FONT_ENCODE_WRITE_STRING(image.metadata);
         ARTERY_FONT_ENCODE_WRITE((const unsigned char *) image.data, header.dataLength);
@@ -358,10 +358,10 @@ bool encode(const ArteryFont<REAL, LIST, BYTE_ARRAY, STRING> &font, void *userDa
     }
     // Write appendices
     for (int i = 0; i < appendixCount; ++i) {
-        const Appendix<BYTE_ARRAY, STRING> &appendix = font.appendices[i];
+        const FontAppendix<BYTE_ARRAY, STRING> &appendix = font.appendices[i];
         internal::AppendixHeader header;
-        header.metadataLength = appendix.metadata.length();
+        header.metadataLength = (uint32) appendix.metadata.length();
-        header.dataLength = appendix.data.length();
+        header.dataLength = (uint32) appendix.data.length();
         ARTERY_FONT_ENCODE_WRITE(&header, sizeof(header));
         ARTERY_FONT_ENCODE_WRITE_STRING(appendix.metadata);
         ARTERY_FONT_ENCODE_WRITE((const unsigned char *) appendix.data, header.dataLength);

artery-font/std-artery-font.h

@@ -8,30 +8,26 @@
 namespace artery_font {
 
 template <typename T>
-class StdList {
+class StdList : private std::vector<T> {
 
 public:
-    std::vector<T> vector;
+    inline StdList() { }
-
+    inline explicit StdList(int length) : std::vector<T>((size_t) length) { }
-    StdList() { }
+    inline int length() const { return (int) std::vector<T>::size(); }
-    explicit StdList(int length) : vector((size_t) length) { }
+    inline explicit operator T *() { return std::vector<T>::data(); }
-    int length() const { return (int) vector.size(); }
+    inline explicit operator const T *() const { return std::vector<T>::data(); }
-    explicit operator T *() { return vector.data(); }
+    inline T &operator[](int index) { return std::vector<T>::operator[](index); }
-    explicit operator const T *() const { return vector.data(); }
+    inline const T &operator[](int index) const { return std::vector<T>::operator[](index); }
-    T & operator[](int index) { return vector[index]; }
-    const T & operator[](int index) const { return vector[index]; }
 
 };
 
-class StdString {
+class StdString : private std::string {
 
 public:
-    std::string string;
+    inline StdString() { }
-
+    inline StdString(const char *characters, int length) : std::string(characters, (size_t) length) { }
-    StdString() { }
+    inline int length() const { return (int) std::string::size(); }
-    StdString(const char *characters, int length) : string(characters, (size_t) length) { }
+    inline explicit operator const char *() const { return std::string::c_str(); }
-    int length() const { return (int) string.size(); }
-    explicit operator const char *() const { return string.c_str(); }
 
 };
 
@@ -39,9 +35,5 @@ typedef StdList<unsigned char> StdByteArray;
 
 template <typename REAL>
 using StdArteryFont = ArteryFont<REAL, StdList, StdByteArray, StdString>;
-template <typename REAL>
-using StdFontVariant = FontVariant<REAL, StdList, StdString>;
-using StdImage = Image<StdByteArray, StdString>;
-using StdAppendix = Appendix<StdByteArray, StdString>;
 
 }

artery-font/structures.h

@@ -43,7 +43,9 @@ struct FontVariant {
         REAL ascender, descender;
         REAL lineHeight;
         REAL underlineY, underlineThickness;
-        REAL reserved[24];
+        // In pixels:
+        REAL distanceRangeMiddle;
+        REAL reserved[23];
     } metrics;
     STRING name;
     STRING metadata;
@@ -52,7 +54,7 @@ struct FontVariant {
 };
 
 template <class BYTE_ARRAY, class STRING>
-struct Image {
+struct FontImage {
     uint32 flags;
     ImageEncoding encoding;
     uint32 width, height;
@@ -70,18 +72,21 @@ struct Image {
 };
 
 template <class BYTE_ARRAY, class STRING>
-struct Appendix {
+struct FontAppendix {
     STRING metadata;
     BYTE_ARRAY data;
 };
 
 template <typename REAL, template <typename> class LIST, class BYTE_ARRAY, class STRING>
 struct ArteryFont {
+    typedef FontVariant<REAL, LIST, STRING> Variant;
+    typedef FontImage<BYTE_ARRAY, STRING> Image;
+    typedef FontAppendix<BYTE_ARRAY, STRING> Appendix;
     MetadataFormat metadataFormat;
     STRING metadata;
-    LIST<FontVariant<REAL, LIST, STRING> > variants;
+    LIST<Variant> variants;
-    LIST<Image<BYTE_ARRAY, STRING> > images;
+    LIST<Image> images;
-    LIST<Appendix<BYTE_ARRAY, STRING> > appendices;
+    LIST<Appendix> appendices;
 };
 
 }