bungeman@google.com | bbe5013 | 2012-07-24 20:33:21 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2006 The Android Open Source Project |
| 3 | * |
| 4 | * Use of this source code is governed by a BSD-style license that can be |
| 5 | * found in the LICENSE file. |
| 6 | */ |
| 7 | |
| 8 | #ifndef SkGlyph_DEFINED |
| 9 | #define SkGlyph_DEFINED |
| 10 | |
herb | c71239b | 2015-07-21 15:36:25 -0700 | [diff] [blame] | 11 | #include "SkChecksum.h" |
bungeman@google.com | bbe5013 | 2012-07-24 20:33:21 +0000 | [diff] [blame] | 12 | #include "SkFixed.h" |
| 13 | #include "SkMask.h" |
Herbert Derby | 9bd8346 | 2018-11-30 15:40:55 -0500 | [diff] [blame] | 14 | #include "SkPath.h" |
Hal Canary | c640d0d | 2018-06-13 09:59:02 -0400 | [diff] [blame] | 15 | #include "SkTo.h" |
Herb Derby | 7c5a806 | 2017-01-20 11:59:03 -0500 | [diff] [blame] | 16 | #include "SkTypes.h" |
| 17 | |
Herb Derby | 8219163 | 2018-10-24 14:49:26 -0400 | [diff] [blame] | 18 | class SkArenaAlloc; |
herb | b69d0e0 | 2015-02-25 06:47:06 -0800 | [diff] [blame] | 19 | class SkGlyphCache; |
Herb Derby | f4958ce | 2018-11-27 13:17:02 -0500 | [diff] [blame] | 20 | class SkScalerContext; |
bungeman@google.com | bbe5013 | 2012-07-24 20:33:21 +0000 | [diff] [blame] | 21 | |
| 22 | // needs to be != to any valid SkMask::Format |
| 23 | #define MASK_FORMAT_UNKNOWN (0xFF) |
| 24 | #define MASK_FORMAT_JUST_ADVANCE MASK_FORMAT_UNKNOWN |
| 25 | |
| 26 | #define kMaxGlyphWidth (1<<13) |
| 27 | |
Ben Wagner | 6e9ac12 | 2016-11-11 14:31:06 -0500 | [diff] [blame] | 28 | /** (glyph-index or unicode-point) + subpixel-pos */ |
| 29 | struct SkPackedID { |
| 30 | static constexpr uint32_t kImpossibleID = ~0; |
herb | b69d0e0 | 2015-02-25 06:47:06 -0800 | [diff] [blame] | 31 | enum { |
| 32 | kSubBits = 2, |
| 33 | kSubMask = ((1 << kSubBits) - 1), |
| 34 | kSubShift = 24, // must be large enough for glyphs and unichars |
| 35 | kCodeMask = ((1 << kSubShift) - 1), |
| 36 | // relative offsets for X and Y subpixel bits |
| 37 | kSubShiftX = kSubBits, |
| 38 | kSubShiftY = 0 |
| 39 | }; |
| 40 | |
Ben Wagner | 6e9ac12 | 2016-11-11 14:31:06 -0500 | [diff] [blame] | 41 | SkPackedID(uint32_t code) { |
| 42 | SkASSERT(code <= kCodeMask); |
| 43 | SkASSERT(code != kImpossibleID); |
| 44 | fID = code; |
| 45 | } |
| 46 | |
| 47 | SkPackedID(uint32_t code, SkFixed x, SkFixed y) { |
| 48 | SkASSERT(code <= kCodeMask); |
| 49 | x = FixedToSub(x); |
| 50 | y = FixedToSub(y); |
| 51 | uint32_t ID = (x << (kSubShift + kSubShiftX)) | |
| 52 | (y << (kSubShift + kSubShiftY)) | |
| 53 | code; |
| 54 | SkASSERT(ID != kImpossibleID); |
| 55 | fID = ID; |
| 56 | } |
| 57 | |
| 58 | constexpr SkPackedID() : fID(kImpossibleID) {} |
| 59 | |
| 60 | bool operator==(const SkPackedID& that) const { |
| 61 | return fID == that.fID; |
| 62 | } |
| 63 | bool operator!=(const SkPackedID& that) const { |
| 64 | return !(*this == that); |
| 65 | } |
Herb Derby | efbf00c | 2018-03-14 11:53:40 -0400 | [diff] [blame] | 66 | bool operator<(SkPackedID that) const { |
| 67 | return this->fID < that.fID; |
| 68 | } |
Ben Wagner | 6e9ac12 | 2016-11-11 14:31:06 -0500 | [diff] [blame] | 69 | |
| 70 | uint32_t code() const { |
| 71 | return fID & kCodeMask; |
| 72 | } |
| 73 | |
Herb Derby | 8219163 | 2018-10-24 14:49:26 -0400 | [diff] [blame] | 74 | uint32_t value() const { |
Herb Derby | efbf00c | 2018-03-14 11:53:40 -0400 | [diff] [blame] | 75 | return fID; |
| 76 | } |
| 77 | |
Ben Wagner | 6e9ac12 | 2016-11-11 14:31:06 -0500 | [diff] [blame] | 78 | SkFixed getSubXFixed() const { |
| 79 | return SubToFixed(ID2SubX(fID)); |
| 80 | } |
| 81 | |
| 82 | SkFixed getSubYFixed() const { |
| 83 | return SubToFixed(ID2SubY(fID)); |
| 84 | } |
| 85 | |
| 86 | uint32_t hash() const { |
| 87 | return SkChecksum::CheapMix(fID); |
| 88 | } |
| 89 | |
Khushal | 4010c79 | 2018-06-13 09:44:23 -0700 | [diff] [blame] | 90 | SkString dump() const { |
| 91 | SkString str; |
| 92 | str.appendf("code: %d, x: %d, y:%d", code(), getSubXFixed(), getSubYFixed()); |
| 93 | return str; |
| 94 | } |
| 95 | |
Ben Wagner | 6e9ac12 | 2016-11-11 14:31:06 -0500 | [diff] [blame] | 96 | private: |
| 97 | static unsigned ID2SubX(uint32_t id) { |
| 98 | return id >> (kSubShift + kSubShiftX); |
| 99 | } |
| 100 | |
| 101 | static unsigned ID2SubY(uint32_t id) { |
| 102 | return (id >> (kSubShift + kSubShiftY)) & kSubMask; |
| 103 | } |
| 104 | |
| 105 | static unsigned FixedToSub(SkFixed n) { |
| 106 | return (n >> (16 - kSubBits)) & kSubMask; |
| 107 | } |
| 108 | |
| 109 | static SkFixed SubToFixed(unsigned sub) { |
| 110 | SkASSERT(sub <= kSubMask); |
| 111 | return sub << (16 - kSubBits); |
| 112 | } |
| 113 | |
| 114 | uint32_t fID; |
| 115 | }; |
| 116 | |
| 117 | struct SkPackedGlyphID : public SkPackedID { |
| 118 | SkPackedGlyphID(SkGlyphID code) : SkPackedID(code) { } |
| 119 | SkPackedGlyphID(SkGlyphID code, SkFixed x, SkFixed y) : SkPackedID(code, x, y) { } |
Herb Derby | d2fec23 | 2018-08-23 18:44:45 -0400 | [diff] [blame] | 120 | SkPackedGlyphID(SkGlyphID code, SkIPoint pt) : SkPackedID(code, pt.x(), pt.y()) { } |
Herb Derby | 8219163 | 2018-10-24 14:49:26 -0400 | [diff] [blame] | 121 | constexpr SkPackedGlyphID() = default; |
Ben Wagner | 6e9ac12 | 2016-11-11 14:31:06 -0500 | [diff] [blame] | 122 | SkGlyphID code() const { |
| 123 | return SkTo<SkGlyphID>(SkPackedID::code()); |
| 124 | } |
| 125 | }; |
| 126 | |
| 127 | struct SkPackedUnicharID : public SkPackedID { |
| 128 | SkPackedUnicharID(SkUnichar code) : SkPackedID(code) { } |
| 129 | SkPackedUnicharID(SkUnichar code, SkFixed x, SkFixed y) : SkPackedID(code, x, y) { } |
Herb Derby | 8219163 | 2018-10-24 14:49:26 -0400 | [diff] [blame] | 130 | constexpr SkPackedUnicharID() = default; |
Ben Wagner | 6e9ac12 | 2016-11-11 14:31:06 -0500 | [diff] [blame] | 131 | SkUnichar code() const { |
| 132 | return SkTo<SkUnichar>(SkPackedID::code()); |
| 133 | } |
| 134 | }; |
| 135 | |
Ben Wagner | 6e9ac12 | 2016-11-11 14:31:06 -0500 | [diff] [blame] | 136 | class SkGlyph { |
Herb Derby | 8219163 | 2018-10-24 14:49:26 -0400 | [diff] [blame] | 137 | struct PathData; |
| 138 | |
| 139 | public: |
Herb Derby | f6fca26 | 2019-01-09 15:13:54 -0500 | [diff] [blame] | 140 | constexpr explicit SkGlyph(SkPackedGlyphID id = dotUndef) : fID{id} {} |
Herb Derby | 8219163 | 2018-10-24 14:49:26 -0400 | [diff] [blame] | 141 | static constexpr SkFixed kSubpixelRound = SK_FixedHalf >> SkPackedID::kSubBits; |
| 142 | |
| 143 | bool isEmpty() const { return fWidth == 0 || fHeight == 0; } |
| 144 | bool isJustAdvance() const { return MASK_FORMAT_JUST_ADVANCE == fMaskFormat; } |
| 145 | bool isFullMetrics() const { return MASK_FORMAT_JUST_ADVANCE != fMaskFormat; } |
| 146 | SkGlyphID getGlyphID() const { return fID.code(); } |
| 147 | SkPackedGlyphID getPackedID() const { return fID; } |
| 148 | SkFixed getSubXFixed() const { return fID.getSubXFixed(); } |
| 149 | SkFixed getSubYFixed() const { return fID.getSubYFixed(); } |
| 150 | |
Herb Derby | f6fca26 | 2019-01-09 15:13:54 -0500 | [diff] [blame] | 151 | void reset(SkPackedGlyphID glyphID) { |
| 152 | this->SkGlyph::~SkGlyph(); |
| 153 | new (this) SkGlyph{glyphID}; |
| 154 | } |
Herb Derby | 8219163 | 2018-10-24 14:49:26 -0400 | [diff] [blame] | 155 | size_t formatAlignment() const; |
| 156 | size_t allocImage(SkArenaAlloc* alloc); |
| 157 | size_t rowBytes() const; |
| 158 | size_t computeImageSize() const; |
| 159 | size_t rowBytesUsingFormat(SkMask::Format format) const; |
| 160 | |
| 161 | // Call this to set all of the metrics fields to 0 (e.g. if the scaler |
| 162 | // encounters an error measuring a glyph). Note: this does not alter the |
| 163 | // fImage, fPath, fID, fMaskFormat fields. |
| 164 | void zeroMetrics(); |
| 165 | |
| 166 | void toMask(SkMask* mask) const; |
| 167 | |
Herb Derby | f4958ce | 2018-11-27 13:17:02 -0500 | [diff] [blame] | 168 | SkPath* addPath(SkScalerContext*, SkArenaAlloc*); |
| 169 | |
Herbert Derby | 7218f1f | 2018-11-30 11:15:46 -0500 | [diff] [blame] | 170 | SkPath* path() const { |
Herbert Derby | 9bd8346 | 2018-11-30 15:40:55 -0500 | [diff] [blame] | 171 | return fPathData != nullptr && fPathData->fHasPath ? &fPathData->fPath : nullptr; |
Herbert Derby | 7218f1f | 2018-11-30 11:15:46 -0500 | [diff] [blame] | 172 | } |
| 173 | |
Herb Derby | 8219163 | 2018-10-24 14:49:26 -0400 | [diff] [blame] | 174 | // Returns the size allocated on the arena. |
| 175 | size_t copyImageData(const SkGlyph& from, SkArenaAlloc* alloc); |
| 176 | |
Herb Derby | 8219163 | 2018-10-24 14:49:26 -0400 | [diff] [blame] | 177 | void* fImage = nullptr; |
Herb Derby | f4958ce | 2018-11-27 13:17:02 -0500 | [diff] [blame] | 178 | |
| 179 | // Path data has tricky state. If the glyph isEmpty, then fPathData should always be nullptr, |
| 180 | // else if fPathData is not null, then a path has been requested. The fPath field of fPathData |
| 181 | // may still be null after the request meaning that there is no path for this glyph. |
Herb Derby | 8219163 | 2018-10-24 14:49:26 -0400 | [diff] [blame] | 182 | PathData* fPathData = nullptr; |
| 183 | |
| 184 | // The advance for this glyph. |
| 185 | float fAdvanceX = 0, |
| 186 | fAdvanceY = 0; |
| 187 | |
| 188 | // The width and height of the glyph mask. |
| 189 | uint16_t fWidth = 0, |
| 190 | fHeight = 0; |
| 191 | |
| 192 | // The offset from the glyphs origin on the baseline to the top left of the glyph mask. |
| 193 | int16_t fTop = 0, |
| 194 | fLeft = 0; |
| 195 | |
| 196 | // Used by the GDI scaler to track state. |
| 197 | int8_t fForceBW = 0; |
| 198 | |
| 199 | // This is a combination of SkMask::Format and SkGlyph state. The SkGlyph can be in one of two |
| 200 | // states, just the advances have been calculated, and all the metrics are available. The |
| 201 | // illegal mask format is used to signal that only the advances are available. |
Herb Derby | f6fca26 | 2019-01-09 15:13:54 -0500 | [diff] [blame] | 202 | uint8_t fMaskFormat = MASK_FORMAT_UNKNOWN; |
Herb Derby | 8219163 | 2018-10-24 14:49:26 -0400 | [diff] [blame] | 203 | |
| 204 | private: |
Herb Derby | f6fca26 | 2019-01-09 15:13:54 -0500 | [diff] [blame] | 205 | |
| 206 | // The undefined glyph, which seems to be perfectly well defined. |
| 207 | static constexpr SkGlyphID dotUndef = 0; |
| 208 | |
caryclark | 0449bcf | 2016-02-09 13:25:45 -0800 | [diff] [blame] | 209 | // Support horizontal and vertical skipping strike-through / underlines. |
| 210 | // The caller walks the linked list looking for a match. For a horizontal underline, |
| 211 | // the fBounds contains the top and bottom of the underline. The fInterval pair contains the |
| 212 | // beginning and end of of the intersection of the bounds and the glyph's path. |
| 213 | // If interval[0] >= interval[1], no intesection was found. |
| 214 | struct Intercept { |
| 215 | Intercept* fNext; |
| 216 | SkScalar fBounds[2]; // for horz underlines, the boundaries in Y |
| 217 | SkScalar fInterval[2]; // the outside intersections of the axis and the glyph |
| 218 | }; |
| 219 | |
| 220 | struct PathData { |
Herbert Derby | 9bd8346 | 2018-11-30 15:40:55 -0500 | [diff] [blame] | 221 | Intercept* fIntercept{nullptr}; |
| 222 | SkPath fPath; |
| 223 | bool fHasPath{false}; |
caryclark | 0449bcf | 2016-02-09 13:25:45 -0800 | [diff] [blame] | 224 | }; |
| 225 | |
herb | b69d0e0 | 2015-02-25 06:47:06 -0800 | [diff] [blame] | 226 | // TODO(herb) remove friend statement after SkGlyphCache cleanup. |
| 227 | friend class SkGlyphCache; |
Ben Wagner | 6e9ac12 | 2016-11-11 14:31:06 -0500 | [diff] [blame] | 228 | SkPackedGlyphID fID; |
bungeman@google.com | bbe5013 | 2012-07-24 20:33:21 +0000 | [diff] [blame] | 229 | }; |
bungeman@google.com | bbe5013 | 2012-07-24 20:33:21 +0000 | [diff] [blame] | 230 | |
| 231 | #endif |