sch_field.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) 2022 CERN
 * Copyright The 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, see <https://www.gnu.org/licenses/>.
 */
 
#pragma once
 
 
#include <eda_text.h>
#include <sch_item.h>
#include <template_fieldnames.h>
#include <general.h>
#include <string_utils.h>
#include "scintilla_tricks.h"
#include <algorithm>
 
class SCH_EDIT_FRAME;
class SCH_TEXT;
 
namespace kiapi::schematic::types
{
    class SchematicField;
}
 
 
struct SCH_FIELD_RENDER_CACHE_DATA
{
    VECTOR2I                                    pos;
    std::vector<std::unique_ptr<KIFONT::GLYPH>> glyphs;
};
 
 
class SCH_FIELD : public SCH_ITEM, public EDA_TEXT
{
public:
    SCH_FIELD();    // For std::map::operator[]
 
    explicit SCH_FIELD( SCH_ITEM* aParent, FIELD_T aFieldId = FIELD_T::USER, const wxString& aName = wxEmptyString );
 
    explicit SCH_FIELD( SCH_ITEM* aParent, SCH_TEXT* aText );
 
    SCH_FIELD( const SCH_FIELD& aText );
 
    void Serialize( google::protobuf::Any& aContainer ) const override;
    bool Deserialize( const google::protobuf::Any& aContainer ) override;
 
    void Serialize( kiapi::schematic::types::SchematicField& aOutput,
                    const EDA_IU_SCALE& aScale ) const;
    bool Deserialize( const kiapi::schematic::types::SchematicField& aInput,
                      const EDA_IU_SCALE& aScale );
 
    ~SCH_FIELD() override
    { }
 
    SCH_FIELD& operator=( const SCH_FIELD& aField );
 
    static bool ClassOf( const EDA_ITEM* aItem )
    {
        return aItem && SCH_FIELD_T == aItem->Type();
    }
 
    wxString GetClass() const override
    {
        return wxT( "SCH_FIELD" );
    }
 
    bool IsType( const std::vector<KICAD_T>& aScanTypes ) const override
    {
        if( SCH_ITEM::IsType( aScanTypes ) )
            return true;
 
        for( KICAD_T scanType : aScanTypes )
        {
            if( scanType == SCH_FIELD_LOCATE_REFERENCE_T && m_id == FIELD_T::REFERENCE )
                return true;
            else if ( scanType == SCH_FIELD_LOCATE_VALUE_T && m_id == FIELD_T::VALUE )
                return true;
            else if ( scanType == SCH_FIELD_LOCATE_FOOTPRINT_T && m_id == FIELD_T::FOOTPRINT )
                return true;
            else if ( scanType == SCH_FIELD_LOCATE_DATASHEET_T && m_id == FIELD_T::DATASHEET )
                return true;
        }
 
        return false;
    }
 
    wxString GetFriendlyName() const override
    {
        return _( "Field" );
    }
 
    bool HasHypertext() const override;
 
    void DoHypertextAction( EDA_DRAW_FRAME* aFrame, const VECTOR2I& aMousePos ) const override;

    wxString GetName( bool aUseDefaultName = true ) const;

    wxString GetUntranslatedName() const;

    static bool IsNetclassLabelFieldName( const wxString& aName );
 
    void SetName( const wxString& aName );
 
    void SetText( const wxString& aText ) override;
 
    void SetText( const wxString& aText, const SCH_SHEET_PATH* aPath, const wxString& aVariantName = wxEmptyString );
 
    virtual const wxString& GetText() const override { return EDA_TEXT::GetText(); }
 
    wxString GetText( const SCH_SHEET_PATH* aPath, const wxString& aVariantName = wxEmptyString ) const;
 
    FIELD_T GetId() const { return m_id; }
 
    int GetOrdinal() const
    {
        return IsMandatory() ? (int) m_id : m_ordinal;
    }
    void SetOrdinal( int aOrdinal, FIELD_T aType )
    {
        m_id = aType;
        m_ordinal = aOrdinal;
    }

    wxString GetShownName() const;
    wxString GetShownText( const SCH_SHEET_PATH* aPath, RESOLUTION_CONTEXT aContext,
                           const wxString& aVariantName = wxEmptyString, int aDepth = 0 ) const;
 
    wxString GetShownText( RESOLUTION_CONTEXT aContextx, int aDepth = 0 ) const override;

    wxString GetFullText( int unit = 1 ) const;

    bool IsEmpty()
    {
        wxString name( m_name );
        wxString value( GetText() );
 
        return name.Trim().empty() && value.Trim().empty();
    }
 
    int GetSchTextSize() const { return GetTextWidth(); }
    void SetSchTextSize( int aSize ) { SetTextSize( VECTOR2I( aSize, aSize ) ); }
 
    COLOR4D GetFieldColor() const;
 
    void SetLastResolvedState( const SCH_ITEM* aItem ) override
    {
        const SCH_FIELD* aField = dynamic_cast<const SCH_FIELD*>( aItem );
 
        if( aField )
            m_lastResolvedColor = aField->m_lastResolvedColor;
    }
 
    std::vector<int> ViewGetLayers() const override;
 
    SCH_LAYER_ID GetDefaultLayer() const;

    EDA_ANGLE GetDrawRotation() const override;
 
    KIFONT::FONT* GetDrawFont( const RENDER_SETTINGS* aSettings ) const override;
 
    const BOX2I GetBoundingBox() const override;

    bool IsHorizJustifyFlipped() const;
    bool IsVertJustifyFlipped() const;
 
    GR_TEXT_H_ALIGN_T GetEffectiveHorizJustify() const;
    GR_TEXT_V_ALIGN_T GetEffectiveVertJustify() const;
 
    void SetEffectiveHorizJustify( GR_TEXT_H_ALIGN_T );
    void SetEffectiveVertJustify( GR_TEXT_V_ALIGN_T );
 
    bool IsNameShown() const { return m_showName; }
    void SetNameShown( bool aShown = true ) { m_showName = aShown; }

    bool IsGeneratedField() const { return m_isGeneratedField; }
 
    bool CanAutoplace() const { return m_allowAutoPlace; }
    void SetCanAutoplace( bool aCanPlace ) { m_allowAutoPlace = aCanPlace; }
 
    void swapData( SCH_ITEM* aItem ) override;
 
    int GetPenWidth() const override;
 
    bool IsAutoAdded() const { return m_autoAdded; }
    void SetAutoAdded( bool aAutoAdded ) { m_autoAdded = aAutoAdded; }
 
    bool ShowInChooser() const { return m_showInChooser; }
    void SetShowInChooser( bool aShow = true ) { m_showInChooser = aShow; }
 
    void ClearCaches() override;
    void ClearRenderCache() override;
 
    std::vector<std::unique_ptr<KIFONT::GLYPH>>*
    GetRenderCache( const wxString& forResolvedText, const VECTOR2I& forPosition, TEXT_ATTRIBUTES& aAttrs ) const;
 
    void Move( const VECTOR2I& aMoveVector ) override
    {
        Offset( aMoveVector );
    }
 
    void Rotate( const VECTOR2I& aCenter, bool aRotateCCW ) override;
 
    void MirrorVertically( int aCenter ) override;
    void MirrorHorizontally( int aCenter ) override;
 
    void BeginEdit( const VECTOR2I& aStartPoint ) override;
    void CalcEdit( const VECTOR2I& aPosition ) override;
 
    void OnScintillaCharAdded( SCINTILLA_TRICKS* aScintillaTricks, wxStyledTextEvent &aEvent ) const;
 
    bool Matches( const EDA_SEARCH_DATA& aSearchData, void* aAuxData ) const override;
 
    bool Replace( const EDA_SEARCH_DATA& aSearchData, void* aAuxData = nullptr ) override;
 
    wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const override;
    void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
 
    BITMAPS GetMenuImage() const override;
 
    bool IsReplaceable() const override;
 
    bool IsLocked() const override;
 
    VECTOR2I GetLibPosition() const { return EDA_TEXT::GetTextPos(); }
 
    VECTOR2I GetPosition() const override;
    void     SetPosition( const VECTOR2I& aPosition ) override;
 
    VECTOR2I GetParentPosition() const;
 
    bool HitTest( const VECTOR2I& aPosition, int aAccuracy = 0 ) const override;
    bool HitTest( const BOX2I& aRect, bool aContained, int aAccuracy = 0 ) const override;
    bool HitTest( const SHAPE_LINE_CHAIN& aPoly, bool aContained ) const override;
 
    void Plot( PLOTTER* aPlotter, bool aBackground, const SCH_PLOT_OPTS& aPlotOpts,
               int aUnit, int aBodyStyle, const VECTOR2I& aOffset, bool aDimmed ) override;
 
    EDA_ITEM* Clone() const override;

    void ImportValues( const SCH_FIELD& aSource );

    void Copy( SCH_FIELD* aTarget ) const;
 
    bool IsMandatory() const;
 
    bool operator <( const SCH_ITEM& aItem ) const override;
 
    double Similarity( const SCH_ITEM& aItem ) const override;
 
    bool operator==( const SCH_ITEM& aItem ) const override;
    bool operator==( const SCH_FIELD& aItem ) const;

    bool HasSameContent( const SCH_FIELD& aOther ) const;
 
#if defined(DEBUG)
    void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
#endif
 
protected:
    friend class SCH_IO_KICAD_SEXPR_PARSER;
 
    const KIFONT::METRICS& getFontMetrics() const override { return GetFontMetrics(); }

    int compare( const SCH_ITEM& aOther, int aCompareFlags = 0 ) const override;
 
    void setId( FIELD_T aId );
 
    wxString getUnescapedText( const SCH_SHEET_PATH* aPath = nullptr,
                               const wxString& aVariantName = wxEmptyString ) const;
 
private:
    FIELD_T  m_id;               
    int      m_ordinal;          
    wxString m_name;
 
    bool     m_showName;         
    bool     m_allowAutoPlace;   
    bool     m_isGeneratedField; 
 
    bool     m_autoAdded;        
    bool     m_showInChooser;    
 
    mutable std::unique_ptr<SCH_FIELD_RENDER_CACHE_DATA> m_renderCache;
 
    mutable COLOR4D                                     m_lastResolvedColor;
};
 
 
inline int NextFieldOrdinal( const std::vector<SCH_FIELD>& aFields )
{
    int ordinal = 42;     // Arbitrarily larger than any mandatory FIELD_T id
 
    for( const SCH_FIELD& field : aFields )
        ordinal = std::max( ordinal, field.GetOrdinal() + 1 );
 
    return ordinal;
}
 
 
inline const SCH_FIELD* FindField( const std::vector<SCH_FIELD>& aFields, FIELD_T aFieldId )
{
    for( const SCH_FIELD& field : aFields )
    {
        if( field.GetId() == aFieldId )
            return &field;
    }
 
    return nullptr;
}
 
 
inline SCH_FIELD* FindField( std::vector<SCH_FIELD>& aFields, FIELD_T aFieldId )
{
    const std::vector<SCH_FIELD>& constFields = const_cast<const std::vector<SCH_FIELD>&>( aFields );
    return const_cast<SCH_FIELD*>( FindField( constFields, aFieldId ) );
}
 
 
inline const SCH_FIELD* FindField( const std::vector<SCH_FIELD>& aFields, const wxString& aFieldName )
{
    for( const SCH_FIELD& field : aFields )
    {
        if( field.GetName() == aFieldName )
            return &field;
    }
 
    return nullptr;
}
 
 
inline SCH_FIELD* FindField( std::vector<SCH_FIELD>& aFields, const wxString& aFieldName )
{
    const std::vector<SCH_FIELD>& constFields = const_cast<const std::vector<SCH_FIELD>&>( aFields );
    return const_cast<SCH_FIELD*>( FindField( constFields, aFieldName ) );
}
 
 
inline wxString GetFieldValue( const std::vector<SCH_FIELD>* aFields, FIELD_T aFieldType )
{
    if( !aFields )
        return wxEmptyString;
 
    if( const SCH_FIELD* field = FindField( *aFields, aFieldType ) )
        return field->GetText();
 
    return wxEmptyString;
}
 
 
inline std::string GetFieldValue( const std::vector<SCH_FIELD>* aFields, const wxString& aFieldName,
                                  bool aResolve, int aDepth )
{
    if( !aFields )
        return "";
 
    if( const SCH_FIELD* field = FindField( *aFields, aFieldName ) )
        return ( aResolve ? field->GetShownText( INTERNAL, aDepth ) : field->GetText() ).ToStdString();
 
    return "";
}
 
 
inline void SetFieldValue( std::vector<SCH_FIELD>& aFields, const wxString& aFieldName,
                           const std::string& aValue, bool aIsVisible = true,
                           const SCH_SHEET_PATH* aSheetPath = nullptr, const wxString& aVariantName = wxEmptyString )
{
    if( !aSheetPath || aVariantName.empty() )
    {
        // Without a sheet path this is a local write (usually to the Symbol Properties dialog's copy of the
        // fields).  Variant handling will apply only when the local fields are written back to the symbol.
 
        if( aValue == "" )
        {
            std::erase_if( aFields, [&]( const SCH_FIELD& field )
                                    {
                                        return field.GetName() == aFieldName;
                                    } );
            return;
        }
 
        if( SCH_FIELD* field = FindField( aFields, aFieldName ) )
        {
            field->SetText( aValue );
            return;
        }
 
        SCH_ITEM* parent = static_cast<SCH_ITEM*>( aFields.at( 0 ).GetParent() );
        aFields.emplace_back( parent, FIELD_T::USER, aFieldName );
 
        aFields.back().SetText( aValue );
        aFields.back().SetVisible( aIsVisible );
        return;
    }
 
    if( SCH_FIELD* field = FindField( aFields, aFieldName ) )
    {
        field->SetText( aValue, aSheetPath, aVariantName );
        return;
    }
 
    SCH_ITEM* parent = static_cast<SCH_ITEM*>( aFields.at( 0 ).GetParent() );
    aFields.emplace_back( parent, FIELD_T::USER, aFieldName );
 
    // Since the default variant doesn't have this field at all, we're going to set it to the same value
    // and visibility as specified for the variant.  We therefore don't really have a variant at all, so we
    // can ignore variant processing here.
    aFields.back().SetText( aValue );
    aFields.back().SetVisible( aIsVisible );
}