CADSTAR PCB Archive Importer: Parse ASSIGNMENTS->TECHNOLOGY and ASSIGNMENTS->GRIDS sections

This commit is contained in:
Roberto Fernandez Bautista 2020-07-18 17:44:20 +01:00 committed by Seth Hillbrand
parent 4fcba4d619
commit 0ce95f2803
4 changed files with 451 additions and 116 deletions

View File

@ -38,6 +38,15 @@ void CADSTAR_COMMON::EVALUE::Parse( XNODE* aNode )
} }
void CADSTAR_COMMON::POINT::Parse( XNODE* aNode )
{
wxASSERT( aNode->GetName() == wxT( "PT" ) );
X = CADSTAR_COMMON::GetAttributeIDLong( aNode, 0 );
Y = CADSTAR_COMMON::GetAttributeIDLong( aNode, 1 );
}
double CADSTAR_COMMON::EVALUE::GetDouble() double CADSTAR_COMMON::EVALUE::GetDouble()
{ {
return Base * std::pow( 10.0, Exponent ); return Base * std::pow( 10.0, Exponent );
@ -132,12 +141,9 @@ XNODE* CADSTAR_COMMON::LoadArchiveFile( const wxString& aFileName, FILE_TYPE aTy
else if( iNode ) else if( iNode )
{ {
str = wxString( lexer.CurText(), *conv ); str = wxString( lexer.CurText(), *conv );
//Insert even if string is empty
if( !str.IsEmpty() )
{
InsertAttributeAtEnd( iNode, str ); InsertAttributeAtEnd( iNode, str );
} }
}
else else
{ {
//not enough closing brackets //not enough closing brackets
@ -217,3 +223,31 @@ void CADSTAR_COMMON::ParseChildEValue( XNODE* aNode, CADSTAR_COMMON::EVALUE& aVa
THROW_UNKNOWN_NODE_IO_ERROR( aNode->GetChildren()->GetName(), aNode->GetName() ); THROW_UNKNOWN_NODE_IO_ERROR( aNode->GetChildren()->GetName(), aNode->GetName() );
} }
} }
std::vector<CADSTAR_COMMON::POINT> CADSTAR_COMMON::ParseAllChildPoints(
XNODE* aNode, bool aTestAllChildNodes, int aExpectedNumPoints )
{
std::vector<CADSTAR_COMMON::POINT> retVal;
XNODE* cNode = aNode->GetChildren();
for( ; cNode; cNode = cNode->GetNext() )
{
if( cNode->GetName() == wxT( "PT" ) )
{
POINT pt;
//TODO try.. catch + throw again with more detailed error information
pt.Parse( cNode );
retVal.push_back( pt );
}
else if( aTestAllChildNodes )
THROW_UNKNOWN_NODE_IO_ERROR( cNode->GetName(), aNode->GetName() );
}
if( aExpectedNumPoints >= 0 && retVal.size() != aExpectedNumPoints )
THROW_IO_ERROR( wxString::Format(
_( "Unexpected number of points in '%s'. Found %d but expected %d." ),
aNode->GetName(), retVal.size(), aExpectedNumPoints ) );
return retVal;
}

View File

@ -29,6 +29,7 @@
#include <class_board.h> #include <class_board.h>
#include <dsnlexer.h> #include <dsnlexer.h>
#include <macros.h> #include <macros.h>
#include <vector>
#include <wx/wx.h> #include <wx/wx.h>
#include <wx/xml/xml.h> #include <wx/xml/xml.h>
#include <xnode.h> #include <xnode.h>
@ -72,6 +73,18 @@ struct EVALUE
double GetDouble(); double GetDouble();
}; };
/**
* @brief Represents a point in x,y coordinates
*/
struct POINT
{
long X;
long Y;
void Parse( XNODE* aNode );
};
extern void InsertAttributeAtEnd( XNODE* aNode, wxString aValue ); extern void InsertAttributeAtEnd( XNODE* aNode, wxString aValue );
/** /**
@ -79,8 +92,8 @@ extern void InsertAttributeAtEnd( XNODE* aNode, wxString aValue );
* @param aFileName * @param aFileName
* @param aType * @param aType
* @return XNODE pointing to the top of the tree for further parsing. Each node has the first * @return 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", * 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. * "attr1", "attr2", etc.). Caller is responsible for deleting to avoid memory leaks.
* @throws IO_ERROR * @throws IO_ERROR
*/ */
extern XNODE* LoadArchiveFile( extern XNODE* LoadArchiveFile(
@ -131,6 +144,20 @@ extern void CheckNoNextNodes( XNODE* aNode );
*/ */
extern void ParseChildEValue( XNODE* aNode, EVALUE& aValueToParse ); extern void ParseChildEValue( XNODE* aNode, EVALUE& aValueToParse );
/**
* @brief if no childs are present, it just returns an empty
* vector (without throwing an exception)
* @param aNode containing a series of POINT objects
* @param aTestAllChildNodes
* @param aExpectedNumPoints if -1, this is check is disabled
* @return std::vector containing all POINT objects
* @throw IO_ERROR if one of the following:
* - Unable to parse a POINT object
* - aTestAllChildNodes is true and one of the child nodes is not a valid POINT object
* - aExpectedNumPoints is non-negative and the number of POINT objects found is different
*/
extern std::vector<POINT> ParseAllChildPoints(
XNODE* aNode, bool aTestAllChildNodes = true, int aExpectedNumPoints = -1 );
} // namespace CADSTAR_COMMON } // namespace CADSTAR_COMMON

View File

@ -32,16 +32,17 @@ void CPA_FILE::Parse()
XNODE* fileRootNode = XNODE* fileRootNode =
CADSTAR_COMMON::LoadArchiveFile( Filename, CADSTAR_COMMON::FILE_TYPE::PCB_ARCHIVE ); CADSTAR_COMMON::LoadArchiveFile( Filename, CADSTAR_COMMON::FILE_TYPE::PCB_ARCHIVE );
XNODE* tempNode = fileRootNode->GetChildren(); XNODE* cNode = fileRootNode->GetChildren();
for( ; tempNode && ( tempNode->GetName() != wxT( "HEADER" ) ); tempNode = tempNode->GetNext() ) if( !cNode )
;
if( !tempNode )
THROW_MISSING_NODE_IO_ERROR( wxT( "HEADER" ), wxT( "CADSTARPCB" ) ); THROW_MISSING_NODE_IO_ERROR( wxT( "HEADER" ), wxT( "CADSTARPCB" ) );
for( ; cNode; cNode = cNode->GetNext() )
{
if( cNode->GetName() == wxT( "HEADER" ) )
{
//TODO try.. catch + throw again with more detailed error information //TODO try.. catch + throw again with more detailed error information
Header.Parse( tempNode ); Header.Parse( cNode );
switch( Header.Resolution ) switch( Header.Resolution )
{ {
@ -53,27 +54,10 @@ void CPA_FILE::Parse()
wxASSERT_MSG( true, wxT( "Unknown File Resolution" ) ); wxASSERT_MSG( true, wxT( "Unknown File Resolution" ) );
break; break;
} }
}
for( ; tempNode && ( tempNode->GetName() != wxT( "ASSIGNMENTS" ) ); else if( cNode->GetName() == wxT( "ASSIGNMENTS" ) )
tempNode = tempNode->GetNext() ) Assignments.Parse( cNode );
; //TODO need to parse everything else!
if( !tempNode )
THROW_MISSING_NODE_IO_ERROR( wxT( "ASSIGNMENTS" ), wxT( "CADSTARPCB" ) );
tempNode = tempNode->GetChildren();
if( !tempNode )
THROW_MISSING_NODE_IO_ERROR( wxT( "LAYERDEFS" ), wxT( "ASSIGNMENTS" ) );
for( ; tempNode; tempNode = tempNode->GetNext() )
{
if( tempNode->GetName() == wxT( "LAYERDEFS" ) )
//TODO try.. catch + throw again with more detailed error information
Assignments.Layerdefs.Parse( tempNode );
else if( tempNode->GetName() == wxT( "CODEDEFS" ) )
Assignments.Codedefs.Parse( tempNode );
//TODO parse technology, grids,etc
} }
@ -85,8 +69,39 @@ void CPA_FILE::Parse()
} }
//delete fileRootNode; //delete fileRootNode;
}
//TODO need to parse everything else!
void CPA_ASSIGNMENTS::Parse( XNODE* aNode )
{
wxASSERT( aNode->GetName() == wxT( "ASSIGNMENTS" ) );
XNODE* cNode = aNode->GetChildren();
if( !cNode )
THROW_MISSING_NODE_IO_ERROR( wxT( "TECHNOLOGY" ), wxT( "ASSIGNMENTS" ) );
for( ; cNode; cNode = cNode->GetNext() )
{
if( cNode->GetName() == wxT( "LAYERDEFS" ) )
//TODO try.. catch + throw again with more detailed error information
Layerdefs.Parse( cNode );
else if( cNode->GetName() == wxT( "CODEDEFS" ) )
//TODO try.. catch + throw again with more detailed error information
Codedefs.Parse( cNode );
else if( cNode->GetName() == wxT( "TECHNOLOGY" ) )
//TODO try.. catch + throw again with more detailed error information
Technology.Parse( cNode );
else if( cNode->GetName() == wxT( "GRIDS" ) )
//TODO try.. catch + throw again with more detailed error information
Grids.Parse( cNode );
else if( cNode->GetName() == wxT( "NETCLASSEDITATTRIBSETTINGS" ) )
NetclassEditAttributeSettings = true;
else if( cNode->GetName() == wxT( "SPCCLASSEDITATTRIBSETTINGS" ) )
SpacingclassEditAttributeSettings = true;
else
THROW_UNKNOWN_NODE_IO_ERROR( cNode->GetName(), aNode->GetName() );
}
} }
@ -1128,8 +1143,8 @@ void CPA_NETCLASS::Parse( XNODE* aNode )
if( cNodeName == wxT( "ATTR" ) ) if( cNodeName == wxT( "ATTR" ) )
{ {
//TODO try.. catch + throw again with more detailed error information
CPA_ATTRIBUTE_VALUE attribute_val; CPA_ATTRIBUTE_VALUE attribute_val;
//TODO try.. catch + throw again with more detailed error information
attribute_val.Parse( cNode ); attribute_val.Parse( cNode );
Attributes.push_back( attribute_val ); Attributes.push_back( attribute_val );
} }
@ -1158,3 +1173,162 @@ void CPA_SPCCLASSSPACE::Parse( XNODE* aNode )
LayerID = CADSTAR_COMMON::GetAttributeID( aNode, 2 ); LayerID = CADSTAR_COMMON::GetAttributeID( aNode, 2 );
Spacing = CADSTAR_COMMON::GetAttributeIDLong( aNode, 3 ); Spacing = CADSTAR_COMMON::GetAttributeIDLong( aNode, 3 );
} }
void CPA_TECHNOLOGY::Parse( XNODE* aNode )
{
wxASSERT( aNode->GetName() == wxT( "TECHNOLOGY" ) );
XNODE* cNode = aNode->GetChildren();
for( ; cNode; cNode = cNode->GetNext() )
{
wxString cNodeName = cNode->GetName();
if( cNodeName == wxT( "UNITS" ) )
{
wxString unit = CADSTAR_COMMON::GetAttributeID( cNode, 0 );
if( unit == wxT( "CENTIMETER" ) )
Unit = CPA_UNITS::CENTIMETER;
else if( unit == wxT( "INCH" ) )
Unit = CPA_UNITS::INCH;
else if( unit == wxT( "METER" ) )
Unit = CPA_UNITS::METER;
else if( unit == wxT( "MICROMETRE" ) )
Unit = CPA_UNITS::MICROMETRE;
else if( unit == wxT( "MM" ) )
Unit = CPA_UNITS::MM;
else if( unit == wxT( "THOU" ) )
Unit = CPA_UNITS::THOU;
else
THROW_UNKNOWN_PARAMETER_IO_ERROR( unit, wxT( "TECHNOLOGY -> UNITS" ) );
}
else if( cNodeName == wxT( "UNITSPRECISION" ) )
UnitDisplPrecision = CADSTAR_COMMON::GetAttributeIDLong( cNode, 0 );
else if( cNodeName == wxT( "INTERLINEGAP" ) )
InterlineGap = CADSTAR_COMMON::GetAttributeIDLong( cNode, 0 );
else if( cNodeName == wxT( "BARLINEGAP" ) )
BarlineGap = CADSTAR_COMMON::GetAttributeIDLong( cNode, 0 );
else if( cNodeName == wxT( "ALLOWBARTEXT" ) )
AllowBarredText = true;
else if( cNodeName == wxT( "ANGULARPRECISION" ) )
AngularPrecision = CADSTAR_COMMON::GetAttributeIDLong( cNode, 0 );
else if( cNodeName == wxT( "MINROUTEWIDTH" ) )
MinRouteWidth = CADSTAR_COMMON::GetAttributeIDLong( cNode, 0 );
else if( cNodeName == wxT( "MINNECKED" ) )
MinNeckedLength = CADSTAR_COMMON::GetAttributeIDLong( cNode, 0 );
else if( cNodeName == wxT( "MINUNNECKED" ) )
MinUnneckedLength = CADSTAR_COMMON::GetAttributeIDLong( cNode, 0 );
else if( cNodeName == wxT( "MINMITER" ) )
MinMitre = CADSTAR_COMMON::GetAttributeIDLong( cNode, 0 );
else if( cNodeName == wxT( "MAXMITER" ) )
MaxMitre = CADSTAR_COMMON::GetAttributeIDLong( cNode, 0 );
else if( cNodeName == wxT( "MAXPHYSLAYER" ) )
MaxPhysicalLayer = CADSTAR_COMMON::GetAttributeIDLong( cNode, 0 );
else if( cNodeName == wxT( "TRACKGRID" ) )
TrackGrid = CADSTAR_COMMON::GetAttributeIDLong( cNode, 0 );
else if( cNodeName == wxT( "VIAGRID" ) )
ViaGrid = CADSTAR_COMMON::GetAttributeIDLong( cNode, 0 );
else if( cNodeName == wxT( "DESIGNORIGIN" ) )
{
std::vector<CADSTAR_COMMON::POINT> pts =
CADSTAR_COMMON::ParseAllChildPoints( cNode, true, 1 );
DesignOrigin = pts[0];
}
else if( cNodeName == wxT( "DESIGNAREA" ) )
{
std::vector<CADSTAR_COMMON::POINT> pts =
CADSTAR_COMMON::ParseAllChildPoints( cNode, true, 2 );
DesignArea = std::make_pair( pts[0], pts[1] );
}
else if( cNodeName == wxT( "DESIGNREF" ) )
{
std::vector<CADSTAR_COMMON::POINT> pts =
CADSTAR_COMMON::ParseAllChildPoints( cNode, true, 1 );
DesignRef = pts[0];
}
else if( cNodeName == wxT( "DESIGNLIMIT" ) )
{
std::vector<CADSTAR_COMMON::POINT> pts =
CADSTAR_COMMON::ParseAllChildPoints( cNode, true, 1 );
DesignLimit = pts[0];
}
else if( cNodeName == wxT( "BACKOFFJCTS" ) )
BackOffJunctions = true;
else if( cNodeName == wxT( "BCKOFFWIDCHANGE" ) )
BackOffWidthChange = true;
else
THROW_UNKNOWN_NODE_IO_ERROR( cNodeName, wxT( "TECHNOLOGY" ) );
}
}
bool CPA_GRID::IsGrid( XNODE* aNode )
{
wxString aNodeName = aNode->GetName();
if( aNodeName == wxT( "FRACTIONALGRID" ) || aNodeName == wxT( "STEPGRID" ) )
return true;
else
return false;
}
void CPA_GRID::Parse( XNODE* aNode )
{
wxASSERT( IsGrid( aNode ) );
wxString aNodeName = aNode->GetName();
if( aNodeName == wxT( "FRACTIONALGRID" ) )
Type = CPA_GRID_TYPE::FRACTIONALGRID;
else if( aNodeName == wxT( "STEPGRID" ) )
Type = CPA_GRID_TYPE::STEPGRID;
else
wxASSERT_MSG( true, wxT( "Unknown Grid Type" ) );
Name = CADSTAR_COMMON::GetAttributeID( aNode, 0 );
Param1 = CADSTAR_COMMON::GetAttributeIDLong( aNode, 1 );
Param2 = CADSTAR_COMMON::GetAttributeIDLong( aNode, 2 );
}
void CPA_GRIDS::Parse( XNODE* aNode )
{
wxASSERT( aNode->GetName() == wxT( "GRIDS" ) );
XNODE* cNode = aNode->GetChildren();
for( ; cNode; cNode = cNode->GetNext() )
{
wxString cNodeName = cNode->GetName();
if( cNodeName == wxT( "WORKINGGRID" ) )
{
XNODE* workingGridNode = cNode->GetChildren();
if( !CPA_GRID::IsGrid( workingGridNode ) )
THROW_UNKNOWN_NODE_IO_ERROR(
workingGridNode->GetName(), wxT( "GRIDS -> WORKINGGRID" ) );
else
WorkingGrid.Parse( workingGridNode );
}
else if( cNodeName == wxT( "SCREENGRID" ) )
{
XNODE* screenGridNode = cNode->GetChildren();
if( !CPA_GRID::IsGrid( screenGridNode ) )
THROW_UNKNOWN_NODE_IO_ERROR(
screenGridNode->GetName(), wxT( "GRIDS -> SCREENGRID" ) );
else
ScreenGrid.Parse( screenGridNode );
}
else if( CPA_GRID::IsGrid( cNode ) )
{
CPA_GRID userGrid;
userGrid.Parse( cNode );
UserGrids.push_back( userGrid );
}
}
}

View File

@ -30,7 +30,7 @@
#include <map> #include <map>
#include <vector> #include <vector>
const long CPA_UNDEFINED = -1; //<Undefined Parameter const long CPA_UNDEFINED = -1; ///< Undefined Parameter
typedef wxString CPA_ID; typedef wxString CPA_ID;
@ -43,9 +43,9 @@ typedef wxString CPA_ID;
struct CPA_FORMAT struct CPA_FORMAT
{ {
wxString Type; wxString Type;
long SomeInt; //<unsure what this parameter is used for long SomeInt; ///< It is unclear what this parameter is used for
long Version; //<Archive version number (e.g. 21 => CADSTAR 2018.0 and 2019.0 arhive, long Version; ///< Archive version number (e.g. 21 => CADSTAR 2018.0 and 2019.0 arhive,
// 20=> CADSTAR 18.0 archive, 19=> CADSTAR 17.0 archive, etc.) ///< 20=> CADSTAR 18.0 archive, 19=> CADSTAR 17.0 archive, etc.)
void Parse( XNODE* aNode ); void Parse( XNODE* aNode );
}; };
@ -106,10 +106,10 @@ struct CPA_MATERIAL
{ {
CPA_ID ID; CPA_ID ID;
wxString Name; wxString Name;
CPA_MATERIAL_LAYER_TYPE Type; //<Type of layer appropriate for the material being set up CPA_MATERIAL_LAYER_TYPE Type; ///< Type of layer appropriate for the material being set up
CADSTAR_COMMON::EVALUE Permittivity; CADSTAR_COMMON::EVALUE Permittivity;
CADSTAR_COMMON::EVALUE LossTangent; CADSTAR_COMMON::EVALUE LossTangent;
CADSTAR_COMMON::EVALUE Resistivity; //< x10^-8 ohm*metre CADSTAR_COMMON::EVALUE Resistivity; ///< x10^-8 ohm*metre
void Parse( XNODE* aNode ); void Parse( XNODE* aNode );
}; };
@ -117,16 +117,16 @@ struct CPA_MATERIAL
enum class CPA_LAYER_TYPE enum class CPA_LAYER_TYPE
{ {
UNDEFINED, //< Only used for error detection UNDEFINED, ///< Only used for error detection
ALLLAYER, //< Inbuilt layer type (cannot be assigned to user layers) ALLLAYER, ///< Inbuilt layer type (cannot be assigned to user layers)
ALLELEC, //< Inbuilt layer type (cannot be assigned to user layers) ALLELEC, ///< Inbuilt layer type (cannot be assigned to user layers)
ALLDOC, //< Inbuilt layer type (cannot be assigned to user layers) ALLDOC, ///< Inbuilt layer type (cannot be assigned to user layers)
NOLAYER, //< Inbuilt layer type (cannot be assigned to user layers) NOLAYER, ///< Inbuilt layer type (cannot be assigned to user layers)
ASSCOMPCOPP, //< Inbuilt layer type (cannot be assigned to user layers) ASSCOMPCOPP, ///< Inbuilt layer type (cannot be assigned to user layers)
JUMPERLAYER, //< Inbuilt layer type (cannot be assigned to user layers) JUMPERLAYER, ///< Inbuilt layer type (cannot be assigned to user layers)
ELEC, ELEC,
POWER, POWER,
NONELEC, //< This type has subtypes NONELEC, ///< This type has subtypes
CONSTRUCTION, CONSTRUCTION,
DOC DOC
}; };
@ -145,11 +145,11 @@ enum class CPA_LAYER_SUBTYPE
enum class CPA_ROUTING_BIAS enum class CPA_ROUTING_BIAS
{ {
UNBIASED, //<Keyword "UNBIASED" (default) UNBIASED, ///< Keyword "UNBIASED" (default)
X, //<Keyword "X_BIASED" X, ///< Keyword "X_BIASED"
Y, //<Keyword "Y_BIASED" Y, ///< Keyword "Y_BIASED"
ANTI_ROUTE, //<Keyword "ANTITRACK" ANTI_ROUTE, ///< Keyword "ANTITRACK"
OBSTACLE //<Keyword "OBSTACLE" OBSTACLE ///< Keyword "OBSTACLE"
}; };
@ -168,12 +168,12 @@ struct CPA_LAYER
wxString Name; wxString Name;
CPA_LAYER_TYPE Type = CPA_LAYER_TYPE::UNDEFINED; CPA_LAYER_TYPE Type = CPA_LAYER_TYPE::UNDEFINED;
CPA_LAYER_SUBTYPE SubType = CPA_LAYER_SUBTYPE::LAYERSUBTYPE_NONE; CPA_LAYER_SUBTYPE SubType = CPA_LAYER_SUBTYPE::LAYERSUBTYPE_NONE;
CPA_PHYSICAL_LAYER PhysicalLayer = CPA_UNDEFINED; //< If CPA_UNDEFINED, no physical layer is CPA_PHYSICAL_LAYER PhysicalLayer = CPA_UNDEFINED; ///< If CPA_UNDEFINED, no physical layer is
// assigned (e.g. documentation and ///< assigned (e.g. documentation and
// construction layers) ///< construction layers)
CPA_ID SwapLayerID = wxEmptyString; //< If empty, no swap layer CPA_ID SwapLayerID = wxEmptyString; ///< If empty, no swap layer
CPA_ROUTING_BIAS RoutingBias = CPA_ROUTING_BIAS::UNBIASED; CPA_ROUTING_BIAS RoutingBias = CPA_ROUTING_BIAS::UNBIASED;
long Thickness = 0; //< Note: Units of length are defined in file header long Thickness = 0; ///< Note: Units of length are defined in file header
CPA_ID MaterialId; CPA_ID MaterialId;
CPA_EMBEDDING Embedding = CPA_EMBEDDING::NONE; CPA_EMBEDDING Embedding = CPA_EMBEDDING::NONE;
@ -219,7 +219,7 @@ struct CPA_HATCH
{ {
long Step; long Step;
long LineWidth; long LineWidth;
long OrientAngle; //< 1/1000 of a Degree long OrientAngle; ///< 1/1000 of a Degree
void Parse( XNODE* aNode ); void Parse( XNODE* aNode );
}; };
@ -242,11 +242,11 @@ const long CPA_FONT_BOLD = 700;
struct CPA_FONT struct CPA_FONT
{ {
wxString Name = wxT( "CADSTAR" ); wxString Name = wxT( "CADSTAR" );
long Modifier1 = CPA_FONT_NORMAL; //< It seems this is related to weight. 400=Normal, 700=Bold. long Modifier1 = CPA_FONT_NORMAL; ///< It seems this is related to weight. 400=Normal, 700=Bold.
long Modifier2 = 0; //< It seems this is always 0 regardless of settings long Modifier2 = 0; ///< It seems this is always 0 regardless of settings
bool KerningPairs = false; //< From CADSTAR Help: "Kerning Pairs is for causing the system to bool KerningPairs = false; ///< From CADSTAR Help: "Kerning Pairs is for causing the system to
//automatically reduce the spacing between certain pairs of ///< automatically reduce the spacing between certain pairs of
//characters in order to improve the appearance of the text" ///< characters in order to improve the appearance of the text"
bool Italic = false; bool Italic = false;
void Parse( XNODE* aNode ); void Parse( XNODE* aNode );
@ -259,9 +259,9 @@ struct CPA_TEXTCODE
wxString Name; wxString Name;
long LineWidth; long LineWidth;
long Height; long Height;
long Width; //< Defaults to 0 if using system fonts or, if using CADSTAR font, default to long Width; ///< Defaults to 0 if using system fonts or, if using CADSTAR font, default to
//equal height (1:1 aspect ratio). Allows for system fonts to be rendered in ///< equal height (1:1 aspect ratio). Allows for system fonts to be rendered in
//a different aspect ratio. ///< a different aspect ratio.
CPA_FONT Font; CPA_FONT Font;
void Parse( XNODE* aNode ); void Parse( XNODE* aNode );
@ -314,12 +314,12 @@ enum class CPA_SHAPE_TYPE
{ {
ANNULUS, ANNULUS,
BULLET, BULLET,
CIRCLE, //<Keyword "ROUND" CIRCLE, ///< Keyword "ROUND"
DIAMOND, DIAMOND,
FINGER, FINGER,
OCTAGON, OCTAGON,
RECTANGLE, RECTANGLE,
ROUNDED_RECT, //<Keyword "ROUNDED" ROUNDED_RECT, ///< Keyword "ROUNDED"
SQUARE SQUARE
}; };
@ -331,7 +331,7 @@ struct CPA_PAD_SHAPE
long LeftLength = CPA_UNDEFINED; long LeftLength = CPA_UNDEFINED;
long RightLength = CPA_UNDEFINED; long RightLength = CPA_UNDEFINED;
long InternalFeature = CPA_UNDEFINED; long InternalFeature = CPA_UNDEFINED;
long OrientAngle = 0; //< 1/1000 of a Degree long OrientAngle = 0; ///< 1/1000 of a Degree
static bool IsShape( XNODE* aNode ); static bool IsShape( XNODE* aNode );
void Parse( XNODE* aNode ); void Parse( XNODE* aNode );
@ -343,7 +343,7 @@ struct CPA_PADREASSIGN
CPA_ID LayerID; CPA_ID LayerID;
CPA_PAD_SHAPE Shape; CPA_PAD_SHAPE Shape;
void Parse( XNODE* aNode ); //TODO Implement void Parse( XNODE* aNode );
}; };
@ -352,8 +352,8 @@ struct CPA_PADCODE
CPA_ID ID; CPA_ID ID;
wxString Name; wxString Name;
CPA_PAD_SHAPE Shape; CPA_PAD_SHAPE Shape;
long ReliefClearance = CPA_UNDEFINED; //< if undefined inherits from design long ReliefClearance = CPA_UNDEFINED; ///< if undefined inherits from design
long ReliefWidth = CPA_UNDEFINED; //< if undefined inherits from design long ReliefWidth = CPA_UNDEFINED; ///< if undefined inherits from design
bool Plated = true; bool Plated = true;
long DrillDiameter = CPA_UNDEFINED; long DrillDiameter = CPA_UNDEFINED;
long DrillOversize = CPA_UNDEFINED; long DrillOversize = CPA_UNDEFINED;
@ -382,8 +382,8 @@ struct CPA_VIACODE
CPA_ID ID; CPA_ID ID;
wxString Name; wxString Name;
CPA_PAD_SHAPE Shape; CPA_PAD_SHAPE Shape;
long ReliefClearance = CPA_UNDEFINED; //< if undefined inherits from design long ReliefClearance = CPA_UNDEFINED; ///< if undefined inherits from design
long ReliefWidth = CPA_UNDEFINED; //< if undefined inherits from design long ReliefWidth = CPA_UNDEFINED; ///< if undefined inherits from design
long DrillDiameter = CPA_UNDEFINED; long DrillDiameter = CPA_UNDEFINED;
long DrillOversize = CPA_UNDEFINED; long DrillOversize = CPA_UNDEFINED;
@ -417,8 +417,8 @@ enum class CPA_ATTROWNER
FIGURE, FIGURE,
NET, NET,
NETCLASS, NETCLASS,
PART, //< Only library Attributes PART, ///< Only library Attributes
PART_DEFINITION, //< Only library Attributes PART_DEFINITION, ///< Only library Attributes
PIN, PIN,
SYMDEF, SYMDEF,
TEMPLATE, TEMPLATE,
@ -428,17 +428,17 @@ enum class CPA_ATTROWNER
enum class CPA_ATTRUSAGE enum class CPA_ATTRUSAGE
{ {
BOTH, //< From CADSTAR Help: Assigned to both Schematic symbols and PCB components, BOTH, ///< From CADSTAR Help: Assigned to both Schematic symbols and PCB components,
// and displayed on Schematic and PCB designs. ///< and displayed on Schematic and PCB designs.
COMPONENT, //< From CADSTAR Help: Assigned to PCB components and displayed on 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 PART_DEFINITION, ///< From CADSTAR Help: Assigned to Parts library Definitions and displayed
// by the Library searcher ///< by the Library searcher
PART_LIBRARY, //< From CADSTAR Help: Only used by non-Cadstar applicationws PART_LIBRARY, ///< From CADSTAR Help: Only used by non-Cadstar applicationws
SYMBOL, //< From CADSTAR Help: Assigned to Schematic Symbols and displayed on SYMBOL, ///< From CADSTAR Help: Assigned to Schematic Symbols and displayed on
// Schematic Designs ///< Schematic Designs
UNDEFINED //< Note: It seems that some attribute have no "ATTRUSAGE" defined. It appears UNDEFINED ///< Note: It seems that some attribute have no "ATTRUSAGE" defined. It appears
// that the attributes that fall under this category arethe ones associated ///< that the attributes that fall under this category arethe ones associated
// with the design itself (i.e. not inherited from the library) ///< with the design itself (i.e. not inherited from the library)
}; };
/** /**
@ -451,11 +451,13 @@ struct CPA_ATTRNAME
wxString Name; wxString Name;
CPA_ATTROWNER AttributeOwner = CPA_ATTROWNER::ALL_ITEMS; CPA_ATTROWNER AttributeOwner = CPA_ATTROWNER::ALL_ITEMS;
CPA_ATTRUSAGE AttributeUsage = CPA_ATTRUSAGE::UNDEFINED; CPA_ATTRUSAGE AttributeUsage = CPA_ATTRUSAGE::UNDEFINED;
bool NoTransfer = false; //< True="All Design Types", False="Current Design Type" bool NoTransfer = false; ///< True="All Design Types", False="Current Design Type"
// "All Design Types" Description from CADSTAR Help: "The selected ///< "All Design Types" Description from CADSTAR Help:
// attribute name will beavailable when any design is displayed" ///< "The selected attribute name will beavailable when
// "Current Design Type" From CADSTAR Help: This restricts the ///< any design is displayed"
// availability of the selectedattribute name to the current design. ///< "Current Design Type" From CADSTAR Help: This
///< restricts the availability of the selected attribute
///< name to the current design.
void Parse( XNODE* aNode ); void Parse( XNODE* aNode );
}; };
@ -482,19 +484,19 @@ struct CPA_NETCLASS
struct CPA_SPCCLASSNAME struct CPA_SPCCLASSNAME
{ {
CPA_ID ID; CPA_ID ID; //TODO convert to an enum class containing all valid spacings
wxString Name; wxString Name;
void Parse( XNODE* aNode ); void Parse( XNODE* aNode );
}; };
const CPA_ID CPA_NO_SPACE_CLASS_ID = wxT( "NO_SPACE_CLASS" ); //< Default spacing class const CPA_ID CPA_NO_SPACE_CLASS_ID = wxT( "NO_SPACE_CLASS" ); ///< Default spacing class
struct CPA_SPCCLASSSPACE struct CPA_SPCCLASSSPACE
{ {
CPA_ID SpacingClassID1; CPA_ID SpacingClassID1;
CPA_ID SpacingClassID2; CPA_ID SpacingClassID2;
CPA_ID LayerID; //< Normally LAY0, which corresponds to (All Layers) CPA_ID LayerID; ///< Normally LAY0, which corresponds to (All Layers)
long Spacing; long Spacing;
void Parse( XNODE* aNode ); void Parse( XNODE* aNode );
@ -508,16 +510,109 @@ struct CPA_CODEDEFS
std::map<CPA_ID, CPA_TEXTCODE> TextCodes; std::map<CPA_ID, CPA_TEXTCODE> TextCodes;
std::map<CPA_ID, CPA_ROUTECODE> RouteCodes; std::map<CPA_ID, CPA_ROUTECODE> RouteCodes;
std::map<CPA_ID, CPA_COPPERCODE> CopperCodes; std::map<CPA_ID, CPA_COPPERCODE> CopperCodes;
std::vector<CPA_SPACINGCODE> SpacingCodes; //<Design Rules. E.g. "A_A" = Comp to Comp std::vector<CPA_SPACINGCODE> SpacingCodes; ///< Spacing Design Rules
std::map<CPA_ID, CPA_PADCODE> PadCodes; std::map<CPA_ID, CPA_PADCODE> PadCodes;
std::map<CPA_ID, CPA_VIACODE> ViaCodes; std::map<CPA_ID, CPA_VIACODE> ViaCodes;
std::map<CPA_ID, CPA_LAYERPAIR> LayerPairs; //< Default vias to use between pairs of layers std::map<CPA_ID, CPA_LAYERPAIR> LayerPairs; ///< Default vias to use between pairs of layers
std::map<CPA_ID, CPA_ATTRNAME> AttributeNames; std::map<CPA_ID, CPA_ATTRNAME> AttributeNames;
std::map<CPA_ID, CPA_NETCLASS> NetClasses; std::map<CPA_ID, CPA_NETCLASS> NetClasses;
std::map<CPA_ID, CPA_SPCCLASSNAME> SpacingClassNames; std::map<CPA_ID, CPA_SPCCLASSNAME> SpacingClassNames;
std::vector<CPA_SPCCLASSSPACE> SpacingClasses; std::vector<CPA_SPCCLASSSPACE> SpacingClasses;
void Parse( XNODE* aNode ); //TODO Implement void Parse( XNODE* aNode );
};
//.................................
// ASSIGNMENTS -> TECHNOLOGY
//.................................
enum class CPA_UNITS
{
THOU,
INCH,
MICROMETRE,
MM,
CENTIMETER,
METER
};
struct CPA_TECHNOLOGY
{
CPA_UNITS Unit; ///< Unit to display for linear dimensions
long UnitDisplPrecision; ///< Number of decimal points to display for linear dimensions
long InterlineGap; ///< For CADSTAR font only, distance between lines of text,
///< expressed as a percentage of the text height (accepted
///< values are 0-100)
long BarlineGap; ///< For CADSTAR font only, distance between top bar and
///< character, expressed as a percentage of the text height
///< (accepted values are 0-100)
bool AllowBarredText = false; ///< Specifies if barring is allowed in the design
long AngularPrecision; ///< Number of decimal points to display for angular dimensions
long MinRouteWidth; ///< Manufacturing Design Rule. Corresponds to "Thin Route Width"
long MinNeckedLength; ///< Manufacturing Design Rule. Corresponds to
///< "Minimum Thinner Track Length"
long MinUnneckedLength; ///< Manufacturing Design Rule. Corresponds to
///< "Minimum Thicker Track Length"
long MinMitre; ///< Manufacturing Design Rule. Corresponds to "Minimum Mitre"
long MaxMitre; ///< Manufacturing Design Rule. Corresponds to "Maximum Mitre"
long MaxPhysicalLayer; ///< Should equal number of copper layers. However, it seems this
///< can be set to any arbitrarily high number as long as it is
///< greater or equal to the number of copper layers. Also the
///< last copper layer (bottom) must have this set as its value.
long TrackGrid; ///< Grid for Routes (equal X and Y steps)
long ViaGrid; ///< Grid for Vias (equal X and Y steps)
CADSTAR_COMMON::POINT DesignOrigin;
std::pair<CADSTAR_COMMON::POINT, CADSTAR_COMMON::POINT> DesignArea;
CADSTAR_COMMON::POINT DesignRef; ///< Appears to be 0,0 always
CADSTAR_COMMON::POINT DesignLimit;
bool BackOffJunctions = false;
bool BackOffWidthChange = false;
void Parse( XNODE* aNode );
};
//.................................
// ASSIGNMENTS -> GRIDS
//.................................
enum class CPA_GRID_TYPE
{
FRACTIONALGRID, ///< Param1 = Unit, 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.
};
struct CPA_GRID
{
CPA_GRID_TYPE Type;
wxString Name;
long Param1; ///< Either Unit or X step, depending on Type (see CPA_GRID_TYPE for
///< more details)
long Param2; ///< Either Divisor or Y step, depending on Type (see CPA_GRID_TYPE for
///< more details)
static bool IsGrid( XNODE* aNode );
void Parse( XNODE* aNode );
};
struct CPA_GRIDS
{
CPA_GRID WorkingGrid;
CPA_GRID ScreenGrid; ///< From CADSTAR Help: "There is one Screen Grid, which is
///< visible as dots on the screen. You cannot specify your
///< own name for the Screen Grid. The visibility and colour
///< of the dots representing the Screen Grid is set up by
///< the Highlight category on the Colours dialog.
///<
///< The type of Screen grid displayed(Lined or Points) is
///< set up on the Display dialog within Options(File menu)."
std::vector<CPA_GRID> UserGrids; ///< List of predefined grids created by the user
void Parse( XNODE* aNode );
}; };
@ -525,7 +620,12 @@ struct CPA_ASSIGNMENTS
{ {
CPA_LAYERDEFS Layerdefs; CPA_LAYERDEFS Layerdefs;
CPA_CODEDEFS Codedefs; CPA_CODEDEFS Codedefs;
//TODO Add technology, grids, etc. CPA_TECHNOLOGY Technology;
CPA_GRIDS Grids;
bool NetclassEditAttributeSettings = false; //< Unclear what this does
bool SpacingclassEditAttributeSettings = false; //< Unclear what this does
void Parse( XNODE* aNode );
}; };
@ -556,7 +656,7 @@ public:
CPA_ASSIGNMENTS Assignments; CPA_ASSIGNMENTS Assignments;
//TODO Add Library, Defaults, Parts, etc.. //TODO Add Library, Defaults, Parts, etc..
int KiCadUnitMultiplier; //<Use this value to convert units in this CPA file to KiCad units int KiCadUnitMultiplier; ///<Use this value to convert units in this CPA file to KiCad units
}; };