#include <template_fieldnames.h>

Public Member Functions
	TEMPLATES ()

void	Format (OUTPUTFORMATTER *out, int nestLevel, bool aGlobal) const
	Serialize this object out as text into the given OUTPUTFORMATTER. More...

void	Parse (TEMPLATE_FIELDNAMES_LEXER *in, bool aGlobal)
	Fill this object from information in the input stream handled by #TEMPLATE_FIELDNAMES_LEXER. More...

void	AddTemplateFieldName (const TEMPLATE_FIELDNAME &aFieldName, bool aGlobal)
	Insert or append a wanted symbol field name into the field names template. More...

void	DeleteAllFieldNameTemplates (bool aGlobal)
	Delete the entire contents. More...

const TEMPLATE_FIELDNAMES &	GetTemplateFieldNames ()
	Return a template field name list for read only access. More...

const TEMPLATE_FIELDNAMES &	GetTemplateFieldNames (bool aGlobal)
	Return a specific list (global or project) for read only access. More...

const TEMPLATE_FIELDNAME *	GetFieldName (const wxString &aName)
	Search for aName in the template field name list. More...

Protected Member Functions
void	resolveTemplates ()

Private Attributes
TEMPLATE_FIELDNAMES	m_globals

TEMPLATE_FIELDNAMES	m_project

TEMPLATE_FIELDNAMES	m_resolved

bool	m_resolvedDirty

Detailed Description

Definition at line 122 of file template_fieldnames.h.

Constructor & Destructor Documentation

◆ TEMPLATES()

TEMPLATES::TEMPLATES ( )

inline

Definition at line 125 of file template_fieldnames.h.

 :
 m_resolvedDirty( true )
 { }

Member Function Documentation

◆ AddTemplateFieldName()

void TEMPLATES::AddTemplateFieldName	(	const TEMPLATE_FIELDNAME &	aFieldName,
		bool	aGlobal
	)

Insert or append a wanted symbol field name into the field names 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 field names.
aGlobal	indicates whether to add to the global or project table.

Definition at line 203 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;
 }
 
 TEMPLATE_FIELDNAMES& target = aGlobal ? m_globals : m_project;
 
 // ensure uniqueness, overwrite any template fieldname by the same name.
 for( TEMPLATE_FIELDNAME& temp : target )
 {
 if( temp.m_Name == aFieldName.m_Name )
 {
 temp = aFieldName;
 m_resolvedDirty = true;
 return;
 }
 }
 
 // the name is legal and not previously added to the config container, append
 // it and return its index within the container.
 target.push_back( aFieldName );
 m_resolvedDirty = true;
}

References TEMPLATE_FIELDNAME::GetDefaultFieldName(), m_globals, TEMPLATE_FIELDNAME::m_Name, m_project, m_resolvedDirty, and MANDATORY_FIELDS.

Referenced by Parse(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), and PANEL_TEMPLATE_FIELDNAMES::TransferDataFromWindow().

◆ DeleteAllFieldNameTemplates()

void TEMPLATES::DeleteAllFieldNameTemplates ( bool aGlobal )

Delete the entire contents.

Definition at line 232 of file template_fieldnames.cpp.

{
 if( aGlobal )
 {
 m_globals.clear();
 m_resolved = m_project;
 }
 else
 {
 m_project.clear();
 m_resolved = m_globals;
 }
 
 m_resolvedDirty = false;
}

References m_globals, m_project, m_resolved, and m_resolvedDirty.

Referenced by SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), and PANEL_TEMPLATE_FIELDNAMES::TransferDataFromWindow().

◆ Format()

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

Serialize this object out as text into the given OUTPUTFORMATTER.

Definition at line 123 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" );
 
 const TEMPLATE_FIELDNAMES& source = aGlobal ? m_globals : m_project;
 
 for( const TEMPLATE_FIELDNAME& temp : source )
 temp.Format( out, nestLevel+1 );
 
 out->Print( 0, ")\n" );
}

References m_globals, m_project, and OUTPUTFORMATTER::Print().

Referenced by PANEL_TEMPLATE_FIELDNAMES::TransferDataFromWindow().

◆ GetFieldName()

const TEMPLATE_FIELDNAME * TEMPLATES::GetFieldName ( const wxString & aName )

Search for aName in the template field name list.

Parameters

aName A wxString object containing the field name to search for.

Returns: the template field name if found; NULL otherwise.

Definition at line 267 of file template_fieldnames.cpp.

{
 if( m_resolvedDirty )
 resolveTemplates();
 
 for( const TEMPLATE_FIELDNAME& field : m_resolved )
 {
 if( field.m_Name == aName )
 return &field;
 }
 
 return nullptr;
}

References m_resolved, m_resolvedDirty, and resolveTemplates().

Referenced by FIELDS_GRID_TABLE< T >::GetAttr().

◆ GetTemplateFieldNames() [1/2]

const TEMPLATE_FIELDNAMES & TEMPLATES::GetTemplateFieldNames ( )

Return a template field name list for read only access.

Definition at line 249 of file template_fieldnames.cpp.

{
 if( m_resolvedDirty )
 resolveTemplates();
 
 return m_resolved;
}

References m_resolved, m_resolvedDirty, and resolveTemplates().

Referenced by PANEL_TEMPLATE_FIELDNAMES::ImportSettingsFrom(), DIALOG_SYMBOL_FIELDS_TABLE::LoadFieldNames(), SCH_SYMBOL::ResolveTextVar(), SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS(), and PANEL_TEMPLATE_FIELDNAMES::TransferDataToWindow().

◆ GetTemplateFieldNames() [2/2]

const TEMPLATE_FIELDNAMES & TEMPLATES::GetTemplateFieldNames ( bool aGlobal )

Return a specific list (global or project) for read only access.

Definition at line 258 of file template_fieldnames.cpp.

{
 if( aGlobal )
 return m_globals;
 else
 return m_project;
}

References m_globals, and m_project.

◆ Parse()

void TEMPLATES::Parse	(	TEMPLATE_FIELDNAMES_LEXER *	in,
		bool	aGlobal
	)

Fill this object from information in the input stream handled by #TEMPLATE_FIELDNAMES_LEXER.

Definition at line 138 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, aGlobal );
 }
 break;
 
 default:
 in->Unexpected( in->CurText() );
 break;
 }
 }
}

References AddTemplateFieldName(), and TEMPLATE_FIELDNAME::Parse().

Referenced by PANEL_TEMPLATE_FIELDNAMES::PANEL_TEMPLATE_FIELDNAMES(), and SCHEMATIC_SETTINGS::SCHEMATIC_SETTINGS().

◆ resolveTemplates()

void TEMPLATES::resolveTemplates ( )

protected

Definition at line 181 of file template_fieldnames.cpp.

{
 m_resolved = m_project;
 
 // Note: order N^2 algorithm. Would need changing if fieldname template sets ever
 // get large.
 
 for( const TEMPLATE_FIELDNAME& global : m_globals )
 {
 for( const TEMPLATE_FIELDNAME& project : m_project )
 {
 if( global.m_Name == project.m_Name )
 continue;
 }
 
 m_resolved.push_back( global );
 }
 
 m_resolvedDirty = false;
}

References m_globals, m_project, m_resolved, m_resolvedDirty, and project.

Referenced by GetFieldName(), and GetTemplateFieldNames().

Member Data Documentation

◆ m_globals

TEMPLATE_FIELDNAMES TEMPLATES::m_globals

private

Definition at line 180 of file template_fieldnames.h.

Referenced by AddTemplateFieldName(), DeleteAllFieldNameTemplates(), Format(), GetTemplateFieldNames(), and resolveTemplates().

◆ m_project

TEMPLATE_FIELDNAMES TEMPLATES::m_project

private

Definition at line 181 of file template_fieldnames.h.

Referenced by AddTemplateFieldName(), DeleteAllFieldNameTemplates(), Format(), GetTemplateFieldNames(), and resolveTemplates().

◆ m_resolved

TEMPLATE_FIELDNAMES TEMPLATES::m_resolved

private

Definition at line 184 of file template_fieldnames.h.

Referenced by DeleteAllFieldNameTemplates(), GetFieldName(), GetTemplateFieldNames(), and resolveTemplates().

◆ m_resolvedDirty

bool TEMPLATES::m_resolvedDirty

private

Definition at line 185 of file template_fieldnames.h.

Referenced by AddTemplateFieldName(), DeleteAllFieldNameTemplates(), GetFieldName(), GetTemplateFieldNames(), and resolveTemplates().

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

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TEMPLATES()

Member Function Documentation

◆ AddTemplateFieldName()

◆ DeleteAllFieldNameTemplates()

◆ Format()

◆ GetFieldName()

◆ GetTemplateFieldNames() [1/2]

◆ GetTemplateFieldNames() [2/2]

◆ Parse()

◆ resolveTemplates()

Member Data Documentation

◆ m_globals

◆ m_project

◆ m_resolved

◆ m_resolvedDirty