kicad/eeschema/libarch.cpp

166 lines
5.5 KiB
C++
Raw Normal View History

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2004 Jean-Pierre Charras, jp.charras ar wanadoo.fr
* Copyright (C) 2008 Wayne Stambaugh <stambaughw@gmail.com>
* Copyright (C) 2004-2021 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, 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 libarch.cpp
* @brief Module for generation of symbol archive files.
*/
#include <confirm.h>
#include <wildcards_and_files_ext.h>
2018-01-30 10:49:51 +00:00
#include <sch_edit_frame.h>
#include <symbol_lib_table.h>
#include <symbol_library.h>
#include <sch_symbol.h>
#include <sch_sheet.h>
#include <schematic.h>
bool SCH_EDIT_FRAME::CreateArchiveLibraryCacheFile( bool aUseCurrentSheetFilename )
{
wxFileName fn;
if( aUseCurrentSheetFilename )
fn = GetScreen()->GetFileName();
else
fn = Schematic().RootScreen()->GetFileName();
2023-01-17 04:14:38 +00:00
fn.SetName( fn.GetName() + wxS( "-cache" ) );
fn.SetExt( LegacySymbolLibFileExtension );
bool success = CreateArchiveLibrary( fn.GetFullPath() );
// Update the schematic symbol library links.
// because the lib cache has changed
SCH_SCREENS schematic( Schematic().Root() );
schematic.UpdateSymbolLinks();
return success;
}
2007-05-06 16:03:28 +00:00
bool SCH_EDIT_FRAME::CreateArchiveLibrary( const wxString& aFileName )
2007-05-06 16:03:28 +00:00
{
wxString tmp;
wxString errorMsg;
SCH_SCREENS screens( Schematic().Root() );
2021-05-05 21:41:51 +00:00
// Create a new empty library to archive symbols:
std::unique_ptr<SYMBOL_LIB> archLib = std::make_unique<SYMBOL_LIB>( SCH_LIB_TYPE::LT_EESCHEMA,
2021-05-05 21:41:51 +00:00
aFileName );
// Save symbols to file only when the library will be fully filled
archLib->EnableBuffering();
/* Examine all screens (not hierarchical sheets) used in the schematic and build a
* library of unique symbols found in all screens. Complex hierarchies are not a
2017-07-09 08:16:00 +00:00
* problem because we just want to know the library symbols used in the schematic
* not their reference.
*/
for( SCH_SCREEN* screen = screens.GetFirst(); screen; screen = screens.GetNext() )
{
2021-06-17 21:22:10 +00:00
for( SCH_ITEM* aItem : screen->Items().OfType( SCH_SYMBOL_T ) )
{
2021-06-10 18:51:46 +00:00
LIB_SYMBOL* libSymbol = nullptr;
2021-06-10 14:10:55 +00:00
SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( aItem );
try
{
if( archLib->FindSymbol( symbol->GetLibId() ) )
continue;
2021-06-17 21:22:10 +00:00
libSymbol = GetLibSymbol( symbol->GetLibId(), true );
}
catch( const IO_ERROR& )
{
// Queue up error messages for later.
tmp.Printf( _( "Failed to add symbol %s to library file '%s'." ),
symbol->GetLibId().GetUniStringLibItemName(),
aFileName );
// Don't bail out here. Attempt to add as many of the symbols to the library
// as possible.
}
catch( ... )
{
tmp = _( "Unexpected exception occurred." );
}
2021-06-10 18:51:46 +00:00
if( libSymbol )
{
2021-06-10 18:51:46 +00:00
std::unique_ptr<LIB_SYMBOL> flattenedSymbol = libSymbol->Flatten();
// Use the full LIB_ID as the symbol name to prevent symbol name collisions.
2021-06-10 18:51:46 +00:00
flattenedSymbol->SetName( symbol->GetLibId().GetUniStringLibId() );
// AddSymbol() does first clone the symbol before adding.
archLib->AddSymbol( flattenedSymbol.get() );
}
else
{
tmp.Printf( _( "Symbol %s not found in any library or cache." ),
2021-05-05 21:41:51 +00:00
symbol->GetLibId().GetUniStringLibId() );
}
2021-05-05 21:41:51 +00:00
if( !tmp.empty() && !errorMsg.Contains( symbol->GetLibId().GetUniStringLibId() ) )
{
if( errorMsg.empty() )
errorMsg += tmp;
else
2023-01-17 04:14:38 +00:00
errorMsg += wxS( "\n" ) + tmp;
}
2008-09-18 17:10:54 +00:00
}
}
if( !errorMsg.empty() )
{
tmp.Printf( _( "Errors occurred creating symbol library %s." ), aFileName );
DisplayErrorMessage( this, tmp, errorMsg );
}
archLib->EnableBuffering( false );
try
{
2017-07-09 08:16:00 +00:00
archLib->Save( false );
}
catch( const IO_ERROR& ioe )
{
errorMsg.Printf( _( "Failed to save symbol library file '%s'." ), aFileName );
DisplayErrorMessage( this, errorMsg, ioe.What() );
return false;
}
catch( std::exception& error )
{
errorMsg.Printf( _( "Failed to save symbol library file '%s'." ), aFileName );
DisplayErrorMessage( this, errorMsg, error.what() );
return false;
}
return true;
}