kicad/eeschema/libarch.cpp

/*
 * 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>

#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();

    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;
}


bool SCH_EDIT_FRAME::CreateArchiveLibrary( const wxString& aFileName )
{
    wxString          tmp;
    wxString          errorMsg;
    SCH_SCREENS       screens( Schematic().Root() );

    // Create a new empty library to archive symbols:
    std::unique_ptr<SYMBOL_LIB> archLib = std::make_unique<SYMBOL_LIB>( SCH_LIB_TYPE::LT_EESCHEMA,
                                                                    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
     * 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() )
    {

        for( SCH_ITEM* aItem : screen->Items().OfType( SCH_SYMBOL_T ) )
        {
            LIB_SYMBOL* libSymbol = nullptr;
            SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( aItem );

            try
            {
                if( archLib->FindSymbol( symbol->GetLibId() ) )
                    continue;

                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." );
            }

            if( libSymbol )
            {
                std::unique_ptr<LIB_SYMBOL> flattenedSymbol = libSymbol->Flatten();

                // Use the full LIB_ID as the symbol name to prevent symbol name collisions.
                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." ),
                            symbol->GetLibId().GetUniStringLibId() );
            }

            if( !tmp.empty() && !errorMsg.Contains( symbol->GetLibId().GetUniStringLibId() ) )
            {
                if( errorMsg.empty() )
                    errorMsg += tmp;
                else
                    errorMsg += wxS( "\n" ) + tmp;
            }
        }
    }

    if( !errorMsg.empty() )
    {
        tmp.Printf( _( "Errors occurred creating symbol library %s." ), aFileName );
        DisplayErrorMessage( this, tmp, errorMsg );
    }

    archLib->EnableBuffering( false );

    try
    {
        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;
}