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
36class OUTPUTFORMATTER;
37class SHAPE_COMPOUND;
38class SHAPE_POLY_SET;
39
40
41// These are only here for algorithmic safety, not to tell the user what to do
42#define TEXT_MIN_SIZE_MILS 1
43#define TEXT_MAX_SIZE_MILS 10000
44
45
46namespace KIGFX
47{
48 class RENDER_SETTINGS;
49 class COLOR4D;
50}
51
52namespace KIFONT
53{
54 class METRICS;
55 }
56
58using KIGFX::COLOR4D;
59
60// part of the kicad_plugin.h family of defines.
61// See kicad_plugin.h for the choice of the value
62// When set when calling EDA_TEXT::Format, disable writing the "hide" keyword in save file
63#define CTL_OMIT_HIDE (1 << 6)
64
65
70#define DEFAULT_SIZE_TEXT 50 // default text height (in mils, i.e. 1/1000")
71
72
80{
81public:
82 EDA_TEXT( const EDA_IU_SCALE& aIuScale, const wxString& aText = wxEmptyString );
83
84 EDA_TEXT( const EDA_TEXT& aText );
85
86 virtual ~EDA_TEXT();
87
88 EDA_TEXT& operator=( const EDA_TEXT& aItem );
89
95 virtual const wxString& GetText() const { return m_text; }
96
106 virtual wxString GetShownText( bool aAllowExtraText, int aDepth = 0 ) const
107 {
108 return m_shown_text;
109 }
110
115
116 virtual void SetText( const wxString& aText );
117
122 void SetTextThickness( int aWidth );
124
128 int GetEffectiveTextPenWidth( int aDefaultPenWidth = 0 ) const;
129
130 virtual void SetTextAngle( const EDA_ANGLE& aAngle );
131 const EDA_ANGLE& GetTextAngle() const { return m_attributes.m_Angle; }
132
133 // For property system:
134 void SetTextAngleDegrees( double aOrientation )
135 {
136 SetTextAngle( EDA_ANGLE( aOrientation, DEGREES_T ) );
137 }
139
140 void SetItalic( bool aItalic );
141 bool IsItalic() const { return m_attributes.m_Italic; }
142
143 void SetBold( bool aBold );
144 void SetBoldFlag( bool aBold );
145 bool IsBold() const { return m_attributes.m_Bold; }
146
147 virtual void SetVisible( bool aVisible );
148 virtual bool IsVisible() const { return m_attributes.m_Visible; }
149
150 void SetMirrored( bool isMirrored );
151 bool IsMirrored() const { return m_attributes.m_Mirrored; }
152
157 void SetMultilineAllowed( bool aAllow );
159
162
163 void SetVertJustify( GR_TEXT_V_ALIGN_T aType );
165
166 void SetKeepUpright( bool aKeepUpright );
167 bool IsKeepUpright() const { return m_attributes.m_KeepUpright; }
168
170 {
175 }
176
180 void SetAttributes( const EDA_TEXT& aSrc, bool aSetPosition = true );
181
185 void SwapAttributes( EDA_TEXT& aTradingPartner );
186
187 void SwapText( EDA_TEXT& aTradingPartner );
188
189 void CopyText( const EDA_TEXT& aSrc );
190
191 void SetAttributes( const TEXT_ATTRIBUTES& aTextAttrs ) { m_attributes = aTextAttrs; }
192 const TEXT_ATTRIBUTES& GetAttributes() const { return m_attributes; }
193
203 bool Replace( const EDA_SEARCH_DATA& aSearchData );
204
205 bool IsDefaultFormatting() const;
206
207 void SetFont( KIFONT::FONT* aFont );
209
210 wxString GetFontName() const;
211
212 void SetFontIndex( int aIdx );
213 int GetFontIndex() const;
214
215 void SetLineSpacing( double aLineSpacing );
216 double GetLineSpacing() const { return m_attributes.m_LineSpacing; }
217
218 void SetTextSize( VECTOR2I aNewSize, bool aEnforceMinTextSize = true );
220
221 void SetTextWidth( int aWidth );
222 int GetTextWidth() const { return m_attributes.m_Size.x; }
223
224 void SetTextHeight( int aHeight );
225 int GetTextHeight() const { return m_attributes.m_Size.y; }
226
227 void SetTextColor( const COLOR4D& aColor ) { m_attributes.m_Color = aColor; }
229
230 void SetTextPos( const VECTOR2I& aPoint );
231 const VECTOR2I& GetTextPos() const { return m_pos; }
232
233 void SetTextX( int aX );
234 void SetTextY( int aY );
235
236 void Offset( const VECTOR2I& aOffset );
237
238 void Empty();
239
240 static GR_TEXT_H_ALIGN_T MapHorizJustify( int aHorizJustify );
241 static GR_TEXT_V_ALIGN_T MapVertJustify( int aVertJustify );
242
251 void Print( const RENDER_SETTINGS* aSettings, const VECTOR2I& aOffset, const COLOR4D& aColor,
252 OUTLINE_MODE aDisplay_mode = FILLED );
253
260 std::shared_ptr<SHAPE_COMPOUND> GetEffectiveTextShape( bool aTriangulate = true,
261 const BOX2I& aBBox = BOX2I(),
262 const EDA_ANGLE& aAngle = ANGLE_0 ) const;
263
271 virtual bool TextHitTest( const VECTOR2I& aPoint, int aAccuracy = 0 ) const;
272
281 virtual bool TextHitTest( const BOX2I& aRect, bool aContains, int aAccuracy = 0 ) const;
282
293 BOX2I GetTextBox( int aLine = -1, bool aInvertY = false ) const;
294
302 int GetInterline() const;
303
307 wxString GetTextStyleName() const;
308
316 void GetLinePositions( std::vector<VECTOR2I>& aPositions, int aLineCount ) const;
317
323 double Levenshtein( const EDA_TEXT& aOther ) const;
324
325
326 double Similarity( const EDA_TEXT& aOther ) const;
327
336 virtual void Format( OUTPUTFORMATTER* aFormatter, int aNestLevel, int aControlBits ) const;
337
338 virtual EDA_ANGLE GetDrawRotation() const { return GetTextAngle(); }
339 virtual VECTOR2I GetDrawPos() const { return GetTextPos(); }
340
341 virtual void ClearRenderCache();
342 virtual void ClearBoundingBoxCache();
343
344 std::vector<std::unique_ptr<KIFONT::GLYPH>>*
345 GetRenderCache( const KIFONT::FONT* aFont, const wxString& forResolvedText,
346 const VECTOR2I& aOffset = { 0, 0 } ) const;
347
348 // Support for reading the cache from disk.
349 void SetupRenderCache( const wxString& aResolvedText, const EDA_ANGLE& aAngle );
350 void AddRenderCacheGlyph( const SHAPE_POLY_SET& aPoly );
351
352 int Compare( const EDA_TEXT* aOther ) const;
353
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 bool operator>( const EDA_TEXT& aRhs ) const { return Compare( &aRhs ) > 0; }
357
358 virtual bool HasHyperlink() const { return !m_hyperlink.IsEmpty(); }
359 wxString GetHyperlink() const { return m_hyperlink; }
360 void SetHyperlink( wxString aLink ) { m_hyperlink = aLink; }
361 void RemoveHyperlink() { m_hyperlink = wxEmptyString; }
362
369 static bool ValidateHyperlink( const wxString& aURL );
370
379 static bool IsGotoPageHref( const wxString& aHref, wxString* aDestination = nullptr );
380
387 static wxString GotoPageHref( const wxString& aDestination );
388
389protected:
390 virtual KIFONT::FONT* getDrawFont() const;
391
392 virtual const KIFONT::METRICS& getFontMetrics() const;
393
394 virtual void cacheShownText();
395
405 void printOneLineOfText( const RENDER_SETTINGS* aSettings, const VECTOR2I& aOffset,
406 const COLOR4D& aColor, OUTLINE_MODE aFillMode, const wxString& aText,
407 const VECTOR2I& aPos );
408
409protected:
413 wxString m_hyperlink;
414
415private:
416 wxString m_text;
417 wxString m_shown_text; // Cache of unescaped text for efficient access
419
420 std::reference_wrapper<const EDA_IU_SCALE> m_IuScale;
421
422 mutable wxString m_render_cache_text;
426 mutable std::vector<std::unique_ptr<KIFONT::GLYPH>> m_render_cache;
427
433
436};
437
438
439extern std::ostream& operator<<( std::ostream& aStream, const EDA_TEXT& aAttributes );
440
441
442template<>
443struct std::hash<EDA_TEXT>
444{
445 std::size_t operator()( const EDA_TEXT& aText ) const
446 {
447 return hash_val( aText.GetText(), aText.GetAttributes(), aText.GetTextPos().x,
448 aText.GetTextPos().y );
449 }
450};
451
452#endif // EDA_TEXT_H_
BOX2< VECTOR2I > BOX2I
Definition: box2.h:853
double AsDegrees() const
Definition: eda_angle.h:155
A mix-in class (via multiple inheritance) that handles texts such as labels, parts,...
Definition: eda_text.h:80
int GetTextHeight() const
Definition: eda_text.h:225
BOX2I GetTextBox(int aLine=-1, bool aInvertY=false) const
Useful in multiline texts to calculate the full text or a line area (for zones filling,...
Definition: eda_text.cpp:567
void SetTextColor(const COLOR4D &aColor)
Definition: eda_text.h:227
const VECTOR2I & GetTextPos() const
Definition: eda_text.h:231
COLOR4D GetTextColor() const
Definition: eda_text.h:228
wxString GetTextStyleName() const
Definition: eda_text.cpp:824
VECTOR2I m_pos
Definition: eda_text.h:435
wxString m_text
Definition: eda_text.h:416
bool IsDefaultFormatting() const
Definition: eda_text.cpp:898
static bool IsGotoPageHref(const wxString &aHref, wxString *aDestination=nullptr)
Check if aHref is a valid internal hyperlink.
Definition: eda_text.cpp:1167
std::vector< std::unique_ptr< KIFONT::GLYPH > > m_render_cache
Definition: eda_text.h:426
wxString GetFontName() const
Definition: eda_text.cpp:845
void SetupRenderCache(const wxString &aResolvedText, const EDA_ANGLE &aAngle)
Definition: eda_text.cpp:547
virtual ~EDA_TEXT()
Definition: eda_text.cpp:147
bool IsItalic() const
Definition: eda_text.h:141
const EDA_ANGLE & GetTextAngle() const
Definition: eda_text.h:131
BOX2I m_bounding_box_cache
Definition: eda_text.h:432
void SetTextSize(VECTOR2I aNewSize, bool aEnforceMinTextSize=true)
Definition: eda_text.cpp:374
bool IsMultilineAllowed() const
Definition: eda_text.h:158
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:95
int GetInterline() const
Return the distance between two lines of text.
Definition: eda_text.cpp:561
bool IsKeepUpright() const
Definition: eda_text.h:167
virtual bool IsVisible() const
Definition: eda_text.h:148
void SetTextPos(const VECTOR2I &aPoint)
Definition: eda_text.cpp:419
void SetTextX(int aX)
Definition: eda_text.cpp:425
bool m_shown_text_has_text_var_refs
Definition: eda_text.h:418
KIFONT::FONT * GetFont() const
Definition: eda_text.h:208
void SetAttributes(const TEXT_ATTRIBUTES &aTextAttrs)
Definition: eda_text.h:191
void SetAttributes(const EDA_TEXT &aSrc, bool aSetPosition=true)
Set the text attributes from another instance.
Definition: eda_text.cpp:292
wxString m_shown_text
Definition: eda_text.h:417
virtual void Format(OUTPUTFORMATTER *aFormatter, int aNestLevel, int aControlBits) const
Output the object to aFormatter in s-expression form.
Definition: eda_text.cpp:913
int GetFontIndex() const
Definition: eda_text.cpp:854
void SetMirrored(bool isMirrored)
Definition: eda_text.cpp:252
void SetTextY(int aY)
Definition: eda_text.cpp:431
int m_bounding_box_cache_line
Definition: eda_text.h:430
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:512
const KIFONT::FONT * m_render_cache_font
Definition: eda_text.h:423
virtual EDA_ANGLE GetDrawRotation() const
Definition: eda_text.h:338
virtual VECTOR2I GetDrawPos() const
Definition: eda_text.h:339
EDA_TEXT & operator=(const EDA_TEXT &aItem)
Definition: eda_text.cpp:152
wxString m_hyperlink
A hyperlink URL.
Definition: eda_text.h:413
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:799
int GetTextWidth() const
Definition: eda_text.h:222
virtual bool HasHyperlink() const
Definition: eda_text.h:358
void SetVertJustify(GR_TEXT_V_ALIGN_T aType)
Definition: eda_text.cpp:276
wxString GetHyperlink() const
Definition: eda_text.h:359
void Offset(const VECTOR2I &aOffset)
Definition: eda_text.cpp:437
GR_TEXT_H_ALIGN_T GetHorizJustify() const
Definition: eda_text.h:161
void SetTextWidth(int aWidth)
Definition: eda_text.cpp:397
void SetBoldFlag(bool aBold)
Definition: eda_text.cpp:237
bool Replace(const EDA_SEARCH_DATA &aSearchData)
Helper function used in search and replace dialog.
Definition: eda_text.cpp:345
int Compare(const EDA_TEXT *aOther) const
Definition: eda_text.cpp:1064
std::reference_wrapper< const EDA_IU_SCALE > m_IuScale
Definition: eda_text.h:420
bool HasTextVars() const
Indicates the ShownText has text var references which need to be processed.
Definition: eda_text.h:114
bool operator>(const EDA_TEXT &aRhs) const
Definition: eda_text.h:356
virtual void SetVisible(bool aVisible)
Definition: eda_text.cpp:245
bool m_bounding_box_cache_valid
Definition: eda_text.h:428
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:755
static wxString GotoPageHref(const wxString &aDestination)
Generate a href to a page in the current schematic.
Definition: eda_text.cpp:1173
virtual void ClearBoundingBoxCache()
Definition: eda_text.cpp:505
virtual KIFONT::FONT * getDrawFont() const
Definition: eda_text.cpp:482
double GetLineSpacing() const
Definition: eda_text.h:216
double Similarity(const EDA_TEXT &aOther) const
Definition: eda_text.cpp:1151
VECTOR2I m_render_cache_offset
Definition: eda_text.h:425
void SetLineSpacing(double aLineSpacing)
Definition: eda_text.cpp:366
void AddRenderCacheGlyph(const SHAPE_POLY_SET &aPoly)
Definition: eda_text.cpp:555
void Empty()
Definition: eda_text.cpp:456
void SetTextThickness(int aWidth)
The TextThickness is that set by the user.
Definition: eda_text.cpp:197
virtual bool TextHitTest(const VECTOR2I &aPoint, int aAccuracy=0) const
Test if aPoint is within the bounds of this object.
Definition: eda_text.cpp:706
void FlipHJustify()
Definition: eda_text.h:169
void SetTextHeight(int aHeight)
Definition: eda_text.cpp:408
virtual void cacheShownText()
Definition: eda_text.cpp:464
EDA_ANGLE m_render_cache_angle
Definition: eda_text.h:424
static GR_TEXT_H_ALIGN_T MapHorizJustify(int aHorizJustify)
Definition: eda_text.cpp:63
bool m_bounding_box_cache_inverted
Definition: eda_text.h:431
virtual void ClearRenderCache()
Definition: eda_text.cpp:499
void RemoveHyperlink()
Definition: eda_text.h:361
const TEXT_ATTRIBUTES & GetAttributes() const
Definition: eda_text.h:192
void SetBold(bool aBold)
Definition: eda_text.cpp:221
static bool ValidateHyperlink(const wxString &aURL)
Check if aURL is a valid hyperlink.
Definition: eda_text.cpp:1088
VECTOR2I m_bounding_box_cache_pos
Definition: eda_text.h:429
bool IsMirrored() const
Definition: eda_text.h:151
int GetEffectiveTextPenWidth(int aDefaultPenWidth=0) const
The EffectiveTextPenWidth uses the text thickness if > 1 or aDefaultPenWidth.
Definition: eda_text.cpp:324
void SwapAttributes(EDA_TEXT &aTradingPartner)
Swap the text attributes of the two involved instances.
Definition: eda_text.cpp:311
wxString m_render_cache_text
Definition: eda_text.h:422
double GetTextAngleDegrees() const
Definition: eda_text.h:138
virtual const KIFONT::METRICS & getFontMetrics() const
Definition: eda_text.cpp:493
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:985
bool operator<(const EDA_TEXT &aRhs) const
Definition: eda_text.h:355
bool IsBold() const
Definition: eda_text.h:145
void SetTextAngleDegrees(double aOrientation)
Definition: eda_text.h:134
void SetHyperlink(wxString aLink)
Definition: eda_text.h:360
static GR_TEXT_V_ALIGN_T MapVertJustify(int aVertJustify)
Definition: eda_text.cpp:77
void SetKeepUpright(bool aKeepUpright)
Definition: eda_text.cpp:284
void CopyText(const EDA_TEXT &aSrc)
Definition: eda_text.cpp:190
GR_TEXT_V_ALIGN_T GetVertJustify() const
Definition: eda_text.h:164
virtual wxString GetShownText(bool aAllowExtraText, int aDepth=0) const
Return the string actually shown after processing of the base text.
Definition: eda_text.h:106
virtual void SetText(const wxString &aText)
Definition: eda_text.cpp:183
double Levenshtein(const EDA_TEXT &aOther) const
Return the levenstein distance between two texts.
Definition: eda_text.cpp:1105
virtual void SetTextAngle(const EDA_ANGLE &aAngle)
Definition: eda_text.cpp:205
void SetFontIndex(int aIdx)
Definition: eda_text.cpp:875
int GetTextThickness() const
Definition: eda_text.h:123
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:731
void SetItalic(bool aItalic)
Definition: eda_text.cpp:213
void SwapText(EDA_TEXT &aTradingPartner)
Definition: eda_text.cpp:304
bool operator==(const EDA_TEXT &aRhs) const
Definition: eda_text.h:354
void SetMultilineAllowed(bool aAllow)
Definition: eda_text.cpp:260
void SetFont(KIFONT::FONT *aFont)
Definition: eda_text.cpp:358
VECTOR2I GetTextSize() const
Definition: eda_text.h:219
void SetHorizJustify(GR_TEXT_H_ALIGN_T aType)
Definition: eda_text.cpp:268
TEXT_ATTRIBUTES m_attributes
Definition: eda_text.h:434
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:435
@ DEGREES_T
Definition: eda_angle.h:31
std::ostream & operator<<(std::ostream &aStream, const EDA_TEXT &aAttributes)
Definition: eda_text.cpp:1179
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:445
GR_TEXT_H_ALIGN_T
@ GR_TEXT_H_ALIGN_RIGHT
@ GR_TEXT_H_ALIGN_LEFT
GR_TEXT_V_ALIGN_T