KiCad PCB EDA Suite
CADSTAR_ARCHIVE_PARSER Class Reference

Helper functions and common structures for CADSTAR PCB and Schematic archive files. More...

#include <cadstar_archive_parser.h>

Inheritance diagram for CADSTAR_ARCHIVE_PARSER:
CADSTAR_PCB_ARCHIVE_PARSER CADSTAR_SCH_ARCHIVE_PARSER CADSTAR_PCB_ARCHIVE_LOADER CADSTAR_SCH_ARCHIVE_LOADER

Classes

struct  ATTRCOL
 
struct  ATTRCOLORS
 
struct  ATTRIBUTE_LOCATION
 
struct  ATTRIBUTE_VALUE
 
struct  ATTRNAME
 NOTE from CADSTAR help: To convert a Part Definition Attribute into a hyperlink, prefix the attribute name with "Link ". More...
 
struct  CADSTAR_NETCLASS
 
struct  CODEDEFS
 
struct  CUTOUT
 Represents a cutout in a closed shape (e.g. More...
 
struct  DFLTSETTINGS
 
struct  DOCUMENTATION_SYMBOL
 
struct  EVALUE
 Represents a floating value in E notation. More...
 
struct  FIGURE
 
struct  FONT
 
struct  FORMAT
 
struct  GRID
 
struct  GRIDS
 
struct  GROUP
 
struct  HATCH
 
struct  HATCHCODE
 
struct  HEADER
 
struct  LINECODE
 
struct  LONGPOINT
 
struct  NET
 
struct  PARSER
 
struct  PARSER_CONTEXT
 
struct  PART
 
struct  PARTNAMECOL
 
struct  PARTS
 
struct  POINT
 Represents a point in x,y coordinates. More...
 
struct  REUSEBLOCK
 
struct  REUSEBLOCKREF
 References an element from a design reuse block. More...
 
struct  ROUTECODE
 
struct  ROUTEREASSIGN
 
struct  SETTINGS
 
struct  SHAPE
 
struct  SPCCLASSNAME
 
struct  SYMDEF
 
struct  TEXT
 
struct  TEXT_LOCATION
 Corresponds to CADSTAR "origin". More...
 
struct  TEXTCODE
 
struct  TIMESTAMP
 
struct  VARIANT
 < Nodename = "VARIANT" or "VMASTER" (master variant More...
 
struct  VARIANT_HIERARCHY
 
struct  VERTEX
 Represents a vertex in a shape. More...
 

Public Types

enum  TEXT_FIELD_NAME {
  TEXT_FIELD_NAME::DESIGN_TITLE, TEXT_FIELD_NAME::SHORT_JOBNAME, TEXT_FIELD_NAME::LONG_JOBNAME, TEXT_FIELD_NAME::NUM_OF_SHEETS,
  TEXT_FIELD_NAME::SHEET_NUMBER, TEXT_FIELD_NAME::SHEET_NAME, TEXT_FIELD_NAME::VARIANT_NAME, TEXT_FIELD_NAME::VARIANT_DESCRIPTION,
  TEXT_FIELD_NAME::REG_USER, TEXT_FIELD_NAME::COMPANY_NAME, TEXT_FIELD_NAME::CURRENT_USER, TEXT_FIELD_NAME::DATE,
  TEXT_FIELD_NAME::TIME, TEXT_FIELD_NAME::MACHINE_NAME, TEXT_FIELD_NAME::FROM_FILE, TEXT_FIELD_NAME::DISTANCE,
  TEXT_FIELD_NAME::UNITS_SHORT, TEXT_FIELD_NAME::UNITS_ABBREV, TEXT_FIELD_NAME::UNITS_FULL, TEXT_FIELD_NAME::HYPERLINK,
  TEXT_FIELD_NAME::NONE
}
 These are special fields in text objects enclosed between the tokens '<@' and '>' such as <@[FIELD_NAME][FIELD_VALUE]>. More...
 
enum  RESOLUTION { RESOLUTION::HUNDREDTH_MICRON }
 
enum  LINESTYLE {
  LINESTYLE::SOLID, LINESTYLE::DASH, LINESTYLE::DASHDOT, LINESTYLE::DASHDOTDOT,
  LINESTYLE::DOT
}
 
enum  VERTEX_TYPE {
  VERTEX_TYPE::POINT, VERTEX_TYPE::CLOCKWISE_ARC, VERTEX_TYPE::CLOCKWISE_SEMICIRCLE, VERTEX_TYPE::ANTICLOCKWISE_ARC,
  VERTEX_TYPE::ANTICLOCKWISE_SEMICIRCLE
}
 
enum  SHAPE_TYPE { SHAPE_TYPE::OPENSHAPE, SHAPE_TYPE::OUTLINE, SHAPE_TYPE::SOLID, SHAPE_TYPE::HATCHED }
 
enum  UNITS {
  UNITS::DESIGN, UNITS::THOU, UNITS::INCH, UNITS::MICROMETRE,
  UNITS::MM, UNITS::CENTIMETER, UNITS::METER
}
 
enum  ANGUNITS { ANGUNITS::DEGREES, ANGUNITS::RADIANS }
 
enum  GRID_TYPE { GRID_TYPE::FRACTIONALGRID, GRID_TYPE::STEPGRID }
 
enum  ALIGNMENT {
  ALIGNMENT::NO_ALIGNMENT, ALIGNMENT::TOPLEFT, ALIGNMENT::TOPCENTER, ALIGNMENT::TOPRIGHT,
  ALIGNMENT::CENTERLEFT, ALIGNMENT::CENTERCENTER, ALIGNMENT::CENTERRIGHT, ALIGNMENT::BOTTOMLEFT,
  ALIGNMENT::BOTTOMCENTER, ALIGNMENT::BOTTOMRIGHT
}
 From CADSTAR Help: "Text Alignment enables you to define the position of an alignment origin for all text items in CADSTAR. More...
 
enum  JUSTIFICATION { JUSTIFICATION::LEFT, JUSTIFICATION::CENTER, JUSTIFICATION::RIGHT }
 From CADSTAR Help: "Multi Line Text can also be justified as Left, Centre or Right. More...
 
enum  READABILITY { READABILITY::BOTTOM_TO_TOP, READABILITY::TOP_TO_BOTTOM }
 Sets the readability direction of text. More...
 
enum  ATTROWNER {
  ATTROWNER::ALL_ITEMS, ATTROWNER::AREA, ATTROWNER::BOARD, ATTROWNER::COMPONENT,
  ATTROWNER::CONNECTION, ATTROWNER::COPPER, ATTROWNER::DOCSYMBOL, ATTROWNER::FIGURE,
  ATTROWNER::NET, ATTROWNER::NETCLASS, ATTROWNER::PART, ATTROWNER::PART_DEFINITION,
  ATTROWNER::PIN, ATTROWNER::SIGNALREF, ATTROWNER::SYMBOL, ATTROWNER::SYMDEF,
  ATTROWNER::TEMPLATE, ATTROWNER::TESTPOINT
}
 
enum  ATTRUSAGE {
  ATTRUSAGE::BOTH, ATTRUSAGE::COMPONENT, ATTRUSAGE::PART_DEFINITION, ATTRUSAGE::PART_LIBRARY,
  ATTRUSAGE::SYMBOL, ATTRUSAGE::UNDEFINED
}
 
enum  SWAP_RULE { SWAP_RULE::NO_SWAP, SWAP_RULE::USE_SWAP_LAYER, SWAP_RULE::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_ARCHIVE_PARSER ()
 

Static Public Member Functions

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 XNODELoadArchiveFile (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< POINTParseAllChildPoints (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< VERTEXParseAllChildVertices (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< CUTOUTParseAllChildCutouts (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)
 

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_REPORTERm_progressReporter
 

Detailed Description

Helper functions and common structures for CADSTAR PCB and Schematic archive files.

Definition at line 86 of file cadstar_archive_parser.h.

Member Typedef Documentation

◆ ATTRIBUTE_ID

Definition at line 100 of file cadstar_archive_parser.h.

◆ COLOR_ID

Definition at line 114 of file cadstar_archive_parser.h.

◆ DOCUMENTATION_SYMBOL_ID

◆ FIGURE_ID

Definition at line 108 of file cadstar_archive_parser.h.

◆ GATE_ID

Definition at line 103 of file cadstar_archive_parser.h.

◆ GROUP_ID

Definition at line 109 of file cadstar_archive_parser.h.

◆ HATCHCODE_ID

Definition at line 93 of file cadstar_archive_parser.h.

◆ LAYER_ID

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

Definition at line 98 of file cadstar_archive_parser.h.

◆ LINECODE_ID

Definition at line 92 of file cadstar_archive_parser.h.

◆ NET_ID

Definition at line 111 of file cadstar_archive_parser.h.

◆ NETCLASS_ID

Definition at line 95 of file cadstar_archive_parser.h.

◆ NETELEMENT_ID

Definition at line 112 of file cadstar_archive_parser.h.

◆ PART_DEFINITION_PIN_ID

Pin identifier in the part definition.

Definition at line 105 of file cadstar_archive_parser.h.

◆ PART_ID

Definition at line 102 of file cadstar_archive_parser.h.

◆ PART_PIN_ID

Pin identifier in the part.

Definition at line 106 of file cadstar_archive_parser.h.

◆ REUSEBLOCK_ID

Definition at line 110 of file cadstar_archive_parser.h.

◆ ROUTECODE_ID

Definition at line 94 of file cadstar_archive_parser.h.

◆ SPACING_CLASS_ID

Definition at line 96 of file cadstar_archive_parser.h.

◆ SYMDEF_ID

Definition at line 101 of file cadstar_archive_parser.h.

◆ TERMINAL_ID

Terminal is the pin identifier in the schematic.

Definition at line 104 of file cadstar_archive_parser.h.

◆ TEXT_ID

Definition at line 107 of file cadstar_archive_parser.h.

◆ TEXTCODE_ID

Definition at line 97 of file cadstar_archive_parser.h.

◆ VARIANT_ID

Definition at line 99 of file cadstar_archive_parser.h.

Member Enumeration Documentation

◆ ALIGNMENT

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."

See also JUSTIFICATION

Enumerator
NO_ALIGNMENT 

NO_ALIGNMENT has different meaning depending on the object type.

TOPLEFT 
TOPCENTER 
TOPRIGHT 
CENTERLEFT 
CENTERCENTER 
CENTERRIGHT 
BOTTOMLEFT 
BOTTOMCENTER 
BOTTOMRIGHT 

Definition at line 576 of file cadstar_archive_parser.h.

577  {
578  NO_ALIGNMENT,
579  TOPLEFT,
580  TOPCENTER,
581  TOPRIGHT,
582  CENTERLEFT,
583  CENTERCENTER,
584  CENTERRIGHT,
585  BOTTOMLEFT,
586  BOTTOMCENTER,
587  BOTTOMRIGHT
588  };

◆ ANGUNITS

Enumerator
DEGREES 
RADIANS 

Definition at line 486 of file cadstar_archive_parser.h.

487  {
488  DEGREES,
489  RADIANS
490  };

◆ ATTROWNER

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 630 of file cadstar_archive_parser.h.

631  {
632  ALL_ITEMS,
633  AREA,
634  BOARD,
635  COMPONENT,
636  CONNECTION,
637  COPPER,
638  DOCSYMBOL,
639  FIGURE,
640  NET,
641  NETCLASS,
642  PART,
643  PART_DEFINITION,
644  PIN,
645  SIGNALREF,
646  SYMBOL,
647  SYMDEF,
648  TEMPLATE,
649  TESTPOINT
650  };
a test point pad
A collection of nets and the parameters used to route or test these nets.
Definition: netclass.h:46
This item represents a net.
Store all of the related footprint information found in a netlist.
Definition: pcb_netlist.h:84
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:191

◆ ATTRUSAGE

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 653 of file cadstar_archive_parser.h.

654  {
655  BOTH,
656  COMPONENT,
658  PART_DEFINITION,
659  PART_LIBRARY,
661  SYMBOL,
662  UNDEFINED
664  };
Store all of the related footprint information found in a netlist.
Definition: pcb_netlist.h:84

◆ GRID_TYPE

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 496 of file cadstar_archive_parser.h.

497  {
498  FRACTIONALGRID,
499  STEPGRID
501  };

◆ JUSTIFICATION

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

See also ALIGNMENT

Enumerator
LEFT 
CENTER 
RIGHT 

Definition at line 602 of file cadstar_archive_parser.h.

◆ LINESTYLE

Enumerator
SOLID 
DASH 
DASHDOT 
DASHDOTDOT 
DOT 

Definition at line 280 of file cadstar_archive_parser.h.

◆ READABILITY

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 620 of file cadstar_archive_parser.h.

621  {
622  BOTTOM_TO_TOP,
623  TOP_TO_BOTTOM
624  };

◆ RESOLUTION

Enumerator
HUNDREDTH_MICRON 

Definition at line 242 of file cadstar_archive_parser.h.

243  {
244  HUNDREDTH_MICRON
245  };

◆ SHAPE_TYPE

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 450 of file cadstar_archive_parser.h.

451  {
452  OPENSHAPE,
453  OUTLINE,
454  SOLID,
455  HATCHED
456  };

◆ SWAP_RULE

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 810 of file cadstar_archive_parser.h.

811  {
812  NO_SWAP,
813  USE_SWAP_LAYER,
814  BOTH
815  };

◆ TEXT_FIELD_NAME

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 135 of file cadstar_archive_parser.h.

136  {
137  DESIGN_TITLE,
138  SHORT_JOBNAME,
139  LONG_JOBNAME,
140  NUM_OF_SHEETS,
141  SHEET_NUMBER,
142  SHEET_NAME,
143  VARIANT_NAME,
144  VARIANT_DESCRIPTION,
145  REG_USER,
146  COMPANY_NAME,
147  CURRENT_USER,
148  DATE,
149  TIME,
150  MACHINE_NAME,
151  FROM_FILE,
152  DISTANCE,
153  UNITS_SHORT,
154  UNITS_ABBREV,
155  UNITS_FULL,
156  HYPERLINK,
157  NONE
158  };
Display value expressed in distance units (mm/inch)
Definition: property.h:53
No updates are required.
Definition: view_item.h:46

◆ UNITS

Enumerator
DESIGN 

Inherits from design units (assumed Assignments->Technology->Units)

THOU 
INCH 
MICROMETRE 
MM 
CENTIMETER 
METER 

Definition at line 471 of file cadstar_archive_parser.h.

472  {
473  DESIGN,
474  THOU,
475  INCH,
476  MICROMETRE,
477  MM,
478  CENTIMETER,
479  METER
480  };
Definition: rs274x.cpp:63

◆ VERTEX_TYPE

Enumerator
POINT 
CLOCKWISE_ARC 
CLOCKWISE_SEMICIRCLE 
ANTICLOCKWISE_ARC 
ANTICLOCKWISE_SEMICIRCLE 

Definition at line 416 of file cadstar_archive_parser.h.

417  {
418  POINT,
419  CLOCKWISE_ARC,
420  CLOCKWISE_SEMICIRCLE,
421  ANTICLOCKWISE_ARC,
422  ANTICLOCKWISE_SEMICIRCLE
423  };

Constructor & Destructor Documentation

◆ CADSTAR_ARCHIVE_PARSER()

CADSTAR_ARCHIVE_PARSER::CADSTAR_ARCHIVE_PARSER ( )
inline

Definition at line 89 of file cadstar_archive_parser.h.

89 { m_progressReporter = nullptr; }
PROGRESS_REPORTER * m_progressReporter

References m_progressReporter.

Member Function Documentation

◆ CheckNoChildNodes()

◆ CheckNoNextNodes()

void CADSTAR_ARCHIVE_PARSER::CheckNoNextNodes ( XNODE aNode)
static

◆ checkPoint()

void CADSTAR_ARCHIVE_PARSER::checkPoint ( )
protected

Updates m_progressReporter or throws if user cancelled.

Definition at line 2645 of file cadstar_archive_parser.cpp.

2646 {
2647  if( m_progressReporter )
2648  {
2650 
2652  THROW_IO_ERROR( _( "File import cancelled by user." ) );
2653  }
2654 }
virtual void AdvanceProgress()=0
Increment the progress bar length (inside the current virtual zone).
#define _(s)
PROGRESS_REPORTER * m_progressReporter
virtual bool KeepRefreshing(bool aWait=false)=0
Update the UI (if any).
#define THROW_IO_ERROR(msg)
Definition: ki_exception.h:38

References _, PROGRESS_REPORTER::AdvanceProgress(), PROGRESS_REPORTER::KeepRefreshing(), 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(), CADSTAR_SCH_ARCHIVE_PARSER::Parse(), and CADSTAR_PCB_ARCHIVE_PARSER::Parse().

◆ FixTextPositionNoAlignment()

void CADSTAR_ARCHIVE_PARSER::FixTextPositionNoAlignment ( EDA_TEXT aKiCadTextItem)
static

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
aKiCadTextItema Kicad item to correct

Definition at line 2617 of file cadstar_archive_parser.cpp.

2618 {
2619  if( !aKiCadTextItem->GetText().IsEmpty() )
2620  {
2621  int txtAngleDecideg = aKiCadTextItem->GetTextAngleDegrees() * 10.0;
2622  wxPoint positionOffset( 0, aKiCadTextItem->GetInterline() );
2623  RotatePoint( &positionOffset, txtAngleDecideg );
2624 
2625  EDA_ITEM* textEdaItem = dynamic_cast<EDA_ITEM*>( aKiCadTextItem );
2626 
2627  if( textEdaItem &&
2628  ( textEdaItem->Type() == LIB_TEXT_T || textEdaItem->Type() == LIB_FIELD_T ) )
2629  {
2630  // Y coordinate increases upwards in the symbol editor
2631  positionOffset.y = -positionOffset.y;
2632  }
2633 
2634  //Count num of additional lines
2635  wxString text = aKiCadTextItem->GetText();
2636  int numExtraLines = text.Replace( wxT( "\n" ), wxT( "\n" ) );
2637  numExtraLines -= text.at( text.size() - 1 ) == '\n'; // Ignore new line character at end
2638  positionOffset.x *= numExtraLines;
2639  positionOffset.y *= numExtraLines;
2640 
2641  aKiCadTextItem->Offset( positionOffset );
2642  }
2643 }
void Offset(const wxPoint &aOffset)
Definition: eda_text.h:273
int GetInterline() const
Return the distance between two lines of text.
Definition: eda_text.cpp:233
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:229
double GetTextAngleDegrees() const
Definition: eda_text.h:197
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:99
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:154
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:112

References EDA_TEXT::GetInterline(), EDA_TEXT::GetText(), EDA_TEXT::GetTextAngleDegrees(), LIB_FIELD_T, LIB_TEXT_T, EDA_TEXT::Offset(), RotatePoint(), text, and EDA_ITEM::Type().

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 
)
inlinestatic

Definition at line 1402 of file cadstar_archive_parser.h.

1403  {
1404  return aRefName
1405  + ( ( aAlternateName.size() > 0 ) ? ( wxT( " (" ) + aAlternateName + wxT( ")" ) )
1406  : wxString() );
1407  }

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary().

◆ GetNumberOfChildNodes()

long CADSTAR_ARCHIVE_PARSER::GetNumberOfChildNodes ( XNODE aNode)
static

Definition at line 2575 of file cadstar_archive_parser.cpp.

2576 {
2577  XNODE* childNodes = aNode->GetChildren();
2578  long retval = 0;
2579 
2580  for( ; childNodes; childNodes = childNodes->GetNext() )
2581  retval++;
2582 
2583  return retval;
2584 }
XNODE * GetChildren() const
Definition: xnode.h:62
Hold an XML or S-expression element.
Definition: xnode.h:43
XNODE * GetNext() const
Definition: xnode.h:67

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

Referenced by GetNumberOfStepsForReporting().

◆ GetNumberOfStepsForReporting()

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

Definition at line 2587 of file cadstar_archive_parser.cpp.

2588 {
2589  XNODE* level1Node = aRootNode->GetChildren();
2590  long retval = 0;
2591 
2592  for( ; level1Node; level1Node = level1Node->GetNext() )
2593  {
2594  for( wxString childNodeName : aSubNodeChildrenToCount )
2595  {
2596  if( level1Node->GetName() == childNodeName )
2597  retval += GetNumberOfChildNodes( level1Node );
2598  }
2599 
2600  retval++;
2601  }
2602 
2603  return retval;
2604 }
static long GetNumberOfChildNodes(XNODE *aNode)
XNODE * GetChildren() const
Definition: xnode.h:62
Hold an XML or S-expression element.
Definition: xnode.h:43
XNODE * GetNext() const
Definition: xnode.h:67

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

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

◆ GetXmlAttributeIDLong()

long CADSTAR_ARCHIVE_PARSER::GetXmlAttributeIDLong ( XNODE aNode,
unsigned int  aID,
bool  aIsRequired = true 
)
static
Parameters
aNode
aID
aIsRequiredPrevents exception throwing if false.
Returns
returns the value (long) of attribute "attrX" in aNode where 'X' is aID
Exceptions
IO_ERRORif attribute does not exist

Definition at line 2447 of file cadstar_archive_parser.cpp.

2449 {
2450  long retVal;
2451  bool success = GetXmlAttributeIDString( aNode, aID, aIsRequired ).ToLong( &retVal );
2452 
2453  if( !success )
2454  {
2455  if( aIsRequired )
2456  THROW_PARSING_IO_ERROR( std::to_string( aID ), aNode->GetName() );
2457  else
2458  return UNDEFINED_VALUE;
2459  }
2460 
2461  return retVal;
2462 }
#define THROW_PARSING_IO_ERROR(param, location)
static const long UNDEFINED_VALUE
static wxString GetXmlAttributeIDString(XNODE *aNode, unsigned int aID, bool aIsRequired=true)

References GetXmlAttributeIDString(), THROW_PARSING_IO_ERROR, and UNDEFINED_VALUE.

Referenced by CADSTAR_SCH_ARCHIVE_PARSER::TERMINAL_SHAPE::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::TERMINAL::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::PIN_NUM_LABEL_LOC::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::LAYER::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::COPREASSIGN::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::COPPERCODE::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::TERMATTR::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::SPACINGCODE::REASSIGN::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::SYMPINNAME_LABEL::Parse(), CADSTAR_ARCHIVE_PARSER::FORMAT::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::SPACINGCODE::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::SYMBOL::PIN_NUM::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::CADSTAR_PAD_SHAPE::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::SYMBOL::Parse(), CADSTAR_ARCHIVE_PARSER::HATCH::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::PADCODE::Parse(), CADSTAR_ARCHIVE_PARSER::FONT::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::VIACODE::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::LAYERPAIR::Parse(), CADSTAR_ARCHIVE_PARSER::TEXTCODE::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::SPCCLASSSPACE::Parse(), CADSTAR_ARCHIVE_PARSER::ROUTEREASSIGN::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::NET_SCH::SYM_TERM::Parse(), CADSTAR_ARCHIVE_PARSER::ROUTECODE::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::NET_SCH::BLOCK_TERM::Parse(), CADSTAR_ARCHIVE_PARSER::POINT::Parse(), CADSTAR_ARCHIVE_PARSER::LONGPOINT::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::TECHNOLOGY_SECTION::Parse(), CADSTAR_ARCHIVE_PARSER::GRID::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::COMPONENT_PAD::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::DIMENSION::ARROW::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::DIMENSION::TEXTFORMAT::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::DIMENSION::EXTENSION_LINE::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::DIMENSION::LINE::Parse(), CADSTAR_ARCHIVE_PARSER::ATTRNAME::COLUMNORDER::Parse(), CADSTAR_ARCHIVE_PARSER::ATTRNAME::COLUMNWIDTH::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::DIMENSION::Parse(), CADSTAR_ARCHIVE_PARSER::TEXT_LOCATION::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::SYMDEF_PCB::Parse(), CADSTAR_ARCHIVE_PARSER::REUSEBLOCK::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::AREA::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::PIN_ATTRIBUTE::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::PADEXCEPTION::Parse(), CADSTAR_ARCHIVE_PARSER::TEXT::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::COMPONENT::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::NET_PCB::PIN::Parse(), CADSTAR_ARCHIVE_PARSER::PART::DEFINITION::GATE::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::NET_PCB::COPPER_TERMINAL::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::NET_PCB::ROUTE_VERTEX::Parse(), CADSTAR_ARCHIVE_PARSER::PART::DEFINITION::PIN::Parse(), CADSTAR_ARCHIVE_PARSER::PART::DEFINITION::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::TEMPLATE::POURING::Parse(), CADSTAR_ARCHIVE_PARSER::PART::PART_PIN::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::COPPER::NETREF::COPPER_TERM::Parse(), CADSTAR_ARCHIVE_PARSER::PART::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::DRILL_TABLE::Parse(), CADSTAR_ARCHIVE_PARSER::DOCUMENTATION_SYMBOL::Parse(), CADSTAR_ARCHIVE_PARSER::SETTINGS::ParseSubNode(), CADSTAR_ARCHIVE_PARSER::ATTRIBUTE_LOCATION::ParseSubNode(), CADSTAR_ARCHIVE_PARSER::SYMDEF::ParseSubNode(), and CADSTAR_ARCHIVE_PARSER::NET::ParseSubNode().

◆ GetXmlAttributeIDString()

wxString CADSTAR_ARCHIVE_PARSER::GetXmlAttributeIDString ( XNODE aNode,
unsigned int  aID,
bool  aIsRequired = true 
)
static
Parameters
aNode
aID
aIsRequiredPrevents exception throwing if false.
Returns
returns the value (wxString) of attribute "attrX" in aNode where 'X' is aID
Exceptions
IO_ERRORif attribute does not exist

Definition at line 2428 of file cadstar_archive_parser.cpp.

2430 {
2431  wxString attrName, retVal;
2432  attrName = wxT( "attr" );
2433  attrName << aID;
2434 
2435  if( !aNode->GetAttribute( attrName, &retVal ) )
2436  {
2437  if( aIsRequired )
2438  THROW_MISSING_PARAMETER_IO_ERROR( std::to_string( aID ), aNode->GetName() );
2439  else
2440  return wxEmptyString;
2441  }
2442 
2443  return retVal;
2444 }
#define THROW_MISSING_PARAMETER_IO_ERROR(param, location)

References THROW_MISSING_PARAMETER_IO_ERROR.

Referenced by CADSTAR_ARCHIVE_PARSER::PART::GetPinType(), GetXmlAttributeIDLong(), CADSTAR_PCB_ARCHIVE_PARSER::MATERIAL::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::TERMINALCODE::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::TERMINAL::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::PIN_NUM_LABEL_LOC::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::LAYER::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::SHEETS::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::LAYERDEFS::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::COMP::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::COPREASSIGN::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::PARTREF::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::COPPERCODE::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::SPACINGCODE::REASSIGN::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::SYMPINNAME_LABEL::Parse(), CADSTAR_ARCHIVE_PARSER::FORMAT::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::SYMBOLVARIANT::Parse(), CADSTAR_ARCHIVE_PARSER::TIMESTAMP::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::SIGNALREFERENCELINK::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::SPACINGCODE::Parse(), CADSTAR_ARCHIVE_PARSER::HEADER::Parse(), CADSTAR_ARCHIVE_PARSER::VARIANT::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::PADREASSIGN::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::SYMBOL::Parse(), CADSTAR_ARCHIVE_PARSER::LINECODE::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::SIGLOC::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::PADCODE::Parse(), CADSTAR_ARCHIVE_PARSER::HATCHCODE::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::BUS::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::VIAREASSIGN::Parse(), CADSTAR_ARCHIVE_PARSER::FONT::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::VIACODE::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::BLOCK::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::LAYERPAIR::Parse(), CADSTAR_ARCHIVE_PARSER::TEXTCODE::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::NET_SCH::JUNCTION_SCH::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::SPCCLASSSPACE::Parse(), CADSTAR_ARCHIVE_PARSER::ROUTEREASSIGN::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::NET_SCH::SYM_TERM::Parse(), CADSTAR_ARCHIVE_PARSER::ROUTECODE::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::NET_SCH::BUS_TERM::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::RULESET::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::NET_SCH::BLOCK_TERM::Parse(), CADSTAR_ARCHIVE_PARSER::EVALUE::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::NET_SCH::DANGLER::Parse(), CADSTAR_SCH_ARCHIVE_PARSER::NET_SCH::CONNECTION_SCH::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::COMPONENT_COPPER::Parse(), CADSTAR_ARCHIVE_PARSER::SHAPE::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::COMPONENT_AREA::Parse(), CADSTAR_ARCHIVE_PARSER::GRID::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::COMPONENT_PAD::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::DIMENSION::ARROW::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::DIMENSION::TEXTFORMAT::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::DIMENSION::EXTENSION_LINE::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::DIMENSION::LINE::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::DIMENSION::Parse(), CADSTAR_ARCHIVE_PARSER::ATTRNAME::Parse(), CADSTAR_ARCHIVE_PARSER::ATTRIBUTE_VALUE::Parse(), CADSTAR_ARCHIVE_PARSER::TEXT_LOCATION::Parse(), CADSTAR_ARCHIVE_PARSER::CADSTAR_NETCLASS::Parse(), CADSTAR_ARCHIVE_PARSER::SPCCLASSNAME::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::CADSTAR_BOARD::Parse(), CADSTAR_ARCHIVE_PARSER::REUSEBLOCK::Parse(), CADSTAR_ARCHIVE_PARSER::REUSEBLOCKREF::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::AREA::Parse(), CADSTAR_ARCHIVE_PARSER::GROUP::Parse(), CADSTAR_ARCHIVE_PARSER::FIGURE::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::PADEXCEPTION::Parse(), CADSTAR_ARCHIVE_PARSER::TEXT::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::COMPONENT::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::TRUNK::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::NET_PCB::PIN::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::NET_PCB::JUNCTION_PCB::Parse(), CADSTAR_ARCHIVE_PARSER::PART::DEFINITION::GATE::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::NET_PCB::VIA::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::NET_PCB::COPPER_TERMINAL::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::NET_PCB::ROUTE::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::NET_PCB::CONNECTION_PCB::Parse(), CADSTAR_ARCHIVE_PARSER::PART::DEFINITION::PIN::Parse(), CADSTAR_ARCHIVE_PARSER::PART::DEFINITION::SWAP_GROUP::Parse(), CADSTAR_ARCHIVE_PARSER::PART::DEFINITION::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::TEMPLATE::POURING::Parse(), CADSTAR_ARCHIVE_PARSER::PART::PART_PIN::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::TEMPLATE::Parse(), CADSTAR_ARCHIVE_PARSER::PART::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::COPPER::NETREF::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::COPPER::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::DRILL_TABLE::Parse(), CADSTAR_PCB_ARCHIVE_PARSER::LAYOUT::Parse(), CADSTAR_ARCHIVE_PARSER::DOCUMENTATION_SYMBOL::Parse(), CADSTAR_ARCHIVE_PARSER::DFLTSETTINGS::Parse(), CADSTAR_ARCHIVE_PARSER::ATTRCOL::Parse(), CADSTAR_ARCHIVE_PARSER::PARTNAMECOL::Parse(), ParseAlignment(), ParseAngunits(), CADSTAR_ARCHIVE_PARSER::ATTRIBUTE_LOCATION::ParseIdentifiers(), CADSTAR_ARCHIVE_PARSER::SYMDEF::ParseIdentifiers(), CADSTAR_ARCHIVE_PARSER::NET::JUNCTION::ParseIdentifiers(), CADSTAR_ARCHIVE_PARSER::NET::CONNECTION::ParseIdentifiers(), CADSTAR_ARCHIVE_PARSER::NET::ParseIdentifiers(), ParseJustification(), ParseReadability(), CADSTAR_ARCHIVE_PARSER::NET::JUNCTION::ParseSubNode(), CADSTAR_ARCHIVE_PARSER::NET::CONNECTION::ParseSubNode(), CADSTAR_ARCHIVE_PARSER::NET::ParseSubNode(), ParseSwapRule(), CADSTAR_PCB_ARCHIVE_PARSER::ParseTestlandSide(), and ParseUnits().

◆ HandleTextOverbar()

wxString CADSTAR_ARCHIVE_PARSER::HandleTextOverbar ( wxString  aCadstarString)
static

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

Parameters
aCadstarStringInput string
Returns
KiCad string with overbar characters

Definition at line 2607 of file cadstar_archive_parser.cpp.

2608 {
2609  wxString escapedText = aCadstarString;
2610 
2611  escapedText.Replace( wxT( "'" ), wxT( "~" ) );
2612 
2613  return ConvertToNewOverbarNotation( escapedText );
2614 }
wxString ConvertToNewOverbarNotation(const wxString &aOldStr)
Convert the old ~...~ overbar notation to the new ~{...} one.

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 
)
static

Definition at line 2297 of file cadstar_archive_parser.cpp.

2298 {
2299  wxString result;
2300  int numAttributes = 0;
2301 
2302  if( aNode->GetAttribute( wxT( "numAttributes" ), &result ) )
2303  {
2304  numAttributes = wxAtoi( result );
2305  aNode->DeleteAttribute( wxT( "numAttributes" ) );
2306  ++numAttributes;
2307  }
2308 
2309  aNode->AddAttribute( wxT( "numAttributes" ), wxString::Format( wxT( "%i" ), numAttributes ) );
2310 
2311  wxString paramName = wxT( "attr" );
2312  paramName << numAttributes;
2313 
2314  aNode->AddAttribute( paramName, aValue );
2315 }
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200

References Format().

Referenced by LoadArchiveFile().

◆ IsValidAttribute()

◆ LoadArchiveFile()

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

Reads a CADSTAR Archive file (S-parameter format)

Parameters
aFileName
aFileTypeIdentifierIdentifier of the first node in the file to check against. E.g. "CADSTARPCB"
aProgressReporterPointer 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 2318 of file cadstar_archive_parser.cpp.

2320 {
2321  KEYWORD emptyKeywords[1] = {};
2322  XNODE * iNode = nullptr, *cNode = nullptr;
2323  int tok;
2324  bool cadstarFileCheckDone = false;
2325  wxString str;
2326  wxCSConv win1252( wxT( "windows-1252" ) );
2327  wxMBConv* conv = &win1252; // Initial testing suggests file encoding to be Windows-1252
2328  // More samples required.
2329 
2330  // Open the file and get the file size
2331  FILE* fp = wxFopen( aFileName, wxT( "rt" ) );
2332 
2333  if( !fp )
2334  THROW_IO_ERROR( wxString::Format( _( "Cannot open file '%s'" ), aFileName ) );
2335 
2336  fseek( fp, 0L, SEEK_END );
2337  long fileSize = ftell( fp );
2338  rewind( fp );
2339 
2340  DSNLEXER lexer( emptyKeywords, 0, fp, aFileName );
2341 
2342  auto currentProgress = [&]() -> double
2343  {
2344  return static_cast<double>( ftell( fp ) ) / fileSize;
2345  };
2346 
2347  double previousReportedProgress = -1.0;
2348 
2349  while( ( tok = lexer.NextTok() ) != DSN_EOF )
2350  {
2351  if( aProgressReporter && ( currentProgress() - previousReportedProgress ) > 0.01 )
2352  {
2353  if( !aProgressReporter->KeepRefreshing() )
2354  THROW_IO_ERROR( _( "File import cancelled by user." ) );
2355 
2356  aProgressReporter->SetCurrentProgress( currentProgress() );
2357  previousReportedProgress = currentProgress();
2358  }
2359 
2360  if( tok == DSN_RIGHT )
2361  {
2362  cNode = iNode;
2363  if( cNode )
2364  {
2365  iNode = cNode->GetParent();
2366  }
2367  else
2368  {
2369  //too many closing brackets
2370  THROW_IO_ERROR( _( "The selected file is not valid or might be corrupt!" ) );
2371  }
2372  }
2373  else if( tok == DSN_LEFT )
2374  {
2375  tok = lexer.NextTok();
2376  str = wxString( lexer.CurText(), *conv );
2377  cNode = new XNODE( wxXML_ELEMENT_NODE, str );
2378 
2379  if( iNode )
2380  {
2381  //we will add it as attribute as well as child node
2382  InsertAttributeAtEnd( iNode, str );
2383  iNode->AddChild( cNode );
2384  }
2385  else if( !cadstarFileCheckDone )
2386  {
2387  if( cNode->GetName() != aFileTypeIdentifier )
2388  THROW_IO_ERROR( _( "The selected file is not valid or might be corrupt!" ) );
2389 
2390  cadstarFileCheckDone = true;
2391  }
2392 
2393  iNode = cNode;
2394  }
2395  else if( iNode )
2396  {
2397  str = wxString( lexer.CurText(), *conv );
2398  //Insert even if string is empty
2399  InsertAttributeAtEnd( iNode, str );
2400  }
2401  else
2402  {
2403  //not enough closing brackets
2404  THROW_IO_ERROR( _( "The selected file is not valid or might be corrupt!" ) );
2405  }
2406  }
2407 
2408  // Not enough closing brackets
2409  if( iNode != nullptr )
2410  THROW_IO_ERROR( _( "The selected file is not valid or might be corrupt!" ) );
2411 
2412  // Throw if no data was parsed
2413  if( cNode )
2414  return cNode;
2415  else
2416  THROW_IO_ERROR( _( "The selected file is not valid or might be corrupt!" ) );
2417 
2418  return nullptr;
2419 }
XNODE * GetParent() const
Definition: xnode.h:72
#define _(s)
Hold an XML or S-expression element.
Definition: xnode.h:43
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
static void InsertAttributeAtEnd(XNODE *aNode, wxString aValue)
virtual bool KeepRefreshing(bool aWait=false)=0
Update the UI (if any).
Hold a keyword string and its unique integer token.
Definition: dsnlexer.h:39
#define THROW_IO_ERROR(msg)
Definition: ki_exception.h:38
Implement a lexical analyzer for the SPECCTRA DSN file format.
Definition: dsnlexer.h:78
virtual void SetCurrentProgress(double aProgress)=0
Set the progress value to aProgress (0..1).

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

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

◆ ParseAlignment()

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

Definition at line 937 of file cadstar_archive_parser.cpp.

938 {
939  wxASSERT( aNode->GetName() == wxT( "ALIGN" ) );
940 
941  wxString alignmentStr = GetXmlAttributeIDString( aNode, 0 );
942 
943  if( alignmentStr == wxT( "BOTTOMCENTER" ) )
945  else if( alignmentStr == wxT( "BOTTOMLEFT" ) )
946  return ALIGNMENT::BOTTOMLEFT;
947  else if( alignmentStr == wxT( "BOTTOMRIGHT" ) )
948  return ALIGNMENT::BOTTOMRIGHT;
949  else if( alignmentStr == wxT( "CENTERCENTER" ) )
951  else if( alignmentStr == wxT( "CENTERLEFT" ) )
952  return ALIGNMENT::CENTERLEFT;
953  else if( alignmentStr == wxT( "CENTERRIGHT" ) )
954  return ALIGNMENT::CENTERRIGHT;
955  else if( alignmentStr == wxT( "TOPCENTER" ) )
956  return ALIGNMENT::TOPCENTER;
957  else if( alignmentStr == wxT( "TOPLEFT" ) )
958  return ALIGNMENT::TOPLEFT;
959  else if( alignmentStr == wxT( "TOPRIGHT" ) )
960  return ALIGNMENT::TOPRIGHT;
961  else
962  THROW_UNKNOWN_PARAMETER_IO_ERROR( alignmentStr, wxT( "ALIGN" ) );
963 
964  //shouldn't be here but avoids compiler warning
966 }
static wxString GetXmlAttributeIDString(XNODE *aNode, unsigned int aID, bool aIsRequired=true)
NO_ALIGNMENT has different meaning depending on the object type.
#define THROW_UNKNOWN_PARAMETER_IO_ERROR(param, location)

References BOTTOMCENTER, BOTTOMLEFT, BOTTOMRIGHT, CENTERCENTER, CENTERLEFT, CENTERRIGHT, GetXmlAttributeIDString(), NO_ALIGNMENT, THROW_UNKNOWN_PARAMETER_IO_ERROR, TOPCENTER, TOPLEFT, and 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 
)
static

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

Parameters
aNodecontaining a series of CUTOUT objects
aTestAllChildNodes
aExpectedNumPointsif -1, this is check is disabled
Returns
std::vector containing all CUTOUT objects
Exceptions
IO_ERRORif 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 2549 of file cadstar_archive_parser.cpp.

2551 {
2552  std::vector<CUTOUT> retVal;
2553 
2554  XNODE* cNode = aNode->GetChildren();
2555 
2556  for( ; cNode; cNode = cNode->GetNext() )
2557  {
2558  if( cNode->GetName() == wxT( "CUTOUT" ) )
2559  {
2560  CUTOUT cutout;
2561  //TODO try.. catch + throw again with more detailed error information
2562  cutout.Parse( cNode, aContext );
2563  retVal.push_back( cutout );
2564  }
2565  else if( aTestAllChildNodes )
2566  {
2567  THROW_UNKNOWN_NODE_IO_ERROR( cNode->GetName(), aNode->GetName() );
2568  }
2569  }
2570 
2571  return retVal;
2572 }
XNODE * GetChildren() const
Definition: xnode.h:62
Make a cutout to an existing zone.
Hold an XML or S-expression element.
Definition: xnode.h:43
XNODE * GetNext() const
Definition: xnode.h:67
#define THROW_UNKNOWN_NODE_IO_ERROR(nodename, location)

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 
)
static

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

Parameters
aNodecontaining a series of POINT objects
aTestAllChildNodes
aExpectedNumPointsif UNDEFINED_VALUE (i.e. -1), this is check is disabled
Returns
std::vector containing all POINT objects
Exceptions
IO_ERRORif 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 2489 of file cadstar_archive_parser.cpp.

2491 {
2492  std::vector<POINT> retVal;
2493 
2494  XNODE* cNode = aNode->GetChildren();
2495 
2496  for( ; cNode; cNode = cNode->GetNext() )
2497  {
2498  if( cNode->GetName() == wxT( "PT" ) )
2499  {
2500  POINT pt;
2501  //TODO try.. catch + throw again with more detailed error information
2502  pt.Parse( cNode, aContext );
2503  retVal.push_back( pt );
2504  }
2505  else if( aTestAllChildNodes )
2506  {
2507  THROW_UNKNOWN_NODE_IO_ERROR( cNode->GetName(), aNode->GetName() );
2508  }
2509  }
2510 
2511  if( aExpectedNumPoints != UNDEFINED_VALUE
2512  && retVal.size() != static_cast<size_t>( aExpectedNumPoints ) )
2513  {
2515  _( "Unexpected number of points in '%s'. Found %d but expected %d." ),
2516  aNode->GetName(), retVal.size(), aExpectedNumPoints ) );
2517  }
2518 
2519  return retVal;
2520 }
XNODE * GetChildren() const
Definition: xnode.h:62
#define _(s)
static const long UNDEFINED_VALUE
Hold an XML or S-expression element.
Definition: xnode.h:43
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
XNODE * GetNext() const
Definition: xnode.h:67
#define THROW_UNKNOWN_NODE_IO_ERROR(nodename, location)
#define THROW_IO_ERROR(msg)
Definition: ki_exception.h:38

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

Referenced by CADSTAR_SCH_ARCHIVE_PARSER::NET_SCH::CONNECTION_SCH::Parse(), CADSTAR_ARCHIVE_PARSER::VERTEX::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 
)
static

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

Parameters
aNodecontaining a series of VERTEX objects
aTestAllChildNodes
aExpectedNumPointsif -1, this is check is disabled
Returns
std::vector containing all VERTEX objects
Exceptions
IO_ERRORif 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 2523 of file cadstar_archive_parser.cpp.

2525 {
2526  std::vector<VERTEX> retVal;
2527 
2528  XNODE* cNode = aNode->GetChildren();
2529 
2530  for( ; cNode; cNode = cNode->GetNext() )
2531  {
2532  if( VERTEX::IsVertex( cNode ) )
2533  {
2534  VERTEX vertex;
2535  //TODO try.. catch + throw again with more detailed error information
2536  vertex.Parse( cNode, aContext );
2537  retVal.push_back( vertex );
2538  }
2539  else if( aTestAllChildNodes )
2540  {
2541  THROW_UNKNOWN_NODE_IO_ERROR( cNode->GetName(), aNode->GetName() );
2542  }
2543  }
2544 
2545  return retVal;
2546 }
XNODE * GetChildren() const
Definition: xnode.h:62
Hold an XML or S-expression element.
Definition: xnode.h:43
XNODE * GetNext() const
Definition: xnode.h:67
#define THROW_UNKNOWN_NODE_IO_ERROR(nodename, location)

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)
static

Definition at line 576 of file cadstar_archive_parser.cpp.

577 {
578  wxASSERT( aNode->GetName() == wxT( "ANGUNITS" ) );
579 
580  wxString angUnitStr = GetXmlAttributeIDString( aNode, 0 );
581 
582  if( angUnitStr == wxT( "DEGREES" ) )
583  return ANGUNITS::DEGREES;
584  else if( angUnitStr == wxT( "RADIANS" ) )
585  return ANGUNITS::RADIANS;
586  else
587  THROW_UNKNOWN_PARAMETER_IO_ERROR( angUnitStr, aNode->GetName() );
588 
589  return ANGUNITS();
590 }
static wxString GetXmlAttributeIDString(XNODE *aNode, unsigned int aID, bool aIsRequired=true)
#define THROW_UNKNOWN_PARAMETER_IO_ERROR(param, location)

References DEGREES, GetXmlAttributeIDString(), 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 
)
static
Parameters
aNodewith a child node containing an EVALUE
aValueToParse
Exceptions
IO_ERRORif unable to parse or node is not an EVALUE

Definition at line 2479 of file cadstar_archive_parser.cpp.

2481 {
2482  if( aNode->GetChildren()->GetName() == wxT( "E" ) )
2483  aValueToParse.Parse( aNode->GetChildren(), aContext );
2484  else
2485  THROW_UNKNOWN_NODE_IO_ERROR( aNode->GetChildren()->GetName(), aNode->GetName() );
2486 }
XNODE * GetChildren() const
Definition: xnode.h:62
#define THROW_UNKNOWN_NODE_IO_ERROR(nodename, location)

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)
static

Definition at line 969 of file cadstar_archive_parser.cpp.

970 {
971  wxASSERT( aNode->GetName() == wxT( "JUSTIFICATION" ) );
972 
973  wxString justificationStr = GetXmlAttributeIDString( aNode, 0 );
974 
975  if( justificationStr == wxT( "LEFT" ) )
976  return JUSTIFICATION::LEFT;
977  else if( justificationStr == wxT( "RIGHT" ) )
978  return JUSTIFICATION::RIGHT;
979  else if( justificationStr == wxT( "CENTER" ) )
980  return JUSTIFICATION::CENTER;
981  else
982  THROW_UNKNOWN_PARAMETER_IO_ERROR( justificationStr, wxT( "JUSTIFICATION" ) );
983 
984  return JUSTIFICATION::LEFT;
985 }
static wxString GetXmlAttributeIDString(XNODE *aNode, unsigned int aID, bool aIsRequired=true)
#define THROW_UNKNOWN_PARAMETER_IO_ERROR(param, location)

References CENTER, GetXmlAttributeIDString(), LEFT, 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)
static

Definition at line 988 of file cadstar_archive_parser.cpp.

989 {
990  wxASSERT( aNode->GetName() == wxT( "READABILITY" ) );
991 
992  wxString readabilityStr = GetXmlAttributeIDString( aNode, 0 );
993 
994  if( readabilityStr == wxT( "BOTTOM_TO_TOP" ) )
996  else if( readabilityStr == wxT( "TOP_TO_BOTTOM" ) )
998  else
999  THROW_UNKNOWN_PARAMETER_IO_ERROR( readabilityStr, wxT( "READABILITY" ) );
1000 
1002 }
When text is vertical, show it rotated 90 degrees clockwise.
static wxString GetXmlAttributeIDString(XNODE *aNode, unsigned int aID, bool aIsRequired=true)
#define THROW_UNKNOWN_PARAMETER_IO_ERROR(param, location)
When text is vertical, show it rotated 90 degrees anticlockwise.

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

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

◆ ParseSwapRule()

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

Definition at line 1400 of file cadstar_archive_parser.cpp.

1401 {
1402  wxASSERT( aNode->GetName() == wxT( "SWAPRULE" ) );
1403 
1404  SWAP_RULE retval;
1405  wxString swapRuleStr = GetXmlAttributeIDString( aNode, 0 );
1406 
1407  if( swapRuleStr == wxT( "NO_SWAP" ) )
1408  retval = SWAP_RULE::NO_SWAP;
1409  else if( swapRuleStr == wxT( "USE_SWAP_LAYER" ) )
1410  retval = SWAP_RULE::USE_SWAP_LAYER;
1411  else
1412  THROW_UNKNOWN_PARAMETER_IO_ERROR( swapRuleStr, wxT( "SWAPRULE" ) );
1413 
1414  return retval;
1415 }
SWAP_RULE
Corresponds to "Display when" Item property.
static wxString GetXmlAttributeIDString(XNODE *aNode, unsigned int aID, bool aIsRequired=true)
#define THROW_UNKNOWN_PARAMETER_IO_ERROR(param, location)

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

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

◆ ParseTextFields()

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

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

Parameters
aTextStringText string to parse
aParserContextPARSER_CONTEXT in which to store the values of the found fields
Returns

Definition at line 743 of file cadstar_archive_parser.cpp.

745 {
746  static const std::map<TEXT_FIELD_NAME, wxString> txtTokens =
747  {
748  { TEXT_FIELD_NAME::DESIGN_TITLE, wxT( "DESIGN TITLE" ) },
749  { TEXT_FIELD_NAME::SHORT_JOBNAME, wxT( "SHORT_JOBNAME" ) },
750  { TEXT_FIELD_NAME::LONG_JOBNAME, wxT( "LONG_JOBNAME" ) },
751  { TEXT_FIELD_NAME::NUM_OF_SHEETS, wxT( "NUM_OF_SHEETS" ) },
752  { TEXT_FIELD_NAME::SHEET_NUMBER, wxT( "SHEET_NUMBER" ) },
753  { TEXT_FIELD_NAME::SHEET_NAME, wxT( "SHEET_NAME" ) },
754  { TEXT_FIELD_NAME::VARIANT_NAME, wxT( "VARIANT_NAME" ) },
755  { TEXT_FIELD_NAME::VARIANT_DESCRIPTION, wxT( "VARIANT_DESCRIPTION" ) },
756  { TEXT_FIELD_NAME::REG_USER, wxT( "REG_USER" ) },
757  { TEXT_FIELD_NAME::COMPANY_NAME, wxT( "COMPANY_NAME" ) },
758  { TEXT_FIELD_NAME::CURRENT_USER, wxT( "CURRENT_USER" ) },
759  { TEXT_FIELD_NAME::DATE, wxT( "DATE" ) },
760  { TEXT_FIELD_NAME::TIME, wxT( "TIME" ) },
761  { TEXT_FIELD_NAME::MACHINE_NAME, wxT( "MACHINE_NAME" ) },
762  { TEXT_FIELD_NAME::FROM_FILE, wxT( "FROM_FILE" ) },
763  { TEXT_FIELD_NAME::DISTANCE, wxT( "DISTANCE" ) },
764  { TEXT_FIELD_NAME::UNITS_SHORT, wxT( "UNITS SHORT" ) },
765  { TEXT_FIELD_NAME::UNITS_ABBREV, wxT( "UNITS ABBREV" ) },
766  { TEXT_FIELD_NAME::UNITS_FULL, wxT( "UNITS FULL" ) },
767  { TEXT_FIELD_NAME::HYPERLINK, wxT( "HYPERLINK" ) }
768  };
769 
770  wxString remainingStr = aTextString;
771  wxString returnStr;
772 
773  while( remainingStr.size() > 0 )
774  {
775  //Find the start token
776  size_t startpos = remainingStr.Find( wxT( "<@" ) );
777 
778  if( static_cast<int>( startpos ) == wxNOT_FOUND )
779  {
780  // No more fields to parse, add to return string
781  returnStr += remainingStr;
782  break;
783  }
784 
785  if( startpos > 0 )
786  returnStr += remainingStr.SubString( 0, startpos - 1 );
787 
788  if( ( startpos + 2 ) >= remainingStr.size() )
789  break;
790 
791  remainingStr = remainingStr.Mid( startpos + 2 );
792 
793  //Find the expected token for the field
795 
796  for( std::pair<TEXT_FIELD_NAME, wxString> txtF : txtTokens )
797  {
798  if( remainingStr.StartsWith( txtF.second ) )
799  {
800  foundField = txtF.first;
801  break;
802  }
803  }
804 
805  if( foundField == TEXT_FIELD_NAME::NONE )
806  {
807  // Not a valid field, lets keep looking
808  returnStr += wxT( "<@" );
809  continue;
810  }
811 
812  //Now lets find the end token
813  size_t endpos = remainingStr.Find( wxT( "@>" ) );
814 
815  if( static_cast<int>( endpos ) == wxNOT_FOUND )
816  {
817  // The field we found isn't valid as it doesn't have a termination
818  // Lets append the whole thing as plain text
819  returnStr += wxT( "<@" ) + remainingStr;
820  break;
821  }
822 
823  size_t valueStart = txtTokens.at( foundField ).size();
824  wxString fieldValue = remainingStr.SubString( valueStart, endpos - 1 );
825  wxString address;
826 
827  if( foundField == TEXT_FIELD_NAME::FROM_FILE || foundField == TEXT_FIELD_NAME::HYPERLINK )
828  {
829  // The first character should always be a double quotation mark
830  wxASSERT_MSG( fieldValue.at( 0 ) == '"', "Expected '\"' as the first character" );
831 
832  size_t splitPos = fieldValue.find_first_of( '"', 1 );
833  address = fieldValue.SubString( 1, splitPos - 1 );
834 
835  if( foundField == TEXT_FIELD_NAME::HYPERLINK )
836  {
837  // Assume the last two characters are "@>"
838  wxASSERT_MSG( remainingStr.EndsWith( wxT( "@>" ) ),
839  wxT( "Expected '@>' at the end of a hyperlink" ) );
840 
841  fieldValue = remainingStr.SubString( valueStart + splitPos + 1,
842  remainingStr.Length() - 3 );
843 
844  remainingStr = wxEmptyString;
845  }
846  else
847  {
848  fieldValue = fieldValue.Mid( splitPos + 1 );
849  }
850  }
851 
852  switch( foundField )
853  {
865 
866  if( aContext->TextFieldToValuesMap.find( foundField )
867  != aContext->TextFieldToValuesMap.end() )
868  {
869  aContext->InconsistentTextFields.insert( foundField );
870  }
871  else
872  {
873  aContext->TextFieldToValuesMap.insert( { foundField, fieldValue } );
874  }
875 
877 
881  returnStr += wxT( "${" ) + CADSTAR_TO_KICAD_FIELDS.at( foundField ) + wxT( "}" );
882  break;
883 
888  // Just flatten the text for distances
889  returnStr += fieldValue;
890  break;
891 
893  {
894  wxFileName fn( address );
895  wxString fieldFmt = wxT( "FROM_FILE_%s_%s" );
896  wxString fieldName = wxString::Format( fieldFmt, fn.GetName(), fn.GetExt() );
897 
898  int version = 1;
899 
900  while(
901  aContext->FilenamesToTextMap.find( fieldName )
902  != aContext->FilenamesToTextMap.end()
903  && aContext->FilenamesToTextMap.at( fieldName ) != fieldValue )
904  {
905  fieldName = wxString::Format( fieldFmt, fn.GetName(), fn.GetExt() )
906  + wxString::Format( wxT( "_%d" ), version++ );
907  }
908 
909  aContext->FilenamesToTextMap[fieldName] = fieldValue;
910  returnStr += wxT( "${" ) + fieldName + wxT( "}" );
911  }
912  break;
913 
915  {
916  aContext->TextToHyperlinksMap[fieldValue] = address;
917  returnStr += ParseTextFields( fieldValue, aContext );
918  }
919  break;
920 
922  wxFAIL_MSG( "We should have already covered this scenario above" );
923  break;
924  }
925 
926 
927  if( ( endpos + 2 ) >= remainingStr.size() )
928  break;
929 
930  remainingStr = remainingStr.Mid( endpos + 2 );
931  }
932 
933  return returnStr;
934 }
TEXT_FIELD_NAME
These are special fields in text objects enclosed between the tokens '<@' and '>' such as <@[FIELD_NA...
#define KI_FALLTHROUGH
The KI_FALLTHROUGH macro is to be used when switch statement cases should purposely fallthrough from ...
Definition: macros.h:83
static wxString ParseTextFields(const wxString &aTextString, PARSER_CONTEXT *aParserContext)
Replaces CADSTAR fields for the equivalent in KiCad and stores the field values in aParserContext.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
static const std::map< TEXT_FIELD_NAME, wxString > CADSTAR_TO_KICAD_FIELDS
Map between CADSTAR fields and KiCad text variables.

References CADSTAR_TO_KICAD_FIELDS, COMPANY_NAME, CURRENT_USER, DATE, DESIGN_TITLE, DISTANCE, CADSTAR_ARCHIVE_PARSER::PARSER_CONTEXT::FilenamesToTextMap, Format(), FROM_FILE, HYPERLINK, CADSTAR_ARCHIVE_PARSER::PARSER_CONTEXT::InconsistentTextFields, KI_FALLTHROUGH, LONG_JOBNAME, MACHINE_NAME, NONE, NUM_OF_SHEETS, REG_USER, SHEET_NAME, SHEET_NUMBER, SHORT_JOBNAME, CADSTAR_ARCHIVE_PARSER::PARSER_CONTEXT::TextFieldToValuesMap, CADSTAR_ARCHIVE_PARSER::PARSER_CONTEXT::TextToHyperlinksMap, TIME, UNITS_ABBREV, UNITS_FULL, UNITS_SHORT, VARIANT_DESCRIPTION, and VARIANT_NAME.

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

◆ ParseUnits()

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

Definition at line 549 of file cadstar_archive_parser.cpp.

550 {
551  wxASSERT( aNode->GetName() == wxT( "UNITS" ) );
552 
553  wxString unit = GetXmlAttributeIDString( aNode, 0 );
554 
555  if( unit == wxT( "CENTIMETER" ) )
556  return UNITS::CENTIMETER;
557  else if( unit == wxT( "INCH" ) )
558  return UNITS::INCH;
559  else if( unit == wxT( "METER" ) )
560  return UNITS::METER;
561  else if( unit == wxT( "MICROMETRE" ) )
562  return UNITS::MICROMETRE;
563  else if( unit == wxT( "MM" ) )
564  return UNITS::MM;
565  else if( unit == wxT( "THOU" ) )
566  return UNITS::THOU;
567  else if( unit == wxT( "DESIGN" ) )
568  return UNITS::DESIGN;
569  else
570  THROW_UNKNOWN_PARAMETER_IO_ERROR( unit, wxT( "UNITS" ) );
571 
572  return UNITS();
573 }
Inherits from design units (assumed Assignments->Technology->Units)
static wxString GetXmlAttributeIDString(XNODE *aNode, unsigned int aID, bool aIsRequired=true)
#define THROW_UNKNOWN_PARAMETER_IO_ERROR(param, location)

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

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

Member Data Documentation

◆ CADSTAR_TO_KICAD_FIELDS

const std::map< CADSTAR_ARCHIVE_PARSER::TEXT_FIELD_NAME, wxString > CADSTAR_ARCHIVE_PARSER::CADSTAR_TO_KICAD_FIELDS
static
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::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 164 of file cadstar_archive_parser.h.

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

◆ FONT_BOLD

const long CADSTAR_ARCHIVE_PARSER::FONT_BOLD = 700
static

◆ FONT_NORMAL

const long CADSTAR_ARCHIVE_PARSER::FONT_NORMAL = 400
static

Definition at line 321 of file cadstar_archive_parser.h.

◆ m_context

◆ m_progressReporter

◆ TXT_HEIGHT_RATIO

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

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 129 of file cadstar_archive_parser.h.

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

◆ UNDEFINED_VALUE


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