KiCad PCB EDA Suite
Loading...
Searching...
No Matches
eeschema_test_utils.cpp
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2019-2023 KiCad Developers, see AUTHORS.TXT for contributors.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, you may find one here:
18 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19 * or you may search the http://www.gnu.org website for the version 2 license,
20 * or you may write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22 */
23
24#include "eeschema_test_utils.h"
27
28#include <cstdlib>
29#include <memory>
30
31#include <eeschema/sch_io_mgr.h>
32#include <eeschema/sch_screen.h>
33#include <eeschema/schematic.h>
35
36
37void KI_TEST::SCHEMATIC_TEST_FIXTURE::LoadSchematic( const wxString& aBaseName )
38{
39 wxFileName fn = GetSchematicPath( aBaseName );
40
41 BOOST_TEST_MESSAGE( fn.GetFullPath() );
42
43 wxFileName pro( fn );
44 pro.SetExt( ProjectFileExtension );
45
46 // Schematic must be reset before a project is reloaded
48 m_manager.LoadProject( pro.GetFullPath() );
49
51
53 m_schematic.SetRoot( m_pi->LoadSchematicFile( fn.GetFullPath(), &m_schematic ) );
54
55 BOOST_REQUIRE_EQUAL( m_pi->GetError().IsEmpty(), true );
56
58
59 SCH_SCREENS screens( m_schematic.Root() );
60
61 for( SCH_SCREEN* screen = screens.GetFirst(); screen; screen = screens.GetNext() )
62 screen->UpdateLocalLibSymbolLinks();
63
65
66 // Restore all of the loaded symbol instances from the root sheet screen.
69
72
74 {
75 for( SCH_SCREEN* screen = screens.GetFirst(); screen; screen = screens.GetNext() )
76 screen->MigrateSimModels();
77 }
78
81
83
84 // NOTE: This is required for multi-unit symbols to be correct
85 for( SCH_SHEET_PATH& sheet : sheets )
86 sheet.UpdateAllScreenReferences();
87
88 // NOTE: SchematicCleanUp is not called; QA schematics must already be clean or else
89 // SchematicCleanUp must be freed from its UI dependencies.
90
92}
93
94
95wxFileName KI_TEST::SCHEMATIC_TEST_FIXTURE::GetSchematicPath( const wxString& aBaseName )
96{
97 wxFileName fn( KI_TEST::GetEeschemaTestDataDir() );
98 fn.AppendDir( "netlists" );
99 fn.AppendDir( aBaseName );
100 fn.SetName( aBaseName );
101 fn.SetExt( KiCadSchematicFileExtension );
102
103 return fn;
104}
105
106
107template <typename Exporter>
109{
110 wxFileName netFile = m_schematic.Prj().GetProjectFullName();
111
112 if( aTest )
113 netFile.SetName( netFile.GetName() + "_test" );
114
115 netFile.SetExt( NetlistFileExtension );
116
117 return netFile.GetFullPath();
118}
119
120
121template <typename Exporter>
123{
124 // In case of a crash the file may not have been deleted.
125 if( wxFileExists( GetNetlistPath( true ) ) )
126 wxRemoveFile( GetNetlistPath( true ) );
127
128 wxString errors;
129 WX_STRING_REPORTER reporter( &errors );
130 std::unique_ptr<Exporter> exporter = std::make_unique<Exporter>( &m_schematic );
131
132 bool success = exporter->WriteNetlist( GetNetlistPath( true ), GetNetlistOptions(), reporter );
133
134 BOOST_REQUIRE( success && errors.IsEmpty() );
135}
136
137
138template <typename Exporter>
140{
141 wxRemoveFile( GetNetlistPath( true ) );
142 m_schematic.Reset();
143}
144
145
146template <typename Exporter>
148{
149 LoadSchematic( aBaseName );
150 WriteNetlist();
151 CompareNetlists();
152 Cleanup();
153}
154
155
void Recalculate(const SCH_SHEET_LIST &aSheetList, bool aUnconditional=false, std::function< void(SCH_ITEM *)> *aChangedItemHandler=nullptr)
Updates the connection graph for the given list of sheets.
virtual void LoadSchematic(const wxString &aRelativePath)
virtual wxFileName GetSchematicPath(const wxString &aBaseName)
virtual void SetElem(ELEM_T aIndex, _ELEM *aElem)
Definition: project.cpp:311
@ ELEM_SCH_SYMBOL_LIBS
Definition: project.h:217
void Reset()
Initialize this schematic to a blank one, unloading anything existing.
Definition: schematic.cpp:57
SCH_SHEET_PATH & CurrentSheet() const override
Definition: schematic.h:136
CONNECTION_GRAPH * ConnectionGraph() const override
Definition: schematic.h:146
SCH_SHEET_LIST GetSheets() const override
Builds and returns an updated schematic hierarchy TODO: can this be cached?
Definition: schematic.h:100
void SetRoot(SCH_SHEET *aRootSheet)
Initialize the schematic with a new root sheet.
Definition: schematic.cpp:113
void SetProject(PROJECT *aPrj)
Definition: schematic.cpp:83
SCH_SCREEN * RootScreen() const
Helper to retrieve the screen of the root sheet.
Definition: schematic.cpp:126
SCH_SHEET & Root() const
Definition: schematic.h:105
virtual const wxString & GetError() const
Return an error string to the caller.
Definition: sch_plugin.cpp:216
virtual SCH_SHEET * LoadSchematicFile(const wxString &aFileName, SCHEMATIC *aSchematic, SCH_SHEET *aAppendToMe=nullptr, const STRING_UTF8_MAP *aProperties=nullptr)
Load information from some input file format that this SCH_PLUGIN implementation knows about,...
Definition: sch_plugin.cpp:126
Container class that holds multiple SCH_SCREEN objects in a hierarchy.
Definition: sch_screen.h:673
SCH_SCREEN * GetNext()
void FixLegacyPowerSymbolMismatches()
Fix legacy power symbols that have mismatched value text fields and invisible power pin names.
SCH_SCREEN * GetFirst()
const std::vector< SCH_SYMBOL_INSTANCE > & GetSymbolInstances() const
Definition: sch_screen.h:515
int GetFileFormatVersionAtLoad() const
Definition: sch_screen.h:129
const std::vector< SCH_SHEET_INSTANCE > & GetSheetInstances() const
Definition: sch_screen.h:520
A container for handling SCH_SHEET_PATH objects in a flattened hierarchy.
void UpdateSheetInstanceData(const std::vector< SCH_SHEET_INSTANCE > &aSheetInstances)
Update all of the sheet instance information using aSheetInstances.
void AnnotatePowerSymbols()
Silently annotate the not yet annotated power symbols of the entire hierarchy of the sheet path list.
void UpdateSymbolInstanceData(const std::vector< SCH_SYMBOL_INSTANCE > &aSymbolInstances)
Update all of the symbol instance information using aSymbolInstances.
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
void push_back(SCH_SHEET *aSheet)
Forwarded method from std::vector.
bool LoadProject(const wxString &aFullPath, bool aSetActive=true)
Loads a project or sets up a new project with a specified path.
PROJECT & Prj() const
A helper while we are not MDI-capable – return the one and only project.
void TestNetlist(const wxString &aBaseName)
virtual wxString GetNetlistPath(bool aTest=false)
A wrapper for reporting to a wxString object.
Definition: reporter.h:164
const std::string ProjectFileExtension
const std::string NetlistFileExtension
const std::string KiCadSchematicFileExtension
void LoadSchematic(SETTINGS_MANAGER &aSettingsManager, const wxString &aRelPath, std::unique_ptr< SCHEMATIC > &aSchematic)
std::string GetEeschemaTestDataDir()
Get the configured location of Eeschema test data.
Definition of file extensions used in Kicad.