pcb_io.h

Go to the documentation of this file.

/*
 * This program source code file is part of KICAD, a free EDA CAD application.
 *
 * Copyright (C) 2011-2012 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
 * Copyright (C) 2016-2023 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
 */
 
#ifndef PCB_IO_H_
#define PCB_IO_H_
 
#include <io/io_base.h>
#include <pcb_io/pcb_io_mgr.h>
 
#include <cstdint>
#include <config.h>
#include <vector>
#include <wx/arrstr.h>
#include <i18n_utility.h>
 
class BOARD;
class FOOTPRINT;
class PROJECT;
class PROGRESS_REPORTER;
 
class PCB_IO : public IO_BASE
{
public:
    virtual const IO_BASE::IO_FILE_DESC GetBoardFileDesc() const
    {
        return IO_BASE::IO_FILE_DESC( wxEmptyString, {} );
    }
 
 
    virtual bool CanReadBoard( const wxString& aFileName ) const;
 
    virtual bool CanReadFootprint( const wxString& aFileName ) const;
 
    virtual void SetQueryUserCallback( std::function<bool( wxString aTitle, int aIcon,
                                                           wxString aMessage,
                                                           wxString aAction )> aCallback )
    { }
 
    virtual BOARD* LoadBoard( const wxString& aFileName, BOARD* aAppendToMe,
                         const std::map<std::string, UTF8>* aProperties = nullptr, PROJECT* aProject = nullptr );
 
    virtual std::vector<FOOTPRINT*> GetImportedCachedLibraryFootprints();
 
    virtual void SaveBoard( const wxString& aFileName, BOARD* aBoard,
                            const std::map<std::string, UTF8>* aProperties = nullptr );
 
    virtual void FootprintEnumerate( wxArrayString& aFootprintNames, const wxString& aLibraryPath,
                                     bool aBestEfforts, const std::map<std::string, UTF8>* aProperties = nullptr );
 
    virtual long long GetLibraryTimestamp( const wxString& aLibraryPath ) const = 0;
 
    virtual void PrefetchLib( const wxString& aLibraryPath,
                              const std::map<std::string, UTF8>* aProperties = nullptr );
 
    virtual FOOTPRINT* ImportFootprint( const wxString& aFootprintPath, wxString& aFootprintNameOut,
                                        const std::map<std::string, UTF8>* aProperties = nullptr );
 
    virtual FOOTPRINT* FootprintLoad( const wxString& aLibraryPath,
                                      const wxString& aFootprintName,
                                      bool  aKeepUUID = false,
                                      const std::map<std::string, UTF8>* aProperties = nullptr );
 
    virtual const FOOTPRINT* GetEnumeratedFootprint( const wxString& aLibraryPath,
                                                     const wxString& aFootprintName,
                                                     const std::map<std::string, UTF8>* aProperties = nullptr );
 
    virtual bool FootprintExists( const wxString& aLibraryPath, const wxString& aFootprintName,
                                  const std::map<std::string, UTF8>* aProperties = nullptr );
 
    virtual void FootprintSave( const wxString& aLibraryPath, const FOOTPRINT* aFootprint,
                                const std::map<std::string, UTF8>* aProperties = nullptr );
 
    virtual void FootprintDelete( const wxString& aLibraryPath, const wxString& aFootprintName,
                                  const std::map<std::string, UTF8>* aProperties = nullptr );
 
    virtual void GetLibraryOptions( std::map<std::string, UTF8>* aListToAppendTo ) const override;
 
    virtual ~PCB_IO()
    {};
 
protected:
    PCB_IO( const wxString& aName ) : IO_BASE( aName ),
        m_board( nullptr ),
        m_props( nullptr )
    {}
 
    BOARD* m_board;
 
    const std::map<std::string, UTF8>* m_props;
};
 
#endif // PCB_IO_H_