#include <initializer_list>
#include <kicommon.h>
#include <wx/string.h>

Classes
struct	TEMPLATE_FIELDNAME
	Hold a name of a symbol's field, field value, and default visibility. More...

class	TEMPLATES

Macros
#define	MANDATORY_FIELDS

#define	GLOBALLABEL_MANDATORY_FIELDS { FIELD_T::INTERSHEET_REFS }

#define	SHEET_MANDATORY_FIELDS

Enumerations
enum class	FIELD_T : int { USER , REFERENCE , VALUE , FOOTPRINT , DATASHEET , DESCRIPTION , INTERSHEET_REFS , SHEET_NAME , SHEET_FILENAME , SHEET_USER }
	The set of all field indices assuming an array like sequence that a SCH_COMPONENT or LIB_PART can hold. More...

enum	TRANSLATION { UNTRANSLATED , TRANSLATED }

Functions
KICOMMON_API wxString	GetDefaultFieldName (FIELD_T aFieldId, TRANSLATION aTranslation)
	Return a default symbol field name for a mandatory field type.

KICOMMON_API wxString	GetUserFieldName (int aFieldNdx, TRANSLATION aTranslation)

KICOMMON_API bool	FieldNamesAreDuplicates (const wxString &aLhs, const wxString &aRhs, std::initializer_list< FIELD_T > aMandatoryFields)
	Test whether two field names should be treated as duplicates for the purposes of field name uniqueness within a given parent (symbol, sheet, or global label).

KICOMMON_API bool	FieldNamesAreDuplicates (const wxString &aLhs, const wxString &aRhs)
	Convenience overload defaulting to symbol mandatory fields.

Macro Definition Documentation

◆ GLOBALLABEL_MANDATORY_FIELDS

#define GLOBALLABEL_MANDATORY_FIELDS { FIELD_T::INTERSHEET_REFS }

Definition at line 62 of file template_fieldnames.h.

Referenced by BOOST_AUTO_TEST_CASE(), DIALOG_LABEL_PROPERTIES::OnGridCellChanging(), and SCH_IO_KICAD_SEXPR_PARSER::parseSchField().

◆ MANDATORY_FIELDS

#define MANDATORY_FIELDS

Value:

                           { FIELD_T::REFERENCE,        \
                           FIELD_T::VALUE,            \
                           FIELD_T::FOOTPRINT,        \
                           FIELD_T::DATASHEET,        \
                           FIELD_T::DESCRIPTION }

Definition at line 56 of file template_fieldnames.h.

Referenced by TEMPLATES::AddTemplateFieldName(), FIELDS_TABLE_DATA_MODEL_BASE::CanClearCell(), LIB_SYMBOL_LIBRARY_MANAGER::CreateSymbol(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), DIALOG_UPDATE_SYMBOL_FIELDS::DIALOG_UPDATE_SYMBOL_FIELDS(), FieldNamesAreDuplicates(), LIB_SYMBOL::Flatten(), VIEW_CONTROLS_GRID_DATA_MODEL::GetValue(), EESCHEMA_JOBS_HANDLER::JobExportBom(), PCBNEW_JOBS_HANDLER::JobExportBom(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadAliases(), SCH_IO_DATABASE::loadSymbolFromRow(), DIALOG_CHANGE_SYMBOLS::onOkButtonClicked(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), DIALOG_FIELDS_TABLE::OnRemoveField(), DIALOG_FIELDS_TABLE::OnRenameField(), SCH_IO_KICAD_SEXPR_PARSER::parseProperty(), SCH_IO_KICAD_SEXPR_PARSER::parseSchField(), DIALOG_CHANGE_SYMBOLS::updateFieldsList(), and DIALOG_UPDATE_SYMBOL_FIELDS::updateFieldsList().

◆ SHEET_MANDATORY_FIELDS

#define SHEET_MANDATORY_FIELDS

Value:

{ FIELD_T::SHEET_NAME, \

FIELD_T::SHEET_FILENAME }

FIELD_T::SHEET_NAME

@ SHEET_NAME

Definition template_fieldnames.h:51

FIELD_T::SHEET_FILENAME

@ SHEET_FILENAME

Definition template_fieldnames.h:52

Definition at line 64 of file template_fieldnames.h.

Referenced by BOOST_AUTO_TEST_CASE(), DIALOG_SHEET_PROPERTIES::OnGridCellChanging(), and SCH_IO_KICAD_SEXPR_PARSER::parseSchField().

Enumeration Type Documentation

◆ FIELD_T

enum class FIELD_T : int

strong

The set of all field indices assuming an array like sequence that a SCH_COMPONENT or LIB_PART can hold.

The first fields are fixed fields and are defined by MANDATORY_FIELDS. After that come an unlimited number of user defined fields, only some of which have indices defined here.

NOTE: this must stay a enum class to prevent developers from trying to use it as an array index.

Enumerator
USER	The field ID hasn't been set yet; field is invalid.
REFERENCE	Field Reference of part, i.e. "IC21".
VALUE	Field Value of part, i.e. "3.3K".
FOOTPRINT	Field Name Module PCB, i.e. "16DIP300".
DATASHEET	name of datasheet
DESCRIPTION	Field Description of part, i.e. "1/4W 1% Metal Film Resistor".
INTERSHEET_REFS	Global label cross-reference page numbers.
SHEET_NAME
SHEET_FILENAME
SHEET_USER

Definition at line 42 of file template_fieldnames.h.

◆ TRANSLATION

enum TRANSLATION

Enumerator
UNTRANSLATED
TRANSLATED

Definition at line 68 of file template_fieldnames.h.

Function Documentation

◆ FieldNamesAreDuplicates() [1/2]

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

Convenience overload defaulting to symbol mandatory fields.

Definition at line 118 of file template_fieldnames.cpp.

References FieldNamesAreDuplicates(), and MANDATORY_FIELDS.

◆ FieldNamesAreDuplicates() [2/2]

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

Test whether two field names should be treated as duplicates for the purposes of field name uniqueness within a given parent (symbol, sheet, or global label).

Mandatory field names in the supplied set are matched case-insensitively because the s-expression parser folds case variants onto the mandatory field with the matching untranslated name on load. User-defined field names retain their original case in storage, so two user fields that differ only in case (e.g. "Manufacturer" vs "MANUFACTURER") are considered distinct.

Pass MANDATORY_FIELDS for symbol contexts, SHEET_MANDATORY_FIELDS for sheets, or GLOBALLABEL_MANDATORY_FIELDS for global labels. Each parent has its own set of untranslated mandatory field names used for case-insensitive matching in the parser.

Definition at line 95 of file template_fieldnames.cpp.

References GetDefaultFieldName(), and UNTRANSLATED.