footprint_import_reconciler.h

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/>.
 */
 
#ifndef FOOTPRINT_IMPORT_RECONCILER_H
#define FOOTPRINT_IMPORT_RECONCILER_H
 
#include <map>
#include <memory>
#include <vector>
#include <wx/string.h>
 
class BOARD;
class FOOTPRINT;
class FOOTPRINT_LIBRARY_ADAPTER;
class REPORTER;

struct FOOTPRINT_IMPORT_RECONCILE_RESULT
{
    int      m_linkedToSource = 0;   
    int      m_linkedToCache  = 0;   
    int      m_unresolved     = 0;   
    int      m_savedToCache   = 0;   
    wxString m_cacheNickname;        
    wxString m_cacheLibraryPath;     
 
    bool Ok() const { return m_unresolved == 0; }
};

class FOOTPRINT_IMPORT_RECONCILER
{
public:
    FOOTPRINT_IMPORT_RECONCILER( FOOTPRINT_LIBRARY_ADAPTER& aAdapter, const wxString& aProjectPath,
                                 REPORTER* aReporter = nullptr );

    FOOTPRINT_IMPORT_RECONCILE_RESULT
    Reconcile( BOARD* aBoard, std::vector<std::unique_ptr<FOOTPRINT>> aDefinitions,
               const wxString& aCacheNickname, const std::vector<wxString>& aSourceLibNicknames );

    static const wxString& ManagedCacheOption();
 
private:
    void writeAndRegisterCache( const wxString&                       aCacheNickname,
                                const std::map<wxString, FOOTPRINT*>& aCacheDefs,
                                FOOTPRINT_IMPORT_RECONCILE_RESULT&    aResult );

    bool registerCacheRow( const wxString& aCacheNickname );
 
    FOOTPRINT_LIBRARY_ADAPTER& m_adapter;
    wxString                   m_projectPath;
    REPORTER*                  m_reporter;
};
 
#endif // FOOTPRINT_IMPORT_RECONCILER_H