KiCad PCB EDA Suite
cadstar_archive_parser.h File Reference

Helper functions and common defines between schematic and PCB Archive files. More...

#include <dsnlexer.h>
#include <vector>
#include <wx/log.h>
#include <wx/xml/xml.h>
#include <xnode.h>

Go to the source code of this file.

Classes

class  CADSTAR_ARCHIVE_PARSER
 Helper functions and common structures for CADSTAR PCB and Schematic archive files. More...
 
struct  CADSTAR_ARCHIVE_PARSER::PARSER_CONTEXT
 
struct  CADSTAR_ARCHIVE_PARSER::PARSER
 
struct  CADSTAR_ARCHIVE_PARSER::FORMAT
 
struct  CADSTAR_ARCHIVE_PARSER::TIMESTAMP
 
struct  CADSTAR_ARCHIVE_PARSER::HEADER
 
struct  CADSTAR_ARCHIVE_PARSER::VARIANT
 < Nodename = "VARIANT" or "VMASTER" (master variant More...
 
struct  CADSTAR_ARCHIVE_PARSER::VARIANT_HIERARCHY
 
struct  CADSTAR_ARCHIVE_PARSER::LINECODE
 
struct  CADSTAR_ARCHIVE_PARSER::HATCH
 
struct  CADSTAR_ARCHIVE_PARSER::HATCHCODE
 
struct  CADSTAR_ARCHIVE_PARSER::FONT
 
struct  CADSTAR_ARCHIVE_PARSER::TEXTCODE
 
struct  CADSTAR_ARCHIVE_PARSER::ROUTEREASSIGN
 
struct  CADSTAR_ARCHIVE_PARSER::ROUTECODE
 
struct  CADSTAR_ARCHIVE_PARSER::EVALUE
 Represents a floating value in E notation. More...
 
struct  CADSTAR_ARCHIVE_PARSER::POINT
 Represents a point in x,y coordinates. More...
 
struct  CADSTAR_ARCHIVE_PARSER::LONGPOINT
 
struct  CADSTAR_ARCHIVE_PARSER::VERTEX
 Represents a vertex in a shape. More...
 
struct  CADSTAR_ARCHIVE_PARSER::CUTOUT
 Represents a cutout in a closed shape (e.g. More...
 
struct  CADSTAR_ARCHIVE_PARSER::SHAPE
 
struct  CADSTAR_ARCHIVE_PARSER::GRID
 
struct  CADSTAR_ARCHIVE_PARSER::GRIDS
 
struct  CADSTAR_ARCHIVE_PARSER::SETTINGS
 
struct  CADSTAR_ARCHIVE_PARSER::ATTRIBUTE_LOCATION
 
struct  CADSTAR_ARCHIVE_PARSER::ATTRNAME
 NOTE from CADSTAR help: To convert a Part Definition Attribute into a hyperlink, prefix the attribute name with "Link ". More...
 
struct  CADSTAR_ARCHIVE_PARSER::ATTRNAME::COLUMNORDER
 
struct  CADSTAR_ARCHIVE_PARSER::ATTRNAME::COLUMNWIDTH
 
struct  CADSTAR_ARCHIVE_PARSER::ATTRIBUTE_VALUE
 
struct  CADSTAR_ARCHIVE_PARSER::TEXT_LOCATION
 Corresponds to CADSTAR "origin". More...
 
struct  CADSTAR_ARCHIVE_PARSER::CADSTAR_NETCLASS
 
struct  CADSTAR_ARCHIVE_PARSER::SPCCLASSNAME
 
struct  CADSTAR_ARCHIVE_PARSER::CODEDEFS
 
struct  CADSTAR_ARCHIVE_PARSER::REUSEBLOCK
 
struct  CADSTAR_ARCHIVE_PARSER::REUSEBLOCKREF
 References an element from a design reuse block. More...
 
struct  CADSTAR_ARCHIVE_PARSER::GROUP
 
struct  CADSTAR_ARCHIVE_PARSER::FIGURE
 
struct  CADSTAR_ARCHIVE_PARSER::TEXT
 
struct  CADSTAR_ARCHIVE_PARSER::SYMDEF
 
struct  CADSTAR_ARCHIVE_PARSER::PART
 
struct  CADSTAR_ARCHIVE_PARSER::PART::DEFINITION
 < "PARTDEFINITION" node name More...
 
struct  CADSTAR_ARCHIVE_PARSER::PART::DEFINITION::GATE
 < "GATEDEFINITION" node name More...
 
struct  CADSTAR_ARCHIVE_PARSER::PART::DEFINITION::PIN
 < "PARTDEFINITIONPIN" node name More...
 
struct  CADSTAR_ARCHIVE_PARSER::PART::DEFINITION::PIN_EQUIVALENCE
 < "PINEQUIVALENCE" Node name More...
 
struct  CADSTAR_ARCHIVE_PARSER::PART::DEFINITION::SWAP_GATE
 < "SWAPGATE" Node name (represents an "Element") More...
 
struct  CADSTAR_ARCHIVE_PARSER::PART::DEFINITION::SWAP_GROUP
 
struct  CADSTAR_ARCHIVE_PARSER::PART::PART_PIN
 < "PARTPIN" node name More...
 
struct  CADSTAR_ARCHIVE_PARSER::PARTS
 
struct  CADSTAR_ARCHIVE_PARSER::NET
 
struct  CADSTAR_ARCHIVE_PARSER::NET::JUNCTION
 < "JPT" nodename. More...
 
struct  CADSTAR_ARCHIVE_PARSER::NET::CONNECTION
 < "CONN" nodename More...
 
struct  CADSTAR_ARCHIVE_PARSER::DOCUMENTATION_SYMBOL
 
struct  CADSTAR_ARCHIVE_PARSER::DFLTSETTINGS
 
struct  CADSTAR_ARCHIVE_PARSER::ATTRCOL
 
struct  CADSTAR_ARCHIVE_PARSER::ATTRCOLORS
 
struct  CADSTAR_ARCHIVE_PARSER::PARTNAMECOL
 

Macros

#define THROW_MISSING_NODE_IO_ERROR(nodename, location)   THROW_IO_ERROR( wxString::Format( _( "Missing node '%s' in '%s'" ), nodename, location ) )
 
#define THROW_UNKNOWN_NODE_IO_ERROR(nodename, location)   THROW_IO_ERROR( wxString::Format( _( "Unknown node '%s' in '%s'" ), nodename, location ) )
 
#define THROW_MISSING_PARAMETER_IO_ERROR(param, location)   THROW_IO_ERROR( wxString::Format( _( "Missing Parameter '%s' in '%s'" ), param, location ) )
 
#define THROW_UNKNOWN_PARAMETER_IO_ERROR(param, location)   THROW_IO_ERROR( wxString::Format( _( "Unknown Parameter '%s' in '%s'" ), param, location ) )
 
#define THROW_PARSING_IO_ERROR(param, location)   THROW_IO_ERROR( wxString::Format( _( "Unable to parse '%s' in '%s'" ), param, location ) )
 
#define UNDEFINED_LAYER_ID   ( LAYER_ID ) wxEmptyString
 
#define COMPONENT_NAME_ATTRID   ( ATTRIBUTE_ID ) wxT( "__COMPONENT_NAME__" )
 Component Name Attribute ID - typically used for placement of designators on silk screen. More...
 
#define COMPONENT_NAME_2_ATTRID   ( ATTRIBUTE_ID ) wxT( "__COMPONENT_NAME_2__" )
 Component Name 2 Attribute ID - typically used for indicating the placement of designators in placement drawings. More...
 
#define SYMBOL_NAME_ATTRID   ( ATTRIBUTE_ID ) wxT( "__SYMBOL_NAME__" )
 Symbol Name attribute ID - used for placement of designators on the schematic. More...
 
#define LINK_ORIGIN_ATTRID   ( ATTRIBUTE_ID ) wxT( "__LINK_ORIGIN__" )
 
#define SIGNALNAME_ORIGIN_ATTRID   ( ATTRIBUTE_ID ) wxT( "__SIGNALNAME_ORIGIN__" )
 
#define PART_NAME_ATTRID   ( ATTRIBUTE_ID ) wxT( "__PART_NAME__" )
 

Detailed Description

Helper functions and common defines between schematic and PCB Archive files.

Definition in file cadstar_archive_parser.h.

Macro Definition Documentation

◆ COMPONENT_NAME_2_ATTRID

#define COMPONENT_NAME_2_ATTRID   ( ATTRIBUTE_ID ) wxT( "__COMPONENT_NAME_2__" )

Component Name 2 Attribute ID - typically used for indicating the placement of designators in placement drawings.

Definition at line 67 of file cadstar_archive_parser.h.

◆ COMPONENT_NAME_ATTRID

#define COMPONENT_NAME_ATTRID   ( ATTRIBUTE_ID ) wxT( "__COMPONENT_NAME__" )

Component Name Attribute ID - typically used for placement of designators on silk screen.

Definition at line 61 of file cadstar_archive_parser.h.

◆ LINK_ORIGIN_ATTRID

#define LINK_ORIGIN_ATTRID   ( ATTRIBUTE_ID ) wxT( "__LINK_ORIGIN__" )

Definition at line 73 of file cadstar_archive_parser.h.

◆ PART_NAME_ATTRID

#define PART_NAME_ATTRID   ( ATTRIBUTE_ID ) wxT( "__PART_NAME__" )

Definition at line 75 of file cadstar_archive_parser.h.

◆ SIGNALNAME_ORIGIN_ATTRID

#define SIGNALNAME_ORIGIN_ATTRID   ( ATTRIBUTE_ID ) wxT( "__SIGNALNAME_ORIGIN__" )

Definition at line 74 of file cadstar_archive_parser.h.

◆ SYMBOL_NAME_ATTRID

#define SYMBOL_NAME_ATTRID   ( ATTRIBUTE_ID ) wxT( "__SYMBOL_NAME__" )

Symbol Name attribute ID - used for placement of designators on the schematic.

Definition at line 72 of file cadstar_archive_parser.h.

◆ THROW_MISSING_NODE_IO_ERROR

#define THROW_MISSING_NODE_IO_ERROR (   nodename,
  location 
)    THROW_IO_ERROR( wxString::Format( _( "Missing node '%s' in '%s'" ), nodename, location ) )

Definition at line 37 of file cadstar_archive_parser.h.

◆ THROW_MISSING_PARAMETER_IO_ERROR

#define THROW_MISSING_PARAMETER_IO_ERROR (   param,
  location 
)    THROW_IO_ERROR( wxString::Format( _( "Missing Parameter '%s' in '%s'" ), param, location ) )

Definition at line 43 of file cadstar_archive_parser.h.

◆ THROW_PARSING_IO_ERROR

#define THROW_PARSING_IO_ERROR (   param,
  location 
)    THROW_IO_ERROR( wxString::Format( _( "Unable to parse '%s' in '%s'" ), param, location ) )

Definition at line 49 of file cadstar_archive_parser.h.

◆ THROW_UNKNOWN_NODE_IO_ERROR

#define THROW_UNKNOWN_NODE_IO_ERROR (   nodename,
  location 
)    THROW_IO_ERROR( wxString::Format( _( "Unknown node '%s' in '%s'" ), nodename, location ) )

Definition at line 40 of file cadstar_archive_parser.h.

◆ THROW_UNKNOWN_PARAMETER_IO_ERROR

#define THROW_UNKNOWN_PARAMETER_IO_ERROR (   param,
  location 
)    THROW_IO_ERROR( wxString::Format( _( "Unknown Parameter '%s' in '%s'" ), param, location ) )

Definition at line 46 of file cadstar_archive_parser.h.

◆ UNDEFINED_LAYER_ID

#define UNDEFINED_LAYER_ID   ( LAYER_ID ) wxEmptyString

Definition at line 55 of file cadstar_archive_parser.h.