sch_label.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright (C) 1992-2024 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
 */
 
#ifndef SCH_LABEL_H
#define SCH_LABEL_H
 
#include <sch_text.h>
#include <sch_item.h>
#include <sch_field.h>
#include <sch_connection.h> // for CONNECTION_TYPE
 
class SCH_RULE_AREA;
 
 
/*
 * Spin style for labels of all kinds on schematics
 * Basically a higher level abstraction of rotation and justification of text
 */
class SPIN_STYLE
{
public:
 enum SPIN : int
 {
 LEFT = 0,
 UP = 1,
 RIGHT = 2,
 BOTTOM = 3
 };
 
 
 SPIN_STYLE() = default;
 constexpr SPIN_STYLE( SPIN aSpin ) : m_spin( aSpin )
 {
 }
 
 constexpr bool operator==( SPIN a ) const
 {
 return m_spin == a;
 }
 
 constexpr bool operator!=( SPIN a ) const
 {
 return m_spin != a;
 }
 
 operator int() const
 {
 return static_cast<int>( m_spin );
 }
 
 SPIN_STYLE RotateCCW();
 
 SPIN_STYLE MirrorX();
 
 SPIN_STYLE MirrorY();
 
private:
 SPIN m_spin;
};
 
 
/*
 * Label and flag shapes used with text objects.
 */
enum LABEL_FLAG_SHAPE
{
 L_INPUT,
 L_OUTPUT,
 L_BIDI,
 L_TRISTATE,
 L_UNSPECIFIED,
 
 F_FIRST,
 F_DOT = F_FIRST,
 F_ROUND,
 F_DIAMOND,
 F_RECTANGLE
};
 
/*
 * Specific enums for property manager (not used elsewhere)
 */
enum LABEL_SHAPE
{
 LABEL_INPUT = L_INPUT,
 LABEL_OUTPUT = L_OUTPUT,
 LABEL_BIDI = L_BIDI,
 LABEL_TRISTATE = L_TRISTATE,
 LABEL_PASSIVE = L_UNSPECIFIED
};
 
enum FLAG_SHAPE
{
 FLAG_DOT = F_DOT,
 FLAG_CIRCLE = F_ROUND,
 FLAG_DIAMOND = F_DIAMOND,
 FLAG_RECTANGLE = F_RECTANGLE
};
 
 
class SCH_LABEL_BASE : public SCH_TEXT
{
public:
 SCH_LABEL_BASE( const VECTOR2I& aPos, const wxString& aText, KICAD_T aType );
 
 SCH_LABEL_BASE( const SCH_LABEL_BASE& aLabel );
 
 SCH_LABEL_BASE& operator=( const SCH_LABEL_BASE& aLabel );
 
 // Abstract class
 virtual wxString GetClass() const override = 0;
 
 bool IsType( const std::vector<KICAD_T>& aScanTypes ) const override;
 
 void SwapData( SCH_ITEM* aItem ) override;
 
 bool CanConnect( const SCH_ITEM* aItem ) const override
 {
 switch( aItem->Type() )
 {
 case SCH_LINE_T:
 return aItem->GetLayer() == LAYER_WIRE || aItem->GetLayer() == LAYER_BUS;
 
 case SCH_BUS_WIRE_ENTRY_T:
 return true;
 
 case SCH_SYMBOL_T:
 return true;
 
 case SCH_LABEL_T:
 case SCH_GLOBAL_LABEL_T:
 case SCH_HIER_LABEL_T:
 case SCH_DIRECTIVE_LABEL_T:
 case SCH_SHEET_PIN_T:
 return true;
 
 default:
 return false;
 }
 }
 
 bool HasConnectivityChanges( const SCH_ITEM* aItem,
 const SCH_SHEET_PATH* aInstance = nullptr ) const override;
 
 LABEL_FLAG_SHAPE GetShape() const { return m_shape; }
 void SetShape( LABEL_FLAG_SHAPE aShape ) { m_shape = aShape; }
 
 // Type-specific versions for property manager
 LABEL_SHAPE GetLabelShape() const { return (LABEL_SHAPE) m_shape; }
 void SetLabelShape( LABEL_SHAPE aShape ) { m_shape = (LABEL_FLAG_SHAPE) aShape; }
 
 COLOR4D GetLabelColor() const;
 
 virtual void SetSpinStyle( SPIN_STYLE aSpinStyle );
 SPIN_STYLE GetSpinStyle() const;
 
 void SetLastResolvedState( const SCH_ITEM* aItem ) override
 {
 const SCH_LABEL_BASE* aLabel = dynamic_cast<const SCH_LABEL_BASE*>( aItem );
 
 if( aLabel )
 m_lastResolvedColor = aLabel->m_lastResolvedColor;
 }
 
 static const wxString GetDefaultFieldName( const wxString& aName, bool aUseDefaultName );
 
 virtual int GetMandatoryFieldCount() { return 0; }
 
 std::vector<SCH_FIELD>& GetFields() { return m_fields; }
 const std::vector<SCH_FIELD>& GetFields() const { return m_fields; }
 
 void SetFields( const std::vector<SCH_FIELD>& aFields )
 {
 m_fields = aFields; // vector copying, length is changed possibly
 }
 
 void AddFields( const std::vector<SCH_FIELD>& aFields )
 {
 m_fields.insert( m_fields.end(), aFields.begin(), aFields.end() );
 }
 
 void AddField( const SCH_FIELD& aField )
 {
 m_fields.push_back( aField );
 }
 
 bool IncrementLabel( int aIncrement );
 
 void Move( const VECTOR2I& aMoveVector ) override;
 void Rotate( const VECTOR2I& aCenter, bool aRotateCCW ) override;
 void Rotate90( bool aClockwise ) override;
 
 void MirrorSpinStyle( bool aLeftRight ) override;
 
 void MirrorHorizontally( int aCenter ) override;
 void MirrorVertically( int aCenter ) override;
 
 void SetPosition( const VECTOR2I& aPosition ) override;
 
 void AutoplaceFields( SCH_SCREEN* aScreen, bool aManual ) override;
 
 void GetIntersheetRefs( const SCH_SHEET_PATH* aPath,
 std::vector<std::pair<wxString, wxString>>* pages );
 
 void GetContextualTextVars( wxArrayString* aVars ) const;
 
 virtual bool ResolveTextVar( const SCH_SHEET_PATH* aPath, wxString* token, int aDepth ) const;
 
 wxString GetShownText( const SCH_SHEET_PATH* aPath, bool aAllowExtraText,
 int aDepth = 0 ) const override;
 
 wxString GetShownText( bool aAllowExtraText, int aDepth = 0 ) const override
 {
 SCHEMATIC* schematic = Schematic();
 
 if( schematic )
 return GetShownText( &schematic->CurrentSheet(), aAllowExtraText, aDepth );
 else
 return GetText();
 }
 
 bool HasCachedDriverName() const override;
 const wxString& GetCachedDriverName() const override;
 
 void RunOnChildren( const std::function<void( SCH_ITEM* )>& aFunction ) override;
 
 INSPECT_RESULT Visit( INSPECTOR inspector, void* testData,
 const std::vector<KICAD_T>& scanTypes ) override;
 
 bool Matches( const EDA_SEARCH_DATA& aSearchData, void* aAuxData ) const override;
 bool Replace( const EDA_SEARCH_DATA& aSearchData, void* aAuxData ) override;
 
 VECTOR2I GetSchematicTextOffset( const RENDER_SETTINGS* aSettings ) const override;
 
 virtual void CreateGraphicShape( const RENDER_SETTINGS* aSettings,
 std::vector<VECTOR2I>& aPoints, const VECTOR2I& Pos ) const
 {
 aPoints.clear();
 }
 
 int GetLabelBoxExpansion( const RENDER_SETTINGS* aSettings = nullptr ) const;
 
 virtual const BOX2I GetBodyBoundingBox() const;
 
 const BOX2I GetBoundingBox() const override;
 
 bool HitTest( const VECTOR2I& aPosition, int aAccuracy = 0 ) const override;
 bool HitTest( const BOX2I& aRect, bool aContained, int aAccuracy = 0 ) const override;
 
 std::vector<VECTOR2I> GetConnectionPoints() const override;
 
 void GetEndPoints( std::vector< DANGLING_END_ITEM >& aItemList ) override;
 
 bool UpdateDanglingState( std::vector<DANGLING_END_ITEM>& aItemListByType,
 std::vector<DANGLING_END_ITEM>& aItemListByPos,
 const SCH_SHEET_PATH* aPath = nullptr ) override;
 
 bool IsDangling() const override { return m_isDangling; }
 void SetIsDangling( bool aIsDangling ) { m_isDangling = aIsDangling; }
 
 void ViewGetLayers( int aLayers[], int& aCount ) const override;
 
 void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
 
 void Print( const SCH_RENDER_SETTINGS* aSettings, int aUnit, int aBodyStyle,
 const VECTOR2I& offset, bool aForceNoFill, bool aDimmed ) override;
 
 void Plot( PLOTTER* aPlotter, bool aBackground, const SCH_PLOT_OPTS& aPlotOpts,
 int aUnit, int aBodyStyle, const VECTOR2I& aOffset, bool aDimmed ) override;
 
 bool AutoRotateOnPlacement() const;
 
 void SetAutoRotateOnPlacement( bool autoRotate = true );
 
 virtual bool AutoRotateOnPlacementSupported() const = 0;
 
 double Similarity( const SCH_ITEM& aItem ) const override;
 
 bool operator==( const SCH_ITEM& aItem ) const override;
 
protected:
 void cacheShownText() override;
 
protected:
 std::vector<SCH_FIELD> m_fields;
 
 LABEL_FLAG_SHAPE m_shape;
 
 CONNECTION_TYPE m_connectionType;
 bool m_isDangling;
 bool m_autoRotateOnPlacement = false;
 
 mutable COLOR4D m_lastResolvedColor;
 
 wxString m_cached_driver_name;
};
 
 
class SCH_LABEL : public SCH_LABEL_BASE
{
public:
 SCH_LABEL( const VECTOR2I& aPos = VECTOR2I( 0, 0 ), const wxString& aText = wxEmptyString );
 
 // Do not create a copy constructor. The one generated by the compiler is adequate.
 
 ~SCH_LABEL() { }
 
 void Serialize( google::protobuf::Any &aContainer ) const override;
 bool Deserialize( const google::protobuf::Any &aContainer ) override;
 
 static inline bool ClassOf( const EDA_ITEM* aItem )
 {
 return aItem && SCH_LABEL_T == aItem->Type();
 }
 
 wxString GetClass() const override
 {
 return wxT( "SCH_LABEL" );
 }
 
 const BOX2I GetBodyBoundingBox() const override;
 
 bool IsConnectable() const override { return true; }
 
 wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override;
 
 BITMAPS GetMenuImage() const override;
 
 bool IsReplaceable() const override { return true; }
 
 EDA_ITEM* Clone() const override
 {
 return new SCH_LABEL( *this );
 }
 
 bool IsPointClickableAnchor( const VECTOR2I& aPos ) const override
 {
 return m_isDangling && GetPosition() == aPos;
 }
 
 bool AutoRotateOnPlacementSupported() const override { return false; }
 
private:
 bool doIsConnected( const VECTOR2I& aPosition ) const override
 {
 return EDA_TEXT::GetTextPos() == aPosition;
 }
};
 
 
class SCH_DIRECTIVE_LABEL : public SCH_LABEL_BASE
{
public:
 SCH_DIRECTIVE_LABEL( const VECTOR2I& aPos = VECTOR2I( 0, 0 ) );
 
 SCH_DIRECTIVE_LABEL( const SCH_DIRECTIVE_LABEL& aClassLabel );
 
 ~SCH_DIRECTIVE_LABEL() { }
 
 void Serialize( google::protobuf::Any &aContainer ) const override;
 bool Deserialize( const google::protobuf::Any &aContainer ) override;
 
 static inline bool ClassOf( const EDA_ITEM* aItem )
 {
 return aItem && SCH_DIRECTIVE_LABEL_T == aItem->Type();
 }
 
 wxString GetClass() const override
 {
 return wxT( "SCH_DIRECTIVE_LABEL" );
 }
 
 EDA_ITEM* Clone() const override
 {
 return new SCH_DIRECTIVE_LABEL( *this );
 }
 
 void SwapData( SCH_ITEM* aItem ) override;
 
 FLAG_SHAPE GetFlagShape() const { return (FLAG_SHAPE) m_shape; }
 void SetFlagShape( FLAG_SHAPE aShape ) { m_shape = (LABEL_FLAG_SHAPE) aShape; }
 
 int GetPinLength() const { return m_pinLength; }
 void SetPinLength( int aLength ) { m_pinLength = aLength; }
 
 int GetPenWidth() const override;
 
 void CreateGraphicShape( const RENDER_SETTINGS* aSettings, std::vector<VECTOR2I>& aPoints,
 const VECTOR2I& aPos ) const override;
 
 void AutoplaceFields( SCH_SCREEN* aScreen, bool aManual ) override;
 
 wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override;
 
 bool IsConnectable() const override { return true; }
 
 bool AutoRotateOnPlacementSupported() const override { return false; }
 
 void MirrorSpinStyle( bool aLeftRight ) override;
 
 void MirrorHorizontally( int aCenter ) override;
 void MirrorVertically( int aCenter ) override;
 
 void AddConnectedRuleArea( SCH_RULE_AREA* aRuleArea );
 
 void ClearConnectedRuleAreas();
 
 void RemoveConnectedRuleArea( SCH_RULE_AREA* aRuleArea );
 
 virtual bool IsDangling() const override;
 
private:
 int m_pinLength;
 int m_symbolSize;
 
 std::unordered_set<SCH_RULE_AREA*> m_connected_rule_areas;
};
 
 
class SCH_GLOBALLABEL : public SCH_LABEL_BASE
{
public:
 SCH_GLOBALLABEL( const VECTOR2I& aPos = VECTOR2I( 0, 0 ),
 const wxString& aText = wxEmptyString );
 
 SCH_GLOBALLABEL( const SCH_GLOBALLABEL& aGlobalLabel );
 
 ~SCH_GLOBALLABEL() { }
 
 void Serialize( google::protobuf::Any &aContainer ) const override;
 bool Deserialize( const google::protobuf::Any &aContainer ) override;
 
 static inline bool ClassOf( const EDA_ITEM* aItem )
 {
 return aItem && SCH_GLOBAL_LABEL_T == aItem->Type();
 }
 
 wxString GetClass() const override
 {
 return wxT( "SCH_GLOBALLABEL" );
 }
 
 EDA_ITEM* Clone() const override
 {
 return new SCH_GLOBALLABEL( *this );
 }
 
 int GetMandatoryFieldCount() override { return 1; }
 
 void SetSpinStyle( SPIN_STYLE aSpinStyle ) override;
 
 VECTOR2I GetSchematicTextOffset( const RENDER_SETTINGS* aSettings ) const override;
 
 void CreateGraphicShape( const RENDER_SETTINGS* aRenderSettings, std::vector<VECTOR2I>& aPoints,
 const VECTOR2I& aPos ) const override;
 
 bool ResolveTextVar( const SCH_SHEET_PATH* aPath, wxString* token, int aDepth ) const override;
 
 bool IsConnectable() const override { return true; }
 
 void ViewGetLayers( int aLayers[], int& aCount ) const override;
 
 wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override;
 
 BITMAPS GetMenuImage() const override;
 
 bool IsPointClickableAnchor( const VECTOR2I& aPos ) const override
 {
 return m_isDangling && GetPosition() == aPos;
 }
 
 bool AutoRotateOnPlacementSupported() const override { return true; }
 
private:
 bool doIsConnected( const VECTOR2I& aPosition ) const override
 {
 return EDA_TEXT::GetTextPos() == aPosition;
 }
};
 
 
class SCH_HIERLABEL : public SCH_LABEL_BASE
{
public:
 SCH_HIERLABEL( const VECTOR2I& aPos = VECTOR2I( 0, 0 ), const wxString& aText = wxEmptyString,
 KICAD_T aType = SCH_HIER_LABEL_T );
 
 // Do not create a copy constructor. The one generated by the compiler is adequate.
 
 ~SCH_HIERLABEL() { }
 
 void Serialize( google::protobuf::Any &aContainer ) const override;
 bool Deserialize( const google::protobuf::Any &aContainer ) override;
 
 static inline bool ClassOf( const EDA_ITEM* aItem )
 {
 return aItem && SCH_HIER_LABEL_T == aItem->Type();
 }
 
 wxString GetClass() const override
 {
 return wxT( "SCH_HIERLABEL" );
 }
 
 void SetSpinStyle( SPIN_STYLE aSpinStyle ) override;
 
 VECTOR2I GetSchematicTextOffset( const RENDER_SETTINGS* aSettings ) const override;
 
 void CreateGraphicShape( const RENDER_SETTINGS* aSettings, std::vector<VECTOR2I>& aPoints,
 const VECTOR2I& aPos ) const override;
 void CreateGraphicShape( const RENDER_SETTINGS* aSettings, std::vector<VECTOR2I>& aPoints,
 const VECTOR2I& aPos, LABEL_FLAG_SHAPE aShape ) const;
 
 const BOX2I GetBodyBoundingBox() const override;
 
 bool IsConnectable() const override { return true; }
 
 wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override;
 
 BITMAPS GetMenuImage() const override;
 
 EDA_ITEM* Clone() const override
 {
 return new SCH_HIERLABEL( *this );
 }
 
 bool IsPointClickableAnchor( const VECTOR2I& aPos ) const override
 {
 return m_isDangling && GetPosition() == aPos;
 }
 
 bool AutoRotateOnPlacementSupported() const override { return true; }
 
private:
 bool doIsConnected( const VECTOR2I& aPosition ) const override
 {
 return EDA_TEXT::GetTextPos() == aPosition;
 }
};
 
#endif /* SCH_LABEL_H */