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-2017 Wayne Stambaugh <stambaughw@verizon.net>
 * Copyright (C) 2004-2017 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 component archive files.
 */

#include <fctsys.h>
#include <confirm.h>
#include <class_sch_screen.h>
#include <wxstruct.h>
#include <schframe.h>

#include <class_library.h>
#include <sch_component.h>
#include <sch_sheet.h>
#include <wildcards_and_files_ext.h>


bool SCH_EDIT_FRAME::CreateArchiveLibraryCacheFile( bool aUseCurrentSheetFilename )
{
    wxFileName fn;

    if( aUseCurrentSheetFilename )
        fn = GetScreen()->GetFileName();
    else
        fn = g_RootSheet->GetScreen()->GetFileName();

    fn.SetName( fn.GetName() + "-cache" );
    fn.SetExt( SchematicLibraryFileExtension );

    return CreateArchiveLibrary( fn.GetFullPath() );
}


bool SCH_EDIT_FRAME::CreateArchiveLibrary( const wxString& aFileName )
{
    wxString        msg;
    SCH_SCREENS     screens;
    PART_LIBS*      libs = Prj().SchLibs();
    PART_LIB*       cacheLib = libs->FindLibraryByFullFileName( aFileName );

    if( !cacheLib )
    {
        cacheLib = new PART_LIB( LIBRARY_TYPE_EESCHEMA, aFileName );
        libs->push_back( cacheLib );
    }

    cacheLib->SetCache();
    cacheLib->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.
     */
    for( SCH_SCREEN* screen = screens.GetFirst(); screen; screen = screens.GetNext() )
    {
        for( SCH_ITEM* item = screen->GetDrawItems(); item; item = item->Next() )
        {
            if( item->Type() != SCH_COMPONENT_T )
                continue;

            SCH_COMPONENT* component = (SCH_COMPONENT*) item;

            if( !cacheLib->FindAlias( component->GetLibId().GetLibItemName() ) )
            {
                LIB_PART* part = NULL;

                try
                {
                    part = libs->FindLibPart( component->GetLibId() );

                    if( part )
                    {
                        // AddPart() does first clone the part before adding.
                        cacheLib->AddPart( part );
                    }
                }
                catch( ... /* IO_ERROR ioe */ )
                {
                    msg.Printf( _( "Failed to add symbol %s to library file '%s'" ),
                                wxString( component->GetLibId().GetLibItemName() ), aFileName );
                    DisplayError( this, msg );
                    return false;
                }
            }
        }
    }

    try
    {
        cacheLib->Save( false );
        cacheLib->EnableBuffering( false );
    }
    catch( ... /* IO_ERROR ioe */ )
    {
        msg.Printf( _( "Failed to save symbol library file '%s'" ), aFileName );
        DisplayError( this, msg );
        return false;
    }

    return true;
}