KiCad PCB EDA Suite
Loading...
Searching...
No Matches
outline_font.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KICAD, a free EDA CAD application.
3 *
4 * Copyright (C) 2021 Ola Rinta-Koski
5 * Copyright (C) 2021-2022 Kicad Developers, see AUTHORS.txt for contributors.
6 *
7 * Outline font class
8 *
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version 2
12 * of the License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, you may find one here:
21 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
22 * or you may search the http://www.gnu.org website for the version 2 license,
23 * or you may write to the Free Software Foundation, Inc.,
24 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
25 */
26
27#ifndef OUTLINE_FONT_H_
28#define OUTLINE_FONT_H_
29
32#ifdef _MSC_VER
33#include <ft2build.h>
34#else
35#include <freetype2/ft2build.h>
36#endif
37#include FT_FREETYPE_H
38#include FT_OUTLINE_H
39//#include <gal/opengl/opengl_freetype.h>
40#include <font/font.h>
41#include <font/glyph.h>
43
44#include <mutex>
45
46namespace KIFONT
47{
51class OUTLINE_FONT : public FONT
52{
53public:
55
56 static wxString FontConfigVersion();
57
58 static wxString FreeTypeVersion();
59
60 static wxString HarfBuzzVersion();
61
62 static wxString FontLibraryVersion();
63
64 bool IsOutline() const override { return true; }
65
66 bool IsBold() const override
67 {
68 return m_face && ( m_fakeBold || ( m_face->style_flags & FT_STYLE_FLAG_BOLD ) );
69 }
70
71 bool IsItalic() const override
72 {
73 return m_face && ( m_fakeItal || ( m_face->style_flags & FT_STYLE_FLAG_ITALIC ) );
74 }
75
77 {
78 m_fakeBold = true;
79 }
80
82 {
83 m_fakeItal = true;
84 }
85
90 static OUTLINE_FONT* LoadFont( const wxString& aFontFileName, bool aBold, bool aItalic );
91
96 double ComputeOverbarVerticalPosition( double aGlyphHeight ) const override;
97
102 double ComputeUnderlineVerticalPosition( double aGlyphHeight ) const override;
103
108 double GetInterline( double aGlyphHeight = 0.0, double aLineSpacing = 1.0 ) const override;
109
110 VECTOR2I GetTextAsGlyphs( BOX2I* aBoundingBox, std::vector<std::unique_ptr<GLYPH>>* aGlyphs,
111 const wxString& aText, const VECTOR2I& aSize,
112 const VECTOR2I& aPosition, const EDA_ANGLE& aAngle, bool aMirror,
113 const VECTOR2I& aOrigin, TEXT_STYLE_FLAGS aTextStyle ) const override;
114
115 void GetLinesAsGlyphs( std::vector<std::unique_ptr<GLYPH>>* aGlyphs, const wxString& aText,
116 const VECTOR2I& aPosition, const TEXT_ATTRIBUTES& aAttrs ) const;
117
118 const FT_Face& GetFace() const { return m_face; }
119
120#if 0
121 void RenderToOpenGLCanvas( KIGFX::OPENGL_FREETYPE& aTarget, const wxString& aString,
122 const VECTOR2D& aSize, const wxPoint& aPosition,
123 const EDA_ANGLE& aAngle, bool aMirror ) const;
124#endif
125
126protected:
127 FT_Error loadFace( const wxString& aFontFileName, int aFaceIndex );
128
129 BOX2I getBoundingBox( const std::vector<std::unique_ptr<GLYPH>>& aGlyphs ) const;
130
131 VECTOR2I getTextAsGlyphs( BOX2I* aBoundingBox, std::vector<std::unique_ptr<GLYPH>>* aGlyphs,
132 const wxString& aText, const VECTOR2I& aSize,
133 const VECTOR2I& aPosition, const EDA_ANGLE& aAngle, bool aMirror,
134 const VECTOR2I& aOrigin, TEXT_STYLE_FLAGS aTextStyle ) const;
135
136private:
138 std::vector<std::unique_ptr<GLYPH>>* aGlyphs,
139 const wxString& aText, const VECTOR2I& aSize,
140 const VECTOR2I& aPosition, const EDA_ANGLE& aAngle,
141 bool aMirror, const VECTOR2I& aOrigin,
142 TEXT_STYLE_FLAGS aTextStyle ) const;
143
144private:
145 // FreeType variables
146
150 static std::mutex m_freeTypeMutex;
151 static FT_Library m_freeType;
152 FT_Face m_face;
153
154 const int m_faceSize;
157
158 // cache for glyphs converted to straight segments
159 // key is glyph index (FT_GlyphSlot field glyph_index)
160 std::map<unsigned int, GLYPH_POINTS_LIST> m_contourCache;
161
162 // The height of the KiCad stroke font is the distance between stroke endpoints for a vertical
163 // line of cap-height. So the cap-height of the font is actually stroke-width taller than its
164 // height.
165 // Outline fonts are normally scaled on full-height (including ascenders and descenders), so we
166 // need to compensate to keep them from being much smaller than their stroked counterparts.
167 static constexpr double m_outlineFontSizeCompensation = 1.4;
168
169 // FT_Set_Char_Size() gets character width and height specified in 1/64ths of a point
170 static constexpr int m_charSizeScaler = 64;
171
172 // The KiCad stroke font uses a subscript/superscript size ratio of 0.7. This ratio is also
173 // commonly used in LaTeX, but fonts with designed-in subscript and superscript glyphs are more
174 // likely to use 0.58.
175 // For auto-generated subscript and superscript glyphs in outline fonts we split the difference
176 // with 0.64.
177 static constexpr double m_subscriptSuperscriptSize = 0.64;
178
179 static constexpr double m_underlineOffsetScaler = -0.16;
180
181 int faceSize( int aSize ) const
182 {
184 };
185 int faceSize() const { return faceSize( m_faceSize ); }
186
187 // also for superscripts
188 int subscriptSize( int aSize ) const
189 {
190 return KiROUND( faceSize( aSize ) * m_subscriptSuperscriptSize );
191 }
192 int subscriptSize() const { return subscriptSize( m_faceSize ); }
193
194 static constexpr double m_subscriptVerticalOffset = -0.25;
195 static constexpr double m_superscriptVerticalOffset = 0.45;
196};
197
198} //namespace KIFONT
199
200#endif // OUTLINE_FONT_H_
FONT is an abstract base class for both outline and stroke fonts.
Definition: font.h:105
Class OUTLINE_FONT implements outline font drawing.
Definition: outline_font.h:52
VECTOR2I getTextAsGlyphsUnlocked(BOX2I *aBoundingBox, std::vector< std::unique_ptr< GLYPH > > *aGlyphs, const wxString &aText, const VECTOR2I &aSize, const VECTOR2I &aPosition, const EDA_ANGLE &aAngle, bool aMirror, const VECTOR2I &aOrigin, TEXT_STYLE_FLAGS aTextStyle) const
static std::mutex m_freeTypeMutex
Mutex for freetype access, FT_Library and FT_Face are not thread safe.
Definition: outline_font.h:150
static FT_Library m_freeType
Definition: outline_font.h:151
BOX2I getBoundingBox(const std::vector< std::unique_ptr< GLYPH > > &aGlyphs) const
FT_Error loadFace(const wxString &aFontFileName, int aFaceIndex)
static constexpr double m_superscriptVerticalOffset
Definition: outline_font.h:195
static wxString FreeTypeVersion()
VECTOR2I getTextAsGlyphs(BOX2I *aBoundingBox, std::vector< std::unique_ptr< GLYPH > > *aGlyphs, const wxString &aText, const VECTOR2I &aSize, const VECTOR2I &aPosition, const EDA_ANGLE &aAngle, bool aMirror, const VECTOR2I &aOrigin, TEXT_STYLE_FLAGS aTextStyle) const
std::map< unsigned int, GLYPH_POINTS_LIST > m_contourCache
Definition: outline_font.h:160
VECTOR2I GetTextAsGlyphs(BOX2I *aBoundingBox, std::vector< std::unique_ptr< GLYPH > > *aGlyphs, const wxString &aText, const VECTOR2I &aSize, const VECTOR2I &aPosition, const EDA_ANGLE &aAngle, bool aMirror, const VECTOR2I &aOrigin, TEXT_STYLE_FLAGS aTextStyle) const override
Convert text string to an array of GLYPHs.
const FT_Face & GetFace() const
Definition: outline_font.h:118
double GetInterline(double aGlyphHeight=0.0, double aLineSpacing=1.0) const override
Compute the distance (interline) between 2 lines of text (for multiline texts).
int subscriptSize(int aSize) const
Definition: outline_font.h:188
static wxString FontConfigVersion()
bool IsItalic() const override
Definition: outline_font.h:71
static constexpr int m_charSizeScaler
Definition: outline_font.h:170
int faceSize(int aSize) const
Definition: outline_font.h:181
void GetLinesAsGlyphs(std::vector< std::unique_ptr< GLYPH > > *aGlyphs, const wxString &aText, const VECTOR2I &aPosition, const TEXT_ATTRIBUTES &aAttrs) const
bool IsOutline() const override
Definition: outline_font.h:64
double ComputeUnderlineVerticalPosition(double aGlyphHeight) const override
Compute the vertical position of an underline.
int faceSize() const
Definition: outline_font.h:185
static constexpr double m_subscriptSuperscriptSize
Definition: outline_font.h:177
static constexpr double m_outlineFontSizeCompensation
Definition: outline_font.h:167
static constexpr double m_underlineOffsetScaler
Definition: outline_font.h:179
double ComputeOverbarVerticalPosition(double aGlyphHeight) const override
Compute the vertical position of an overbar.
int subscriptSize() const
Definition: outline_font.h:192
static wxString FontLibraryVersion()
bool IsBold() const override
Definition: outline_font.h:66
static wxString HarfBuzzVersion()
static OUTLINE_FONT * LoadFont(const wxString &aFontFileName, bool aBold, bool aItalic)
Load an outline font.
static constexpr double m_subscriptVerticalOffset
Definition: outline_font.h:194
unsigned int TEXT_STYLE_FLAGS
Definition: font.h:63
Definition: font.h:100
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:85