KiCad PCB EDA Suite
Loading...
Searching...
No Matches
eda_text.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) 2013 Jean-Pierre Charras, jp.charras at wanadoo.fr
5 * Copyright (C) 2004-2023 KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, you may find one here:
19 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20 * or you may search the http://www.gnu.org website for the version 2 license,
21 * or you may write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23 */
24
25#ifndef EDA_TEXT_H_
26#define EDA_TEXT_H_
27
28#include <memory>
29#include <vector>
30
31#include <outline_mode.h>
32#include <eda_search_data.h>
33#include <font/glyph.h>
35
36
37class OUTPUTFORMATTER;
38class SHAPE_COMPOUND;
39class SHAPE_POLY_SET;
40
41
42// These are only here for algorithmic safety, not to tell the user what to do.
43// PL_EDITOR has the least resolution (its internal units are microns), so the min size is chosen
44// to yield 1 in PL_EDITOR.
45// The max size chosen is somewhat arbitrary, but no one has complained yet.
46#define TEXT_MIN_SIZE_MM 0.001
47#define TEXT_MAX_SIZE_MM 250.0
48
49
50namespace KIGFX
51{
52 class RENDER_SETTINGS;
53 class COLOR4D;
54}
55
56namespace KIFONT
57{
58 class METRICS;
59 }
60
62using KIGFX::COLOR4D;
63
64
69#define DEFAULT_SIZE_TEXT 50 // default text height (in mils, i.e. 1/1000")
70
71
79{
80public:
81 EDA_TEXT( const EDA_IU_SCALE& aIuScale, const wxString& aText = wxEmptyString );
82
83 EDA_TEXT( const EDA_TEXT& aText );
84
85 virtual ~EDA_TEXT();
86
87 EDA_TEXT& operator=( const EDA_TEXT& aItem );
88
94 virtual const wxString& GetText() const { return m_text; }
95
105 virtual wxString GetShownText( bool aAllowExtraText, int aDepth = 0 ) const
106 {
107 return m_shown_text;
108 }
109
114
115 virtual void SetText( const wxString& aText );
116
121 void SetTextThickness( int aWidth );
123
127 int GetEffectiveTextPenWidth( int aDefaultPenWidth = 0 ) const;
128
129 virtual void SetTextAngle( const EDA_ANGLE& aAngle );
130 const EDA_ANGLE& GetTextAngle() const { return m_attributes.m_Angle; }
131
132 // For property system:
133 void SetTextAngleDegrees( double aOrientation )
134 {
135 SetTextAngle( EDA_ANGLE( aOrientation, DEGREES_T ) );
136 }
138
139 void SetItalic( bool aItalic );
140 bool IsItalic() const { return m_attributes.m_Italic; }
141
142 void SetBold( bool aBold );
143 void SetBoldFlag( bool aBold );
144 bool IsBold() const { return m_attributes.m_Bold; }
145
146 virtual void SetVisible( bool aVisible );
147 virtual bool IsVisible() const { return m_attributes.m_Visible; }
148
149 void SetMirrored( bool isMirrored );
150 bool IsMirrored() const { return m_attributes.m_Mirrored; }
151
156 void SetMultilineAllowed( bool aAllow );
158
161
162 void SetVertJustify( GR_TEXT_V_ALIGN_T aType );
164
165 void SetKeepUpright( bool aKeepUpright );
166 bool IsKeepUpright() const { return m_attributes.m_KeepUpright; }
167
169 {
174 }
175
179 void SetAttributes( const EDA_TEXT& aSrc, bool aSetPosition = true );
180
184 void SwapAttributes( EDA_TEXT& aTradingPartner );
185
186 void SwapText( EDA_TEXT& aTradingPartner );
187
188 void CopyText( const EDA_TEXT& aSrc );
189
190 void SetAttributes( const TEXT_ATTRIBUTES& aTextAttrs ) { m_attributes = aTextAttrs; }
191 const TEXT_ATTRIBUTES& GetAttributes() const { return m_attributes; }
192
202 bool Replace( const EDA_SEARCH_DATA& aSearchData );
203
204 bool IsDefaultFormatting() const;
205
206 void SetFont( KIFONT::FONT* aFont );
208
209 wxString GetFontName() const;
210
211 void SetFontIndex( int aIdx );
212 int GetFontIndex() const;
213
214 void SetLineSpacing( double aLineSpacing );
215 double GetLineSpacing() const { return m_attributes.m_LineSpacing; }
216
217 void SetTextSize( VECTOR2I aNewSize, bool aEnforceMinTextSize = true );
219
220 void SetTextWidth( int aWidth );
221 int GetTextWidth() const { return m_attributes.m_Size.x; }
222
223 void SetTextHeight( int aHeight );
224 int GetTextHeight() const { return m_attributes.m_Size.y; }
225
226 void SetTextColor( const COLOR4D& aColor ) { m_attributes.m_Color = aColor; }
228
229 void SetTextPos( const VECTOR2I& aPoint );
230 const VECTOR2I& GetTextPos() const { return m_pos; }
231
232 void SetTextX( int aX );
233 void SetTextY( int aY );
234
235 void Offset( const VECTOR2I& aOffset );
236
237 void Empty();
238
239 static GR_TEXT_H_ALIGN_T MapHorizJustify( int aHorizJustify );
240 static GR_TEXT_V_ALIGN_T MapVertJustify( int aVertJustify );
241
250 void Print( const RENDER_SETTINGS* aSettings, const VECTOR2I& aOffset, const COLOR4D& aColor,
251 OUTLINE_MODE aDisplay_mode = FILLED );
252
259 std::shared_ptr<SHAPE_COMPOUND> GetEffectiveTextShape( bool aTriangulate = true,
260 const BOX2I& aBBox = BOX2I(),
261 const EDA_ANGLE& aAngle = ANGLE_0 ) const;
262
270 virtual bool TextHitTest( const VECTOR2I& aPoint, int aAccuracy = 0 ) const;
271
280 virtual bool TextHitTest( const BOX2I& aRect, bool aContains, int aAccuracy = 0 ) const;
281
291 BOX2I GetTextBox( int aLine = -1 ) const;
292
300 int GetInterline() const;
301
305 wxString GetTextStyleName() const;
306
314 void GetLinePositions( std::vector<VECTOR2I>& aPositions, int aLineCount ) const;
315
321 double Levenshtein( const EDA_TEXT& aOther ) const;
322
323
324 double Similarity( const EDA_TEXT& aOther ) const;
325
334 virtual void Format( OUTPUTFORMATTER* aFormatter, int aNestLevel, int aControlBits ) const;
335
336 virtual EDA_ANGLE GetDrawRotation() const { return GetTextAngle(); }
337 virtual VECTOR2I GetDrawPos() const { return GetTextPos(); }
338
339 virtual void ClearRenderCache();
340 virtual void ClearBoundingBoxCache();
341
342 std::vector<std::unique_ptr<KIFONT::GLYPH>>*
343 GetRenderCache( const KIFONT::FONT* aFont, const wxString& forResolvedText,
344 const VECTOR2I& aOffset = { 0, 0 } ) const;
345
346 // Support for reading the cache from disk.
347 void SetupRenderCache( const wxString& aResolvedText, const KIFONT::FONT* aFont,
348 const EDA_ANGLE& aAngle, const VECTOR2I& aOffset );
349 void AddRenderCacheGlyph( const SHAPE_POLY_SET& aPoly );
350
351 int Compare( const EDA_TEXT* aOther ) const;
352
353 bool operator==( const EDA_TEXT& aRhs ) const { return Compare( &aRhs ) == 0; }
354 bool operator<( const EDA_TEXT& aRhs ) const { return Compare( &aRhs ) < 0; }
355 bool operator>( const EDA_TEXT& aRhs ) const { return Compare( &aRhs ) > 0; }
356
357 virtual bool HasHyperlink() const { return !m_hyperlink.IsEmpty(); }
358 wxString GetHyperlink() const { return m_hyperlink; }
359 void SetHyperlink( wxString aLink ) { m_hyperlink = aLink; }
360 void RemoveHyperlink() { m_hyperlink = wxEmptyString; }
361
368 static bool ValidateHyperlink( const wxString& aURL );
369
378 static bool IsGotoPageHref( const wxString& aHref, wxString* aDestination = nullptr );
379
386 static wxString GotoPageHref( const wxString& aDestination );
387
388protected:
389 virtual KIFONT::FONT* getDrawFont() const;
390
391 virtual const KIFONT::METRICS& getFontMetrics() const;
392
393 virtual void cacheShownText();
394
404 void printOneLineOfText( const RENDER_SETTINGS* aSettings, const VECTOR2I& aOffset,
405 const COLOR4D& aColor, OUTLINE_MODE aFillMode, const wxString& aText,
406 const VECTOR2I& aPos );
407
408protected:
412 wxString m_hyperlink;
413
414private:
415 wxString m_text;
416 wxString m_shown_text; // Cache of unescaped text for efficient access
418
419 std::reference_wrapper<const EDA_IU_SCALE> m_IuScale;
420
421 mutable wxString m_render_cache_text;
425 mutable std::vector<std::unique_ptr<KIFONT::GLYPH>> m_render_cache;
426
431
434};
435
436
437extern std::ostream& operator<<( std::ostream& aStream, const EDA_TEXT& aAttributes );
438
439
440template<>
441struct std::hash<EDA_TEXT>
442{
443 std::size_t operator()( const EDA_TEXT& aText ) const
444 {
445 return hash_val( aText.GetText(), aText.GetAttributes(), aText.GetTextPos().x,
446 aText.GetTextPos().y );
447 }
448};
449
450#endif // EDA_TEXT_H_
BOX2< VECTOR2I > BOX2I
Definition: box2.h:877
double AsDegrees() const
Definition: eda_angle.h:113
A mix-in class (via multiple inheritance) that handles texts such as labels, parts,...
Definition: eda_text.h:79
int GetTextHeight() const
Definition: eda_text.h:224
void SetTextColor(const COLOR4D &aColor)
Definition: eda_text.h:226
const VECTOR2I & GetTextPos() const
Definition: eda_text.h:230
COLOR4D GetTextColor() const
Definition: eda_text.h:227
wxString GetTextStyleName() const
Definition: eda_text.cpp:822
VECTOR2I m_pos
Definition: eda_text.h:433
wxString m_text
Definition: eda_text.h:415
bool IsDefaultFormatting() const
Definition: eda_text.cpp:896
static bool IsGotoPageHref(const wxString &aHref, wxString *aDestination=nullptr)
Check if aHref is a valid internal hyperlink.
Definition: eda_text.cpp:1158
std::vector< std::unique_ptr< KIFONT::GLYPH > > m_render_cache
Definition: eda_text.h:425
wxString GetFontName() const
Definition: eda_text.cpp:843
virtual ~EDA_TEXT()
Definition: eda_text.cpp:146
bool IsItalic() const
Definition: eda_text.h:140
const EDA_ANGLE & GetTextAngle() const
Definition: eda_text.h:130
BOX2I m_bounding_box_cache
Definition: eda_text.h:430
void SetTextSize(VECTOR2I aNewSize, bool aEnforceMinTextSize=true)
Definition: eda_text.cpp:373
bool IsMultilineAllowed() const
Definition: eda_text.h:157
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:94
int GetInterline() const
Return the distance between two lines of text.
Definition: eda_text.cpp:564
bool IsKeepUpright() const
Definition: eda_text.h:166
virtual bool IsVisible() const
Definition: eda_text.h:147
void SetTextPos(const VECTOR2I &aPoint)
Definition: eda_text.cpp:418
void SetTextX(int aX)
Definition: eda_text.cpp:424
bool m_shown_text_has_text_var_refs
Definition: eda_text.h:417
KIFONT::FONT * GetFont() const
Definition: eda_text.h:207
void SetAttributes(const TEXT_ATTRIBUTES &aTextAttrs)
Definition: eda_text.h:190
void SetAttributes(const EDA_TEXT &aSrc, bool aSetPosition=true)
Set the text attributes from another instance.
Definition: eda_text.cpp:291
wxString m_shown_text
Definition: eda_text.h:416
virtual void Format(OUTPUTFORMATTER *aFormatter, int aNestLevel, int aControlBits) const
Output the object to aFormatter in s-expression form.
Definition: eda_text.cpp:911
int GetFontIndex() const
Definition: eda_text.cpp:852
BOX2I GetTextBox(int aLine=-1) const
Useful in multiline texts to calculate the full text or a line area (for zones filling,...
Definition: eda_text.cpp:570
void SetMirrored(bool isMirrored)
Definition: eda_text.cpp:251
void SetTextY(int aY)
Definition: eda_text.cpp:430
int m_bounding_box_cache_line
Definition: eda_text.h:429
std::vector< std::unique_ptr< KIFONT::GLYPH > > * GetRenderCache(const KIFONT::FONT *aFont, const wxString &forResolvedText, const VECTOR2I &aOffset={ 0, 0 }) const
Definition: eda_text.cpp:511
const KIFONT::FONT * m_render_cache_font
Definition: eda_text.h:422
virtual EDA_ANGLE GetDrawRotation() const
Definition: eda_text.h:336
virtual VECTOR2I GetDrawPos() const
Definition: eda_text.h:337
EDA_TEXT & operator=(const EDA_TEXT &aItem)
Definition: eda_text.cpp:151
wxString m_hyperlink
A hyperlink URL.
Definition: eda_text.h:412
void printOneLineOfText(const RENDER_SETTINGS *aSettings, const VECTOR2I &aOffset, const COLOR4D &aColor, OUTLINE_MODE aFillMode, const wxString &aText, const VECTOR2I &aPos)
Print each line of this EDA_TEXT.
Definition: eda_text.cpp:797
int GetTextWidth() const
Definition: eda_text.h:221
virtual bool HasHyperlink() const
Definition: eda_text.h:357
void SetVertJustify(GR_TEXT_V_ALIGN_T aType)
Definition: eda_text.cpp:275
wxString GetHyperlink() const
Definition: eda_text.h:358
void Offset(const VECTOR2I &aOffset)
Definition: eda_text.cpp:436
GR_TEXT_H_ALIGN_T GetHorizJustify() const
Definition: eda_text.h:160
void SetTextWidth(int aWidth)
Definition: eda_text.cpp:396
void SetBoldFlag(bool aBold)
Definition: eda_text.cpp:236
bool Replace(const EDA_SEARCH_DATA &aSearchData)
Helper function used in search and replace dialog.
Definition: eda_text.cpp:344
void SetupRenderCache(const wxString &aResolvedText, const KIFONT::FONT *aFont, const EDA_ANGLE &aAngle, const VECTOR2I &aOffset)
Definition: eda_text.cpp:546
int Compare(const EDA_TEXT *aOther) const
Definition: eda_text.cpp:1062
std::reference_wrapper< const EDA_IU_SCALE > m_IuScale
Definition: eda_text.h:419
bool HasTextVars() const
Indicates the ShownText has text var references which need to be processed.
Definition: eda_text.h:113
bool operator>(const EDA_TEXT &aRhs) const
Definition: eda_text.h:355
virtual void SetVisible(bool aVisible)
Definition: eda_text.cpp:244
bool m_bounding_box_cache_valid
Definition: eda_text.h:427
void GetLinePositions(std::vector< VECTOR2I > &aPositions, int aLineCount) const
Populate aPositions with the position of each line of a multiline text, according to the vertical jus...
Definition: eda_text.cpp:753
static wxString GotoPageHref(const wxString &aDestination)
Generate a href to a page in the current schematic.
Definition: eda_text.cpp:1164
virtual void ClearBoundingBoxCache()
Definition: eda_text.cpp:504
virtual KIFONT::FONT * getDrawFont() const
Definition: eda_text.cpp:481
double GetLineSpacing() const
Definition: eda_text.h:215
double Similarity(const EDA_TEXT &aOther) const
Definition: eda_text.cpp:1142
VECTOR2I m_render_cache_offset
Definition: eda_text.h:424
void SetLineSpacing(double aLineSpacing)
Definition: eda_text.cpp:365
void AddRenderCacheGlyph(const SHAPE_POLY_SET &aPoly)
Definition: eda_text.cpp:557
void Empty()
Definition: eda_text.cpp:455
void SetTextThickness(int aWidth)
The TextThickness is that set by the user.
Definition: eda_text.cpp:196
virtual bool TextHitTest(const VECTOR2I &aPoint, int aAccuracy=0) const
Test if aPoint is within the bounds of this object.
Definition: eda_text.cpp:704
void FlipHJustify()
Definition: eda_text.h:168
void SetTextHeight(int aHeight)
Definition: eda_text.cpp:407
virtual void cacheShownText()
Definition: eda_text.cpp:463
EDA_ANGLE m_render_cache_angle
Definition: eda_text.h:423
static GR_TEXT_H_ALIGN_T MapHorizJustify(int aHorizJustify)
Definition: eda_text.cpp:64
virtual void ClearRenderCache()
Definition: eda_text.cpp:498
void RemoveHyperlink()
Definition: eda_text.h:360
const TEXT_ATTRIBUTES & GetAttributes() const
Definition: eda_text.h:191
void SetBold(bool aBold)
Definition: eda_text.cpp:220
static bool ValidateHyperlink(const wxString &aURL)
Check if aURL is a valid hyperlink.
Definition: eda_text.cpp:1086
VECTOR2I m_bounding_box_cache_pos
Definition: eda_text.h:428
bool IsMirrored() const
Definition: eda_text.h:150
int GetEffectiveTextPenWidth(int aDefaultPenWidth=0) const
The EffectiveTextPenWidth uses the text thickness if > 1 or aDefaultPenWidth.
Definition: eda_text.cpp:323
void SwapAttributes(EDA_TEXT &aTradingPartner)
Swap the text attributes of the two involved instances.
Definition: eda_text.cpp:310
wxString m_render_cache_text
Definition: eda_text.h:421
double GetTextAngleDegrees() const
Definition: eda_text.h:137
virtual const KIFONT::METRICS & getFontMetrics() const
Definition: eda_text.cpp:492
std::shared_ptr< SHAPE_COMPOUND > GetEffectiveTextShape(bool aTriangulate=true, const BOX2I &aBBox=BOX2I(), const EDA_ANGLE &aAngle=ANGLE_0) const
build a list of segments (SHAPE_SEGMENT) to describe a text shape.
Definition: eda_text.cpp:983
bool operator<(const EDA_TEXT &aRhs) const
Definition: eda_text.h:354
bool IsBold() const
Definition: eda_text.h:144
void SetTextAngleDegrees(double aOrientation)
Definition: eda_text.h:133
void SetHyperlink(wxString aLink)
Definition: eda_text.h:359
static GR_TEXT_V_ALIGN_T MapVertJustify(int aVertJustify)
Definition: eda_text.cpp:78
void SetKeepUpright(bool aKeepUpright)
Definition: eda_text.cpp:283
void CopyText(const EDA_TEXT &aSrc)
Definition: eda_text.cpp:189
GR_TEXT_V_ALIGN_T GetVertJustify() const
Definition: eda_text.h:163
virtual wxString GetShownText(bool aAllowExtraText, int aDepth=0) const
Return the string actually shown after processing of the base text.
Definition: eda_text.h:105
virtual void SetText(const wxString &aText)
Definition: eda_text.cpp:182
double Levenshtein(const EDA_TEXT &aOther) const
Return the levenstein distance between two texts.
Definition: eda_text.cpp:1096
virtual void SetTextAngle(const EDA_ANGLE &aAngle)
Definition: eda_text.cpp:204
void SetFontIndex(int aIdx)
Definition: eda_text.cpp:873
int GetTextThickness() const
Definition: eda_text.h:122
void Print(const RENDER_SETTINGS *aSettings, const VECTOR2I &aOffset, const COLOR4D &aColor, OUTLINE_MODE aDisplay_mode=FILLED)
Print this text object to the device context aDC.
Definition: eda_text.cpp:729
void SetItalic(bool aItalic)
Definition: eda_text.cpp:212
void SwapText(EDA_TEXT &aTradingPartner)
Definition: eda_text.cpp:303
bool operator==(const EDA_TEXT &aRhs) const
Definition: eda_text.h:353
void SetMultilineAllowed(bool aAllow)
Definition: eda_text.cpp:259
void SetFont(KIFONT::FONT *aFont)
Definition: eda_text.cpp:357
VECTOR2I GetTextSize() const
Definition: eda_text.h:218
void SetHorizJustify(GR_TEXT_H_ALIGN_T aType)
Definition: eda_text.cpp:267
TEXT_ATTRIBUTES m_attributes
Definition: eda_text.h:432
FONT is an abstract base class for both outline and stroke fonts.
Definition: font.h:131
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:104
Container for all the knowledge about how graphical objects are drawn on any output surface/device.
An interface used to output 8 bit text in a convenient way.
Definition: richio.h:322
Represent a set of closed polygons.
KIGFX::COLOR4D m_Color
GR_TEXT_H_ALIGN_T m_Halign
GR_TEXT_V_ALIGN_T m_Valign
KIFONT::FONT * m_Font
static constexpr EDA_ANGLE ANGLE_0
Definition: eda_angle.h:401
@ DEGREES_T
Definition: eda_angle.h:31
std::ostream & operator<<(std::ostream &aStream, const EDA_TEXT &aText)
Definition: eda_text.cpp:1170
static const bool FILLED
Definition: gr_basic.cpp:30
static std::size_t hash_val(const Types &... args)
Definition: hash.h:51
The Cairo implementation of the graphics abstraction layer.
Definition: color4d.cpp:247
OUTLINE_MODE
Definition: outline_mode.h:25
std::size_t operator()(const EDA_TEXT &aText) const
Definition: eda_text.h:443
GR_TEXT_H_ALIGN_T
@ GR_TEXT_H_ALIGN_RIGHT
@ GR_TEXT_H_ALIGN_LEFT
GR_TEXT_V_ALIGN_T