/* * This program source code file is part of KiCad, a free EDA CAD application. * * Copyright (C) 2022-2023 KiCad Developers, see AUTHORS.txt for contributors. * * This program is free software; you can redistribute it and/or * modify it under the terms of the GNU General Public License * as published by the Free Software Foundation; either version 2 * of the License, or (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, you may find one here: * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html * or you may search the http://www.gnu.org website for the version 2 license, * or you may write to the Free Software Foundation, Inc., * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include SCH_TEXTBOX::SCH_TEXTBOX( SCH_LAYER_ID aLayer, int aLineWidth, FILL_T aFillType, const wxString& aText, KICAD_T aType ) : SCH_SHAPE( SHAPE_T::RECTANGLE, aLayer, aLineWidth, aFillType, aType ), EDA_TEXT( schIUScale, aText ) { m_layer = aLayer; SetHorizJustify( GR_TEXT_H_ALIGN_LEFT ); SetVertJustify( GR_TEXT_V_ALIGN_TOP ); SetMultilineAllowed( true ); m_excludedFromSim = false; int defaultMargin = GetLegacyTextMargin(); m_marginLeft = defaultMargin; m_marginTop = defaultMargin; m_marginRight = defaultMargin; m_marginBottom = defaultMargin; } SCH_TEXTBOX::SCH_TEXTBOX( const SCH_TEXTBOX& aText ) : SCH_SHAPE( aText ), EDA_TEXT( aText ) { m_excludedFromSim = aText.m_excludedFromSim; m_marginLeft = aText.m_marginLeft; m_marginTop = aText.m_marginTop; m_marginRight = aText.m_marginRight; m_marginBottom = aText.m_marginBottom; } int SCH_TEXTBOX::GetLegacyTextMargin() const { if( m_layer == LAYER_DEVICE ) return KiROUND( GetTextSize().y * 0.8 ); else return KiROUND( GetStroke().GetWidth() / 2.0 ) + KiROUND( GetTextSize().y * 0.75 ); } void SCH_TEXTBOX::MirrorHorizontally( int aCenter ) { // Text is NOT really mirrored; it just has its justification flipped if( GetTextAngle() == ANGLE_HORIZONTAL ) { if( GetHorizJustify() == GR_TEXT_H_ALIGN_LEFT ) SetHorizJustify( GR_TEXT_H_ALIGN_RIGHT ); else if( GetHorizJustify() == GR_TEXT_H_ALIGN_RIGHT ) SetHorizJustify( GR_TEXT_H_ALIGN_LEFT ); } } void SCH_TEXTBOX::MirrorVertically( int aCenter ) { // Text is NOT really mirrored; it just has its justification flipped if( GetTextAngle() == ANGLE_VERTICAL ) { if( GetHorizJustify() == GR_TEXT_H_ALIGN_LEFT ) SetHorizJustify( GR_TEXT_H_ALIGN_RIGHT ); else if( GetHorizJustify() == GR_TEXT_H_ALIGN_RIGHT ) SetHorizJustify( GR_TEXT_H_ALIGN_LEFT ); } } void SCH_TEXTBOX::Rotate( const VECTOR2I& aCenter, bool aRotateCCW ) { SCH_SHAPE::Rotate( aCenter, aRotateCCW ); SetTextAngle( GetTextAngle() == ANGLE_VERTICAL ? ANGLE_HORIZONTAL : ANGLE_VERTICAL ); } void SCH_TEXTBOX::Rotate90( bool aClockwise ) { SetTextAngle( GetTextAngle() == ANGLE_VERTICAL ? ANGLE_HORIZONTAL : ANGLE_VERTICAL ); } VECTOR2I SCH_TEXTBOX::GetDrawPos() const { BOX2I bbox = BOX2I( m_start, m_end - m_start ); bbox.Normalize(); VECTOR2I pos( bbox.GetLeft() + m_marginLeft, bbox.GetBottom() - m_marginBottom ); if( GetTextAngle().IsVertical() ) { switch( GetHorizJustify() ) { case GR_TEXT_H_ALIGN_LEFT: pos.y = bbox.GetBottom() - m_marginBottom; break; case GR_TEXT_H_ALIGN_CENTER: pos.y = ( bbox.GetTop() + bbox.GetBottom() ) / 2; break; case GR_TEXT_H_ALIGN_RIGHT: pos.y = bbox.GetTop() + m_marginTop; break; case GR_TEXT_H_ALIGN_INDETERMINATE: wxFAIL_MSG( wxT( "Indeterminate state legal only in dialogs." ) ); break; } switch( GetVertJustify() ) { case GR_TEXT_V_ALIGN_TOP: pos.x = bbox.GetLeft() + m_marginLeft; break; case GR_TEXT_V_ALIGN_CENTER: pos.x = ( bbox.GetLeft() + bbox.GetRight() ) / 2; break; case GR_TEXT_V_ALIGN_BOTTOM: pos.x = bbox.GetRight() - m_marginRight; break; case GR_TEXT_V_ALIGN_INDETERMINATE: wxFAIL_MSG( wxT( "Indeterminate state legal only in dialogs." ) ); break; } } else { switch( GetHorizJustify() ) { case GR_TEXT_H_ALIGN_LEFT: pos.x = bbox.GetLeft() + m_marginLeft; break; case GR_TEXT_H_ALIGN_CENTER: pos.x = ( bbox.GetLeft() + bbox.GetRight() ) / 2; break; case GR_TEXT_H_ALIGN_RIGHT: pos.x = bbox.GetRight() - m_marginRight; break; case GR_TEXT_H_ALIGN_INDETERMINATE: wxFAIL_MSG( wxT( "Indeterminate state legal only in dialogs." ) ); break; } switch( GetVertJustify() ) { case GR_TEXT_V_ALIGN_TOP: pos.y = bbox.GetTop() + m_marginTop; break; case GR_TEXT_V_ALIGN_CENTER: pos.y = ( bbox.GetTop() + bbox.GetBottom() ) / 2; break; case GR_TEXT_V_ALIGN_BOTTOM: pos.y = bbox.GetBottom() - m_marginBottom; break; case GR_TEXT_V_ALIGN_INDETERMINATE: wxFAIL_MSG( wxT( "Indeterminate state legal only in dialogs." ) ); break; } } return pos; } void SCH_TEXTBOX::SwapData( SCH_ITEM* aItem ) { SCH_SHAPE::SwapData( aItem ); SCH_TEXTBOX* item = static_cast( aItem ); std::swap( m_layer, item->m_layer ); std::swap( m_marginLeft, item->m_marginLeft ); std::swap( m_marginTop, item->m_marginTop ); std::swap( m_marginRight, item->m_marginRight ); std::swap( m_marginBottom, item->m_marginBottom ); SwapText( *item ); SwapAttributes( *item ); } bool SCH_TEXTBOX::operator<( const SCH_ITEM& aItem ) const { if( Type() != aItem.Type() ) return Type() < aItem.Type(); auto other = static_cast( &aItem ); if( GetLayer() != other->GetLayer() ) return GetLayer() < other->GetLayer(); if( GetPosition().x != other->GetPosition().x ) return GetPosition().x < other->GetPosition().x; if( GetPosition().y != other->GetPosition().y ) return GetPosition().y < other->GetPosition().y; if( GetMarginLeft() != other->GetMarginLeft() ) return GetMarginLeft() < other->GetMarginLeft(); if( GetMarginTop() != other->GetMarginTop() ) return GetMarginTop() < other->GetMarginTop(); if( GetMarginRight() != other->GetMarginRight() ) return GetMarginRight() < other->GetMarginRight(); if( GetMarginBottom() != other->GetMarginBottom() ) return GetMarginBottom() < other->GetMarginBottom(); if( GetExcludedFromSim() != other->GetExcludedFromSim() ) return GetExcludedFromSim() - other->GetExcludedFromSim(); return GetText() < other->GetText(); } KIFONT::FONT* SCH_TEXTBOX::getDrawFont() const { KIFONT::FONT* font = EDA_TEXT::GetFont(); if( !font ) font = KIFONT::FONT::GetFont( GetDefaultFont(), IsBold(), IsItalic() ); return font; } void SCH_TEXTBOX::Print( const SCH_RENDER_SETTINGS* aSettings, int aUnit, int aBodyStyle, const VECTOR2I& aOffset, bool aForceNoFill, bool aDimmed ) { if( IsPrivate() ) return; wxDC* DC = aSettings->GetPrintDC(); int penWidth = GetEffectivePenWidth( aSettings ); bool blackAndWhiteMode = GetGRForceBlackPenState(); VECTOR2I pt1 = GetStart(); VECTOR2I pt2 = GetEnd(); COLOR4D color = GetStroke().GetColor(); COLOR4D bg = aSettings->GetBackgroundColor(); LINE_STYLE lineStyle = GetStroke().GetLineStyle(); if( bg == COLOR4D::UNSPECIFIED || GetGRForceBlackPenState() ) bg = COLOR4D::WHITE; if( GetFillMode() == FILL_T::FILLED_WITH_COLOR && !blackAndWhiteMode && !aForceNoFill ) GRFilledRect( DC, pt1, pt2, 0, GetFillColor(), GetFillColor() ); if( penWidth > 0 ) { penWidth = std::max( penWidth, aSettings->GetMinPenWidth() ); if( blackAndWhiteMode || color == COLOR4D::UNSPECIFIED ) color = aSettings->GetLayerColor( m_layer ); if( aDimmed ) { color.Desaturate( ); color = color.Mix( bg, 0.5f ); } if( lineStyle == LINE_STYLE::DEFAULT ) lineStyle = LINE_STYLE::SOLID; if( lineStyle == LINE_STYLE::SOLID ) { GRRect( DC, pt1, pt2, penWidth, color ); } else { std::vector shapes = MakeEffectiveShapes( true ); for( SHAPE* shape : shapes ) { STROKE_PARAMS::Stroke( shape, lineStyle, penWidth, aSettings, [&]( const VECTOR2I& a, const VECTOR2I& b ) { VECTOR2I ptA = aSettings->TransformCoordinate( a ) + aOffset; VECTOR2I ptB = aSettings->TransformCoordinate( b ) + aOffset; GRLine( DC, ptA.x, ptA.y, ptB.x, ptB.y, penWidth, color ); } ); } for( SHAPE* shape : shapes ) delete shape; } } color = GetTextColor(); if( blackAndWhiteMode || color == COLOR4D::UNSPECIFIED ) color = aSettings->GetLayerColor( m_layer ); if( aDimmed ) { color.Desaturate( ); color = color.Mix( bg, 0.5f ); } EDA_TEXT::Print( aSettings, aOffset, color ); } wxString SCH_TEXTBOX::GetShownText( const SCH_SHEET_PATH* aPath, bool aAllowExtraText, int aDepth ) const { SCH_SHEET* sheet = nullptr; if( aPath ) sheet = aPath->Last(); std::function textResolver = [&]( wxString* token ) -> bool { if( sheet ) { if( sheet->ResolveTextVar( aPath, token, aDepth + 1 ) ) return true; } return false; }; wxString text = EDA_TEXT::GetShownText( aAllowExtraText, aDepth ); if( HasTextVars() ) { if( aDepth < 10 ) text = ExpandTextVars( text, &textResolver ); } VECTOR2I size = GetEnd() - GetStart(); int colWidth; if( GetTextAngle().IsVertical() ) colWidth = abs( size.y ) - ( GetMarginTop() + GetMarginBottom() ); else colWidth = abs( size.x ) - ( GetMarginLeft() + GetMarginRight() ); getDrawFont()->LinebreakText( text, colWidth, GetTextSize(), GetTextThickness(), IsBold(), IsItalic() ); return text; } bool SCH_TEXTBOX::HitTest( const VECTOR2I& aPosition, int aAccuracy ) const { BOX2I rect = GetBoundingBox(); rect.Inflate( aAccuracy ); return rect.Contains( aPosition ); } bool SCH_TEXTBOX::HitTest( const BOX2I& aRect, bool aContained, int aAccuracy ) const { BOX2I rect = aRect; rect.Inflate( aAccuracy ); if( aContained ) return rect.Contains( GetBoundingBox() ); return rect.Intersects( GetBoundingBox() ); } void SCH_TEXTBOX::DoHypertextAction( EDA_DRAW_FRAME* aFrame ) const { wxCHECK_MSG( IsHypertext(), /* void */, wxT( "Calling a hypertext menu on a SCH_TEXTBOX with no hyperlink?" ) ); SCH_NAVIGATE_TOOL* navTool = aFrame->GetToolManager()->GetTool(); navTool->HypertextCommand( m_hyperlink ); } wxString SCH_TEXTBOX::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const { return wxString::Format( _( "Text Box" ) ); } BITMAPS SCH_TEXTBOX::GetMenuImage() const { return BITMAPS::add_textbox; } void SCH_TEXTBOX::Plot( PLOTTER* aPlotter, bool aBackground, const SCH_PLOT_OPTS& aPlotOpts, int aUnit, int aBodyStyle, const VECTOR2I& aOffset, bool aDimmed ) { if( IsPrivate() ) return; SCH_SHAPE::Plot( aPlotter, aBackground, aPlotOpts, aUnit, aBodyStyle, aOffset, aDimmed ); if( aBackground ) return; SCH_SHEET_PATH* sheet = Schematic() ? &Schematic()->CurrentSheet() : nullptr; SCH_RENDER_SETTINGS* renderSettings = getRenderSettings( aPlotter ); int penWidth = GetEffectivePenWidth( renderSettings ); COLOR4D color = GetStroke().GetColor(); COLOR4D bg = renderSettings->GetBackgroundColor(); LINE_STYLE lineStyle = GetStroke().GetLineStyle(); if( penWidth > 0 ) { if( !aPlotter->GetColorMode() || color == COLOR4D::UNSPECIFIED ) color = renderSettings->GetLayerColor( m_layer ); if( aDimmed ) { color.Desaturate( ); color = color.Mix( bg, 0.5f ); } if( lineStyle == LINE_STYLE::DEFAULT ) lineStyle = LINE_STYLE::SOLID; aPlotter->SetColor( color ); aPlotter->SetDash( penWidth, lineStyle ); aPlotter->Rect( m_start, m_end, FILL_T::NO_FILL, penWidth ); aPlotter->SetDash( penWidth, LINE_STYLE::SOLID ); } KIFONT::FONT* font = getDrawFont(); color = GetTextColor(); if( !aPlotter->GetColorMode() || color == COLOR4D::UNSPECIFIED ) color = renderSettings->GetLayerColor( m_layer ); if( bg == COLOR4D::UNSPECIFIED || !aPlotter->GetColorMode() ) bg = COLOR4D::WHITE; if( aDimmed ) { color.Desaturate( ); color = color.Mix( bg, 0.5f ); } penWidth = GetEffectiveTextPenWidth( renderSettings->GetDefaultPenWidth() ); penWidth = std::max( penWidth, renderSettings->GetMinPenWidth() ); aPlotter->SetCurrentLineWidth( penWidth ); TEXT_ATTRIBUTES attrs; std::vector positions; wxArrayString strings_list; wxStringSplit( GetShownText( sheet, true ), strings_list, '\n' ); positions.reserve( strings_list.Count() ); if( renderSettings->m_Transform != TRANSFORM() || aOffset != VECTOR2I() ) { SCH_TEXTBOX temp( *this ); if( renderSettings->m_Transform.y1 ) { temp.SetTextAngle( temp.GetTextAngle() == ANGLE_HORIZONTAL ? ANGLE_VERTICAL : ANGLE_HORIZONTAL ); } temp.SetStart( renderSettings->TransformCoordinate( m_start ) + aOffset ); temp.SetEnd( renderSettings->TransformCoordinate( m_end ) + aOffset ); attrs = temp.GetAttributes(); temp.GetLinePositions( positions, (int) strings_list.Count() ); } else { attrs = GetAttributes(); GetLinePositions( positions, (int) strings_list.Count() ); } attrs.m_StrokeWidth = penWidth; attrs.m_Multiline = false; for( unsigned ii = 0; ii < strings_list.Count(); ii++ ) { aPlotter->PlotText( positions[ii], color, strings_list.Item( ii ), attrs, font, GetFontMetrics() ); } if( HasHyperlink() ) aPlotter->HyperlinkBox( GetBoundingBox(), GetHyperlink() ); } void SCH_TEXTBOX::GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector& aList ) { // Don't use GetShownText() here; we want to show the user the variable references aList.emplace_back( _( "Text Box" ), KIUI::EllipsizeStatusText( aFrame, GetText() ) ); if( m_excludedFromSim ) aList.emplace_back( _( "Exclude from" ), _( "Simulation" ) ); aList.emplace_back( _( "Font" ), GetFont() ? GetFont()->GetName() : _( "Default" ) ); wxString textStyle[] = { _( "Normal" ), _( "Italic" ), _( "Bold" ), _( "Bold Italic" ) }; int style = IsBold() && IsItalic() ? 3 : IsBold() ? 2 : IsItalic() ? 1 : 0; aList.emplace_back( _( "Style" ), textStyle[style] ); aList.emplace_back( _( "Text Size" ), aFrame->MessageTextFromValue( GetTextWidth() ) ); aList.emplace_back( _( "Box Width" ), aFrame->MessageTextFromValue( std::abs( GetEnd().x - GetStart().x ) ) ); aList.emplace_back( _( "Box Height" ), aFrame->MessageTextFromValue( std::abs( GetEnd().y - GetStart().y ) ) ); m_stroke.GetMsgPanelInfo( aFrame, aList ); } bool SCH_TEXTBOX::operator==( const SCH_ITEM& aOther ) const { if( Type() != aOther.Type() ) return false; const SCH_TEXTBOX& other = static_cast( aOther ); if( m_excludedFromSim != other.m_excludedFromSim ) return false; if( GetMarginLeft() != other.GetMarginLeft() ) return false; if( GetMarginTop() != other.GetMarginTop() ) return false; if( GetMarginRight() != other.GetMarginRight() ) return false; if( GetMarginBottom() != other.GetMarginBottom() ) return false; return SCH_SHAPE::operator==( aOther ) && EDA_TEXT::operator==( other ); } double SCH_TEXTBOX::Similarity( const SCH_ITEM& aOther ) const { if( m_Uuid == aOther.m_Uuid ) return 1.0; if( aOther.Type() != Type() ) return 0.0; auto other = static_cast( aOther ); double similarity = SimilarityBase( other ); if( m_excludedFromSim != other.m_excludedFromSim ) similarity *= 0.9; if( GetMarginLeft() != other.GetMarginLeft() ) similarity *= 0.9; if( GetMarginTop() != other.GetMarginTop() ) similarity *= 0.9; if( GetMarginRight() != other.GetMarginRight() ) similarity *= 0.9; if( GetMarginBottom() != other.GetMarginBottom() ) similarity *= 0.9; similarity *= SCH_SHAPE::Similarity( aOther ); similarity *= EDA_TEXT::Similarity( other ); return similarity; } int SCH_TEXTBOX::compare( const SCH_ITEM& aOther, int aCompareFlags ) const { wxASSERT( aOther.Type() == SCH_TEXTBOX_T ); int retv = SCH_SHAPE::compare( aOther, aCompareFlags ); if( retv ) return retv; const SCH_TEXTBOX* tmp = static_cast( &aOther ); int result = GetText().CmpNoCase( tmp->GetText() ); if( result != 0 ) return result; if( GetTextWidth() != tmp->GetTextWidth() ) return GetTextWidth() - tmp->GetTextWidth(); if( GetTextHeight() != tmp->GetTextHeight() ) return GetTextHeight() - tmp->GetTextHeight(); if( IsBold() != tmp->IsBold() ) return IsBold() - tmp->IsBold(); if( IsItalic() != tmp->IsItalic() ) return IsItalic() - tmp->IsItalic(); if( GetHorizJustify() != tmp->GetHorizJustify() ) return GetHorizJustify() - tmp->GetHorizJustify(); if( GetTextAngle().AsTenthsOfADegree() != tmp->GetTextAngle().AsTenthsOfADegree() ) return GetTextAngle().AsTenthsOfADegree() - tmp->GetTextAngle().AsTenthsOfADegree(); if( GetMarginLeft() != tmp->GetMarginLeft() ) return GetMarginLeft() - tmp->GetMarginLeft(); if( GetMarginTop() != tmp->GetMarginTop() ) return GetMarginTop() - tmp->GetMarginTop(); if( GetMarginRight() != tmp->GetMarginRight() ) return GetMarginRight() - tmp->GetMarginRight(); if( GetMarginBottom() != tmp->GetMarginBottom() ) return GetMarginBottom() - tmp->GetMarginBottom(); return 0; } static struct SCH_TEXTBOX_DESC { SCH_TEXTBOX_DESC() { PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance(); REGISTER_TYPE( SCH_TEXTBOX ); propMgr.AddTypeCast( new TYPE_CAST ); propMgr.AddTypeCast( new TYPE_CAST ); propMgr.AddTypeCast( new TYPE_CAST ); propMgr.InheritsAfter( TYPE_HASH( SCH_TEXTBOX ), TYPE_HASH( SCH_SHAPE ) ); propMgr.InheritsAfter( TYPE_HASH( SCH_TEXTBOX ), TYPE_HASH( EDA_SHAPE ) ); propMgr.InheritsAfter( TYPE_HASH( SCH_TEXTBOX ), TYPE_HASH( EDA_TEXT ) ); propMgr.Mask( TYPE_HASH( SCH_TEXTBOX ), TYPE_HASH( EDA_SHAPE ), _HKI( "Shape" ) ); propMgr.Mask( TYPE_HASH( SCH_TEXTBOX ), TYPE_HASH( EDA_TEXT ), _HKI( "Visible" ) ); propMgr.Mask( TYPE_HASH( SCH_TEXTBOX ), TYPE_HASH( EDA_TEXT ), _HKI( "Width" ) ); propMgr.Mask( TYPE_HASH( SCH_TEXTBOX ), TYPE_HASH( EDA_TEXT ), _HKI( "Height" ) ); propMgr.Mask( TYPE_HASH( SCH_TEXTBOX ), TYPE_HASH( EDA_TEXT ), _HKI( "Thickness" ) ); const wxString marginProps = _( "Margins" ); propMgr.AddProperty( new PROPERTY( _HKI( "Margin Left" ), &SCH_TEXTBOX::SetMarginLeft, &SCH_TEXTBOX::GetMarginLeft, PROPERTY_DISPLAY::PT_SIZE ), marginProps ); propMgr.AddProperty( new PROPERTY( _HKI( "Margin Top" ), &SCH_TEXTBOX::SetMarginTop, &SCH_TEXTBOX::GetMarginTop, PROPERTY_DISPLAY::PT_SIZE ), marginProps ); propMgr.AddProperty( new PROPERTY( _HKI( "Margin Right" ), &SCH_TEXTBOX::SetMarginRight, &SCH_TEXTBOX::GetMarginRight, PROPERTY_DISPLAY::PT_SIZE ), marginProps ); propMgr.AddProperty( new PROPERTY( _HKI( "Margin Bottom" ), &SCH_TEXTBOX::SetMarginBottom, &SCH_TEXTBOX::GetMarginBottom, PROPERTY_DISPLAY::PT_SIZE ), marginProps ); propMgr.AddProperty( new PROPERTY( _HKI( "Text Size" ), &SCH_TEXTBOX::SetSchTextSize, &SCH_TEXTBOX::GetSchTextSize, PROPERTY_DISPLAY::PT_SIZE ), _HKI( "Text Properties" ) ); propMgr.Mask( TYPE_HASH( SCH_TEXTBOX ), TYPE_HASH( EDA_TEXT ), _HKI( "Orientation" ) ); } } _SCH_TEXTBOX_DESC;