haskal
/
kicad
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
kicad/qa/eeschema/test_lib_part.cpp

476 lines
16 KiB
C++
Raw Normal View History

QA eeschema: add some tests This adds a few tests on: * LIB_PART * SCH_PIN * SCH_SHEET * SCH_SHEET_PATH These tests exercise some of the basic code paths in these classes and show some of the expected behaviours. None of these tests are particularly ground-breaking, but they provide a starting point to build out further tests, and to ensure the already-covered behaviour is stable. It does expose some places where SCH_SHEET could probably use const.
2019-04-23 08:18:15 +00:00
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
Eeschema: fix false positive library symbol changed ERC errors. This fix required sorting all of the LIB_PART draw items to ensure accurate comparison between the symbols stored in the schematic and the original library symbols. This has a noticeable impact on symbol library load performance. It may also cause significant changes the next time the library is saved due to changes in the draw item sorting. Hashing may be a better solution here but this addressed the immediate problem. A skeleton method SCH_SCREEN::SwapSymbolLinks() was added because there is most likely an issue with orphaned symbols in the schematic library symbol cache during undo/redo operations. More testing is required to verify this. Fixes https://gitlab.com/kicad/code/kicad/-/issues/7263
2021-03-04 22:59:24 +00:00
* Copyright (C) 2019-2021 KiCad Developers, see AUTHORS.txt for contributors.
QA eeschema: add some tests This adds a few tests on: * LIB_PART * SCH_PIN * SCH_SHEET * SCH_SHEET_PATH These tests exercise some of the basic code paths in these classes and show some of the expected behaviours. None of these tests are particularly ground-breaking, but they provide a starting point to build out further tests, and to ensure the already-covered behaviour is stable. It does expose some places where SCH_SHEET could probably use const.
2019-04-23 08:18:15 +00:00
*
* 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
*/
/**
* @file
* Test suite for LIB_PART
*/
qa: merge unit_test_utils to qa_utils
2021-02-06 22:20:31 +00:00
#include <qa_utils/wx_utils/unit_test_utils.h>
QA eeschema: add some tests This adds a few tests on: * LIB_PART * SCH_PIN * SCH_SHEET * SCH_SHEET_PATH These tests exercise some of the basic code paths in these classes and show some of the expected behaviours. None of these tests are particularly ground-breaking, but they provide a starting point to build out further tests, and to ensure the already-covered behaviour is stable. It does expose some places where SCH_SHEET could probably use const.
2019-04-23 08:18:15 +00:00
// Code under test
Implement simple inheritance for library symbols. This change completely removes the LIB_ALIAS design pattern an replaces it by allowing LIB_PART objects to inherit from other LIB_PART objects. The initial implementation only allows for single inheritance and only supports the mandatory fields in the derived part because that is all that the current symbol library file format will support. Once the new file format is implemented and saving to the old file format is deprecated, more complex inheritance will be added. The LIB_ALIAS information saved in the document files was move into the LIB_PART object. This change impacts virtually every part of the schematic and symbol library editor code so this commit message is woefully incomplete. REMOVE: Removed the symbol aliases concept from the schematic and symbol editors and the symbol viewer. NEW: Replace the symbol alias concept with simple inheritance that allows a library symbol to be derived from another library symbol.
2019-11-06 19:15:42 +00:00
#include <lib_rectangle.h>
#include <lib_arc.h>
#include <lib_pin.h>
QA eeschema: add some tests This adds a few tests on: * LIB_PART * SCH_PIN * SCH_SHEET * SCH_SHEET_PATH These tests exercise some of the basic code paths in these classes and show some of the expected behaviours. None of these tests are particularly ground-breaking, but they provide a starting point to build out further tests, and to ensure the already-covered behaviour is stable. It does expose some places where SCH_SHEET could probably use const.
2019-04-23 08:18:15 +00:00
#include "lib_field_test_utils.h"
class TEST_LIB_PART_FIXTURE
{
public:
Eeschema: implement new symbol library file s-expression formatter. CHANGES: Symbol library file format has been converted to s-expressions. Add support code for picking apart symbols at some future junction that will allow full inheritance conversion of existing symbol libraries. For now, symbols arranged by unit and body style numbers are nested for round robin testing of symbol libraries once the parser is complete.
2020-02-13 13:39:52 +00:00
TEST_LIB_PART_FIXTURE() :
m_part_no_data( "part_name", nullptr )
QA eeschema: add some tests This adds a few tests on: * LIB_PART * SCH_PIN * SCH_SHEET * SCH_SHEET_PATH These tests exercise some of the basic code paths in these classes and show some of the expected behaviours. None of these tests are particularly ground-breaking, but they provide a starting point to build out further tests, and to ensure the already-covered behaviour is stable. It does expose some places where SCH_SHEET could probably use const.
2019-04-23 08:18:15 +00:00
{
}
///> Part with no extra data set
LIB_PART m_part_no_data;
};
/**
* Declare the test suite
*/
BOOST_FIXTURE_TEST_SUITE( LibPart, TEST_LIB_PART_FIXTURE )
/**
* Check that we can get the basic properties out as expected
*/
BOOST_AUTO_TEST_CASE( DefaultProperties )
{
BOOST_CHECK_EQUAL( m_part_no_data.GetName(), "part_name" );
// Didn't set a library, so this is empty
BOOST_CHECK_EQUAL( m_part_no_data.GetLibraryName(), "" );
BOOST_CHECK_EQUAL( m_part_no_data.GetLib(), nullptr );
// only get the root
Implement simple inheritance for library symbols. This change completely removes the LIB_ALIAS design pattern an replaces it by allowing LIB_PART objects to inherit from other LIB_PART objects. The initial implementation only allows for single inheritance and only supports the mandatory fields in the derived part because that is all that the current symbol library file format will support. Once the new file format is implemented and saving to the old file format is deprecated, more complex inheritance will be added. The LIB_ALIAS information saved in the document files was move into the LIB_PART object. This change impacts virtually every part of the schematic and symbol library editor code so this commit message is woefully incomplete. REMOVE: Removed the symbol aliases concept from the schematic and symbol editors and the symbol viewer. NEW: Replace the symbol alias concept with simple inheritance that allows a library symbol to be derived from another library symbol.
2019-11-06 19:15:42 +00:00
BOOST_CHECK_EQUAL( m_part_no_data.IsRoot(), true );
BOOST_CHECK_EQUAL( m_part_no_data.IsAlias(), false );
BOOST_CHECK_EQUAL( m_part_no_data.SharedPtr().use_count(), 2 );
QA eeschema: add some tests This adds a few tests on: * LIB_PART * SCH_PIN * SCH_SHEET * SCH_SHEET_PATH These tests exercise some of the basic code paths in these classes and show some of the expected behaviours. None of these tests are particularly ground-breaking, but they provide a starting point to build out further tests, and to ensure the already-covered behaviour is stable. It does expose some places where SCH_SHEET could probably use const.
2019-04-23 08:18:15 +00:00
// no sub units
BOOST_CHECK_EQUAL( m_part_no_data.GetUnitCount(), 1 );
BOOST_CHECK_EQUAL( m_part_no_data.IsMulti(), false );
// no conversion
BOOST_CHECK_EQUAL( m_part_no_data.HasConversion(), false );
}
/**
* Check the drawings on a "blank" LIB_PART
*/
BOOST_AUTO_TEST_CASE( DefaultDrawings )
{
// default drawings exist
BOOST_CHECK_EQUAL( m_part_no_data.GetDrawItems().size(), 4 );
Implement simple inheritance for library symbols. This change completely removes the LIB_ALIAS design pattern an replaces it by allowing LIB_PART objects to inherit from other LIB_PART objects. The initial implementation only allows for single inheritance and only supports the mandatory fields in the derived part because that is all that the current symbol library file format will support. Once the new file format is implemented and saving to the old file format is deprecated, more complex inheritance will be added. The LIB_ALIAS information saved in the document files was move into the LIB_PART object. This change impacts virtually every part of the schematic and symbol library editor code so this commit message is woefully incomplete. REMOVE: Removed the symbol aliases concept from the schematic and symbol editors and the symbol viewer. NEW: Replace the symbol alias concept with simple inheritance that allows a library symbol to be derived from another library symbol.
2019-11-06 19:15:42 +00:00
BOOST_CHECK_EQUAL( m_part_no_data.GetNextDrawItem( NULL, LIB_PIN_T ), (LIB_ITEM*)NULL );
QA eeschema: add some tests This adds a few tests on: * LIB_PART * SCH_PIN * SCH_SHEET * SCH_SHEET_PATH These tests exercise some of the basic code paths in these classes and show some of the expected behaviours. None of these tests are particularly ground-breaking, but they provide a starting point to build out further tests, and to ensure the already-covered behaviour is stable. It does expose some places where SCH_SHEET could probably use const.
2019-04-23 08:18:15 +00:00
}
/**
* Check the default fields are present as expected
*/
BOOST_AUTO_TEST_CASE( DefaultFields )
{
Fix some bugs in Change Symbol and Update Symbols. In particular, there was a typo that kept library values from being updated, and there was missing logic to fetch the various field names from the library parts (and the change-to part). Also implements some performance gains by desisting from copying LIB_FIELDs around every time we want to look at them. Fixes https://gitlab.com/kicad/code/kicad/issues/6733 Fixes https://gitlab.com/kicad/code/kicad/issues/6749
2020-12-15 15:06:19 +00:00
std::vector<LIB_FIELD> fields;
QA eeschema: add some tests This adds a few tests on: * LIB_PART * SCH_PIN * SCH_SHEET * SCH_SHEET_PATH These tests exercise some of the basic code paths in these classes and show some of the expected behaviours. None of these tests are particularly ground-breaking, but they provide a starting point to build out further tests, and to ensure the already-covered behaviour is stable. It does expose some places where SCH_SHEET could probably use const.
2019-04-23 08:18:15 +00:00
m_part_no_data.GetFields( fields );
// Should get the 4 default fields
BOOST_CHECK_PREDICATE( KI_TEST::AreDefaultFieldsCorrect, ( fields ) );
// but no more (we didn't set them)
SCH_COMPONENT::GetField() expects a vector index, not a field id. Check this at compile time. Callers wanting to use an index now must use SCH_COMPONENT::GetFields()[i] instead. Fixes https://gitlab.com/kicad/code/kicad/issues/7757
2021-02-28 13:28:23 +00:00
BOOST_CHECK_EQUAL( fields.size(), MANDATORY_FIELD_T::MANDATORY_FIELDS );
QA eeschema: add some tests This adds a few tests on: * LIB_PART * SCH_PIN * SCH_SHEET * SCH_SHEET_PATH These tests exercise some of the basic code paths in these classes and show some of the expected behaviours. None of these tests are particularly ground-breaking, but they provide a starting point to build out further tests, and to ensure the already-covered behaviour is stable. It does expose some places where SCH_SHEET could probably use const.
2019-04-23 08:18:15 +00:00
// also check the default field accessors
BOOST_CHECK_PREDICATE( KI_TEST::FieldNameIdMatches,
SCH_COMPONENT::GetField() expects a vector index, not a field id. Check this at compile time. Callers wanting to use an index now must use SCH_COMPONENT::GetFields()[i] instead. Fixes https://gitlab.com/kicad/code/kicad/issues/7757
2021-02-28 13:28:23 +00:00
( m_part_no_data.GetReferenceField() )( "Reference" )( MANDATORY_FIELD_T::REFERENCE_FIELD ) );
QA eeschema: add some tests This adds a few tests on: * LIB_PART * SCH_PIN * SCH_SHEET * SCH_SHEET_PATH These tests exercise some of the basic code paths in these classes and show some of the expected behaviours. None of these tests are particularly ground-breaking, but they provide a starting point to build out further tests, and to ensure the already-covered behaviour is stable. It does expose some places where SCH_SHEET could probably use const.
2019-04-23 08:18:15 +00:00
BOOST_CHECK_PREDICATE( KI_TEST::FieldNameIdMatches,
SCH_COMPONENT::GetField() expects a vector index, not a field id. Check this at compile time. Callers wanting to use an index now must use SCH_COMPONENT::GetFields()[i] instead. Fixes https://gitlab.com/kicad/code/kicad/issues/7757
2021-02-28 13:28:23 +00:00
( m_part_no_data.GetValueField() )( "Value" )( MANDATORY_FIELD_T::VALUE_FIELD ) );
QA eeschema: add some tests This adds a few tests on: * LIB_PART * SCH_PIN * SCH_SHEET * SCH_SHEET_PATH These tests exercise some of the basic code paths in these classes and show some of the expected behaviours. None of these tests are particularly ground-breaking, but they provide a starting point to build out further tests, and to ensure the already-covered behaviour is stable. It does expose some places where SCH_SHEET could probably use const.
2019-04-23 08:18:15 +00:00
BOOST_CHECK_PREDICATE( KI_TEST::FieldNameIdMatches,
SCH_COMPONENT::GetField() expects a vector index, not a field id. Check this at compile time. Callers wanting to use an index now must use SCH_COMPONENT::GetFields()[i] instead. Fixes https://gitlab.com/kicad/code/kicad/issues/7757
2021-02-28 13:28:23 +00:00
( m_part_no_data.GetFootprintField() )( "Footprint" )( MANDATORY_FIELD_T::FOOTPRINT_FIELD ) );
QA eeschema: add some tests This adds a few tests on: * LIB_PART * SCH_PIN * SCH_SHEET * SCH_SHEET_PATH These tests exercise some of the basic code paths in these classes and show some of the expected behaviours. None of these tests are particularly ground-breaking, but they provide a starting point to build out further tests, and to ensure the already-covered behaviour is stable. It does expose some places where SCH_SHEET could probably use const.
2019-04-23 08:18:15 +00:00
}
/**
* Test adding fields to a LIB_PART
*/
BOOST_AUTO_TEST_CASE( AddedFields )
{
Fix some bugs in Change Symbol and Update Symbols. In particular, there was a typo that kept library values from being updated, and there was missing logic to fetch the various field names from the library parts (and the change-to part). Also implements some performance gains by desisting from copying LIB_FIELDs around every time we want to look at them. Fixes https://gitlab.com/kicad/code/kicad/issues/6733 Fixes https://gitlab.com/kicad/code/kicad/issues/6749
2020-12-15 15:06:19 +00:00
std::vector<LIB_FIELD> fields;
QA eeschema: add some tests This adds a few tests on: * LIB_PART * SCH_PIN * SCH_SHEET * SCH_SHEET_PATH These tests exercise some of the basic code paths in these classes and show some of the expected behaviours. None of these tests are particularly ground-breaking, but they provide a starting point to build out further tests, and to ensure the already-covered behaviour is stable. It does expose some places where SCH_SHEET could probably use const.
2019-04-23 08:18:15 +00:00
m_part_no_data.GetFields( fields );
// Ctor takes non-const ref (?!)
const std::string newFieldName = "new_field";
wxString nonConstNewFieldName = newFieldName;
fields.push_back( LIB_FIELD( 42, nonConstNewFieldName ) );
// fairly roundabout way to add a field, but it is what it is
m_part_no_data.SetFields( fields );
// Should get the 4 default fields
BOOST_CHECK_PREDICATE( KI_TEST::AreDefaultFieldsCorrect, ( fields ) );
// and our new one
SCH_COMPONENT::GetField() expects a vector index, not a field id. Check this at compile time. Callers wanting to use an index now must use SCH_COMPONENT::GetFields()[i] instead. Fixes https://gitlab.com/kicad/code/kicad/issues/7757
2021-02-28 13:28:23 +00:00
BOOST_REQUIRE_EQUAL( fields.size(), MANDATORY_FIELD_T::MANDATORY_FIELDS + 1 );
QA eeschema: add some tests This adds a few tests on: * LIB_PART * SCH_PIN * SCH_SHEET * SCH_SHEET_PATH These tests exercise some of the basic code paths in these classes and show some of the expected behaviours. None of these tests are particularly ground-breaking, but they provide a starting point to build out further tests, and to ensure the already-covered behaviour is stable. It does expose some places where SCH_SHEET could probably use const.
2019-04-23 08:18:15 +00:00
BOOST_CHECK_PREDICATE( KI_TEST::FieldNameIdMatches,
SCH_COMPONENT::GetField() expects a vector index, not a field id. Check this at compile time. Callers wanting to use an index now must use SCH_COMPONENT::GetFields()[i] instead. Fixes https://gitlab.com/kicad/code/kicad/issues/7757
2021-02-28 13:28:23 +00:00
( fields[MANDATORY_FIELD_T::MANDATORY_FIELDS] )( newFieldName )( 42 ) );
QA eeschema: add some tests This adds a few tests on: * LIB_PART * SCH_PIN * SCH_SHEET * SCH_SHEET_PATH These tests exercise some of the basic code paths in these classes and show some of the expected behaviours. None of these tests are particularly ground-breaking, but they provide a starting point to build out further tests, and to ensure the already-covered behaviour is stable. It does expose some places where SCH_SHEET could probably use const.
2019-04-23 08:18:15 +00:00
// Check by-id lookup
SCH_COMPONENT::GetField() expects a vector index, not a field id. Check this at compile time. Callers wanting to use an index now must use SCH_COMPONENT::GetFields()[i] instead. Fixes https://gitlab.com/kicad/code/kicad/issues/7757
2021-02-28 13:28:23 +00:00
LIB_FIELD* gotNewField = m_part_no_data.GetFieldById( 42 );
QA eeschema: add some tests This adds a few tests on: * LIB_PART * SCH_PIN * SCH_SHEET * SCH_SHEET_PATH These tests exercise some of the basic code paths in these classes and show some of the expected behaviours. None of these tests are particularly ground-breaking, but they provide a starting point to build out further tests, and to ensure the already-covered behaviour is stable. It does expose some places where SCH_SHEET could probably use const.
2019-04-23 08:18:15 +00:00
BOOST_REQUIRE_NE( gotNewField, nullptr );
BOOST_CHECK_PREDICATE( KI_TEST::FieldNameIdMatches, ( *gotNewField )( newFieldName )( 42 ) );
// Check by-name lookup
gotNewField = m_part_no_data.FindField( newFieldName );
BOOST_REQUIRE_NE( gotNewField, nullptr );
BOOST_CHECK_PREDICATE( KI_TEST::FieldNameIdMatches, ( *gotNewField )( newFieldName )( 42 ) );
}
Implement simple inheritance for library symbols. This change completely removes the LIB_ALIAS design pattern an replaces it by allowing LIB_PART objects to inherit from other LIB_PART objects. The initial implementation only allows for single inheritance and only supports the mandatory fields in the derived part because that is all that the current symbol library file format will support. Once the new file format is implemented and saving to the old file format is deprecated, more complex inheritance will be added. The LIB_ALIAS information saved in the document files was move into the LIB_PART object. This change impacts virtually every part of the schematic and symbol library editor code so this commit message is woefully incomplete. REMOVE: Removed the symbol aliases concept from the schematic and symbol editors and the symbol viewer. NEW: Replace the symbol alias concept with simple inheritance that allows a library symbol to be derived from another library symbol.
2019-11-06 19:15:42 +00:00
/**
* Test adding draw items to a LIB_PART
*/
BOOST_AUTO_TEST_CASE( AddedDrawItems )
{
}
QA eeschema: add some tests This adds a few tests on: * LIB_PART * SCH_PIN * SCH_SHEET * SCH_SHEET_PATH These tests exercise some of the basic code paths in these classes and show some of the expected behaviours. None of these tests are particularly ground-breaking, but they provide a starting point to build out further tests, and to ensure the already-covered behaviour is stable. It does expose some places where SCH_SHEET could probably use const.
2019-04-23 08:18:15 +00:00
struct TEST_LIB_PART_SUBREF_CASE
{
int m_index;
bool m_addSep;
std::string m_expSubRef;
};
/**
* Test the subreference indexing
*/
BOOST_AUTO_TEST_CASE( SubReference )
{
const std::vector<TEST_LIB_PART_SUBREF_CASE> cases = {
{
1,
false,
"A",
},
{
2,
false,
"B",
},
{
26,
false,
"Z",
},
{
27,
false,
"AA",
},
{ // haven't configured a separator, so should be nothing
1,
true,
"A",
},
};
for( const auto& c : cases )
{
BOOST_TEST_CONTEXT(
"Subref: " << c.m_index << ", " << c.m_addSep << " -> '" << c.m_expSubRef << "'" )
{
const auto subref = m_part_no_data.SubReference( c.m_index, c.m_addSep );
BOOST_CHECK_EQUAL( subref, c.m_expSubRef );
}
}
}
Implement simple inheritance for library symbols. This change completely removes the LIB_ALIAS design pattern an replaces it by allowing LIB_PART objects to inherit from other LIB_PART objects. The initial implementation only allows for single inheritance and only supports the mandatory fields in the derived part because that is all that the current symbol library file format will support. Once the new file format is implemented and saving to the old file format is deprecated, more complex inheritance will be added. The LIB_ALIAS information saved in the document files was move into the LIB_PART object. This change impacts virtually every part of the schematic and symbol library editor code so this commit message is woefully incomplete. REMOVE: Removed the symbol aliases concept from the schematic and symbol editors and the symbol viewer. NEW: Replace the symbol alias concept with simple inheritance that allows a library symbol to be derived from another library symbol.
2019-11-06 19:15:42 +00:00
/**
* Check the compare method.
*/
BOOST_AUTO_TEST_CASE( Compare )
{
// Identical root part to m_part_no_data sans time stamp.
LIB_PART testPart( "part_name" );
// Self comparison test.
BOOST_CHECK_EQUAL( m_part_no_data.Compare( m_part_no_data ), 0 );
// Test for identical LIB_PART.
BOOST_CHECK_EQUAL( m_part_no_data.Compare( testPart ), 0 );
// Test name.
testPart.SetName( "tart_name" );
BOOST_CHECK( m_part_no_data.Compare( testPart ) < 0 );
testPart.SetName( "cart_name" );
BOOST_CHECK( m_part_no_data.Compare( testPart ) > 0 );
testPart.SetName( "part_name" );
// LIB_ID comparison tests.
LIB_ID id = testPart.GetLibId();
id.SetLibItemName( "tart_name" );
testPart.SetLibId( id );
BOOST_CHECK( m_part_no_data.Compare( testPart ) < 0 );
id.SetLibItemName( "cart_name" );
testPart.SetLibId( id );
BOOST_CHECK( m_part_no_data.Compare( testPart ) > 0 );
id.SetLibItemName( "part_name" );
testPart.SetLibId( id );
// Unit count comparison tests.
testPart.SetUnitCount( 2 );
BOOST_CHECK( m_part_no_data.Compare( testPart ) < 0 );
testPart.SetUnitCount( 1 );
m_part_no_data.SetUnitCount( 2 );
BOOST_CHECK( m_part_no_data.Compare( testPart ) > 0 );
m_part_no_data.SetUnitCount( 1 );
// Options flag comparison tests.
testPart.SetPower();
BOOST_CHECK( m_part_no_data.Compare( testPart ) < 0 );
testPart.SetNormal();
m_part_no_data.SetPower();
BOOST_CHECK( m_part_no_data.Compare( testPart ) > 0 );
m_part_no_data.SetNormal();
// Draw item list size comparison tests.
testPart.AddDrawItem( new LIB_RECTANGLE( &testPart ) );
m_part_no_data.AddDrawItem( new LIB_RECTANGLE( &m_part_no_data ) );
BOOST_CHECK_EQUAL( m_part_no_data.Compare( testPart ), 0 );
m_part_no_data.RemoveDrawItem( m_part_no_data.GetNextDrawItem( nullptr, LIB_RECTANGLE_T ) );
BOOST_CHECK( m_part_no_data.Compare( testPart ) < 0 );
testPart.RemoveDrawItem( testPart.GetNextDrawItem( nullptr, LIB_RECTANGLE_T ) );
m_part_no_data.AddDrawItem( new LIB_RECTANGLE( &m_part_no_data ) );
BOOST_CHECK( m_part_no_data.Compare( testPart ) > 0 );
m_part_no_data.RemoveDrawItem( m_part_no_data.GetNextDrawItem( nullptr, LIB_RECTANGLE_T ) );
// Draw item list contents comparison tests.
testPart.AddDrawItem( new LIB_RECTANGLE( &testPart ) );
m_part_no_data.AddDrawItem( new LIB_ARC( &m_part_no_data ) );
BOOST_CHECK( m_part_no_data.Compare( testPart ) < 0 );
m_part_no_data.RemoveDrawItem( m_part_no_data.GetNextDrawItem( nullptr, LIB_ARC_T ) );
m_part_no_data.AddDrawItem( new LIB_PIN( &m_part_no_data ) );
BOOST_CHECK( m_part_no_data.Compare( testPart ) > 0 );
m_part_no_data.RemoveDrawItem( m_part_no_data.GetNextDrawItem( nullptr, LIB_PIN_T ) );
testPart.RemoveDrawItem( testPart.GetNextDrawItem( nullptr, LIB_RECTANGLE_T ) );
// Footprint filter array comparison tests.
wxArrayString footPrintFilters;
Aliases should inherit their descs, keywords, and fp filters. Assuming they're not set locally, of course. Also updates to new class structure order. Fixes https://gitlab.com/kicad/code/kicad/issues/6051
2020-12-14 13:47:32 +00:00
BOOST_CHECK( m_part_no_data.GetFPFilters() == footPrintFilters );
Implement simple inheritance for library symbols. This change completely removes the LIB_ALIAS design pattern an replaces it by allowing LIB_PART objects to inherit from other LIB_PART objects. The initial implementation only allows for single inheritance and only supports the mandatory fields in the derived part because that is all that the current symbol library file format will support. Once the new file format is implemented and saving to the old file format is deprecated, more complex inheritance will be added. The LIB_ALIAS information saved in the document files was move into the LIB_PART object. This change impacts virtually every part of the schematic and symbol library editor code so this commit message is woefully incomplete. REMOVE: Removed the symbol aliases concept from the schematic and symbol editors and the symbol viewer. NEW: Replace the symbol alias concept with simple inheritance that allows a library symbol to be derived from another library symbol.
2019-11-06 19:15:42 +00:00
footPrintFilters.Add( "b" );
Aliases should inherit their descs, keywords, and fp filters. Assuming they're not set locally, of course. Also updates to new class structure order. Fixes https://gitlab.com/kicad/code/kicad/issues/6051
2020-12-14 13:47:32 +00:00
testPart.SetFPFilters( footPrintFilters );
Implement simple inheritance for library symbols. This change completely removes the LIB_ALIAS design pattern an replaces it by allowing LIB_PART objects to inherit from other LIB_PART objects. The initial implementation only allows for single inheritance and only supports the mandatory fields in the derived part because that is all that the current symbol library file format will support. Once the new file format is implemented and saving to the old file format is deprecated, more complex inheritance will be added. The LIB_ALIAS information saved in the document files was move into the LIB_PART object. This change impacts virtually every part of the schematic and symbol library editor code so this commit message is woefully incomplete. REMOVE: Removed the symbol aliases concept from the schematic and symbol editors and the symbol viewer. NEW: Replace the symbol alias concept with simple inheritance that allows a library symbol to be derived from another library symbol.
2019-11-06 19:15:42 +00:00
BOOST_CHECK( m_part_no_data.Compare( testPart ) < 0 );
Aliases should inherit their descs, keywords, and fp filters. Assuming they're not set locally, of course. Also updates to new class structure order. Fixes https://gitlab.com/kicad/code/kicad/issues/6051
2020-12-14 13:47:32 +00:00
m_part_no_data.SetFPFilters( footPrintFilters );
Implement simple inheritance for library symbols. This change completely removes the LIB_ALIAS design pattern an replaces it by allowing LIB_PART objects to inherit from other LIB_PART objects. The initial implementation only allows for single inheritance and only supports the mandatory fields in the derived part because that is all that the current symbol library file format will support. Once the new file format is implemented and saving to the old file format is deprecated, more complex inheritance will be added. The LIB_ALIAS information saved in the document files was move into the LIB_PART object. This change impacts virtually every part of the schematic and symbol library editor code so this commit message is woefully incomplete. REMOVE: Removed the symbol aliases concept from the schematic and symbol editors and the symbol viewer. NEW: Replace the symbol alias concept with simple inheritance that allows a library symbol to be derived from another library symbol.
2019-11-06 19:15:42 +00:00
footPrintFilters.Clear();
Aliases should inherit their descs, keywords, and fp filters. Assuming they're not set locally, of course. Also updates to new class structure order. Fixes https://gitlab.com/kicad/code/kicad/issues/6051
2020-12-14 13:47:32 +00:00
testPart.SetFPFilters( footPrintFilters );
Implement simple inheritance for library symbols. This change completely removes the LIB_ALIAS design pattern an replaces it by allowing LIB_PART objects to inherit from other LIB_PART objects. The initial implementation only allows for single inheritance and only supports the mandatory fields in the derived part because that is all that the current symbol library file format will support. Once the new file format is implemented and saving to the old file format is deprecated, more complex inheritance will be added. The LIB_ALIAS information saved in the document files was move into the LIB_PART object. This change impacts virtually every part of the schematic and symbol library editor code so this commit message is woefully incomplete. REMOVE: Removed the symbol aliases concept from the schematic and symbol editors and the symbol viewer. NEW: Replace the symbol alias concept with simple inheritance that allows a library symbol to be derived from another library symbol.
2019-11-06 19:15:42 +00:00
BOOST_CHECK( m_part_no_data.Compare( testPart ) > 0 );
footPrintFilters.Clear();
Aliases should inherit their descs, keywords, and fp filters. Assuming they're not set locally, of course. Also updates to new class structure order. Fixes https://gitlab.com/kicad/code/kicad/issues/6051
2020-12-14 13:47:32 +00:00
m_part_no_data.SetFPFilters( footPrintFilters );
testPart.SetFPFilters( footPrintFilters );
Implement simple inheritance for library symbols. This change completely removes the LIB_ALIAS design pattern an replaces it by allowing LIB_PART objects to inherit from other LIB_PART objects. The initial implementation only allows for single inheritance and only supports the mandatory fields in the derived part because that is all that the current symbol library file format will support. Once the new file format is implemented and saving to the old file format is deprecated, more complex inheritance will be added. The LIB_ALIAS information saved in the document files was move into the LIB_PART object. This change impacts virtually every part of the schematic and symbol library editor code so this commit message is woefully incomplete. REMOVE: Removed the symbol aliases concept from the schematic and symbol editors and the symbol viewer. NEW: Replace the symbol alias concept with simple inheritance that allows a library symbol to be derived from another library symbol.
2019-11-06 19:15:42 +00:00
// Description string tests.
m_part_no_data.SetDescription( "b" );
testPart.SetDescription( "b" );
BOOST_CHECK_EQUAL( m_part_no_data.Compare( testPart ), 0 );
m_part_no_data.SetDescription( "a" );
BOOST_CHECK( m_part_no_data.Compare( testPart ) < 0 );
m_part_no_data.SetDescription( "c" );
BOOST_CHECK( m_part_no_data.Compare( testPart ) > 0 );
m_part_no_data.SetDescription( wxEmptyString );
testPart.SetDescription( wxEmptyString );
// Key word string tests.
m_part_no_data.SetKeyWords( "b" );
testPart.SetKeyWords( "b" );
BOOST_CHECK_EQUAL( m_part_no_data.Compare( testPart ), 0 );
m_part_no_data.SetKeyWords( "a" );
BOOST_CHECK( m_part_no_data.Compare( testPart ) < 0 );
m_part_no_data.SetKeyWords( "c" );
BOOST_CHECK( m_part_no_data.Compare( testPart ) > 0 );
m_part_no_data.SetKeyWords( wxEmptyString );
testPart.SetKeyWords( wxEmptyString );
// Pin name offset comparison tests.
testPart.SetPinNameOffset( testPart.GetPinNameOffset() + 1 );
BOOST_CHECK( m_part_no_data.Compare( testPart ) < 0 );
testPart.SetPinNameOffset( testPart.GetPinNameOffset() - 2 );
BOOST_CHECK( m_part_no_data.Compare( testPart ) > 0 );
testPart.SetPinNameOffset( testPart.GetPinNameOffset() + 1 );
// Units locked flag comparision tests.
testPart.LockUnits( true );
BOOST_CHECK( m_part_no_data.Compare( testPart ) < 0 );
testPart.LockUnits( false );
m_part_no_data.LockUnits( true );
BOOST_CHECK( m_part_no_data.Compare( testPart ) > 0 );
m_part_no_data.LockUnits( false );
Exclude from bill of materials and board netlist to library symbols. ADDED: Support for exclude from bill of materials and board netlist to library symbols. Fixes https://gitlab.com/kicad/code/kicad/issues/4915
2020-09-09 13:03:37 +00:00
// Include in BOM support tests.
testPart.SetIncludeInBom( false );
BOOST_CHECK( m_part_no_data.Compare( testPart ) > 0 );
testPart.SetIncludeInBom( true );
m_part_no_data.SetIncludeInBom( false );
BOOST_CHECK( m_part_no_data.Compare( testPart ) < 0 );
m_part_no_data.SetIncludeInBom( true );
// Include on board support tests.
testPart.SetIncludeOnBoard( false );
BOOST_CHECK( m_part_no_data.Compare( testPart ) > 0 );
testPart.SetIncludeOnBoard( true );
m_part_no_data.SetIncludeOnBoard( false );
BOOST_CHECK( m_part_no_data.Compare( testPart ) < 0 );
m_part_no_data.SetIncludeOnBoard( true );
Implement simple inheritance for library symbols. This change completely removes the LIB_ALIAS design pattern an replaces it by allowing LIB_PART objects to inherit from other LIB_PART objects. The initial implementation only allows for single inheritance and only supports the mandatory fields in the derived part because that is all that the current symbol library file format will support. Once the new file format is implemented and saving to the old file format is deprecated, more complex inheritance will be added. The LIB_ALIAS information saved in the document files was move into the LIB_PART object. This change impacts virtually every part of the schematic and symbol library editor code so this commit message is woefully incomplete. REMOVE: Removed the symbol aliases concept from the schematic and symbol editors and the symbol viewer. NEW: Replace the symbol alias concept with simple inheritance that allows a library symbol to be derived from another library symbol.
2019-11-06 19:15:42 +00:00
// Show pin names flag comparison tests.
m_part_no_data.SetShowPinNames( false );
BOOST_CHECK( m_part_no_data.Compare( testPart ) < 0 );
m_part_no_data.SetShowPinNames( true );
testPart.SetShowPinNames( false );
BOOST_CHECK( m_part_no_data.Compare( testPart ) > 0 );
testPart.SetShowPinNames( true );
// Show pin numbers flag comparison tests.
m_part_no_data.SetShowPinNumbers( false );
BOOST_CHECK( m_part_no_data.Compare( testPart ) < 0 );
m_part_no_data.SetShowPinNumbers( true );
testPart.SetShowPinNumbers( false );
BOOST_CHECK( m_part_no_data.Compare( testPart ) > 0 );
testPart.SetShowPinNumbers( true );
// Time stamp comparison tests.
Eeschema: fix false positive library symbol changed ERC errors. This fix required sorting all of the LIB_PART draw items to ensure accurate comparison between the symbols stored in the schematic and the original library symbols. This has a noticeable impact on symbol library load performance. It may also cause significant changes the next time the library is saved due to changes in the draw item sorting. Hashing may be a better solution here but this addressed the immediate problem. A skeleton method SCH_SCREEN::SwapSymbolLinks() was added because there is most likely an issue with orphaned symbols in the schematic library symbol cache during undo/redo operations. More testing is required to verify this. Fixes https://gitlab.com/kicad/code/kicad/-/issues/7263
2021-03-04 22:59:24 +00:00
// Check to see if we broke the copy ctor.
LIB_PART* copy = new LIB_PART( testPart );
BOOST_CHECK( testPart.Compare( *copy ) == 0 );
Implement simple inheritance for library symbols. This change completely removes the LIB_ALIAS design pattern an replaces it by allowing LIB_PART objects to inherit from other LIB_PART objects. The initial implementation only allows for single inheritance and only supports the mandatory fields in the derived part because that is all that the current symbol library file format will support. Once the new file format is implemented and saving to the old file format is deprecated, more complex inheritance will be added. The LIB_ALIAS information saved in the document files was move into the LIB_PART object. This change impacts virtually every part of the schematic and symbol library editor code so this commit message is woefully incomplete. REMOVE: Removed the symbol aliases concept from the schematic and symbol editors and the symbol viewer. NEW: Replace the symbol alias concept with simple inheritance that allows a library symbol to be derived from another library symbol.
2019-11-06 19:15:42 +00:00
}
Eeschema: implement new symbol library file s-expression formatter. CHANGES: Symbol library file format has been converted to s-expressions. Add support code for picking apart symbols at some future junction that will allow full inheritance conversion of existing symbol libraries. For now, symbols arranged by unit and body style numbers are nested for round robin testing of symbol libraries once the parser is complete.
2020-02-13 13:39:52 +00:00
/**
* Check the fetch unit items code.
*/
BOOST_AUTO_TEST_CASE( GetUnitItems )
{
// There are no unit draw items in the empty LIB_PART object.
BOOST_CHECK( m_part_no_data.GetUnitItems( 1, 1 ).size() == 0 );
// A single unique unit with 1 pin common to all units and all body styles.
LIB_PIN* pin1 = new LIB_PIN( &m_part_no_data );
m_part_no_data.AddDrawItem( pin1 );
BOOST_CHECK( m_part_no_data.GetUnitItems( 0, 0 ).size() == 1 );
// A single unique unit with 1 pin in unit 1 and common to all body styles.
pin1->SetUnit( 1 );
BOOST_CHECK( m_part_no_data.GetUnitItems( 1, 0 ).size() == 1 );
// A single unique unit with 1 pin in unit 1 and body style 1.
pin1->SetConvert( 1 );
BOOST_CHECK( m_part_no_data.GetUnitItems( 1, 1 ).size() == 1 );
// Two unique units with pin 1 assigned to unit 1 and body style 1 and pin 2 assinged to
// unit 2 and body style 1.
LIB_PIN* pin2 = new LIB_PIN( &m_part_no_data );
m_part_no_data.SetUnitCount( 2 );
pin2->SetUnit( 2 );
pin2->SetConvert( 2 );
pin2->SetNumber( "4" );
m_part_no_data.AddDrawItem( pin2 );
BOOST_CHECK( m_part_no_data.GetUnitItems( 2, 2 ).size() == 1 );
// Make pin 1 body style common to all units.
pin1->SetConvert( 0 );
BOOST_CHECK( m_part_no_data.GetUnitItems( 1, 1 ).size() == 0 );
BOOST_CHECK( m_part_no_data.GetUnitItems( 2, 1 ).size() == 1 );
m_part_no_data.RemoveDrawItem( pin2 );
m_part_no_data.RemoveDrawItem( pin1 );
m_part_no_data.RemoveDrawItem( m_part_no_data.GetNextDrawItem() );
}
/**
* Check the fetch unit draw items code.
*/
BOOST_AUTO_TEST_CASE( GetUnitDrawItems )
{
// There are no unit draw items in the empty LIB_PART object.
BOOST_CHECK( m_part_no_data.GetUnitDrawItems().size() == 0 );
// A single unique unit with 1 pin common to all units and all body styles.
LIB_PIN* pin1 = new LIB_PIN( &m_part_no_data );
pin1->SetNumber( "1" );
m_part_no_data.AddDrawItem( pin1 );
std::vector<struct PART_UNITS> units = m_part_no_data.GetUnitDrawItems();
BOOST_CHECK( units.size() == 1 );
BOOST_CHECK( units[0].m_unit == 0 );
BOOST_CHECK( units[0].m_convert == 0 );
BOOST_CHECK( units[0].m_items[0] == pin1 );
}
Implement simple inheritance for library symbols. This change completely removes the LIB_ALIAS design pattern an replaces it by allowing LIB_PART objects to inherit from other LIB_PART objects. The initial implementation only allows for single inheritance and only supports the mandatory fields in the derived part because that is all that the current symbol library file format will support. Once the new file format is implemented and saving to the old file format is deprecated, more complex inheritance will be added. The LIB_ALIAS information saved in the document files was move into the LIB_PART object. This change impacts virtually every part of the schematic and symbol library editor code so this commit message is woefully incomplete. REMOVE: Removed the symbol aliases concept from the schematic and symbol editors and the symbol viewer. NEW: Replace the symbol alias concept with simple inheritance that allows a library symbol to be derived from another library symbol.
2019-11-06 19:15:42 +00:00
/**
* Check inheritance support.
*/
BOOST_AUTO_TEST_CASE( Inheritance )
{
Cleanup creation of all our smart pointers
2020-10-26 23:49:11 +00:00
std::unique_ptr<LIB_PART> parent = std::make_unique<LIB_PART>( "parent" );
Implement simple inheritance for library symbols. This change completely removes the LIB_ALIAS design pattern an replaces it by allowing LIB_PART objects to inherit from other LIB_PART objects. The initial implementation only allows for single inheritance and only supports the mandatory fields in the derived part because that is all that the current symbol library file format will support. Once the new file format is implemented and saving to the old file format is deprecated, more complex inheritance will be added. The LIB_ALIAS information saved in the document files was move into the LIB_PART object. This change impacts virtually every part of the schematic and symbol library editor code so this commit message is woefully incomplete. REMOVE: Removed the symbol aliases concept from the schematic and symbol editors and the symbol viewer. NEW: Replace the symbol alias concept with simple inheritance that allows a library symbol to be derived from another library symbol.
2019-11-06 19:15:42 +00:00
BOOST_CHECK( parent->IsRoot() );
Cleanup creation of all our smart pointers
2020-10-26 23:49:11 +00:00
std::unique_ptr<LIB_PART> child1 = std::make_unique<LIB_PART>( "child1", parent.get() );
Implement simple inheritance for library symbols. This change completely removes the LIB_ALIAS design pattern an replaces it by allowing LIB_PART objects to inherit from other LIB_PART objects. The initial implementation only allows for single inheritance and only supports the mandatory fields in the derived part because that is all that the current symbol library file format will support. Once the new file format is implemented and saving to the old file format is deprecated, more complex inheritance will be added. The LIB_ALIAS information saved in the document files was move into the LIB_PART object. This change impacts virtually every part of the schematic and symbol library editor code so this commit message is woefully incomplete. REMOVE: Removed the symbol aliases concept from the schematic and symbol editors and the symbol viewer. NEW: Replace the symbol alias concept with simple inheritance that allows a library symbol to be derived from another library symbol.
2019-11-06 19:15:42 +00:00
BOOST_CHECK( child1->IsAlias() );
PART_SPTR parentRef = child1->GetParent().lock();
BOOST_CHECK( parentRef );
BOOST_CHECK( parentRef == parent->SharedPtr() );
BOOST_CHECK_EQUAL( parent->SharedPtr().use_count(), 3 );
BOOST_CHECK_EQUAL( child1->GetUnitCount(), 1 );
parent->SetUnitCount( 4 );
BOOST_CHECK_EQUAL( child1->GetUnitCount(), 4 );
child1->SetParent();
BOOST_CHECK_EQUAL( child1->GetUnitCount(), 1 );
parentRef.reset();
BOOST_CHECK_EQUAL( parent->SharedPtr().use_count(), 2 );
}
/**
* Check the copy constructor.
*/
BOOST_AUTO_TEST_CASE( CopyConstructor )
{
Cleanup creation of all our smart pointers
2020-10-26 23:49:11 +00:00
std::shared_ptr<LIB_PART> copy = std::make_shared<LIB_PART>( m_part_no_data );
Implement simple inheritance for library symbols. This change completely removes the LIB_ALIAS design pattern an replaces it by allowing LIB_PART objects to inherit from other LIB_PART objects. The initial implementation only allows for single inheritance and only supports the mandatory fields in the derived part because that is all that the current symbol library file format will support. Once the new file format is implemented and saving to the old file format is deprecated, more complex inheritance will be added. The LIB_ALIAS information saved in the document files was move into the LIB_PART object. This change impacts virtually every part of the schematic and symbol library editor code so this commit message is woefully incomplete. REMOVE: Removed the symbol aliases concept from the schematic and symbol editors and the symbol viewer. NEW: Replace the symbol alias concept with simple inheritance that allows a library symbol to be derived from another library symbol.
2019-11-06 19:15:42 +00:00
BOOST_CHECK( m_part_no_data == *copy.get() );
}
BOOST_AUTO_TEST_SUITE_END()