KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Private Attributes | List of all members
SCH_IO_KICAD_SEXPR_PARSER Class Reference

Object to parser s-expression symbol library and schematic file formats. More...

#include <sch_io_kicad_sexpr_parser.h>

Inheritance diagram for SCH_IO_KICAD_SEXPR_PARSER:

Public Member Functions

 SCH_IO_KICAD_SEXPR_PARSER (LINE_READER *aLineReader=nullptr, PROGRESS_REPORTER *aProgressReporter=nullptr, unsigned aLineCount=0, SCH_SHEET *aRootSheet=nullptr, bool aIsAppending=false)
 
void ParseLib (LIB_SYMBOL_MAP &aSymbolLibMap)
 
LIB_SYMBOL * ParseSymbol (LIB_SYMBOL_MAP &aSymbolLibMap, int aFileVersion=SEXPR_SYMBOL_LIB_FILE_VERSION)
 Parse internal LINE_READER object into symbols and return all found.
 
SCH_ITEM * ParseSymbolDrawItem ()
 
void ParseSchematic (SCH_SHEET *aSheet, bool aIsCopyablyOnly=false, int aFileVersion=SEXPR_SCHEMATIC_FILE_VERSION)
 Parse the internal LINE_READER object into aSheet.
 
int GetParsedRequiredVersion () const
 

Private Member Functions

void checkpoint ()
 
KIID parseKIID ()
 
void parseHeader (TSCHEMATIC_T::T aHeaderType, int aFileVersion)
 
long parseHex ()
 
int parseInt ()
 
int parseInt (const char *aExpected)
 
int parseInternalUnits ()
 
int parseInternalUnits (const char *aExpected)
 
int parseInternalUnits (TSCHEMATIC_T::T aToken)
 
VECTOR2I parseXY (bool aInvertY=false)
 
bool parseBool ()
 
bool parseMaybeAbsentBool (bool aDefaultValue)
 Parses a boolean flag inside a list that existed before boolean normalization.
 
LIB_SYMBOL * parseLibSymbol (LIB_SYMBOL_MAP &aSymbolLibMap)
 
void parseStroke (STROKE_PARAMS &aStroke)
 Parse stroke definition aStroke.
 
void parseFill (FILL_PARAMS &aFill)
 
void parseMargins (int &aLeft, int &aTop, int &aRight, int &aBottom)
 
void parseEDA_TEXT (EDA_TEXT *aText, bool aConvertOverbarSyntax, bool aEnforceMinTextSize=true)
 
void parsePinNames (std::unique_ptr< LIB_SYMBOL > &aSymbol)
 
void parsePinNumbers (std::unique_ptr< LIB_SYMBOL > &aSymbol)
 
SCH_FIELD * parseProperty (std::unique_ptr< LIB_SYMBOL > &aSymbol)
 
SCH_SHAPE * parseSymbolArc ()
 
SCH_SHAPE * parseSymbolBezier ()
 
SCH_SHAPE * parseSymbolCircle ()
 
SCH_PIN * parseSymbolPin ()
 
SCH_SHAPE * parseSymbolPolyLine ()
 
SCH_SHAPE * parseSymbolRectangle ()
 
SCH_TEXT * parseSymbolText ()
 
SCH_TEXTBOX * parseSymbolTextBox ()
 
void parsePAGE_INFO (PAGE_INFO &aPageInfo)
 
void parseTITLE_BLOCK (TITLE_BLOCK &aTitleBlock)
 
void parseSchSymbolInstances (SCH_SCREEN *aScreen)
 
void parseSchSheetInstances (SCH_SHEET *aRootSheet, SCH_SCREEN *aScreen)
 
SCH_SHEET_PIN * parseSchSheetPin (SCH_SHEET *aSheet)
 
SCH_FIELD * parseSchField (SCH_ITEM *aParent)
 
SCH_SYMBOL * parseSchematicSymbol ()
 
SCH_BITMAP * parseImage ()
 
SCH_SHEET * parseSheet ()
 
SCH_JUNCTION * parseJunction ()
 
SCH_NO_CONNECT * parseNoConnect ()
 
SCH_BUS_WIRE_ENTRY * parseBusEntry ()
 
SCH_LINE * parseLine ()
 
SCH_SHAPE * parseSchPolyLine ()
 
SCH_SHAPE * parseSchArc ()
 
SCH_SHAPE * parseSchCircle ()
 
SCH_SHAPE * parseSchRectangle ()
 
SCH_SHAPE * parseSchBezier ()
 
SCH_RULE_AREA * parseSchRuleArea ()
 
SCH_TEXT * parseSchText ()
 
SCH_TEXTBOX * parseSchTextBox ()
 
void parseSchTextBoxContent (SCH_TEXTBOX *aTextBox)
 
SCH_TABLECELL * parseSchTableCell ()
 
SCH_TABLE * parseSchTable ()
 
void parseBusAlias (SCH_SCREEN *aScreen)
 

Private Attributes

int m_requiredVersion
 Set to the symbol library file version required.
 
wxString m_generatorVersion
 
int m_unit
 The current unit being parsed.
 
int m_bodyStyle
 The current body style being parsed.
 
wxString m_symbolName
 The current symbol name.
 
bool m_appending
 Appending load status.
 
std::set< int > m_fieldIDsRead
 Field IDs that have been read so far for the current symbol.
 
std::set< KIID > m_uuids
 
PROGRESS_REPORTER * m_progressReporter
 
const LINE_READER * m_lineReader
 
unsigned m_lastProgressLine
 
unsigned m_lineCount
 
KIID m_rootUuid
 
SCH_SHEET * m_rootSheet
 The rootsheet for full project loads or null for importing a schematic.
 

Detailed Description

Object to parser s-expression symbol library and schematic file formats.

Definition at line 76 of file sch_io_kicad_sexpr_parser.h.

Constructor & Destructor Documentation

◆ SCH_IO_KICAD_SEXPR_PARSER()

SCH_IO_KICAD_SEXPR_PARSER::SCH_IO_KICAD_SEXPR_PARSER ( LINE_READER *  aLineReader = nullptr,
PROGRESS_REPORTER *  aProgressReporter = nullptr,
unsigned  aLineCount = 0,
SCH_SHEET *  aRootSheet = nullptr,
bool  aIsAppending = false 
)

Definition at line 75 of file sch_io_kicad_sexpr_parser.cpp.

Member Function Documentation

◆ checkpoint()

void SCH_IO_KICAD_SEXPR_PARSER::checkpoint ( )
private

Definition at line 93 of file sch_io_kicad_sexpr_parser.cpp.

References _, PROGRESS_REPORTER::KeepRefreshing(), LINE_READER::LineNumber(), m_lastProgressLine, m_lineCount, m_lineReader, m_progressReporter, PROGRESS_REPORTER::SetCurrentProgress(), and THROW_IO_ERROR.

Referenced by ParseSchematic().

◆ GetParsedRequiredVersion()

int SCH_IO_KICAD_SEXPR_PARSER::GetParsedRequiredVersion ( ) const
inline

Definition at line 113 of file sch_io_kicad_sexpr_parser.h.

References m_requiredVersion.

Referenced by SCH_IO_KICAD_SEXPR_LIB_CACHE::Load().

◆ parseBool()

bool SCH_IO_KICAD_SEXPR_PARSER::parseBool ( )
private

Definition at line 128 of file sch_io_kicad_sexpr_parser.cpp.

Referenced by parseLibSymbol(), parsePinNames(), parsePinNumbers(), ParseSchematic(), parseSchematicSymbol(), parseSchTable(), parseSchText(), parseSchTextBoxContent(), parseSheet(), and parseSymbolPin().

◆ parseBusAlias()

void SCH_IO_KICAD_SEXPR_PARSER::parseBusAlias ( SCH_SCREEN *  aScreen)
private

Definition at line 4701 of file sch_io_kicad_sexpr_parser.cpp.

References SCH_SCREEN::AddBusAlias(), ConvertToNewOverbarNotation(), and m_requiredVersion.

Referenced by ParseSchematic().

◆ parseBusEntry()

SCH_BUS_WIRE_ENTRY * SCH_IO_KICAD_SEXPR_PARSER::parseBusEntry ( )
private

Definition at line 3737 of file sch_io_kicad_sexpr_parser.cpp.

References DEFAULT_LINE_WIDTH_MILS, EDA_IU_SCALE::MilsToIU(), parseInternalUnits(), parseKIID(), parseStroke(), parseXY(), schIUScale, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by ParseSchematic().

◆ parseEDA_TEXT()

void SCH_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT ( EDA_TEXT *  aText,
bool  aConvertOverbarSyntax,
bool  aEnforceMinTextSize = true 
)
private

Definition at line 702 of file sch_io_kicad_sexpr_parser.cpp.

References _, color, ConvertToNewOverbarNotation(), EDA_TEXT::GetText(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_H_ALIGN_LEFT, GR_TEXT_H_ALIGN_RIGHT, GR_TEXT_V_ALIGN_BOTTOM, GR_TEXT_V_ALIGN_CENTER, GR_TEXT_V_ALIGN_TOP, m_requiredVersion, parseDouble(), parseInt(), parseInternalUnits(), parseMaybeAbsentBool(), EDA_TEXT::SetBoldFlag(), EDA_TEXT::SetHorizJustify(), EDA_TEXT::SetHyperlink(), EDA_TEXT::SetItalicFlag(), EDA_TEXT::SetLineSpacing(), EDA_TEXT::SetText(), EDA_TEXT::SetTextColor(), EDA_TEXT::SetTextSize(), EDA_TEXT::SetTextThickness(), EDA_TEXT::SetUnresolvedFontName(), EDA_TEXT::SetVertJustify(), EDA_TEXT::SetVisible(), THROW_PARSE_ERROR, EDA_TEXT::ValidateHyperlink(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by parseProperty(), parseSchField(), parseSchSheetPin(), parseSchText(), parseSchTextBoxContent(), parseSymbolPin(), parseSymbolText(), and parseSymbolTextBox().

◆ parseFill()

void SCH_IO_KICAD_SEXPR_PARSER::parseFill ( FILL_PARAMS &  aFill)
private

Definition at line 647 of file sch_io_kicad_sexpr_parser.cpp.

References color, FILL_PARAMS::m_Color, FILL_PARAMS::m_FillType, parseDouble(), and parseInt().

Referenced by parseSchArc(), parseSchBezier(), parseSchCircle(), parseSchPolyLine(), parseSchRectangle(), parseSchTextBoxContent(), parseSheet(), parseSymbolArc(), parseSymbolBezier(), parseSymbolCircle(), parseSymbolPolyLine(), parseSymbolRectangle(), and parseSymbolTextBox().

◆ parseHeader()

void SCH_IO_KICAD_SEXPR_PARSER::parseHeader ( TSCHEMATIC_T::T  aHeaderType,
int  aFileVersion 
)
private

Definition at line 840 of file sch_io_kicad_sexpr_parser.cpp.

References m_requiredVersion, and parseInt().

Referenced by ParseLib(), and ParseSchematic().

◆ parseHex()

long SCH_IO_KICAD_SEXPR_PARSER::parseHex ( )
inlineprivate

Definition at line 122 of file sch_io_kicad_sexpr_parser.h.

◆ parseImage()

SCH_BITMAP * SCH_IO_KICAD_SEXPR_PARSER::parseImage ( )
private

Definition at line 3346 of file sch_io_kicad_sexpr_parser.cpp.

References _, REFERENCE_IMAGE::GetImage(), REFERENCE_IMAGE::GetImageScale(), BITMAP_BASE::GetPPI(), m_requiredVersion, parseDouble(), parseKIID(), parseXY(), REFERENCE_IMAGE::ReadImageFile(), scale, REFERENCE_IMAGE::SetImageScale(), and THROW_IO_ERROR.

Referenced by ParseSchematic().

◆ parseInt() [1/2]

int SCH_IO_KICAD_SEXPR_PARSER::parseInt ( )
inlineprivate

Definition at line 128 of file sch_io_kicad_sexpr_parser.h.

Referenced by parseEDA_TEXT(), parseFill(), parseHeader(), parseInt(), parseJunction(), parseProperty(), parseSchematicSymbol(), parseSchField(), parseSchSymbolInstances(), parseSchTable(), parseSchTextBoxContent(), parseSymbolPin(), and parseTITLE_BLOCK().

◆ parseInt() [2/2]

int SCH_IO_KICAD_SEXPR_PARSER::parseInt ( const char *  aExpected)
inlineprivate

Definition at line 133 of file sch_io_kicad_sexpr_parser.h.

References parseInt().

◆ parseInternalUnits() [1/3]

int SCH_IO_KICAD_SEXPR_PARSER::parseInternalUnits ( )
private

Definition at line 614 of file sch_io_kicad_sexpr_parser.cpp.

References EDA_IU_SCALE::IU_PER_MM, KiROUND(), parseDouble(), and schIUScale.

Referenced by parseBusEntry(), parseEDA_TEXT(), parseInternalUnits(), parseJunction(), parseMargins(), parsePinNames(), parseSchCircle(), parseSchTable(), parseSchText(), parseSheet(), parseSymbolArc(), parseSymbolCircle(), parseSymbolPin(), and parseXY().

◆ parseInternalUnits() [2/3]

int SCH_IO_KICAD_SEXPR_PARSER::parseInternalUnits ( const char *  aExpected)
private

Definition at line 627 of file sch_io_kicad_sexpr_parser.cpp.

References EDA_IU_SCALE::IU_PER_MM, KiROUND(), parseDouble(), and schIUScale.

◆ parseInternalUnits() [3/3]

int SCH_IO_KICAD_SEXPR_PARSER::parseInternalUnits ( TSCHEMATIC_T::T  aToken)
inlineprivate

Definition at line 143 of file sch_io_kicad_sexpr_parser.h.

References parseInternalUnits().

◆ parseJunction()

SCH_JUNCTION * SCH_IO_KICAD_SEXPR_PARSER::parseJunction ( )
private

Definition at line 3644 of file sch_io_kicad_sexpr_parser.cpp.

References color, parseDouble(), parseInt(), parseInternalUnits(), parseKIID(), and parseXY().

Referenced by ParseSchematic().

◆ parseKIID()

KIID SCH_IO_KICAD_SEXPR_PARSER::parseKIID ( )
private

Definition at line 115 of file sch_io_kicad_sexpr_parser.cpp.

References m_uuids.

Referenced by parseBusEntry(), parseImage(), parseJunction(), parseLine(), parseNoConnect(), ParseSchematic(), parseSchematicSymbol(), parseSchPolyLine(), parseSchSheetPin(), parseSchText(), and parseSheet().

◆ ParseLib()

void SCH_IO_KICAD_SEXPR_PARSER::ParseLib ( LIB_SYMBOL_MAP &  aSymbolLibMap)

Definition at line 177 of file sch_io_kicad_sexpr_parser.cpp.

References LIB_SYMBOL::GetName(), m_bodyStyle, m_generatorVersion, m_requiredVersion, m_unit, parseHeader(), parseLibSymbol(), and SEXPR_SYMBOL_LIB_FILE_VERSION.

Referenced by SCH_IO_KICAD_SEXPR_LIB_CACHE::Load().

◆ parseLibSymbol()

LIB_SYMBOL * SCH_IO_KICAD_SEXPR_PARSER::parseLibSymbol ( LIB_SYMBOL_MAP &  aSymbolLibMap)
private

Definition at line 297 of file sch_io_kicad_sexpr_parser.cpp.

References _, m_bodyStyle, m_fieldIDsRead, m_symbolName, m_unit, MANDATORY_FIELDS, name, LIB_ID::Parse(), parseBool(), EMBEDDED_FILES_PARSER::ParseEmbedded(), parsePinNames(), parsePinNumbers(), parseProperty(), ParseSymbolDrawItem(), EDA_ITEM::SetParent(), THROW_PARSE_ERROR, and IO_ERROR::What().

Referenced by ParseLib(), ParseSchematic(), and ParseSymbol().

◆ parseLine()

SCH_LINE * SCH_IO_KICAD_SEXPR_PARSER::parseLine ( )
private

Definition at line 3867 of file sch_io_kicad_sexpr_parser.cpp.

References DEFAULT_LINE_WIDTH_MILS, LAYER_BUS, LAYER_NOTES, LAYER_WIRE, EDA_IU_SCALE::MilsToIU(), parseKIID(), parseStroke(), parseXY(), and schIUScale.

Referenced by ParseSchematic().

◆ parseMargins()

void SCH_IO_KICAD_SEXPR_PARSER::parseMargins ( int &  aLeft,
int &  aTop,
int &  aRight,
int &  aBottom 
)
inlineprivate

Definition at line 184 of file sch_io_kicad_sexpr_parser.h.

References parseInternalUnits().

Referenced by parseSchTextBoxContent(), and parseSymbolTextBox().

◆ parseMaybeAbsentBool()

bool SCH_IO_KICAD_SEXPR_PARSER::parseMaybeAbsentBool ( bool  aDefaultValue)
private

Parses a boolean flag inside a list that existed before boolean normalization.

For example, this will handle both (legacy_teardrops) and (legacy_teardrops yes). Call this after parsing the T_legacy_teardrops, and aDefaultValue will be returned for the first case, or true will be returned for the second case.

Parameters
aDefaultValuewill be returned if the end of the list is encountered as the next token
Returns
the parsed boolean

Definition at line 146 of file sch_io_kicad_sexpr_parser.cpp.

References DSN_RIGHT.

Referenced by parseEDA_TEXT(), parseProperty(), parseSchematicSymbol(), parseSchField(), parseSchText(), and parseSheet().

◆ parseNoConnect()

SCH_NO_CONNECT * SCH_IO_KICAD_SEXPR_PARSER::parseNoConnect ( )
private

Definition at line 3700 of file sch_io_kicad_sexpr_parser.cpp.

References parseKIID(), and parseXY().

Referenced by ParseSchematic().

◆ parsePAGE_INFO()

void SCH_IO_KICAD_SEXPR_PARSER::parsePAGE_INFO ( PAGE_INFO &  aPageInfo)
private

Definition at line 2021 of file sch_io_kicad_sexpr_parser.cpp.

References _, PAGE_INFO::Custom, m_requiredVersion, MAX_PAGE_SIZE_EESCHEMA_MM, MIN_PAGE_SIZE_MM, parseDouble(), PAGE_INFO::SetHeightMM(), PAGE_INFO::SetPortrait(), PAGE_INFO::SetType(), PAGE_INFO::SetWidthMM(), and THROW_PARSE_ERROR.

Referenced by ParseSchematic().

◆ parsePinNames()

void SCH_IO_KICAD_SEXPR_PARSER::parsePinNames ( std::unique_ptr< LIB_SYMBOL > &  aSymbol)
private

(pin_names (offset 123) ; optional (hide yes/no) ; optional hide ; optional, pre-20241004 )

Definition at line 861 of file sch_io_kicad_sexpr_parser.cpp.

References parseBool(), and parseInternalUnits().

Referenced by parseLibSymbol().

◆ parsePinNumbers()

void SCH_IO_KICAD_SEXPR_PARSER::parsePinNumbers ( std::unique_ptr< LIB_SYMBOL > &  aSymbol)
private

(pin_numbers (hide yes/no) ; optional hide ; optional (pre-20241004) )

Definition at line 909 of file sch_io_kicad_sexpr_parser.cpp.

References parseBool().

Referenced by parseLibSymbol().

◆ parseProperty()

SCH_FIELD * SCH_IO_KICAD_SEXPR_PARSER::parseProperty ( std::unique_ptr< LIB_SYMBOL > &  aSymbol)
private

Definition at line 952 of file sch_io_kicad_sexpr_parser.cpp.

References _, DEGREES_T, GetCanonicalFieldName(), SCH_FIELD::GetCanonicalName(), m_fieldIDsRead, MANDATORY_FIELDS, name, parseDouble(), parseEDA_TEXT(), parseInt(), parseMaybeAbsentBool(), parseXY(), THROW_PARSE_ERROR, UnescapeString(), and VALUE_FIELD.

Referenced by parseLibSymbol().

◆ parseSchArc()

SCH_SHAPE * SCH_IO_KICAD_SEXPR_PARSER::parseSchArc ( )
private

Definition at line 3936 of file sch_io_kicad_sexpr_parser.cpp.

References DEFAULT_LINE_WIDTH_MILS, fixupSchFillMode(), FILL_PARAMS::m_Color, FILL_PARAMS::m_FillType, EDA_IU_SCALE::MilsToIU(), parseFill(), parseStroke(), parseXY(), and schIUScale.

Referenced by ParseSchematic().

◆ parseSchBezier()

SCH_SHAPE * SCH_IO_KICAD_SEXPR_PARSER::parseSchBezier ( )
private

Definition at line 4162 of file sch_io_kicad_sexpr_parser.cpp.

References DEFAULT_LINE_WIDTH_MILS, fixupSchFillMode(), FILL_PARAMS::m_Color, FILL_PARAMS::m_FillType, EDA_IU_SCALE::MilsToIU(), parseFill(), parseStroke(), parseXY(), and schIUScale.

Referenced by ParseSchematic().

◆ parseSchCircle()

SCH_SHAPE * SCH_IO_KICAD_SEXPR_PARSER::parseSchCircle ( )
private

Definition at line 4002 of file sch_io_kicad_sexpr_parser.cpp.

References DEFAULT_LINE_WIDTH_MILS, fixupSchFillMode(), FILL_PARAMS::m_Color, FILL_PARAMS::m_FillType, EDA_IU_SCALE::MilsToIU(), parseFill(), parseInternalUnits(), parseStroke(), parseXY(), schIUScale, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by ParseSchematic().

◆ ParseSchematic()

void SCH_IO_KICAD_SEXPR_PARSER::ParseSchematic ( SCH_SHEET *  aSheet,
bool  aIsCopyablyOnly = false,
int  aFileVersion = SEXPR_SCHEMATIC_FILE_VERSION 
)

Parse the internal LINE_READER object into aSheet.

When aIsCopyableOnly is true, only schematic objects that are viewable on the canvas for copy and paste purposes are parsed. Other schematic content such as bus definitions or instance data will throw an IO_ERROR exception.

When aIsCopyableOnly is false, full schematic file parsing is performed.

Note
This does not load any sub-sheets or decent complex sheet hierarchies.
Parameters
aSheetThe SCH_SHEET object to store the parsed schematic file.
aIsCopyableOnlyLoad only the schematic objects that can be copied into aSheet if true. Otherwise, load the full schematic file format.
aFileVersionThe schematic file version to parser. Defaults to the schematic file being parsed when aIsCopyableOnly is false.

Definition at line 2584 of file sch_io_kicad_sexpr_parser.cpp.

References _, SCH_SCREEN::AddLibSymbol(), SCH_SCREEN::Append(), checkpoint(), SHAPE_LINE_CHAIN::CPoint(), SCH_SCREEN::FixupEmbeddedData(), Fontconfig(), SCHEMATIC::GetEmbeddedFiles(), EMBEDDED_FILES::GetFontFiles(), EDA_SHAPE::GetPointCount(), EDA_SHAPE::GetPolyShape(), SCH_SHEET::GetScreen(), SCH_SHAPE::GetStroke(), SCH_SCREEN::GetUuid(), KI_FALLTHROUGH, LAYER_NOTES, m_generatorVersion, m_requiredVersion, m_rootSheet, m_rootUuid, SCH_SCREEN::m_uuid, EDA_ITEM::m_Uuid, SHAPE_POLY_SET::Outline(), parseBool(), parseBusAlias(), parseBusEntry(), EMBEDDED_FILES_PARSER::ParseEmbedded(), parseHeader(), parseImage(), parseJunction(), parseKIID(), parseLibSymbol(), parseLine(), parseNoConnect(), parsePAGE_INFO(), parseSchArc(), parseSchBezier(), parseSchCircle(), parseSchematicSymbol(), parseSchPolyLine(), parseSchRectangle(), parseSchRuleArea(), parseSchSheetInstances(), parseSchSymbolInstances(), parseSchTable(), parseSchText(), parseSchTextBox(), parseSheet(), parseTITLE_BLOCK(), Pgm(), SCH_SCREEN::Schematic(), EMBEDDED_FILES::SetAreFontsEmbedded(), SCH_LINE::SetEndPoint(), SCH_SCREEN::SetFileFormatVersionAtLoad(), SCH_SCREEN::SetLegacySymbolInstanceData(), SCH_SCREEN::SetPageSettings(), EDA_ITEM::SetParent(), SCH_LINE::SetStartPoint(), SCH_LINE::SetStroke(), SCH_SCREEN::SetTitleBlock(), SEXPR_SCHEMATIC_FILE_VERSION, THROW_PARSE_ERROR, LIB_SYMBOL::UpdateFieldOrdinals(), SCH_SCREEN::UpdateLocalLibSymbolLinks(), and IO_ERROR::What().

Referenced by SCH_IO_KICAD_SEXPR::LoadContent(), SCH_IO_KICAD_SEXPR::loadFile(), and KI_TEST::LoadSheetSchematicContents().

◆ parseSchematicSymbol()

SCH_SYMBOL * SCH_IO_KICAD_SEXPR_PARSER::parseSchematicSymbol ( )
private

Definition at line 2957 of file sch_io_kicad_sexpr_parser.cpp.

References _, AUTOPLACE_AUTO, AUTOPLACE_NONE, SCH_FIELD::GetCanonicalName(), SCH_FIELD::GetId(), EDA_TEXT::GetText(), m_fieldIDsRead, SCH_SYMBOL_INSTANCE::m_Path, SCH_SYMBOL_INSTANCE::m_ProjectName, SCH_SYMBOL_INSTANCE::m_Reference, m_requiredVersion, SCH_SYMBOL_INSTANCE::m_Unit, MANDATORY_FIELDS, name, LIB_ID::Parse(), parseBool(), parseDouble(), parseInt(), parseKIID(), parseMaybeAbsentBool(), parseSchField(), parseXY(), REFERENCE_FIELD, SCH_FIELD::SetId(), SIM_LEGACY_ENABLE_FIELD, SIM_LEGACY_ENABLE_FIELD_V7, SYM_MIRROR_X, SYM_MIRROR_Y, and THROW_PARSE_ERROR.

Referenced by ParseSchematic().

◆ parseSchField()

SCH_FIELD * SCH_IO_KICAD_SEXPR_PARSER::parseSchField ( SCH_ITEM *  aParent)
private

Definition at line 2177 of file sch_io_kicad_sexpr_parser.cpp.

References _, DEGREES_T, DO_TRANSLATE, GetCanonicalFieldName(), SCH_SHEET::GetDefaultFieldName(), MANDATORY_FIELDS, name, parseDouble(), parseEDA_TEXT(), parseInt(), parseMaybeAbsentBool(), parseXY(), SCH_SHEET_T, SCH_SYMBOL_T, SHEET_MANDATORY_FIELDS, SHEETFILENAME, SHEETNAME, THROW_PARSE_ERROR, EDA_ITEM::Type(), and VALUE_FIELD.

Referenced by parseSchematicSymbol(), parseSchText(), and parseSheet().

◆ parseSchPolyLine()

SCH_SHAPE * SCH_IO_KICAD_SEXPR_PARSER::parseSchPolyLine ( )
private

Definition at line 3801 of file sch_io_kicad_sexpr_parser.cpp.

References DEFAULT_LINE_WIDTH_MILS, fixupSchFillMode(), STROKE_PARAMS::GetLineStyle(), LAYER_NOTES, FILL_PARAMS::m_Color, FILL_PARAMS::m_FillType, m_requiredVersion, EDA_IU_SCALE::MilsToIU(), parseFill(), parseKIID(), parseStroke(), parseXY(), schIUScale, and STROKE_PARAMS::SetLineStyle().

Referenced by ParseSchematic(), and parseSchRuleArea().

◆ parseSchRectangle()

SCH_SHAPE * SCH_IO_KICAD_SEXPR_PARSER::parseSchRectangle ( )
private

Definition at line 4063 of file sch_io_kicad_sexpr_parser.cpp.

References DEFAULT_LINE_WIDTH_MILS, fixupSchFillMode(), FILL_PARAMS::m_Color, FILL_PARAMS::m_FillType, EDA_IU_SCALE::MilsToIU(), parseFill(), parseStroke(), parseXY(), and schIUScale.

Referenced by ParseSchematic().

◆ parseSchRuleArea()

SCH_RULE_AREA * SCH_IO_KICAD_SEXPR_PARSER::parseSchRuleArea ( )
private

Definition at line 4119 of file sch_io_kicad_sexpr_parser.cpp.

References DEFAULT_LINE_WIDTH_MILS, EDA_IU_SCALE::MilsToIU(), SHAPE_POLY_SET::Outline(), parseSchPolyLine(), schIUScale, and SHAPE_LINE_CHAIN::SetClosed().

Referenced by ParseSchematic().

◆ parseSchSheetInstances()

void SCH_IO_KICAD_SEXPR_PARSER::parseSchSheetInstances ( SCH_SHEET *  aRootSheet,
SCH_SCREEN *  aScreen 
)
private

Definition at line 2410 of file sch_io_kicad_sexpr_parser.cpp.

References SCH_SCREEN::GetFileFormatVersionAtLoad(), SCH_SHEET::GetScreen(), m_appending, SCH_SHEET_INSTANCE::m_PageNumber, SCH_SHEET_INSTANCE::m_Path, m_rootUuid, SCH_SCREEN::m_sheetInstances, SCH_SHEET_PATH::push_back(), BASE_SCREEN::SetContentModified(), and SCH_SHEET_PATH::SetPageNumber().

Referenced by ParseSchematic().

◆ parseSchSheetPin()

SCH_SHEET_PIN * SCH_IO_KICAD_SEXPR_PARSER::parseSchSheetPin ( SCH_SHEET *  aSheet)
private

Definition at line 2324 of file sch_io_kicad_sexpr_parser.cpp.

References _, name, parseDouble(), parseEDA_TEXT(), parseKIID(), parseXY(), and THROW_PARSE_ERROR.

Referenced by parseSheet().

◆ parseSchSymbolInstances()

void SCH_IO_KICAD_SEXPR_PARSER::parseSchSymbolInstances ( SCH_SCREEN *  aScreen)
private

Definition at line 2507 of file sch_io_kicad_sexpr_parser.cpp.

References m_appending, SCH_SYMBOL_INSTANCE::m_Footprint, SCH_SYMBOL_INSTANCE::m_Path, SCH_SYMBOL_INSTANCE::m_Reference, m_rootUuid, SCH_SCREEN::m_symbolInstances, SCH_SYMBOL_INSTANCE::m_Unit, SCH_SYMBOL_INSTANCE::m_Value, NilUuid(), and parseInt().

Referenced by ParseSchematic().

◆ parseSchTable()

SCH_TABLE * SCH_IO_KICAD_SEXPR_PARSER::parseSchTable ( )
private

Definition at line 4565 of file sch_io_kicad_sexpr_parser.cpp.

References DEFAULT_LINE_WIDTH_MILS, EDA_IU_SCALE::MilsToIU(), parseBool(), parseInt(), parseInternalUnits(), parseSchTableCell(), parseStroke(), and schIUScale.

Referenced by ParseSchematic().

◆ parseSchTableCell()

SCH_TABLECELL * SCH_IO_KICAD_SEXPR_PARSER::parseSchTableCell ( )
private

Definition at line 4421 of file sch_io_kicad_sexpr_parser.cpp.

References parseSchTextBoxContent().

Referenced by parseSchTable().

◆ parseSchText()

SCH_TEXT * SCH_IO_KICAD_SEXPR_PARSER::parseSchText ( )
private

Definition at line 4238 of file sch_io_kicad_sexpr_parser.cpp.

References AUTOPLACE_AUTO, AUTOPLACE_NONE, SPIN_STYLE::BOTTOM, DEGREES_T, SCH_LABEL_BASE::GetFields(), SCH_FIELD::GetInternalName(), SPIN_STYLE::LEFT, parseBool(), parseDouble(), parseEDA_TEXT(), parseInternalUnits(), parseKIID(), parseMaybeAbsentBool(), parseSchField(), parseXY(), SPIN_STYLE::RIGHT, SCH_DIRECTIVE_LABEL_T, SCH_GLOBAL_LABEL_T, SCH_LABEL_T, SCH_TEXT_T, SCH_ITEM::SetFieldsAutoplaced(), SCH_FIELD::SetId(), SCH_DIRECTIVE_LABEL::SetPinLength(), SCH_LABEL_BASE::SetShape(), EDA_TEXT::SetTextPos(), EDA_TEXT::SetVisible(), text, and SPIN_STYLE::UP.

Referenced by ParseSchematic().

◆ parseSchTextBox()

SCH_TEXTBOX * SCH_IO_KICAD_SEXPR_PARSER::parseSchTextBox ( )
private

Definition at line 4408 of file sch_io_kicad_sexpr_parser.cpp.

References parseSchTextBoxContent().

Referenced by ParseSchematic().

◆ parseSchTextBoxContent()

void SCH_IO_KICAD_SEXPR_PARSER::parseSchTextBoxContent ( SCH_TEXTBOX *  aTextBox)
private

Definition at line 4434 of file sch_io_kicad_sexpr_parser.cpp.

References DEFAULT_LINE_WIDTH_MILS, DEGREES_T, fixupSchFillMode(), SCH_TEXTBOX::GetLegacyTextMargin(), left, FILL_PARAMS::m_Color, FILL_PARAMS::m_FillType, EDA_ITEM::m_Uuid, EDA_IU_SCALE::MilsToIU(), parseBool(), parseDouble(), parseEDA_TEXT(), parseFill(), parseInt(), parseMargins(), parseStroke(), parseXY(), right, schIUScale, EDA_SHAPE::SetEnd(), SCH_TEXTBOX::SetExcludedFromSim(), EDA_SHAPE::SetFillColor(), EDA_SHAPE::SetFillMode(), SCH_TEXTBOX::SetMarginBottom(), SCH_TEXTBOX::SetMarginLeft(), SCH_TEXTBOX::SetMarginRight(), SCH_TEXTBOX::SetMarginTop(), SCH_SHAPE::SetPosition(), SCH_SHAPE::SetStroke(), EDA_TEXT::SetText(), and EDA_TEXT::SetTextAngle().

Referenced by parseSchTableCell(), and parseSchTextBox().

◆ parseSheet()

SCH_SHEET * SCH_IO_KICAD_SEXPR_PARSER::parseSheet ( )
private

Definition at line 3428 of file sch_io_kicad_sexpr_parser.cpp.

References AUTOPLACE_AUTO, AUTOPLACE_NONE, DEFAULT_LINE_WIDTH_MILS, STROKE_PARAMS::GetColor(), SCH_FIELD::GetId(), STROKE_PARAMS::GetWidth(), FILL_PARAMS::m_Color, SCH_SHEET_INSTANCE::m_PageNumber, SCH_SHEET_INSTANCE::m_Path, SCH_SHEET_INSTANCE::m_ProjectName, m_requiredVersion, EDA_IU_SCALE::MilsToIU(), parseBool(), parseFill(), parseInternalUnits(), parseKIID(), parseMaybeAbsentBool(), parseSchField(), parseSchSheetPin(), parseStroke(), parseXY(), schIUScale, SCH_FIELD::SetId(), SHEET_MANDATORY_FIELDS, SHEETFILENAME, SHEETNAME, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by ParseSchematic().

◆ parseStroke()

void SCH_IO_KICAD_SEXPR_PARSER::parseStroke ( STROKE_PARAMS &  aStroke)
private

Parse stroke definition aStroke.

Parameters
aStrokeDefA reference to the STROKE_PARAMS structure to write to.

Definition at line 637 of file sch_io_kicad_sexpr_parser.cpp.

References EDA_IU_SCALE::IU_PER_MM, STROKE_PARAMS_PARSER::ParseStroke(), and schIUScale.

Referenced by parseBusEntry(), parseLine(), parseSchArc(), parseSchBezier(), parseSchCircle(), parseSchPolyLine(), parseSchRectangle(), parseSchTable(), parseSchTextBoxContent(), parseSheet(), parseSymbolArc(), parseSymbolBezier(), parseSymbolCircle(), parseSymbolPolyLine(), parseSymbolRectangle(), and parseSymbolTextBox().

◆ ParseSymbol()

LIB_SYMBOL * SCH_IO_KICAD_SEXPR_PARSER::ParseSymbol ( LIB_SYMBOL_MAP &  aSymbolLibMap,
int  aFileVersion = SEXPR_SYMBOL_LIB_FILE_VERSION 
)

Parse internal LINE_READER object into symbols and return all found.

Definition at line 258 of file sch_io_kicad_sexpr_parser.cpp.

References _, LIB_SYMBOL::GetEmbeddedFiles(), m_requiredVersion, parseLibSymbol(), LIB_SYMBOL::RunOnChildren(), THROW_PARSE_ERROR, and EMBEDDED_FILES::UpdateFontFiles().

Referenced by SCH_IO_KICAD_SEXPR::ParseLibSymbols().

◆ parseSymbolArc()

SCH_SHAPE * SCH_IO_KICAD_SEXPR_PARSER::parseSymbolArc ( )
private

Definition at line 1162 of file sch_io_kicad_sexpr_parser.cpp.

References ANGLE_0, ANGLE_180, ANGLE_360, ANGLE_90, CalcArcCenter(), DEFAULT_LINE_WIDTH_MILS, DEGREES_T, LAYER_DEVICE, m_bodyStyle, FILL_PARAMS::m_Color, FILL_PARAMS::m_FillType, m_requiredVersion, m_unit, EDA_IU_SCALE::MilsToIU(), EDA_ANGLE::Normalize(), parseDouble(), parseFill(), parseInternalUnits(), parseStroke(), parseXY(), and schIUScale.

Referenced by ParseSymbolDrawItem().

◆ parseSymbolBezier()

SCH_SHAPE * SCH_IO_KICAD_SEXPR_PARSER::parseSymbolBezier ( )
private

Definition at line 1349 of file sch_io_kicad_sexpr_parser.cpp.

References DEFAULT_LINE_WIDTH_MILS, LAYER_DEVICE, m_bodyStyle, FILL_PARAMS::m_Color, FILL_PARAMS::m_FillType, m_unit, EDA_IU_SCALE::MilsToIU(), parseFill(), parseStroke(), parseXY(), and schIUScale.

Referenced by ParseSymbolDrawItem().

◆ parseSymbolCircle()

SCH_SHAPE * SCH_IO_KICAD_SEXPR_PARSER::parseSymbolCircle ( )
private

Definition at line 1430 of file sch_io_kicad_sexpr_parser.cpp.

References DEFAULT_LINE_WIDTH_MILS, LAYER_DEVICE, m_bodyStyle, FILL_PARAMS::m_Color, FILL_PARAMS::m_FillType, m_unit, EDA_IU_SCALE::MilsToIU(), parseFill(), parseInternalUnits(), parseStroke(), parseXY(), schIUScale, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by ParseSymbolDrawItem().

◆ ParseSymbolDrawItem()

SCH_ITEM * SCH_IO_KICAD_SEXPR_PARSER::ParseSymbolDrawItem ( )

Definition at line 595 of file sch_io_kicad_sexpr_parser.cpp.

References parseSymbolArc(), parseSymbolBezier(), parseSymbolCircle(), parseSymbolPin(), parseSymbolPolyLine(), parseSymbolRectangle(), parseSymbolText(), and parseSymbolTextBox().

Referenced by parseLibSymbol().

◆ parseSymbolPin()

SCH_PIN * SCH_IO_KICAD_SEXPR_PARSER::parseSymbolPin ( )
private

Definition at line 1496 of file sch_io_kicad_sexpr_parser.cpp.

References _, ConvertToNewOverbarNotation(), m_bodyStyle, SCH_PIN::ALT::m_Name, m_requiredVersion, SCH_PIN::ALT::m_Shape, SCH_PIN::ALT::m_Type, m_unit, parseBool(), parseEDA_TEXT(), parseInt(), parseInternalUnits(), parseXY(), pin, schIUScale, text, and THROW_PARSE_ERROR.

Referenced by ParseSymbolDrawItem().

◆ parseSymbolPolyLine()

SCH_SHAPE * SCH_IO_KICAD_SEXPR_PARSER::parseSymbolPolyLine ( )
private

Definition at line 1714 of file sch_io_kicad_sexpr_parser.cpp.

References DEFAULT_LINE_WIDTH_MILS, LAYER_DEVICE, m_bodyStyle, FILL_PARAMS::m_Color, FILL_PARAMS::m_FillType, m_unit, EDA_IU_SCALE::MilsToIU(), parseFill(), parseStroke(), parseXY(), and schIUScale.

Referenced by ParseSymbolDrawItem().

◆ parseSymbolRectangle()

SCH_SHAPE * SCH_IO_KICAD_SEXPR_PARSER::parseSymbolRectangle ( )
private

Definition at line 1782 of file sch_io_kicad_sexpr_parser.cpp.

References DEFAULT_LINE_WIDTH_MILS, LAYER_DEVICE, m_bodyStyle, FILL_PARAMS::m_Color, FILL_PARAMS::m_FillType, m_unit, EDA_IU_SCALE::MilsToIU(), parseFill(), parseStroke(), parseXY(), and schIUScale.

Referenced by ParseSymbolDrawItem().

◆ parseSymbolText()

SCH_TEXT * SCH_IO_KICAD_SEXPR_PARSER::parseSymbolText ( )
private

Definition at line 1842 of file sch_io_kicad_sexpr_parser.cpp.

References _, LAYER_DEVICE, m_bodyStyle, m_unit, parseDouble(), parseEDA_TEXT(), parseXY(), TENTHS_OF_A_DEGREE_T, text, and THROW_PARSE_ERROR.

Referenced by ParseSymbolDrawItem().

◆ parseSymbolTextBox()

SCH_TEXTBOX * SCH_IO_KICAD_SEXPR_PARSER::parseSymbolTextBox ( )
private

Definition at line 1898 of file sch_io_kicad_sexpr_parser.cpp.

References _, DEFAULT_LINE_WIDTH_MILS, DEGREES_T, LAYER_DEVICE, left, m_bodyStyle, FILL_PARAMS::m_Color, FILL_PARAMS::m_FillType, m_unit, EDA_IU_SCALE::MilsToIU(), parseDouble(), parseEDA_TEXT(), parseFill(), parseMargins(), parseStroke(), parseXY(), right, schIUScale, and THROW_PARSE_ERROR.

Referenced by ParseSymbolDrawItem().

◆ parseTITLE_BLOCK()

void SCH_IO_KICAD_SEXPR_PARSER::parseTITLE_BLOCK ( TITLE_BLOCK &  aTitleBlock)
private

Definition at line 2073 of file sch_io_kicad_sexpr_parser.cpp.

References _, parseInt(), TITLE_BLOCK::SetComment(), TITLE_BLOCK::SetCompany(), TITLE_BLOCK::SetDate(), TITLE_BLOCK::SetRevision(), TITLE_BLOCK::SetTitle(), and THROW_PARSE_ERROR.

Referenced by ParseSchematic().

◆ parseXY()

VECTOR2I SCH_IO_KICAD_SEXPR_PARSER::parseXY ( bool  aInvertY = false)
inlineprivate

Definition at line 148 of file sch_io_kicad_sexpr_parser.h.

References parseInternalUnits(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by parseBusEntry(), parseImage(), parseJunction(), parseLine(), parseNoConnect(), parseProperty(), parseSchArc(), parseSchBezier(), parseSchCircle(), parseSchematicSymbol(), parseSchField(), parseSchPolyLine(), parseSchRectangle(), parseSchSheetPin(), parseSchText(), parseSchTextBoxContent(), parseSheet(), parseSymbolArc(), parseSymbolBezier(), parseSymbolCircle(), parseSymbolPin(), parseSymbolPolyLine(), parseSymbolRectangle(), parseSymbolText(), and parseSymbolTextBox().

Member Data Documentation

◆ m_appending

bool SCH_IO_KICAD_SEXPR_PARSER::m_appending
private

Appending load status.

Definition at line 241 of file sch_io_kicad_sexpr_parser.h.

Referenced by parseSchSheetInstances(), and parseSchSymbolInstances().

◆ m_bodyStyle

int SCH_IO_KICAD_SEXPR_PARSER::m_bodyStyle
private

The current body style being parsed.

Definition at line 239 of file sch_io_kicad_sexpr_parser.h.

Referenced by ParseLib(), parseLibSymbol(), parseSymbolArc(), parseSymbolBezier(), parseSymbolCircle(), parseSymbolPin(), parseSymbolPolyLine(), parseSymbolRectangle(), parseSymbolText(), and parseSymbolTextBox().

◆ m_fieldIDsRead

std::set<int> SCH_IO_KICAD_SEXPR_PARSER::m_fieldIDsRead
private

Field IDs that have been read so far for the current symbol.

Definition at line 244 of file sch_io_kicad_sexpr_parser.h.

Referenced by parseLibSymbol(), parseProperty(), and parseSchematicSymbol().

◆ m_generatorVersion

wxString SCH_IO_KICAD_SEXPR_PARSER::m_generatorVersion
private

Definition at line 237 of file sch_io_kicad_sexpr_parser.h.

Referenced by ParseLib(), and ParseSchematic().

◆ m_lastProgressLine

unsigned SCH_IO_KICAD_SEXPR_PARSER::m_lastProgressLine
private

Definition at line 250 of file sch_io_kicad_sexpr_parser.h.

Referenced by checkpoint().

◆ m_lineCount

unsigned SCH_IO_KICAD_SEXPR_PARSER::m_lineCount
private

Definition at line 251 of file sch_io_kicad_sexpr_parser.h.

Referenced by checkpoint().

◆ m_lineReader

const LINE_READER* SCH_IO_KICAD_SEXPR_PARSER::m_lineReader
private

Definition at line 249 of file sch_io_kicad_sexpr_parser.h.

Referenced by checkpoint().

◆ m_progressReporter

PROGRESS_REPORTER* SCH_IO_KICAD_SEXPR_PARSER::m_progressReporter
private

Definition at line 248 of file sch_io_kicad_sexpr_parser.h.

Referenced by checkpoint().

◆ m_requiredVersion

int SCH_IO_KICAD_SEXPR_PARSER::m_requiredVersion
private

Set to the symbol library file version required.

Definition at line 236 of file sch_io_kicad_sexpr_parser.h.

Referenced by GetParsedRequiredVersion(), parseBusAlias(), parseEDA_TEXT(), parseHeader(), parseImage(), ParseLib(), parsePAGE_INFO(), ParseSchematic(), parseSchematicSymbol(), parseSchPolyLine(), parseSheet(), ParseSymbol(), parseSymbolArc(), and parseSymbolPin().

◆ m_rootSheet

SCH_SHEET* SCH_IO_KICAD_SEXPR_PARSER::m_rootSheet
private

The rootsheet for full project loads or null for importing a schematic.

Definition at line 256 of file sch_io_kicad_sexpr_parser.h.

Referenced by ParseSchematic().

◆ m_rootUuid

KIID SCH_IO_KICAD_SEXPR_PARSER::m_rootUuid
private

Definition at line 253 of file sch_io_kicad_sexpr_parser.h.

Referenced by ParseSchematic(), parseSchSheetInstances(), and parseSchSymbolInstances().

◆ m_symbolName

wxString SCH_IO_KICAD_SEXPR_PARSER::m_symbolName
private

The current symbol name.

Definition at line 240 of file sch_io_kicad_sexpr_parser.h.

Referenced by parseLibSymbol().

◆ m_unit

int SCH_IO_KICAD_SEXPR_PARSER::m_unit
private

The current unit being parsed.

Definition at line 238 of file sch_io_kicad_sexpr_parser.h.

Referenced by ParseLib(), parseLibSymbol(), parseSymbolArc(), parseSymbolBezier(), parseSymbolCircle(), parseSymbolPin(), parseSymbolPolyLine(), parseSymbolRectangle(), parseSymbolText(), and parseSymbolTextBox().

◆ m_uuids

std::set<KIID> SCH_IO_KICAD_SEXPR_PARSER::m_uuids
private

Definition at line 246 of file sch_io_kicad_sexpr_parser.h.

Referenced by parseKIID().

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