src/hb-ot-name.cc

   1 /*
   2  * Copyright © 2018  Google, Inc.
   3  *
   4  *  This is part of HarfBuzz, a text shaping library.
   5  *
   6  * Permission is hereby granted, without written agreement and without
   7  * license or royalty fees, to use, copy, modify, and distribute this
   8  * software and its documentation for any purpose, provided that the
   9  * above copyright notice and the following two paragraphs appear in
  10  * all copies of this software.
  11  *
  12  * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
  13  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  14  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
  15  * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
  16  * DAMAGE.
  17  *
  18  * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
  19  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  20  * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  21  * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
  22  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  23  *
  24  * Google Author(s): Behdad Esfahbod
  25  */
  26
  27 #include "hb.hh"
  28
  29 #ifndef HB_NO_NAME
  30
  31 #include "hb-ot-name-table.hh"
  32
  33 #include "hb-utf.hh"
  34
  35
  36 /**
  37  * SECTION:hb-ot-name
  38  * @title: hb-ot-name
  39  * @short_description: OpenType font name information
  40  * @include: hb-ot.h
  41  *
  42  * Functions for fetching name strings from OpenType fonts.
  43  **/
  44
  45
  46 /**
  47  * hb_ot_name_list_names:
  48  * @face: font face.
  49  * @num_entries: (out) (optional): number of returned entries.
  50  *
  51  * Enumerates all available name IDs and language combinations. Returned
  52  * array is owned by the @face and should not be modified.  It can be
  53  * used as long as @face is alive.
  54  *
  55  * Returns: (transfer none) (array length=num_entries): Array of available name entries.
  56  * Since: 2.1.0
  57  **/
  58 const hb_ot_name_entry_t *
  59 hb_ot_name_list_names (hb_face_t    *face,
  60                        unsigned int *num_entries /* OUT */)
  61 {
  62   const OT::name_accelerator_t &name = *face->table.name;
  63   if (num_entries) *num_entries = name.names.length;
  64   return (const hb_ot_name_entry_t *) name.names;
  65 }
  66
  67
  68 template <typename in_utf_t, typename out_utf_t>
  69 static inline unsigned int
  70 hb_ot_name_convert_utf (hb_bytes_t                       bytes,
  71                         unsigned int                    *text_size /* IN/OUT */,
  72                         typename out_utf_t::codepoint_t *text /* OUT */)
  73 {
  74   unsigned int src_len = bytes.length / sizeof (typename in_utf_t::codepoint_t);
  75   const typename in_utf_t::codepoint_t *src = (const typename in_utf_t::codepoint_t *) bytes.arrayZ;
  76   const typename in_utf_t::codepoint_t *src_end = src + src_len;
  77
  78   typename out_utf_t::codepoint_t *dst = text;
  79
  80   hb_codepoint_t unicode;
  81   const hb_codepoint_t replacement = HB_BUFFER_REPLACEMENT_CODEPOINT_DEFAULT;
  82
  83   if (text_size && *text_size)
  84   {
  85     (*text_size)--; /* Same room for NUL-termination. */
  86     const typename out_utf_t::codepoint_t *dst_end = text + *text_size;
  87
  88     while (src < src_end && dst < dst_end)
  89     {
  90       const typename in_utf_t::codepoint_t *src_next = in_utf_t::next (src, src_end, &unicode, replacement);
  91       typename out_utf_t::codepoint_t *dst_next = out_utf_t::encode (dst, dst_end, unicode);
  92       if (dst_next == dst)
  93         break; /* Out-of-room. */
  94
  95       dst = dst_next;
  96       src = src_next;
  97     }
  98
  99     *text_size = dst - text;
 100     *dst = 0; /* NUL-terminate. */
 101   }
 102
 103   /* Accumulate length of rest. */
 104   unsigned int dst_len = dst - text;
 105   while (src < src_end)
 106   {
 107     src = in_utf_t::next (src, src_end, &unicode, replacement);
 108     dst_len += out_utf_t::encode_len (unicode);
 109   }
 110   return dst_len;
 111 }
 112
 113 template <typename utf_t>
 114 static inline unsigned int
 115 hb_ot_name_get_utf (hb_face_t       *face,
 116                     hb_ot_name_id_t  name_id,
 117                     hb_language_t    language,
 118                     unsigned int    *text_size /* IN/OUT */,
 119                     typename utf_t::codepoint_t *text /* OUT */)
 120 {
 121   const OT::name_accelerator_t &name = *face->table.name;
 122
 123   if (!language)
 124     language = hb_language_from_string ("en", 2);
 125
 126   unsigned int width;
 127   int idx = name.get_index (name_id, language, &width);
 128   if (idx != -1)
 129   {
 130     hb_bytes_t bytes = name.get_name (idx);
 131
 132     if (width == 2) /* UTF16-BE */
 133       return hb_ot_name_convert_utf<hb_utf16_be_t, utf_t> (bytes, text_size, text);
 134
 135     if (width == 1) /* ASCII */
 136       return hb_ot_name_convert_utf<hb_ascii_t, utf_t> (bytes, text_size, text);
 137   }
 138
 139   if (text_size)
 140   {
 141     if (*text_size)
 142       *text = 0;
 143     *text_size = 0;
 144   }
 145   return 0;
 146 }
 147
 148 /**
 149  * hb_ot_name_get_utf8:
 150  * @face: font face.
 151  * @name_id: OpenType name identifier to fetch.
 152  * @language: language to fetch the name for.
 153  * @text_size: (inout) (optional): input size of @text buffer, and output size of
 154  *                                   text written to buffer.
 155  * @text: (out caller-allocates) (array length=text_size): buffer to write fetched name into.
 156  *
 157  * Fetches a font name from the OpenType 'name' table.
 158  * If @language is #HB_LANGUAGE_INVALID, English ("en") is assumed.
 159  * Returns string in UTF-8 encoding. A NUL terminator is always written
 160  * for convenience, and isn't included in the output @text_size.
 161  *
 162  * Returns: full length of the requested string, or 0 if not found.
 163  * Since: 2.1.0
 164  **/
 165 unsigned int
 166 hb_ot_name_get_utf8 (hb_face_t       *face,
 167                      hb_ot_name_id_t  name_id,
 168                      hb_language_t    language,
 169                      unsigned int    *text_size /* IN/OUT */,
 170                      char            *text      /* OUT */)
 171 {
 172   return hb_ot_name_get_utf<hb_utf8_t> (face, name_id, language, text_size,
 173                                         (hb_utf8_t::codepoint_t *) text);
 174 }
 175
 176 /**
 177  * hb_ot_name_get_utf16:
 178  * @face: font face.
 179  * @name_id: OpenType name identifier to fetch.
 180  * @language: language to fetch the name for.
 181  * @text_size: (inout) (optional): input size of @text buffer, and output size of
 182  *                                   text written to buffer.
 183  * @text: (out caller-allocates) (array length=text_size): buffer to write fetched name into.
 184  *
 185  * Fetches a font name from the OpenType 'name' table.
 186  * If @language is #HB_LANGUAGE_INVALID, English ("en") is assumed.
 187  * Returns string in UTF-16 encoding. A NUL terminator is always written
 188  * for convenience, and isn't included in the output @text_size.
 189  *
 190  * Returns: full length of the requested string, or 0 if not found.
 191  * Since: 2.1.0
 192  **/
 193 unsigned int
 194 hb_ot_name_get_utf16 (hb_face_t       *face,
 195                       hb_ot_name_id_t  name_id,
 196                       hb_language_t    language,
 197                       unsigned int    *text_size /* IN/OUT */,
 198                       uint16_t        *text      /* OUT */)
 199 {
 200   return hb_ot_name_get_utf<hb_utf16_t> (face, name_id, language, text_size, text);
 201 }
 202
 203 /**
 204  * hb_ot_name_get_utf32:
 205  * @face: font face.
 206  * @name_id: OpenType name identifier to fetch.
 207  * @language: language to fetch the name for.
 208  * @text_size: (inout) (optional): input size of @text buffer, and output size of
 209  *                                   text written to buffer.
 210  * @text: (out caller-allocates) (array length=text_size): buffer to write fetched name into.
 211  *
 212  * Fetches a font name from the OpenType 'name' table.
 213  * If @language is #HB_LANGUAGE_INVALID, English ("en") is assumed.
 214  * Returns string in UTF-32 encoding. A NUL terminator is always written
 215  * for convenience, and isn't included in the output @text_size.
 216  *
 217  * Returns: full length of the requested string, or 0 if not found.
 218  * Since: 2.1.0
 219  **/
 220 unsigned int
 221 hb_ot_name_get_utf32 (hb_face_t       *face,
 222                       hb_ot_name_id_t  name_id,
 223                       hb_language_t    language,
 224                       unsigned int    *text_size /* IN/OUT */,
 225                       uint32_t        *text      /* OUT */)
 226 {
 227   return hb_ot_name_get_utf<hb_utf32_t> (face, name_id, language, text_size, text);
 228 }
 229
 230
 231 #endif