25#include <wx/filename.h>
27#include <wx/xml/xml.h>
48 aChildNode->GetName(), aParentNode->GetName() ) );
56const std::map<CADSTAR_ARCHIVE_PARSER::TEXT_FIELD_NAME, wxString>
58 { { TEXT_FIELD_NAME::DESIGN_TITLE, wxT(
"DESIGN_TITLE" ) },
59 { TEXT_FIELD_NAME::SHORT_JOBNAME, wxT(
"SHORT_JOBNAME" ) },
60 { TEXT_FIELD_NAME::LONG_JOBNAME, wxT(
"LONG_JOBNAME" ) },
61 { TEXT_FIELD_NAME::NUM_OF_SHEETS, wxT(
"##" ) },
62 { TEXT_FIELD_NAME::SHEET_NUMBER, wxT(
"#" ) },
63 { TEXT_FIELD_NAME::SHEET_NAME, wxT(
"SHEETNAME" ) },
64 { TEXT_FIELD_NAME::VARIANT_NAME, wxT(
"VARIANT_NAME" ) },
65 { TEXT_FIELD_NAME::VARIANT_DESCRIPTION, wxT(
"VARIANT_DESCRIPTION" ) },
66 { TEXT_FIELD_NAME::REG_USER, wxT(
"REG_USER" ) },
67 { TEXT_FIELD_NAME::COMPANY_NAME, wxT(
"COMPANY_NAME" ) },
68 { TEXT_FIELD_NAME::CURRENT_USER, wxT(
"CURRENT_USER" ) },
69 { TEXT_FIELD_NAME::DATE, wxT(
"DATE" ) },
70 { TEXT_FIELD_NAME::TIME, wxT(
"TIME" ) },
71 { TEXT_FIELD_NAME::MACHINE_NAME, wxT(
"MACHINE_NAME" ) } };
76 wxASSERT( aNode->GetName() == wxT(
"FORMAT" ) );
86 wxASSERT( aNode->GetName() == wxT(
"TIMESTAMP" ) );
102 wxASSERT( aNode->GetName() == wxT(
"HEADER" ) );
106 for( ; cNode; cNode = cNode->
GetNext() )
108 wxString
nodeName = cNode->GetName();
112 Format.Parse( cNode, aContext );
114 else if(
nodeName == wxT(
"JOBFILE" ) )
118 else if(
nodeName == wxT(
"JOBTITLE" ) )
122 else if(
nodeName == wxT(
"GENERATOR" ) )
126 else if(
nodeName == wxT(
"RESOLUTION" ) )
131 && subNode->GetName() == wxT(
"METRIC" )
146 else if(
nodeName == wxT(
"TIMESTAMP" ) )
160 wxASSERT( aNode->GetName() == wxT(
"VMASTER" ) || aNode->GetName() == wxT(
"VARIANT" ) );
164 if( aNode->GetName() == wxT(
"VMASTER" ) )
180 wxASSERT( aNode->GetName() == wxT(
"VHIERARCHY" ) );
184 for( ; cNode; cNode = cNode->
GetNext() )
186 if( cNode->GetName() == wxT(
"VMASTER" ) || cNode->GetName() == wxT(
"VARIANT" ) )
189 variant.
Parse( cNode, aContext );
190 Variants.insert( std::make_pair( variant.
ID, variant ) );
202 wxASSERT( aNode->GetName() == wxT(
"LINECODE" ) );
212 if( !cNode || cNode->GetName() != wxT(
"STYLE" ) )
217 if( styleStr == wxT(
"SOLID" ) )
221 else if( styleStr == wxT(
"DASH" ) )
225 else if( styleStr == wxT(
"DASHDOT" ) )
229 else if( styleStr == wxT(
"DASHDOTDOT" ) )
233 else if( styleStr == wxT(
"DOT" ) )
240 wxString::Format(
"LINECODE -> %s",
Name ) );
247 wxASSERT( aNode->GetName() == wxT(
"HATCH" ) );
254 if( !cNode || cNode->GetName() != wxT(
"ORIENT" ) )
263 wxASSERT( aNode->GetName() == wxT(
"HATCHCODE" ) );
269 wxString
location = wxString::Format(
"HATCHCODE -> %s",
Name );
271 for( ; cNode; cNode = cNode->
GetNext() )
273 if( cNode->GetName() != wxT(
"HATCH" ) )
280 hatch.
Parse( cNode, aContext );
288 wxASSERT( aNode->GetName() == wxT(
"FONT" ) );
296 for( ; cNode; cNode = cNode->
GetNext() )
298 wxString cNodeName = cNode->GetName();
300 if( cNodeName == wxT(
"ITALIC" ) )
302 else if( cNodeName == wxT(
"KERNING" ) )
312 wxASSERT( aNode->GetName() == wxT(
"TEXTCODE" ) );
325 if( cNode->GetName() == wxT(
"FONT" ) )
326 Font.Parse( cNode, aContext );
335 wxASSERT( aNode->GetName() == wxT(
"ROUTEREASSIGN" ) );
342 for( ; cNode; cNode = cNode->
GetNext() )
344 wxString cNodeName = cNode->GetName();
346 if( cNodeName == wxT(
"NECKWIDTH" ) )
348 else if( cNodeName == wxT(
"SROUTEWIDTH" ) )
350 else if( cNodeName == wxT(
"MINWIDTH" ) )
352 else if( cNodeName == wxT(
"MAXWIDTH" ) )
362 wxASSERT( aNode->GetName() == wxT(
"ROUTECODE" ) );
370 for( ; cNode; cNode = cNode->
GetNext() )
372 wxString cNodeName = cNode->GetName();
374 if( cNodeName == wxT(
"NECKWIDTH" ) )
378 else if( cNodeName == wxT(
"SROUTEWIDTH" ) )
382 else if( cNodeName == wxT(
"MINWIDTH" ) )
386 else if( cNodeName == wxT(
"MAXWIDTH" ) )
390 else if( cNodeName == wxT(
"ROUTEREASSIGN" ) )
393 routereassign.
Parse( cNode, aContext );
412 wxASSERT( aNode->GetName() == wxT(
"E" ) );
418 wxString::Format(
"%s->%s", aNode->
GetParent()->GetName(),
426 wxASSERT( aNode->GetName() == wxT(
"PT" ) );
435 wxASSERT( aNode->GetName() == wxT(
"PT" ) );
444 wxString aNodeName = aNode->GetName();
446 if( aNodeName == wxT(
"PT" ) || aNodeName == wxT(
"ACWARC" ) || aNodeName == wxT(
"CWARC" )
447 || aNodeName == wxT(
"CWSEMI" ) || aNodeName == wxT(
"ACWSEMI" ) )
462 wxString aNodeName = aNode->GetName();
464 if( aNodeName == wxT(
"PT" ) )
469 End.Parse( aNode, aContext );
471 else if( aNodeName == wxT(
"ACWARC" ) || aNodeName == wxT(
"CWARC" ) )
473 if( aNodeName == wxT(
"ACWARC" ) )
483 else if( aNodeName == wxT(
"ACWSEMI" ) || aNodeName == wxT(
"CWSEMI" ) )
485 if( aNodeName == wxT(
"ACWSEMI" ) )
499 wxASSERT_MSG(
true, wxT(
"Unknown VERTEX type" ) );
505 const std::function<
VECTOR2I(
const VECTOR2I& )> aCadstarToKicadPointCallback,
506 int aAccuracy )
const
510 aChainToAppendTo->
Append( aCadstarToKicadPointCallback(
End ) );
514 wxCHECK_MSG( aChainToAppendTo->
PointCount() > 0, ,
515 "Can't append an arc to vertex to an empty chain" );
518 aCadstarToKicadPointCallback ),
524 const std::function<
VECTOR2I(
const VECTOR2I& )> aCadstarToKicadPointCallback )
const
527 "Can't build an arc for a straight segment!" );
530 VECTOR2I endPoint = aCadstarToKicadPointCallback(
End );
534 centerPoint = ( startPoint / 2 ) + ( endPoint / 2 );
536 centerPoint = aCadstarToKicadPointCallback(
Center );
542 VECTOR2I transform = aCadstarToKicadPointCallback( { 500, 500 } )
543 - aCadstarToKicadPointCallback( { 0, 0 } );
545 if( ( transform.
x > 0 && transform.
y < 0 ) || ( transform.
x < 0 && transform.
y > 0 ) )
546 clockwise = !clockwise;
556 wxASSERT( aNode->GetName() == wxT(
"CUTOUT" ) );
564 wxString aNodeName = aNode->GetName();
566 if( aNodeName == wxT(
"OPENSHAPE" ) || aNodeName == wxT(
"OUTLINE" )
567 || aNodeName == wxT(
"SOLID" ) || aNodeName == wxT(
"HATCHED" ) )
582 wxString aNodeName = aNode->GetName();
584 if( aNodeName == wxT(
"OPENSHAPE" ) )
591 else if( aNodeName == wxT(
"OUTLINE" ) )
598 else if( aNodeName == wxT(
"SOLID" ) )
605 else if( aNodeName == wxT(
"HATCHED" ) )
614 wxASSERT_MSG(
true, wxT(
"Unknown SHAPE type" ) );
619 const std::function<
VECTOR2I(
const VECTOR2I& )> aCadstarToKicadPointCallback,
620 int aMaxError )
const
627 for(
const auto& vertex :
Vertices )
628 vertex.AppendToChain( &outline, aCadstarToKicadPointCallback, aMaxError );
643 const std::function<
VECTOR2I(
const VECTOR2I& )> aCadstarToKicadPointCallback,
644 int aMaxError )
const
653 for(
const auto& cutout :
Cutouts )
657 if( cutout.Vertices.size() == 0 )
660 for(
const auto& cutoutVertex : cutout.Vertices )
661 cutoutVertex.AppendToChain( &hole, aCadstarToKicadPointCallback, aMaxError );
666 cutout.Vertices.at( 0 ).AppendToChain( &hole, aCadstarToKicadPointCallback, aMaxError );
677 wxASSERT( aNode->GetName() == wxT(
"UNITS" ) );
681 if( unit == wxT(
"CENTIMETER" ) )
683 else if( unit == wxT(
"INCH" ) )
685 else if( unit == wxT(
"METER" ) )
687 else if( unit == wxT(
"MICROMETRE" ) )
689 else if( unit == wxT(
"MM" ) )
691 else if( unit == wxT(
"THOU" ) )
693 else if( unit == wxT(
"DESIGN" ) )
704 wxASSERT( aNode->GetName() == wxT(
"ANGUNITS" ) );
708 if( angUnitStr == wxT(
"DEGREES" ) )
710 else if( angUnitStr == wxT(
"RADIANS" ) )
724 wxString aNodeName = aNode->GetName();
726 if( aNodeName == wxT(
"FRACTIONALGRID" ) || aNodeName == wxT(
"STEPGRID" ) )
735 wxASSERT(
IsGrid( aNode ) );
737 wxString aNodeName = aNode->GetName();
739 if( aNodeName == wxT(
"FRACTIONALGRID" ) )
741 else if( aNodeName == wxT(
"STEPGRID" ) )
744 wxASSERT_MSG(
true, wxT(
"Unknown Grid Type" ) );
754 wxASSERT( aNode->GetName() == wxT(
"GRIDS" ) );
758 for( ; cNode; cNode = cNode->
GetNext() )
760 wxString cNodeName = cNode->GetName();
762 if( cNodeName == wxT(
"WORKINGGRID" ) )
768 wxString found = workingGridNode ? workingGridNode->GetName() : wxString(
"(empty)" );
776 else if( cNodeName == wxT(
"SCREENGRID" ) )
782 wxString found = screenGridNode ? screenGridNode->GetName() : wxString(
"(empty)" );
793 userGrid.
Parse( cNode, aContext );
806 wxString cNodeName = aChildNode->GetName();
808 if( cNodeName == wxT(
"UNITS" ) )
812 else if( cNodeName == wxT(
"UNITSPRECISION" ) )
816 else if( cNodeName == wxT(
"INTERLINEGAP" ) )
820 else if( cNodeName == wxT(
"BARLINEGAP" ) )
824 else if( cNodeName == wxT(
"ALLOWBARTEXT" ) )
828 else if( cNodeName == wxT(
"ANGULARPRECISION" ) )
832 else if( cNodeName == wxT(
"DESIGNORIGIN" ) )
836 else if( cNodeName == wxT(
"DESIGNAREA" ) )
839 DesignArea = std::make_pair( pts[0], pts[1] );
841 else if( cNodeName == wxT(
"DESIGNREF" ) )
845 else if( cNodeName == wxT(
"DESIGNLIMIT" ) )
849 else if( cNodeName == wxT(
"PINNOOFFSET" ) )
853 else if( cNodeName == wxT(
"PINNOANGLE" ) )
868 wxASSERT( aNode->GetName() == wxT(
"SETTINGS" ) );
872 for( ; cNode; cNode = cNode->
GetNext() )
874 wxString cNodeName = cNode->GetName();
887 static const std::map<TEXT_FIELD_NAME, wxString> txtTokens =
911 wxString remainingStr = aTextString;
914 while( remainingStr.size() > 0 )
917 size_t startpos = remainingStr.Find( wxT(
"<@" ) );
919 if(
static_cast<int>( startpos ) == wxNOT_FOUND )
922 returnStr += remainingStr;
927 returnStr += remainingStr.SubString( 0, startpos - 1 );
929 if( ( startpos + 2 ) >= remainingStr.size() )
932 remainingStr = remainingStr.Mid( startpos + 2 );
937 for( std::pair<TEXT_FIELD_NAME, wxString> txtF : txtTokens )
939 if( remainingStr.StartsWith( txtF.second ) )
941 foundField = txtF.first;
949 returnStr += wxT(
"<@" );
954 size_t endpos = remainingStr.Find( wxT(
"@>" ) );
956 if(
static_cast<int>( endpos ) == wxNOT_FOUND )
960 returnStr += wxT(
"<@" ) + remainingStr;
964 size_t valueStart = txtTokens.at( foundField ).size();
965 wxString fieldValue = remainingStr.SubString( valueStart, endpos - 1 );
971 wxASSERT_MSG( fieldValue.at( 0 ) ==
'"',
"Expected '\"' as the first character" );
973 size_t splitPos = fieldValue.find_first_of(
'"', 1 );
974 address = fieldValue.SubString( 1, splitPos - 1 );
979 wxASSERT_MSG( remainingStr.EndsWith( wxT(
"@>" ) ),
980 "Expected '@>' at the end of a hyperlink" );
982 fieldValue = remainingStr.SubString( valueStart + splitPos + 1,
983 remainingStr.Length() - 3 );
985 remainingStr = wxEmptyString;
989 fieldValue = fieldValue.Mid( splitPos + 1 );
1030 returnStr += fieldValue;
1035 wxFileName fn( address );
1036 wxString fieldFmt = wxT(
"FROM_FILE_%s_%s" );
1037 wxString fieldName = wxString::Format( fieldFmt, fn.GetName(), fn.GetExt() );
1046 fieldName = wxString::Format( fieldFmt, fn.GetName(), fn.GetExt() )
1047 + wxString::Format( wxT(
"_%d" ), version++ );
1051 returnStr += wxT(
"${" ) + fieldName + wxT(
"}" );
1063 wxFAIL_MSG(
"We should have already covered this scenario above" );
1068 if( ( endpos + 2 ) >= remainingStr.size() )
1071 remainingStr = remainingStr.Mid( endpos + 2 );
1080 wxASSERT( aNode->GetName() == wxT(
"ALIGN" ) );
1084 if( alignmentStr == wxT(
"BOTTOMCENTER" ) )
1086 else if( alignmentStr == wxT(
"BOTTOMLEFT" ) )
1088 else if( alignmentStr == wxT(
"BOTTOMRIGHT" ) )
1090 else if( alignmentStr == wxT(
"CENTERCENTER" ) )
1092 else if( alignmentStr == wxT(
"CENTERLEFT" ) )
1094 else if( alignmentStr == wxT(
"CENTERRIGHT" ) )
1096 else if( alignmentStr == wxT(
"TOPCENTER" ) )
1098 else if( alignmentStr == wxT(
"TOPLEFT" ) )
1100 else if( alignmentStr == wxT(
"TOPRIGHT" ) )
1112 wxASSERT( aNode->GetName() == wxT(
"JUSTIFICATION" ) );
1116 if( justificationStr == wxT(
"LEFT" ) )
1118 else if( justificationStr == wxT(
"RIGHT" ) )
1120 else if( justificationStr == wxT(
"CENTER" ) )
1131 wxASSERT( aNode->GetName() == wxT(
"READABILITY" ) );
1135 if( readabilityStr == wxT(
"BOTTOM_TO_TOP" ) )
1137 else if( readabilityStr == wxT(
"TOP_TO_BOTTOM" ) )
1157 wxString cNodeName = aChildNode->GetName();
1159 if( cNodeName == wxT(
"PT" ) )
1160 Position.Parse( aChildNode, aContext );
1161 else if( cNodeName == wxT(
"ORIENT" ) )
1163 else if( cNodeName == wxT(
"MIRROR" ) )
1165 else if( cNodeName == wxT(
"FIX" ) )
1167 else if( cNodeName == wxT(
"ALIGN" ) )
1169 else if( cNodeName == wxT(
"JUSTIFICATION" ) )
1180 wxASSERT( aNode->GetName() == wxT(
"ATTRLOC" ) );
1187 for( ; cNode; cNode = cNode->
GetNext() )
1202 wxASSERT( aNode->GetName() == wxT(
"COLUMNORDER" ) );
1213 wxASSERT( aNode->GetName() == wxT(
"COLUMNWIDTH" ) );
1224 wxASSERT( aNode->GetName() == wxT(
"ATTRNAME" ) );
1230 wxString
location = wxString::Format(
"ATTRNAME -> %s",
Name );
1232 for( ; cNode; cNode = cNode->
GetNext() )
1234 wxString cNodeName = cNode->GetName();
1236 if( cNodeName == wxT(
"ATTROWNER" ) )
1240 if( attOwnerVal == wxT(
"ALL_ITEMS" ) )
1242 else if( attOwnerVal == wxT(
"AREA" ) )
1244 else if( attOwnerVal == wxT(
"BOARD" ) )
1246 else if( attOwnerVal == wxT(
"COMPONENT" ) )
1248 else if( attOwnerVal == wxT(
"CONNECTION" ) )
1250 else if( attOwnerVal == wxT(
"COPPER" ) )
1252 else if( attOwnerVal == wxT(
"DOCSYMBOL" ) )
1254 else if( attOwnerVal == wxT(
"FIGURE" ) )
1256 else if( attOwnerVal == wxT(
"NET" ) )
1258 else if( attOwnerVal == wxT(
"NETCLASS" ) )
1260 else if( attOwnerVal == wxT(
"PART" ) )
1262 else if( attOwnerVal == wxT(
"PART_DEFINITION" ) )
1264 else if( attOwnerVal == wxT(
"PIN" ) )
1266 else if( attOwnerVal == wxT(
"SIGNALREF" ) )
1268 else if( attOwnerVal == wxT(
"SYMBOL" ) )
1270 else if( attOwnerVal == wxT(
"SYMDEF" ) )
1272 else if( attOwnerVal == wxT(
"TEMPLATE" ) )
1274 else if( attOwnerVal == wxT(
"TESTPOINT" ) )
1279 else if( cNodeName == wxT(
"ATTRUSAGE" ) )
1283 if( attUsageVal == wxT(
"BOTH" ) )
1285 else if( attUsageVal == wxT(
"COMPONENT" ) )
1287 else if( attUsageVal == wxT(
"PART_DEFINITION" ) )
1289 else if( attUsageVal == wxT(
"PART_LIBRARY" ) )
1291 else if( attUsageVal == wxT(
"SYMBOL" ) )
1296 else if( cNodeName == wxT(
"NOTRANSFER" ) )
1300 else if( cNodeName == wxT(
"COLUMNORDER" ) )
1303 cOrder.
Parse( cNode, aContext );
1306 else if( cNodeName == wxT(
"COLUMNWIDTH" ) )
1309 cWidth.
Parse( cNode, aContext );
1312 else if( cNodeName == wxT(
"COLUMNINVISIBLE" ) )
1326 wxASSERT( aNode->GetName() == wxT(
"ATTR" ) );
1333 for( ; cNode; cNode = cNode->
GetNext() )
1335 if( cNode->GetName() == wxT(
"READONLY" ) )
1339 else if( cNode->GetName() == wxT(
"ATTRLOC" ) )
1354 wxASSERT( aNode->GetName() == wxT(
"TEXTLOC" ) );
1357 bool attributeIDisSet =
false;
1359 if( attributeStr == wxT(
"PART_NAME" ) )
1362 attributeIDisSet =
true;
1364 else if( attributeStr == wxT(
"COMP_NAME" ) )
1367 attributeIDisSet =
true;
1369 else if( attributeStr == wxT(
"COMP_NAME2" ) )
1372 attributeIDisSet =
true;
1374 else if( attributeStr == wxT(
"SYMBOL_NAME" ) )
1377 attributeIDisSet =
true;
1379 else if( attributeStr == wxT(
"LINK_ORIGIN" ) )
1382 attributeIDisSet =
true;
1384 else if( attributeStr == wxT(
"SIGNALNAME_ORIGIN" ) )
1387 attributeIDisSet =
true;
1389 else if( attributeStr == wxT(
"ATTRREF" ) )
1392 attributeIDisSet =
false;
1405 for( ; cNode; cNode = cNode->
GetNext() )
1407 wxString cNodeName = cNode->GetName();
1413 else if( !attributeIDisSet && cNodeName == wxT(
"ATTRREF" ) )
1416 attributeIDisSet =
true;
1418 else if( cNodeName == wxT(
"ORIENT" ) )
1422 else if( cNodeName == wxT(
"MIRROR" ) )
1426 else if( cNodeName == wxT(
"FIX" ) )
1430 else if( cNodeName == wxT(
"ALIGN" ) )
1434 else if( cNodeName == wxT(
"JUSTIFICATION" ) )
1451 wxASSERT( aNode->GetName() == wxT(
"NETCLASS" ) );
1457 wxString
location = wxString::Format(
"NETCLASS -> %s",
Name );
1459 for( ; cNode; cNode = cNode->
GetNext() )
1461 wxString cNodeName = cNode->GetName();
1463 if( cNodeName == wxT(
"ATTR" ) )
1466 attribute_val.
Parse( cNode, aContext );
1479 wxASSERT( aNode->GetName() == wxT(
"SPCCLASSNAME" ) );
1488 wxString
nodeName = aChildNode->GetName();
1490 if(
nodeName == wxT(
"LINECODE" ) )
1493 linecode.
Parse( aChildNode, aContext );
1494 LineCodes.insert( std::make_pair( linecode.
ID, linecode ) );
1496 else if(
nodeName == wxT(
"HATCHCODE" ) )
1499 hatchcode.
Parse( aChildNode, aContext );
1500 HatchCodes.insert( std::make_pair( hatchcode.
ID, hatchcode ) );
1502 else if(
nodeName == wxT(
"TEXTCODE" ) )
1505 textcode.
Parse( aChildNode, aContext );
1506 TextCodes.insert( std::make_pair( textcode.
ID, textcode ) );
1508 else if(
nodeName == wxT(
"ROUTECODE" ) )
1511 routecode.
Parse( aChildNode, aContext );
1512 RouteCodes.insert( std::make_pair( routecode.
ID, routecode ) );
1514 else if(
nodeName == wxT(
"ATTRNAME" ) )
1517 attrname.
Parse( aChildNode, aContext );
1520 else if(
nodeName == wxT(
"NETCLASS" ) )
1523 netclass.
Parse( aChildNode, aContext );
1524 NetClasses.insert( std::make_pair( netclass.
ID, netclass ) );
1526 else if(
nodeName == wxT(
"SPCCLASSNAME" ) )
1529 spcclassname.
Parse( aChildNode, aContext );
1543 wxASSERT( aNode->GetName() == wxT(
"SWAPRULE" ) );
1548 if( swapRuleStr == wxT(
"NO_SWAP" ) )
1550 else if( swapRuleStr == wxT(
"USE_SWAP_LAYER" ) )
1561 wxASSERT( aNode->GetName() == wxT(
"REUSEBLOCK" ) );
1569 for( ; cNode; cNode = cNode->
GetNext() )
1571 wxString cNodeName = cNode->GetName();
1573 if( cNodeName == wxT(
"MIRROR" ) )
1575 else if( cNodeName == wxT(
"ORIENT" ) )
1591 wxASSERT( aNode->GetName() == wxT(
"REUSEBLOCKREF" ) );
1602 wxASSERT( aNode->GetName() == wxT(
"GROUP" ) );
1609 for( ; cNode; cNode = cNode->
GetNext() )
1611 wxString cNodeName = cNode->GetName();
1613 if( cNodeName == wxT(
"FIX" ) )
1615 else if( cNodeName == wxT(
"TRANSFER" ) )
1617 else if( cNodeName == wxT(
"GROUPREF" ) )
1619 else if( cNodeName == wxT(
"REUSEBLOCKREF" ) )
1629 wxASSERT( aNode->GetName() == wxT(
"FIGURE" ) );
1636 bool shapeIsInitialised =
false;
1637 wxString
location = wxString::Format(
"Figure %s",
ID );
1642 for( ; cNode; cNode = cNode->
GetNext() )
1644 wxString cNodeName = cNode->GetName();
1646 if( !shapeIsInitialised &&
Shape.IsShape( cNode ) )
1648 Shape.Parse( cNode, aContext );
1649 shapeIsInitialised =
true;
1651 else if( cNodeName == wxT(
"SWAPRULE" ) )
1655 else if( cNodeName == wxT(
"FIX" ) )
1659 else if( cNodeName == wxT(
"GROUPREF" ) )
1664 else if( cNodeName == wxT(
"REUSEBLOCKREF" ) )
1668 else if( cNodeName == wxT(
"ATTR" ) )
1671 attr.
Parse( cNode, aContext );
1684 Parse( aNode, aContext,
true );
1691 wxASSERT( aNode->GetName() == wxT(
"TEXT" ) );
1707 for( ; cNode; cNode = cNode->
GetNext() )
1709 wxString cNodeName = cNode->GetName();
1711 if( cNodeName == wxT(
"PT" ) )
1713 else if( cNodeName == wxT(
"ORIENT" ) )
1715 else if( cNodeName == wxT(
"MIRROR" ) )
1717 else if( cNodeName == wxT(
"FIX" ) )
1719 else if( cNodeName == wxT(
"SWAPRULE" ) )
1721 else if( cNodeName == wxT(
"ALIGN" ) )
1723 else if( cNodeName == wxT(
"JUSTIFICATION" ) )
1725 else if( cNodeName == wxT(
"GROUPREF" ) )
1727 else if( cNodeName == wxT(
"REUSEBLOCKREF" ) )
1743 wxASSERT( aNode->GetName() == wxT(
"SYMDEF" ) );
1753 wxString cNodeName = aChildNode->GetName();
1755 if( cNodeName == wxT(
"PT" ) )
1757 Origin.Parse( aChildNode, aContext );
1759 else if( cNodeName == wxT(
"STUB" ) )
1763 else if( cNodeName == wxT(
"VERSION" ) )
1767 else if( cNodeName == wxT(
"FIGURE" ) )
1770 figure.
Parse( aChildNode, aContext );
1771 Figures.insert( std::make_pair( figure.
ID, figure ) );
1773 else if( cNodeName == wxT(
"TEXT" ) )
1776 txt.
Parse( aChildNode, aContext );
1777 Texts.insert( std::make_pair( txt.
ID, txt ) );
1779 else if( cNodeName == wxT(
"TEXTLOC" ) )
1782 textloc.
Parse( aChildNode, aContext );
1785 else if( cNodeName == wxT(
"ATTR" ) )
1788 attrVal.
Parse( aChildNode, aContext );
1802 wxASSERT( aNode->GetName() == wxT(
"GATEDEFINITION" ) );
1815 wxASSERT( aNode->GetName() == wxT(
"PINTYPE" ) );
1819 std::map<wxString, CADSTAR_PIN_TYPE> pinTypeMap = {
1830 if( pinTypeMap.find( pinTypeStr ) == pinTypeMap.end() )
1836 return pinTypeMap[pinTypeStr];
1842 wxASSERT( aNode->GetName() == wxT(
"PARTDEFINITIONPIN" ) );
1848 for( ; cNode; cNode = cNode->
GetNext() )
1850 wxString cNodeName = cNode->GetName();
1852 if( cNodeName == wxT(
"PINNAME" ) )
1856 else if( cNodeName == wxT(
"PINLABEL" ) )
1860 else if( cNodeName == wxT(
"PINSIGNAL" ) )
1864 else if( cNodeName == wxT(
"PINTERM" ) )
1869 else if( cNodeName == wxT(
"PINTYPE" ) )
1873 else if( cNodeName == wxT(
"PINLOAD" ) )
1877 else if( cNodeName == wxT(
"PINPOSITION" ) )
1881 else if( cNodeName == wxT(
"PINIDENTIFIER" ) )
1895 wxASSERT( aNode->GetName() == wxT(
"PARTPIN" ) );
1901 for( ; cNode; cNode = cNode->
GetNext() )
1903 wxString cNodeName = cNode->GetName();
1905 if( cNodeName == wxT(
"PINNAME" ) )
1907 else if( cNodeName == wxT(
"PINTYPE" ) )
1909 else if( cNodeName == wxT(
"PINIDENTIFIER" ) )
1920 wxASSERT( aNode->GetName() == wxT(
"PINEQUIVALENCE" ) );
1922 wxXmlAttribute* xmlAttribute = aNode->GetAttributes();
1924 for( ; xmlAttribute; xmlAttribute = xmlAttribute->GetNext() )
1931 if( !xmlAttribute->GetValue().ToLong( &pinId ) )
1944 wxASSERT( aNode->GetName() == wxT(
"SWAPGATE" ) );
1946 wxXmlAttribute* xmlAttribute = aNode->GetAttributes();
1948 for( ; xmlAttribute; xmlAttribute = xmlAttribute->GetNext() )
1955 if( !xmlAttribute->GetValue().ToLong( &pinId ) )
1968 wxASSERT( aNode->GetName() == wxT(
"SWAPGROUP" ) );
1974 for( ; cNode; cNode = cNode->
GetNext() )
1976 wxString cNodeName = cNode->GetName();
1978 if( cNodeName == wxT(
"EXTERNAL" ) )
1982 else if( cNodeName == wxT(
"SWAPGATE" ) )
1985 swapGate.
Parse( cNode, aContext );
1998 wxASSERT( aNode->GetName() == wxT(
"PARTDEFINITION" ) );
2004 for( ; cNode; cNode = cNode->
GetNext() )
2006 wxString cNodeName = cNode->GetName();
2008 if( cNodeName == wxT(
"HIDEPINNAMES" ) )
2012 else if( cNodeName == wxT(
"MAXPIN" ) )
2016 else if( cNodeName == wxT(
"GATEDEFINITION" ) )
2019 gate.
Parse( cNode, aContext );
2022 else if( cNodeName == wxT(
"PARTDEFINITIONPIN" ) )
2025 pin.Parse( cNode, aContext );
2026 Pins.insert( std::make_pair(
pin.ID,
pin ) );
2028 else if( cNodeName == wxT(
"ATTR" ) )
2031 attr.
Parse( cNode, aContext );
2034 else if( cNodeName == wxT(
"PINEQUIVALENCE" ) )
2037 pinEq.
Parse( cNode, aContext );
2040 else if( cNodeName == wxT(
"SWAPGROUP" ) )
2043 swapGroup.
Parse( cNode, aContext );
2056 wxASSERT( aNode->GetName() == wxT(
"PART" ) );
2063 for( ; cNode; cNode = cNode->
GetNext() )
2065 wxString cNodeName = cNode->GetName();
2067 if( cNodeName == wxT(
"VERSION" ) )
2071 else if( cNodeName == wxT(
"HIDEPINNAMES" ) )
2075 else if( cNodeName == wxT(
"PARTDEFINITION" ) )
2079 else if( cNodeName == wxT(
"PARTPIN" ) )
2082 pin.Parse( cNode, aContext );
2085 else if( cNodeName == wxT(
"ATTR" ) )
2088 attr.
Parse( cNode, aContext );
2101 wxASSERT( aNode->GetName() == wxT(
"PARTS" ) );
2105 for( ; cNode; cNode = cNode->
GetNext() )
2107 wxString cNodeName = cNode->GetName();
2109 if( cNodeName == wxT(
"PART" ) )
2112 part.
Parse( cNode, aContext );
2128 wxASSERT( aNode->GetName() == wxT(
"JPT" ) );
2138 wxString cNodeName = aChildNode->GetName();
2140 if( cNodeName == wxT(
"PT" ) )
2141 Location.Parse( aChildNode, aContext );
2142 else if( cNodeName == wxT(
"FIX" ) )
2144 else if( cNodeName == wxT(
"GROUPREF" ) )
2146 else if( cNodeName == wxT(
"REUSEBLOCKREF" ) )
2160 for( ; cNode; cNode = cNode->
GetNext() )
2173 wxASSERT( aNode->GetName() == wxT(
"CONN" ) );
2184 wxString cNodeName = aChildNode->GetName();
2186 if( cNodeName == wxT(
"FIX" ) )
2190 else if( cNodeName == wxT(
"HIDDEN" ) )
2194 else if( cNodeName == wxT(
"GROUPREF" ) )
2198 else if( cNodeName == wxT(
"REUSEBLOCKREF" ) )
2202 else if( cNodeName == wxT(
"ATTR" ) )
2205 attrVal.
Parse( aChildNode, aContext );
2219 wxASSERT( aNode->GetName() == wxT(
"NET" ) );
2227 wxString cNodeName = aChildNode->GetName();
2229 if( cNodeName == wxT(
"NETCODE" ) )
2233 else if( cNodeName == wxT(
"SIGNAME" ) )
2237 else if( cNodeName == wxT(
"SIGNUM" ) )
2241 else if( cNodeName == wxT(
"HIGHLIT" ) )
2245 else if( cNodeName == wxT(
"JPT" ) )
2248 jpt.
Parse( aChildNode, aContext );
2249 Junctions.insert( std::make_pair( jpt.
ID, jpt ) );
2251 else if( cNodeName == wxT(
"NETCLASSREF" ) )
2255 else if( cNodeName == wxT(
"SPACINGCLASS" ) )
2259 else if( cNodeName == wxT(
"ATTR" ) )
2262 attrVal.
Parse( aChildNode, aContext );
2276 wxASSERT( aNode->GetName() == wxT(
"DOCSYMBOL" ) );
2283 bool originParsed =
false;
2285 for( ; cNode; cNode = cNode->
GetNext() )
2287 wxString cNodeName = cNode->GetName();
2289 if( !originParsed && cNodeName == wxT(
"PT" ) )
2291 Origin.Parse( cNode, aContext );
2292 originParsed =
true;
2294 else if( cNodeName == wxT(
"GROUPREF" ) )
2298 else if( cNodeName == wxT(
"REUSEBLOCKREF" ) )
2302 else if( cNodeName == wxT(
"FIX" ) )
2306 else if( cNodeName == wxT(
"MIRROR" ) )
2310 else if( cNodeName == wxT(
"READABILITY" ) )
2314 else if( cNodeName == wxT(
"ORIENT" ) )
2318 else if( cNodeName == wxT(
"ATTR" ) )
2321 attr.
Parse( cNode, aContext );
2324 else if( cNodeName == wxT(
"SCALE" ) )
2342 wxASSERT( aNode->GetName() == wxT(
"DFLTSETTINGS" ) );
2348 for( ; cNode; cNode = cNode->
GetNext() )
2350 wxString cNodeName = cNode->GetName();
2352 if( cNodeName == wxT(
"INVISIBLE" ) )
2366 wxASSERT( aNode->GetName() == wxT(
"ATTRCOL" ) );
2373 for( ; cNode; cNode = cNode->
GetNext() )
2375 wxString cNodeName = cNode->GetName();
2377 if( cNodeName == wxT(
"INVISIBLE" ) )
2381 else if( cNodeName == wxT(
"NOTPICKABLE" ) )
2395 wxASSERT( aNode->GetName() == wxT(
"ATTRCOLORS" ) );
2399 for( ; cNode; cNode = cNode->
GetNext() )
2401 wxString cNodeName = cNode->GetName();
2403 if( cNodeName == wxT(
"DFLTSETTINGS" ) )
2407 else if( cNodeName == wxT(
"ATTRCOL" ) )
2410 attrcol.
Parse( cNode, aContext );
2413 else if( cNodeName == wxT(
"INVISIBLE" ) )
2427 wxASSERT( aNode->GetName() == wxT(
"PARTNAMECOL" ) );
2433 for( ; cNode; cNode = cNode->
GetNext() )
2435 wxString cNodeName = cNode->GetName();
2437 if( cNodeName == wxT(
"INVISIBLE" ) )
2441 else if( cNodeName == wxT(
"NOTPICKABLE" ) )
2455 static const wxString c_numAttributes = wxT(
"numAttributes" );
2458 long numAttributes = 0;
2460 if( aNode->GetAttribute( c_numAttributes, &
result ) )
2462 numAttributes = wxAtol(
result );
2463 aNode->DeleteAttribute( c_numAttributes );
2467#if wxUSE_UNICODE_WCHAR
2468 std::wstring numAttrStr = std::to_wstring( numAttributes );
2470 std::string numAttrStr = std::to_string( numAttributes );
2475 wxString paramName = wxT(
"attr" );
2476 paramName << numAttrStr;
2483 const wxString& aFileTypeIdentifier,
2486 KEYWORD emptyKeywords[1] = {};
2487 XNODE* rootNode =
nullptr;
2488 XNODE* cNode =
nullptr;
2489 XNODE* iNode =
nullptr;
2491 bool cadstarFileCheckDone =
false;
2493 wxCSConv win1252( wxT(
"windows-1252" ) );
2494 wxMBConv* conv = &win1252;
2498 FILE* fp = wxFopen( aFileName, wxT(
"rt" ) );
2503 fseek( fp, 0
L, SEEK_END );
2504 long fileSize = ftell( fp );
2507 DSNLEXER lexer( emptyKeywords, 0,
nullptr, fp, aFileName );
2509 auto currentProgress =
2512 return static_cast<double>( ftell( fp ) ) / fileSize;
2515 double previousReportedProgress = -1.0;
2519 if( aProgressReporter && ( currentProgress() - previousReportedProgress ) > 0.01 )
2529 previousReportedProgress = currentProgress();
2543 THROW_IO_ERROR(
_(
"The selected file is not valid or might be corrupt!" ) );
2549 str = wxString( lexer.
CurText(), *conv );
2550 cNode =
new XNODE( wxXML_ELEMENT_NODE, str );
2559 iNode->AddChild( cNode );
2561 else if( !cadstarFileCheckDone )
2563 if( cNode->GetName() != aFileTypeIdentifier )
2566 THROW_IO_ERROR(
_(
"The selected file is not valid or might be corrupt!" ) );
2569 cadstarFileCheckDone =
true;
2576 str = wxString( lexer.
CurText(), *conv );
2584 THROW_IO_ERROR(
_(
"The selected file is not valid or might be corrupt!" ) );
2589 if( iNode !=
nullptr )
2592 THROW_IO_ERROR(
_(
"The selected file is not valid or might be corrupt!" ) );
2603 THROW_IO_ERROR(
_(
"The selected file is not valid or might be corrupt!" ) );
2612 return aAttribute->GetName() != wxT(
"numAttributes" );
2619#if wxUSE_UNICODE_WCHAR
2620 std::wstring idStr = std::to_wstring( aID );
2622 std::string idStr = std::to_string( aID );
2625 wxString attrName = wxS(
"attr" );
2630 if( !aNode->GetAttribute( attrName, &retVal ) )
2635 return wxEmptyString;
2668 if( aNode && aNode->
GetNext() )
2676 if( aNode->
GetChildren()->GetName() == wxT(
"E" ) )
2686 std::vector<POINT> retVal;
2690 for( ; cNode; cNode = cNode->
GetNext() )
2692 if( cNode->GetName() == wxT(
"PT" ) )
2698 pt.
Parse( cNode, aContext );
2705 retVal.push_back( pt );
2707 else if( aTestAllChildNodes )
2713 if( aExpectedNumPoints !=
UNDEFINED_VALUE && retVal.size() !=
static_cast<size_t>( aExpectedNumPoints ) )
2715 THROW_IO_ERRORF(
_(
"Unexpected number of points in '%s'. Found %d but expected %d." ),
2718 aExpectedNumPoints );
2728 std::vector<VERTEX> retVal;
2732 for( ; cNode; cNode = cNode->
GetNext() )
2740 vertex.
Parse( cNode, aContext );
2747 retVal.push_back( vertex );
2749 else if( aTestAllChildNodes )
2762 std::vector<CUTOUT> retVal;
2766 for( ; cNode; cNode = cNode->
GetNext() )
2768 if( cNode->GetName() == wxT(
"CUTOUT" ) )
2774 cutout.
Parse( cNode, aContext );
2781 retVal.push_back( cutout );
2783 else if( aTestAllChildNodes )
2798 for( ; childNodes; childNodes = childNodes->
GetNext() )
2806 XNODE* aRootNode, std::vector<wxString> aSubNodeChildrenToCount )
2811 for( ; level1Node; level1Node = level1Node->
GetNext() )
2813 for( wxString childNodeName : aSubNodeChildrenToCount )
2815 if( level1Node->GetName() == childNodeName )
2828 wxString escapedText = aCadstarString;
2830 escapedText.Replace( wxT(
"'" ), wxT(
"~" ) );
2838 if( !aKiCadTextItem->
GetText().IsEmpty() )
2845 int numExtraLines =
text.Replace(
"\n",
"\n" );
2846 numExtraLines -=
text.at(
text.size() - 1 ) ==
'\n';
2847 positionOffset.
x *= numExtraLines;
2848 positionOffset.
y *= numExtraLines;
2850 aKiCadTextItem->
Offset( positionOffset );
2856 const wxString& aAlternateName )
2858 if( aAlternateName.IsEmpty() )
CADSTAR_PIN_POSITION
Positioning of pin names can be in one of four quadrants.
@ OUTPUT_NOT_OR
Output pin not OR tieable.
@ TRISTATE_DRIVER
Tristate output pin.
@ OUTPUT_OR
Output pin OR tieable.
@ UNCOMMITTED
Uncommitted pin (default)
@ TRISTATE_INPUT
Tristate input pin.
@ TRISTATE_BIDIR
Tristate bi-directional driver pin.
@ OUTPUT_NOT_NORM_OR
Output pin not normally OR tieable.
static void reThrowWithParentContext(const IO_ERROR &aError, XNODE *aChildNode, XNODE *aParentNode)
Helper functions and common defines between schematic and PCB Archive files.
#define SYMBOL_NAME_ATTRID
Symbol Name attribute ID - used for placement of designators on the schematic.
#define SIGNALNAME_ORIGIN_ATTRID
#define WARN_UNKNOWN_NODE_IO_ERROR(nodename, location)
#define THROW_MISSING_NODE_IO_ERROR(nodename, location)
#define THROW_UNKNOWN_NODE_IO_ERROR(nodename, location)
#define LINK_ORIGIN_ATTRID
#define COMPONENT_NAME_2_ATTRID
Component Name 2 Attribute ID - typically used for indicating the placement of designators in placeme...
#define THROW_UNKNOWN_PARAMETER_IO_ERROR(param, location)
#define COMPONENT_NAME_ATTRID
Component Name Attribute ID - typically used for placement of designators on silk screen.
#define WARN_UNKNOWN_PARAMETER_IO_ERROR(param, location)
#define THROW_MISSING_PARAMETER_IO_ERROR(param, location)
#define THROW_PARSING_IO_ERROR(param, location)
READABILITY
Sets the readability direction of text.
@ 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.
@ ANTICLOCKWISE_SEMICIRCLE
@ STEPGRID
Param1 = X Step, Param2 = Y Step. A standard x,y grid.
@ FRACTIONALGRID
Param1 = Units, Param2 = Divisor.
SWAP_RULE
Corresponds to "Display when" Item property.
@ USE_SWAP_LAYER
Display when Mirrored.
@ NO_SWAP
Display when Unmirrored.
static UNITS ParseUnits(XNODE *aNode)
static ALIGNMENT ParseAlignment(XNODE *aNode)
static const std::map< TEXT_FIELD_NAME, wxString > CADSTAR_TO_KICAD_FIELDS
Map between CADSTAR fields and KiCad text variables.
TEXT_FIELD_NAME
These are special fields in text objects enclosed between the tokens '<@' and '>' such as <@[FIELD_NA...
@ NONE
Synthetic for flagging.
static SWAP_RULE ParseSwapRule(XNODE *aNode)
ALIGNMENT
From CADSTAR Help: "Text Alignment enables you to define the position of an alignment origin for all ...
@ NO_ALIGNMENT
NO_ALIGNMENT has different meaning depending on the object type.
static const long UNDEFINED_VALUE
static wxString generateLibName(const wxString &aRefName, const wxString &aAlternateName)
static void CheckNoNextNodes(XNODE *aNode)
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).
static XNODE * LoadArchiveFile(const wxString &aFileName, const wxString &aFileTypeIdentifier, PROGRESS_REPORTER *aProgressReporter=nullptr)
Reads a CADSTAR Archive file (S-parameter format).
static JUSTIFICATION ParseJustification(XNODE *aNode)
static wxString ParseTextFields(const wxString &aTextString, PARSER_CONTEXT *aParserContext)
Replaces CADSTAR fields for the equivalent in KiCad and stores the field values in aParserContext.
@ PART_DEFINITION
From CADSTAR Help: Assigned to Parts library Definitions and displayed by the Library searcher.
@ BOTH
From CADSTAR Help: Assigned to both Schematic symbols and PCB components, and displayed on Schematic ...
@ COMPONENT
From CADSTAR Help: Assigned to PCB components and displayed on PCB designs.
@ SYMBOL
From CADSTAR Help: Assigned to Schematic Symbols and displayed on Schematic Designs.
@ PART_LIBRARY
From CADSTAR Help: Only used by non-Cadstar applications.
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).
static void FixTextPositionNoAlignment(EDA_TEXT *aKiCadTextItem)
Correct the position of a text element that had NO_ALIGNMENT in CADSTAR.
static ANGUNITS ParseAngunits(XNODE *aNode)
long PART_DEFINITION_PIN_ID
Pin identifier in the part definition.
@ OUTLINE
Unfilled closed shape.
@ OPENSHAPE
Unfilled open shape. Cannot have cutouts.
@ SOLID
Filled closed shape (solid fill).
@ HATCHED
Filled closed shape (hatch fill).
static const double TXT_HEIGHT_RATIO
CADSTAR fonts are drawn on a 24x24 integer matrix, where the each axis goes from 0 to 24.
static wxString GetXmlAttributeIDString(XNODE *aNode, unsigned int aID, bool aIsRequired=true)
void checkPoint()
Updates m_progressReporter or throws if user canceled.
static bool IsValidAttribute(wxXmlAttribute *aAttribute)
static READABILITY ParseReadability(XNODE *aNode)
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).
@ DESIGN
Inherits from design units (assumed Assignments->Technology->Units)
static wxString HandleTextOverbar(wxString aCadstarString)
Convert a string with CADSTAR overbar characters to equivalent in KiCad.
static void CheckNoChildNodes(XNODE *aNode)
static long GetXmlAttributeIDLong(XNODE *aNode, unsigned int aID, bool aIsRequired=true)
JUSTIFICATION
From CADSTAR Help: "Multi Line Text can also be justified as Left, Centre or Right.
static void ParseChildEValue(XNODE *aNode, PARSER_CONTEXT *aContext, EVALUE &aValueToParse)
static long GetNumberOfStepsForReporting(XNODE *aRootNode, std::vector< wxString > aSubNodeChildrenToCount)
PROGRESS_REPORTER * m_progressReporter
static long GetNumberOfChildNodes(XNODE *aNode)
static void InsertAttributeAtEnd(XNODE *aNode, wxString aValue)
@ PART_DEFINITION
Only library Attributes.
@ PART
Only library Attributes.
Implement a lexical analyzer for the SPECCTRA DSN file format.
const char * CurText() const
Return a pointer to the current token's text.
int NextTok()
Return the next token found in the input file or DSN_EOF when reaching the end of file.
A mix-in class (via multiple inheritance) that handles texts such as labels, parts,...
virtual const wxString & GetText() const
Return the string associated with the text object.
virtual void Offset(const VECTOR2I &aOffset)
virtual EDA_ANGLE GetTextAngle() const
int GetInterline(const RENDER_SETTINGS *aSettings) const
Return the distance between two lines of text.
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
virtual const wxString Problem() const
what was the problem?
A progress reporter interface for use in multi-threaded environments.
virtual bool KeepRefreshing(bool aWait=false)=0
Update the UI (if any).
virtual void SetCurrentProgress(double aProgress)=0
Set the progress value to aProgress (0..1).
SHAPE_ARC & ConstructFromStartEndCenter(const VECTOR2I &aStart, const VECTOR2I &aEnd, const VECTOR2I &aCenter, bool aClockwise=false, double aWidth=0)
Constructs this arc from the given start, end and center.
Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc s...
virtual const VECTOR2I GetPoint(int aIndex) const override
void SetClosed(bool aClosed)
Mark the line chain as closed (i.e.
int PointCount() const
Return the number of points (vertices) in this line chain.
void Append(int aX, int aY, bool aAllowDuplication=false)
Append a new point at the end of the line chain.
const VECTOR2I & CPoint(int aIndex) const
Return a reference to a given point in the line chain.
Represent a set of closed polygons.
int AddOutline(const SHAPE_LINE_CHAIN &aOutline)
Adds a new outline to the set and returns its index.
int AddHole(const SHAPE_LINE_CHAIN &aHole, int aOutline=-1)
Adds a new hole to the given outline (default: last) and returns its index.
An extension of wxXmlNode that can format its contents as KiCad-style s-expressions.
XNODE * GetParent() const
XNODE * GetChildren() const
void AddAttribute(const wxString &aName, const wxString &aValue) override
#define THROW_IO_ERROR(msg)
macro which captures the "call site" values of FILE_, __FUNCTION & LINE
#define THROW_IO_ERRORF(msg,...)
#define THROW_IO_CANCELLED()
This file contains miscellaneous commonly used macros and functions.
#define KI_FALLTHROUGH
The KI_FALLTHROUGH macro is to be used when switch statement cases should purposely fallthrough from ...
static wxString nodeName(const wxString &aSymbolPin)
wxString ConvertToNewOverbarNotation(const wxString &aOldStr)
Convert the old ~...~ overbar notation to the new ~{...} one.
wxString EscapeString(const wxString &aSource, ESCAPE_CONTEXT aContext)
The Escape/Unescape routines use HTML-entity-reference-style encoding to handle characters which are:...
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
DFLTSETTINGS DefaultSettings
std::map< ATTRIBUTE_ID, ATTRCOL > AttributeColors
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
void ParseIdentifiers(XNODE *aNode, PARSER_CONTEXT *aContext)
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
JUSTIFICATION Justification
Note: Justification has no effect on single lines of text.
ALIGNMENT Alignment
In CADSTAR The default alignment for a TEXT object (when "(No Alignment()" is selected) Bottom Left o...
bool ParseSubNode(XNODE *aChildNode, PARSER_CONTEXT *aContext)
ATTRIBUTE_LOCATION AttributeLocation
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
bool HasLocation
Flag to know if this ATTRIBUTE_VALUE has a location i.e.
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
NOTE from CADSTAR help: To convert a Part Definition Attribute into a hyperlink, prefix the attribute...
std::vector< COLUMNWIDTH > ColumnWidths
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
bool NoTransfer
True="All Design Types", False="Current Design Type" "All Design Types" Description from CADSTAR Help...
std::vector< COLUMNORDER > ColumnOrders
wxString Name
Parenthesis aren't permitted in user attributes in CADSTAR.
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
std::vector< ATTRIBUTE_VALUE > Attributes
std::map< SPACING_CLASS_ID, SPCCLASSNAME > SpacingClassNames
std::map< LINECODE_ID, LINECODE > LineCodes
std::map< NETCLASS_ID, CADSTAR_NETCLASS > NetClasses
bool ParseSubNode(XNODE *aChildNode, PARSER_CONTEXT *aContext)
std::map< HATCHCODE_ID, HATCHCODE > HatchCodes
std::map< ATTRIBUTE_ID, ATTRNAME > AttributeNames
std::map< ROUTECODE_ID, ROUTECODE > RouteCodes
std::map< TEXTCODE_ID, TEXTCODE > TextCodes
Represent a cutout in a closed shape (e.g.
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
std::vector< VERTEX > Vertices
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
long ScaleRatioNumerator
Documentation symbols can be arbitrarily scaled when added to a design.
std::map< ATTRIBUTE_ID, ATTRIBUTE_VALUE > AttributeValues
long ScaleRatioDenominator
Documentation symbols can be arbitrarily scaled when added to a design.
POINT Origin
Origin of the component (this is used as the reference point when placing the component in the design...
REUSEBLOCKREF ReuseBlockRef
GROUP_ID GroupID
If not empty, this component is part of a group.
LAYER_ID LayerID
Move all objects in the Symdef to this layer.
DOCUMENTATION_SYMBOL_ID ID
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
SYMDEF_ID SymdefID
Normally documentation symbols only have TEXT, FIGURE and TEXT_LOCATION objects which are all drawn o...
Represent a floating value in E notation.
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
long Modifier2
It seems this is always 0 regardless of settings.
long Modifier1
It seems this is related to weight. 400=Normal, 700=Bold.
GRID ScreenGrid
From CADSTAR Help: "There is one Screen Grid, which is visible as dots on the screen.
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
std::vector< GRID > UserGrids
List of predefined grids created by the user.
static bool IsGrid(XNODE *aNode)
long Param1
Either Units or X step, depending on Type (see GRID_TYPE for more details)
long Param2
Either Divisor or Y step, depending on Type (see GRID_TYPE for more details)
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
GROUP_ID GroupID
If not empty, this GROUP is part of another GROUP.
bool Transfer
If true, the group is transferred to PCB.
REUSEBLOCKREF ReuseBlockRef
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
std::vector< HATCH > Hatches
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
long OrientAngle
1/1000 of a Degree
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
std::map< ATTRIBUTE_ID, ATTRIBUTE_VALUE > AttributeValues
It is possible to add attributes solely to a particular connection.
REUSEBLOCKREF ReuseBlockRef
void ParseIdentifiers(XNODE *aNode, PARSER_CONTEXT *aContext)
GROUP_ID GroupID
If not empty, this connection is part of a group.
bool ParseSubNode(XNODE *aChildNode, PARSER_CONTEXT *aContext)
GROUP_ID GroupID
If not empty, this JUNCTION is part of a group.
bool ParseSubNode(XNODE *aChildNode, PARSER_CONTEXT *aContext)
virtual void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
void ParseIdentifiers(XNODE *aNode, PARSER_CONTEXT *aContext)
NETELEMENT_ID ID
First character is "J".
REUSEBLOCKREF ReuseBlockRef
ROUTECODE_ID RouteCodeID
"NETCODE" subnode
bool ParseSubNode(XNODE *aChildNode, PARSER_CONTEXT *aContext)
wxString Name
This is undefined (wxEmptyString) if the net is unnamed.
std::map< NETELEMENT_ID, JUNCTION > Junctions
void ParseIdentifiers(XNODE *aNode, PARSER_CONTEXT *aContext)
NETCLASS_ID NetClassID
The net might not have a net class, in which case it will be wxEmptyString subnode="NETCLASSREF".
SPACING_CLASS_ID SpacingClassID
The net might not have a spacing class, in which case it will be wxEmptyString subnode="SPACINGCLASS"...
std::map< ATTRIBUTE_ID, ATTRIBUTE_VALUE > AttributeValues
long SignalNum
This is undefined if the net has been given a name.
std::map< TEXT_FIELD_NAME, wxString > TextFieldToValuesMap
Values for the text field elements used in the CADSTAR design extracted from the text element instanc...
std::map< wxString, wxString > FilenamesToTextMap
CADSTAR doesn't have user defined text fields but does allow loading text from a file.
std::map< wxString, wxString > TextToHyperlinksMap
KiCad doesn't support hyperlinks but we use this map to display warning messages after import.
std::set< TEXT_FIELD_NAME > InconsistentTextFields
Text fields need to be updated in CADSTAR and it is possible that they are not consistent across text...
std::function< void()> CheckPointCallback
Callback function to report progress.
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
std::map< PART_ID, PART > PartDefinitions
< "GATEDEFINITION" node name
long PinCount
Number of pins (terminals) in the symbol.
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
GATE_ID ID
Usually "A", "B", "C", etc.
wxString Alternate
Symbol alternate name in the symbol library.
wxString Name
Symbol name in the symbol library.
< "PINEQUIVALENCE" Node name
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
std::vector< PART_DEFINITION_PIN_ID > PinIDs
All the pins in this vector are equivalent and can be swapped with each other.
< "PARTDEFINITIONPIN" node name
wxString Label
Can be empty.
wxString Name
Can be empty.
long Load
The electrical current expected on the pin (it is unclear what the units are, but only accepted value...
CADSTAR_PIN_POSITION Position
The pin names will use these positions when the symbol is added to a design.
TERMINAL_ID TerminalPin
(subnode="PINTERM", param1)
wxString Identifier
This should match a pad identifier in the component footprint.
GATE_ID TerminalGate
(subnode="PINTERM", param0)
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
wxString Signal
Usually for Power/Ground pins subnode="PINSIGNAL".
PART_DEFINITION_PIN_ID ID
CADSTAR_PIN_TYPE Type
subnode="PINTYPE"
< "SWAPGATE" Node name (represents an "Element")
std::vector< PART_DEFINITION_PIN_ID > PinIDs
The pins in this vector describe a "gate".
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
wxString GateName
Optional.
std::vector< SWAP_GATE > SwapGates
Each of the elements in this vector can be swapped with each other - i.e.
bool External
Determines if this swap group is external (and internal) or internal only.
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
bool HidePinNames
Specifies whether to display the pin names/identifier in the schematic symbol or not.
std::map< GATE_ID, GATE > GateSymbols
std::vector< PIN_EQUIVALENCE > PinEquivalences
wxString Name
This name can be different to the PART name.
long MaxPinCount
Optional parameter which is used for specifying the number of electrical pins on the PCB component sy...
std::map< ATTRIBUTE_ID, ATTRIBUTE_VALUE > AttributeValues
Some attributes are defined within the part definition, whilst others are defined in the part.
std::map< PART_DEFINITION_PIN_ID, PIN > Pins
std::vector< SWAP_GROUP > SwapGroups
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
static CADSTAR_PIN_TYPE GetPinType(XNODE *aNode)
std::map< PART_PIN_ID, PART_PIN > PartPins
It is unclear why there are two "Pin" structures in CPA files... PART_PIN seems to be a reduced versi...
std::map< ATTRIBUTE_ID, ATTRIBUTE_VALUE > AttributeValues
Some attributes are defined within the part definition, whilst others are defined in the part itself.
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
bool HidePinNames
This seems to be a duplicate of DEFINITION::HidePinNames Possibly only used in older file formats?
Represent a point in x,y coordinates.
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
REUSEBLOCK_ID ReuseBlockID
wxString ItemReference
For Components, this references the designator in the reuse file.
bool IsEmpty()
Determines if this is empty (i.e. no design reuse associated)
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
wxString FileName
Filename of the reuse block (usually a .pcb). Used for reloading.
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
std::vector< ROUTEREASSIGN > RouteReassigns
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
UNITS Units
Units to display for linear dimensions.
long PinNoAngle
The angle at which the Pin ID is positioned relative to a terminal.
long InterlineGap
For CADSTAR font only, distance between lines of text, expressed as a percentage of the text height (...
long BarlineGap
For CADSTAR font only, distance between top bar and character, expressed as a percentage of the text ...
virtual void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
bool AllowBarredText
Specifies if barring is allowed in the design.
std::pair< POINT, POINT > DesignArea
long AngularPrecision
Number of decimal points to display for angular dimensions.
long UnitDisplPrecision
Number of decimal points to display for linear dimensions.
bool ParseSubNode(XNODE *aChildNode, PARSER_CONTEXT *aContext)
long PinNoOffset
The distance, of a Pin Name/Identifier from its parent terminal.
SHAPE_POLY_SET ConvertToPolySet(const std::function< VECTOR2I(const VECTOR2I &)> aCadstarToKicadPointCallback, int aAccuracy) const
std::vector< VERTEX > Vertices
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
wxString HatchCodeID
Only Applicable for HATCHED Type.
static bool IsShape(XNODE *aNode)
std::vector< CUTOUT > Cutouts
Not Applicable to OPENSHAPE Type.
SHAPE_LINE_CHAIN OutlineAsChain(const std::function< VECTOR2I(const VECTOR2I &)> aCadstarToKicadPointCallback, int aAccuracy) const
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
std::map< FIGURE_ID, FIGURE > Figures
std::map< ATTRIBUTE_ID, TEXT_LOCATION > TextLocations
This contains location of any attributes, including designator position.
POINT Origin
Origin of the component (this is used as the reference point when placing the component in the design...
wxString Alternate
This is in addition to ReferenceName.
bool ParseSubNode(XNODE *aChildNode, PARSER_CONTEXT *aContext)
std::map< TEXT_ID, TEXT > Texts
bool Stub
When the CADSTAR Archive file is exported without the component library, if components on the board a...
wxString ReferenceName
This is the name which identifies the symbol in the library.
void ParseIdentifiers(XNODE *aNode, PARSER_CONTEXT *aContext)
std::map< ATTRIBUTE_ID, ATTRIBUTE_VALUE > AttributeValues
These attributes might also have a location.
wxString BuildLibName() const
long Version
Version is a sequential integer number to identify discrepancies between the library and the design.
long Width
Defaults to 0 if using system fonts or, if using CADSTAR font, defaults to equal height (1:1 aspect r...
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
Corresponds to CADSTAR "origin".
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
REUSEBLOCKREF ReuseBlockRef
ALIGNMENT Alignment
In CADSTAR The default alignment for a TEXT object (when "(No Alignment)" is selected) Bottom Left of...
JUSTIFICATION Justification
Note: has no effect on single lines of text.
GROUP_ID GroupID
If not empty, this FIGURE is part of a group.
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
std::map< VARIANT_ID, VARIANT > Variants
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
< Nodename = "VARIANT" or "VMASTER" (master variant
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
VARIANT_ID ParentID
if empty, then this one is the master
Represents a vertex in a shape.
static bool IsVertex(XNODE *aNode)
SHAPE_ARC BuildArc(const VECTOR2I &aPrevPoint, const std::function< VECTOR2I(const VECTOR2I &)> aCadstarToKicadPointCallback) const
void Parse(XNODE *aNode, PARSER_CONTEXT *aContext) override
void AppendToChain(SHAPE_LINE_CHAIN *aChainToAppendTo, const std::function< VECTOR2I(const VECTOR2I &)> aCadstarToKicadPointCallback, int aAccuracy) const
Hold a keyword string and its unique integer token.
wxString result
Test unit parsing edge cases and error handling.
void RotatePoint(int *pX, int *pY, const EDA_ANGLE &aAngle)
Calculate the new point of coord coord pX, pY, for a rotation center 0, 0.
VECTOR2< int32_t > VECTOR2I