/src/skia/include/core/SkFontMetrics.h

Source (jump to first uncovered line)
/*
 * Copyright 2018 Google Inc.
 *
 * Use of this source code is governed by a BSD-style license that can be
 * found in the LICENSE file.
 */

#ifndef SkFontMetrics_DEFINED
#define SkFontMetrics_DEFINED

#include "include/core/SkScalar.h"
#include "include/private/base/SkTo.h"

/** \class SkFontMetrics
    The metrics of an SkFont.
    The metric values are consistent with the Skia y-down coordinate system.
 */
struct SK_API SkFontMetrics {
    bool operator==(const SkFontMetrics& that) const {
        return
        this->fFlags == that.fFlags &&
        this->fTop == that.fTop &&
        this->fAscent == that.fAscent &&
        this->fDescent == that.fDescent &&
        this->fBottom == that.fBottom &&
        this->fLeading == that.fLeading &&
        this->fAvgCharWidth == that.fAvgCharWidth &&
        this->fMaxCharWidth == that.fMaxCharWidth &&
        this->fXMin == that.fXMin &&
        this->fXMax == that.fXMax &&
        this->fXHeight == that.fXHeight &&
        this->fCapHeight == that.fCapHeight &&
        this->fUnderlineThickness == that.fUnderlineThickness &&
        this->fUnderlinePosition == that.fUnderlinePosition &&
        this->fStrikeoutThickness == that.fStrikeoutThickness &&
        this->fStrikeoutPosition == that.fStrikeoutPosition;
    }

    /** \enum FontMetricsFlags
     FontMetricsFlags indicate when certain metrics are valid;
     the underline or strikeout metrics may be valid and zero.
     Fonts with embedded bitmaps may not have valid underline or strikeout metrics.
     */
    enum FontMetricsFlags {
        kUnderlineThicknessIsValid_Flag = 1 << 0, //!< set if fUnderlineThickness is valid
        kUnderlinePositionIsValid_Flag  = 1 << 1, //!< set if fUnderlinePosition is valid
        kStrikeoutThicknessIsValid_Flag = 1 << 2, //!< set if fStrikeoutThickness is valid
        kStrikeoutPositionIsValid_Flag  = 1 << 3, //!< set if fStrikeoutPosition is valid
        kBoundsInvalid_Flag             = 1 << 4, //!< set if fTop, fBottom, fXMin, fXMax invalid
    };

    uint32_t fFlags;              //!< FontMetricsFlags indicating which metrics are valid
    SkScalar fTop;                //!< greatest extent above origin of any glyph bounding box, typically negative; deprecated with variable fonts
    SkScalar fAscent;             //!< distance to reserve above baseline, typically negative
    SkScalar fDescent;            //!< distance to reserve below baseline, typically positive
    SkScalar fBottom;             //!< greatest extent below origin of any glyph bounding box, typically positive; deprecated with variable fonts
    SkScalar fLeading;            //!< distance to add between lines, typically positive or zero
    SkScalar fAvgCharWidth;       //!< average character width, zero if unknown
    SkScalar fMaxCharWidth;       //!< maximum character width, zero if unknown
    SkScalar fXMin;               //!< greatest extent to left of origin of any glyph bounding box, typically negative; deprecated with variable fonts
    SkScalar fXMax;               //!< greatest extent to right of origin of any glyph bounding box, typically positive; deprecated with variable fonts
    SkScalar fXHeight;            //!< height of lower-case 'x', zero if unknown, typically negative
    SkScalar fCapHeight;          //!< height of an upper-case letter, zero if unknown, typically negative
    SkScalar fUnderlineThickness; //!< underline thickness
    SkScalar fUnderlinePosition;  //!< distance from baseline to top of stroke, typically positive
    SkScalar fStrikeoutThickness; //!< strikeout thickness
    SkScalar fStrikeoutPosition;  //!< distance from baseline to bottom of stroke, typically negative

    /** Returns true if SkFontMetrics has a valid underline thickness, and sets
     thickness to that value. If the underline thickness is not valid,
     return false, and ignore thickness.

     @param thickness  storage for underline width
     @return           true if font specifies underline width
     */
    bool hasUnderlineThickness(SkScalar* thickness) const {
        if (SkToBool(fFlags & kUnderlineThicknessIsValid_Flag)) {
            *thickness = fUnderlineThickness;
            return true;
        }
        return false;
    }

    /** Returns true if SkFontMetrics has a valid underline position, and sets
     position to that value. If the underline position is not valid,
     return false, and ignore position.

     @param position  storage for underline position
     @return          true if font specifies underline position
     */
    bool hasUnderlinePosition(SkScalar* position) const {
        if (SkToBool(fFlags & kUnderlinePositionIsValid_Flag)) {
            *position = fUnderlinePosition;
            return true;
        }
        return false;
    }

    /** Returns true if SkFontMetrics has a valid strikeout thickness, and sets
     thickness to that value. If the underline thickness is not valid,
     return false, and ignore thickness.

     @param thickness  storage for strikeout width
     @return           true if font specifies strikeout width
     */
    bool hasStrikeoutThickness(SkScalar* thickness) const {
        if (SkToBool(fFlags & kStrikeoutThicknessIsValid_Flag)) {
            *thickness = fStrikeoutThickness;
            return true;
        }
        return false;
    }

    /** Returns true if SkFontMetrics has a valid strikeout position, and sets
     position to that value. If the underline position is not valid,
     return false, and ignore position.

     @param position  storage for strikeout position
     @return          true if font specifies strikeout position
     */
    bool hasStrikeoutPosition(SkScalar* position) const {
        if (SkToBool(fFlags & kStrikeoutPositionIsValid_Flag)) {
            *position = fStrikeoutPosition;
            return true;
        }
        return false;
    }

    /** Returns true if SkFontMetrics has a valid fTop, fBottom, fXMin, and fXMax.
     If the bounds are not valid, return false.

     @return        true if font specifies maximum glyph bounds
     */
    bool hasBounds() const {
        return !SkToBool(fFlags & kBoundsInvalid_Flag);
    }
};

#endif

Line	Count	Source (jump to first uncovered line)
1		/*
2		* Copyright 2018 Google Inc.
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 SkFontMetrics_DEFINED
9		#define SkFontMetrics_DEFINED
10
11		#include "include/core/SkScalar.h"
12		#include "include/private/base/SkTo.h"
13
14		/** \class SkFontMetrics
15		The metrics of an SkFont.
16		The metric values are consistent with the Skia y-down coordinate system.
17		*/
18		struct SK_API SkFontMetrics {
19	0	bool operator==(const SkFontMetrics& that) const {
20	0	return
21	0	this->fFlags == that.fFlags &&
22	0	this->fTop == that.fTop &&
23	0	this->fAscent == that.fAscent &&
24	0	this->fDescent == that.fDescent &&
25	0	this->fBottom == that.fBottom &&
26	0	this->fLeading == that.fLeading &&
27	0	this->fAvgCharWidth == that.fAvgCharWidth &&
28	0	this->fMaxCharWidth == that.fMaxCharWidth &&
29	0	this->fXMin == that.fXMin &&
30	0	this->fXMax == that.fXMax &&
31	0	this->fXHeight == that.fXHeight &&
32	0	this->fCapHeight == that.fCapHeight &&
33	0	this->fUnderlineThickness == that.fUnderlineThickness &&
34	0	this->fUnderlinePosition == that.fUnderlinePosition &&
35	0	this->fStrikeoutThickness == that.fStrikeoutThickness &&
36	0	this->fStrikeoutPosition == that.fStrikeoutPosition;
37	0	}
38
39		/** \enum FontMetricsFlags
40		FontMetricsFlags indicate when certain metrics are valid;
41		the underline or strikeout metrics may be valid and zero.
42		Fonts with embedded bitmaps may not have valid underline or strikeout metrics.
43		*/
44		enum FontMetricsFlags {
45		kUnderlineThicknessIsValid_Flag = 1 << 0, //!< set if fUnderlineThickness is valid
46		kUnderlinePositionIsValid_Flag = 1 << 1, //!< set if fUnderlinePosition is valid
47		kStrikeoutThicknessIsValid_Flag = 1 << 2, //!< set if fStrikeoutThickness is valid
48		kStrikeoutPositionIsValid_Flag = 1 << 3, //!< set if fStrikeoutPosition is valid
49		kBoundsInvalid_Flag = 1 << 4, //!< set if fTop, fBottom, fXMin, fXMax invalid
50		};
51
52		uint32_t fFlags; //!< FontMetricsFlags indicating which metrics are valid
53		SkScalar fTop; //!< greatest extent above origin of any glyph bounding box, typically negative; deprecated with variable fonts
54		SkScalar fAscent; //!< distance to reserve above baseline, typically negative
55		SkScalar fDescent; //!< distance to reserve below baseline, typically positive
56		SkScalar fBottom; //!< greatest extent below origin of any glyph bounding box, typically positive; deprecated with variable fonts
57		SkScalar fLeading; //!< distance to add between lines, typically positive or zero
58		SkScalar fAvgCharWidth; //!< average character width, zero if unknown
59		SkScalar fMaxCharWidth; //!< maximum character width, zero if unknown
60		SkScalar fXMin; //!< greatest extent to left of origin of any glyph bounding box, typically negative; deprecated with variable fonts
61		SkScalar fXMax; //!< greatest extent to right of origin of any glyph bounding box, typically positive; deprecated with variable fonts
62		SkScalar fXHeight; //!< height of lower-case 'x', zero if unknown, typically negative
63		SkScalar fCapHeight; //!< height of an upper-case letter, zero if unknown, typically negative
64		SkScalar fUnderlineThickness; //!< underline thickness
65		SkScalar fUnderlinePosition; //!< distance from baseline to top of stroke, typically positive
66		SkScalar fStrikeoutThickness; //!< strikeout thickness
67		SkScalar fStrikeoutPosition; //!< distance from baseline to bottom of stroke, typically negative
68
69		/** Returns true if SkFontMetrics has a valid underline thickness, and sets
70		thickness to that value. If the underline thickness is not valid,
71		return false, and ignore thickness.
72
73		@param thickness storage for underline width
74		@return true if font specifies underline width
75		*/
76	0	bool hasUnderlineThickness(SkScalar* thickness) const {
77	0	if (SkToBool(fFlags & kUnderlineThicknessIsValid_Flag)) {
78	0	*thickness = fUnderlineThickness;
79	0	return true;
80	0	}
81	0	return false;
82	0	}
83
84		/** Returns true if SkFontMetrics has a valid underline position, and sets
85		position to that value. If the underline position is not valid,
86		return false, and ignore position.
87
88		@param position storage for underline position
89		@return true if font specifies underline position
90		*/
91	0	bool hasUnderlinePosition(SkScalar* position) const {
92	0	if (SkToBool(fFlags & kUnderlinePositionIsValid_Flag)) {
93	0	*position = fUnderlinePosition;
94	0	return true;
95	0	}
96	0	return false;
97	0	}
98
99		/** Returns true if SkFontMetrics has a valid strikeout thickness, and sets
100		thickness to that value. If the underline thickness is not valid,
101		return false, and ignore thickness.
102
103		@param thickness storage for strikeout width
104		@return true if font specifies strikeout width
105		*/
106	0	bool hasStrikeoutThickness(SkScalar* thickness) const {
107	0	if (SkToBool(fFlags & kStrikeoutThicknessIsValid_Flag)) {
108	0	*thickness = fStrikeoutThickness;
109	0	return true;
110	0	}
111	0	return false;
112	0	}
113
114		/** Returns true if SkFontMetrics has a valid strikeout position, and sets
115		position to that value. If the underline position is not valid,
116		return false, and ignore position.
117
118		@param position storage for strikeout position
119		@return true if font specifies strikeout position
120		*/
121	0	bool hasStrikeoutPosition(SkScalar* position) const {
122	0	if (SkToBool(fFlags & kStrikeoutPositionIsValid_Flag)) {
123	0	*position = fStrikeoutPosition;
124	0	return true;
125	0	}
126	0	return false;
127	0	}
128
129		/** Returns true if SkFontMetrics has a valid fTop, fBottom, fXMin, and fXMax.
130		If the bounds are not valid, return false.
131
132		@return true if font specifies maximum glyph bounds
133		*/
134	3.98k	bool hasBounds() const {
135	3.98k	return !SkToBool(fFlags & kBoundsInvalid_Flag);
136	3.98k	}
137		};
138
139		#endif

Coverage Report

Created: 2024-05-20 07:14