gbr_metadata.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2018 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright (C) 2018-2020 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 GBR_METADATA_H
#define GBR_METADATA_H

#include <gbr_netlist_metadata.h>

enum GBR_NC_STRING_FORMAT       // Options for string format in some attribute strings
{
    GBR_NC_STRING_FORMAT_X1,
    GBR_NC_STRING_FORMAT_X2,
    GBR_NC_STRING_FORMAT_GBRJOB,
    GBR_NC_STRING_FORMAT_NCDRILL
};
wxString GbrMakeCreationDateAttributeString( GBR_NC_STRING_FORMAT aFormat );


wxString GbrMakeProjectGUIDfromString( const wxString& aText );


// this class handle info which can be added in a gerber file as attribute
// of an aperture, by the %TA.AperFunction command
// This attribute is added when creating a new aperture (command %ADDxx)
// Only one aperture attribute can be added to a given aperture
//
class GBR_APERTURE_METADATA
{
public:
    enum GBR_APERTURE_ATTRIB
    {
        GBR_APERTURE_ATTRIB_NONE,           
        GBR_APERTURE_ATTRIB_ETCHEDCMP,      

        GBR_APERTURE_ATTRIB_CONDUCTOR,
        GBR_APERTURE_ATTRIB_EDGECUT,        

        GBR_APERTURE_ATTRIB_NONCONDUCTOR,
        GBR_APERTURE_ATTRIB_VIAPAD,         

        GBR_APERTURE_ATTRIB_COMPONENTPAD,

        GBR_APERTURE_ATTRIB_SMDPAD_SMDEF,

        GBR_APERTURE_ATTRIB_SMDPAD_CUDEF,

        GBR_APERTURE_ATTRIB_BGAPAD_SMDEF,

        GBR_APERTURE_ATTRIB_BGAPAD_CUDEF,

        GBR_APERTURE_ATTRIB_CONNECTORPAD,
        GBR_APERTURE_ATTRIB_WASHERPAD,      
        GBR_APERTURE_ATTRIB_TESTPOINT,      

        GBR_APERTURE_ATTRIB_FIDUCIAL_GLBL,

        GBR_APERTURE_ATTRIB_FIDUCIAL_LOCAL,

        GBR_APERTURE_ATTRIB_HEATSINKPAD,

        GBR_APERTURE_ATTRIB_CASTELLATEDPAD,

        GBR_APERTURE_ATTRIB_CASTELLATEDDRILL,

        GBR_APERTURE_ATTRIB_VIADRILL,       
        GBR_APERTURE_ATTRIB_CMP_DRILL,      

        GBR_APERTURE_ATTRIB_CMP_OBLONG_DRILL,

        GBR_APERTURE_ATTRIB_CMP_POSITION,

        GBR_APERTURE_ATTRIB_PAD1_POSITION,

        GBR_APERTURE_ATTRIB_PADOTHER_POSITION,

        GBR_APERTURE_ATTRIB_CMP_BODY,

        GBR_APERTURE_ATTRIB_CMP_LEAD2LEAD,

        GBR_APERTURE_ATTRIB_CMP_FOOTPRINT,

        GBR_APERTURE_ATTRIB_CMP_COURTYARD,
        GBR_APERTURE_ATTRIB_END             
    };

    GBR_APERTURE_METADATA()
        :m_ApertAttribute( GBR_APERTURE_ATTRIB_NONE )
    {}

    static std::string GetAttributeName( GBR_APERTURE_ATTRIB aAttribute );
    std::string GetAttributeName()
    {
        return GetAttributeName( m_ApertAttribute );
    }

    static std::string FormatAttribute( GBR_APERTURE_ATTRIB aAttribute,
                                        bool aUseX1StructuredComment );

    std::string FormatAttribute( bool aUseX1StructuredComment )
    {
        return FormatAttribute( m_ApertAttribute, aUseX1StructuredComment );
    }

    // The id of the aperture attribute
    GBR_APERTURE_ATTRIB m_ApertAttribute;
};


class GBR_METADATA
{
public:
    GBR_METADATA(): m_isCopper( false)  {}

    void SetApertureAttrib( GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB aApertAttribute )
    {
        m_ApertureMetadata.m_ApertAttribute = aApertAttribute;
    }

    GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB GetApertureAttrib()
    {
        return m_ApertureMetadata.m_ApertAttribute;
    }

    void SetNetAttribType( int aNetAttribType )
    {
        m_NetlistMetadata.m_NetAttribType = aNetAttribType;
    }

    int GetNetAttribType() const
    {
        return m_NetlistMetadata.m_NetAttribType;
    }

    void SetNetName( const wxString& aNetname ) { m_NetlistMetadata.m_Netname = aNetname; }

    void SetPadName( const wxString& aPadname, bool aUseUTF8 = false, bool aEscapeString = false )
    {
        m_NetlistMetadata.m_Padname.SetField( aPadname, aUseUTF8, aEscapeString );
    }

    void SetPadPinFunction( const wxString& aPadPinFunction, bool aUseUTF8, bool aEscapeString )
    {
        m_NetlistMetadata.m_PadPinFunction.SetField( aPadPinFunction, aUseUTF8, aEscapeString );
    }

    void SetCmpReference( const wxString& aComponentRef )
    {
        m_NetlistMetadata.m_Cmpref = aComponentRef;
    }

    bool IsCopper() { return m_isCopper; }
    void SetCopper( bool aValue ) { m_isCopper = aValue; }

    GBR_APERTURE_METADATA m_ApertureMetadata;

    GBR_NETLIST_METADATA m_NetlistMetadata;

private:
    bool m_isCopper;
};


std::string FormatStringToGerber( const wxString& aString );


wxString ConvertNotAllowedCharsInGerber( const wxString& aString, bool aAllowUtf8Chars,
                                         bool aQuoteString );

wxString FormatStringFromGerber( const wxString& aString );

bool FormatNetAttribute( std::string& aPrintedText, std::string& aLastNetAttributes,
                         const GBR_NETLIST_METADATA* aData, bool& aClearPreviousAttributes,
                         bool aUseX1StructuredComment );

#endif      // GBR_METADATA_H