Represents a CADSTAR Schematic Archive (*.csa) file. More...

#include <cadstar_sch_archive_parser.h>

Inheritance diagram for CADSTAR_SCH_ARCHIVE_PARSER:

Classes
struct	ASSIGNMENTS_SCM

struct	BLOCK

struct	BUS

struct	CADSTAR_SCHEMATIC

struct	CODEDEFS_SCM

struct	COMP

struct	LIBRARY_SCM

struct	NET_SCH

struct	PARTREF

struct	PIN_NUM_LABEL_LOC

struct	SHEETS

struct	SIGLOC
	Net name or bus name label. More...

struct	SIGNALREFERENCELINK

struct	SYMBOL

struct	SYMBOLVARIANT

struct	SYMDEF_SCM

struct	SYMPINNAME_LABEL

struct	TERMATTR

struct	TERMINAL

struct	TERMINAL_SHAPE

struct	TERMINALCODE

Public Types
enum class	TERMINAL_SHAPE_TYPE { ANNULUS , BOX , BULLET , CIRCLE , CROSS , DIAMOND , FINGER , OCTAGON , PLUS , POINTER , RECTANGLE , ROUNDED_RECT , SQUARE , STAR , TRIANGLE , UNDEFINED }

typedef wxString	TERMINALCODE_ID

typedef wxString	SYMBOL_ID

typedef wxString	BUS_ID

typedef wxString	BLOCK_ID

typedef wxString	SHEET_NAME

enum class	TEXT_FIELD_NAME { DESIGN_TITLE , SHORT_JOBNAME , LONG_JOBNAME , NUM_OF_SHEETS , SHEET_NUMBER , SHEET_NAME , VARIANT_NAME , VARIANT_DESCRIPTION , REG_USER , COMPANY_NAME , CURRENT_USER , DATE , TIME , MACHINE_NAME , FROM_FILE , DISTANCE , UNITS_SHORT , UNITS_ABBREV , UNITS_FULL , HYPERLINK , NONE }
	These are special fields in text objects enclosed between the tokens '<@' and '>' such as <@[FIELD_NAME][FIELD_VALUE]>. More...

enum class	RESOLUTION { HUNDREDTH_MICRON }

enum class	LINESTYLE { SOLID , DASH , DASHDOT , DASHDOTDOT , DOT }

enum class	VERTEX_TYPE { POINT , CLOCKWISE_ARC , CLOCKWISE_SEMICIRCLE , ANTICLOCKWISE_ARC , ANTICLOCKWISE_SEMICIRCLE }

enum class	SHAPE_TYPE { OPENSHAPE , OUTLINE , SOLID , HATCHED }

enum class	UNITS { DESIGN , THOU , INCH , MICROMETRE , MM , CENTIMETER , METER }

enum class	ANGUNITS { DEGREES , RADIANS }

enum class	GRID_TYPE { FRACTIONALGRID , STEPGRID }

enum class	ALIGNMENT { NO_ALIGNMENT , TOPLEFT , TOPCENTER , TOPRIGHT , CENTERLEFT , CENTERCENTER , CENTERRIGHT , BOTTOMLEFT , BOTTOMCENTER , BOTTOMRIGHT }
	From CADSTAR Help: "Text Alignment enables you to define the position of an alignment origin for all text items in CADSTAR. More...

enum class	JUSTIFICATION { LEFT , CENTER , RIGHT }
	From CADSTAR Help: "Multi Line Text can also be justified as Left, Centre or Right. More...

enum class	READABILITY { BOTTOM_TO_TOP , TOP_TO_BOTTOM }
	Sets the readability direction of text. More...

enum class	ATTROWNER { ALL_ITEMS , AREA , BOARD , COMPONENT , CONNECTION , COPPER , DOCSYMBOL , FIGURE , NET , NETCLASS , PART , PART_DEFINITION , PIN , SIGNALREF , SYMBOL , SYMDEF , TEMPLATE , TESTPOINT }

enum class	ATTRUSAGE { BOTH , COMPONENT , PART_DEFINITION , PART_LIBRARY , SYMBOL , UNDEFINED }

enum class	SWAP_RULE { NO_SWAP , USE_SWAP_LAYER , BOTH }
	Corresponds to "Display when" Item property. More...

typedef wxString	LINECODE_ID

typedef wxString	HATCHCODE_ID

typedef wxString	ROUTECODE_ID

typedef wxString	NETCLASS_ID

typedef wxString	SPACING_CLASS_ID

typedef wxString	TEXTCODE_ID

typedef wxString	LAYER_ID
	ID of a Sheet (if schematic) or board Layer (if PCB) More...

typedef wxString	VARIANT_ID

typedef wxString	ATTRIBUTE_ID

typedef wxString	SYMDEF_ID

typedef wxString	PART_ID

typedef wxString	GATE_ID

typedef long	TERMINAL_ID
	Terminal is the pin identifier in the schematic. More...

typedef long	PART_DEFINITION_PIN_ID
	Pin identifier in the part definition. More...

typedef long	PART_PIN_ID
	Pin identifier in the part. More...

typedef wxString	TEXT_ID

typedef wxString	FIGURE_ID

typedef wxString	GROUP_ID

typedef wxString	REUSEBLOCK_ID

typedef wxString	NET_ID

typedef wxString	NETELEMENT_ID

typedef wxString	DOCUMENTATION_SYMBOL_ID

typedef wxString	COLOR_ID

Public Member Functions
	CADSTAR_SCH_ARCHIVE_PARSER (wxString aFilename)

virtual	~CADSTAR_SCH_ARCHIVE_PARSER ()

void	Parse ()
	Parses the file. More...

Static Public Member Functions
static TERMINAL_SHAPE_TYPE	ParseTermShapeType (const wxString &aShapeStr)

static wxString	ParseTextFields (const wxString &aTextString, PARSER_CONTEXT *aParserContext)
	Replaces CADSTAR fields for the equivalent in KiCad and stores the field values in aParserContext. More...

static UNITS	ParseUnits (XNODE *aNode)

static ANGUNITS	ParseAngunits (XNODE *aNode)

static ALIGNMENT	ParseAlignment (XNODE *aNode)

static JUSTIFICATION	ParseJustification (XNODE *aNode)

static READABILITY	ParseReadability (XNODE *aNode)

static SWAP_RULE	ParseSwapRule (XNODE *aNode)

static void	InsertAttributeAtEnd (XNODE *aNode, wxString aValue)

static XNODE *	LoadArchiveFile (const wxString &aFileName, const wxString &aFileTypeIdentifier, PROGRESS_REPORTER *aProgressReporter=nullptr)
	Reads a CADSTAR Archive file (S-parameter format) More...

static bool	IsValidAttribute (wxXmlAttribute *aAttribute)

static wxString	GetXmlAttributeIDString (XNODE *aNode, unsigned int aID, bool aIsRequired=true)

static long	GetXmlAttributeIDLong (XNODE *aNode, unsigned int aID, bool aIsRequired=true)

static void	CheckNoChildNodes (XNODE *aNode)

static void	CheckNoNextNodes (XNODE *aNode)

static void	ParseChildEValue (XNODE aNode, PARSER_CONTEXT aContext, EVALUE &aValueToParse)

static std::vector< POINT >	ParseAllChildPoints (XNODE aNode, PARSER_CONTEXT aContext, bool aTestAllChildNodes=false, int aExpectedNumPoints=UNDEFINED_VALUE)
	if no children are present, it just returns an empty vector (without throwing an exception) More...

static std::vector< VERTEX >	ParseAllChildVertices (XNODE aNode, PARSER_CONTEXT aContext, bool aTestAllChildNodes=false)
	if no children are present, it just returns an empty vector (without throwing an exception) More...

static std::vector< CUTOUT >	ParseAllChildCutouts (XNODE aNode, PARSER_CONTEXT aContext, bool aTestAllChildNodes=false)
	if no children are present, it just returns an empty vector (without throwing an exception) More...

static long	GetNumberOfChildNodes (XNODE *aNode)

static long	GetNumberOfStepsForReporting (XNODE *aRootNode, std::vector< wxString > aSubNodeChildrenToCount)

static wxString	HandleTextOverbar (wxString aCadstarString)
	Convert a string with CADSTAR overbar characters to equivalent in KiCad. More...

static void	FixTextPositionNoAlignment (EDA_TEXT *aKiCadTextItem)
	Corrects the position of a text element that had NO_ALIGNMENT in CADSTAR. More...

static wxString	generateLibName (const wxString &aRefName, const wxString &aAlternateName)

Public Attributes
wxString	Filename

HEADER	Header

ASSIGNMENTS_SCM	Assignments

LIBRARY_SCM	Library

PARTS	Parts

SHEETS	Sheets

CADSTAR_SCHEMATIC	Schematic

ATTRCOLORS	AttrColors

PARTNAMECOL	SymbolPartNameColor

int	KiCadUnitDivider
	Use this value to convert units in this CSA file to KiCad units. More...

Static Public Attributes
static const long	UNDEFINED_VALUE = -1

static const double	TXT_HEIGHT_RATIO = ( 24.0 - 5.0 ) / 24.0
	CADSTAR fonts are drawn on a 24x24 integer matrix, where the each axis goes from 0 to 24. More...

static const std::map< TEXT_FIELD_NAME, wxString >	CADSTAR_TO_KICAD_FIELDS
	Map between CADSTAR fields and KiCad text variables. More...

static const long	FONT_NORMAL = 400

static const long	FONT_BOLD = 700

Protected Member Functions
void	checkPoint ()
	Updates m_progressReporter or throws if user cancelled. More...

Protected Attributes
PARSER_CONTEXT	m_context

PROGRESS_REPORTER *	m_progressReporter

Private Attributes
XNODE *	m_rootNode

Detailed Description

Represents a CADSTAR Schematic Archive (*.csa) file.

Definition at line 35 of file cadstar_sch_archive_parser.h.

Member Typedef Documentation

◆ ATTRIBUTE_ID

typedef wxString CADSTAR_ARCHIVE_PARSER::ATTRIBUTE_ID

inherited

Definition at line 107 of file cadstar_archive_parser.h.

◆ BLOCK_ID

typedef wxString CADSTAR_SCH_ARCHIVE_PARSER::BLOCK_ID

Definition at line 61 of file cadstar_sch_archive_parser.h.

◆ BUS_ID

typedef wxString CADSTAR_SCH_ARCHIVE_PARSER::BUS_ID

Definition at line 60 of file cadstar_sch_archive_parser.h.

◆ COLOR_ID

typedef wxString CADSTAR_ARCHIVE_PARSER::COLOR_ID

inherited

Definition at line 121 of file cadstar_archive_parser.h.

◆ DOCUMENTATION_SYMBOL_ID

typedef wxString CADSTAR_ARCHIVE_PARSER::DOCUMENTATION_SYMBOL_ID

inherited

Definition at line 120 of file cadstar_archive_parser.h.

◆ FIGURE_ID

typedef wxString CADSTAR_ARCHIVE_PARSER::FIGURE_ID

inherited

Definition at line 115 of file cadstar_archive_parser.h.

◆ GATE_ID

typedef wxString CADSTAR_ARCHIVE_PARSER::GATE_ID

inherited

Definition at line 110 of file cadstar_archive_parser.h.

◆ GROUP_ID

typedef wxString CADSTAR_ARCHIVE_PARSER::GROUP_ID

inherited

Definition at line 116 of file cadstar_archive_parser.h.

◆ HATCHCODE_ID

typedef wxString CADSTAR_ARCHIVE_PARSER::HATCHCODE_ID

inherited

Definition at line 100 of file cadstar_archive_parser.h.

◆ LAYER_ID

typedef wxString CADSTAR_ARCHIVE_PARSER::LAYER_ID

inherited

ID of a Sheet (if schematic) or board Layer (if PCB)

Definition at line 105 of file cadstar_archive_parser.h.

◆ LINECODE_ID

typedef wxString CADSTAR_ARCHIVE_PARSER::LINECODE_ID

inherited

Definition at line 99 of file cadstar_archive_parser.h.

◆ NET_ID

typedef wxString CADSTAR_ARCHIVE_PARSER::NET_ID

inherited

Definition at line 118 of file cadstar_archive_parser.h.

◆ NETCLASS_ID

typedef wxString CADSTAR_ARCHIVE_PARSER::NETCLASS_ID

inherited

Definition at line 102 of file cadstar_archive_parser.h.

◆ NETELEMENT_ID

typedef wxString CADSTAR_ARCHIVE_PARSER::NETELEMENT_ID

inherited

Definition at line 119 of file cadstar_archive_parser.h.

◆ PART_DEFINITION_PIN_ID

typedef long CADSTAR_ARCHIVE_PARSER::PART_DEFINITION_PIN_ID

inherited

Pin identifier in the part definition.

Definition at line 112 of file cadstar_archive_parser.h.

◆ PART_ID

typedef wxString CADSTAR_ARCHIVE_PARSER::PART_ID

inherited

Definition at line 109 of file cadstar_archive_parser.h.

◆ PART_PIN_ID

typedef long CADSTAR_ARCHIVE_PARSER::PART_PIN_ID

inherited

Pin identifier in the part.

Definition at line 113 of file cadstar_archive_parser.h.

◆ REUSEBLOCK_ID

typedef wxString CADSTAR_ARCHIVE_PARSER::REUSEBLOCK_ID

inherited

Definition at line 117 of file cadstar_archive_parser.h.

◆ ROUTECODE_ID

typedef wxString CADSTAR_ARCHIVE_PARSER::ROUTECODE_ID

inherited

Definition at line 101 of file cadstar_archive_parser.h.

◆ SHEET_NAME

typedef wxString CADSTAR_SCH_ARCHIVE_PARSER::SHEET_NAME

Definition at line 62 of file cadstar_sch_archive_parser.h.

◆ SPACING_CLASS_ID

typedef wxString CADSTAR_ARCHIVE_PARSER::SPACING_CLASS_ID

inherited

Definition at line 103 of file cadstar_archive_parser.h.

◆ SYMBOL_ID

typedef wxString CADSTAR_SCH_ARCHIVE_PARSER::SYMBOL_ID

Definition at line 59 of file cadstar_sch_archive_parser.h.

◆ SYMDEF_ID

typedef wxString CADSTAR_ARCHIVE_PARSER::SYMDEF_ID

inherited

Definition at line 108 of file cadstar_archive_parser.h.

◆ TERMINAL_ID

typedef long CADSTAR_ARCHIVE_PARSER::TERMINAL_ID

inherited

Terminal is the pin identifier in the schematic.

Definition at line 111 of file cadstar_archive_parser.h.

◆ TERMINALCODE_ID

typedef wxString CADSTAR_SCH_ARCHIVE_PARSER::TERMINALCODE_ID

Definition at line 58 of file cadstar_sch_archive_parser.h.

◆ TEXT_ID

typedef wxString CADSTAR_ARCHIVE_PARSER::TEXT_ID

inherited

Definition at line 114 of file cadstar_archive_parser.h.

◆ TEXTCODE_ID

typedef wxString CADSTAR_ARCHIVE_PARSER::TEXTCODE_ID

inherited

Definition at line 104 of file cadstar_archive_parser.h.

◆ VARIANT_ID

typedef wxString CADSTAR_ARCHIVE_PARSER::VARIANT_ID

inherited

Definition at line 106 of file cadstar_archive_parser.h.

Member Enumeration Documentation

◆ ALIGNMENT

enum class CADSTAR_ARCHIVE_PARSER::ALIGNMENT

stronginherited

From CADSTAR Help: "Text Alignment enables you to define the position of an alignment origin for all text items in CADSTAR.

The alignment origin is a point on or within the text boundary and defines how the text is displayed.

For example, with an alignment of bottom-right the origin will be positioned at the bottom right of the text boundary. This makes it easier to right-align several text items regardless of the length of text displayed.

Text Alignment applies to all CADSTAR text. [...]

Note: Unaligned text operates in the way CADSTAR text always has. In most cases this behaves as Bottom Left alignment, but there are a few exceptions, e.g. pin names. Also unaligned multiline text has an origin Bottom Left of the first line."

◆ ANGUNITS

enum class CADSTAR_ARCHIVE_PARSER::ANGUNITS

stronginherited

Enumerator
DEGREES
RADIANS

Definition at line 518 of file cadstar_archive_parser.h.

 {
 DEGREES,
 RADIANS
 };

◆ ATTROWNER

enum class CADSTAR_ARCHIVE_PARSER::ATTROWNER

stronginherited

Enumerator
ALL_ITEMS
AREA
BOARD
COMPONENT
CONNECTION
COPPER
DOCSYMBOL
FIGURE
NET
NETCLASS
PART	Only library Attributes.
PART_DEFINITION	Only library Attributes.
PIN
SIGNALREF
SYMBOL
SYMDEF
TEMPLATE
TESTPOINT

Definition at line 662 of file cadstar_archive_parser.h.

 {
 ALL_ITEMS,
 AREA,
 BOARD,
 COMPONENT,
 CONNECTION,
 COPPER,
 DOCSYMBOL,
 FIGURE,
 NET,
 NETCLASS,
 PART, 
 PART_DEFINITION, 
 PIN,
 SIGNALREF,
 SYMBOL,
 SYMDEF,
 TEMPLATE,
 TESTPOINT
 };

◆ ATTRUSAGE

enum class CADSTAR_ARCHIVE_PARSER::ATTRUSAGE

stronginherited

Enumerator
BOTH	From CADSTAR Help: Assigned to both Schematic symbols and PCB components, and displayed on Schematic and PCB designs.
COMPONENT	From CADSTAR Help: Assigned to PCB components and displayed on PCB designs.
PART_DEFINITION	From CADSTAR Help: Assigned to Parts library Definitions and displayed by the Library searcher.
PART_LIBRARY	From CADSTAR Help: Only used by non-Cadstar applications.
SYMBOL	From CADSTAR Help: Assigned to Schematic Symbols and displayed on Schematic Designs.
UNDEFINED	Note: It seems that some attribute have no "ATTRUSAGE" defined. It appears that the attributes that fall under this category are the ones associated with the design itself (i.e. not inherited from the library)

Definition at line 685 of file cadstar_archive_parser.h.

 {
 BOTH, 
 COMPONENT, 
 PART_DEFINITION, 
 PART_LIBRARY, 
 SYMBOL, 
 UNDEFINED 
 };

◆ GRID_TYPE

enum class CADSTAR_ARCHIVE_PARSER::GRID_TYPE

stronginherited

Enumerator

FRACTIONALGRID

Param1 = Units, Param2 = Divisor.

The grid is equal in X and Y dimensions with a step size equal to Param1/Param2

STEPGRID

Param1 = X Step, Param2 = Y Step. A standard x,y grid.

Definition at line 528 of file cadstar_archive_parser.h.

 {
 FRACTIONALGRID, 
 STEPGRID 
 };

◆ JUSTIFICATION

enum class CADSTAR_ARCHIVE_PARSER::JUSTIFICATION

stronginherited

From CADSTAR Help: "Multi Line Text can also be justified as Left, Centre or Right.

This does not affect the text alignment. Note: Justification of single line text has no effect."

This only affects multiline text

◆ LINESTYLE

enum class CADSTAR_ARCHIVE_PARSER::LINESTYLE

stronginherited

Enumerator
SOLID
DASH
DASHDOT
DASHDOTDOT
DOT

Definition at line 287 of file cadstar_archive_parser.h.

 {
 SOLID,
 DASH,
 DASHDOT,
 DASHDOTDOT,
 DOT
 };

◆ READABILITY

enum class CADSTAR_ARCHIVE_PARSER::READABILITY

stronginherited

Sets the readability direction of text.

From CADSTAR Help: "Horizontal text will always be displayed from left to right (i.e. never upside down). Vertical text can be set as readable from either the left or right edge of the design."

I.e. Vertical text can either be rotated 90 degrees clockwise or 90 degrees anticlockwise from horizontal. This does not impact vertical text

Enumerator
BOTTOM_TO_TOP	When text is vertical, show it rotated 90 degrees anticlockwise.
TOP_TO_BOTTOM	When text is vertical, show it rotated 90 degrees clockwise.

Definition at line 652 of file cadstar_archive_parser.h.

 {
 BOTTOM_TO_TOP, 
 TOP_TO_BOTTOM 
 };

◆ RESOLUTION

enum class CADSTAR_ARCHIVE_PARSER::RESOLUTION

stronginherited

Enumerator
HUNDREDTH_MICRON

Definition at line 249 of file cadstar_archive_parser.h.

 {
 HUNDREDTH_MICRON
 };

◆ SHAPE_TYPE

enum class CADSTAR_ARCHIVE_PARSER::SHAPE_TYPE

stronginherited

Enumerator
OPENSHAPE	Unfilled open shape. Cannot have cutouts.
OUTLINE	Unfilled closed shape.
SOLID	Filled closed shape (solid fill).
HATCHED	Filled closed shape (hatch fill).

Definition at line 474 of file cadstar_archive_parser.h.

 {
 OPENSHAPE, 
 OUTLINE, 
 SOLID, 
 HATCHED 
 };

◆ SWAP_RULE

enum class CADSTAR_ARCHIVE_PARSER::SWAP_RULE

stronginherited

Corresponds to "Display when" Item property.

From CADSTAR Help: "This parameter enables you to make the visibility of a component outline/area (or an area of component copper, or a string of component text) dependent on the current mirror status of the component. For example, you may require a string of component text to be displayed only when the component is mirrored."

Enumerator
NO_SWAP	Display when Unmirrored.
USE_SWAP_LAYER	Display when Mirrored.
BOTH	Always display (Mirrored and Unmirrored)

Definition at line 842 of file cadstar_archive_parser.h.

 {
 NO_SWAP, 
 USE_SWAP_LAYER, 
 BOTH 
 };

◆ TERMINAL_SHAPE_TYPE

enum class CADSTAR_SCH_ARCHIVE_PARSER::TERMINAL_SHAPE_TYPE

strong

Enumerator
ANNULUS
BOX
BULLET
CIRCLE	Keyword "ROUND".
CROSS
DIAMOND
FINGER
OCTAGON
PLUS
POINTER
RECTANGLE
ROUNDED_RECT	Keyword "ROUNDED".
SQUARE
STAR
TRIANGLE
UNDEFINED	Only used for error checking (not a real shape)

Definition at line 65 of file cadstar_sch_archive_parser.h.

 {
 ANNULUS,
 BOX,
 BULLET,
 CIRCLE, 
 CROSS,
 DIAMOND,
 FINGER,
 OCTAGON,
 PLUS,
 POINTER,
 RECTANGLE,
 ROUNDED_RECT, 
 SQUARE,
 STAR,
 TRIANGLE,
 UNDEFINED 
 };

◆ TEXT_FIELD_NAME

enum class CADSTAR_ARCHIVE_PARSER::TEXT_FIELD_NAME

stronginherited

These are special fields in text objects enclosed between the tokens '<@' and '>' such as <@[FIELD_NAME][FIELD_VALUE]>.

For example: "<@DESIGN TITLEProject [email protected]>"

Enumerator
DESIGN_TITLE
SHORT_JOBNAME
LONG_JOBNAME
NUM_OF_SHEETS
SHEET_NUMBER
SHEET_NAME
VARIANT_NAME
VARIANT_DESCRIPTION
REG_USER
COMPANY_NAME
CURRENT_USER
DATE
TIME
MACHINE_NAME
FROM_FILE
DISTANCE
UNITS_SHORT
UNITS_ABBREV
UNITS_FULL
HYPERLINK
NONE	Synthetic for flagging.

Definition at line 142 of file cadstar_archive_parser.h.

 {
 DESIGN_TITLE,
 SHORT_JOBNAME,
 LONG_JOBNAME,
 NUM_OF_SHEETS,
 SHEET_NUMBER,
 SHEET_NAME,
 VARIANT_NAME,
 VARIANT_DESCRIPTION,
 REG_USER,
 COMPANY_NAME,
 CURRENT_USER,
 DATE,
 TIME,
 MACHINE_NAME,
 FROM_FILE,
 DISTANCE,
 UNITS_SHORT,
 UNITS_ABBREV,
 UNITS_FULL,
 HYPERLINK,
 NONE 
 };

◆ UNITS

enum class CADSTAR_ARCHIVE_PARSER::UNITS

stronginherited

Enumerator
DESIGN	Inherits from design units (assumed Assignments->Technology->Units)
THOU
INCH
MICROMETRE
MM
CENTIMETER
METER

Definition at line 503 of file cadstar_archive_parser.h.

 {
 DESIGN, 
 THOU,
 INCH,
 MICROMETRE,
 MM,
 CENTIMETER,
 METER
 };

◆ VERTEX_TYPE

enum class CADSTAR_ARCHIVE_PARSER::VERTEX_TYPE

stronginherited

Enumerator
POINT
CLOCKWISE_ARC
CLOCKWISE_SEMICIRCLE
ANTICLOCKWISE_ARC
ANTICLOCKWISE_SEMICIRCLE

Definition at line 428 of file cadstar_archive_parser.h.

 {
 POINT,
 CLOCKWISE_ARC,
 CLOCKWISE_SEMICIRCLE,
 ANTICLOCKWISE_ARC,
 ANTICLOCKWISE_SEMICIRCLE
 };

Constructor & Destructor Documentation

◆ CADSTAR_SCH_ARCHIVE_PARSER()

CADSTAR_SCH_ARCHIVE_PARSER::CADSTAR_SCH_ARCHIVE_PARSER ( wxString aFilename )

inlineexplicit

Definition at line 38 of file cadstar_sch_archive_parser.h.

  :
 CADSTAR_ARCHIVE_PARSER(), Filename( aFilename ), Header(), Assignments(),
 KiCadUnitDivider( 10 ), m_rootNode( nullptr )
 {
 }

◆ ~CADSTAR_SCH_ARCHIVE_PARSER()

virtual CADSTAR_SCH_ARCHIVE_PARSER::~CADSTAR_SCH_ARCHIVE_PARSER ( )

inlinevirtual

Definition at line 44 of file cadstar_sch_archive_parser.h.

 {
 if( m_rootNode )
 delete m_rootNode;
 }

References m_rootNode.

Member Function Documentation

◆ CheckNoChildNodes()

void CADSTAR_ARCHIVE_PARSER::CheckNoChildNodes ( XNODE * aNode )

staticinherited

Parameters

aNode

Exceptions

IO_ERROR if a child node was found

Definition at line 2595 of file cadstar_archive_parser.cpp.

{
 if( aNode && aNode->GetChildren() )
 THROW_UNKNOWN_NODE_IO_ERROR( aNode->GetChildren()->GetName(), aNode->GetName() );
}

References XNODE::GetChildren(), and THROW_UNKNOWN_NODE_IO_ERROR.

Referenced by CADSTAR_ARCHIVE_PARSER::ATTRNAME::COLUMNORDER::Parse(), CADSTAR_ARCHIVE_PARSER::ATTRNAME::COLUMNWIDTH::Parse(), CADSTAR_ARCHIVE_PARSER::REUSEBLOCKREF::Parse(), CADSTAR_ARCHIVE_PARSER::PART::DEFINITION::GATE::Parse(), CADSTAR_ARCHIVE_PARSER::PART::DEFINITION::PIN_EQUIVALENCE::Parse(), CADSTAR_ARCHIVE_PARSER::PART::DEFINITION::SWAP_GATE::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::LAYERDEFS::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::SPACINGCODE::REASSIGN::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::COMPONENT_COPPER::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::COMPONENT_AREA::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::PAD_EXITS::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::AREA::Parse(), and CADSTAR_PCB_ARCHIVE_PARSER::NET_PCB::PIN::Parse().

◆ CheckNoNextNodes()

void CADSTAR_ARCHIVE_PARSER::CheckNoNextNodes ( XNODE * aNode )

staticinherited

Parameters

aNode

Exceptions

IO_ERROR if a node adjacent to aNode was found

Definition at line 2602 of file cadstar_archive_parser.cpp.

{
 if( aNode && aNode->GetNext() )
 THROW_UNKNOWN_NODE_IO_ERROR( aNode->GetNext()->GetName(), aNode->GetParent()->GetName() );
}

References XNODE::GetNext(), XNODE::GetParent(), and THROW_UNKNOWN_NODE_IO_ERROR.

Referenced by CADSTAR_SCH_ARCHIVE_PARSER::TERMINAL_SHAPE::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::SYMBOLVARIANT::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::CADSTAR_PAD_SHAPE::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::PADREASSIGN::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::VIAREASSIGN::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::LAYERPAIR::Parse(), and CADSTAR_PCB_ARCHIVE_PARSER::DIMENSION::TEXTFORMAT::Parse().

◆ checkPoint()

void CADSTAR_ARCHIVE_PARSER::checkPoint ( )

protectedinherited

Updates m_progressReporter or throws if user cancelled.

Definition at line 2774 of file cadstar_archive_parser.cpp.

{
 if( m_progressReporter )
 {
 m_progressReporter->AdvanceProgress();
 
 if( !m_progressReporter->KeepRefreshing() )
 THROW_IO_ERROR( _( "File import cancelled by user." ) );
 }
}

References _, PROGRESS_REPORTER::AdvanceProgress(), PROGRESS_REPORTER::KeepRefreshing(), CADSTAR_ARCHIVE_PARSER::m_progressReporter, and THROW_IO_ERROR.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::calculateZonePriorities(), CADSTAR_SCH_ARCHIVE_LOADER::Load(), CADSTAR_PCB_ARCHIVE_LOADER::loadCoppers(), CADSTAR_SCH_ARCHIVE_LOADER::loadPartsLibrary(), Parse(), and CADSTAR_PCB_ARCHIVE_PARSER::Parse().

◆ FixTextPositionNoAlignment()

void CADSTAR_ARCHIVE_PARSER::FixTextPositionNoAlignment ( EDA_TEXT * aKiCadTextItem )

staticinherited

Corrects the position of a text element that had NO_ALIGNMENT in CADSTAR.

Assumes that the provided text element has been initialised with a position and orientation.

Parameters

aKiCadTextItem a Kicad item to correct

Definition at line 2747 of file cadstar_archive_parser.cpp.

{
 if( !aKiCadTextItem->GetText().IsEmpty() )
 {
 VECTOR2I positionOffset( 0, aKiCadTextItem->GetInterline() );
 RotatePoint( positionOffset, aKiCadTextItem->GetTextAngle() );
 
 EDA_ITEM* textEdaItem = dynamic_cast<EDA_ITEM*>( aKiCadTextItem );
 
 if( textEdaItem &&
 ( textEdaItem->Type() == LIB_TEXT_T || textEdaItem->Type() == LIB_FIELD_T ) )
 {
 // Y coordinate increases upwards in the symbol editor
 positionOffset.y = -positionOffset.y;
 }
 
 //Count num of additional lines
 wxString text = aKiCadTextItem->GetText();
 int numExtraLines = text.Replace( "\n", "\n" );
 numExtraLines -= text.at( text.size() - 1 ) == '\n'; // Ignore new line character at end
 positionOffset.x *= numExtraLines;
 positionOffset.y *= numExtraLines;
 
 aKiCadTextItem->Offset( positionOffset );
 }
}

References EDA_TEXT::GetInterline(), EDA_TEXT::GetText(), EDA_TEXT::GetTextAngle(), LIB_FIELD_T, LIB_TEXT_T, EDA_TEXT::Offset(), RotatePoint(), text, EDA_ITEM::Type(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), and CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText().

◆ generateLibName()

static wxString CADSTAR_ARCHIVE_PARSER::generateLibName	(	const wxString &	aRefName,
		const wxString &	aAlternateName
	)

inlinestaticinherited

Definition at line 1436 of file cadstar_archive_parser.h.

 {
 return aRefName
 + ( ( aAlternateName.size() > 0 ) ? ( wxT( " (" ) + aAlternateName + wxT( ")" ) )
 : wxString( wxT( "" ) ) );
 }

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary().

◆ GetNumberOfChildNodes()

long CADSTAR_ARCHIVE_PARSER::GetNumberOfChildNodes ( XNODE * aNode )

staticinherited

Definition at line 2705 of file cadstar_archive_parser.cpp.

{
 XNODE* childNodes = aNode->GetChildren();
 long retval = 0;
 
 for( ; childNodes; childNodes = childNodes->GetNext() )
 retval++;
 
 return retval;
}

References XNODE::GetChildren(), and XNODE::GetNext().

Referenced by CADSTAR_ARCHIVE_PARSER::GetNumberOfStepsForReporting().

◆ GetNumberOfStepsForReporting()

long CADSTAR_ARCHIVE_PARSER::GetNumberOfStepsForReporting	(	XNODE *	aRootNode,
		std::vector< wxString >	aSubNodeChildrenToCount
	)

staticinherited

Definition at line 2717 of file cadstar_archive_parser.cpp.

{
 XNODE* level1Node = aRootNode->GetChildren();
 long retval = 0;
 
 for( ; level1Node; level1Node = level1Node->GetNext() )
 {
 for( wxString childNodeName : aSubNodeChildrenToCount )
 {
 if( level1Node->GetName() == childNodeName )
 retval += GetNumberOfChildNodes( level1Node );
 }
 
 retval++;
 }
 
 return retval;
}

References XNODE::GetChildren(), XNODE::GetNext(), and CADSTAR_ARCHIVE_PARSER::GetNumberOfChildNodes().

Referenced by Parse(), and CADSTAR_PCB_ARCHIVE_PARSER::Parse().

◆ GetXmlAttributeIDLong()

long CADSTAR_ARCHIVE_PARSER::GetXmlAttributeIDLong	(	XNODE *	aNode,
		unsigned int	aID,
		bool	aIsRequired = `true`
	)

staticinherited

Parameters

aNode
aID
aIsRequired	Prevents exception throwing if false.

Returns: returns the value (long) of attribute "attrX" in aNode where 'X' is aID

Exceptions

IO_ERROR if attribute does not exist

Definition at line 2577 of file cadstar_archive_parser.cpp.

{
 long retVal;
 bool success = GetXmlAttributeIDString( aNode, aID, aIsRequired ).ToLong( &retVal );
 
 if( !success )
 {
 if( aIsRequired )
 THROW_PARSING_IO_ERROR( std::to_string( aID ), aNode->GetName() );
 else
 return UNDEFINED_VALUE;
 }
 
 return retVal;
}

References CADSTAR_ARCHIVE_PARSER::GetXmlAttributeIDString(), THROW_PARSING_IO_ERROR, and CADSTAR_ARCHIVE_PARSER::UNDEFINED_VALUE.

◆ GetXmlAttributeIDString()

wxString CADSTAR_ARCHIVE_PARSER::GetXmlAttributeIDString	(	XNODE *	aNode,
		unsigned int	aID,
		bool	aIsRequired = `true`
	)

staticinherited

Parameters

aNode
aID
aIsRequired	Prevents exception throwing if false.

Returns: returns the value (wxString) of attribute "attrX" in aNode where 'X' is aID

Exceptions

IO_ERROR if attribute does not exist

Definition at line 2558 of file cadstar_archive_parser.cpp.

{
 wxString attrName, retVal;
 attrName = "attr";
 attrName << aID;
 
 if( !aNode->GetAttribute( attrName, &retVal ) )
 {
 if( aIsRequired )
 THROW_MISSING_PARAMETER_IO_ERROR( std::to_string( aID ), aNode->GetName() );
 else
 return wxEmptyString;
 }
 
 return retVal;
}

References THROW_MISSING_PARAMETER_IO_ERROR.

◆ HandleTextOverbar()

wxString CADSTAR_ARCHIVE_PARSER::HandleTextOverbar ( wxString aCadstarString )

staticinherited

Convert a string with CADSTAR overbar characters to equivalent in KiCad.

Parameters

aCadstarString Input string

Returns: KiCad string with overbar characters

Definition at line 2737 of file cadstar_archive_parser.cpp.

{
 wxString escapedText = aCadstarString;
 
 escapedText.Replace( wxT( "'" ), wxT( "~" ) );
 
 return ConvertToNewOverbarNotation( escapedText );
}

References ConvertToNewOverbarNotation().

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), CADSTAR_SCH_ARCHIVE_LOADER::loadBusses(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbol(), and CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary().

◆ InsertAttributeAtEnd()

void CADSTAR_ARCHIVE_PARSER::InsertAttributeAtEnd	(	XNODE *	aNode,
		wxString	aValue
	)

staticinherited

Definition at line 2406 of file cadstar_archive_parser.cpp.

{
 wxString result;
 int numAttributes = 0;
 
 if( aNode->GetAttribute( wxT( "numAttributes" ), &result ) )
 {
 numAttributes = wxAtoi( result );
 aNode->DeleteAttribute( wxT( "numAttributes" ) );
 ++numAttributes;
 }
 
 aNode->AddAttribute( wxT( "numAttributes" ), wxString::Format( wxT( "%i" ), numAttributes ) );
 
 wxString paramName = wxT( "attr" );
 paramName << numAttributes;
 
 aNode->AddAttribute( paramName, aValue );
}

References Format().

Referenced by CADSTAR_ARCHIVE_PARSER::LoadArchiveFile().

◆ IsValidAttribute()

bool CADSTAR_ARCHIVE_PARSER::IsValidAttribute ( wxXmlAttribute * aAttribute )

staticinherited

Parameters

aAttribute

Returns

Definition at line 2552 of file cadstar_archive_parser.cpp.

{
 return aAttribute->GetName() != wxT( "numAttributes" );
}

Referenced by CADSTAR_ARCHIVE_PARSER::PART::DEFINITION::PIN_EQUIVALENCE::Parse(), CADSTAR_ARCHIVE_PARSER::PART::DEFINITION::SWAP_GATE::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::LAYERDEFS::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::COMPONENT_COPPER::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::COMPONENT_AREA::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::PAD_EXITS::Parse(), and CADSTAR_PCB_ARCHIVE_PARSER::AREA::Parse().

◆ LoadArchiveFile()

XNODE * CADSTAR_ARCHIVE_PARSER::LoadArchiveFile	(	const wxString &	aFileName,
		const wxString &	aFileTypeIdentifier,
		PROGRESS_REPORTER *	aProgressReporter = `nullptr`
	)

staticinherited

Reads a CADSTAR Archive file (S-parameter format)

Parameters

aFileName
aFileTypeIdentifier	Identifier of the first node in the file to check against. E.g. "CADSTARPCB"
aProgressReporter	Pointer to a Progress Reporter to report progress to.

Returns: XNODE pointing to the top of the tree for further parsing. Each node has the first element as the node's name and subsequent elements as node attributes ("attr0", "attr1", "attr2", etc.). Caller is responsible for deleting to avoid memory leaks.

Exceptions

IO_ERROR

Definition at line 2427 of file cadstar_archive_parser.cpp.

{
 KEYWORD emptyKeywords[1] = {};
 XNODE* rootNode = nullptr;
 XNODE* cNode = nullptr;
 XNODE* iNode = nullptr;
 int tok;
 bool cadstarFileCheckDone = false;
 wxString str;
 wxCSConv win1252( wxT( "windows-1252" ) );
 wxMBConv* conv = &win1252; // Initial testing suggests file encoding to be Windows-1252
 // More samples required.
 
 // Open the file and get the file size
 FILE* fp = wxFopen( aFileName, wxT( "rt" ) );
 
 if( !fp )
 THROW_IO_ERROR( wxString::Format( _( "Cannot open file '%s'" ), aFileName ) );
 
 fseek( fp, 0L, SEEK_END );
 long fileSize = ftell( fp );
 rewind( fp );
 
 DSNLEXER lexer( emptyKeywords, 0, nullptr, fp, aFileName );
 
 auto currentProgress = [&]() -> double
 {
 return static_cast<double>( ftell( fp ) ) / fileSize;
 };
 
 double previousReportedProgress = -1.0;
 
 while( ( tok = lexer.NextTok() ) != DSN_EOF )
 {
 if( aProgressReporter && ( currentProgress() - previousReportedProgress ) > 0.01 )
 {
 if( !aProgressReporter->KeepRefreshing() )
 {
 delete rootNode;
 THROW_IO_ERROR( _( "File import cancelled by user." ) );
 }
 
 aProgressReporter->SetCurrentProgress( currentProgress() );
 previousReportedProgress = currentProgress();
 }
 
 if( tok == DSN_RIGHT )
 {
 cNode = iNode;
 if( cNode )
 {
 iNode = cNode->GetParent();
 }
 else
 {
 //too many closing brackets
 delete rootNode;
 THROW_IO_ERROR( _( "The selected file is not valid or might be corrupt!" ) );
 }
 }
 else if( tok == DSN_LEFT )
 {
 tok = lexer.NextTok();
 str = wxString( lexer.CurText(), *conv );
 cNode = new XNODE( wxXML_ELEMENT_NODE, str );
 
 if( !rootNode )
 rootNode = cNode;
 
 if( iNode )
 {
 //we will add it as attribute as well as child node
 InsertAttributeAtEnd( iNode, str );
 iNode->AddChild( cNode );
 }
 else if( !cadstarFileCheckDone )
 {
 if( cNode->GetName() != aFileTypeIdentifier )
 {
 delete rootNode;
 THROW_IO_ERROR( _( "The selected file is not valid or might be corrupt!" ) );
 }
 
 cadstarFileCheckDone = true;
 }
 
 iNode = cNode;
 }
 else if( iNode )
 {
  str = wxString( lexer.CurText(), *conv );
 //Insert even if string is empty
 InsertAttributeAtEnd( iNode, str );
 }
 else
 {
 //not enough closing brackets
 delete rootNode;
 THROW_IO_ERROR( _( "The selected file is not valid or might be corrupt!" ) );
 }
 }
 
 // Not enough closing brackets
 if( iNode != nullptr )
 {
 delete rootNode;
 THROW_IO_ERROR( _( "The selected file is not valid or might be corrupt!" ) );
 }
 
 // Throw if no data was parsed
 if( rootNode )
 {
 return rootNode;
 }
 else
 {
 delete rootNode;
 THROW_IO_ERROR( _( "The selected file is not valid or might be corrupt!" ) );
 }
 
 return nullptr;
}

References _, DSNLEXER::CurText(), DSN_EOF, DSN_LEFT, DSN_RIGHT, Format(), XNODE::GetParent(), CADSTAR_ARCHIVE_PARSER::InsertAttributeAtEnd(), PROGRESS_REPORTER::KeepRefreshing(), DSNLEXER::NextTok(), PROGRESS_REPORTER::SetCurrentProgress(), and THROW_IO_ERROR.

Referenced by Parse(), and CADSTAR_PCB_ARCHIVE_PARSER::Parse().

◆ Parse()

void CADSTAR_SCH_ARCHIVE_PARSER::Parse ( )

Parses the file.

Exceptions

IO_ERROR if file could not be opened or there was an error while parsing

Definition at line 33 of file cadstar_sch_archive_parser.cpp.

{
 if( m_progressReporter )
 m_progressReporter->BeginPhase( 0 ); // Read file
 
 m_rootNode = LoadArchiveFile( Filename, wxT( "CADSTARSCM" ), m_progressReporter );
 
 if( m_progressReporter )
 {
 m_progressReporter->BeginPhase( 1 ); // Parse File
 
 std::vector<wxString> subNodeChildrenToCount = { wxT( "LIBRARY" ), wxT( "PARTS" ),
 wxT( "SCHEMATIC" ) };
 
 long numOfSteps = GetNumberOfStepsForReporting( m_rootNode, subNodeChildrenToCount );
 m_progressReporter->SetMaxProgress( numOfSteps );
 }
 
 m_context.CheckPointCallback = [&](){ checkPoint(); };
 
 XNODE* cNode = m_rootNode->GetChildren();
 
 if( !cNode )
 THROW_MISSING_NODE_IO_ERROR( wxT( "HEADER" ), wxT( "CADSTARSCM" ) );
 
 for( ; cNode; cNode = cNode->GetNext() )
 {
 if( cNode->GetName() == wxT( "HEADER" ) )
 {
 Header.Parse( cNode, &m_context );
 
 switch( Header.Resolution )
 {
 case RESOLUTION::HUNDREDTH_MICRON:
 KiCadUnitDivider = (long) 1e5 / (long) SCH_IU_PER_MM;
 break;
 
 default:
 wxASSERT_MSG( true, wxT( "Unknown File Resolution" ) );
 break;
 }
 }
 else if( cNode->GetName() == wxT( "ASSIGNMENTS" ) )
 {
 Assignments.Parse( cNode, &m_context );
 }
 else if( cNode->GetName() == wxT( "LIBRARY" ) )
 {
 Library.Parse( cNode, &m_context );
 }
 else if( cNode->GetName() == wxT( "DEFAULTS" ) )
 {
 // No design information here (no need to parse)
 // Only contains CADSTAR configuration data such as default shapes, text and units
 // In future some of this could be converted to KiCad but limited value
 }
 else if( cNode->GetName() == wxT( "PARTS" ) )
 {
 Parts.Parse( cNode, &m_context );
 }
 else if( cNode->GetName() == wxT( "SHEETS" ) )
 {
 Sheets.Parse( cNode, &m_context );
 }
 else if( cNode->GetName() == wxT( "SCHEMATIC" ) )
 {
 Schematic.Parse( cNode, &m_context );
 }
 else if( cNode->GetName() == wxT( "DISPLAY" ) )
 {
 // For now only interested in Attribute visibilities, in order to set field visibilities
 // in the imported design
 XNODE* subNode = cNode->GetChildren();
 
 for( ; subNode; subNode = subNode->GetNext() )
 {
 if( subNode->GetName() == wxT( "ATTRCOLORS" ) )
 {
 AttrColors.Parse( subNode, &m_context );
 }
 else if( subNode->GetName() == wxT( "SCMITEMCOLORS" ) )
 {
 XNODE* sub2Node = subNode->GetChildren();
 
 for( ; sub2Node; sub2Node = sub2Node->GetNext() )
 {
 if( sub2Node->GetName() == wxT( "SYMCOL" ) )
 {
 XNODE* sub3Node = sub2Node->GetChildren();
 
 for( ; sub3Node; sub3Node = sub3Node->GetNext() )
 {
 if( sub3Node->GetName() == wxT( "PARTNAMECOL" ) )
 SymbolPartNameColor.Parse( sub3Node, &m_context );
 }
 }
 }
 }
 else
 {
 // No design information here
 // Contains CADSTAR Display settings such as layer/element colours and visibility.
 // In the future these settings could be converted to KiCad
 }
 }
 
 }
 else
 {
 THROW_UNKNOWN_NODE_IO_ERROR( cNode->GetName(), wxT( "[root]" ) );
 }
 
 checkPoint();
 }
 
 delete m_rootNode;
 m_rootNode = nullptr;
}

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::Load().

◆ ParseAlignment()

CADSTAR_ARCHIVE_PARSER::ALIGNMENT CADSTAR_ARCHIVE_PARSER::ParseAlignment ( XNODE * aNode )

staticinherited

Definition at line 1042 of file cadstar_archive_parser.cpp.

{
 wxASSERT( aNode->GetName() == wxT( "ALIGN" ) );
 
 wxString alignmentStr = GetXmlAttributeIDString( aNode, 0 );
 
 if( alignmentStr == wxT( "BOTTOMCENTER" ) )
 return ALIGNMENT::BOTTOMCENTER;
 else if( alignmentStr == wxT( "BOTTOMLEFT" ) )
 return ALIGNMENT::BOTTOMLEFT;
 else if( alignmentStr == wxT( "BOTTOMRIGHT" ) )
 return ALIGNMENT::BOTTOMRIGHT;
 else if( alignmentStr == wxT( "CENTERCENTER" ) )
 return ALIGNMENT::CENTERCENTER;
 else if( alignmentStr == wxT( "CENTERLEFT" ) )
 return ALIGNMENT::CENTERLEFT;
 else if( alignmentStr == wxT( "CENTERRIGHT" ) )
 return ALIGNMENT::CENTERRIGHT;
 else if( alignmentStr == wxT( "TOPCENTER" ) )
 return ALIGNMENT::TOPCENTER;
 else if( alignmentStr == wxT( "TOPLEFT" ) )
 return ALIGNMENT::TOPLEFT;
 else if( alignmentStr == wxT( "TOPRIGHT" ) )
 return ALIGNMENT::TOPRIGHT;
 else
 THROW_UNKNOWN_PARAMETER_IO_ERROR( alignmentStr, wxT( "ALIGN" ) );
 
 //shouldn't be here but avoids compiler warning
 return ALIGNMENT::NO_ALIGNMENT;
}

References CADSTAR_ARCHIVE_PARSER::BOTTOMCENTER, CADSTAR_ARCHIVE_PARSER::BOTTOMLEFT, CADSTAR_ARCHIVE_PARSER::BOTTOMRIGHT, CADSTAR_ARCHIVE_PARSER::CENTERCENTER, CADSTAR_ARCHIVE_PARSER::CENTERLEFT, CADSTAR_ARCHIVE_PARSER::CENTERRIGHT, CADSTAR_ARCHIVE_PARSER::GetXmlAttributeIDString(), CADSTAR_ARCHIVE_PARSER::NO_ALIGNMENT, THROW_UNKNOWN_PARAMETER_IO_ERROR, CADSTAR_ARCHIVE_PARSER::TOPCENTER, CADSTAR_ARCHIVE_PARSER::TOPLEFT, and CADSTAR_ARCHIVE_PARSER::TOPRIGHT.

Referenced by CADSTAR_ARCHIVE_PARSER::TEXT_LOCATION::Parse(), CADSTAR_ARCHIVE_PARSER::TEXT::Parse(), and CADSTAR_ARCHIVE_PARSER::ATTRIBUTE_LOCATION::ParseSubNode().

◆ ParseAllChildCutouts()

std::vector< CADSTAR_ARCHIVE_PARSER::CUTOUT > CADSTAR_ARCHIVE_PARSER::ParseAllChildCutouts	(	XNODE *	aNode,
		PARSER_CONTEXT *	aContext,
		bool	aTestAllChildNodes = `false`
	)

staticinherited

if no children are present, it just returns an empty vector (without throwing an exception)

Parameters

aNode	containing a series of CUTOUT objects
aTestAllChildNodes
aExpectedNumPoints	if -1, this is check is disabled

Returns: std::vector containing all CUTOUT objects

Exceptions

IO_ERROR

if one of the following:

Unable to parse a CUTOUT object
aTestAllChildNodes is true and one of the child nodes is not a valid CUTOUT object

Definition at line 2679 of file cadstar_archive_parser.cpp.

{
 std::vector<CUTOUT> retVal;
 
 XNODE* cNode = aNode->GetChildren();
 
 for( ; cNode; cNode = cNode->GetNext() )
 {
 if( cNode->GetName() == wxT( "CUTOUT" ) )
 {
 CUTOUT cutout;
 //TODO try.. catch + throw again with more detailed error information
 cutout.Parse( cNode, aContext );
 retVal.push_back( cutout );
 }
 else if( aTestAllChildNodes )
 {
 THROW_UNKNOWN_NODE_IO_ERROR( cNode->GetName(), aNode->GetName() );
 }
 }
 
 return retVal;
}

References XNODE::GetChildren(), XNODE::GetNext(), CADSTAR_ARCHIVE_PARSER::CUTOUT::Parse(), and THROW_UNKNOWN_NODE_IO_ERROR.

Referenced by CADSTAR_ARCHIVE_PARSER::SHAPE::Parse().

◆ ParseAllChildPoints()

std::vector< CADSTAR_ARCHIVE_PARSER::POINT > CADSTAR_ARCHIVE_PARSER::ParseAllChildPoints	(	XNODE *	aNode,
		PARSER_CONTEXT *	aContext,
		bool	aTestAllChildNodes = `false`,
		int	aExpectedNumPoints = `UNDEFINED_VALUE`
	)

staticinherited

if no children are present, it just returns an empty vector (without throwing an exception)

Parameters

aNode	containing a series of POINT objects
aTestAllChildNodes
aExpectedNumPoints	if UNDEFINED_VALUE (i.e. -1), this is check is disabled

Returns: std::vector containing all POINT objects

Exceptions

IO_ERROR

if one of the following:

Unable to parse a POINT object
aTestAllChildNodes is true and one of the child nodes is not a valid POINT object
aExpectedNumPoints is non-negative and the number of POINT objects found is different

Definition at line 2619 of file cadstar_archive_parser.cpp.

{
 std::vector<POINT> retVal;
 
 XNODE* cNode = aNode->GetChildren();
 
 for( ; cNode; cNode = cNode->GetNext() )
 {
 if( cNode->GetName() == wxT( "PT" ) )
 {
 POINT pt;
 //TODO try.. catch + throw again with more detailed error information
 pt.Parse( cNode, aContext );
 retVal.push_back( pt );
 }
 else if( aTestAllChildNodes )
 {
 THROW_UNKNOWN_NODE_IO_ERROR( cNode->GetName(), aNode->GetName() );
 }
 }
 
 if( aExpectedNumPoints != UNDEFINED_VALUE
 && retVal.size() != static_cast<size_t>( aExpectedNumPoints ) )
 {
 THROW_IO_ERROR( wxString::Format(
 _( "Unexpected number of points in '%s'. Found %d but expected %d." ),
 aNode->GetName(), retVal.size(), aExpectedNumPoints ) );
 }
 
 return retVal;
}

References _, Format(), XNODE::GetChildren(), XNODE::GetNext(), CADSTAR_ARCHIVE_PARSER::POINT::Parse(), THROW_IO_ERROR, THROW_UNKNOWN_NODE_IO_ERROR, and CADSTAR_ARCHIVE_PARSER::UNDEFINED_VALUE.

Referenced by CADSTAR_ARCHIVE_PARSER::VERTEX::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::NET_SCH::CONNECTION_SCH::Parse(), and CADSTAR_ARCHIVE_PARSER::SETTINGS::ParseSubNode().

◆ ParseAllChildVertices()

std::vector< CADSTAR_ARCHIVE_PARSER::VERTEX > CADSTAR_ARCHIVE_PARSER::ParseAllChildVertices	(	XNODE *	aNode,
		PARSER_CONTEXT *	aContext,
		bool	aTestAllChildNodes = `false`
	)

staticinherited

if no children are present, it just returns an empty vector (without throwing an exception)

Parameters

aNode	containing a series of VERTEX objects
aTestAllChildNodes
aExpectedNumPoints	if -1, this is check is disabled

Returns: std::vector containing all VERTEX objects

Exceptions

IO_ERROR

if one of the following:

Unable to parse a VERTEX object
aTestAllChildNodes is true and one of the child nodes is not a valid VERTEX object

Definition at line 2653 of file cadstar_archive_parser.cpp.

{
 std::vector<VERTEX> retVal;
 
 XNODE* cNode = aNode->GetChildren();
 
 for( ; cNode; cNode = cNode->GetNext() )
 {
 if( VERTEX::IsVertex( cNode ) )
 {
 VERTEX vertex;
 //TODO try.. catch + throw again with more detailed error information
 vertex.Parse( cNode, aContext );
 retVal.push_back( vertex );
 }
 else if( aTestAllChildNodes )
 {
 THROW_UNKNOWN_NODE_IO_ERROR( cNode->GetName(), aNode->GetName() );
 }
 }
 
 return retVal;
}

References XNODE::GetChildren(), XNODE::GetNext(), CADSTAR_ARCHIVE_PARSER::VERTEX::IsVertex(), CADSTAR_ARCHIVE_PARSER::VERTEX::Parse(), and THROW_UNKNOWN_NODE_IO_ERROR.

Referenced by CADSTAR_ARCHIVE_PARSER::CUTOUT::Parse(), and CADSTAR_ARCHIVE_PARSER::SHAPE::Parse().

◆ ParseAngunits()

CADSTAR_ARCHIVE_PARSER::ANGUNITS CADSTAR_ARCHIVE_PARSER::ParseAngunits ( XNODE * aNode )

staticinherited

Definition at line 681 of file cadstar_archive_parser.cpp.

{
 wxASSERT( aNode->GetName() == wxT( "ANGUNITS" ) );
 
 wxString angUnitStr = GetXmlAttributeIDString( aNode, 0 );
 
 if( angUnitStr == wxT( "DEGREES" ) )
 return ANGUNITS::DEGREES;
 else if( angUnitStr == wxT( "RADIANS" ) )
 return ANGUNITS::RADIANS;
 else
 THROW_UNKNOWN_PARAMETER_IO_ERROR( angUnitStr, aNode->GetName() );
 
 return ANGUNITS();
}

References CADSTAR_ARCHIVE_PARSER::DEGREES, CADSTAR_ARCHIVE_PARSER::GetXmlAttributeIDString(), CADSTAR_ARCHIVE_PARSER::RADIANS, and THROW_UNKNOWN_PARAMETER_IO_ERROR.

Referenced by CADSTAR_PCB_ARCHIVE_PARSER::DIMENSION::Parse().

◆ ParseChildEValue()

void CADSTAR_ARCHIVE_PARSER::ParseChildEValue	(	XNODE *	aNode,
		PARSER_CONTEXT *	aContext,
		EVALUE &	aValueToParse
	)

staticinherited

Parameters

aNode	with a child node containing an EVALUE
aValueToParse

Exceptions

IO_ERROR if unable to parse or node is not an EVALUE

Definition at line 2609 of file cadstar_archive_parser.cpp.

{
 if( aNode->GetChildren()->GetName() == wxT( "E" ) )
 aValueToParse.Parse( aNode->GetChildren(), aContext );
 else
 THROW_UNKNOWN_NODE_IO_ERROR( aNode->GetChildren()->GetName(), aNode->GetName() );
}

References XNODE::GetChildren(), CADSTAR_ARCHIVE_PARSER::EVALUE::Parse(), and THROW_UNKNOWN_NODE_IO_ERROR.

Referenced by CADSTAR_PCB_ARCHIVE_PARSER::MATERIAL::Parse().

◆ ParseJustification()

CADSTAR_ARCHIVE_PARSER::JUSTIFICATION CADSTAR_ARCHIVE_PARSER::ParseJustification ( XNODE * aNode )

staticinherited

Definition at line 1074 of file cadstar_archive_parser.cpp.

{
 wxASSERT( aNode->GetName() == wxT( "JUSTIFICATION" ) );
 
 wxString justificationStr = GetXmlAttributeIDString( aNode, 0 );
 
 if( justificationStr == wxT( "LEFT" ) )
 return JUSTIFICATION::LEFT;
 else if( justificationStr == wxT( "RIGHT" ) )
 return JUSTIFICATION::RIGHT;
 else if( justificationStr == wxT( "CENTER" ) )
 return JUSTIFICATION::CENTER;
 else
 THROW_UNKNOWN_PARAMETER_IO_ERROR( justificationStr, wxT( "JUSTIFICATION" ) );
 
 return JUSTIFICATION::LEFT;
}

References CADSTAR_ARCHIVE_PARSER::CENTER, CADSTAR_ARCHIVE_PARSER::GetXmlAttributeIDString(), CADSTAR_ARCHIVE_PARSER::LEFT, CADSTAR_ARCHIVE_PARSER::RIGHT, and THROW_UNKNOWN_PARAMETER_IO_ERROR.

Referenced by CADSTAR_ARCHIVE_PARSER::TEXT_LOCATION::Parse(), CADSTAR_ARCHIVE_PARSER::TEXT::Parse(), and CADSTAR_ARCHIVE_PARSER::ATTRIBUTE_LOCATION::ParseSubNode().

◆ ParseReadability()

CADSTAR_ARCHIVE_PARSER::READABILITY CADSTAR_ARCHIVE_PARSER::ParseReadability ( XNODE * aNode )

staticinherited

Definition at line 1093 of file cadstar_archive_parser.cpp.

{
 wxASSERT( aNode->GetName() == wxT( "READABILITY" ) );
 
 wxString readabilityStr = GetXmlAttributeIDString( aNode, 0 );
 
 if( readabilityStr == wxT( "BOTTOM_TO_TOP" ) )
 return READABILITY::BOTTOM_TO_TOP;
 else if( readabilityStr == wxT( "TOP_TO_BOTTOM" ) )
 return READABILITY::TOP_TO_BOTTOM;
 else
 THROW_UNKNOWN_PARAMETER_IO_ERROR( readabilityStr, wxT( "READABILITY" ) );
 
 return READABILITY::BOTTOM_TO_TOP;
}

References CADSTAR_ARCHIVE_PARSER::BOTTOM_TO_TOP, CADSTAR_ARCHIVE_PARSER::GetXmlAttributeIDString(), THROW_UNKNOWN_PARAMETER_IO_ERROR, and CADSTAR_ARCHIVE_PARSER::TOP_TO_BOTTOM.

Referenced by CADSTAR_ARCHIVE_PARSER::DOCUMENTATION_SYMBOL::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::SYMBOL::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::COMPONENT::Parse(), and CADSTAR_PCB_ARCHIVE_PARSER::DRILL_TABLE::Parse().

◆ ParseSwapRule()

CADSTAR_ARCHIVE_PARSER::SWAP_RULE CADSTAR_ARCHIVE_PARSER::ParseSwapRule ( XNODE * aNode )

staticinherited

Definition at line 1505 of file cadstar_archive_parser.cpp.

{
 wxASSERT( aNode->GetName() == wxT( "SWAPRULE" ) );
 
 SWAP_RULE retval;
 wxString swapRuleStr = GetXmlAttributeIDString( aNode, 0 );
 
 if( swapRuleStr == wxT( "NO_SWAP" ) )
 retval = SWAP_RULE::NO_SWAP;
 else if( swapRuleStr == wxT( "USE_SWAP_LAYER" ) )
 retval = SWAP_RULE::USE_SWAP_LAYER;
 else
 THROW_UNKNOWN_PARAMETER_IO_ERROR( swapRuleStr, wxT( "SWAPRULE" ) );
 
 return retval;
}

References CADSTAR_ARCHIVE_PARSER::GetXmlAttributeIDString(), CADSTAR_ARCHIVE_PARSER::NO_SWAP, THROW_UNKNOWN_PARAMETER_IO_ERROR, and CADSTAR_ARCHIVE_PARSER::USE_SWAP_LAYER.

Referenced by CADSTAR_ARCHIVE_PARSER::FIGURE::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::COMPONENT_COPPER::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::COMPONENT_AREA::Parse(), and CADSTAR_ARCHIVE_PARSER::TEXT::Parse().

◆ ParseTermShapeType()

CADSTAR_SCH_ARCHIVE_PARSER::TERMINAL_SHAPE_TYPE CADSTAR_SCH_ARCHIVE_PARSER::ParseTermShapeType ( const wxString & aShapeStr )

static

Definition at line 153 of file cadstar_sch_archive_parser.cpp.

{
 if( aShapeStr == wxT( "ANNULUS" ) )
 return TERMINAL_SHAPE_TYPE::ANNULUS;
 else if( aShapeStr == wxT( "BOX" ) )
 return TERMINAL_SHAPE_TYPE::BOX;
 else if( aShapeStr == wxT( "BULLET" ) )
 return TERMINAL_SHAPE_TYPE::BULLET;
 else if( aShapeStr == wxT( "ROUND" ) )
 return TERMINAL_SHAPE_TYPE::CIRCLE;
 else if( aShapeStr == wxT( "CROSS" ) )
 return TERMINAL_SHAPE_TYPE::CROSS;
 else if( aShapeStr == wxT( "DIAMOND" ) )
 return TERMINAL_SHAPE_TYPE::DIAMOND;
 else if( aShapeStr == wxT( "FINGER" ) )
 return TERMINAL_SHAPE_TYPE::FINGER;
 else if( aShapeStr == wxT( "OCTAGON" ) )
 return TERMINAL_SHAPE_TYPE::OCTAGON;
 else if( aShapeStr == wxT( "PLUS" ) )
 return TERMINAL_SHAPE_TYPE::PLUS;
 else if( aShapeStr == wxT( "POINTER" ) )
 return TERMINAL_SHAPE_TYPE::POINTER;
 else if( aShapeStr == wxT( "RECTANGLE" ) )
 return TERMINAL_SHAPE_TYPE::RECTANGLE;
 else if( aShapeStr == wxT( "ROUNDED" ) )
 return TERMINAL_SHAPE_TYPE::ROUNDED_RECT;
 else if( aShapeStr == wxT( "SQUARE" ) )
 return TERMINAL_SHAPE_TYPE::SQUARE;
 else if( aShapeStr == wxT( "STAR" ) )
 return TERMINAL_SHAPE_TYPE::STAR;
 else if( aShapeStr == wxT( "TRIANGLE" ) )
 return TERMINAL_SHAPE_TYPE::TRIANGLE;
 else
 return TERMINAL_SHAPE_TYPE::UNDEFINED;
}

References ANNULUS, BOX, BULLET, CIRCLE, CROSS, DIAMOND, FINGER, OCTAGON, PLUS, POINTER, RECTANGLE, ROUNDED_RECT, SQUARE, STAR, TRIANGLE, and UNDEFINED.

Referenced by CADSTAR_SCH_ARCHIVE_PARSER::TERMINAL_SHAPE::IsTermShape(), and CADSTAR_SCH_ARCHIVE_PARSER::TERMINAL_SHAPE::Parse().

◆ ParseTextFields()

wxString CADSTAR_ARCHIVE_PARSER::ParseTextFields	(	const wxString &	aTextString,
		PARSER_CONTEXT *	aParserContext
	)

staticinherited

Replaces CADSTAR fields for the equivalent in KiCad and stores the field values in aParserContext.

Parameters

aTextString	Text string to parse
aParserContext	PARSER_CONTEXT in which to store the values of the found fields

Returns

Definition at line 848 of file cadstar_archive_parser.cpp.

{
 static const std::map<TEXT_FIELD_NAME, wxString> txtTokens =
 {
 { TEXT_FIELD_NAME::DESIGN_TITLE, wxT( "DESIGN TITLE" ) },
 { TEXT_FIELD_NAME::SHORT_JOBNAME, wxT( "SHORT_JOBNAME" ) },
 { TEXT_FIELD_NAME::LONG_JOBNAME, wxT( "LONG_JOBNAME" ) },
 { TEXT_FIELD_NAME::NUM_OF_SHEETS, wxT( "NUM_OF_SHEETS" ) },
 { TEXT_FIELD_NAME::SHEET_NUMBER, wxT( "SHEET_NUMBER" ) },
 { TEXT_FIELD_NAME::SHEET_NAME, wxT( "SHEET_NAME" ) },
 { TEXT_FIELD_NAME::VARIANT_NAME, wxT( "VARIANT_NAME" ) },
 { TEXT_FIELD_NAME::VARIANT_DESCRIPTION, wxT( "VARIANT_DESCRIPTION" ) },
 { TEXT_FIELD_NAME::REG_USER, wxT( "REG_USER" ) },
 { TEXT_FIELD_NAME::COMPANY_NAME, wxT( "COMPANY_NAME" ) },
 { TEXT_FIELD_NAME::CURRENT_USER, wxT( "CURRENT_USER" ) },
 { TEXT_FIELD_NAME::DATE, wxT( "DATE" ) },
 { TEXT_FIELD_NAME::TIME, wxT( "TIME" ) },
 { TEXT_FIELD_NAME::MACHINE_NAME, wxT( "MACHINE_NAME" ) },
 { TEXT_FIELD_NAME::FROM_FILE, wxT( "FROM_FILE" ) },
 { TEXT_FIELD_NAME::DISTANCE, wxT( "DISTANCE" ) },
 { TEXT_FIELD_NAME::UNITS_SHORT, wxT( "UNITS SHORT" ) },
 { TEXT_FIELD_NAME::UNITS_ABBREV, wxT( "UNITS ABBREV" ) },
 { TEXT_FIELD_NAME::UNITS_FULL, wxT( "UNITS FULL" ) },
 { TEXT_FIELD_NAME::HYPERLINK, wxT( "HYPERLINK" ) }
 };
 
 wxString remainingStr = aTextString;
 wxString returnStr;
 
 while( remainingStr.size() > 0 )
 {
 //Find the start token
 size_t startpos = remainingStr.Find( wxT( "<@" ) );
 
 if( static_cast<int>( startpos ) == wxNOT_FOUND )
 {
 // No more fields to parse, add to return string
 returnStr += remainingStr;
 break;
 }
 
 if( startpos > 0 )
 returnStr += remainingStr.SubString( 0, startpos - 1 );
 
 if( ( startpos + 2 ) >= remainingStr.size() )
 break;
 
 remainingStr = remainingStr.Mid( startpos + 2 );
 
 //Find the expected token for the field
 TEXT_FIELD_NAME foundField = TEXT_FIELD_NAME::NONE;
 
 for( std::pair<TEXT_FIELD_NAME, wxString> txtF : txtTokens )
 {
 if( remainingStr.StartsWith( txtF.second ) )
 {
 foundField = txtF.first;
 break;
 }
 }
 
 if( foundField == TEXT_FIELD_NAME::NONE )
 {
 // Not a valid field, lets keep looking
 returnStr += wxT( "<@" );
 continue;
 }
 
 //Now lets find the end token
 size_t endpos = remainingStr.Find( wxT( "@>" ) );
 
 if( static_cast<int>( endpos ) == wxNOT_FOUND )
 {
 // The field we found isn't valid as it doesn't have a termination
 // Lets append the whole thing as plain text
 returnStr += wxT( "<@" ) + remainingStr;
 break;
 }
 
 size_t valueStart = txtTokens.at( foundField ).size();
 wxString fieldValue = remainingStr.SubString( valueStart, endpos - 1 );
 wxString address;
 
 if( foundField == TEXT_FIELD_NAME::FROM_FILE || foundField == TEXT_FIELD_NAME::HYPERLINK )
 {
 // The first character should always be a double quotation mark
 wxASSERT_MSG( fieldValue.at( 0 ) == '"', "Expected '\"' as the first character" );
 
 size_t splitPos = fieldValue.find_first_of( '"', 1 );
 address = fieldValue.SubString( 1, splitPos - 1 );
 
 if( foundField == TEXT_FIELD_NAME::HYPERLINK )
 {
 // Assume the last two characters are "@>"
 wxASSERT_MSG( remainingStr.EndsWith( wxT( "@>" ) ),
 "Expected '@>' at the end of a hyperlink" );
 
 fieldValue = remainingStr.SubString( valueStart + splitPos + 1,
 remainingStr.Length() - 3 );
 
 remainingStr = wxEmptyString;
 }
 else
 {
 fieldValue = fieldValue.Mid( splitPos + 1 );
 }
 }
 
 switch( foundField )
 {
 case TEXT_FIELD_NAME::DESIGN_TITLE:
 case TEXT_FIELD_NAME::SHORT_JOBNAME:
 case TEXT_FIELD_NAME::LONG_JOBNAME:
 case TEXT_FIELD_NAME::VARIANT_NAME:
 case TEXT_FIELD_NAME::VARIANT_DESCRIPTION:
 case TEXT_FIELD_NAME::REG_USER:
 case TEXT_FIELD_NAME::COMPANY_NAME:
 case TEXT_FIELD_NAME::CURRENT_USER:
 case TEXT_FIELD_NAME::DATE:
 case TEXT_FIELD_NAME::TIME:
 case TEXT_FIELD_NAME::MACHINE_NAME:
 
 if( aContext->TextFieldToValuesMap.find( foundField )
 != aContext->TextFieldToValuesMap.end() )
 {
 aContext->InconsistentTextFields.insert( foundField );
 }
 else
 {
 aContext->TextFieldToValuesMap.insert( { foundField, fieldValue } );
 }
 
 KI_FALLTHROUGH;
 
 case TEXT_FIELD_NAME::NUM_OF_SHEETS:
 case TEXT_FIELD_NAME::SHEET_NUMBER:
 case TEXT_FIELD_NAME::SHEET_NAME:
 returnStr += wxT( "${" ) + CADSTAR_TO_KICAD_FIELDS.at( foundField ) + wxT( "}" );
 break;
 
 case TEXT_FIELD_NAME::DISTANCE:
 case TEXT_FIELD_NAME::UNITS_SHORT:
 case TEXT_FIELD_NAME::UNITS_ABBREV:
 case TEXT_FIELD_NAME::UNITS_FULL:
 // Just flatten the text for distances
 returnStr += fieldValue;
 break;
 
 case TEXT_FIELD_NAME::FROM_FILE:
 {
 wxFileName fn( address );
 wxString fieldFmt = wxT( "FROM_FILE_%s_%s" );
 wxString fieldName = wxString::Format( fieldFmt, fn.GetName(), fn.GetExt() );
 
 int version = 1;
 
 while(
 aContext->FilenamesToTextMap.find( fieldName )
 != aContext->FilenamesToTextMap.end()
 && aContext->FilenamesToTextMap.at( fieldName ) != fieldValue )
 {
 fieldName = wxString::Format( fieldFmt, fn.GetName(), fn.GetExt() )
 + wxString::Format( wxT( "_%d" ), version++ );
 }
 
 aContext->FilenamesToTextMap[fieldName] = fieldValue;
 returnStr += wxT( "${" ) + fieldName + wxT( "}" );
 }
 break;
 
 case TEXT_FIELD_NAME::HYPERLINK:
 {
 aContext->TextToHyperlinksMap[fieldValue] = address;
 returnStr += ParseTextFields( fieldValue, aContext );
 }
 break;
 
 case TEXT_FIELD_NAME::NONE:
 wxFAIL_MSG( "We should have already covered this scenario above" );
 break;
 }
 
 
 if( ( endpos + 2 ) >= remainingStr.size() )
 break;
 
 remainingStr = remainingStr.Mid( endpos + 2 );
 }
 
 return returnStr;
}

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::applyDimensionSettings(), CADSTAR_PCB_ARCHIVE_LOADER::loadDimensions(), CADSTAR_ARCHIVE_PARSER::TEXT::Parse(), and CADSTAR_ARCHIVE_PARSER::ParseTextFields().

◆ ParseUnits()

CADSTAR_ARCHIVE_PARSER::UNITS CADSTAR_ARCHIVE_PARSER::ParseUnits ( XNODE * aNode )

staticinherited

Definition at line 654 of file cadstar_archive_parser.cpp.

{
 wxASSERT( aNode->GetName() == wxT( "UNITS" ) );
 
 wxString unit = GetXmlAttributeIDString( aNode, 0 );
 
 if( unit == wxT( "CENTIMETER" ) )
 return UNITS::CENTIMETER;
 else if( unit == wxT( "INCH" ) )
 return UNITS::INCH;
 else if( unit == wxT( "METER" ) )
 return UNITS::METER;
 else if( unit == wxT( "MICROMETRE" ) )
 return UNITS::MICROMETRE;
 else if( unit == wxT( "MM" ) )
 return UNITS::MM;
 else if( unit == wxT( "THOU" ) )
 return UNITS::THOU;
 else if( unit == wxT( "DESIGN" ) )
 return UNITS::DESIGN;
 else
 THROW_UNKNOWN_PARAMETER_IO_ERROR( unit, wxT( "UNITS" ) );
 
 return UNITS();
}

References CADSTAR_ARCHIVE_PARSER::CENTIMETER, CADSTAR_ARCHIVE_PARSER::DESIGN, CADSTAR_ARCHIVE_PARSER::GetXmlAttributeIDString(), CADSTAR_ARCHIVE_PARSER::INCH, CADSTAR_ARCHIVE_PARSER::METER, CADSTAR_ARCHIVE_PARSER::MICROMETRE, CADSTAR_ARCHIVE_PARSER::MM, CADSTAR_ARCHIVE_PARSER::THOU, and THROW_UNKNOWN_PARAMETER_IO_ERROR.

Referenced by CADSTAR_PCB_ARCHIVE_PARSER::DIMENSION::Parse(), and CADSTAR_ARCHIVE_PARSER::SETTINGS::ParseSubNode().

Member Data Documentation

◆ Assignments

ASSIGNMENTS_SCM CADSTAR_SCH_ARCHIVE_PARSER::Assignments

Definition at line 454 of file cadstar_sch_archive_parser.h.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::getAttributeName(), CADSTAR_SCH_ARCHIVE_LOADER::getFigureExtentsKiCad(), CADSTAR_SCH_ARCHIVE_LOADER::getLineStyle(), CADSTAR_SCH_ARCHIVE_LOADER::getLineThickness(), CADSTAR_SCH_ARCHIVE_LOADER::getRouteCode(), CADSTAR_SCH_ARCHIVE_LOADER::getTextCode(), CADSTAR_SCH_ARCHIVE_LOADER::Load(), and Parse().

◆ AttrColors

ATTRCOLORS CADSTAR_SCH_ARCHIVE_PARSER::AttrColors

Definition at line 459 of file cadstar_sch_archive_parser.h.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::isAttributeVisible(), and Parse().

◆ CADSTAR_TO_KICAD_FIELDS

const std::map< CADSTAR_ARCHIVE_PARSER::TEXT_FIELD_NAME, wxString > CADSTAR_ARCHIVE_PARSER::CADSTAR_TO_KICAD_FIELDS

staticinherited

Initial value:

=
 { { TEXT_FIELD_NAME::DESIGN_TITLE, wxT( "DESIGN_TITLE" ) },
 { TEXT_FIELD_NAME::SHORT_JOBNAME, wxT( "SHORT_JOBNAME" ) },
 { TEXT_FIELD_NAME::LONG_JOBNAME, wxT( "LONG_JOBNAME" ) },
 { TEXT_FIELD_NAME::NUM_OF_SHEETS, wxT( "##" ) },
 { TEXT_FIELD_NAME::SHEET_NUMBER, wxT( "#" ) },
 { TEXT_FIELD_NAME::SHEET_NAME, wxT( "SHEETNAME" ) },
 { TEXT_FIELD_NAME::VARIANT_NAME, wxT( "VARIANT_NAME" ) },
 { TEXT_FIELD_NAME::VARIANT_DESCRIPTION, wxT( "VARIANT_DESCRIPTION" ) },
 { TEXT_FIELD_NAME::REG_USER, wxT( "REG_USER" ) },
 { TEXT_FIELD_NAME::COMPANY_NAME, wxT( "COMPANY_NAME" ) },
 { TEXT_FIELD_NAME::CURRENT_USER, wxT( "CURRENT_USER" ) },
 { TEXT_FIELD_NAME::DATE, wxT( "DATE" ) },
 { TEXT_FIELD_NAME::TIME, wxT( "TIME" ) },
 { TEXT_FIELD_NAME::MACHINE_NAME, wxT( "MACHINE_NAME" ) } }

Map between CADSTAR fields and KiCad text variables.

This is used as a lookup table when parsing CADSTAR text fields. Most variables have a similar name in KiCad as in CADSTAR.

Definition at line 171 of file cadstar_archive_parser.h.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadTextVariables(), CADSTAR_PCB_ARCHIVE_LOADER::loadTextVariables(), and CADSTAR_ARCHIVE_PARSER::ParseTextFields().

◆ Filename

wxString CADSTAR_SCH_ARCHIVE_PARSER::Filename

Definition at line 452 of file cadstar_sch_archive_parser.h.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadSheetAndChildSheets(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheets(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), and Parse().

◆ FONT_BOLD

const long CADSTAR_ARCHIVE_PARSER::FONT_BOLD = 700

staticinherited

Definition at line 329 of file cadstar_archive_parser.h.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings().

◆ FONT_NORMAL

const long CADSTAR_ARCHIVE_PARSER::FONT_NORMAL = 400

staticinherited

Definition at line 328 of file cadstar_archive_parser.h.

◆ Header

HEADER CADSTAR_SCH_ARCHIVE_PARSER::Header

Definition at line 453 of file cadstar_sch_archive_parser.h.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::getAngle(), CADSTAR_SCH_ARCHIVE_LOADER::getCadstarAngle(), CADSTAR_SCH_ARCHIVE_LOADER::loadTextVariables(), and Parse().

◆ KiCadUnitDivider

int CADSTAR_SCH_ARCHIVE_PARSER::KiCadUnitDivider

Use this value to convert units in this CSA file to KiCad units.

Definition at line 462 of file cadstar_sch_archive_parser.h.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::getKiCadLength(), CADSTAR_SCH_ARCHIVE_LOADER::Load(), and Parse().

◆ Library

LIBRARY_SCM CADSTAR_SCH_ARCHIVE_PARSER::Library

Definition at line 455 of file cadstar_sch_archive_parser.h.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::getLocationOfNetElement(), CADSTAR_SCH_ARCHIVE_LOADER::getSymDefFromName(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), and Parse().

◆ m_context

PARSER_CONTEXT CADSTAR_ARCHIVE_PARSER::m_context

protectedinherited

Definition at line 1447 of file cadstar_archive_parser.h.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::applyDimensionSettings(), CADSTAR_PCB_ARCHIVE_LOADER::loadDimensions(), CADSTAR_SCH_ARCHIVE_LOADER::loadTextVariables(), CADSTAR_PCB_ARCHIVE_LOADER::loadTextVariables(), Parse(), and CADSTAR_PCB_ARCHIVE_PARSER::Parse().

◆ m_progressReporter

PROGRESS_REPORTER* CADSTAR_ARCHIVE_PARSER::m_progressReporter

protectedinherited

Definition at line 1448 of file cadstar_archive_parser.h.

Referenced by CADSTAR_ARCHIVE_PARSER::CADSTAR_ARCHIVE_PARSER(), CADSTAR_PCB_ARCHIVE_LOADER::CADSTAR_PCB_ARCHIVE_LOADER(), CADSTAR_SCH_ARCHIVE_LOADER::CADSTAR_SCH_ARCHIVE_LOADER(), CADSTAR_ARCHIVE_PARSER::checkPoint(), CADSTAR_PCB_ARCHIVE_LOADER::Load(), CADSTAR_SCH_ARCHIVE_LOADER::Load(), Parse(), and CADSTAR_PCB_ARCHIVE_PARSER::Parse().

◆ m_rootNode

XNODE* CADSTAR_SCH_ARCHIVE_PARSER::m_rootNode

private

Definition at line 465 of file cadstar_sch_archive_parser.h.

Referenced by Parse(), and ~CADSTAR_SCH_ARCHIVE_PARSER().

◆ Parts

PARTS CADSTAR_SCH_ARCHIVE_PARSER::Parts

Definition at line 456 of file cadstar_sch_archive_parser.h.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::getPart(), CADSTAR_SCH_ARCHIVE_LOADER::Load(), CADSTAR_SCH_ARCHIVE_LOADER::loadPartsLibrary(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), and Parse().

◆ Schematic

CADSTAR_SCHEMATIC CADSTAR_SCH_ARCHIVE_PARSER::Schematic

Definition at line 458 of file cadstar_sch_archive_parser.h.

◆ Sheets

SHEETS CADSTAR_SCH_ARCHIVE_PARSER::Sheets

Definition at line 457 of file cadstar_sch_archive_parser.h.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::findOrphanSheets(), CADSTAR_SCH_ARCHIVE_LOADER::getSheetNumber(), CADSTAR_SCH_ARCHIVE_LOADER::loadChildSheets(), CADSTAR_SCH_ARCHIVE_LOADER::loadItemOntoKiCadSheet(), CADSTAR_SCH_ARCHIVE_LOADER::loadSheetAndChildSheets(), and Parse().

◆ SymbolPartNameColor

PARTNAMECOL CADSTAR_SCH_ARCHIVE_PARSER::SymbolPartNameColor

Definition at line 460 of file cadstar_sch_archive_parser.h.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), and Parse().

◆ TXT_HEIGHT_RATIO

const double CADSTAR_ARCHIVE_PARSER::TXT_HEIGHT_RATIO = ( 24.0 - 5.0 ) / 24.0

staticinherited

CADSTAR fonts are drawn on a 24x24 integer matrix, where the each axis goes from 0 to 24.

The characters can each specify a width of between 12 and 24, but the height is fixed at 24.

The default CADSTAR font uses y=5 as the starting point for capital letters, leaving space for the tails of letters such as "g", "p", "y", "q", etc.

The font height in CADSTAR corresponds to the full 24 point height. In KiCad it only corresponds to the height above the guide line, meaning the overall text height will be larger in KiCad.

Definition at line 136 of file cadstar_archive_parser.h.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::applyTextCode(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), and CADSTAR_SCH_ARCHIVE_LOADER::getTextHeightFromTextCode().

◆ UNDEFINED_VALUE

const long CADSTAR_ARCHIVE_PARSER::UNDEFINED_VALUE = -1

staticinherited

Definition at line 123 of file cadstar_archive_parser.h.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::getKiCadPad(), CADSTAR_ARCHIVE_PARSER::GetXmlAttributeIDLong(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), CADSTAR_PCB_ARCHIVE_LOADER::loadTemplates(), CADSTAR_ARCHIVE_PARSER::VERTEX::Parse(), CADSTAR_ARCHIVE_PARSER::ATTRIBUTE_LOCATION::Parse(), CADSTAR_ARCHIVE_PARSER::TEXT_LOCATION::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::PIN_NUM_LABEL_LOC::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::SYMDEF_SCM::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::SIGNALREFERENCELINK::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::SIGLOC::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::SYMDEF_PCB::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::TEMPLATE::POURING::Parse(), and CADSTAR_ARCHIVE_PARSER::ParseAllChildPoints().

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

Enumerator
NO_ALIGNMENT	NO_ALIGNMENT has different meaning depending on the object type.
TOPLEFT
TOPCENTER
TOPRIGHT
CENTERLEFT
CENTERCENTER
CENTERRIGHT
BOTTOMLEFT
BOTTOMCENTER
BOTTOMRIGHT

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ATTRIBUTE_ID

◆ BLOCK_ID

◆ BUS_ID

◆ COLOR_ID

◆ DOCUMENTATION_SYMBOL_ID

◆ FIGURE_ID

◆ GATE_ID

◆ GROUP_ID

◆ HATCHCODE_ID

◆ LAYER_ID

◆ LINECODE_ID

◆ NET_ID

◆ NETCLASS_ID

◆ NETELEMENT_ID

◆ PART_DEFINITION_PIN_ID

◆ PART_ID

◆ PART_PIN_ID

◆ REUSEBLOCK_ID

◆ ROUTECODE_ID

◆ SHEET_NAME

◆ SPACING_CLASS_ID

◆ SYMBOL_ID

◆ SYMDEF_ID

◆ TERMINAL_ID

◆ TERMINALCODE_ID

◆ TEXT_ID

◆ TEXTCODE_ID

◆ VARIANT_ID

Member Enumeration Documentation

◆ ALIGNMENT

◆ ANGUNITS

◆ ATTROWNER

◆ ATTRUSAGE

◆ GRID_TYPE

◆ JUSTIFICATION

◆ LINESTYLE

◆ READABILITY

◆ RESOLUTION

◆ SHAPE_TYPE

◆ SWAP_RULE

◆ TERMINAL_SHAPE_TYPE

◆ TEXT_FIELD_NAME

◆ UNITS

◆ VERTEX_TYPE

Constructor & Destructor Documentation

◆ CADSTAR_SCH_ARCHIVE_PARSER()

◆ ~CADSTAR_SCH_ARCHIVE_PARSER()

Member Function Documentation

◆ CheckNoChildNodes()

◆ CheckNoNextNodes()

◆ checkPoint()

◆ FixTextPositionNoAlignment()

◆ generateLibName()

◆ GetNumberOfChildNodes()

◆ GetNumberOfStepsForReporting()

◆ GetXmlAttributeIDLong()

◆ GetXmlAttributeIDString()

◆ HandleTextOverbar()

◆ InsertAttributeAtEnd()

◆ IsValidAttribute()

◆ LoadArchiveFile()

◆ Parse()

◆ ParseAlignment()

◆ ParseAllChildCutouts()

◆ ParseAllChildPoints()

◆ ParseAllChildVertices()

◆ ParseAngunits()

◆ ParseChildEValue()

◆ ParseJustification()