sch_field.cpp

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 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, 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 <wx/log.h>
#include <wx/menu.h>
 
#include <advanced_config.h>
#include <base_units.h>
#include <common.h> // for ExpandTextVars
#include <sch_edit_frame.h>
#include <plotters/plotter.h>
#include <bitmaps.h>
#include <kiway.h>
#include <settings/color_settings.h>
#include <string_utils.h>
#include <geometry/geometry_utils.h>
#include <trace_helpers.h>
#include <tool/tool_manager.h>
#include <tools/sch_navigate_tool.h>
#include <font/outline_font.h>
#include "sim/sim_lib_mgr.h"
#include <properties/property.h>
#include <properties/property_mgr.h>
#include <google/protobuf/any.pb.h>
#include <api/schematic/schematic_types.pb.h>
 
static const std::vector<KICAD_T> labelTypes = { SCH_LABEL_LOCATE_ANY_T };
 
 
SCH_FIELD::SCH_FIELD() :
        SCH_ITEM( nullptr, SCH_FIELD_T ),
        EDA_TEXT( schIUScale, wxEmptyString ),
        m_id( FIELD_T::USER ),
        m_ordinal( 0 ),
        m_showName( false ),
        m_allowAutoPlace( true ),
        m_isGeneratedField( false ),
        m_autoAdded( false ),
        m_showInChooser( true ),
        m_lastResolvedColor( COLOR4D::UNSPECIFIED )
{
}
 
 
SCH_FIELD::SCH_FIELD( SCH_ITEM* aParent, FIELD_T aFieldId, const wxString& aName ) :
        SCH_FIELD()
{
    m_parent = aParent;
 
    if( !aName.IsEmpty() )
        SetName( aName );
    else
        SetName( GetDefaultFieldName( aFieldId, DO_TRANSLATE ) );
 
    setId( aFieldId ); // will also set the layer
    SetVisible( true );
 
    if( aParent && aParent->Schematic() )
    {
        SCHEMATIC_SETTINGS& settings = aParent->Schematic()->Settings();
        SetTextSize( VECTOR2I( settings.m_DefaultTextSize, settings.m_DefaultTextSize ) );
    }
 
    if( aFieldId == FIELD_T::USER && aParent )
    {
        if( aParent->Type() == SCH_SYMBOL_T )
            m_ordinal = static_cast<SCH_SYMBOL*>( aParent )->GetNextFieldOrdinal();
        else if( aParent->Type() == LIB_SYMBOL_T )
            m_ordinal = static_cast<LIB_SYMBOL*>( aParent )->GetNextFieldOrdinal();
        else if( aParent->Type() == SCH_SHEET_T )
            m_ordinal = static_cast<SCH_SHEET*>( aParent )->GetNextFieldOrdinal();
        else if( SCH_LABEL_BASE* label = dynamic_cast<SCH_LABEL_BASE*>( aParent ) )
            m_ordinal = label->GetNextFieldOrdinal();
    }
}
 
 
SCH_FIELD::SCH_FIELD( SCH_ITEM* aParent, SCH_TEXT* aText ) :
        SCH_FIELD( aParent, FIELD_T::USER, wxEmptyString )
{
    SCH_ITEM::operator=( *aText );
    EDA_TEXT::operator=( *aText );
}
 
 
SCH_FIELD::SCH_FIELD( const SCH_FIELD& aField ) :
        SCH_ITEM( aField ),
        EDA_TEXT( aField )
{
    m_private = aField.m_private;
    setId( aField.m_id ); // will also set the layer
    m_ordinal = aField.m_ordinal;
    m_name = aField.m_name;
    m_showName = aField.m_showName;
    m_allowAutoPlace = aField.m_allowAutoPlace;
    m_isGeneratedField = aField.m_isGeneratedField;
    m_autoAdded = aField.m_autoAdded;
    m_showInChooser = aField.m_showInChooser;
    m_lastResolvedColor = aField.m_lastResolvedColor;
 
    m_renderCache.reset();
}
 
 
void SCH_FIELD::Serialize( google::protobuf::Any& aContainer ) const
{
    kiapi::schematic::types::SchematicField field;
 
    field.set_name( GetName( false ).ToUTF8() );
    field.set_visible( IsVisible() );
    field.set_show_name( IsNameShown() );
    field.set_allow_auto_place( CanAutoplace() );
 
    google::protobuf::Any any;
    EDA_TEXT::Serialize( any, schIUScale );
    any.UnpackTo( field.mutable_text() );
 
    aContainer.PackFrom( field );
}
 
 
bool SCH_FIELD::Deserialize( const google::protobuf::Any& aContainer )
{
    kiapi::schematic::types::SchematicField field;
 
    if( !aContainer.UnpackTo( &field ) )
        return false;
 
    SetName( wxString::FromUTF8( field.name() ) );
    SetVisible( field.visible() );
    SetNameShown( field.show_name() );
    SetCanAutoplace( field.allow_auto_place() );
 
    google::protobuf::Any any;
    any.PackFrom( field.text() );
    return EDA_TEXT::Deserialize( any, schIUScale );
}
 
 
SCH_FIELD& SCH_FIELD::operator=( const SCH_FIELD& aField )
{
    EDA_TEXT::operator=( aField );
 
    m_private = aField.m_private;
    setId( aField.m_id ); // will also set the layer
    m_ordinal = aField.m_ordinal;
    m_name = aField.m_name;
    m_showName = aField.m_showName;
    m_allowAutoPlace = aField.m_allowAutoPlace;
    m_isGeneratedField = aField.m_isGeneratedField;
    m_lastResolvedColor = aField.m_lastResolvedColor;
 
    m_renderCache.reset();
 
    return *this;
}
 
 
EDA_ITEM* SCH_FIELD::Clone() const
{
    return new SCH_FIELD( *this );
}
 
 
void SCH_FIELD::Copy( SCH_FIELD* aTarget ) const
{
    *aTarget = *this;
}
 
 
void SCH_FIELD::setId( FIELD_T aId )
{
    m_id = aId;
    SetLayer( GetDefaultLayer() );
}
 
 
wxString SCH_FIELD::GetShownName() const
{
    return m_isGeneratedField ? GetGeneratedFieldDisplayName( GetName() ) : GetName();
}
 
 
wxString SCH_FIELD::GetShownText( const SCH_SHEET_PATH* aPath, bool aAllowExtraText, int aDepth,
                                  const wxString& aVariantName ) const
{
    wxString text = getUnescapedText( aPath, aVariantName );
 
    if( IsNameShown() && aAllowExtraText )
        text = GetShownName() << wxS( ": " ) << text;
 
    if( HasTextVars() )
        text = ResolveText( text, aPath, aDepth );
 
    if( m_id == FIELD_T::SHEET_FILENAME && aAllowExtraText && !IsNameShown() )
        text = _( "File:" ) + wxS( " " ) + text;
 
    // Convert escape markers back to literals for final display
    text.Replace( wxT( "<<<ESC_DOLLAR:" ), wxT( "${" ) );
    text.Replace( wxT( "<<<ESC_AT:" ), wxT( "@{" ) );
 
    return text;
}
 
 
wxString SCH_FIELD::GetShownText( bool aAllowExtraText, int aDepth ) const
{
    if( SCHEMATIC* schematic = Schematic() )
    {
        const SCH_SHEET_PATH& currentSheet = schematic->CurrentSheet();
        wxString variantName = schematic->GetCurrentVariant();
 
        wxLogTrace( traceSchFieldRendering,
                    "GetShownText (no path arg): field=%s, current sheet path='%s', variant='%s', size=%zu, empty=%d",
                    GetName(), currentSheet.Path().AsString(), variantName, currentSheet.size(),
                    currentSheet.empty() ? 1 : 0 );
        return GetShownText( &currentSheet, aAllowExtraText, aDepth, variantName );
    }
    else
    {
        return GetShownText( nullptr, aAllowExtraText, aDepth );
    }
}
 
 
wxString SCH_FIELD::GetFullText( int unit ) const
{
    if( GetId() != FIELD_T::REFERENCE )
        return GetText();
 
    wxString text = GetText();
    text << wxT( "?" );
 
    if( GetParentSymbol() && GetParentSymbol()->IsMultiUnit() )
        text << LIB_SYMBOL::LetterSubReference( unit, 'A' );
 
    return text;
}
 
 
int SCH_FIELD::GetPenWidth() const
{
    return GetEffectiveTextPenWidth();
}
 
 
KIFONT::FONT* SCH_FIELD::GetDrawFont( const RENDER_SETTINGS* aSettings ) const
{
    KIFONT::FONT* font = EDA_TEXT::GetFont();
 
    if( !font )
        font = KIFONT::FONT::GetFont( GetDefaultFont( aSettings ), IsBold(), IsItalic() );
 
    return font;
}
 
 
void SCH_FIELD::ClearCaches()
{
    ClearRenderCache();
    EDA_TEXT::ClearBoundingBoxCache();
}
 
 
void SCH_FIELD::ClearRenderCache()
{
    EDA_TEXT::ClearRenderCache();
    m_renderCache.reset();
}
 
 
std::vector<std::unique_ptr<KIFONT::GLYPH>>*
SCH_FIELD::GetRenderCache( const wxString& forResolvedText, const VECTOR2I& forPosition, TEXT_ATTRIBUTES& aAttrs ) const
{
    KIFONT::FONT* font = GetDrawFont( nullptr );
 
    if( font->IsOutline() )
    {
        KIFONT::OUTLINE_FONT* outlineFont = static_cast<KIFONT::OUTLINE_FONT*>( font );
 
        if( !m_renderCache )
            m_renderCache = std::make_unique<SCH_FIELD_RENDER_CACHE_DATA>();
 
        if( m_renderCache->glyphs.empty() )
        {
            m_renderCache->glyphs.clear();
 
            outlineFont->GetLinesAsGlyphs( &m_renderCache->glyphs, forResolvedText, forPosition, aAttrs,
                                           GetFontMetrics() );
 
            m_renderCache->pos = forPosition;
        }
 
        if( m_renderCache->pos != forPosition )
        {
            VECTOR2I delta = forPosition - m_renderCache->pos;
 
            for( std::unique_ptr<KIFONT::GLYPH>& glyph : m_renderCache->glyphs )
            {
                if( glyph->IsOutline() )
                    static_cast<KIFONT::OUTLINE_GLYPH*>( glyph.get() )->Move( delta );
                else
                    static_cast<KIFONT::STROKE_GLYPH*>( glyph.get() )->Move( delta );
            }
 
            m_renderCache->pos = forPosition;
        }
 
        return &m_renderCache->glyphs;
    }
 
    return nullptr;
}
 
 
void SCH_FIELD::ImportValues( const SCH_FIELD& aSource )
{
    SetAttributes( aSource );
    SetVisible( aSource.IsVisible() );
    SetNameShown( aSource.IsNameShown() );
    SetCanAutoplace( aSource.CanAutoplace() );
}
 
 
void SCH_FIELD::swapData( SCH_ITEM* aItem )
{
    wxCHECK_RET( aItem && aItem->Type() == SCH_FIELD_T, wxT( "Cannot swap with invalid item." ) );
 
    SCH_FIELD* item = static_cast<SCH_FIELD*>( aItem );
 
    std::swap( m_showName, item->m_showName );
    std::swap( m_allowAutoPlace, item->m_allowAutoPlace );
    std::swap( m_isGeneratedField, item->m_isGeneratedField );
    SwapText( *item );
    SwapAttributes( *item );
 
    std::swap( m_lastResolvedColor, item->m_lastResolvedColor );
}
 
 
COLOR4D SCH_FIELD::GetFieldColor() const
{
    if( GetTextColor() != COLOR4D::UNSPECIFIED )
    {
        m_lastResolvedColor = GetTextColor();
    }
    else
    {
        SCH_LABEL_BASE* parentLabel = dynamic_cast<SCH_LABEL_BASE*>( GetParent() );
 
        if( parentLabel && !parentLabel->IsConnectivityDirty() )
            m_lastResolvedColor = parentLabel->GetEffectiveNetClass()->GetSchematicColor();
        else
            m_lastResolvedColor = GetTextColor();
    }
 
    return m_lastResolvedColor;
}
 
 
std::vector<int> SCH_FIELD::ViewGetLayers() const
{
    return { GetDefaultLayer(), LAYER_SELECTION_SHADOWS };
}
 
 
SCH_LAYER_ID SCH_FIELD::GetDefaultLayer() const
{
    if( m_parent && m_parent->Type() == SCH_LABEL_T )
    {
        if( GetCanonicalName() == wxT( "Netclass" ) || GetCanonicalName() == wxT( "Component Class" ) )
        {
            return LAYER_NETCLASS_REFS;
        }
    }
 
    switch( m_id )
    {
    case FIELD_T::REFERENCE:       return LAYER_REFERENCEPART;
    case FIELD_T::VALUE:           return LAYER_VALUEPART;
    case FIELD_T::SHEET_NAME:      return LAYER_SHEETNAME;
    case FIELD_T::SHEET_FILENAME:  return LAYER_SHEETFILENAME;
    case FIELD_T::SHEET_USER:      return LAYER_SHEETFIELDS;
    case FIELD_T::INTERSHEET_REFS: return LAYER_INTERSHEET_REFS;
    default:                       return LAYER_FIELDS;
    }
}
 
 
EDA_ANGLE SCH_FIELD::GetDrawRotation() const
{
    // Calculate the text orientation according to the symbol orientation.
    EDA_ANGLE orient = GetTextAngle();
 
    if( m_parent && m_parent->Type() == SCH_SYMBOL_T )
    {
        SCH_SYMBOL* parentSymbol = static_cast<SCH_SYMBOL*>( m_parent );
 
        if( parentSymbol && parentSymbol->GetTransform().y1 ) // Rotate symbol 90 degrees.
        {
            if( orient.IsHorizontal() )
                orient = ANGLE_VERTICAL;
            else
                orient = ANGLE_HORIZONTAL;
        }
    }
 
    return orient;
}
 
 
const BOX2I SCH_FIELD::GetBoundingBox() const
{
    BOX2I bbox = GetTextBox( nullptr );
 
    // Calculate the bounding box position relative to the parent:
    VECTOR2I origin = GetParentPosition();
    VECTOR2I pos = GetTextPos() - origin;
    VECTOR2I begin = bbox.GetOrigin() - origin;
    VECTOR2I end = bbox.GetEnd() - origin;
    RotatePoint( begin, pos, GetTextAngle() );
    RotatePoint( end, pos, GetTextAngle() );
 
    // Now, apply the symbol transform (mirror/rot)
    TRANSFORM transform;
 
    if( m_parent && m_parent->Type() == SCH_SYMBOL_T )
        transform = static_cast<SCH_SYMBOL*>( m_parent )->GetTransform();
 
    bbox.SetOrigin( transform.TransformCoordinate( begin ) );
    bbox.SetEnd( transform.TransformCoordinate( end ) );
 
    bbox.Move( origin );
    bbox.Normalize();
 
    return bbox;
}
 
 
bool SCH_FIELD::IsHorizJustifyFlipped() const
{
    VECTOR2I render_center = GetBoundingBox().Centre();
    VECTOR2I pos = GetPosition();
 
    switch( GetHorizJustify() )
    {
    case GR_TEXT_H_ALIGN_LEFT:
        if( GetDrawRotation().IsVertical() )
            return render_center.y > pos.y;
        else
            return render_center.x < pos.x;
 
    case GR_TEXT_H_ALIGN_RIGHT:
        if( GetDrawRotation().IsVertical() )
            return render_center.y < pos.y;
        else
            return render_center.x > pos.x;
 
    default:
        return false;
    }
}
 
 
void SCH_FIELD::SetEffectiveHorizJustify( GR_TEXT_H_ALIGN_T aJustify )
{
    GR_TEXT_H_ALIGN_T actualJustify;
 
    switch( aJustify )
    {
    case GR_TEXT_H_ALIGN_LEFT:
        actualJustify = IsHorizJustifyFlipped() ? GR_TEXT_H_ALIGN_RIGHT : GR_TEXT_H_ALIGN_LEFT;
        break;
 
    case GR_TEXT_H_ALIGN_RIGHT:
        actualJustify = IsHorizJustifyFlipped() ? GR_TEXT_H_ALIGN_LEFT : GR_TEXT_H_ALIGN_RIGHT;
        break;
 
    default:
        actualJustify = aJustify;
    }
 
    SetHorizJustify( actualJustify );
}
 
 
GR_TEXT_H_ALIGN_T SCH_FIELD::GetEffectiveHorizJustify() const
{
    switch( GetHorizJustify() )
    {
    case GR_TEXT_H_ALIGN_LEFT:  return IsHorizJustifyFlipped() ? GR_TEXT_H_ALIGN_RIGHT : GR_TEXT_H_ALIGN_LEFT;
    case GR_TEXT_H_ALIGN_RIGHT: return IsHorizJustifyFlipped() ? GR_TEXT_H_ALIGN_LEFT : GR_TEXT_H_ALIGN_RIGHT;
    default:                    return GR_TEXT_H_ALIGN_CENTER;
    }
}
 
 
bool SCH_FIELD::IsVertJustifyFlipped() const
{
    VECTOR2I render_center = GetBoundingBox().Centre();
    VECTOR2I pos = GetPosition();
 
    switch( GetVertJustify() )
    {
    case GR_TEXT_V_ALIGN_TOP:
        if( GetDrawRotation().IsVertical() )
            return render_center.x < pos.x;
        else
            return render_center.y < pos.y;
 
    case GR_TEXT_V_ALIGN_BOTTOM:
        if( GetDrawRotation().IsVertical() )
            return render_center.x > pos.x;
        else
            return render_center.y > pos.y;
 
    default:
        return false;
    }
}
 
 
void SCH_FIELD::SetEffectiveVertJustify( GR_TEXT_V_ALIGN_T aJustify )
{
    GR_TEXT_V_ALIGN_T actualJustify;
 
    switch( aJustify )
    {
    case GR_TEXT_V_ALIGN_TOP:
        actualJustify = IsVertJustifyFlipped() ? GR_TEXT_V_ALIGN_BOTTOM : GR_TEXT_V_ALIGN_TOP;
        break;
 
    case GR_TEXT_V_ALIGN_BOTTOM:
        actualJustify = IsVertJustifyFlipped() ? GR_TEXT_V_ALIGN_TOP : GR_TEXT_V_ALIGN_BOTTOM;
        break;
 
    default:
        actualJustify = aJustify;
    }
 
    SetVertJustify( actualJustify );
}
 
 
GR_TEXT_V_ALIGN_T SCH_FIELD::GetEffectiveVertJustify() const
{
    switch( GetVertJustify() )
    {
    case GR_TEXT_V_ALIGN_TOP:    return IsVertJustifyFlipped() ? GR_TEXT_V_ALIGN_BOTTOM : GR_TEXT_V_ALIGN_TOP;
    case GR_TEXT_V_ALIGN_BOTTOM: return IsVertJustifyFlipped() ? GR_TEXT_V_ALIGN_TOP : GR_TEXT_V_ALIGN_BOTTOM;
    default:                     return GR_TEXT_V_ALIGN_CENTER;
    }
}
 
 
bool SCH_FIELD::Matches( const EDA_SEARCH_DATA& aSearchData, void* aAuxData ) const
{
    bool searchHiddenFields = aSearchData.searchAllFields;
    bool searchAndReplace = aSearchData.searchAndReplace;
    bool replaceReferences = false;
 
    try
    {
        // downcast
        const SCH_SEARCH_DATA& schSearchData = dynamic_cast<const SCH_SEARCH_DATA&>( aSearchData );
        replaceReferences = schSearchData.replaceReferences;
    }
    catch( const std::bad_cast& )
    {
    }
 
    wxString text = UnescapeString( GetText() );
 
    if( !IsVisible() && !searchHiddenFields )
        return false;
 
    if( m_id == FIELD_T::REFERENCE )
    {
        if( searchAndReplace && !replaceReferences )
            return false;
 
        SCH_SYMBOL* parentSymbol = dyn_cast<SCH_SYMBOL*>( m_parent );
 
        // The parent might be a LIB_SYMBOL, in which case, we don't
        // have a sheet path to resolve the reference.
        if( !parentSymbol )
            return false;
 
        if( parentSymbol->Matches( aSearchData, aAuxData ) )
            return true;
 
        wxASSERT( aAuxData );
 
        // Take sheet path into account which effects the reference field and the unit for
        // symbols with multiple parts.
        if( aAuxData )
        {
            SCH_SHEET_PATH* sheet = (SCH_SHEET_PATH*) aAuxData;
            text = parentSymbol->GetRef( sheet );
 
            if( SCH_ITEM::Matches( text, aSearchData ) )
                return true;
 
            if( parentSymbol->GetUnitCount() > 1 )
                text << parentSymbol->SubReference( parentSymbol->GetUnitSelection( sheet ) );
        }
    }
 
    return SCH_ITEM::Matches( text, aSearchData );
}
 
 
void SCH_FIELD::OnScintillaCharAdded( SCINTILLA_TRICKS* aScintillaTricks, wxStyledTextEvent& aEvent ) const
{
    SCH_ITEM*  parent = dynamic_cast<SCH_ITEM*>( GetParent() );
    SCHEMATIC* schematic = parent ? parent->Schematic() : nullptr;
 
    if( !schematic )
        return;
 
    wxStyledTextCtrl* scintilla = aScintillaTricks->Scintilla();
    int               key = aEvent.GetKey();
 
    wxArrayString autocompleteTokens;
    int           pos = scintilla->GetCurrentPos();
    int           start = scintilla->WordStartPosition( pos, true );
    wxString      partial;
 
    // Multi-line fields are not allowed. So remove '\n' if entered.
    if( key == '\n' )
    {
        wxString text = scintilla->GetText();
        int      currpos = scintilla->GetCurrentPos();
        text.Replace( wxS( "\n" ), wxS( "" ) );
        scintilla->SetText( text );
        scintilla->GotoPos( currpos - 1 );
        return;
    }
 
    auto textVarRef =
            [&]( int pt )
            {
                return pt >= 2 && scintilla->GetCharAt( pt - 2 ) == '$' && scintilla->GetCharAt( pt - 1 ) == '{';
            };
 
    // Check for cross-reference
    if( start > 1 && scintilla->GetCharAt( start - 1 ) == ':' )
    {
        int refStart = scintilla->WordStartPosition( start - 1, true );
 
        if( textVarRef( refStart ) )
        {
            partial = scintilla->GetRange( start, pos );
 
            wxString ref = scintilla->GetRange( refStart, start - 1 );
 
            if( ref == wxS( "OP" ) )
            {
                // SPICE operating points use ':' syntax for ports
                if( SCH_SYMBOL* symbol = dynamic_cast<SCH_SYMBOL*>( parent ) )
                {
                    NULL_REPORTER   devnull;
                    SCH_SHEET_PATH& sheet = schematic->CurrentSheet();
                    wxString        variant = schematic->GetCurrentVariant();
                    SIM_LIB_MGR     mgr( &schematic->Project() );
 
                    std::vector<EMBEDDED_FILES*> embeddedFilesStack;
                    embeddedFilesStack.push_back( schematic->GetEmbeddedFiles() );
 
                    if( EMBEDDED_FILES* symbolEmbeddedFiles = symbol->GetEmbeddedFiles() )
                    {
                        embeddedFilesStack.push_back( symbolEmbeddedFiles );
                        symbol->GetLibSymbolRef()->AppendParentEmbeddedFiles( embeddedFilesStack );
                    }
 
                    mgr.SetFilesStack( std::move( embeddedFilesStack ) );
 
                    SIM_MODEL& model = mgr.CreateModel( &sheet, *symbol, true, 0, variant, devnull ).model;
 
                    for( wxString pin : model.GetPinNames() )
                    {
                        if( pin.StartsWith( '<' ) && pin.EndsWith( '>' ) )
                            autocompleteTokens.push_back( pin.Mid( 1, pin.Length() - 2 ) );
                        else
                            autocompleteTokens.push_back( pin );
                    }
 
                    // add the synthetic port for power measurements
                    autocompleteTokens.push_back( wxT( "power" ) );
                }
            }
            else
            {
                SCH_REFERENCE_LIST refs;
                SCH_SYMBOL*        refSymbol = nullptr;
 
                schematic->Hierarchy().GetSymbols( refs, SYMBOL_FILTER_ALL );
 
                for( size_t jj = 0; jj < refs.GetCount(); jj++ )
                {
                    if( refs[jj].GetSymbol()->GetRef( &refs[jj].GetSheetPath(), true ) == ref )
                    {
                        refSymbol = refs[jj].GetSymbol();
                        break;
                    }
                }
 
                if( refSymbol )
                    refSymbol->GetContextualTextVars( &autocompleteTokens );
            }
        }
    }
    else if( textVarRef( start ) )
    {
        partial = scintilla->GetTextRange( start, pos );
 
        SCH_SYMBOL*     symbol = dynamic_cast<SCH_SYMBOL*>( parent );
        SCH_SHEET*      sheet = dynamic_cast<SCH_SHEET*>( parent );
        SCH_LABEL_BASE* label = dynamic_cast<SCH_LABEL_BASE*>( parent );
 
        if( symbol )
        {
            symbol->GetContextualTextVars( &autocompleteTokens );
 
            if( schematic->CurrentSheet().Last() )
                schematic->CurrentSheet().Last()->GetContextualTextVars( &autocompleteTokens );
        }
 
        if( sheet )
            sheet->GetContextualTextVars( &autocompleteTokens );
 
        if( label )
            label->GetContextualTextVars( &autocompleteTokens );
 
        for( std::pair<wxString, wxString> entry : schematic->Project().GetTextVars() )
            autocompleteTokens.push_back( entry.first );
    }
 
    aScintillaTricks->DoAutocomplete( partial, autocompleteTokens );
    scintilla->SetFocus();
}
 
 
bool SCH_FIELD::IsReplaceable() const
{
    // See comments in SCH_FIELD::Replace(), below.
    if( m_id == FIELD_T::SHEET_FILENAME || m_id == FIELD_T::INTERSHEET_REFS )
        return false;
 
    return true;
}
 
 
bool SCH_FIELD::IsLocked() const
{
    if( const SYMBOL* parentSymbol = GetParentSymbol() )
    {
        if( parentSymbol->IsLocked() )
            return true;
    }
 
    if( const SCH_SHEET* parentSheet = dynamic_cast<const SCH_SHEET*>( m_parent ) )
    {
        if( parentSheet->IsLocked() )
            return true;
    }
 
    return SCH_ITEM::IsLocked();
}
 
 
bool SCH_FIELD::Replace( const EDA_SEARCH_DATA& aSearchData, void* aAuxData )
{
    bool replaceReferences = false;
 
    try
    {
        const SCH_SEARCH_DATA& schSearchData = dynamic_cast<const SCH_SEARCH_DATA&>( aSearchData );
        replaceReferences = schSearchData.replaceReferences;
    }
    catch( const std::bad_cast& )
    {
    }
 
    wxString text;
    bool     isReplaced = false;
 
    if( m_id == FIELD_T::REFERENCE && m_parent && m_parent->Type() == SCH_SYMBOL_T )
    {
        SCH_SYMBOL* parentSymbol = static_cast<SCH_SYMBOL*>( m_parent );
 
        if( !replaceReferences )
            return false;
 
        wxCHECK_MSG( aAuxData, false, wxT( "Need sheetpath to replace in refdes." ) );
 
        text = parentSymbol->GetRef( (SCH_SHEET_PATH*) aAuxData );
        isReplaced = EDA_ITEM::Replace( aSearchData, text );
 
        if( isReplaced )
            parentSymbol->SetRef( (SCH_SHEET_PATH*) aAuxData, text );
    }
    else
    {
        isReplaced = EDA_TEXT::Replace( aSearchData );
 
        if( m_id == FIELD_T::SHEET_FILENAME && isReplaced )
        {
            // If we allowed this we'd have a bunch of work to do here, including warning
            // about it not being undoable, checking for recursive hierarchies, reloading
            // sheets, etc.  See DIALOG_SHEET_PROPERTIES::TransferDataFromWindow().
        }
    }
 
    return isReplaced;
}
 
 
void SCH_FIELD::Rotate( const VECTOR2I& aCenter, bool aRotateCCW )
{
    const GR_TEXT_H_ALIGN_T horizJustify = GetHorizJustify();
 
    if( GetTextAngle().IsVertical() )
    {
        switch( horizJustify )
        {
        case GR_TEXT_H_ALIGN_LEFT:
            if( aRotateCCW )
                SetHorizJustify( GR_TEXT_H_ALIGN_RIGHT );
 
            break;
 
        case GR_TEXT_H_ALIGN_RIGHT:
            if( aRotateCCW )
                SetHorizJustify( GR_TEXT_H_ALIGN_LEFT );
 
            break;
 
        case GR_TEXT_H_ALIGN_CENTER:
        case GR_TEXT_H_ALIGN_INDETERMINATE:
            break;
        }
 
        SetTextAngle( ANGLE_HORIZONTAL );
    }
    else if( GetTextAngle().IsHorizontal() )
    {
        switch( horizJustify )
        {
        case GR_TEXT_H_ALIGN_LEFT:
            if( !aRotateCCW )
                SetHorizJustify( GR_TEXT_H_ALIGN_RIGHT );
 
            break;
 
        case GR_TEXT_H_ALIGN_RIGHT:
            if( !aRotateCCW )
                SetHorizJustify( GR_TEXT_H_ALIGN_LEFT );
 
            break;
 
        case GR_TEXT_H_ALIGN_CENTER:
        case GR_TEXT_H_ALIGN_INDETERMINATE:
            break;
        }
 
        SetTextAngle( ANGLE_VERTICAL );
    }
    else
    {
        wxFAIL_MSG( wxString::Format( wxT( "SCH_FIELD text angle is not horizontal or vertical: %f" ),
                                      GetTextAngle().AsDegrees() ) );
    }
 
    VECTOR2I pt = GetPosition();
    RotatePoint( pt, aCenter, aRotateCCW ? ANGLE_90 : ANGLE_270 );
    SetPosition( pt );
}
 
 
void SCH_FIELD::MirrorHorizontally( int aCenter )
{
    int x = GetTextPos().x;
 
    x -= aCenter;
    x *= -1;
    x += aCenter;
 
    SetTextX( x );
}
 
 
void SCH_FIELD::MirrorVertically( int aCenter )
{
    int y = GetTextPos().y;
 
    y -= aCenter;
    y *= -1;
    y += aCenter;
 
    SetTextY( y );
}
 
 
void SCH_FIELD::BeginEdit( const VECTOR2I& aPosition )
{
    SetTextPos( aPosition );
}
 
 
void SCH_FIELD::CalcEdit( const VECTOR2I& aPosition )
{
    SetTextPos( aPosition );
}
 
 
wxString SCH_FIELD::GetItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const
{
    wxString content = aFull ? GetShownText( false ) : KIUI::EllipsizeMenuText( GetText() );
 
    if( content.IsEmpty() )
    {
        return wxString::Format( _( "Field %s (empty)" ), UnescapeString( GetName() ) );
    }
    else
    {
        return wxString::Format( _( "Field %s '%s'" ), UnescapeString( GetName() ), content );
    }
}
 
 
void SCH_FIELD::GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList )
{
    wxString msg;
 
    aList.emplace_back( _( "Symbol Field" ), UnescapeString( GetName() ) );
 
    // Don't use GetShownText() here; we want to show the user the variable references
    aList.emplace_back( _( "Text" ), KIUI::EllipsizeStatusText( aFrame, GetText() ) );
 
    aList.emplace_back( _( "Visible" ), IsVisible() ? _( "Yes" ) : _( "No" ) );
 
    aList.emplace_back( _( "Font" ), GetFont() ? GetFont()->GetName() : _( "Default" ) );
 
    aList.emplace_back( _( "Style" ), GetTextStyleName() );
 
    aList.emplace_back( _( "Text Size" ), aFrame->MessageTextFromValue( GetTextWidth() ) );
 
    switch( GetHorizJustify() )
    {
    case GR_TEXT_H_ALIGN_LEFT:          msg = _( "Left" );         break;
    case GR_TEXT_H_ALIGN_CENTER:        msg = _( "Center" );       break;
    case GR_TEXT_H_ALIGN_RIGHT:         msg = _( "Right" );        break;
    case GR_TEXT_H_ALIGN_INDETERMINATE: msg = INDETERMINATE_STATE; break;
    }
 
    aList.emplace_back( _( "H Justification" ), msg );
 
    switch( GetVertJustify() )
    {
    case GR_TEXT_V_ALIGN_TOP:           msg = _( "Top" );          break;
    case GR_TEXT_V_ALIGN_CENTER:        msg = _( "Center" );       break;
    case GR_TEXT_V_ALIGN_BOTTOM:        msg = _( "Bottom" );       break;
    case GR_TEXT_V_ALIGN_INDETERMINATE: msg = INDETERMINATE_STATE; break;
    }
 
    aList.emplace_back( _( "V Justification" ), msg );
}
 
 
bool SCH_FIELD::HasHypertext() const
{
    if( m_id == FIELD_T::INTERSHEET_REFS )
        return true;
 
    if( m_name == SIM_LIBRARY::LIBRARY_FIELD )
        return true;
 
    return IsURL( GetShownText( false ) );
}
 
 
void SCH_FIELD::DoHypertextAction( EDA_DRAW_FRAME* aFrame, const VECTOR2I& aMousePos ) const
{
    constexpr int START_ID = 1;
 
    wxString href;
 
    if( m_id == FIELD_T::INTERSHEET_REFS )
    {
        SCH_LABEL_BASE* label = static_cast<SCH_LABEL_BASE*>( m_parent );
        SCH_SHEET_PATH* sheet = &label->Schematic()->CurrentSheet();
        wxMenu          menu;
 
        std::vector<std::pair<wxString, wxString>> pages;
 
        label->GetIntersheetRefs( sheet, &pages );
 
        for( int i = 0; i < (int) pages.size(); ++i )
        {
            menu.Append( i + START_ID,
                         wxString::Format( _( "Go to Page %s (%s)" ), pages[i].first, pages[i].second ) );
        }
 
        menu.AppendSeparator();
        menu.Append( 999 + START_ID, _( "Back to Previous Selected Sheet" ) );
 
        int sel = aFrame->GetPopupMenuSelectionFromUser( menu ) - START_ID;
 
        if( sel >= 0 && sel < (int) pages.size() )
            href = wxT( "#" ) + pages[sel].first;
        else if( sel == 999 )
            href = SCH_NAVIGATE_TOOL::g_BackLink;
    }
    else if( IsURL( GetShownText( false ) ) || m_name == SIM_LIBRARY::LIBRARY_FIELD )
    {
        href = GetShownText( false );
    }
 
    if( !href.IsEmpty() )
    {
        SCH_NAVIGATE_TOOL* navTool = aFrame->GetToolManager()->GetTool<SCH_NAVIGATE_TOOL>();
        navTool->HypertextCommand( href );
    }
}
 
 
void SCH_FIELD::SetName( const wxString& aName )
{
    m_name = aName;
    m_isGeneratedField = ::IsGeneratedField( aName );
 
    if( m_isGeneratedField )
        EDA_TEXT::SetText( aName );
}
 
 
void SCH_FIELD::SetText( const wxString& aText )
{
    // Don't allow modification of text value of generated fields.
    if( m_isGeneratedField )
        return;
 
    // Mandatory fields should not have leading or trailing whitespace.
    if( IsMandatory() )
        EDA_TEXT::SetText( aText.Strip( wxString::both ) );
    else
        EDA_TEXT::SetText( aText );
}
 
 
void SCH_FIELD::SetText( const wxString& aText, const SCH_SHEET_PATH* aPath, const wxString& aVariantName )
{
    wxCHECK( m_parent, /* void */ );
 
    if( m_isGeneratedField )
        return;
 
    wxString tmp = aText;
 
    if( IsMandatory() )
        tmp = aText.Strip( wxString::both ) ;
 
    switch( m_parent->Type() )
    {
    case SCH_SYMBOL_T:
    {
        SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( m_parent );
        wxCHECK( symbol, /* void */ );
        symbol->SetFieldText( GetName(), aText, aPath, aVariantName );
        break;
    }
 
    case SCH_SHEET_T:
    {
        SCH_SHEET* sheet = static_cast<SCH_SHEET*>( m_parent );
        wxCHECK( sheet, /* void */ );
        sheet->SetFieldText( GetName(), aText, aPath, aVariantName );
        break;
    }
 
    default:
        SCH_FIELD::SetText( aText );
        break;
    }
}
 
 
wxString SCH_FIELD::GetText( const SCH_SHEET_PATH* aPath, const wxString& aVariantName ) const
{
    wxString retv;
 
    wxCHECK( aPath && m_parent, retv );
 
    switch( m_parent->Type() )
    {
    case SCH_SYMBOL_T:
    {
        SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( m_parent );
        wxCHECK( symbol, retv );
        retv = symbol->GetFieldText( GetName(), aPath, aVariantName );
        break;
    }
 
    case SCH_SHEET_T:
    {
        SCH_SHEET* sheet = static_cast<SCH_SHEET*>( m_parent );
        wxCHECK( sheet, retv );
        retv = sheet->GetFieldText( GetName(), aPath, aVariantName );
        break;
    }
 
    default:
        retv = GetText();
        break;
    }
 
    return retv;
}
 
 
wxString SCH_FIELD::GetName( bool aUseDefaultName ) const
{
    if( m_parent && m_parent->IsType( labelTypes ) )
        return SCH_LABEL_BASE::GetDefaultFieldName( m_name, aUseDefaultName );
 
    if( IsMandatory() )
        return GetCanonicalFieldName( m_id );
    else if( m_name.IsEmpty() && aUseDefaultName )
        return GetDefaultFieldName( m_id, !DO_TRANSLATE );
    else
        return m_name;
}
 
 
wxString SCH_FIELD::GetCanonicalName() const
{
    if( m_parent && m_parent->IsType( labelTypes ) )
    {
        // These should be stored in canonical format, but just in case:
        if( m_name == _( "Net Class" ) || m_name == wxT( "Net Class" ) )
            return wxT( "Netclass" );
    }
 
    if( IsMandatory() )
        return GetCanonicalFieldName( m_id );
 
    return m_name;
}
 
 
BITMAPS SCH_FIELD::GetMenuImage() const
{
    if( m_parent && ( m_parent->Type() == SCH_SYMBOL_T || m_parent->Type() == LIB_SYMBOL_T ) )
    {
        switch( m_id )
        {
        case FIELD_T::REFERENCE: return BITMAPS::edit_comp_ref;
        case FIELD_T::VALUE:     return BITMAPS::edit_comp_value;
        case FIELD_T::FOOTPRINT: return BITMAPS::edit_comp_footprint;
        default:                 return BITMAPS::text;
        }
    }
 
    return BITMAPS::text;
}
 
 
bool SCH_FIELD::HitTest( const VECTOR2I& aPosition, int aAccuracy ) const
{
    if( GetShownText( true ).IsEmpty() )
        return false;
 
    BOX2I rect = GetBoundingBox();
 
    // Text in symbol editor can have additional chars (ie: reference designators U? or U?A)
    if( m_parent && m_parent->Type() == LIB_SYMBOL_T )
    {
        SCH_FIELD temp( *this );
        temp.SetText( GetFullText() );
        rect = temp.GetBoundingBox();
    }
 
    rect.Inflate( aAccuracy );
 
    if( m_parent && m_parent->Type() == SCH_GLOBAL_LABEL_T )
    {
        SCH_GLOBALLABEL* label = static_cast<SCH_GLOBALLABEL*>( GetParent() );
        rect.Offset( label->GetSchematicTextOffset( nullptr ) );
    }
 
    return rect.Contains( aPosition );
}
 
 
bool SCH_FIELD::HitTest( const BOX2I& aRect, bool aContained, int aAccuracy ) const
{
    if( GetShownText( true ).IsEmpty() )
        return false;
 
    if( m_flags & ( STRUCT_DELETED | SKIP_STRUCT ) )
        return false;
 
    BOX2I rect = aRect;
 
    rect.Inflate( aAccuracy );
 
    if( GetParent() && GetParent()->Type() == SCH_GLOBAL_LABEL_T )
    {
        SCH_GLOBALLABEL* label = static_cast<SCH_GLOBALLABEL*>( GetParent() );
        rect.Offset( label->GetSchematicTextOffset( nullptr ) );
    }
 
    if( aContained )
        return rect.Contains( GetBoundingBox() );
 
    return rect.Intersects( GetBoundingBox() );
}
 
 
bool SCH_FIELD::HitTest( const SHAPE_LINE_CHAIN& aPoly, bool aContained ) const
{
    if( GetShownText( true ).IsEmpty() )
        return false;
 
    if( m_flags & ( STRUCT_DELETED | SKIP_STRUCT ) )
        return false;
 
    BOX2I bbox = GetBoundingBox();
 
    if( GetParent() && GetParent()->Type() == SCH_GLOBAL_LABEL_T )
    {
        SCH_GLOBALLABEL* label = static_cast<SCH_GLOBALLABEL*>( GetParent() );
        bbox.Offset( label->GetSchematicTextOffset( nullptr ) );
    }
 
    return KIGEOM::BoxHitTest( aPoly, bbox, aContained );
}
 
 
void SCH_FIELD::Plot( PLOTTER* aPlotter, bool aBackground, const SCH_PLOT_OPTS& aPlotOpts, int aUnit, int aBodyStyle,
                      const VECTOR2I& aOffset, bool aDimmed )
{
    wxString text;
 
    if( Schematic() )
        text = GetShownText( &Schematic()->CurrentSheet(), true, 0, Schematic()->GetCurrentVariant() );
    else
        text = GetShownText( true );
 
    if( ( !IsVisible() && !IsForceVisible() ) || text.IsEmpty() || aBackground )
        return;
 
    SCH_RENDER_SETTINGS* renderSettings = getRenderSettings( aPlotter );
    COLOR4D              color = renderSettings->GetLayerColor( GetLayer() );
    int                  penWidth = GetEffectiveTextPenWidth( renderSettings->GetDefaultPenWidth() );
 
    COLOR4D bg = renderSettings->GetBackgroundColor();
 
    if( bg == COLOR4D::UNSPECIFIED || !aPlotter->GetColorMode() )
        bg = COLOR4D::WHITE;
 
    if( aPlotter->GetColorMode() && GetTextColor() != COLOR4D::UNSPECIFIED )
        color = GetTextColor();
 
    if( color.m_text && Schematic() )
        color = COLOR4D( ResolveText( *color.m_text, &Schematic()->CurrentSheet() ) );
 
    if( aDimmed )
    {
        color.Desaturate();
        color = color.Mix( bg, 0.5f );
    }
 
    penWidth = std::max( penWidth, renderSettings->GetMinPenWidth() );
 
    // clamp the pen width to be sure the text is readable
    penWidth = std::min( penWidth, std::min( GetTextSize().x, GetTextSize().y ) / 4 );
 
    if( !IsVisible() && !renderSettings->m_ShowHiddenFields )
        return;
 
    // Calculate the text orientation, according to the symbol orientation/mirror
    EDA_ANGLE         orient = GetTextAngle();
    VECTOR2I          textpos = GetTextPos();
    GR_TEXT_H_ALIGN_T hjustify = GetHorizJustify();
    GR_TEXT_V_ALIGN_T vjustify = GetVertJustify();
 
    if( renderSettings->m_Transform.y1 ) // Rotate symbol 90 deg.
    {
        if( orient.IsHorizontal() )
            orient = ANGLE_VERTICAL;
        else
            orient = ANGLE_HORIZONTAL;
    }
 
    if( m_parent && m_parent->Type() == SCH_SYMBOL_T )
    {
        /*
         * Calculate the text justification, according to the symbol orientation/mirror.  This is
         * a bit complicated due to cumulative calculations:
         *  - numerous cases (mirrored or not, rotation)
         *  - the plotter's Text() function will also recalculate H and V justifications according
         *    to the text orientation
         *  - when a symbol is mirrored the text is not, and justifications become a nightmare
         *
         *  So the easier way is to use no justifications (centered text) and use GetBoundingBox
         *  to know the text coordinate considered as centered.
         */
        hjustify = GR_TEXT_H_ALIGN_CENTER;
        vjustify = GR_TEXT_V_ALIGN_CENTER;
        textpos = GetBoundingBox().Centre();
    }
    else if( m_parent && m_parent->Type() == LIB_SYMBOL_T )
    {
        // Library-symbol exports (CLI/symbol editor) provide an item offset in the same coordinate
        // frame as body graphics/pins.  Apply the same transform+offset pipeline to field text.
        textpos = renderSettings->TransformCoordinate( textpos ) + aOffset;
    }
    else if( m_parent && m_parent->Type() == SCH_GLOBAL_LABEL_T )
    {
        SCH_GLOBALLABEL* label = static_cast<SCH_GLOBALLABEL*>( m_parent );
        textpos += label->GetSchematicTextOffset( renderSettings );
    }
    else if( m_parent && m_parent->Type() == SCH_DIRECTIVE_LABEL_T )
    {
        SCH_DIRECTIVE_LABEL*      label = static_cast<SCH_DIRECTIVE_LABEL*>( m_parent );
        std::shared_ptr<NETCLASS> nc = label->GetEffectiveNetClass();
 
        if( nc && ( nc->GetSchematicColor() != COLOR4D::UNSPECIFIED ) && aPlotter->GetColorMode() )
            color = nc->GetSchematicColor();
    }
 
    KIFONT::FONT*   font = GetDrawFont( renderSettings );
    TEXT_ATTRIBUTES attrs = GetAttributes();
    attrs.m_StrokeWidth = penWidth;
    attrs.m_Halign = hjustify;
    attrs.m_Valign = vjustify;
    attrs.m_Angle = orient;
    attrs.m_Multiline = false;
 
    aPlotter->PlotText( textpos, color, text, attrs, font, GetFontMetrics() );
 
    if( m_id == FIELD_T::INTERSHEET_REFS && Schematic() )
    {
        if( SCH_LABEL_BASE* label = dynamic_cast<SCH_LABEL_BASE*>( m_parent ) )
        {
            std::vector<std::pair<wxString, wxString>> pages;
            std::vector<wxString>                      pageHrefs;
 
            label->GetIntersheetRefs( &Schematic()->CurrentSheet(), &pages );
 
            for( const auto& [pageNumber, sheetName] : pages )
                pageHrefs.push_back( wxT( "#" ) + pageNumber );
 
            BOX2I bbox = GetBoundingBox();
            bbox.Offset( label->GetSchematicTextOffset( renderSettings ) );
 
            aPlotter->HyperlinkMenu( bbox, pageHrefs );
        }
    }
}
 
 
void SCH_FIELD::SetPosition( const VECTOR2I& aPosition )
{
    // Actual positions are calculated by the rotation/mirror transform of the parent symbol
    // of the field.  The inverse transform is used to calculate the position relative to the
    // parent symbol.
    if( m_parent && m_parent->Type() == SCH_SYMBOL_T )
    {
        SCH_SYMBOL* parentSymbol = static_cast<SCH_SYMBOL*>( m_parent );
        VECTOR2I    relPos = aPosition - parentSymbol->GetPosition();
 
        relPos = parentSymbol->GetTransform().InverseTransform().TransformCoordinate( relPos );
 
        SetTextPos( relPos + parentSymbol->GetPosition() );
        return;
    }
 
    SetTextPos( aPosition );
}
 
 
VECTOR2I SCH_FIELD::GetPosition() const
{
    if( m_parent && m_parent->Type() == SCH_SYMBOL_T )
    {
        SCH_SYMBOL* parentSymbol = static_cast<SCH_SYMBOL*>( m_parent );
        VECTOR2I    relativePos = GetTextPos() - parentSymbol->GetPosition();
 
        relativePos = parentSymbol->GetTransform().TransformCoordinate( relativePos );
 
        return relativePos + parentSymbol->GetPosition();
    }
 
    return GetTextPos();
}
 
 
VECTOR2I SCH_FIELD::GetParentPosition() const
{
    return m_parent ? m_parent->GetPosition() : VECTOR2I( 0, 0 );
}
 
 
bool SCH_FIELD::IsMandatory() const
{
    return m_id == FIELD_T::REFERENCE || m_id == FIELD_T::VALUE || m_id == FIELD_T::FOOTPRINT
           || m_id == FIELD_T::DATASHEET || m_id == FIELD_T::DESCRIPTION || m_id == FIELD_T::SHEET_NAME
           || m_id == FIELD_T::SHEET_FILENAME || m_id == FIELD_T::INTERSHEET_REFS;
}
 
 
bool SCH_FIELD::operator<( const SCH_ITEM& aItem ) const
{
    if( Type() != aItem.Type() )
        return Type() < aItem.Type();
 
    auto field = static_cast<const SCH_FIELD*>( &aItem );
 
    if( GetId() != field->GetId() )
        return GetId() < field->GetId();
 
    if( GetText() != field->GetText() )
        return GetText() < field->GetText();
 
    if( GetLibPosition().x != field->GetLibPosition().x )
        return GetLibPosition().x < field->GetLibPosition().x;
 
    if( GetLibPosition().y != field->GetLibPosition().y )
        return GetLibPosition().y < field->GetLibPosition().y;
 
    return GetName() < field->GetName();
}
 
 
bool SCH_FIELD::operator==( const SCH_ITEM& aOther ) const
{
    if( Type() != aOther.Type() )
        return false;
 
    const SCH_FIELD& field = static_cast<const SCH_FIELD&>( aOther );
 
    return *this == field;
}
 
 
bool SCH_FIELD::operator==( const SCH_FIELD& aOther ) const
{
    // Identical fields owned by different items are not equal.
    if( m_parent || aOther.m_parent )
    {
        if( !m_parent || !aOther.m_parent )
            return false;
 
        if( m_parent->Type() != aOther.m_parent->Type() )
            return false;
 
        if( m_parent->m_Uuid != aOther.m_parent->m_Uuid )
            return false;
    }
 
    if( IsMandatory() != aOther.IsMandatory() )
        return false;
 
    if( IsMandatory() )
    {
        if( GetId() != aOther.GetId() )
            return false;
    }
    else
    {
        if( GetOrdinal() != aOther.GetOrdinal() )
            return false;
    }
 
    if( GetPosition() != aOther.GetPosition() )
        return false;
 
    if( IsGeneratedField() != aOther.IsGeneratedField() )
        return false;
 
    if( IsNameShown() != aOther.IsNameShown() )
        return false;
 
    if( CanAutoplace() != aOther.CanAutoplace() )
        return false;
 
    return EDA_TEXT::operator==( aOther );
}
 
 
double SCH_FIELD::Similarity( const SCH_ITEM& aOther ) const
{
    if( Type() != aOther.Type() )
        return 0.0;
 
    if( m_Uuid == aOther.m_Uuid )
        return 1.0;
 
    const SCH_FIELD& field = static_cast<const SCH_FIELD&>( aOther );
 
    double similarity = 0.99; // The UUIDs are different, so we start with non-identity
 
    if( GetId() != field.GetId() )
    {
        // We don't allow swapping of mandatory fields, so these cannot be the same item
        if( IsMandatory() || field.IsMandatory() )
            return 0.0;
        else
            similarity *= 0.5;
    }
 
    similarity *= SimilarityBase( aOther );
 
    similarity *= EDA_TEXT::Similarity( field );
 
    if( GetPosition() != field.GetPosition() )
        similarity *= 0.5;
 
    if( IsGeneratedField() != field.IsGeneratedField() )
        similarity *= 0.5;
 
    if( IsNameShown() != field.IsNameShown() )
        similarity *= 0.5;
 
    if( CanAutoplace() != field.CanAutoplace() )
        similarity *= 0.5;
 
    return similarity;
}
 
 
int SCH_FIELD::compare( const SCH_ITEM& aOther, int aCompareFlags ) const
{
    wxASSERT( aOther.Type() == SCH_FIELD_T );
 
    int compareFlags = aCompareFlags;
 
    // For ERC tests, the field position has no matter, so do not test it
    if( aCompareFlags & SCH_ITEM::COMPARE_FLAGS::ERC )
        compareFlags |= SCH_ITEM::COMPARE_FLAGS::SKIP_TST_POS;
 
    int retv = SCH_ITEM::compare( aOther, compareFlags );
 
    if( retv )
        return retv;
 
    const SCH_FIELD* tmp = static_cast<const SCH_FIELD*>( &aOther );
 
    // Equality test will vary depending whether or not the field is mandatory.  Otherwise,
    // sorting is done by ordinal.
    if( aCompareFlags & SCH_ITEM::COMPARE_FLAGS::EQUALITY )
    {
        // Mandatory fields have fixed ordinals and their names can vary due to translated field
        // names.  Optional fields have fixed names and their ordinals can vary.
        if( IsMandatory() )
        {
            if( m_id != tmp->m_id )
                return (int) m_id - (int) tmp->m_id;
        }
        else
        {
            retv = m_name.Cmp( tmp->m_name );
 
            if( retv )
                return retv;
        }
    }
    else // assume we're sorting
    {
        if( m_id != tmp->m_id )
            return (int) m_id - (int) tmp->m_id;
    }
 
    bool ignoreFieldText = false;
 
    if( m_id == FIELD_T::REFERENCE && !( aCompareFlags & SCH_ITEM::COMPARE_FLAGS::EQUALITY ) )
        ignoreFieldText = true;
 
    if( m_id == FIELD_T::VALUE && ( aCompareFlags & SCH_ITEM::COMPARE_FLAGS::ERC ) )
        ignoreFieldText = true;
 
    if( !ignoreFieldText )
    {
        retv = GetText().CmpNoCase( tmp->GetText() );
 
        if( retv != 0 )
            return retv;
    }
 
    if( aCompareFlags & SCH_ITEM::COMPARE_FLAGS::EQUALITY )
    {
        if( GetTextPos().x != tmp->GetTextPos().x )
            return GetTextPos().x - tmp->GetTextPos().x;
 
        if( GetTextPos().y != tmp->GetTextPos().y )
            return GetTextPos().y - tmp->GetTextPos().y;
    }
 
    // For ERC tests, the field size has no matter, so do not test it
    if( !( aCompareFlags & SCH_ITEM::COMPARE_FLAGS::ERC ) )
    {
        if( GetTextWidth() != tmp->GetTextWidth() )
            return GetTextWidth() - tmp->GetTextWidth();
 
        if( GetTextHeight() != tmp->GetTextHeight() )
            return GetTextHeight() - tmp->GetTextHeight();
    }
 
    return 0;
}
 
 
wxString SCH_FIELD::getUnescapedText( const SCH_SHEET_PATH* aPath, const wxString& aVariantName ) const
{
    // This is the default variant field text for all fields except the reference field.
    wxString retv = EDA_TEXT::GetShownText( false );
 
    // Special handling for parent object field instance and variant information.
    // Only use the path if it's non-empty; an empty path can't match any instances
    if( m_parent && aPath && !aPath->empty() )
    {
        wxLogTrace( traceSchFieldRendering, "  Path is valid and non-empty, parent type=%d", m_parent->Type() );
 
        switch( m_parent->Type() )
        {
        case SCH_SYMBOL_T:
            if( const SCH_SYMBOL* symbol = static_cast<const SCH_SYMBOL*>( m_parent ) )
            {
                if( m_id == FIELD_T::REFERENCE )
                {
                    wxLogTrace( traceSchFieldRendering, "  Calling GetRef for symbol %s on path %s",
                                symbol->m_Uuid.AsString(), aPath->Path().AsString() );
 
                    retv = symbol->GetRef( aPath, true );
 
                    wxLogTrace( traceSchFieldRendering, "  GetRef returned: '%s'", retv );
                }
                else if( !aVariantName.IsEmpty() )
                {
                    // If the variant is not found, fall back to default variant above.
                    if( std::optional<SCH_SYMBOL_VARIANT> variant = symbol->GetVariant( *aPath, aVariantName ) )
                    {
                        // If the field name does not exist in the variant, fall back to the default variant above.
                        if( variant->m_Fields.contains( GetName() ) )
                            retv = variant->m_Fields[GetName()];
                    }
                }
            }
 
            break;
 
        case SCH_SHEET_T:
            break;
 
        default:
            break;
        }
    }
 
    return retv;
}
 
 
static struct SCH_FIELD_DESC
{
    SCH_FIELD_DESC()
    {
        // These are defined in EDA_TEXT as well but initialization order is
        // not defined, so this needs to be conditional.  Defining in both
        // places leads to duplicate symbols.
        auto& h_inst = ENUM_MAP<GR_TEXT_H_ALIGN_T>::Instance();
 
        if( h_inst.Choices().GetCount() == 0 )
        {
            h_inst.Map( GR_TEXT_H_ALIGN_LEFT, _HKI( "Left" ) );
            h_inst.Map( GR_TEXT_H_ALIGN_CENTER, _HKI( "Center" ) );
            h_inst.Map( GR_TEXT_H_ALIGN_RIGHT, _HKI( "Right" ) );
        }
 
        auto& v_inst = ENUM_MAP<GR_TEXT_V_ALIGN_T>::Instance();
 
        if( v_inst.Choices().GetCount() == 0 )
        {
            v_inst.Map( GR_TEXT_V_ALIGN_TOP, _HKI( "Top" ) );
            v_inst.Map( GR_TEXT_V_ALIGN_CENTER, _HKI( "Center" ) );
            v_inst.Map( GR_TEXT_V_ALIGN_BOTTOM, _HKI( "Bottom" ) );
        }
 
        PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
        REGISTER_TYPE( SCH_FIELD );
        propMgr.AddTypeCast( new TYPE_CAST<SCH_FIELD, SCH_ITEM> );
        propMgr.AddTypeCast( new TYPE_CAST<SCH_FIELD, EDA_TEXT> );
        propMgr.InheritsAfter( TYPE_HASH( SCH_FIELD ), TYPE_HASH( SCH_ITEM ) );
        propMgr.InheritsAfter( TYPE_HASH( SCH_FIELD ), TYPE_HASH( EDA_TEXT ) );
 
        // Lock state is inherited from parent symbol (no independent locking of child items)
        propMgr.Mask( TYPE_HASH( SCH_FIELD ), TYPE_HASH( SCH_ITEM ), _HKI( "Locked" ) );
 
        const wxString textProps = _HKI( "Text Properties" );
 
        auto horiz = new PROPERTY_ENUM<SCH_FIELD, GR_TEXT_H_ALIGN_T>( _HKI( "Horizontal Justification" ),
                                                                      &SCH_FIELD::SetEffectiveHorizJustify,
                                                                      &SCH_FIELD::GetEffectiveHorizJustify );
 
        propMgr.ReplaceProperty( TYPE_HASH( EDA_TEXT ), _HKI( "Horizontal Justification" ), horiz, textProps );
 
        auto vert = new PROPERTY_ENUM<SCH_FIELD, GR_TEXT_V_ALIGN_T>( _HKI( "Vertical Justification" ),
                                                                     &SCH_FIELD::SetEffectiveVertJustify,
                                                                     &SCH_FIELD::GetEffectiveVertJustify );
 
        propMgr.ReplaceProperty( TYPE_HASH( EDA_TEXT ), _HKI( "Vertical Justification" ), vert, textProps );
 
        propMgr.AddProperty( new PROPERTY<SCH_FIELD, bool>( _HKI( "Show Field Name" ), &SCH_FIELD::SetNameShown,
                                                            &SCH_FIELD::IsNameShown ) );
 
        propMgr.AddProperty( new PROPERTY<SCH_FIELD, bool>( _HKI( "Allow Autoplacement" ), &SCH_FIELD::SetCanAutoplace,
                                                            &SCH_FIELD::CanAutoplace ) );
 
        propMgr.Mask( TYPE_HASH( SCH_FIELD ), TYPE_HASH( EDA_TEXT ), _HKI( "Hyperlink" ) );
        propMgr.Mask( TYPE_HASH( SCH_FIELD ), TYPE_HASH( EDA_TEXT ), _HKI( "Thickness" ) );
        propMgr.Mask( TYPE_HASH( SCH_FIELD ), TYPE_HASH( EDA_TEXT ), _HKI( "Mirrored" ) );
        propMgr.Mask( TYPE_HASH( SCH_FIELD ), TYPE_HASH( EDA_TEXT ), _HKI( "Width" ) );
        propMgr.Mask( TYPE_HASH( SCH_FIELD ), TYPE_HASH( EDA_TEXT ), _HKI( "Height" ) );
 
 
        propMgr.AddProperty( new PROPERTY<SCH_FIELD, int>( _HKI( "Text Size" ), &SCH_FIELD::SetSchTextSize,
                                                           &SCH_FIELD::GetSchTextSize, PROPERTY_DISPLAY::PT_SIZE ),
                             _HKI( "Text Properties" ) );
 
        propMgr.Mask( TYPE_HASH( SCH_FIELD ), TYPE_HASH( EDA_TEXT ), _HKI( "Orientation" ) );
 
        auto isNotGeneratedField = []( INSPECTABLE* aItem ) -> bool
        {
            if( SCH_FIELD* field = dynamic_cast<SCH_FIELD*>( aItem ) )
                return !field->IsGeneratedField();
 
            return true;
        };
 
        propMgr.OverrideWriteability( TYPE_HASH( SCH_FIELD ), TYPE_HASH( EDA_TEXT ), _HKI( "Text" ),
                                      isNotGeneratedField );
 
 
        auto isNonMandatoryField = []( INSPECTABLE* aItem ) -> bool
        {
            if( SCH_FIELD* field = dynamic_cast<SCH_FIELD*>( aItem ) )
                return !field->IsMandatory();
 
            return false;
        };
 
        propMgr.OverrideAvailability( TYPE_HASH( SCH_FIELD ), TYPE_HASH( SCH_ITEM ), _HKI( "Private" ),
                                      isNonMandatoryField );
    }
} _SCH_FIELD_DESC;
 
 
DECLARE_ENUM_TO_WXANY( GR_TEXT_H_ALIGN_T )
DECLARE_ENUM_TO_WXANY( GR_TEXT_V_ALIGN_T )