File: harfbuzz_shaper.h

package info (click to toggle)
chromium 138.0.7204.183-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 6,071,908 kB
  • sloc: cpp: 34,937,088; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,806; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (184 lines) | stat: -rw-r--r-- 7,855 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
/*
 * Copyright (C) 2012 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef THIRD_PARTY_BLINK_RENDERER_PLATFORM_FONTS_SHAPING_HARFBUZZ_SHAPER_H_
#define THIRD_PARTY_BLINK_RENDERER_PLATFORM_FONTS_SHAPING_HARFBUZZ_SHAPER_H_

#include "base/functional/callback.h"
#include "third_party/blink/renderer/platform/fonts/font_fallback_iterator.h"
#include "third_party/blink/renderer/platform/fonts/shaping/run_segmenter.h"
#include "third_party/blink/renderer/platform/fonts/shaping/shape_options.h"
#include "third_party/blink/renderer/platform/fonts/shaping/shape_result.h"
#include "third_party/blink/renderer/platform/wtf/allocator/allocator.h"
#include "third_party/blink/renderer/platform/wtf/text/wtf_string.h"
#include "third_party/blink/renderer/platform/wtf/vector.h"

namespace blink {

class Font;
class SimpleFontData;
class HarfBuzzShaper;
struct ReshapeQueueItem;
struct RangeContext;
struct BufferSlice;

class PLATFORM_EXPORT HarfBuzzShaper final {
  DISALLOW_NEW();

  using EmojiMetricsCallback =
      base::RepeatingCallback<void(unsigned, unsigned)>;

 public:
  // The optional emoji_metrics_callback argument is a mock metrics reporting
  // function used during tests. Otherwise successful and unsuccessful emoji
  // clusters are reported per Document / WorkerGlobalContext to
  // FontMatchingMetrics.
  explicit HarfBuzzShaper(
      String text,
      EmojiMetricsCallback emoji_metrics_callback = EmojiMetricsCallback())
      : text_(std::move(text)),
        emoji_metrics_reporter_for_testing_(emoji_metrics_callback) {}

  // Shape a range, defined by the start and end parameters, of the string
  // supplied to the constructor.
  // The start and end positions should represent boundaries where a break may
  // occur, such as at the beginning or end of lines or at element boundaries.
  // If given arbitrary positions the results are not guaranteed to be correct.
  // May be called multiple times; font and direction may vary between calls.
  ShapeResult* Shape(const Font*,
                     TextDirection,
                     unsigned start,
                     unsigned end) const;

  // Shape a range that has already been pre-segmented. Start and end positions
  // must match the positions defined by the ranges and must be at valid break
  // positions.
  ShapeResult* Shape(const Font*,
                     TextDirection,
                     unsigned start,
                     unsigned end,
                     const Vector<RunSegmenter::RunSegmenterRange>&,
                     ShapeOptions = ShapeOptions()) const;

  // Shape a single range. Start and end positions defined by the range.
  ShapeResult* Shape(const Font*,
                     TextDirection,
                     unsigned start,
                     unsigned end,
                     const RunSegmenter::RunSegmenterRange,
                     ShapeOptions = ShapeOptions()) const;

  // Shape the entire string with a single font and direction.
  // Equivalent to calling the range version with a start offset of zero and an
  // end offset equal to the length.
  ShapeResult* Shape(const Font*, TextDirection) const;

  const String& GetText() const { return text_; }
  unsigned TextLength() const { return text_.length(); }

  // This function is between `Shape` and `SimpleFontData::GlyphForCharacter`.
  //
  // Unlike `Shape`, it works only for one `SimpleFontData`, not `Font`, without
  // cascading nor fallback. Missing glyphs are reported as `.notdef` (0). Also
  // it's a lot less expensive than `Shape`.
  //
  // Unlike `SimpleFontData::GlyphForCharacter`, it shapes, taking locale,
  // script, and OpenType features into account.
  struct GlyphData {
    unsigned cluster;
    Glyph glyph;
    gfx::PointF advance;
    gfx::PointF offset;
  };
  using GlyphDataList = Vector<GlyphData, 16>;
  void GetGlyphData(const SimpleFontData& font_data,
                    const LayoutLocale& locale,
                    UScriptCode script,
                    bool is_horizontal,
                    GlyphDataList& glyphs);
  enum FallbackFontStage {
    // There were no unshaped variation sequences found, so we don't need to
    // perform second fallback fonts list pass.
    kIntermediate,
    kLast,
    // Found unshaped variation sequences and we are on the first fallback pass,
    // so we are including variation selectors during shaping.
    kIntermediateWithVS,
    kLastWithVS,
    // Found unshaped variation sequences and we are on the second and last
    // fallback pass, so we are ignoring variation selectors during shaping.
    kIntermediateIgnoreVS,
    kLastIgnoreVS
  };

  ~HarfBuzzShaper() = default;

 private:
  using HintCharList = FontFallbackIterator::HintCharList;

  // Shapes a single seqment, as identified by the RunSegmenterRange parameter,
  // one or more times taking font fallback into account. The start and end
  // parameters are for the entire text run, not the segment, and are used to
  // determine pre- and post-context for shaping.
  void ShapeSegment(RangeContext*,
                    const RunSegmenter::RunSegmenterRange&,
                    ShapeResult*) const;

  void ExtractShapeResults(RangeContext*,
                           bool& font_cycle_queued,
                           const ReshapeQueueItem&,
                           const SimpleFontData*,
                           UScriptCode,
                           CanvasRotationInVertical,
                           FallbackFontStage& fallback_stage,
                           ShapeResult*) const;

  bool CollectFallbackHintChars(const Deque<ReshapeQueueItem>&,
                                bool needs_hint_list,
                                HintCharList& hint) const;

  void CommitGlyphs(RangeContext*,
                    const SimpleFontData* current_font,
                    UScriptCode current_run_script,
                    CanvasRotationInVertical,
                    FallbackFontStage fallback_stage,
                    const BufferSlice&,
                    ShapeResult*) const;

  void CheckTextLen(unsigned start, unsigned length) const;
  void CheckTextEnd(unsigned start, unsigned end) const;

  const String text_;
  EmojiMetricsCallback emoji_metrics_reporter_for_testing_;
};

}  // namespace blink

#endif  // THIRD_PARTY_BLINK_RENDERER_PLATFORM_FONTS_SHAPING_HARFBUZZ_SHAPER_H_