src/hb-ot-os2-table.hh

   1 /*
   2  * Copyright © 2011,2012  Google, Inc.
   3  * Copyright © 2018  Ebrahim Byagowi
   4  *
   5  *  This is part of HarfBuzz, a text shaping library.
   6  *
   7  * Permission is hereby granted, without written agreement and without
   8  * license or royalty fees, to use, copy, modify, and distribute this
   9  * software and its documentation for any purpose, provided that the
  10  * above copyright notice and the following two paragraphs appear in
  11  * all copies of this software.
  12  *
  13  * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
  14  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  15  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
  16  * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
  17  * DAMAGE.
  18  *
  19  * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
  20  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  21  * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  22  * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
  23  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  24  *
  25  * Google Author(s): Behdad Esfahbod
  26  */
  27
  28 #ifndef HB_OT_OS2_TABLE_HH
  29 #define HB_OT_OS2_TABLE_HH
  30
  31 #include "hb-open-type.hh"
  32 #include "hb-ot-os2-unicode-ranges.hh"
  33 #include "hb-ot-cmap-table.hh"
  34
  35 #include "hb-set.hh"
  36
  37 /*
  38  * OS/2 and Windows Metrics
  39  * https://docs.microsoft.com/en-us/typography/opentype/spec/os2
  40  */
  41 #define HB_OT_TAG_OS2 HB_TAG('O','S','/','2')
  42
  43
  44 namespace OT {
  45
  46 struct OS2V1Tail
  47 {
  48   bool sanitize (hb_sanitize_context_t *c) const
  49   {
  50     TRACE_SANITIZE (this);
  51     return_trace (c->check_struct (this));
  52   }
  53
  54   public:
  55   HBUINT32      ulCodePageRange1;
  56   HBUINT32      ulCodePageRange2;
  57   public:
  58   DEFINE_SIZE_STATIC (8);
  59 };
  60
  61 struct OS2V2Tail
  62 {
  63   bool has_data () const { return sxHeight || sCapHeight; }
  64
  65   const OS2V2Tail * operator -> () const { return this; }
  66
  67   bool sanitize (hb_sanitize_context_t *c) const
  68   {
  69     TRACE_SANITIZE (this);
  70     return_trace (c->check_struct (this));
  71   }
  72
  73   public:
  74   HBINT16       sxHeight;
  75   HBINT16       sCapHeight;
  76   HBUINT16      usDefaultChar;
  77   HBUINT16      usBreakChar;
  78   HBUINT16      usMaxContext;
  79   public:
  80   DEFINE_SIZE_STATIC (10);
  81 };
  82
  83 struct OS2V5Tail
  84 {
  85   inline bool get_optical_size (unsigned int *lower, unsigned int *upper) const
  86   {
  87     unsigned int lower_optical_size = usLowerOpticalPointSize;
  88     unsigned int upper_optical_size = usUpperOpticalPointSize;
  89
  90     /* Per https://docs.microsoft.com/en-us/typography/opentype/spec/os2#lps */
  91     if (lower_optical_size < upper_optical_size &&
  92         lower_optical_size >= 1 && lower_optical_size <= 0xFFFE &&
  93         upper_optical_size >= 2 && upper_optical_size <= 0xFFFF)
  94     {
  95       *lower = lower_optical_size;
  96       *upper = upper_optical_size;
  97       return true;
  98     }
  99     return false;
 100   }
 101
 102   bool sanitize (hb_sanitize_context_t *c) const
 103   {
 104     TRACE_SANITIZE (this);
 105     return_trace (c->check_struct (this));
 106   }
 107
 108   public:
 109   HBUINT16      usLowerOpticalPointSize;
 110   HBUINT16      usUpperOpticalPointSize;
 111   public:
 112   DEFINE_SIZE_STATIC (4);
 113 };
 114
 115 struct OS2
 116 {
 117   static constexpr hb_tag_t tableTag = HB_OT_TAG_OS2;
 118
 119   bool has_data () const { return usWeightClass || usWidthClass || usFirstCharIndex || usLastCharIndex; }
 120
 121   const OS2V1Tail &v1 () const { return version >= 1 ? v1X : Null (OS2V1Tail); }
 122   const OS2V2Tail &v2 () const { return version >= 2 ? v2X : Null (OS2V2Tail); }
 123   const OS2V5Tail &v5 () const { return version >= 5 ? v5X : Null (OS2V5Tail); }
 124
 125   enum selection_flag_t {
 126     ITALIC              = 1u<<0,
 127     UNDERSCORE          = 1u<<1,
 128     NEGATIVE            = 1u<<2,
 129     OUTLINED            = 1u<<3,
 130     STRIKEOUT           = 1u<<4,
 131     BOLD                = 1u<<5,
 132     REGULAR             = 1u<<6,
 133     USE_TYPO_METRICS    = 1u<<7,
 134     WWS                 = 1u<<8,
 135     OBLIQUE             = 1u<<9
 136   };
 137
 138   bool        is_italic () const { return fsSelection & ITALIC; }
 139   bool       is_oblique () const { return fsSelection & OBLIQUE; }
 140   bool use_typo_metrics () const { return fsSelection & USE_TYPO_METRICS; }
 141
 142   enum width_class_t {
 143     FWIDTH_ULTRA_CONDENSED      = 1, /* 50% */
 144     FWIDTH_EXTRA_CONDENSED      = 2, /* 62.5% */
 145     FWIDTH_CONDENSED            = 3, /* 75% */
 146     FWIDTH_SEMI_CONDENSED       = 4, /* 87.5% */
 147     FWIDTH_NORMAL               = 5, /* 100% */
 148     FWIDTH_SEMI_EXPANDED        = 6, /* 112.5% */
 149     FWIDTH_EXPANDED             = 7, /* 125% */
 150     FWIDTH_EXTRA_EXPANDED       = 8, /* 150% */
 151     FWIDTH_ULTRA_EXPANDED       = 9  /* 200% */
 152   };
 153
 154   float get_width () const
 155   {
 156     switch (usWidthClass) {
 157     case FWIDTH_ULTRA_CONDENSED:return 50.f;
 158     case FWIDTH_EXTRA_CONDENSED:return 62.5f;
 159     case FWIDTH_CONDENSED:      return 75.f;
 160     case FWIDTH_SEMI_CONDENSED: return 87.5f;
 161     default:
 162     case FWIDTH_NORMAL:         return 100.f;
 163     case FWIDTH_SEMI_EXPANDED:  return 112.5f;
 164     case FWIDTH_EXPANDED:       return 125.f;
 165     case FWIDTH_EXTRA_EXPANDED: return 150.f;
 166     case FWIDTH_ULTRA_EXPANDED: return 200.f;
 167     }
 168   }
 169
 170   bool subset (hb_subset_context_t *c) const
 171   {
 172     TRACE_SUBSET (this);
 173     OS2 *os2_prime = c->serializer->embed (this);
 174     if (unlikely (!os2_prime)) return_trace (false);
 175
 176     hb_set_t unicodes;
 177     hb_map_t unicode_glyphid_map;
 178
 179     OT::cmap::accelerator_t cmap;
 180     cmap.init (c->plan->source);
 181     cmap.collect_mapping (&unicodes, &unicode_glyphid_map);
 182     cmap.fini ();
 183
 184     if (c->plan->unicodes->is_empty ()) unicodes.clear ();
 185     else hb_set_set (&unicodes, c->plan->unicodes);
 186
 187     + unicode_glyphid_map.iter ()
 188     | hb_filter (c->plan->glyphs_requested, hb_second)
 189     | hb_map (hb_first)
 190     | hb_sink (unicodes)
 191     ;
 192     uint16_t min_cp, max_cp;
 193     find_min_and_max_codepoint (&unicodes, &min_cp, &max_cp);
 194     os2_prime->usFirstCharIndex = min_cp;
 195     os2_prime->usLastCharIndex = max_cp;
 196
 197     _update_unicode_ranges (&unicodes, os2_prime->ulUnicodeRange);
 198
 199     return_trace (true);
 200   }
 201
 202   void _update_unicode_ranges (const hb_set_t *codepoints,
 203                                HBUINT32 ulUnicodeRange[4]) const
 204   {
 205     HBUINT32    newBits[4];
 206     for (unsigned int i = 0; i < 4; i++)
 207       newBits[i] = 0;
 208
 209     hb_codepoint_t cp = HB_SET_VALUE_INVALID;
 210     while (codepoints->next (&cp)) {
 211       unsigned int bit = _hb_ot_os2_get_unicode_range_bit (cp);
 212       if (bit < 128)
 213       {
 214         unsigned int block = bit / 32;
 215         unsigned int bit_in_block = bit % 32;
 216         unsigned int mask = 1 << bit_in_block;
 217         newBits[block] = newBits[block] | mask;
 218       }
 219       if (cp >= 0x10000 && cp <= 0x110000)
 220       {
 221         /* the spec says that bit 57 ("Non Plane 0") implies that there's
 222            at least one codepoint beyond the BMP; so I also include all
 223            the non-BMP codepoints here */
 224         newBits[1] = newBits[1] | (1 << 25);
 225       }
 226     }
 227
 228     for (unsigned int i = 0; i < 4; i++)
 229       ulUnicodeRange[i] = ulUnicodeRange[i] & newBits[i]; // set bits only if set in the original
 230   }
 231
 232   static void find_min_and_max_codepoint (const hb_set_t *codepoints,
 233                                           uint16_t *min_cp, /* OUT */
 234                                           uint16_t *max_cp  /* OUT */)
 235   {
 236     *min_cp = hb_min (0xFFFFu, codepoints->get_min ());
 237     *max_cp = hb_min (0xFFFFu, codepoints->get_max ());
 238   }
 239
 240   /* https://github.com/Microsoft/Font-Validator/blob/520aaae/OTFontFileVal/val_OS2.cs#L644-L681 */
 241   enum font_page_t
 242   {
 243     FONT_PAGE_HEBREW            = 0xB100, /* Hebrew Windows 3.1 font page */
 244     FONT_PAGE_SIMP_ARABIC       = 0xB200, /* Simplified Arabic Windows 3.1 font page */
 245     FONT_PAGE_TRAD_ARABIC       = 0xB300, /* Traditional Arabic Windows 3.1 font page */
 246     FONT_PAGE_OEM_ARABIC        = 0xB400, /* OEM Arabic Windows 3.1 font page */
 247     FONT_PAGE_SIMP_FARSI        = 0xBA00, /* Simplified Farsi Windows 3.1 font page */
 248     FONT_PAGE_TRAD_FARSI        = 0xBB00, /* Traditional Farsi Windows 3.1 font page */
 249     FONT_PAGE_THAI              = 0xDE00  /* Thai Windows 3.1 font page */
 250   };
 251   font_page_t get_font_page () const
 252   { return (font_page_t) (version == 0 ? fsSelection & 0xFF00 : 0); }
 253
 254   unsigned get_size () const
 255   {
 256     unsigned result = min_size;
 257     if (version >= 1) result += v1X.get_size ();
 258     if (version >= 2) result += v2X.get_size ();
 259     if (version >= 5) result += v5X.get_size ();
 260     return result;
 261   }
 262
 263   bool sanitize (hb_sanitize_context_t *c) const
 264   {
 265     TRACE_SANITIZE (this);
 266     if (unlikely (!c->check_struct (this))) return_trace (false);
 267     if (unlikely (version >= 1 && !v1X.sanitize (c))) return_trace (false);
 268     if (unlikely (version >= 2 && !v2X.sanitize (c))) return_trace (false);
 269     if (unlikely (version >= 5 && !v5X.sanitize (c))) return_trace (false);
 270     return_trace (true);
 271   }
 272
 273   public:
 274   HBUINT16      version;
 275   HBINT16       xAvgCharWidth;
 276   HBUINT16      usWeightClass;
 277   HBUINT16      usWidthClass;
 278   HBUINT16      fsType;
 279   HBINT16       ySubscriptXSize;
 280   HBINT16       ySubscriptYSize;
 281   HBINT16       ySubscriptXOffset;
 282   HBINT16       ySubscriptYOffset;
 283   HBINT16       ySuperscriptXSize;
 284   HBINT16       ySuperscriptYSize;
 285   HBINT16       ySuperscriptXOffset;
 286   HBINT16       ySuperscriptYOffset;
 287   HBINT16       yStrikeoutSize;
 288   HBINT16       yStrikeoutPosition;
 289   HBINT16       sFamilyClass;
 290   HBUINT8       panose[10];
 291   HBUINT32      ulUnicodeRange[4];
 292   Tag           achVendID;
 293   HBUINT16      fsSelection;
 294   HBUINT16      usFirstCharIndex;
 295   HBUINT16      usLastCharIndex;
 296   HBINT16       sTypoAscender;
 297   HBINT16       sTypoDescender;
 298   HBINT16       sTypoLineGap;
 299   HBUINT16      usWinAscent;
 300   HBUINT16      usWinDescent;
 301   OS2V1Tail     v1X;
 302   OS2V2Tail     v2X;
 303   OS2V5Tail     v5X;
 304   public:
 305   DEFINE_SIZE_MIN (78);
 306 };
 307
 308 } /* namespace OT */
 309
 310
 311 #endif /* HB_OT_OS2_TABLE_HH */