test_ref_suffix.cpp File Reference

Reference suffixes on reused sheets. More...

#include <qa_utils/wx_utils/unit_test_utils.h>
#include <qa_utils/file_utils.h>
#include "eeschema_test_utils.h"
#include <api/api_sch_utils.h>
#include <api/schematic/schematic_types.pb.h>
#include <connectivity/conn_navigation.h>
#include <downgrade/sch_downgrade.h>
#include <downgrade_target.h>
#include <eda_search_data.h>
#include <erc/erc.h>
#include <erc/erc_item.h>
#include <netlist_exporters/netlist_exporter_allegro.h>
#include <netlist_exporters/netlist_exporter_kicad.h>
#include <netlist_exporters/netlist_exporter_xml.h>
#include <reporter.h>
#include <richio.h>
#include <sch_io/kicad_sexpr/sch_io_kicad_sexpr.h>
#include <sch_commit.h>
#include <sch_marker.h>
#include <sch_reference_list.h>
#include <symbol_fields_data_model.h>
#include <tools/backannotate.h>
#include <sch_screen.h>
#include <sch_symbol.h>
#include <sch_sheet.h>
#include <sch_sheet_path.h>
#include <schematic.h>
#include <tool/tool_manager.h>
#include <validators.h>
#include <wildcards_and_files_ext.h>
#include <set>
#include <wx/ffile.h>
#include <wx/regex.h>
#include <wx/tokenzr.h>

Go to the source code of this file.

Classes
class	REF_SUFFIX_FIXTURE

Functions
	BOOST_AUTO_TEST_CASE (SuffixTextRules)
	BOOST_AUTO_TEST_CASE (SaveAndLoad)
	BOOST_AUTO_TEST_CASE (ComposesPerPath)
	BOOST_AUTO_TEST_CASE (ChannelRefsCompose)
	BOOST_AUTO_TEST_CASE (UserTextMapsToBase)
	BOOST_AUTO_TEST_CASE (ErcChecks)
	BOOST_AUTO_TEST_CASE (ErcChecksComposedPackageValues)
	BOOST_AUTO_TEST_CASE (SuffixModeSharesOneBase)
	BOOST_AUTO_TEST_CASE (SeparateNumberingIgnoresConfiguredSuffixes)
	BOOST_AUTO_TEST_CASE (SeparateNumberingResetUsesDistinctPlainReferences)
	BOOST_AUTO_TEST_CASE (SuffixModeNewReferenceAvoidsComposedCollision)
	BOOST_AUTO_TEST_CASE (SuffixModeRenumbersComposedCollision)
	BOOST_AUTO_TEST_CASE (SuffixModeAnnotatesPackages)
	BOOST_AUTO_TEST_CASE (LoadStripsDowngradedPackageSuffix)
	BOOST_AUTO_TEST_CASE (OutputsAgreeOnComposedRefs)

Detailed Description

Reference suffixes on reused sheets.

Definition in file test_ref_suffix.cpp.

Function Documentation

BOOST_AUTO_TEST_CASE() [1/15]

BOOST_AUTO_TEST_CASE

(

ChannelRefsCompose

)

Definition at line 481 of file test_ref_suffix.cpp.

References BOOST_CHECK(), BOOST_CHECK_EQUAL(), SCH_SYMBOL::GetBaseRef(), SCH_SYMBOL::GetField(), SCH_SYMBOL::GetRef(), SCH_FIELD::GetText(), Load(), SCH_CONNECTIVITY::NAVIGATION_QUERY::NetNames(), and REFERENCE.

BOOST_AUTO_TEST_CASE() [2/15]

BOOST_AUTO_TEST_CASE

(

ComposesPerPath

)

Definition at line 393 of file test_ref_suffix.cpp.

References SCH_SHEET_PATH::at(), BOOST_CHECK(), BOOST_CHECK_EQUAL(), BOOST_REQUIRE_EQUAL(), SCH_SHEET_PATH::GetCurrentHash(), SCH_FIELD::GetShownText(), SCH_SHEET::HasHierarchyChanges(), INTERNAL, BASE_SCREEN::IsContentModified(), SCH_SHEET_PATH::LastScreen(), Load(), VARIANT::m_Fields, COMMIT::Modify(), path, SCH_COMMIT::Push(), SCH_SHEET_PATH::push_back(), BASE_SCREEN::SetContentModified(), TOOL_MANAGER::SetEnvironment(), SHEET_REF_SUFFIX, SHEET_USER, SCH_SHEET_PATH::size(), and SKIP_UNDO.

BOOST_AUTO_TEST_CASE() [3/15]

BOOST_AUTO_TEST_CASE

(

ErcChecks

)

Definition at line 576 of file test_ref_suffix.cpp.

References BOOST_CHECK_EQUAL(), BOOST_REQUIRE(), ERCE_DUPLICATE_SHEET_SUFFIX, ERCE_REF_SUFFIX_MISMATCH, LoadSchematic(), path, SCH_IO_KICAD_SEXPR::SaveSchematicFile(), and SHEET_REF_SUFFIX.

BOOST_AUTO_TEST_CASE() [4/15]

BOOST_AUTO_TEST_CASE

(

ErcChecksComposedPackageValues

)

Definition at line 617 of file test_ref_suffix.cpp.

References SCH_SCREEN::Append(), BOOST_CHECK_EQUAL(), BOOST_REQUIRE(), BOOST_REQUIRE_EQUAL(), ERCE_DIFFERENT_UNIT_VALUE, SCH_SYMBOL::GetField(), SCH_SYMBOL::GetRef(), SCH_SHEET_PATH::LastScreen(), SCH_SYMBOL::SetRef(), SCH_FIELD::SetText(), SHEET_REF_SUFFIX, source, and VALUE.

BOOST_AUTO_TEST_CASE() [5/15]

BOOST_AUTO_TEST_CASE

(

LoadStripsDowngradedPackageSuffix

)

Definition at line 867 of file test_ref_suffix.cpp.

References BOOST_CHECK_EQUAL(), BOOST_REQUIRE(), SCH_SYMBOL::GetBaseRef(), SCH_SCREEN::SetFileName(), SCH_SYMBOL::SetRef(), SCH_SYMBOL::SetRefLacksSuffix(), and SCH_SHEET::SetScreen().

BOOST_AUTO_TEST_CASE() [6/15]

BOOST_AUTO_TEST_CASE

(

OutputsAgreeOnComposedRefs

)

Definition at line 908 of file test_ref_suffix.cpp.

References FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::AddColumn(), BOOST_CHECK(), BOOST_CHECK_EQUAL(), BOOST_REQUIRE(), STRING_FORMATTER::Clear(), comp, ERCE_REF_SUFFIX_MISMATCH, expected, NETLIST_EXPORTER_KICAD::Format(), SCH_SYMBOL::GetBaseRef(), GetDefaultFieldName(), FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::GetNumberRows(), SCH_SYMBOL::GetRef(), STRING_FORMATTER::GetString(), FIELDS_TABLE_DATA_MODEL< ITEM_TYPE >::GetValue(), GNL_ALL, GNL_OPT_KICAD, netlist, path, KI_TEST::SCOPED_TEMP_DIR::PathStr(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::RebuildRows(), REFERENCE, reporter, SCH_SYMBOL_T, SCH_SYMBOL::SetExcludedFromBoard(), FIELDS_TABLE_DATA_MODEL_BASE::SetGroupingEnabled(), SCH_SYMBOL::SetRef(), SYMBOL_FILTER_NON_POWER, text, UNTRANSLATED, and NETLIST_EXPORTER_BASE::WriteNetlist().

BOOST_AUTO_TEST_CASE() [7/15]

BOOST_AUTO_TEST_CASE

(

SaveAndLoad

)

Definition at line 294 of file test_ref_suffix.cpp.

References SCH_SHEET_LIST::AddNewSymbolInstances(), BOOST_CHECK(), BOOST_CHECK_EQUAL(), BOOST_REQUIRE(), BOOST_TEST_CONTEXT(), SCH_SYMBOL::GetBaseRef(), GetDowngradeTargets(), SCH_SYMBOL::GetInstance(), SCH_SYMBOL::GetRef(), SCHEMATIC::Hierarchy(), FILEEXT::KiCadSchematicFileExtension, LoadSchematic(), SCH_IO_KICAD_SEXPR::LoadSchematicFile(), SCH_SYMBOL_INSTANCE::m_Reference, EDA_ITEM::m_Uuid, path, SCHEMATIC::RefreshHierarchy(), SCHEMATIC::Reset(), SCH_IO_KICAD_SEXPR::SaveSchematicFile(), SaveSchematicForTarget(), SCH_SYMBOL_T, SCH_SYMBOL::SetRef(), SHEET_REF_SUFFIX, and text.

BOOST_AUTO_TEST_CASE() [8/15]

BOOST_AUTO_TEST_CASE

(

SeparateNumberingIgnoresConfiguredSuffixes

)

Definition at line 682 of file test_ref_suffix.cpp.

References ANNOTATE_SELECTION, AnnotateReferences(), BOOST_CHECK(), BOOST_CHECK_EQUAL(), BOOST_REQUIRE(), SCH_SYMBOL::GetBaseRef(), SCH_SYMBOL::GetRef(), INCREMENTAL_BY_REF, Load(), locked, SCH_SYMBOL::SetRef(), SORT_BY_X_POSITION, and SYMBOL_FILTER_NON_POWER.

BOOST_AUTO_TEST_CASE() [9/15]

BOOST_AUTO_TEST_CASE

(

SeparateNumberingResetUsesDistinctPlainReferences

)

Definition at line 714 of file test_ref_suffix.cpp.

References ANNOTATE_ALL, AnnotateReferences(), BOOST_CHECK(), BOOST_CHECK_EQUAL(), BOOST_REQUIRE(), SCH_SYMBOL::GetBaseRef(), SCH_SHEET_LIST::GetMultiUnitSymbols(), SCH_SYMBOL::GetRef(), SCH_SHEET_LIST::GetSymbols(), INCREMENTAL_BY_REF, Load(), locked, SCH_SYMBOL::SetRef(), SORT_BY_X_POSITION, and SYMBOL_FILTER_NON_POWER.

BOOST_AUTO_TEST_CASE() [10/15]

BOOST_AUTO_TEST_CASE

(

SuffixModeAnnotatesPackages

)

Definition at line 806 of file test_ref_suffix.cpp.

References BOOST_CHECK_EQUAL(), BOOST_REQUIRE(), SCH_SYMBOL::ClearAnnotation(), SCH_SYMBOL::GetBaseRef(), SCH_SYMBOL::GetRef(), INCREMENTAL_BY_REF, SCH_SYMBOL::SetRef(), and SCH_SYMBOL::SetUnitSelection().

BOOST_AUTO_TEST_CASE() [11/15]

BOOST_AUTO_TEST_CASE

(

SuffixModeNewReferenceAvoidsComposedCollision

)

Definition at line 743 of file test_ref_suffix.cpp.

References BOOST_CHECK_EQUAL(), BOOST_REQUIRE(), SCH_SYMBOL::GetRef(), Load(), path, and SCH_SYMBOL::SetRef().

BOOST_AUTO_TEST_CASE() [12/15]

BOOST_AUTO_TEST_CASE

(

SuffixModeRenumbersComposedCollision

)

Definition at line 767 of file test_ref_suffix.cpp.

References BOOST_CHECK_EQUAL(), BOOST_REQUIRE(), SCH_SYMBOL::GetRef(), Load(), path, SCH_SYMBOL::SetRef(), SHEET_REF_SUFFIX, and SHEET_USER.

BOOST_AUTO_TEST_CASE() [13/15]

BOOST_AUTO_TEST_CASE

(

SuffixModeSharesOneBase

)

Definition at line 648 of file test_ref_suffix.cpp.

References BOOST_CHECK(), BOOST_CHECK_EQUAL(), SCH_SYMBOL::GetBaseRef(), SCH_SYMBOL::GetPrefix(), SCH_SYMBOL::GetRef(), Load(), path, SCH_SYMBOL_T, and SCH_SYMBOL::SetRef().

BOOST_AUTO_TEST_CASE() [14/15]

BOOST_AUTO_TEST_CASE

(

SuffixTextRules

)

Definition at line 266 of file test_ref_suffix.cpp.

References BOOST_AUTO_TEST_CASE(), BOOST_CHECK(), BOOST_CHECK_EQUAL(), GetFieldValidationErrorMessage(), SCH_FIELD::GetId(), SCH_SHEET::NextRefSuffix(), SCH_FIELD::SetName(), SCH_FIELD::SetOrdinal(), SHEET_REF_SUFFIX, and SHEET_USER.

BOOST_AUTO_TEST_CASE() [15/15]

BOOST_AUTO_TEST_CASE

(

UserTextMapsToBase

)

Definition at line 508 of file test_ref_suffix.cpp.

References ApplySymbolInstance(), SCH_SYMBOL::BaseRefFromUser(), BOOST_CHECK(), BOOST_CHECK_EQUAL(), BOOST_REQUIRE(), EDA_SEARCH_DATA::findString, SCH_SYMBOL::GetBaseRef(), SCH_SYMBOL::GetField(), SCH_SYMBOL::GetRef(), Load(), EDA_SEARCH_DATA::matchMode, PackSymbol(), PLAIN, REFERENCE, SCH_FIELD::Replace(), SCH_SEARCH_DATA::replaceReferences, EDA_SEARCH_DATA::replaceString, ResolveBackannotatedRefs(), SCH_SYMBOL::SetRef(), SCH_SYMBOL::SetRefProp(), SHEET_REF_SUFFIX, split(), and SYMBOL_FILTER_ALL.