pcb_io_ipc2581.h

Go to the documentation of this file.

 
#ifndef PCB_IO_IPC2581_H_
#define PCB_IO_IPC2581_H_
 
#include <pcb_io/pcb_io.h>
#include "ipc2581_function_mode.h"
#include <pcb_io/pcb_io_mgr.h>
#include <pcb_io/common/plugin_common_layer_mapping.h>
 
#include "ipc2581_types.h"
 
#include <eda_shape.h>
#include <layer_ids.h> // PCB_LAYER_ID
#include <drill/drill_span.h>
#include <font/font.h>
#include <geometry/shape_segment.h>
#include <stroke_params.h>
 
#include <wx/xml/xml.h>
#include <array>
#include <memory>
#include <map>
#include <set>
#include <tuple>
 
class BOARD;
class BOARD_ITEM;
class BOARD_STACKUP_ITEM;
class FAB_STACKUP;
class FAB_DRILL_MODEL;
struct DRILL_OPERATION;
class EDA_TEXT;
class FOOTPRINT;
class PROGRESS_REPORTER;
class NETINFO_ITEM;
class PAD;
class PADSTACK;
class PCB_SHAPE;
class PCB_VIA;
class PCB_TEXT;
class PROGRESS_REPORTER;
class SHAPE_POLY_SET;
class SHAPE_SEGMENT;
 
class PCB_IO_IPC2581 : public PCB_IO
{
public:
    PCB_IO_IPC2581() : PCB_IO( wxS( "IPC-2581" ) )
    {
        m_total_bytes = 0;
        m_scale = 1.0;
        m_sigfig = 3;
        m_revision = IPC2581::REVISION::B;
        m_mode = IPC2581::MODE::USERDEF;
        m_functionModeNode = nullptr;
        m_anonymizeNets = false;
        m_omitRefDes = false;
        m_step_node = nullptr;
        m_progress_tick = 0;
        m_haveCadData = true;
        m_enterpriseNode = nullptr;
        m_board = nullptr;
        m_props = nullptr;
        m_shape_user_node = nullptr;
        m_shape_std_node = nullptr;
        m_line_node = nullptr;
        m_last_padstack = nullptr;
        m_backdrill_spec_index = 0;
        m_cad_header_node = nullptr;
        m_progress_reporter = nullptr;
        m_xml_doc = nullptr;
        m_xml_root = nullptr;
        m_contentNode = nullptr;
        m_lastAppendedNode = nullptr;
    }
 
    ~PCB_IO_IPC2581() override;

    static constexpr int EXPORT_PHASES = 12;
 
    void SaveBoard( const wxString& aFileName, BOARD& aBoard,
                    const std::map<std::string, UTF8>* aProperties = nullptr ) override;
 
    const IO_BASE::IO_FILE_DESC GetBoardFileDesc() const override
    {
        return IO_BASE::IO_FILE_DESC( wxEmptyString, {}, {}, false, false, true );
    }
 
    const IO_BASE::IO_FILE_DESC GetLibraryDesc() const override
    {
        // No library description for this plugin
        return IO_BASE::IO_FILE_DESC( wxEmptyString, {} );
    }
 
    std::vector<FOOTPRINT*> GetImportedCachedLibraryFootprints() override;
 
    long long GetLibraryTimestamp( const wxString& aLibraryPath ) const override
    {
        return 0;
    }
 
    // Reading currently disabled
    bool CanReadBoard( const wxString& aFileName ) const override
    {
        return false;
    }
 
    // Reading currently disabled
    bool CanReadFootprint( const wxString& aFileName ) const override
    {
        return false;
    }
 
    // Reading currently disabled
    bool CanReadLibrary( const wxString& aFileName ) const override
    {
        return false;
    }
 
 
private:

    void clearLoadedFootprints();

    wxXmlNode* generateXmlHeader();

    wxXmlNode* generateContentSection();

    wxXmlNode* generateLogisticSection();

    wxXmlNode* generateHistorySection();

    wxXmlNode* generateBOMSection( wxXmlNode* aEcadNode );

    wxXmlNode* generateEcadSection();

    wxXmlNode* generateAvlSection();
 
    void generateCadLayers( wxXmlNode* aCadLayerNode );
 
    void generateCadSpecs( wxXmlNode* aCadLayerNode );
 
    void generateStackup( wxXmlNode* aCadLayerNode );
 
    void generateDrillLayers( wxXmlNode* aCadLayerNode );
 
    void generateAuxilliaryLayers( wxXmlNode* aCadLayerNode );
 
    void generateStepSection( wxXmlNode* aCadNode );
 
    void generateProfile( wxXmlNode* aStepNode );
 
    void generateLogicalNets( wxXmlNode* aStepNode );
 
    void generatePhyNetGroup( wxXmlNode* aStepNode );
 
    void generateLayerFeatures( wxXmlNode* aStepNode );
 
    void generateLayerSetDrill( wxXmlNode* aStepNode );
 
    void generateLayerSetNet( wxXmlNode* aLayerNode, PCB_LAYER_ID aLayer, const std::vector<BOARD_ITEM*>& aItems );
 
    void generateLayerSetAuxilliary( wxXmlNode* aStepNode );
 
    wxXmlNode* generateContentStackup( wxXmlNode* aContentNode );
 
    void generateContentLayerRefs( wxXmlNode* aCadDataNode );

    void dropContentStepRefs();

    IPC2581::SECTION_SET emittedSections() const;
 
    bool included( IPC2581::SECTION aSection ) const
    {
        return m_resolved.m_included.Contains( aSection );
    }
 
    bool suppressed( IPC2581::SUPPRESS aWhat ) const
    {
        return m_resolved.m_suppressions.Contains( aWhat );
    }

    void reportPhase( const wxString& aMessage );

    void tickProgress( const wxString& aMessage = wxEmptyString );

    bool layerIncluded( PCB_LAYER_ID aLayer ) const;

    bool stackupRowIncluded( bool aDielectric, PCB_LAYER_ID aLayer ) const;

    wxString netName( const wxString& aNetname, const wxString& aSuffix = wxEmptyString );

    bool omitRefDes() const
    {
        return m_omitRefDes || suppressed( IPC2581::SUPPRESS::COMPONENT_REFDES );
    }

    bool refDesEmitted() const
    {
        return m_revision == IPC2581::REVISION::B || !omitRefDes();
    }

    bool componentRefEmitted() const
    {
        return included( IPC2581::SECTION::COMPONENTS ) && !omitRefDes();
    }
 
    void generateComponents( wxXmlNode* aStepNode );
 
    void addCadHeader( wxXmlNode* aEcadNode );
 
    wxXmlNode* addPackage( wxXmlNode* aStepNode, FOOTPRINT* aFootprint );
 
    void addPad( wxXmlNode* aContentNode, const PAD* aPad, PCB_LAYER_ID aLayer );
 
    void addVia( wxXmlNode* aContentNode, const PCB_VIA* aVia, PCB_LAYER_ID aLayer );
 
    void addPadStack( wxXmlNode* aContentNode, const PAD* aPad );
 
    void addPadStack( wxXmlNode* aContentNode, const PCB_VIA* aVia );
 
    void ensureBackdrillSpecs( const wxString& aPadstackName, const PADSTACK& aPadstack );
 
    void addBackdrillSpecRefs( wxXmlNode* aHoleNode, const wxString& aPadstackName );
 
    void addPostMachiningSpecRefs( wxXmlNode* aHoleNode, const DRILL_OPERATION& aOperation );
 
    void pruneUnusedBackdrillSpecs();
 
    void addLocationNode( wxXmlNode* aContentNode, double aX, double aY );
 
    void addLocationNode( wxXmlNode* aContentNode, const PAD& aPad, bool aRelative,
                          PCB_LAYER_ID aLayer );
 
    void addLocationNode( wxXmlNode* aContentNode, const PCB_SHAPE& aShape );
 
    void addShape( wxXmlNode* aContentNode, const PCB_SHAPE& aShape, bool aInline = false );
 
    void addShape( wxXmlNode* aContentNode, const PAD& aPad, PCB_LAYER_ID aLayer );
 
    void addSlotCavity( wxXmlNode* aContentNode, const PAD& aPad, const wxString& aName );
 
    void addKnockoutText( wxXmlNode* aContentNode, PCB_TEXT* aText );
 
    void addText( wxXmlNode* aContentNode, EDA_TEXT* aShape, const KIFONT::METRICS& aFontMetrics );
 
    void addLineDesc( wxXmlNode* aNode, int aWidth, LINE_STYLE aDashType, bool aForce = false );
 
    void addFillDesc( wxXmlNode* aNode, FILL_T aFillType, bool aForce = false );
 
    bool addPolygonNode( wxXmlNode* aParentNode, const SHAPE_LINE_CHAIN& aPolygon,
                         FILL_T aFillType = FILL_T::FILLED_SHAPE, int aWidth = 0,
                         LINE_STYLE aDashType = LINE_STYLE::SOLID );
 
    bool addPolygonCutouts( wxXmlNode* aParentNode, const SHAPE_POLY_SET::POLYGON& aPolygon );
 
    bool addOutlineNode( wxXmlNode* aParentNode, const SHAPE_POLY_SET& aPolySet, int aWidth = 0,
                         LINE_STYLE aDashType = LINE_STYLE::SOLID );
 
    bool addContourNode( wxXmlNode* aParentNode, const SHAPE_POLY_SET& aPolySet, int aOutline = 0,
                         FILL_T aFillType = FILL_T::FILLED_SHAPE, int aWidth = 0,
                         LINE_STYLE aDashType = LINE_STYLE::SOLID );
 
    size_t lineHash( int aWidth, LINE_STYLE aDashType );
 
    size_t shapeHash( const PCB_SHAPE& aShape );
 
    wxString sanitizeId( const wxString& aStr ) const;
    wxString genString( const wxString& aStr, const char* aPrefix = nullptr ) const;
    wxString genLayerString( PCB_LAYER_ID aLayer, const char* aPrefix ) const;
    wxString genLayersString( PCB_LAYER_ID aTop, PCB_LAYER_ID aBottom, const char* aPrefix ) const;
 
    wxString stackupLayerName( const BOARD_STACKUP_ITEM* aItem, int aSublayerId, const char* aPrefix ) const;
 
    wxString floatVal( double aVal, int aSigFig = -1 ) const;
 
    wxString pinName( const PAD* aPad ) const;
 
    wxString componentName( FOOTPRINT* aFootprint );
 
    void addXY( wxXmlNode* aNode, const VECTOR2I& aVec, const char* aXName = nullptr,
                const char* aYName = nullptr );
 
    void addAttribute( wxXmlNode* aNode, const wxString& aName, const wxString& aValue );
 
    wxXmlNode* insertNode( wxXmlNode* aParent, const wxString& aName );
 
    wxXmlNode* appendNode( wxXmlNode* aParent, const wxString& aName );
 
    void appendNode( wxXmlNode* aParent, wxXmlNode* aNode );
 
    void insertNode( wxXmlNode* aParent, wxXmlNode* aNode );
 
    void insertNodeAfter( wxXmlNode* aPrev, wxXmlNode* aNode );
 
    void deleteNode( wxXmlNode*& aNode );
 
    void addLayerAttributes( wxXmlNode* aNode, PCB_LAYER_ID aLayer );
 
private:
 
    size_t                  m_total_bytes;  //<! Total number of bytes to be written
 
    wxString                m_units_str;    //<! Output string for units
    double                  m_scale;        //<! Scale factor from IU to IPC2581 units (mm, micron, in)
    int                     m_sigfig;       //<! Max number of digits past the decimal point
    IPC2581::REVISION       m_revision;
    IPC2581::MODE           m_mode;
    IPC2581::SECTION_SET    m_requestedSections;
    IPC2581::RESOLVE_RESULT m_resolved;
    wxXmlNode*              m_functionModeNode;
    bool                    m_anonymizeNets;
    bool                    m_omitRefDes;
    std::map<wxString, wxString> m_net_name_dict;
    std::map<FOOTPRINT*, wxString> m_anon_refdes_dict;
    wxXmlNode*              m_step_node;
    size_t                  m_progress_tick;
    bool                    m_haveCadData;
    wxString                m_OEMRef;       //<! If set, field name containing the internal ID of parts
    wxString                m_mpn;          //<! If set, field name containing the manufacturer part number
    wxString                m_mfg;          //<! If set, field name containing the part manufacturer
    wxString                m_distpn;       //<! If set, field name containing the distributor part number
    wxString                m_dist;         //<! If set, field name containing the distributor name
    wxString                m_bomRev;       //<! BOM revision string for the BomHeader element
    wxString                m_variantName;  //<! BOM population variant or board current
 
    // Node pointer to the main enterprise node to be used for adding
    // enterprises later when forming the AVL
    wxXmlNode*              m_enterpriseNode;
 
    BOARD*                  m_board;
    const FAB_STACKUP*                  m_fabStackup = nullptr;
    std::vector<FOOTPRINT*> m_loaded_footprints;
    const std::map<std::string, UTF8>*  m_props;
 
    std::map<size_t, wxString> m_user_shape_dict;   //<! Map between shape hash values and reference id string
    wxXmlNode*                 m_shape_user_node;   //<! Output XML node for reference shapes in UserDict
 
    std::map<size_t, wxString> m_std_shape_dict;    //<! Map between shape hash values and reference id string
    wxXmlNode*                 m_shape_std_node;    //<! Output XML node for reference shapes in StandardDict
 
    std::map<size_t, wxString> m_line_dict;         //<! Map between line hash values and reference id string
    wxXmlNode*                 m_line_node;         //<! Output XML node for reference lines in LineDict
 
    std::map<size_t, wxString> m_padstack_dict;     //<! Map between padstack hash values and reference id string (PADSTACK_##)
    std::vector<wxXmlNode*>    m_padstacks;         //<! Holding vector for padstacks.  These need to be inserted prior to the components
    wxXmlNode*                 m_last_padstack;     //<! Pointer to padstack list where we can insert the VIA padstacks once we process tracks
 
    std::map<wxString, std::array<wxString, 2>>       m_padstack_backdrill_specs;
    std::map<wxString, wxXmlNode*>                    m_backdrill_spec_nodes;
    std::set<wxString>                                m_backdrill_spec_used;
    int                                               m_backdrill_spec_index;
    std::map<std::tuple<bool, int, int, int, int>, wxString> m_post_machining_specs;
    wxXmlNode*                                        m_cad_header_node;
 
    std::map<size_t, wxString>
            m_footprint_dict; //<! Map between the footprint hash values and reference id string (<fpid>_##)
 
    std::map<wxString, FOOTPRINT*>
            m_footprint_refdes_dict; //<! Map between sanitized refdes and footprint pointer
 
    std::map<FOOTPRINT*, wxString>
            m_footprint_refdes_reverse_dict; //<! Reverse lookup for
 
    std::map<FOOTPRINT*, wxString>
            m_OEMRef_dict; //<! Reverse map from the footprint pointer to the reference id string assigned for components
 
    std::map<int, std::vector<std::pair<wxString, wxString>>>
            m_net_pin_dict; //<! Map from netcode to the component/pin pairs in the net
 
    std::map<PCB_LAYER_ID, wxString>
            m_layer_name_map; //<! Mapping layer name in 2581 to the internal layer id
 
    std::map<DRILL_SPAN, std::vector<BOARD_ITEM*>> m_drill_layers; //<! Drill sets are output as layers, one per span
    const FAB_DRILL_MODEL* m_fabDrillModel = nullptr;
 
    std::map<std::pair<PCB_LAYER_ID, PCB_LAYER_ID>, std::vector<PAD*>>
            m_slot_holes; //<! Storage vector of slotted holes that need to be output as cutouts
 
    std::map<std::tuple<auxLayerType, PCB_LAYER_ID, PCB_LAYER_ID>, std::vector<BOARD_ITEM*>>
            m_auxilliary_Layers;
 
    PROGRESS_REPORTER*      m_progress_reporter;
 
    mutable std::map<wxString, std::set<wxString>> m_element_names;   //<! Track generated names by namespace
    mutable std::map<wxString, wxString>           m_generated_names; //<! Map input keys to unique names
 
    std::set<wxUniChar>     m_acceptable_chars;     //<! IPC2581B and C have differing sets of allowed characters in names
 
    wxXmlDocument*          m_xml_doc;
    wxXmlNode*              m_xml_root;
    wxXmlNode*              m_contentNode;
 
    wxXmlNode*              m_lastAppendedNode;     
};
 
#endif // PCB_IO_IPC2581_H_