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 (C) 2014-2024 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
 */
 
#pragma once
 
#include <wx/string.h>
 
class OUTPUTFORMATTER;
class TEMPLATE_FIELDNAMES_LEXER;
 
 
enum  MANDATORY_FIELD_T {
    INVALID_FIELD = -1,           
    REFERENCE_FIELD = 0,          
    VALUE_FIELD,                  
    FOOTPRINT_FIELD,              
    DATASHEET_FIELD,              
    DESCRIPTION_FIELD,            
 
    MANDATORY_FIELDS
};
 
// A helper to call GetDefaultFieldName with or without translation.
// Translation should be used only to display field names in dialogs
#define DO_TRANSLATE true
 
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 );
 
    static const wxString GetDefaultFieldName( int aFieldNdx, bool aTranslateForHI = false );
 
    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
};
 
typedef std::vector< TEMPLATE_FIELDNAME > TEMPLATE_FIELDNAMES;
 
 
inline wxString GetCanonicalFieldName( int idx )
{
    // While TEMPLATE_FIELDNAME::GetDefaultFieldName() still works for non-mandatory fields,
    // it's confusing to call it through this function.
    wxASSERT( idx < MANDATORY_FIELDS );
 
    return TEMPLATE_FIELDNAME::GetDefaultFieldName( idx );
}
 
 
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 TEMPLATE_FIELDNAMES& GetTemplateFieldNames();
 
    const TEMPLATE_FIELDNAMES& GetTemplateFieldNames( bool aGlobal );
 
    const TEMPLATE_FIELDNAME* GetFieldName( const wxString& aName );
 
protected:
    void resolveTemplates();
 
    void parse( TEMPLATE_FIELDNAMES_LEXER* in, bool aGlobal );
 
private:
    TEMPLATE_FIELDNAMES     m_globals;
    TEMPLATE_FIELDNAMES     m_project;
 
    // Combined list.  Project templates override global ones.
    TEMPLATE_FIELDNAMES     m_resolved;
    bool                    m_resolvedDirty;
};