template_fieldnames.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2010 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 <initializer_list>
 
#include <wx/string.h>
 
class OUTPUTFORMATTER;
class TEMPLATE_FIELDNAMES_LEXER;
 

enum class FIELD_T : int
{
    USER,                   
    REFERENCE,              
    VALUE,                  
    FOOTPRINT,              
    DATASHEET,              
    DESCRIPTION,            
    INTERSHEET_REFS,        
    SHEET_NAME,
    SHEET_FILENAME,
    SHEET_USER
};
 
#define MANDATORY_FIELDS { FIELD_T::REFERENCE,        \
                           FIELD_T::VALUE,            \
                           FIELD_T::FOOTPRINT,        \
                           FIELD_T::DATASHEET,        \
                           FIELD_T::DESCRIPTION }
 
#define GLOBALLABEL_MANDATORY_FIELDS { FIELD_T::INTERSHEET_REFS }
 
#define SHEET_MANDATORY_FIELDS { FIELD_T::SHEET_NAME,        \
                                 FIELD_T::SHEET_FILENAME }
 
// A helper to call GetDefaultFieldName with or without translation.
// Translation should be used only to display field names in dialogs
#define DO_TRANSLATE true
 

wxString GetDefaultFieldName( FIELD_T aFieldId, bool aTranslateForHI );
wxString GetUserFieldName( int aFieldNdx, bool aTranslateForHI );
 
 
inline wxString GetCanonicalFieldName( FIELD_T aFieldType )
{
    return GetDefaultFieldName( aFieldType, !DO_TRANSLATE );
}
 

bool FieldNamesAreDuplicates( const wxString& aLhs, const wxString& aRhs,
                              std::initializer_list<FIELD_T> aMandatoryFields );
 

bool FieldNamesAreDuplicates( const wxString& aLhs, const wxString& aRhs );
 

struct TEMPLATE_FIELDNAME
{
    TEMPLATE_FIELDNAME() :
            m_Visible( false ),
            m_URL( false )
    {
    }
 
    TEMPLATE_FIELDNAME( const wxString& aName ) :
            m_Name( aName ),
            m_Visible( false ),
            m_URL( false )
    {
    }
 
    TEMPLATE_FIELDNAME( const TEMPLATE_FIELDNAME& ref )
    {
        m_Name = ref.m_Name;
        m_Visible = ref.m_Visible;
        m_URL = ref.m_URL;
    }

    void Format( OUTPUTFORMATTER* out ) const ;

    void Parse( TEMPLATE_FIELDNAMES_LEXER* aSpec );
 
    wxString    m_Name;         // The field name
    bool        m_Visible;      // Field defaults to being visible in schematic.
    bool        m_URL;          // If field should have a browse button
};
 
 
class TEMPLATES
{
public:
    TEMPLATES() :
            m_resolvedDirty( true )
    { }

    void Format( OUTPUTFORMATTER* out, bool aGlobal ) const ;

    void AddTemplateFieldName( const TEMPLATE_FIELDNAME& aFieldName, bool aGlobal );

    void AddTemplateFieldNames( const wxString& aSerializedFieldNames );

    void DeleteAllFieldNameTemplates( bool aGlobal );

    const std::vector<TEMPLATE_FIELDNAME>& GetTemplateFieldNames();

    const std::vector<TEMPLATE_FIELDNAME>& GetTemplateFieldNames( bool aGlobal );

    const TEMPLATE_FIELDNAME* GetFieldName( const wxString& aName );
 
protected:
    void resolveTemplates();
 
    void parse( TEMPLATE_FIELDNAMES_LEXER* in, bool aGlobal );
 
private:
    std::vector<TEMPLATE_FIELDNAME> m_globals;
    std::vector<TEMPLATE_FIELDNAME> m_project;
 
    // Combined list.  Project templates override global ones.
    std::vector<TEMPLATE_FIELDNAME> m_resolved;
    bool                            m_resolvedDirty;
};