summaryrefslogtreecommitdiff
path: root/pcbnew/legacy_plugin.h
diff options
context:
space:
mode:
authorsaurabhb172020-02-26 15:57:49 +0530
committersaurabhb172020-02-26 15:57:49 +0530
commitaa35045840b78d3f48212db45da59a2e5c69b223 (patch)
tree6acee185a4dc19113fcbf0f9a3d6941085dedaf7 /pcbnew/legacy_plugin.h
parent0db48f6533517ecebfd9f0693f89deca28408b76 (diff)
downloadKiCad-eSim-aa35045840b78d3f48212db45da59a2e5c69b223.tar.gz
KiCad-eSim-aa35045840b78d3f48212db45da59a2e5c69b223.tar.bz2
KiCad-eSim-aa35045840b78d3f48212db45da59a2e5c69b223.zip
Added main execs
Diffstat (limited to 'pcbnew/legacy_plugin.h')
-rw-r--r--pcbnew/legacy_plugin.h302
1 files changed, 302 insertions, 0 deletions
diff --git a/pcbnew/legacy_plugin.h b/pcbnew/legacy_plugin.h
new file mode 100644
index 0000000..d99935d
--- /dev/null
+++ b/pcbnew/legacy_plugin.h
@@ -0,0 +1,302 @@
+#ifndef LEGACY_PLUGIN_H_
+#define LEGACY_PLUGIN_H_
+
+/*
+ * This program source code file is part of KiCad, a free EDA CAD application.
+ *
+ * Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
+ * Copyright (C) 2016 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
+ */
+
+#include <io_mgr.h>
+#include <boost/shared_ptr.hpp>
+#include <string>
+#include <layers_id_colors_and_visibility.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 MODULE;
+class DRAWSEGMENT;
+class NETINFO;
+class TEXTE_PCB;
+class TRACK;
+class NETCLASS;
+class NETCLASSES;
+class ZONE_CONTAINER;
+class DIMENSION;
+class NETINFO_ITEM;
+class NETINFO_MAPPING;
+class TEXTE_MODULE;
+class EDGE_MODULE;
+class TRACK;
+class SEGZONE;
+class D_PAD;
+struct LP_CACHE;
+
+
+/**
+ * Class LEGACY_PLUGIN
+ * is a PLUGIN derivation which could possibly be put into a DLL/DSO.
+ * As with any PLUGIN, there is no UI, i.e. windowing calls allowed.
+ */
+class LEGACY_PLUGIN : public PLUGIN
+{
+ friend struct LP_CACHE;
+
+public:
+
+ //-----<PLUGIN IMPLEMENTATION>----------------------------------------------
+
+ const wxString PluginName() const
+ {
+ return wxT( "KiCad-Legacy" );
+ }
+
+ const wxString GetFileExtension() const
+ {
+ return wxT( "brd" );
+ }
+
+ BOARD* Load( const wxString& aFileName, BOARD* aAppendToMe,
+ const PROPERTIES* aProperties = NULL );
+
+ /* we let go of "save" support when the number of CU layers were expanded from 16 to 32.
+ void Save( const wxString& aFileName, BOARD* aBoard, const PROPERTIES* aProperties = NULL );
+
+ void FootprintSave( const wxString& aLibraryPath, const MODULE* aFootprint,
+ const PROPERTIES* aProperties = NULL );
+ void FootprintDelete( const wxString& aLibraryPath, const wxString& aFootprintName, const PROPERTIES* aProperties = NULL );
+
+ void FootprintLibCreate( const wxString& aLibraryPath, const PROPERTIES* aProperties = NULL );
+ */
+
+ wxArrayString FootprintEnumerate( const wxString& aLibraryPath, const PROPERTIES* aProperties = NULL);
+
+ MODULE* FootprintLoad( const wxString& aLibraryPath, const wxString& aFootprintName,
+ const PROPERTIES* aProperties = NULL );
+
+ bool FootprintLibDelete( const wxString& aLibraryPath, const PROPERTIES* aProperties = NULL );
+
+ bool IsFootprintLibWritable( const wxString& aLibraryPath );
+
+ //-----</PLUGIN IMPLEMENTATION>---------------------------------------------
+
+ typedef int BIU;
+
+ LEGACY_PLUGIN();
+ ~LEGACY_PLUGIN();
+
+ void SetReader( LINE_READER* aReader ) { m_reader = aReader; }
+ void SetFilePtr( FILE* aFile ) { m_fp = aFile; }
+
+ void SaveModule3D( const MODULE* aModule ) const;
+
+ // return the new .kicad_pcb layer id from the old (legacy) layer id
+ static LAYER_ID leg_layer2new( int cu_count, LAYER_NUM aLayerNum );
+
+ static LSET leg_mask2new( int cu_count, unsigned aMask );
+
+protected:
+
+ int m_cu_count;
+
+ wxString m_error; ///< for throwing exceptions
+ BOARD* m_board; ///< which BOARD, no ownership here
+ const PROPERTIES* m_props; ///< passed via Save() or Load(), no ownership, may be NULL.
+
+ LINE_READER* m_reader; ///< no ownership here.
+ FILE* m_fp; ///< no ownership here.
+ wxString m_filename; ///< for saves only, name is in m_reader for loads
+
+ wxString m_field; ///< reused to stuff MODULE fields.
+ int m_loading_format_version; ///< which BOARD_FORMAT_VERSION am I Load()ing?
+ LP_CACHE* m_cache;
+
+ NETINFO_MAPPING* m_mapping; ///< mapping for net codes, so only not empty nets
+ ///< are stored with consecutive integers as net codes
+ std::vector<int> m_netCodes; ///< net codes mapping for boards being loaded
+
+ /// initialize PLUGIN like a constructor would, and futz with fresh BOARD if needed.
+ void init( const PROPERTIES* aProperties );
+
+ double biuToDisk; ///< convert from BIUs to disk engineering units
+ ///< with this scale factor
+
+ double diskToBiu; ///< convert from disk engineering units to BIUs
+ ///< with this scale factor
+
+ ///> Converts net code using the mapping table if available,
+ ///> otherwise returns unchanged net code
+ inline int getNetCode( int aNetCode )
+ {
+ if( (unsigned int) aNetCode < m_netCodes.size() )
+ return m_netCodes[aNetCode];
+
+ return aNetCode;
+ }
+
+ /**
+ * Function biuParse
+ * parses an ASCII decimal floating point value and scales it into a BIU
+ * according to the current value of diskToBui. This fuction is the complement of
+ * fmtBIU(). One has to know what the other is doing.
+ *
+ * @param aValue is the ASCII value in C locale form with possible leading whitespace
+ *
+ * @param nptrptr may be NULL, but if not, then it tells where to put a
+ * pointer to the next unconsumed input text. See "man strtod" for more information.
+ *
+ * @return BIU - the converted Board Internal Unit.
+ */
+ BIU biuParse( const char* aValue, const char** nptrptr = NULL );
+
+ /**
+ * Function degParse
+ * parses an ASCII decimal floating point value which is certainly an angle. This
+ * is a dedicated function for encapsulating support for the migration from
+ * tenths of degrees to degrees in floating point. This function is the complement of
+ * fmtDEG(). One has to know what the other is doing.
+ *
+ * @param aValue is the ASCII value in C locale form with possible leading whitespace
+ *
+ * @param nptrptr may be NULL, but if not, then it tells where to put a
+ * pointer to the next unconsumed input text. See "man strtod" for more information.
+ *
+ * @return double - the string converted to a primitive double type
+ */
+ double degParse( const char* aValue, const char** nptrptr = NULL );
+
+ //-----<load/parse functions>-----------------------------------------------
+
+ void checkVersion();
+
+ void loadAllSections( bool doAppend );
+
+
+ void loadGENERAL();
+ void loadSETUP();
+ void loadSHEET();
+
+ void load3D( MODULE* aModule );
+ void loadPAD( MODULE* aModule );
+ void loadMODULE_TEXT( TEXTE_MODULE* aText );
+ void loadMODULE_EDGE( MODULE* aModule );
+
+ void loadPCB_LINE();
+ void loadNETINFO_ITEM();
+ void loadPCB_TEXT();
+ void loadNETCLASS();
+ void loadMODULE( MODULE* aModule );
+
+ /**
+ * Function loadTrackList
+ * reads a list of segments (Tracks and Vias, or Segzones)
+ *
+ * @param aStructType is either PCB_TRACE_T to indicate tracks and vias, or
+ * PCB_ZONE_T to indicate oldschool zone segments (before polygons came to be).
+ */
+ void loadTrackList( int aStructType );
+
+ void loadZONE_CONTAINER(); // "$CZONE_OUTLINE"
+ void loadDIMENSION(); // "$COTATION"
+ void loadPCB_TARGET(); // "$PCB_TARGET"
+
+ //-----</ load/parse functions>---------------------------------------------
+
+
+ //-----<save functions>-----------------------------------------------------
+#if 0
+ /**
+ * Function writeError
+ * returns an error message wxString containing the filename being
+ * currently written.
+ */
+ wxString writeError() const;
+
+ /// encapsulate the BIU formatting tricks in one place.
+ int biuSprintf( char* buf, BIU aValue ) const;
+
+ /**
+ * Function fmtBIU
+ * converts a BIU to engineering units by scaling and formatting to ASCII.
+ * This function is the complement of biuParse(). One has to know what the
+ * other is doing.
+ */
+ std::string fmtBIU( BIU aValue ) const;
+
+ std::string fmtBIUPair( BIU first, BIU second ) const;
+
+ std::string fmtBIUPoint( const wxPoint& aPoint ) const
+ {
+ return fmtBIUPair( aPoint.x, aPoint.y );
+ }
+
+ std::string fmtBIUSize( const wxSize& aSize ) const
+ {
+ return fmtBIUPair( aSize.x, aSize.y );
+ }
+
+ /**
+ * Function fmtDEG
+ * formats an angle in a way particular to a board file format. This function
+ * is the opposite or complement of degParse(). One has to know what the
+ * other is doing.
+ */
+ std::string fmtDEG( double aAngle ) const;
+
+ void saveGENERAL( const BOARD* aBoard ) const;
+ void saveSHEET( const BOARD* aBoard ) const;
+ void saveSETUP( const BOARD* aBoard ) const;
+ void saveBOARD_ITEMS( const BOARD* aBoard ) const;
+
+ void saveMODULE_TEXT( const TEXTE_MODULE* aText ) const;
+ void saveMODULE_EDGE( const EDGE_MODULE* aGraphic ) const;
+ void savePAD( const D_PAD* aPad ) const;
+
+ void saveNETINFO_ITEM( const NETINFO_ITEM* aNet ) const;
+ void saveNETCLASSES( const NETCLASSES* aNetClasses ) const;
+ void saveNETCLASS( const boost::shared_ptr<NETCLASS> aNetclass ) const;
+
+ void savePCB_TEXT( const TEXTE_PCB* aText ) const;
+ void savePCB_TARGET( const PCB_TARGET* aTarget ) const;
+ void savePCB_LINE( const DRAWSEGMENT* aStroke ) const;
+ void saveDIMENSION( const DIMENSION* aDimension ) const;
+ void saveTRACK( const TRACK* aTrack ) const;
+ void saveBOARD( const BOARD* aBoard ) const;
+
+ /**
+ * Function saveZONE_CONTAINER
+ * saves the new polygon zones.
+ */
+ void saveZONE_CONTAINER( const ZONE_CONTAINER* aZone ) const;
+
+ //-----</save functions>----------------------------------------------------
+#endif
+
+ /// we only cache one footprint library for now, this determines which one.
+ void cacheLib( const wxString& aLibraryPath );
+};
+
+#endif // LEGACY_PLUGIN_H_