Coverage Report

Created: 2025-08-09 06:34

/src/harfbuzz/src/OT/Layout/GPOS/PairPosFormat2.hh
Line
Count
Source (jump to first uncovered line)
1
#ifndef OT_LAYOUT_GPOS_PAIRPOSFORMAT2_HH
2
#define OT_LAYOUT_GPOS_PAIRPOSFORMAT2_HH
3
4
#include "ValueFormat.hh"
5
6
namespace OT {
7
namespace Layout {
8
namespace GPOS_impl {
9
10
template <typename Types>
11
struct PairPosFormat2_4 : ValueBase
12
{
13
  protected:
14
  HBUINT16      format;                 /* Format identifier--format = 2 */
15
  typename Types::template OffsetTo<Coverage>
16
                coverage;               /* Offset to Coverage table--from
17
                                         * beginning of subtable */
18
  ValueFormat   valueFormat1;           /* ValueRecord definition--for the
19
                                         * first glyph of the pair--may be zero
20
                                         * (0) */
21
  ValueFormat   valueFormat2;           /* ValueRecord definition--for the
22
                                         * second glyph of the pair--may be
23
                                         * zero (0) */
24
  typename Types::template OffsetTo<ClassDef>
25
                classDef1;              /* Offset to ClassDef table--from
26
                                         * beginning of PairPos subtable--for
27
                                         * the first glyph of the pair */
28
  typename Types::template OffsetTo<ClassDef>
29
                classDef2;              /* Offset to ClassDef table--from
30
                                         * beginning of PairPos subtable--for
31
                                         * the second glyph of the pair */
32
  HBUINT16      class1Count;            /* Number of classes in ClassDef1
33
                                         * table--includes Class0 */
34
  HBUINT16      class2Count;            /* Number of classes in ClassDef2
35
                                         * table--includes Class0 */
36
  ValueRecord   values;                 /* Matrix of value pairs:
37
                                         * class1-major, class2-minor,
38
                                         * Each entry has value1 and value2 */
39
  public:
40
  DEFINE_SIZE_ARRAY (10 + 3 * Types::size, values);
41
42
  bool sanitize (hb_sanitize_context_t *c) const
43
27
  {
44
27
    TRACE_SANITIZE (this);
45
27
    if (!(c->check_struct (this)
46
27
       && coverage.sanitize (c, this)
47
27
       && classDef1.sanitize (c, this)
48
27
       && classDef2.sanitize (c, this))) return_trace (false);
49
50
27
    unsigned int len1 = valueFormat1.get_len ();
51
27
    unsigned int len2 = valueFormat2.get_len ();
52
27
    unsigned int stride = HBUINT16::static_size * (len1 + len2);
53
27
    unsigned int count = (unsigned int) class1Count * (unsigned int) class2Count;
54
27
    return_trace (c->check_range ((const void *) values,
55
27
                                  count,
56
27
                                  stride) &&
57
27
      (c->lazy_some_gpos ||
58
27
       (valueFormat1.sanitize_values_stride_unsafe (c, this, &values[0], count, stride) &&
59
27
        valueFormat2.sanitize_values_stride_unsafe (c, this, &values[len1], count, stride))));
60
27
  }
61
62
  bool intersects (const hb_set_t *glyphs) const
63
0
  {
64
0
    return (this+coverage).intersects (glyphs) &&
65
0
           (this+classDef2).intersects (glyphs);
66
0
  }
67
68
0
  void closure_lookups (hb_closure_lookups_context_t *c) const {}
69
  void collect_variation_indices (hb_collect_variation_indices_context_t *c) const
70
0
  {
71
0
    if (!intersects (c->glyph_set)) return;
72
0
    if ((!valueFormat1.has_device ()) && (!valueFormat2.has_device ())) return;
73
0
74
0
    hb_set_t klass1_glyphs, klass2_glyphs;
75
0
    if (!(this+classDef1).collect_coverage (&klass1_glyphs)) return;
76
0
    if (!(this+classDef2).collect_coverage (&klass2_glyphs)) return;
77
0
78
0
    hb_set_t class1_set, class2_set;
79
0
    for (const unsigned cp : + c->glyph_set->iter () | hb_filter (this + coverage))
80
0
    {
81
0
      if (!klass1_glyphs.has (cp)) class1_set.add (0);
82
0
      else
83
0
      {
84
0
        unsigned klass1 = (this+classDef1).get (cp);
85
0
        class1_set.add (klass1);
86
0
      }
87
0
    }
88
0
89
0
    class2_set.add (0);
90
0
    for (const unsigned cp : + c->glyph_set->iter () | hb_filter (klass2_glyphs))
91
0
    {
92
0
      unsigned klass2 = (this+classDef2).get (cp);
93
0
      class2_set.add (klass2);
94
0
    }
95
0
96
0
    if (class1_set.is_empty ()
97
0
        || class2_set.is_empty ()
98
0
        || (class2_set.get_population() == 1 && class2_set.has(0)))
99
0
      return;
100
0
101
0
    unsigned len1 = valueFormat1.get_len ();
102
0
    unsigned len2 = valueFormat2.get_len ();
103
0
    const hb_array_t<const Value> values_array = values.as_array ((unsigned)class1Count * (unsigned) class2Count * (len1 + len2));
104
0
    for (const unsigned class1_idx : class1_set.iter ())
105
0
    {
106
0
      for (const unsigned class2_idx : class2_set.iter ())
107
0
      {
108
0
        unsigned start_offset = (class1_idx * (unsigned) class2Count + class2_idx) * (len1 + len2);
109
0
        if (valueFormat1.has_device ())
110
0
          valueFormat1.collect_variation_indices (c, this, values_array.sub_array (start_offset, len1));
111
0
112
0
        if (valueFormat2.has_device ())
113
0
          valueFormat2.collect_variation_indices (c, this, values_array.sub_array (start_offset+len1, len2));
114
0
      }
115
0
    }
116
0
  }
117
118
  void collect_glyphs (hb_collect_glyphs_context_t *c) const
119
0
  {
120
0
    if (unlikely (!(this+coverage).collect_coverage (c->input))) return;
121
0
    if (unlikely (!(this+classDef2).collect_coverage (c->input))) return;
122
0
  }
123
124
0
  const Coverage &get_coverage () const { return this+coverage; }
125
126
  struct pair_pos_cache_t
127
  {
128
    hb_ot_layout_mapping_cache_t coverage;
129
    hb_ot_layout_mapping_cache_t first;
130
    hb_ot_layout_mapping_cache_t second;
131
  };
132
133
  unsigned cache_cost () const
134
0
  {
135
0
    return (this+coverage).cost () + (this+classDef1).cost () + (this+classDef2).cost ();
136
0
  }
137
  static void * cache_func (void *p, hb_ot_subtable_cache_op_t op)
138
0
  {
139
0
    switch (op)
140
0
    {
141
0
      case hb_ot_subtable_cache_op_t::CREATE:
142
0
      {
143
0
  pair_pos_cache_t *cache = (pair_pos_cache_t *) hb_malloc (sizeof (pair_pos_cache_t));
144
0
  if (likely (cache))
145
0
  {
146
0
    cache->coverage.clear ();
147
0
    cache->first.clear ();
148
0
    cache->second.clear ();
149
0
  }
150
0
  return cache;
151
0
      }
152
0
      case hb_ot_subtable_cache_op_t::ENTER:
153
0
  return (void *) true;
154
0
      case hb_ot_subtable_cache_op_t::LEAVE:
155
0
  return nullptr;
156
0
      case hb_ot_subtable_cache_op_t::DESTROY:
157
0
  {
158
0
    pair_pos_cache_t *cache = (pair_pos_cache_t *) p;
159
0
    hb_free (cache);
160
0
    return nullptr;
161
0
  }
162
0
    }
163
0
    return nullptr;
164
0
  }
165
166
0
  bool apply_cached (hb_ot_apply_context_t *c) const { return _apply (c, true); }
167
0
  bool apply (hb_ot_apply_context_t *c) const { return _apply (c, false); }
168
  bool _apply (hb_ot_apply_context_t *c, bool cached) const
169
0
  {
170
0
    TRACE_APPLY (this);
171
172
0
    hb_buffer_t *buffer = c->buffer;
173
174
0
#ifndef HB_NO_OT_LAYOUT_LOOKUP_CACHE
175
0
    pair_pos_cache_t *cache = cached ? (pair_pos_cache_t *) c->lookup_accel->subtable_cache : nullptr;
176
0
    unsigned int index = (this+coverage).get_coverage  (buffer->cur().codepoint, cache ? &cache->coverage : nullptr);
177
#else
178
    unsigned int index = (this+coverage).get_coverage  (buffer->cur().codepoint);
179
#endif
180
0
    if (index == NOT_COVERED) return_trace (false);
181
182
0
    auto &skippy_iter = c->iter_input;
183
0
    skippy_iter.reset_fast (buffer->idx);
184
0
    unsigned unsafe_to;
185
0
    if (unlikely (!skippy_iter.next (&unsafe_to)))
186
0
    {
187
0
      buffer->unsafe_to_concat (buffer->idx, unsafe_to);
188
0
      return_trace (false);
189
0
    }
190
191
0
#ifndef HB_NO_OT_LAYOUT_LOOKUP_CACHE
192
0
    unsigned int klass1 = (this+classDef1).get_class (buffer->cur().codepoint, cache ? &cache->first : nullptr);
193
0
    unsigned int klass2 = (this+classDef2).get_class (buffer->info[skippy_iter.idx].codepoint, cache ? &cache->second : nullptr);
194
#else
195
    unsigned int klass1 = (this+classDef1).get_class (buffer->cur().codepoint);
196
    unsigned int klass2 = (this+classDef2).get_class (buffer->info[skippy_iter.idx].codepoint);
197
#endif
198
0
    if (unlikely (klass1 >= class1Count || klass2 >= class2Count))
199
0
    {
200
0
      buffer->unsafe_to_concat (buffer->idx, skippy_iter.idx + 1);
201
0
      return_trace (false);
202
0
    }
203
204
0
    unsigned int len1 = valueFormat1.get_len ();
205
0
    unsigned int len2 = valueFormat2.get_len ();
206
0
    unsigned int record_len = len1 + len2;
207
208
0
    const Value *v = &values[record_len * (klass1 * class2Count + klass2)];
209
210
0
    bool applied_first = false, applied_second = false;
211
212
213
    /* Isolate simple kerning and apply it half to each side.
214
     * Results in better cursor positioning / underline drawing.
215
     *
216
     * Disabled, because causes issues... :-(
217
     * https://github.com/harfbuzz/harfbuzz/issues/3408
218
     * https://github.com/harfbuzz/harfbuzz/pull/3235#issuecomment-1029814978
219
     */
220
0
#ifndef HB_SPLIT_KERN
221
0
    if (false)
222
0
#endif
223
0
    {
224
0
      if (!len2)
225
0
      {
226
0
        const hb_direction_t dir = buffer->props.direction;
227
0
        const bool horizontal = HB_DIRECTION_IS_HORIZONTAL (dir);
228
0
        const bool backward = HB_DIRECTION_IS_BACKWARD (dir);
229
0
        unsigned mask = horizontal ? ValueFormat::xAdvance : ValueFormat::yAdvance;
230
0
        if (backward)
231
0
          mask |= mask >> 2; /* Add eg. xPlacement in RTL. */
232
        /* Add Devices. */
233
0
        mask |= mask << 4;
234
235
0
        if (valueFormat1 & ~mask)
236
0
          goto bail;
237
238
        /* Is simple kern. Apply value on an empty position slot,
239
         * then split it between sides. */
240
241
0
        hb_glyph_position_t pos{};
242
0
        if (valueFormat1.apply_value (c, this, v, pos))
243
0
        {
244
0
          hb_position_t *src  = &pos.x_advance;
245
0
          hb_position_t *dst1 = &buffer->cur_pos().x_advance;
246
0
          hb_position_t *dst2 = &buffer->pos[skippy_iter.idx].x_advance;
247
0
          unsigned i = horizontal ? 0 : 1;
248
249
0
          hb_position_t kern  = src[i];
250
0
          hb_position_t kern1 = kern >> 1;
251
0
          hb_position_t kern2 = kern - kern1;
252
253
0
          if (!backward)
254
0
          {
255
0
            dst1[i] += kern1;
256
0
            dst2[i] += kern2;
257
0
            dst2[i + 2] += kern2;
258
0
          }
259
0
          else
260
0
          {
261
0
            dst1[i] += kern1;
262
0
            dst1[i + 2] += src[i + 2] - kern2;
263
0
            dst2[i] += kern2;
264
0
          }
265
266
0
          applied_first = applied_second = kern != 0;
267
0
          goto success;
268
0
        }
269
0
        goto boring;
270
0
      }
271
0
    }
272
0
    bail:
273
274
0
    if (HB_BUFFER_MESSAGE_MORE && c->buffer->messaging ())
275
0
    {
276
0
      c->buffer->message (c->font,
277
0
        "try kerning glyphs at %u,%u",
278
0
        c->buffer->idx, skippy_iter.idx);
279
0
    }
280
281
0
    applied_first = len1 && valueFormat1.apply_value (c, this, v, buffer->cur_pos());
282
0
    applied_second = len2 && valueFormat2.apply_value (c, this, v + len1, buffer->pos[skippy_iter.idx]);
283
284
0
    if (applied_first || applied_second)
285
0
      if (HB_BUFFER_MESSAGE_MORE && c->buffer->messaging ())
286
0
      {
287
0
  c->buffer->message (c->font,
288
0
          "kerned glyphs at %u,%u",
289
0
          c->buffer->idx, skippy_iter.idx);
290
0
      }
291
292
0
    if (HB_BUFFER_MESSAGE_MORE && c->buffer->messaging ())
293
0
    {
294
0
      c->buffer->message (c->font,
295
0
        "tried kerning glyphs at %u,%u",
296
0
        c->buffer->idx, skippy_iter.idx);
297
0
    }
298
299
0
    success:
300
0
    if (applied_first || applied_second)
301
0
      buffer->unsafe_to_break (buffer->idx, skippy_iter.idx + 1);
302
0
    else
303
0
    boring:
304
0
      buffer->unsafe_to_concat (buffer->idx, skippy_iter.idx + 1);
305
306
0
    if (len2)
307
0
    {
308
0
      skippy_iter.idx++;
309
      // https://github.com/harfbuzz/harfbuzz/issues/3824
310
      // https://github.com/harfbuzz/harfbuzz/issues/3888#issuecomment-1326781116
311
0
      buffer->unsafe_to_break (buffer->idx, skippy_iter.idx + 1);
312
0
    }
313
314
0
    buffer->idx = skippy_iter.idx;
315
316
0
    return_trace (true);
317
0
  }
318
319
  bool subset (hb_subset_context_t *c) const
320
0
  {
321
0
    TRACE_SUBSET (this);
322
0
    auto *out = c->serializer->start_embed (*this);
323
0
    if (unlikely (!c->serializer->extend_min (out))) return_trace (false);
324
0
    out->format = format;
325
0
326
0
    hb_map_t klass1_map;
327
0
    out->classDef1.serialize_subset (c, classDef1, this, &klass1_map, true, true, &(this + coverage));
328
0
    out->class1Count = klass1_map.get_population ();
329
0
330
0
    hb_map_t klass2_map;
331
0
    out->classDef2.serialize_subset (c, classDef2, this, &klass2_map, true, false);
332
0
    out->class2Count = klass2_map.get_population ();
333
0
334
0
    unsigned len1 = valueFormat1.get_len ();
335
0
    unsigned len2 = valueFormat2.get_len ();
336
0
337
0
    hb_pair_t<unsigned, unsigned> newFormats = hb_pair (valueFormat1, valueFormat2);
338
0
339
0
    if (c->plan->normalized_coords)
340
0
    {
341
0
      /* in case of full instancing, all var device flags will be dropped so no
342
0
       * need to strip hints here */
343
0
      newFormats = compute_effective_value_formats (klass1_map, klass2_map, false, false, &c->plan->layout_variation_idx_delta_map);
344
0
    }
345
0
    /* do not strip hints for VF */
346
0
    else if (c->plan->flags & HB_SUBSET_FLAGS_NO_HINTING)
347
0
    {
348
0
      hb_blob_t* blob = hb_face_reference_table (c->plan->source, HB_TAG ('f','v','a','r'));
349
0
      bool has_fvar = (blob != hb_blob_get_empty ());
350
0
      hb_blob_destroy (blob);
351
0
352
0
      bool strip = !has_fvar;
353
0
      /* special case: strip hints when a VF has no GDEF varstore after
354
0
       * subsetting*/
355
0
      if (has_fvar && !c->plan->has_gdef_varstore)
356
0
        strip = true;
357
0
      newFormats = compute_effective_value_formats (klass1_map, klass2_map, strip, true);
358
0
    }
359
0
360
0
    out->valueFormat1 = newFormats.first;
361
0
    out->valueFormat2 = newFormats.second;
362
0
363
0
    unsigned total_len = len1 + len2;
364
0
    hb_vector_t<unsigned> class2_idxs (+ hb_range ((unsigned) class2Count) | hb_filter (klass2_map));
365
0
    for (unsigned class1_idx : + hb_range ((unsigned) class1Count) | hb_filter (klass1_map))
366
0
    {
367
0
      for (unsigned class2_idx : class2_idxs)
368
0
      {
369
0
        unsigned idx = (class1_idx * (unsigned) class2Count + class2_idx) * total_len;
370
0
        valueFormat1.copy_values (c->serializer, out->valueFormat1, this, &values[idx], &c->plan->layout_variation_idx_delta_map);
371
0
        valueFormat2.copy_values (c->serializer, out->valueFormat2, this, &values[idx + len1], &c->plan->layout_variation_idx_delta_map);
372
0
      }
373
0
    }
374
0
375
0
    bool ret = out->coverage.serialize_subset(c, coverage, this);
376
0
    return_trace (out->class1Count && out->class2Count && ret);
377
0
  }
378
379
380
  hb_pair_t<unsigned, unsigned> compute_effective_value_formats (const hb_map_t& klass1_map,
381
                                                                 const hb_map_t& klass2_map,
382
                                                                 bool strip_hints, bool strip_empty,
383
                                                                 const hb_hashmap_t<unsigned, hb_pair_t<unsigned, int>> *varidx_delta_map = nullptr) const
384
0
  {
385
0
    unsigned len1 = valueFormat1.get_len ();
386
0
    unsigned len2 = valueFormat2.get_len ();
387
0
    unsigned record_size = len1 + len2;
388
0
389
0
    unsigned format1 = 0;
390
0
    unsigned format2 = 0;
391
0
392
0
    for (unsigned class1_idx : + hb_range ((unsigned) class1Count) | hb_filter (klass1_map))
393
0
    {
394
0
      for (unsigned class2_idx : + hb_range ((unsigned) class2Count) | hb_filter (klass2_map))
395
0
      {
396
0
        unsigned idx = (class1_idx * (unsigned) class2Count + class2_idx) * record_size;
397
0
        format1 = format1 | valueFormat1.get_effective_format (&values[idx], strip_hints, strip_empty, this, varidx_delta_map);
398
0
        format2 = format2 | valueFormat2.get_effective_format (&values[idx + len1], strip_hints, strip_empty, this, varidx_delta_map);
399
0
      }
400
0
401
0
      if (format1 == valueFormat1 && format2 == valueFormat2)
402
0
        break;
403
0
    }
404
0
405
0
    return hb_pair (format1, format2);
406
0
  }
407
};
408
409
}
410
}
411
}
412
413
#endif  // OT_LAYOUT_GPOS_PAIRPOSFORMAT2_HH