/* * This program source code file is part of KiCad, a free EDA CAD application. * * Copyright (C) 2020-2022 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 3 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 . */ #include #include #include #include #include #include #include #include #include #include SCHEMATIC::SCHEMATIC( PROJECT* aPrj ) : EDA_ITEM( nullptr, SCHEMATIC_T ), m_project( nullptr ), m_rootSheet( nullptr ) { m_currentSheet = new SCH_SHEET_PATH(); m_connectionGraph = new CONNECTION_GRAPH( this ); SetProject( aPrj ); } SCHEMATIC::~SCHEMATIC() { delete m_currentSheet; delete m_connectionGraph; } void SCHEMATIC::Reset() { // Assume project already saved if( m_project ) { PROJECT_FILE& project = m_project->GetProjectFile(); delete project.m_ErcSettings; delete project.m_SchematicSettings; project.m_ErcSettings = nullptr; project.m_SchematicSettings = nullptr; m_project = nullptr; // clear the project, so we don't do this again when setting a new one } delete m_rootSheet; m_rootSheet = nullptr; m_connectionGraph->Reset(); m_currentSheet->clear(); } void SCHEMATIC::SetProject( PROJECT* aPrj ) { if( m_project ) { PROJECT_FILE& project = m_project->GetProjectFile(); delete project.m_ErcSettings; delete project.m_SchematicSettings; project.m_ErcSettings = nullptr; project.m_SchematicSettings = nullptr; } m_project = aPrj; if( m_project ) { PROJECT_FILE& project = m_project->GetProjectFile(); project.m_ErcSettings = new ERC_SETTINGS( &project, "erc" ); project.m_SchematicSettings = new SCHEMATIC_SETTINGS( &project, "schematic" ); project.m_SchematicSettings->LoadFromFile(); project.m_SchematicSettings->m_NgspiceSimulatorSettings->LoadFromFile(); project.m_ErcSettings->LoadFromFile(); } } void SCHEMATIC::SetRoot( SCH_SHEET* aRootSheet ) { wxCHECK_RET( aRootSheet, "Call to SetRoot with null SCH_SHEET!" ); m_rootSheet = aRootSheet; m_currentSheet->clear(); m_currentSheet->push_back( m_rootSheet ); m_connectionGraph->Reset(); } SCH_SCREEN* SCHEMATIC::RootScreen() const { return IsValid() ? m_rootSheet->GetScreen() : nullptr; } bool SCHEMATIC::ResolveTextVar( wxString* token, int aDepth ) const { if( !CurrentSheet().empty() ) { if( token->IsSameAs( wxT( "#" ) ) ) { *token = CurrentSheet().GetPageNumber(); return true; } else if( token->IsSameAs( wxT( "##" ) ) ) { *token = wxString::Format( "%i", Root().CountSheets() ); return true; } else if( token->IsSameAs( wxT( "SHEETPATH" ) ) ) { *token = CurrentSheet().PathHumanReadable(); return true; } else if( token->IsSameAs( wxT( "SHEETNAME" ) ) ) { *token = CurrentSheet().Last()->GetName(); return true; } else if( token->IsSameAs( wxT( "FILENAME" ) ) ) { wxFileName fn( GetFileName() ); *token = fn.GetFullName(); return true; } else if( token->IsSameAs( wxT( "PROJECTNAME" ) ) ) { *token = Prj().GetProjectName(); return true; } return CurrentSheet().LastScreen()->GetTitleBlock().TextVarResolver( token, m_project ); } return false; } wxString SCHEMATIC::GetFileName() const { return IsValid() ? m_rootSheet->GetScreen()->GetFileName() : wxString( wxEmptyString ); } SCHEMATIC_SETTINGS& SCHEMATIC::Settings() const { wxASSERT( m_project ); return *m_project->GetProjectFile().m_SchematicSettings; } ERC_SETTINGS& SCHEMATIC::ErcSettings() const { wxASSERT( m_project ); return *m_project->GetProjectFile().m_ErcSettings; } std::vector SCHEMATIC::ResolveERCExclusions() { SCH_SHEET_LIST sheetList = GetSheets(); ERC_SETTINGS& settings = ErcSettings(); for( const SCH_SHEET_PATH& sheet : sheetList ) { for( SCH_ITEM* item : sheet.LastScreen()->Items().OfType( SCH_MARKER_T ) ) { SCH_MARKER* marker = static_cast( item ); auto it = settings.m_ErcExclusions.find( marker->Serialize() ); if( it != settings.m_ErcExclusions.end() ) { marker->SetExcluded( true ); settings.m_ErcExclusions.erase( it ); } } } std::vector newMarkers; for( const wxString& exclusionData : settings.m_ErcExclusions ) { SCH_MARKER* marker = SCH_MARKER::Deserialize( exclusionData ); if( marker ) { marker->SetExcluded( true ); newMarkers.push_back( marker ); } } settings.m_ErcExclusions.clear(); return newMarkers; } std::shared_ptr SCHEMATIC::GetBusAlias( const wxString& aLabel ) const { for( const auto& sheet : GetSheets() ) { for( const auto& alias : sheet.LastScreen()->GetBusAliases() ) { if( alias->GetName() == aLabel ) return alias; } } return nullptr; } std::set SCHEMATIC::GetNetClassAssignmentCandidates() { std::set names; for( const auto& [ key, subgraphList ] : m_connectionGraph->GetNetMap() ) { CONNECTION_SUBGRAPH* firstSubgraph = subgraphList[0]; if( !firstSubgraph->m_driver_connection->IsBus() && firstSubgraph->GetDriverPriority() >= CONNECTION_SUBGRAPH::PRIORITY::PIN ) { names.insert( key.Name ); } } return names; } bool SCHEMATIC::ResolveCrossReference( wxString* token, int aDepth ) const { SCH_SHEET_LIST sheetList = GetSheets(); wxString remainder; wxString ref = token->BeforeFirst( ':', &remainder ); SCH_SHEET_PATH sheetPath; SCH_ITEM* refItem = sheetList.GetItem( KIID( ref ), &sheetPath ); if( refItem && refItem->Type() == SCH_SYMBOL_T ) { SCH_SYMBOL* refSymbol = static_cast( refItem ); if( refSymbol->ResolveTextVar( &remainder, aDepth + 1 ) ) *token = remainder; else *token = refSymbol->GetRef( &sheetPath, true ) + ":" + remainder; return true; // Cross-reference is resolved whether or not the actual textvar was } else if( refItem && refItem->Type() == SCH_SHEET_T ) { SCH_SHEET* refSheet = static_cast( refItem ); if( refSheet->ResolveTextVar( &remainder, aDepth + 1 ) ) *token = remainder; return true; // Cross-reference is resolved whether or not the actual textvar was } return false; } std::map SCHEMATIC::GetVirtualPageToSheetNamesMap() const { std::map namesMap; for( const SCH_SHEET_PATH& sheet : GetSheets() ) { if( sheet.size() == 1 ) namesMap[sheet.GetVirtualPageNumber()] = _( "" ); else namesMap[sheet.GetVirtualPageNumber()] = sheet.Last()->GetName(); } return namesMap; } std::map SCHEMATIC::GetVirtualPageToSheetPagesMap() const { std::map pagesMap; for( const SCH_SHEET_PATH& sheet : GetSheets() ) pagesMap[sheet.GetVirtualPageNumber()] = sheet.GetPageNumber(); return pagesMap; } wxString SCHEMATIC::ConvertRefsToKIIDs( const wxString& aSource ) const { wxString newbuf; size_t sourceLen = aSource.length(); for( size_t i = 0; i < sourceLen; ++i ) { if( aSource[i] == '$' && i + 1 < sourceLen && aSource[i+1] == '{' ) { wxString token; bool isCrossRef = false; int nesting = 0; for( i = i + 2; i < sourceLen; ++i ) { if( aSource[i] == '{' && ( aSource[i-1] == '_' || aSource[i-1] == '^' || aSource[i-1] == '~' ) ) { nesting++; } if( aSource[i] == '}' ) { nesting--; if( nesting < 0 ) break; } if( aSource[i] == ':' ) isCrossRef = true; token.append( aSource[i] ); } if( isCrossRef ) { SCH_SHEET_LIST sheetList = GetSheets(); wxString remainder; wxString ref = token.BeforeFirst( ':', &remainder ); SCH_REFERENCE_LIST references; sheetList.GetSymbols( references ); for( size_t jj = 0; jj < references.GetCount(); jj++ ) { SCH_SYMBOL* refSymbol = references[ jj ].GetSymbol(); if( ref == refSymbol->GetRef( &references[ jj ].GetSheetPath(), true ) ) { token = refSymbol->m_Uuid.AsString() + ":" + remainder; break; } } } newbuf.append( "${" + token + "}" ); } else { newbuf.append( aSource[i] ); } } return newbuf; } wxString SCHEMATIC::ConvertKIIDsToRefs( const wxString& aSource ) const { wxString newbuf; size_t sourceLen = aSource.length(); for( size_t i = 0; i < sourceLen; ++i ) { if( aSource[i] == '$' && i + 1 < sourceLen && aSource[i+1] == '{' ) { wxString token; bool isCrossRef = false; for( i = i + 2; i < sourceLen; ++i ) { if( aSource[i] == '}' ) break; if( aSource[i] == ':' ) isCrossRef = true; token.append( aSource[i] ); } if( isCrossRef ) { SCH_SHEET_LIST sheetList = GetSheets(); wxString remainder; wxString ref = token.BeforeFirst( ':', &remainder ); SCH_SHEET_PATH refSheetPath; SCH_ITEM* refItem = sheetList.GetItem( KIID( ref ), &refSheetPath ); if( refItem && refItem->Type() == SCH_SYMBOL_T ) { SCH_SYMBOL* refSymbol = static_cast( refItem ); token = refSymbol->GetRef( &refSheetPath, true ) + ":" + remainder; } } newbuf.append( "${" + token + "}" ); } else { newbuf.append( aSource[i] ); } } return newbuf; } SCH_SHEET_LIST& SCHEMATIC::GetFullHierarchy() const { static SCH_SHEET_LIST hierarchy; hierarchy.clear(); hierarchy.BuildSheetList( m_rootSheet, false ); return hierarchy; } void SCHEMATIC::SetLegacySymbolInstanceData() { SCH_SCREENS screens( m_rootSheet ); screens.SetLegacySymbolInstanceData(); }