project_pcb.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The 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, see <https://www.gnu.org/licenses/>.
 */
 
#include "project_pcb.h"
#include <project.h>
#include <confirm.h>
#include <pgm_base.h>
#include <3d_cache/3d_cache.h>
#include <paths.h>
#include <settings/common_settings.h>
#include <footprint_library_adapter.h>
 
#include <mutex>
 
static std::mutex mutex3D_cacheManager;
std::mutex PROJECT_PCB::s_libAdapterMutex;
 
 
FOOTPRINT_LIBRARY_ADAPTER* PROJECT_PCB::FootprintLibAdapter( PROJECT* aProject )
{
    std::scoped_lock lock( s_libAdapterMutex );
 
    LIBRARY_MANAGER& mgr = Pgm().GetLibraryManager();
    std::optional<LIBRARY_MANAGER_ADAPTER*> adapter = mgr.Adapter( LIBRARY_TABLE_TYPE::FOOTPRINT );
 
    if( !adapter )
    {
        mgr.RegisterAdapter( LIBRARY_TABLE_TYPE::FOOTPRINT,
                             std::make_unique<FOOTPRINT_LIBRARY_ADAPTER>( mgr ) );
 
        std::optional<LIBRARY_MANAGER_ADAPTER*> created = mgr.Adapter( LIBRARY_TABLE_TYPE::FOOTPRINT );
        wxCHECK( created && ( *created )->Type() == LIBRARY_TABLE_TYPE::FOOTPRINT, nullptr );
        return static_cast<FOOTPRINT_LIBRARY_ADAPTER*>( *created );
    }
 
    wxCHECK( ( *adapter )->Type() == LIBRARY_TABLE_TYPE::FOOTPRINT, nullptr );
    return static_cast<FOOTPRINT_LIBRARY_ADAPTER*>( *adapter );
}
 
 
S3D_CACHE* PROJECT_PCB::Get3DCacheManager( PROJECT* aProject, bool aUpdateProjDir )
{
    std::lock_guard<std::mutex> lock( mutex3D_cacheManager );
 
    // Get the existing cache from the project
    S3D_CACHE* cache = static_cast<S3D_CACHE*>( aProject->GetElem( PROJECT::ELEM::S3DCACHE ) );
 
    if( !cache )
    {
        // Create a cache if there is not one already
        cache = new S3D_CACHE();
 
        wxFileName cfgpath;
        cfgpath.AssignDir( PATHS::GetUserSettingsPath() );
        cfgpath.AppendDir( wxT( "3d" ) );
 
        cache->SetProgramBase( &Pgm() );
        cache->Set3DConfigDir( cfgpath.GetFullPath() );
 
        aProject->SetElem( PROJECT::ELEM::S3DCACHE, cache );
        aUpdateProjDir = true;
    }
 
    if( aUpdateProjDir )
        cache->SetProject( aProject );
 
    return cache;
}
 
 
FILENAME_RESOLVER* PROJECT_PCB::Get3DFilenameResolver( PROJECT* aProject )
{
    return Get3DCacheManager( aProject )->GetResolver();
}
 
 
void PROJECT_PCB::Cleanup3DCache( PROJECT* aProject )
{
    std::lock_guard<std::mutex> lock( mutex3D_cacheManager );
 
    // Get the existing cache from the project
    S3D_CACHE* cache = static_cast<S3D_CACHE*>( aProject->GetElem( PROJECT::ELEM::S3DCACHE ) );
 
    if( cache )
    {
        // We'll delete ".3dc" cache files older than this many days
        int clearCacheInterval = 0;
 
        if( Pgm().GetCommonSettings() )
            clearCacheInterval = Pgm().GetCommonSettings()->m_System.clear_3d_cache_interval;
 
        // An interval of zero means the user doesn't want to ever clear the cache
 
        if( clearCacheInterval > 0 )
            cache->CleanCacheDir( clearCacheInterval );
    }
}