TEMPLATES Class Reference

#include <template_fieldnames.h>

Public Member Functions
void	Format (OUTPUTFORMATTER *out, int nestLevel) const
	Function Format serializes this object out as text into the given OUTPUTFORMATTER. More...
void	Parse (TEMPLATE_FIELDNAMES_LEXER *in)
	Function Parse fills this object from information in the input stream handled by TEMPLATE_FIELDNAMES_LEXER. More...
int	AddTemplateFieldName (const TEMPLATE_FIELDNAME &aFieldName)
	Function AddTemplateFieldName inserts or appends a wanted symbol field name into the fieldnames template. More...
void	DeleteAllTemplateFieldNames ()
	Function DeleteAllTemplateFieldNames deletes the entire contents. More...
const TEMPLATE_FIELDNAMES &	GetTemplateFieldNames () const
	Function GetTemplateFieldName returns a template fieldnames list for read only access. More...
const TEMPLATE_FIELDNAME *	GetFieldName (const wxString &aName) const
	Function GetFieldName searches for aName in the the template field name list. More...

Private Attributes
TEMPLATE_FIELDNAMES	m_Fields

Detailed Description

Definition at line 130 of file template_fieldnames.h.

Member Function Documentation

AddTemplateFieldName()

int TEMPLATES::AddTemplateFieldName

(

const TEMPLATE_FIELDNAME &

aFieldName

)

Function AddTemplateFieldName inserts or appends a wanted symbol field name into the fieldnames template.

Should be used for any symbol property editor. If the name already exists, it overwrites the same name.

Parameters

aFieldName

is a full description of the wanted field, and it must not match any of the default fieldnames.

Returns

int - the index within the config container at which aFieldName was added, or -1 if the name is illegal because it matches a default fieldname.

Definition at line 192 of file template_fieldnames.cpp.

{
    // Ensure that the template fieldname does not match a fixed fieldname.
    for( int i=0;  i<MANDATORY_FIELDS;  ++i )
    {
        if( TEMPLATE_FIELDNAME::GetDefaultFieldName( i ) == aFieldName.m_Name )
        {
            return -1;
        }
    }

    // ensure uniqueness, overwrite any template fieldname by the same name.
    for( unsigned i=0; i<m_Fields.size();  ++i )
    {
        if( m_Fields[i].m_Name == aFieldName.m_Name )
        {
            // DBG( printf( "inserting template fieldname:'%s' at %d\n",
            //            TO_UTF8( aFieldName.m_Name ), i ); )

            m_Fields[i] = aFieldName;
            return i;   // return the container index
        }
    }

    // DBG(printf("appending template fieldname:'%s'\n", aFieldName.m_Name.utf8_str() );)

    // the name is legal and not previously added to the config container, append
    // it and return its index within the container.
    m_Fields.push_back( aFieldName );

    return m_Fields.size() - 1; // return the index of insertion.
}

References TEMPLATE_FIELDNAME::GetDefaultFieldName(), i, TEMPLATE_FIELDNAME::m_Name, and MANDATORY_FIELDS.

Referenced by SCH_EDIT_FRAME::AddTemplateFieldName().

DeleteAllTemplateFieldNames()

void TEMPLATES::DeleteAllTemplateFieldNames ( )

inline

Function DeleteAllTemplateFieldNames deletes the entire contents.

Definition at line 167 of file template_fieldnames.h.

    {
        m_Fields.clear();
    }

References m_Fields.

Referenced by SCH_EDIT_FRAME::DeleteAllTemplateFieldNames().

Format()

void TEMPLATES::Format	(	OUTPUTFORMATTER *	out,
		int	nestLevel
	)		const

Function Format serializes this object out as text into the given OUTPUTFORMATTER.

Definition at line 140 of file template_fieldnames.cpp.

{
    // We'll keep this general, and include the \n, even though the only known
    // use at this time will not want the newlines or the indentation.
    out->Print( nestLevel, "(templatefields" );

    for( unsigned i=0;  i<m_Fields.size();  ++i )
        m_Fields[i].Format( out, nestLevel+1 );

    out->Print( 0, ")\n" );
}

References Format(), i, and OUTPUTFORMATTER::Print().

Referenced by SCH_EDIT_FRAME::SaveSettings().

GetFieldName()

const TEMPLATE_FIELDNAME * TEMPLATES::GetFieldName

(

const wxString &

aName

)

const

Function GetFieldName searches for aName in the the template field name list.

Parameters

aName

A wxString object containing the field name to search for.

Returns

the template fieldname if found; NULL otherwise.

Definition at line 226 of file template_fieldnames.cpp.

{
    for( const TEMPLATE_FIELDNAME& field : m_Fields )
    {
        if( field.m_Name == aName )
            return &field;
    }

    return nullptr;
}

Referenced by SCH_BASE_FRAME::GetTemplateFieldName().

GetTemplateFieldNames()

const TEMPLATE_FIELDNAMES& TEMPLATES::GetTemplateFieldNames ( ) const

inline

Function GetTemplateFieldName returns a template fieldnames list for read only access.

Definition at line 176 of file template_fieldnames.h.

    {
        return m_Fields;
    }

References m_Fields.

Referenced by SCH_BASE_FRAME::GetTemplateFieldNames().

Parse()

void TEMPLATES::Parse

(

TEMPLATE_FIELDNAMES_LEXER *

in

)

Function Parse fills this object from information in the input stream handled by TEMPLATE_FIELDNAMES_LEXER.

Definition at line 153 of file template_fieldnames.cpp.

{
    T  tok;

    while( ( tok = in->NextTok() ) != T_RIGHT && tok != T_EOF )
    {
        if( tok == T_LEFT )
            tok = in->NextTok();

        switch( tok )
        {
        case T_templatefields:  // a token indicating class TEMPLATES.

            // Be flexible regarding the starting point of the TEMPLATE_FIELDNAMES_LEXER
            // stream.  Caller may not have read the first two tokens out of the
            // stream: T_LEFT and T_templatefields, so ignore them if seen here.
            break;

        case T_field:
            {
                // instantiate on stack, so if exception is thrown,
                // destructor runs
                TEMPLATE_FIELDNAME  field;

                field.Parse( in );

                // add the field
                AddTemplateFieldName( field );
            }
            break;

        default:
            in->Unexpected( in->CurText() );
            break;
        }
    }
}

References TEMPLATE_FIELDNAME::Parse().

Referenced by LIB_EDIT_FRAME::LoadSettings(), and SCH_EDIT_FRAME::LoadSettings().

Member Data Documentation

m_Fields

TEMPLATE_FIELDNAMES TEMPLATES::m_Fields

private

Definition at line 133 of file template_fieldnames.h.

Referenced by DeleteAllTemplateFieldNames(), and GetTemplateFieldNames().

---

The documentation for this class was generated from the following files:

• template_fieldnames.h
• template_fieldnames.cpp