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 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/>.
 */
 
#pragma once
 
#include <io/common/plugin_common_choose_project.h>
#include <io/io_base.h>
#include <pcb_io/pcb_io_mgr.h>
 
#include <memory>
#include <utility>
#include <vector>
 
#include <config.h>
#include <wx/arrstr.h>
#include <i18n_utility.h>
 
class BOARD;
class FOOTPRINT;
class PROJECT;
class PROGRESS_REPORTER;
 
// MIKE WILLIAMS TODO: convert all of the other stringly-typed IO plugin properties to use constants
namespace PCB_IO_LOAD_PROPERTIES
{
// Used to control whether the stackup of the board passed into the IO plugin is preserved or not.
// It will NOT keep the stackup from being changed in all cases, as a copper layer increase may require
// the stackup to grow
inline constexpr char APPEND_PRESERVE_DESTINATION_STACKUP[] = "append_preserve_destination_stackup";
}

class PCB_IO : public IO_BASE
{
public:
    virtual const IO_BASE::IO_FILE_DESC GetBoardFileDesc() const
    {
        return IO_BASE::IO_FILE_DESC( wxEmptyString, {} );
    }

    bool IsPCB_IO() const override { return true; }


    virtual std::vector<std::pair<wxString, wxString>>
    EnumerateProjectBoards( const wxString& aFileName ) const
    {
        return {};
    }

    virtual std::vector<IMPORT_PROJECT_DESC> EnumerateProjectEntries( const wxString& aFileName ) const
    {
        return {};
    }
 
    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 )
    { }

    std::unique_ptr<BOARD> LoadBoard( const wxString&                    aFileName,
                                      const std::map<std::string, UTF8>* aProperties = nullptr,
                                      PROJECT*                           aProject = nullptr );
 

    void LoadAndAppendBoard( const wxString& aFileName, BOARD& aAppendToMe,
                             const std::map<std::string, UTF8>* aProperties = nullptr, PROJECT* aProject = nullptr );

    virtual std::vector<FOOTPRINT*> GetImportedCachedLibraryFootprints();
    virtual wxString GetImportedDesignRules() const { return wxEmptyString; }
 

    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 std::unique_ptr<FOOTPRINT> ImportFootprint( const wxString& aFootprintPath, wxString& aFootprintNameOut,
                                                        const std::map<std::string, UTF8>* aProperties = nullptr );

    virtual std::unique_ptr<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 CachesEnumeratedFootprints() const { return false; }

    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 ClearCachedFootprints( const wxString& aLibraryPath ) {}

    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 )
    {}

    virtual void loadBoard( const wxString& aFileName, BOARD& aBoard, bool aIsNewLoad,
                            const std::map<std::string, UTF8>* aProperties, PROJECT* aProject );

    BOARD* m_board;

    const std::map<std::string, UTF8>* m_props;
};