pcb_io_kicad_legacy.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 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_KICAD_LEGACY_H_
#define PCB_IO_KICAD_LEGACY_H_
 
#include <pcb_io/pcb_io.h>
#include <pcb_io/pcb_io_mgr.h>
 
#include <richio.h>
#include <string>
#include <layer_ids.h>
#include <lset.h>
#include <memory>
#include <geometry/eda_angle.h>
 
 
// FOOTPRINT_LIBRARY_HEADER_CNT gives the number of characters to compare to detect
// a footprint library. A few variants may have been used, and so we can only be
// sure that the header contains "PCBNEW-LibModule-V", not "PCBNEW-LibModule-V1".
 
#define FOOTPRINT_LIBRARY_HEADER       "PCBNEW-LibModule-V1"
#define FOOTPRINT_LIBRARY_HEADER_CNT    18
 
class PCB_TARGET;
class FOOTPRINT;
class NETCLASS;
class ZONE;
class PCB_DIMENSION_BASE;
class NETINFO_ITEM;
class PCB_TEXT;
class PAD;
struct LP_CACHE;
 
 
class PCB_IO_KICAD_LEGACY : public PCB_IO
{
    friend struct LP_CACHE;
 
public:
    PCB_IO_KICAD_LEGACY();
    ~PCB_IO_KICAD_LEGACY();
 
    const IO_BASE::IO_FILE_DESC GetBoardFileDesc() const override
    {
        return IO_BASE::IO_FILE_DESC( _HKI( "Eagle ver. 6.x XML PCB files" ), { "brd" } );
    }
 
    const IO_BASE::IO_FILE_DESC GetLibraryDesc() const override
    {
        return IO_BASE::IO_FILE_DESC( _HKI( "Legacy footprint library files" ), { "mod", "emp" } );
    }
 
    bool CanReadBoard( const wxString& aFileName ) const override;
    bool CanReadFootprint( const wxString& aFileName ) const override;
 
    BOARD* LoadBoard( const wxString& aFileName, BOARD* aAppendToMe,
                      const std::map<std::string, UTF8>* aProperties = nullptr, PROJECT* aProject = nullptr ) override;
 
    void FootprintEnumerate( wxArrayString& aFootprintNames, const wxString& aLibraryPath,
                             bool aBestEfforts,
                             const std::map<std::string, UTF8>* aProperties = nullptr ) override;
 
    FOOTPRINT* FootprintLoad( const wxString& aLibraryPath, const wxString& aFootprintName,
                              bool  aKeepUUID = false,
                              const std::map<std::string, UTF8>* aProperties = nullptr ) override;
 
    bool DeleteLibrary( const wxString& aLibraryPath,
                        const std::map<std::string, UTF8>* aProperties = nullptr ) override;
 
    long long GetLibraryTimestamp( const wxString& aLibraryPath ) const override;
 
    bool IsLibraryWritable( const wxString& aLibraryPath ) override;
 
    typedef int BIU;
 
    void SetReader( LINE_READER* aReader )      { m_reader = aReader; }
 
    // return the new .kicad_pcb layer id from the old (legacy) layer id
    static PCB_LAYER_ID leg_layer2new( int cu_count, int aLayerNum );
 
    static LSET leg_mask2new( int cu_count, unsigned aMask );
 
protected:
    void init( const std::map<std::string, UTF8>* aProperties );
 
    void checkpoint();
 
    inline int getNetCode( int aNetCode )
    {
        if( (unsigned int) aNetCode < m_netCodes.size() )
            return m_netCodes[aNetCode];
 
        return aNetCode;
    }
 
    BIU biuParse( const char* aValue, const char** nptrptr = nullptr );
 
    EDA_ANGLE degParse( const char* aValue, const char** nptrptr = nullptr );
 
    static int getVersion( LINE_READER* aReader );
 
    void loadAllSections( bool doAppend );
 
 
    void loadGENERAL();
    void loadSETUP();
    void loadSHEET();
 
    void load3D( FOOTPRINT* aFootprint );
    void loadPAD( FOOTPRINT* aFootprint );
    void loadMODULE_TEXT( PCB_TEXT* aText );
    void loadFP_SHAPE( FOOTPRINT* aFootprint );
 
    void loadPCB_LINE();
    void loadNETINFO_ITEM();
    void loadPCB_TEXT();
    void loadNETCLASS();
    void loadFOOTPRINT( FOOTPRINT* aFootprint );
 
    void loadTrackList( int aStructType );
 
    void loadZONE_CONTAINER();      // "$CZONE_OUTLINE"
    void loadDIMENSION();           // "$COTATION"
    void loadPCB_TARGET();          // "$PCB_TARGET"
 
    void cacheLib( const wxString& aLibraryPath );
 
protected:
    int                m_cu_count;
 
    wxString           m_error;                  
    PROGRESS_REPORTER* m_progressReporter;       
    unsigned           m_lastProgressLine;
    unsigned           m_lineCount;              
 
    LINE_READER*       m_reader;                 
    FILE*              m_fp;                     
 
    wxString           m_field;                  
    int                m_loading_format_version; 
    LP_CACHE*          m_cache;
    bool               m_showLegacySegmentZoneWarning;
 
    std::vector<int>   m_netCodes;               
 
    double  biuToDisk;              
 
    double  diskToBiu;              
};
 
#endif  // PCB_IO_KICAD_LEGACY_H_