test_autoplace_fields.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * 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/>.
 */

 
#include <qa_utils/wx_utils/unit_test_utils.h>
#include "eeschema_test_utils.h"
 
#include <sch_symbol.h>
#include <sch_field.h>
#include <sch_item.h>
#include <geometry/eda_angle.h>
 
 
class TEST_AUTOPLACE_FIELDS_FIXTURE : public KI_TEST::SCHEMATIC_TEST_FIXTURE
{
public:
    SCH_SYMBOL* GetSymbolByRef( const wxString& aRef )
    {
        if( !m_schematic )
            return nullptr;
 
        SCH_SCREEN* screen = m_schematic->RootScreen();
 
        if( !screen )
            return nullptr;
 
        for( SCH_ITEM* item : screen->Items().OfType( SCH_SYMBOL_T ) )
        {
            SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( item );
 
            if( symbol && symbol->GetRef( &m_schematic->Hierarchy()[0], false ) == aRef )
                return symbol;
        }
 
        return nullptr;
    }
};
 
 
BOOST_FIXTURE_TEST_SUITE( AutoplaceFields, TEST_AUTOPLACE_FIELDS_FIXTURE )
 
 

BOOST_AUTO_TEST_CASE( RotatedSymbolFieldBoundingBox )
{
    wxFileName fn;
    fn.SetPath( KI_TEST::GetEeschemaTestDataDir() );
    fn.AppendDir( wxS( "issue16538" ) );
    fn.SetName( wxS( "issue16538" ) );
    fn.SetExt( FILEEXT::KiCadSchematicFileExtension );
 
    LoadSchematic( fn.GetFullPath() );
 
    SCH_SYMBOL* symbol = GetSymbolByRef( wxS( "C1" ) );
    BOOST_REQUIRE( symbol );
 
    // Verify the symbol is rotated 90 degrees (y1 != 0)
    TRANSFORM transform = symbol->GetTransform();
    BOOST_CHECK( transform.y1 != 0 );
 
    // Get the reference field
    SCH_FIELD* refField = symbol->GetField( FIELD_T::REFERENCE );
    BOOST_REQUIRE( refField );
 
    // Set the field to horizontal angle (as the fix does)
    refField->SetTextAngle( ANGLE_HORIZONTAL );
 
    // Get the bounding box after setting horizontal angle
    BOX2I bbox = refField->GetBoundingBox();
 
    // For a 90-degree rotated symbol with horizontal field angle:
    // The bounding box should be tall and narrow (text displays vertically)
    // Height should be greater than width for short text like "C1"
    BOOST_CHECK_MESSAGE( bbox.GetHeight() > bbox.GetWidth(),
                         wxString::Format( "Expected vertical bounding box (height > width) "
                                           "for rotated symbol. Got width=%lld, height=%lld",
                                           static_cast<long long>( bbox.GetWidth() ),
                                           static_cast<long long>( bbox.GetHeight() ) ) );
}
 

BOOST_AUTO_TEST_CASE( FieldDrawRotationForRotatedSymbol )
{
    wxFileName fn;
    fn.SetPath( KI_TEST::GetEeschemaTestDataDir() );
    fn.AppendDir( wxS( "issue16538" ) );
    fn.SetName( wxS( "issue16538" ) );
    fn.SetExt( FILEEXT::KiCadSchematicFileExtension );
 
    LoadSchematic( fn.GetFullPath() );
 
    SCH_SYMBOL* symbol = GetSymbolByRef( wxS( "C1" ) );
    BOOST_REQUIRE( symbol );
 
    SCH_FIELD* refField = symbol->GetField( FIELD_T::REFERENCE );
    BOOST_REQUIRE( refField );
 
    // Set field to horizontal angle (as the fix does for autoplace)
    refField->SetTextAngle( ANGLE_HORIZONTAL );
 
    // For a 90-degree rotated symbol with horizontal field angle,
    // GetDrawRotation should return vertical (the visual orientation)
    EDA_ANGLE drawRotation = refField->GetDrawRotation();
    BOOST_CHECK_MESSAGE( drawRotation.IsVertical(),
                         wxString::Format( "Expected vertical draw rotation for 90-degree "
                                           "rotated symbol with horizontal field angle. "
                                           "Got %f degrees", drawRotation.AsDegrees() ) );
}
 

BOOST_AUTO_TEST_CASE( RotatedSymbolFieldAngleForHorizontalDisplay )
{
    wxFileName fn;
    fn.SetPath( KI_TEST::GetEeschemaTestDataDir() );
    fn.AppendDir( wxS( "issue16538" ) );
    fn.SetName( wxS( "issue16538" ) );
    fn.SetExt( FILEEXT::KiCadSchematicFileExtension );
 
    LoadSchematic( fn.GetFullPath() );
 
    // C1 is a 90-degree rotated capacitor (y1 != 0)
    SCH_SYMBOL* rotatedSymbol = GetSymbolByRef( wxS( "C1" ) );
    BOOST_REQUIRE( rotatedSymbol );
    BOOST_REQUIRE( rotatedSymbol->GetTransform().y1 != 0 );
 
    SCH_FIELD* refField = rotatedSymbol->GetField( FIELD_T::REFERENCE );
    BOOST_REQUIRE( refField );
 
    // Simulate what the autoplacer should do for rotated symbols
    refField->SetTextAngle( ANGLE_VERTICAL );
 
    EDA_ANGLE drawRotation = refField->GetDrawRotation();
    BOOST_CHECK_MESSAGE( drawRotation.IsHorizontal(),
                         wxString::Format( wxS( "Rotated symbol with VERTICAL field angle "
                                                "should display horizontally. Got %f degrees" ),
                                           drawRotation.AsDegrees() ) );
 
    // R1 is a non-rotated resistor (y1 == 0)
    SCH_SYMBOL* normalSymbol = GetSymbolByRef( wxS( "R1" ) );
    BOOST_REQUIRE( normalSymbol );
    BOOST_REQUIRE( normalSymbol->GetTransform().y1 == 0 );
 
    refField = normalSymbol->GetField( FIELD_T::REFERENCE );
    BOOST_REQUIRE( refField );
 
    // For non-rotated symbols, HORIZONTAL field angle should stay horizontal
    refField->SetTextAngle( ANGLE_HORIZONTAL );
 
    drawRotation = refField->GetDrawRotation();
    BOOST_CHECK_MESSAGE( drawRotation.IsHorizontal(),
                         wxString::Format( wxS( "Non-rotated symbol with HORIZONTAL field angle "
                                                "should display horizontally. Got %f degrees" ),
                                           drawRotation.AsDegrees() ) );
}
 

BOOST_AUTO_TEST_CASE( RotatedSymbolBBoxAngleEffects )
{
    wxFileName fn;
    fn.SetPath( KI_TEST::GetEeschemaTestDataDir() );
    fn.AppendDir( wxS( "issue16538" ) );
    fn.SetName( wxS( "issue16538" ) );
    fn.SetExt( FILEEXT::KiCadSchematicFileExtension );
 
    LoadSchematic( fn.GetFullPath() );
 
    SCH_SYMBOL* symbol = GetSymbolByRef( wxS( "C1" ) );
    BOOST_REQUIRE( symbol );
 
    SCH_FIELD* refField = symbol->GetField( FIELD_T::REFERENCE );
    BOOST_REQUIRE( refField );
 
    // HORIZONTAL angle + 90-degree symbol transform = 90-degree visual rotation.
    // For short text like "C1", this produces a tall, narrow bbox.
    refField->SetTextAngle( ANGLE_HORIZONTAL );
    BOX2I hBox = refField->GetBoundingBox();
 
    // VERTICAL angle + 90-degree symbol transform = 180-degree net rotation.
    // After Normalize() the dimensions match horizontal display (wider than tall).
    refField->SetTextAngle( ANGLE_VERTICAL );
    BOX2I vBox = refField->GetBoundingBox();
 
    BOOST_CHECK_MESSAGE( hBox.GetHeight() > hBox.GetWidth(),
                         wxString::Format( wxS( "HORIZONTAL angle bbox should be taller than "
                                                "wide. Got width=%lld, height=%lld" ),
                                           static_cast<long long>( hBox.GetWidth() ),
                                           static_cast<long long>( hBox.GetHeight() ) ) );
 
    BOOST_CHECK_MESSAGE( vBox.GetWidth() > vBox.GetHeight(),
                         wxString::Format( wxS( "VERTICAL angle bbox should be wider than "
                                                "tall. Got width=%lld, height=%lld" ),
                                           static_cast<long long>( vBox.GetWidth() ),
                                           static_cast<long long>( vBox.GetHeight() ) ) );
 
    refField->SetTextAngle( ANGLE_VERTICAL );
}
 

BOOST_AUTO_TEST_CASE( RotatedSymbolFieldSizingDimensions )
{
    wxFileName fn;
    fn.SetPath( KI_TEST::GetEeschemaTestDataDir() );
    fn.AppendDir( wxS( "issue16538" ) );
    fn.SetName( wxS( "issue16538" ) );
    fn.SetExt( FILEEXT::KiCadSchematicFileExtension );
 
    LoadSchematic( fn.GetFullPath() );
 
    // R1 is a non-rotated resistor, C1 is a 90-degree rotated capacitor
    SCH_SYMBOL* normalSymbol = GetSymbolByRef( wxS( "R1" ) );
    BOOST_REQUIRE( normalSymbol );
    BOOST_REQUIRE( normalSymbol->GetTransform().y1 == 0 );
 
    SCH_SYMBOL* rotatedSymbol = GetSymbolByRef( wxS( "C1" ) );
    BOOST_REQUIRE( rotatedSymbol );
    BOOST_REQUIRE( rotatedSymbol->GetTransform().y1 != 0 );
 
    SCH_FIELD* normalRef = normalSymbol->GetField( FIELD_T::REFERENCE );
    SCH_FIELD* rotatedRef = rotatedSymbol->GetField( FIELD_T::REFERENCE );
    BOOST_REQUIRE( normalRef && rotatedRef );
 
    // For the non-rotated symbol, display angle = HORIZONTAL
    normalRef->SetTextAngle( ANGLE_HORIZONTAL );
    BOX2I normalBBox = normalRef->GetBoundingBox();
 
    // For the 90-degree rotated symbol, display angle = VERTICAL.
    // VERTICAL + 90-degree symbol transform = 180 net rotation, which preserves
    // the native text dimensions (width > height for short text).
    rotatedRef->SetTextAngle( ANGLE_VERTICAL );
    BOX2I rotatedBBox = rotatedRef->GetBoundingBox();
 
    // Both should produce bboxes where width > height (horizontal text dimensions).
    // The normal symbol trivially gets this from HORIZONTAL angle + identity transform.
    // The rotated symbol gets this from VERTICAL + 90-degree transform = 180 net rotation.
    BOOST_CHECK_MESSAGE( normalBBox.GetWidth() > normalBBox.GetHeight(),
                         wxString::Format( wxS( "Normal symbol with HORIZONTAL angle should have "
                                                "width > height. Got width=%lld, height=%lld" ),
                                           static_cast<long long>( normalBBox.GetWidth() ),
                                           static_cast<long long>( normalBBox.GetHeight() ) ) );
 
    BOOST_CHECK_MESSAGE( rotatedBBox.GetWidth() > rotatedBBox.GetHeight(),
                         wxString::Format( wxS( "Rotated symbol with VERTICAL angle should have "
                                                "width > height (native dims). Got width=%lld, "
                                                "height=%lld" ),
                                           static_cast<long long>( rotatedBBox.GetWidth() ),
                                           static_cast<long long>( rotatedBBox.GetHeight() ) ) );
 
    // The height (used for vertical spacing) should be comparable between the two.
    // Both represent the text height for horizontal display.
    int normalH = normalBBox.GetHeight();
    int rotatedH = rotatedBBox.GetHeight();
    double heightRatio = static_cast<double>( std::max( normalH, rotatedH ) )
                       / static_cast<double>( std::max( 1, std::min( normalH, rotatedH ) ) );
 
    BOOST_CHECK_MESSAGE( heightRatio < 2.0,
                         wxString::Format( wxS( "Field height ratio should be < 2.0. "
                                                "Normal=%d, Rotated=%d, Ratio=%.2f" ),
                                           normalH, rotatedH, heightRatio ) );
 
    // Verify that using HORIZONTAL angle on the rotated symbol would produce wrong
    // dimensions (height > width, swapped). This is what the bug looked like.
    rotatedRef->SetTextAngle( ANGLE_HORIZONTAL );
    BOX2I wrongBBox = rotatedRef->GetBoundingBox();
 
    BOOST_CHECK_MESSAGE( wrongBBox.GetHeight() > wrongBBox.GetWidth(),
                         wxString::Format( wxS( "HORIZONTAL angle on rotated symbol should swap "
                                                "dims (height > width). Got width=%lld, "
                                                "height=%lld" ),
                                           static_cast<long long>( wrongBBox.GetWidth() ),
                                           static_cast<long long>( wrongBBox.GetHeight() ) ) );
 
    // Restore
    rotatedRef->SetTextAngle( ANGLE_VERTICAL );
}
 
 
BOOST_AUTO_TEST_CASE( EffectiveJustifyRoundTripFromCenter )
{
    wxFileName fn;
    fn.SetPath( KI_TEST::GetEeschemaTestDataDir() );
    fn.AppendDir( wxS( "issue16538" ) );
    fn.SetName( wxS( "issue16538" ) );
    fn.SetExt( FILEEXT::KiCadSchematicFileExtension );
 
    LoadSchematic( fn.GetFullPath() );
 
    SCH_SYMBOL* symbol = GetSymbolByRef( wxS( "R1" ) );
    BOOST_REQUIRE( symbol );
 
    SCH_FIELD* field = symbol->GetField( FIELD_T::REFERENCE );
    BOOST_REQUIRE( field );
 
    symbol->SetOrientation( SYM_ORIENT_0 + SYM_MIRROR_Y );
 
    field->SetHorizJustify( GR_TEXT_H_ALIGN_LEFT );
    BOOST_REQUIRE( field->IsHorizJustifyFlipped() );
 
    for( GR_TEXT_H_ALIGN_T justify : { GR_TEXT_H_ALIGN_LEFT, GR_TEXT_H_ALIGN_CENTER, GR_TEXT_H_ALIGN_RIGHT } )
    {
        field->SetHorizJustify( GR_TEXT_H_ALIGN_CENTER );
        field->SetEffectiveHorizJustify( justify );
 
        BOOST_CHECK_MESSAGE( field->GetEffectiveHorizJustify() == justify,
                             wxString::Format( wxS( "Horizontal justification %d set from center "
                                                    "reads back as %d" ),
                                               static_cast<int>( justify ),
                                               static_cast<int>( field->GetEffectiveHorizJustify() ) ) );
    }
 
    symbol->SetOrientation( SYM_ORIENT_0 + SYM_MIRROR_X );
 
    field->SetVertJustify( GR_TEXT_V_ALIGN_TOP );
    BOOST_REQUIRE( field->IsVertJustifyFlipped() );
 
    for( GR_TEXT_V_ALIGN_T justify : { GR_TEXT_V_ALIGN_TOP, GR_TEXT_V_ALIGN_CENTER, GR_TEXT_V_ALIGN_BOTTOM } )
    {
        field->SetVertJustify( GR_TEXT_V_ALIGN_CENTER );
        field->SetEffectiveVertJustify( justify );
 
        BOOST_CHECK_MESSAGE( field->GetEffectiveVertJustify() == justify,
                             wxString::Format( wxS( "Vertical justification %d set from center "
                                                    "reads back as %d" ),
                                               static_cast<int>( justify ),
                                               static_cast<int>( field->GetEffectiveVertJustify() ) ) );
    }
}
 
 
BOOST_AUTO_TEST_SUITE_END()