29#include <wx/mstream.h>
72using namespace PCB_KEYS_T;
76 m_filename( aFileName ),
77 m_footprint( aFootprint )
97 THROW_IO_ERROR( wxString::Format(
_(
"Cannot create footprint library '%s'." ),
103 THROW_IO_ERROR( wxString::Format(
_(
"Footprint library '%s' is read only." ),
109 if( aFootprint && aFootprint != it->second->GetFootprint() )
122 wxString tempFileName =
124 wxFileName::CreateTempFileName( fn.
GetPath() );
145 wxMilliSleep( 250L );
150 if( !wxRenameFile( tempFileName, fn.
GetFullPath() ) )
152 wxString msg = wxString::Format(
_(
"Cannot rename temporary file '%s' to '%s'" ),
176 if( !dir.IsOpened() )
178 wxString msg = wxString::Format(
_(
"Footprint library '%s' not found." ),
190 if( dir.GetFirst( &fullName, fileSpec ) )
205 wxString fpName = fn.
GetName();
215 if( !cacheError.IsEmpty() )
216 cacheError += wxT(
"\n\n" );
218 cacheError += wxString::Format(
_(
"Unable to read file '%s'" ) +
'\n',
220 cacheError += ioe.
What();
222 }
while( dir.GetNext( &fullName ) );
226 if( !cacheError.IsEmpty() )
234 FP_CACHE_FOOTPRINT_MAP::const_iterator it =
m_footprints.find( aFootprintName );
238 wxString msg = wxString::Format(
_(
"Library '%s' has no footprint '%s'." ),
245 wxString fullPath = it->second->GetFileName().GetFullPath();
247 wxRemoveFile( fullPath );
265 footprint.second->SetFilePath( aPath );
307 const std::map<std::string, UTF8>* aProperties )
316 _(
"Internal Group Data Error" ), wxICON_ERROR,
317 wxString::Format(
_(
"Please report this bug. Error validating group "
318 "structure: %s\n\nSave anyway?" ), sanityResult ),
319 _(
"Save Anyway" ) ) )
343 m_out->
Print(
"(kicad_pcb (version %d) (generator \"pcbnew\") (generator_version %s)",
358 std::string input =
TO_UTF8( aClipboardSourceInput );
365 return parser.
Parse();
381 switch( aItem->
Type() )
412 format(
static_cast<const PAD*
>( aItem ) );
450 wxFAIL_MSG( wxT(
"Cannot format item " ) + aItem->
GetClass() );
484 aIsKnockout ?
"knockout" :
"" );
493 for(
int ii = 0; ii < outline.
PointCount(); ++ii )
505 m_out->
Print(
"(arc (start %s) (mid %s) (end %s))",
545 callback_gal.DrawGlyphs( *cache );
581 m_out->
Print(
"(pad_to_paste_clearance_ratio %s)",
695 for(
const std::pair<const wxString, wxString>& prop : aBoard->
GetProperties() )
740 m_out->
Print(
"(teardrops (best_length_ratio %s) (max_length %s) (best_width_ratio %s) "
761 std::set<BOARD_ITEM*, BOARD_ITEM::ptr_cmp> sorted_footprints( aBoard->
Footprints().begin(),
763 std::set<BOARD_ITEM*, BOARD_ITEM::ptr_cmp> sorted_drawings( aBoard->
Drawings().begin(),
765 std::set<PCB_TRACK*, PCB_TRACK::cmp_tracks> sorted_tracks( aBoard->
Tracks().begin(),
767 std::set<BOARD_ITEM*, BOARD_ITEM::ptr_cmp> sorted_zones( aBoard->
Zones().begin(),
768 aBoard->
Zones().end() );
769 std::set<BOARD_ITEM*, BOARD_ITEM::ptr_cmp> sorted_groups( aBoard->
Groups().begin(),
771 std::set<BOARD_ITEM*, BOARD_ITEM::ptr_cmp> sorted_generators( aBoard->
Generators().begin(),
776 for(
BOARD_ITEM* footprint : sorted_footprints )
790 for(
auto zone : sorted_zones )
807 files_to_write.
AddFile( file.second );
814 files_to_write.
AddFile( file.second );
820 if( !files_to_write.
IsEmpty() )
850 wxFAIL_MSG( wxT(
"Cannot format unknown dimension type!" ) );
875 m_out->
Print(
"(orientation %d)",
static_cast<int>(
ortho->GetOrientation() ) );
879 m_out->
Print(
"(format (prefix %s) (suffix %s) (units %d) (units_format %d) (precision %d)",
898 m_out->
Print(
"(style (thickness %s) (arrow_length %s) (text_position_mode %d)",
903 if(
ortho || aligned )
907 case DIM_ARROW_DIRECTION::OUTWARD:
910 case DIM_ARROW_DIRECTION::INWARD:
946 std::string prefix = parentFP ?
"fp" :
"gr";
950 case SHAPE_T::SEGMENT:
957 case SHAPE_T::RECTANGLE:
964 case SHAPE_T::CIRCLE:
965 m_out->
Print(
"(%s_circle (center %s) (end %s)",
972 m_out->
Print(
"(%s_arc (start %s) (mid %s) (end %s)",
990 wxFAIL_MSG( wxT(
"Cannot format invalid polygon." ) );
996 case SHAPE_T::BEZIER:
997 m_out->
Print(
"(%s_curve (pts (xy %s) (xy %s) (xy %s) (xy %s))",
1013 if( ( aShape->
GetShape() == SHAPE_T::POLY )
1014 || ( aShape->
GetShape() == SHAPE_T::RECTANGLE )
1015 || ( aShape->
GetShape() == SHAPE_T::CIRCLE ) )
1046 wxCHECK_RET( aBitmap !=
nullptr &&
m_out !=
nullptr,
"" );
1052 wxCHECK_RET(
image !=
nullptr,
"wxImage* is NULL" );
1066 wxMemoryOutputStream ostream;
1078 m_out->
Print(
"(target %s (at %s) (size %s)",
1079 ( aTarget->
GetShape() ) ?
"x" :
"plus",
1098 if( initial_comments )
1100 for(
unsigned i = 0; i < initial_comments->GetCount(); ++i )
1118 m_out->
Print(
"(version %d) (generator \"pcbnew\") (generator_version %s)",
1152 m_out->
Quotew( field->GetCanonicalName() ).c_str(),
1162 if( !compClass->IsEmpty() )
1202 m_out->
Print(
"(solder_paste_margin_ratio %s)",
1256 wxString canonicalName(
LSET::Name( layer ) );
1276 std::set<PAD*, FOOTPRINT::cmp_pads> sorted_pads( aFootprint->
Pads().begin(),
1277 aFootprint->
Pads().end() );
1278 std::set<BOARD_ITEM*, FOOTPRINT::cmp_drawings> sorted_drawings(
1281 std::set<ZONE*, FOOTPRINT::cmp_zones> sorted_zones( aFootprint->
Zones().begin(),
1282 aFootprint->
Zones().end() );
1283 std::set<BOARD_ITEM*, PCB_GROUP::ptr_cmp> sorted_groups( aFootprint->
Groups().begin(),
1284 aFootprint->
Groups().end() );
1292 for(
PAD*
pad : sorted_pads )
1310 auto bs3D = aFootprint->
Models().begin();
1311 auto es3D = aFootprint->
Models().end();
1313 while( bs3D != es3D )
1315 if( !bs3D->m_Filename.IsEmpty() )
1322 if( bs3D->m_Opacity != 1.0 )
1323 m_out->
Print(
"(opacity %0.4f)", bs3D->m_Opacity );
1367 if( !aEnumerateLayers )
1370 if( ( aLayerMask & cu_board_mask ) == cu_board_mask )
1377 aLayerMask &= ~cu_all;
1379 else if( ( aLayerMask & cu_board_mask ) == fr_bk )
1382 aLayerMask &= ~fr_bk;
1385 if( ( aLayerMask & adhes ) == adhes )
1388 aLayerMask &= ~adhes;
1394 aLayerMask &= ~paste;
1397 if( ( aLayerMask & silks ) == silks )
1400 aLayerMask &= ~silks;
1403 if( ( aLayerMask & mask ) == mask )
1406 aLayerMask &= ~mask;
1409 if( ( aLayerMask & crt_yd ) == crt_yd )
1412 aLayerMask &= ~crt_yd;
1415 if( ( aLayerMask & fab ) == fab )
1427 if( aLayerMask[layer] )
1431 m_out->
Print(
"(layers %s)", output.c_str() );
1444 case PAD_SHAPE::CIRCLE:
return "circle";
1445 case PAD_SHAPE::RECTANGLE:
return "rect";
1446 case PAD_SHAPE::OVAL:
return "oval";
1447 case PAD_SHAPE::TRAPEZOID:
return "trapezoid";
1448 case PAD_SHAPE::CHAMFERED_RECT:
1449 case PAD_SHAPE::ROUNDRECT:
return "roundrect";
1450 case PAD_SHAPE::CUSTOM:
return "custom";
1462 case PAD_ATTRIB::PTH: type =
"thru_hole";
break;
1463 case PAD_ATTRIB::SMD: type =
"smd";
break;
1464 case PAD_ATTRIB::CONN: type =
"connect";
break;
1465 case PAD_ATTRIB::NPTH: type =
"np_thru_hole";
break;
1468 THROW_IO_ERROR( wxString::Format( wxT(
"unknown pad attribute: %d" ),
1472 const char*
property =
nullptr;
1476 case PAD_PROP::NONE:
break;
1477 case PAD_PROP::BGA:
property =
"pad_prop_bga";
break;
1478 case PAD_PROP::FIDUCIAL_GLBL:
property =
"pad_prop_fiducial_glob";
break;
1479 case PAD_PROP::FIDUCIAL_LOCAL:
property =
"pad_prop_fiducial_loc";
break;
1480 case PAD_PROP::TESTPOINT:
property =
"pad_prop_testpoint";
break;
1481 case PAD_PROP::HEATSINK:
property =
"pad_prop_heatsink";
break;
1482 case PAD_PROP::CASTELLATED:
property =
"pad_prop_castellated";
break;
1483 case PAD_PROP::MECHANICAL:
property =
"pad_prop_mechanical";
break;
1486 THROW_IO_ERROR( wxString::Format( wxT(
"unknown pad property: %d" ),
1513 if( (sz.
x > 0) || (sz.
y > 0) ||
1514 (shapeoffset.
x != 0) || (shapeoffset.
y != 0) )
1524 if( sz.
y > 0 && sz.
x != sz.
y )
1531 if( shapeoffset.
x != 0 || shapeoffset.
y != 0 )
1569 auto formatCornerProperties =
1573 if( aPad->
GetShape( aLayer ) == PAD_SHAPE::ROUNDRECT
1574 || aPad->
GetShape( aLayer ) == PAD_SHAPE::CHAMFERED_RECT)
1581 if( aPad->
GetShape( aLayer ) == PAD_SHAPE::CHAMFERED_RECT)
1647 m_out->
Print(
"(solder_paste_margin_ratio %s)",
1675 defaultThermalSpokeAngle =
ANGLE_45;
1695 case PAD_SHAPE::RECTANGLE:
return "rect";
1697 case PAD_SHAPE::CIRCLE:
return "circle";
1701 auto formatPrimitives =
1707 for(
const std::shared_ptr<PCB_SHAPE>& primitive : aPad->
GetPrimitives( aLayer ) )
1709 switch( primitive->GetShape() )
1711 case SHAPE_T::SEGMENT:
1712 if( primitive->IsProxyItem() )
1714 m_out->
Print(
"(gr_vector (start %s) (end %s)",
1720 m_out->
Print(
"(gr_line (start %s) (end %s)",
1726 case SHAPE_T::RECTANGLE:
1727 if( primitive->IsProxyItem() )
1729 m_out->
Print(
"(gr_bbox (start %s) (end %s)",
1735 m_out->
Print(
"(gr_rect (start %s) (end %s)",
1742 m_out->
Print(
"(gr_arc (start %s) (mid %s) (end %s)",
1748 case SHAPE_T::CIRCLE:
1749 m_out->
Print(
"(gr_circle (center %s) (end %s)",
1754 case SHAPE_T::BEZIER:
1755 m_out->
Print(
"(gr_curve (pts (xy %s) (xy %s) (xy %s) (xy %s))",
1763 if( primitive->IsPolyShapeValid() )
1777 if( !primitive->IsProxyItem() )
1782 if( ( primitive->GetShape() == SHAPE_T::POLY )
1783 || ( primitive->GetShape() == SHAPE_T::RECTANGLE )
1784 || ( primitive->GetShape() == SHAPE_T::CIRCLE ) )
1821 auto formatPadLayer =
1826 m_out->
Print(
"(shape %s)", shapeName( aLayer ) );
1834 shapeoffset = aPad->
GetOffset( aLayer );
1836 if( shapeoffset.
x != 0 || shapeoffset.
y != 0 )
1839 formatCornerProperties( aLayer );
1841 if( aPad->
GetShape( aLayer ) == PAD_SHAPE::CUSTOM )
1846 m_out->
Print(
"(anchor %s)", anchorShape( aLayer ) );
1851 formatPrimitives( aLayer );
1856 if( aPad->
GetShape( aLayer ) == PAD_SHAPE::CIRCLE ||
1857 ( aPad->
GetShape( aLayer ) == PAD_SHAPE::CUSTOM
1865 if( layerSpokeAngle != defaultLayerAngle )
1871 if( padstack.
ThermalGap( aLayer ).has_value() )
1883 if( padstack.
Clearance( aLayer ).has_value() )
1901 m_out->
Print(
"(padstack (mode front_inner_back)" );
1907 formatPadLayer(
B_Cu );
1922 formatPadLayer( layer );
1939 if( front.has_value() || back.has_value() )
1941 if( front.value_or(
false ) || back.value_or(
false ) )
1944 front.value_or(
false ) ?
"front" :
"",
1945 back.value_or(
false ) ?
"back" :
"" );
1961 bool isField =
dynamic_cast<const PCB_FIELD*
>( aText ) !=
nullptr;
2011 aText->EDA_TEXT::Format(
m_out, ctl_flags );
2027 : parentFP ?
"fp_text_box"
2034 if( aTextBox->
GetShape() == SHAPE_T::RECTANGLE )
2040 else if( aTextBox->
GetShape() == SHAPE_T::POLY )
2059 m_out->
Print(
"(span %d %d)", cell->GetColSpan(), cell->GetRowSpan() );
2094 wxCHECK_RET( aTable !=
nullptr &&
m_out !=
nullptr,
"" );
2123 for(
int col = 0; col < aTable->
GetColCount(); ++col )
2130 for(
int row = 0; row < aTable->
GetRowCount(); ++row )
2158 wxArrayString memberIds;
2161 memberIds.Add( member->m_Uuid.AsString() );
2167 for(
const wxString& memberId : memberIds )
2179 && aGenerator->
GetItems().empty() )
2188 m_out->
Print(
"(type %s) (name %s) (layer %s)",
2196 for(
const auto& [key, value] : aGenerator->
GetProperties() )
2198 if( value.CheckType<
double>() || value.CheckType<
int>() || value.CheckType<
long>()
2199 || value.CheckType<
long long>() )
2203 if( !value.GetAs( &val ) )
2206 std::string buf = fmt::format(
"{:.10g}", val );
2209 m_out->
Print(
"(%s %s)", key.c_str(), buf.c_str() );
2211 else if( value.CheckType<
bool>() )
2214 value.GetAs( &val );
2218 else if( value.CheckType<
VECTOR2I>() )
2221 value.GetAs( &val );
2230 value.GetAs( &val );
2240 if( value.CheckType<wxString>() )
2242 value.GetAs( &val );
2244 else if( value.CheckType<std::string>() )
2247 value.GetAs( &str );
2249 val = wxString::FromUTF8( str );
2256 wxArrayString memberIds;
2259 memberIds.Add( member->m_Uuid.AsString() );
2265 for(
const wxString& memberId : memberIds )
2280 const BOARD* board =
via->GetBoard();
2282 wxCHECK_RET( board !=
nullptr, wxT(
"Via has no parent." ) );
2286 via->LayerPair( &layer1, &layer2 );
2288 switch(
via->GetViaType() )
2290 case VIATYPE::THROUGH:
2293 case VIATYPE::BLIND_BURIED:
2297 case VIATYPE::MICROVIA:
2323 switch(
via->Padstack().UnconnectedLayerMode() )
2339 if(
via->IsLocked() )
2342 if(
via->GetIsFree() )
2345 if(
via->GetRemoveUnconnected() )
2407 m_out->
Print(
"(arc (start %s) (mid %s) (end %s) (width %s)",
2415 m_out->
Print(
"(segment (start %s) (end %s) (width %s)",
2454 m_out->
Print(
"(zone (net %d) (net_name %s)",
2468 if( layers.count() > 1 )
2484 case ZONE_BORDER_DISPLAY_STYLE::NO_HATCH: hatch =
"none";
break;
2485 case ZONE_BORDER_DISPLAY_STYLE::DIAGONAL_EDGE: hatch =
"edge";
break;
2486 case ZONE_BORDER_DISPLAY_STYLE::DIAGONAL_FULL: hatch =
"full";
break;
2489 m_out->
Print(
"(hatch %s %s)", hatch.c_str(),
2511 case ZONE_CONNECTION::THERMAL:
2514 case ZONE_CONNECTION::THT_THERMAL:
2518 case ZONE_CONNECTION::FULL:
2522 case ZONE_CONNECTION::NONE:
2536 m_out->
Print(
"(filled_areas_thickness no)" );
2541 m_out->
Print(
"(keepout (tracks %s) (vias %s) (pads %s) (copperpour %s) (footprints %s))",
2554 case RULE_AREA_PLACEMENT_SOURCE_TYPE::SHEETNAME:
2558 case RULE_AREA_PLACEMENT_SOURCE_TYPE::COMPONENT_CLASS:
2574 if( aZone->
GetFillMode() == ZONE_FILL_MODE::HATCH_PATTERN )
2577 m_out->
Print(
"(thermal_gap %s) (thermal_bridge_width %s)",
2594 THROW_IO_ERROR( wxString::Format(
_(
"unknown zone corner smoothing type %d" ),
2604 m_out->
Print(
"(island_removal_mode %d) (island_area_min %s)",
2609 if( aZone->
GetFillMode() == ZONE_FILL_MODE::HATCH_PATTERN )
2611 m_out->
Print(
"(hatch_thickness %s) (hatch_gap %s) (hatch_orientation %s)",
2618 m_out->
Print(
"(hatch_smoothing_level %d) (hatch_smoothing_value %s)",
2623 m_out->
Print(
"(hatch_border_algorithm %s) (hatch_min_hole_area %s)",
2647 for(
int ii = 0; ii < fv->OutlineCount(); ++ii )
2668 m_ctl( aControlFlags ),
2684 const std::map<std::string, UTF8>* aProperties,
PROJECT* aProject )
2688 unsigned lineCount = 0;
2718 init( aProperties );
2725 board =
dynamic_cast<BOARD*
>( parser.
Parse() );
2744 parser.CurLine(), parser.CurLineNumber(), parser.CurOffset() );
2774 bool aBestEfforts,
const std::map<std::string, UTF8>* aProperties )
2777 wxDir dir( aLibPath );
2780 init( aProperties );
2788 errorMsg = ioe.
What();
2795 aFootprintNames.Add( footprint.first );
2797 if( !errorMsg.IsEmpty() && !aBestEfforts )
2803 const wxString& aFootprintName,
2804 const std::map<std::string, UTF8>* aProperties,
2805 bool checkModified )
2809 init( aProperties );
2821 FP_CACHE_FOOTPRINT_MAP::const_iterator it = footprints.find( aFootprintName );
2823 if( it == footprints.end() )
2826 return it->second->GetFootprint();
2831 const wxString& aFootprintName,
2832 const std::map<std::string, UTF8>* aProperties )
2834 return getFootprint( aLibraryPath, aFootprintName, aProperties,
false );
2839 const std::map<std::string, UTF8>* aProperties )
2850 return footprintFile.Exists();
2855 const std::map<std::string, UTF8>* aProperties )
2858 wxFFile f( aFootprintPath );
2865 f.ReadAll( &fcontents );
2867 aFootprintNameOut = wxFileName( aFootprintPath ).GetName();
2874 const wxString& aFootprintName,
2876 const std::map<std::string, UTF8>* aProperties )
2891 copy->SetParent(
nullptr );
2900 const std::map<std::string, UTF8>* aProperties )
2904 init( aProperties );
2910 validateCache( aLibraryPath, !aProperties || !aProperties->contains(
"skip_cache_validation" ) );
2916 const wxString msg = wxString::Format(
_(
"Library '%s' does not exist.\n"
2917 "Would you like to create it?"),
2921 || wxMessageBox( msg,
_(
"Library Not Found" ), wxYES_NO | wxICON_QUESTION )
2930 wxString msg = wxString::Format(
_(
"Library '%s' is read only." ), aLibraryPath );
2949 THROW_IO_ERROR( wxString::Format(
_(
"Footprint file name '%s' is not valid." ),
2950 fn.GetFullPath() ) );
2953 if( fn.FileExists() && !fn.IsFileWritable() )
2955 THROW_IO_ERROR( wxString::Format(
_(
"Insufficient permissions to delete '%s'." ),
2956 fn.GetFullPath() ) );
2959 wxString fullPath = fn.GetFullPath();
2960 wxString fullName = fn.GetFullName();
2961 FP_CACHE_FOOTPRINT_MAP::const_iterator it = footprints.find( footprintName );
2963 if( it != footprints.end() )
2966 footprints.erase( footprintName );
2967 wxRemoveFile( fullPath );
2983 footprint->
Flip( footprint->
GetPosition(), FLIP_DIRECTION::TOP_BOTTOM );
2990 wxLogTrace(
traceKicadPcbPlugin, wxT(
"Creating s-expr footprint file '%s'." ), fullPath );
2991 footprints.insert( footprintName,
2998 const std::map<std::string, UTF8>* aProperties )
3002 init( aProperties );
3009 aLibraryPath.GetData() ) );
3025 if( wxDir::Exists( aLibraryPath ) )
3027 THROW_IO_ERROR( wxString::Format(
_(
"Cannot overwrite library path '%s'." ),
3028 aLibraryPath.GetData() ) );
3033 init( aProperties );
3044 fn.SetPath( aLibraryPath );
3047 if( !fn.DirExists() )
3050 if( !fn.IsDirWritable() )
3052 THROW_IO_ERROR( wxString::Format(
_(
"Insufficient permissions to delete folder '%s'." ),
3053 aLibraryPath.GetData() ) );
3056 wxDir dir( aLibraryPath );
3058 if( dir.HasSubDirs() )
3060 THROW_IO_ERROR( wxString::Format(
_(
"Library folder '%s' has unexpected sub-folders." ),
3061 aLibraryPath.GetData() ) );
3065 if( dir.HasFiles() )
3069 wxArrayString files;
3071 wxDir::GetAllFiles( aLibraryPath, &files );
3073 for( i = 0; i < files.GetCount(); i++ )
3079 THROW_IO_ERROR( wxString::Format(
_(
"Unexpected file '%s' found in library "
3082 aLibraryPath.GetData() ) );
3086 for( i = 0; i < files.GetCount(); i++ )
3087 wxRemoveFile( files[i] );
3091 aLibraryPath.GetData() );
3095 if( !wxRmdir( aLibraryPath ) )
3097 THROW_IO_ERROR( wxString::Format(
_(
"Footprint library '%s' cannot be deleted." ),
3098 aLibraryPath.GetData() ) );
3105 wxMilliSleep( 250L );
constexpr EDA_IU_SCALE pcbIUScale
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
wxString GetMajorMinorVersion()
Get only the major and minor version in a string major.minor.
bool SaveImageData(wxOutputStream &aOutStream) const
Write the bitmap data to aOutStream.
wxString GetNetname() const
TEARDROP_PARAMETERS & GetTeardropParams()
Container for design settings for a BOARD object.
int GetBoardThickness() const
The full thickness of the board including copper and masks.
const VECTOR2I & GetGridOrigin()
const VECTOR2I & GetAuxOrigin()
bool m_AllowSoldermaskBridgesInFPs
int m_SolderMaskExpansion
BOARD_STACKUP & GetStackupDescriptor()
double m_SolderPasteMarginRatio
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
virtual PCB_LAYER_ID GetLayer() const
Return the primary layer this item is on.
void SetParentGroup(PCB_GROUP *aGroup)
virtual bool IsKnockout() const
virtual const BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
FOOTPRINT * GetParentFootprint() const
VECTOR2I GetFPRelativePosition() const
virtual bool IsLocked() const
Manage layers needed to make a physical board.
void FormatBoardStackup(OUTPUTFORMATTER *aFormatter, const BOARD *aBoard) const
Write the stackup info on board file.
Information pertinent to a Pcbnew printed circuit board.
LSET GetEnabledLayers() const
A proxy function that calls the corresponding function in m_BoardSettings.
EMBEDDED_FILES * GetEmbeddedFiles() override
const GENERATORS & Generators() const
void SetFileName(const wxString &aFileName)
const PAGE_INFO & GetPageSettings() const
const ZONES & Zones() const
const GROUPS & Groups() const
The groups must maintain the following invariants.
LAYER_T GetLayerType(PCB_LAYER_ID aLayer) const
Return the type of the copper layer given by aLayer.
TITLE_BLOCK & GetTitleBlock()
int GetCopperLayerCount() const
const std::map< wxString, wxString > & GetProperties() const
const FOOTPRINTS & Footprints() const
const TRACKS & Tracks() const
const PCB_PLOT_PARAMS & GetPlotOptions() const
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Return the name of a aLayer.
bool LegacyTeardrops() const
wxString GroupsSanityCheck(bool repair=false)
Consistency check of internal m_groups structure.
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
void EmbedFonts() override
Finds all fonts used in the board and embeds them in the file if permissions allow.
const DRAWINGS & Drawings() const
const std::vector< COMPONENT_CLASS * > & GetConstituentClasses() const
Fetches a vector of the constituent classes for this (effective) class.
KICAD_T Type() const
Returns the type of object.
virtual void SetParent(EDA_ITEM *aParent)
virtual wxString GetClass() const =0
Return the class name.
const VECTOR2I & GetBezierC2() const
SHAPE_POLY_SET & GetPolyShape()
const VECTOR2I & GetEnd() const
Return the ending point of the graphic.
const VECTOR2I & GetStart() const
Return the starting point of the graphic.
wxString SHAPE_T_asString() const
const VECTOR2I & GetBezierC1() const
bool IsPolyShapeValid() const
VECTOR2I GetArcMid() const
A mix-in class (via multiple inheritance) that handles texts such as labels, parts,...
const VECTOR2I & GetTextPos() const
const EDA_ANGLE & GetTextAngle() const
virtual const wxString & GetText() const
Return the string associated with the text object.
bool IsKeepUpright() const
virtual bool IsVisible() const
KIFONT::FONT * GetFont() const
std::vector< std::unique_ptr< KIFONT::GLYPH > > * GetRenderCache(const KIFONT::FONT *aFont, const wxString &forResolvedText, const VECTOR2I &aOffset={ 0, 0 }) const
virtual EDA_ANGLE GetDrawRotation() const
virtual wxString GetShownText(bool aAllowExtraText, int aDepth=0) const
Return the string actually shown after processing of the base text.
int GetTextThickness() const
void WriteEmbeddedFiles(OUTPUTFORMATTER &aOut, bool aWriteData) const
Output formatter for the embedded files.
void ClearEmbeddedFiles(bool aDeleteFiles=true)
void ClearEmbeddedFonts()
Remove all embedded fonts from the collection.
EMBEDDED_FILE * AddFile(const wxFileName &aName, bool aOverwrite)
Load a file from disk and adds it to the collection.
const std::map< wxString, EMBEDDED_FILE * > & EmbeddedFileMap() const
bool GetAreFontsEmbedded() const
A LINE_READER that reads from an open file.
void Rewind()
Rewind the file and resets the line number back to zero.
char * ReadLine() override
Read a line of text into the buffer and increments the line number counter.
Helper class for creating a footprint library cache.
FP_CACHE_ITEM(FOOTPRINT *aFootprint, const WX_FILENAME &aFileName)
static long long GetTimestamp(const wxString &aLibPath)
Generate a timestamp representing all source files in the cache (including the parent directory).
FP_CACHE_FOOTPRINT_MAP & GetFootprints()
void Save(FOOTPRINT *aFootprint=nullptr)
Save the footprint cache or a single footprint from it to disk.
PCB_IO_KICAD_SEXPR * m_owner
bool IsModified()
Return true if the cache is not up-to-date.
long long m_cache_timestamp
void SetPath(const wxString &aPath)
bool IsPath(const wxString &aPath) const
Check if aPath is the same as the current cache path.
FP_CACHE_FOOTPRINT_MAP m_footprints
FP_CACHE(PCB_IO_KICAD_SEXPR *aOwner, const wxString &aLibraryPath)
void Remove(const wxString &aFootprintName)
PROGRESS_REPORTER * m_progressReporter
Progress reporter to track the progress of the operation, may be nullptr.
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
virtual const wxString What() const
A composite of Problem() and Where()
APP_SETTINGS_BASE * KifaceSettings() const
virtual bool IsOutline() const
virtual void SetLineWidth(float aLineWidth)
Set the line width.
wxString AsString() const
A logical library item identifier and consists of various portions much like a URI.
const UTF8 & GetLibItemName() const
An abstract class from which implementation specific LINE_READERs may be derived to read single lines...
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
LSEQ is a sequence (and therefore also a set) of PCB_LAYER_IDs.
LSET is a set of PCB_LAYER_IDs.
LSEQ CuStack() const
Return a sequence of copper layers in starting from the front/top and extending to the back/bottom.
LSEQ TechAndUserUIOrder() const
Return the technical and user layers in the order shown in layer widget.
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Return a mask holding the requested number of Cu PCB_LAYER_IDs.
LSEQ Seq(const LSEQ &aSequence) const
Return an LSEQ from the union of this LSET and a desired sequence.
static wxString Name(PCB_LAYER_ID aLayerId)
Return the fixed name association with aLayerId.
Handle the data for a net.
static const int UNCONNECTED
Constant that holds the "unconnected net" number (typically 0) all items "connected" to this net are ...
void SetBoard(const BOARD *aBoard)
Set a BOARD object that is used to prepare the net code map.
int Translate(int aNetCode) const
Translate net number according to the map prepared by Update() function.
A PADSTACK defines the characteristics of a single or multi-layer pad, in the IPC sense of the word.
std::optional< int > & Clearance(PCB_LAYER_ID aLayer=F_Cu)
MASK_LAYER_PROPS & FrontOuterLayers()
std::optional< int > & ThermalSpokeWidth(PCB_LAYER_ID aLayer=F_Cu)
EDA_ANGLE ThermalSpokeAngle(PCB_LAYER_ID aLayer=F_Cu) const
std::optional< int > & ThermalGap(PCB_LAYER_ID aLayer=F_Cu)
const VECTOR2I & Size(PCB_LAYER_ID aLayer) const
@ NORMAL
Shape is the same on all layers.
@ FRONT_INNER_BACK
Up to three shapes can be defined (F_Cu, inner copper layers, B_Cu)
@ REMOVE_EXCEPT_START_AND_END
MASK_LAYER_PROPS & BackOuterLayers()
static constexpr PCB_LAYER_ID ALL_LAYERS
! Temporary layer identifier to identify code that is not padstack-aware
static constexpr PCB_LAYER_ID INNER_LAYERS
! The layer identifier to use for "inner layers" on top/inner/bottom padstacks
std::optional< ZONE_CONNECTION > & ZoneConnection(PCB_LAYER_ID aLayer=F_Cu)
PAD_PROP GetProperty() const
bool GetRemoveUnconnected() const
LSET GetLayerSet() const override
Return a std::bitset of all layers on which the item physically resides.
const std::vector< std::shared_ptr< PCB_SHAPE > > & GetPrimitives(PCB_LAYER_ID aLayer) const
Accessor to the basic shape list for custom-shaped pads.
const ZONE_LAYER_OVERRIDE & GetZoneLayerOverride(PCB_LAYER_ID aLayer) const
std::optional< double > GetLocalSolderPasteMarginRatio() const
const wxString & GetPinType() const
const VECTOR2I & GetDrillSize() const
PAD_ATTRIB GetAttribute() const
const wxString & GetPinFunction() const
const wxString & GetNumber() const
const VECTOR2I & GetDelta(PCB_LAYER_ID aLayer) const
EDA_ANGLE GetThermalSpokeAngle() const
double GetRoundRectRadiusRatio(PCB_LAYER_ID aLayer) const
PAD_SHAPE GetShape(PCB_LAYER_ID aLayer) const
bool GetKeepTopBottom() const
std::optional< int > GetLocalClearance() const override
Return any local clearances set in the "classic" (ie: pre-rule) system.
const PADSTACK & Padstack() const
const VECTOR2I & GetOffset(PCB_LAYER_ID aLayer) const
EDA_ANGLE GetOrientation() const
Return the rotation angle of the pad.
PADSTACK::CUSTOM_SHAPE_ZONE_MODE GetCustomShapeInZoneOpt() const
PAD_DRILL_SHAPE GetDrillShape() const
int GetChamferPositions(PCB_LAYER_ID aLayer) const
std::optional< int > GetLocalSolderPasteMargin() const
std::optional< int > GetLocalSolderMaskMargin() const
double GetChamferRectRatio(PCB_LAYER_ID aLayer) const
std::optional< int > GetLocalThermalSpokeWidthOverride() const
ZONE_CONNECTION GetLocalZoneConnection() const
int GetLocalThermalGapOverride(wxString *aSource) const
PAD_SHAPE GetAnchorPadShape(PCB_LAYER_ID aLayer) const
int GetPadToDieLength() const
const VECTOR2I & GetSize(PCB_LAYER_ID aLayer) const
void Format(OUTPUTFORMATTER *aFormatter) const
Output the page class to aFormatter in s-expression form.
FLIP_DIRECTION m_FlipDirection
const VECTOR2I & GetMid() const
wxString GetOverrideText() const
wxString GetSuffix() const
int GetLineThickness() const
DIM_TEXT_POSITION GetTextPositionMode() const
bool GetKeepTextAligned() const
DIM_PRECISION GetPrecision() const
wxString GetPrefix() const
DIM_UNITS_MODE GetUnitsMode() const
DIM_UNITS_FORMAT GetUnitsFormat() const
virtual const VECTOR2I & GetStart() const
The dimension's origin is the first feature point for the dimension.
DIM_ARROW_DIRECTION GetArrowDirection() const
bool GetSuppressZeroes() const
int GetExtensionOffset() const
int GetArrowLength() const
bool GetOverrideTextEnabled() const
virtual const VECTOR2I & GetEnd() const
For better understanding of the points that make a dimension:
int GetExtensionHeight() const
Mark the center of a circle or arc with a cross shape.
A leader is a dimension-like object pointing to a specific point.
DIM_TEXT_BORDER GetTextBorder() const
An orthogonal dimension is like an aligned dimension, but the extension lines are locked to the X or ...
A radial dimension indicates either the radius or diameter of an arc or circle.
int GetLeaderLength() const
virtual const STRING_ANY_MAP GetProperties() const
virtual wxString GetGeneratorType() const
A set of BOARD_ITEMs (i.e., without duplicates).
std::unordered_set< BOARD_ITEM * > & GetItems()
Read a Pcbnew s-expression formatted LINE_READER object and returns the appropriate BOARD_ITEM object...
bool IsTooRecent()
Return whether a version number, if any was parsed, was too recent.
bool IsValidBoardHeader()
Partially parse the input and check if it matches expected header.
wxString GetRequiredVersion()
Return a string representing the version of KiCad required to open this file.
A #PLUGIN derivation for saving and loading Pcbnew s-expression formatted files.
BOARD * DoLoad(LINE_READER &aReader, BOARD *aAppendToMe, const std::map< std::string, UTF8 > *aProperties, PROGRESS_REPORTER *aProgressReporter, unsigned aLineCount)
bool CanReadBoard(const wxString &aFileName) const override
Checks if this PCB_IO can read the specified board file.
void formatProperties(const BOARD *aBoard) const
formats the Nets and Netclasses
FOOTPRINT * ImportFootprint(const wxString &aFootprintPath, wxString &aFootprintNameOut, const std::map< std::string, UTF8 > *aProperties=nullptr) override
Load a single footprint from aFootprintPath and put its name in aFootprintNameOut.
void FootprintDelete(const wxString &aLibraryPath, const wxString &aFootprintName, const std::map< std::string, UTF8 > *aProperties=nullptr) override
Delete aFootprintName from the library at aLibraryPath.
long long GetLibraryTimestamp(const wxString &aLibraryPath) const override
Generate a timestamp representing all the files in the library (including the library directory).
bool IsLibraryWritable(const wxString &aLibraryPath) override
Return true if the library at aLibraryPath is writable.
void formatTeardropParameters(const TEARDROP_PARAMETERS &tdParams) const
bool DeleteLibrary(const wxString &aLibraryPath, const std::map< std::string, UTF8 > *aProperties=nullptr) override
Delete an existing library and returns true, or if library does not exist returns false,...
NETINFO_MAPPING * m_mapping
mapping for net codes, so only not empty net codes are stored with consecutive integers as net codes
void formatNetInformation(const BOARD *aBoard) const
formats the Nets and Netclasses
const FOOTPRINT * GetEnumeratedFootprint(const wxString &aLibraryPath, const wxString &aFootprintName, const std::map< std::string, UTF8 > *aProperties=nullptr) override
A version of FootprintLoad() for use after FootprintEnumerate() for more efficient cache management.
void CreateLibrary(const wxString &aLibraryPath, const std::map< std::string, UTF8 > *aProperties=nullptr) override
Create a new empty library at aLibraryPath empty.
void FootprintEnumerate(wxArrayString &aFootprintNames, const wxString &aLibraryPath, bool aBestEfforts, const std::map< std::string, UTF8 > *aProperties=nullptr) override
Return a list of footprint names contained within the library at aLibraryPath.
void formatPolyPts(const SHAPE_LINE_CHAIN &outline, const FOOTPRINT *aParentFP=nullptr) const
FP_CACHE * m_cache
Footprint library cache.
void formatBoardLayers(const BOARD *aBoard) const
formats the board layer information
FOOTPRINT * FootprintLoad(const wxString &aLibraryPath, const wxString &aFootprintName, bool aKeepUUID=false, const std::map< std::string, UTF8 > *aProperties=nullptr) override
Load a footprint having aFootprintName from the aLibraryPath containing a library format that this PC...
BOARD * LoadBoard(const wxString &aFileName, BOARD *aAppendToMe, const std::map< std::string, UTF8 > *aProperties=nullptr, PROJECT *aProject=nullptr) override
Load information from some input file format that this PCB_IO implementation knows about into either ...
bool FootprintExists(const wxString &aLibraryPath, const wxString &aFootprintName, const std::map< std::string, UTF8 > *aProperties=nullptr) override
Check for the existence of a footprint.
void FootprintSave(const wxString &aLibraryPath, const FOOTPRINT *aFootprint, const std::map< std::string, UTF8 > *aProperties=nullptr) override
Write aFootprint to an existing library located at aLibraryPath.
void format(const BOARD *aBoard) const
void SaveBoard(const wxString &aFileName, BOARD *aBoard, const std::map< std::string, UTF8 > *aProperties=nullptr) override
Write aBoard to a storage file in a format that this PCB_IO implementation knows about or it can be u...
void formatTenting(const PADSTACK &aPadstack) const
void formatGeneral(const BOARD *aBoard) const
formats the General section of the file
void formatSetup(const BOARD *aBoard) const
formats the board setup information
void formatLayers(LSET aLayerMask, bool aEnumerateLayers) const
std::function< bool(wxString aTitle, int aIcon, wxString aMsg, wxString aAction)> m_queryUserCallback
BOARD_ITEM * Parse(const wxString &aClipboardSourceInput)
void init(const std::map< std::string, UTF8 > *aProperties)
void Format(const BOARD_ITEM *aItem) const
Output aItem to aFormatter in s-expression format.
void formatLayer(PCB_LAYER_ID aLayer, bool aIsKnockout=false) const
void formatHeader(const BOARD *aBoard) const
writes everything that comes before the board_items, like settings and layers etc
const FOOTPRINT * getFootprint(const wxString &aLibraryPath, const wxString &aFootprintName, const std::map< std::string, UTF8 > *aProperties, bool checkModified)
void SetOutputFormatter(OUTPUTFORMATTER *aFormatter)
PCB_IO_KICAD_SEXPR(int aControlFlags=CTL_FOR_BOARD)
OUTPUTFORMATTER * m_out
output any Format()s to this, no ownership
void validateCache(const wxString &aLibraryPath, bool checkModified=true)
virtual ~PCB_IO_KICAD_SEXPR()
void formatRenderCache(const EDA_TEXT *aText) const
LINE_READER * m_reader
no ownership
A base class that BOARD loading and saving plugins should derive from.
BOARD * m_board
The board BOARD being worked on, no ownership here.
virtual bool CanReadBoard(const wxString &aFileName) const
Checks if this PCB_IO can read the specified board file.
const std::map< std::string, UTF8 > * m_props
Properties passed via Save() or Load(), no ownership, may be NULL.
void Format(OUTPUTFORMATTER *aFormatter) const
Object to handle a bitmap image that can be inserted in a PCB.
VECTOR2I GetPosition() const override
Get the position of the image (this is the center of the image).
REFERENCE_IMAGE & GetReferenceImage()
std::optional< int > GetLocalSolderMaskMargin() const
bool HasSolderMask() const
virtual LSET GetLayerSet() const override
Return a std::bitset of all layers on which the item physically resides.
STROKE_PARAMS GetStroke() const override
PCB_LAYER_ID GetLayer() const override
Return the primary layer this item is on.
bool StrokeColumns() const
bool StrokeExternal() const
bool StrokeHeader() const
std::vector< PCB_TABLECELL * > GetCells() const
const STROKE_PARAMS & GetSeparatorsStroke() const
const STROKE_PARAMS & GetBorderStroke() const
int GetColWidth(int aCol) const
int GetRowHeight(int aRow) const
VECTOR2I GetPosition() const override
bool IsBorderEnabled() const
Disables the border, this is done by changing the stroke internally.
int GetMarginBottom() const
int GetMarginLeft() const
int GetMarginRight() const
virtual LSET GetLayerSet() const override
Return a std::bitset of all layers on which the item physically resides.
bool HasSolderMask() const
std::optional< int > GetLocalSolderMaskMargin() const
const VECTOR2I & GetStart() const
const VECTOR2I & GetEnd() const
bool IsOnLayer(PCB_LAYER_ID aLayer) const override
Test to see if this object is on the given layer.
virtual int GetWidth() const
A progress reporter interface for use in multi-threaded environments.
virtual bool KeepRefreshing(bool aWait=false)=0
Update the UI (if any).
virtual void Report(const wxString &aMessage)=0
Display aMessage in the progress bar dialog.
Container for project specific data.
A REFERENCE_IMAGE is a wrapper around a BITMAP_IMAGE that is displayed in an editor as a reference fo...
const BITMAP_BASE & GetImage() const
Get the underlying image.
double GetImageScale() const
const VECTOR2I & GetArcMid() const
const VECTOR2I & GetP1() const
const VECTOR2I & GetP0() const
Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc s...
const SHAPE_ARC & Arc(size_t aArc) const
int PointCount() const
Return the number of points (vertices) in this line chain.
ssize_t ArcIndex(size_t aSegment) const
Return the arc index for the given segment index.
const VECTOR2I & CPoint(int aIndex) const
Return a reference to a given point in the line chain.
Represent a set of closed polygons.
POLYGON & Polygon(int aIndex)
Return the aIndex-th subpolygon in the set.
std::vector< SHAPE_LINE_CHAIN > POLYGON
represents a single polygon outline with holes.
SHAPE_LINE_CHAIN & Outline(int aIndex)
Return the reference to aIndex-th outline in the set.
Is a LINE_READER that reads from a multiline 8 bit wide std::string.
void Format(OUTPUTFORMATTER *out, const EDA_IU_SCALE &aIuScale) const
TEARDROP_PARAMETARS is a helper class to handle parameters needed to build teardrops for a board thes...
double m_BestWidthRatio
The height of a teardrop as ratio between height and size of pad/via.
int m_TdMaxLen
max allowed length for teardrops in IU. <= 0 to disable
bool m_AllowUseTwoTracks
True to create teardrops using 2 track segments if the first in too small.
int m_TdMaxWidth
max allowed height for teardrops in IU. <= 0 to disable
double m_BestLengthRatio
The length of a teardrop as ratio between length and size of pad/via.
double m_WidthtoSizeFilterRatio
The ratio (H/D) between the via/pad size and the track width max value to create a teardrop 1....
bool m_TdOnPadsInZones
A filter to exclude pads inside zone fills.
bool m_Enabled
Flag to enable teardrops.
bool m_CurvedEdges
True if the teardrop should be curved.
virtual void Format(OUTPUTFORMATTER *aFormatter) const
Output the object to aFormatter in s-expression form.
static REPORTER & GetInstance()
A wrapper around a wxFileName which is much more performant with a subset of the API.
void SetFullName(const wxString &aFileNameAndExtension)
static void ResolvePossibleSymlinks(wxFileName &aFilename)
wxString GetFullPath() const
Handle a list of polygons defining a copper zone.
int GetHatchBorderAlgorithm() const
bool GetIsRuleArea() const
Accessors to parameters used in Rule Area zones:
std::optional< int > GetLocalClearance() const override
wxString GetRuleAreaPlacementSource() const
bool GetDoNotAllowVias() const
const std::shared_ptr< SHAPE_POLY_SET > & GetFilledPolysList(PCB_LAYER_ID aLayer) const
bool GetDoNotAllowPads() const
bool GetDoNotAllowTracks() const
bool GetRuleAreaPlacementEnabled() const
ISLAND_REMOVAL_MODE GetIslandRemovalMode() const
SHAPE_POLY_SET * Outline()
bool IsIsland(PCB_LAYER_ID aLayer, int aPolyIdx) const
Check if a given filled polygon is an insulated island.
long long int GetMinIslandArea() const
const wxString & GetZoneName() const
int GetMinThickness() const
ZONE_CONNECTION GetPadConnection() const
int GetHatchThickness() const
double GetHatchHoleMinArea() const
bool IsTeardropArea() const
int GetThermalReliefSpokeWidth() const
int GetBorderHatchPitch() const
HatchBorder related methods.
ZONE_BORDER_DISPLAY_STYLE GetHatchStyle() const
EDA_ANGLE GetHatchOrientation() const
bool GetDoNotAllowFootprints() const
ZONE_FILL_MODE GetFillMode() const
virtual LSET GetLayerSet() const override
Return a std::bitset of all layers on which the item physically resides.
bool GetDoNotAllowCopperPour() const
RULE_AREA_PLACEMENT_SOURCE_TYPE GetRuleAreaPlacementSourceType() const
TEARDROP_TYPE GetTeardropAreaType() const
double GetHatchSmoothingValue() const
int GetHatchSmoothingLevel() const
unsigned int GetCornerRadius() const
int GetCornerSmoothingType() const
bool IsOnCopperLayer() const override
PCB_LAYER_ID GetFirstLayer() const
int GetThermalReliefGap() const
unsigned GetAssignedPriority() const
int GetNumCorners(void) const
Access to m_Poly parameters.
static void SetReporter(REPORTER *aReporter)
Set the reporter to use for reporting font substitution warnings.
long long TimestampDir(const wxString &aDirPath, const wxString &aFilespec)
A copy of ConvertFileTimeToWx() because wxWidgets left it as a static function private to src/common/...
This file is part of the common library.
@ RECT_CHAMFER_BOTTOM_RIGHT
@ RECT_CHAMFER_BOTTOM_LEFT
#define CTL_OMIT_HYPERLINK
Omit the hyperlink attribute in .kicad_xxx files.
#define CTL_OMIT_UUIDS
Omit component unique ids (useless in library)
#define CTL_OMIT_FOOTPRINT_VERSION
Omit the version string from the (footprint) sexpr group.
#define CTL_OMIT_INITIAL_COMMENTS
Omit FOOTPRINT initial comments.
#define CTL_OMIT_LIBNAME
Omit lib alias when saving (used for board/not library).
#define CTL_OMIT_PATH
Omit component sheet time stamp (useless in library).
#define CTL_OMIT_HIDE
Omit the hide attribute in .kicad_xxx files.
#define CTL_OMIT_AT
Omit position and rotation.
#define CTL_OMIT_PAD_NETS
Omit pads net names (useless in library).
#define CTL_OMIT_COLOR
Omit the color attribute in .kicad_xxx files.
static constexpr EDA_ANGLE ANGLE_0
static constexpr EDA_ANGLE ANGLE_90
static constexpr EDA_ANGLE ANGLE_45
static const std::string KiCadFootprintFileExtension
const wxChar *const traceKicadPcbPlugin
Flag to enable GEDA PCB plugin debug output.
#define THROW_IO_ERROR(msg)
#define THROW_PARSE_ERROR(aProblem, aSource, aInputLine, aLineNumber, aByteIndex)
bool IsCopperLayer(int aLayerId)
Test whether a layer is a copper layer.
bool IsExternalCopperLayer(int aLayerId)
Test whether a layer is an external (F_Cu or B_Cu) copper layer.
PCB_LAYER_ID
A quick note on layer IDs:
This file contains miscellaneous commonly used macros and functions.
#define UNIMPLEMENTED_FOR(type)
KICOMMON_API std::string FormatInternalUnits(const EDA_IU_SCALE &aIuScale, int aValue)
Converts aValue from internal units to a string appropriate for writing to file.
KICOMMON_API std::string FormatAngle(const EDA_ANGLE &aAngle)
Convert aAngle from board units to a string appropriate for writing to file.
Class to handle a set of BOARD_ITEMs.
bool isDefaultTeardropParameters(const TEARDROP_PARAMETERS &tdParams)
std::string formatInternalUnits(int aValue)
#define SEXPR_BOARD_FILE_VERSION
Current s-expression file format version. 2 was the last legacy format version.
#define CTL_FOR_BOARD
The zero arg constructor when PCB_PLUGIN is used for PLUGIN::Load() and PLUGIN::Save()ing a BOARD fil...
boost::ptr_map< wxString, FP_CACHE_ITEM > FP_CACHE_FOOTPRINT_MAP
#define CTL_FOR_LIBRARY
Format output for a footprint library instead of clipboard or BOARD.
Pcbnew s-expression file format parser definition.
#define UNDEFINED_DRILL_DIAMETER
PGM_BASE & Pgm()
The global program "get" accessor.
bool ReplaceIllegalFileNameChars(std::string *aName, int aReplaceChar)
Checks aName for illegal file name characters.
std::string FormatDouble2Str(double aValue)
Print a float number without using scientific notation and no trailing 0 This function is intended in...
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
static const char * ShowType(LAYER_T aType)
Convert a LAYER_T enum to a string representation of the layer type.
std::optional< bool > has_solder_mask
True if this outer layer has mask (is not tented)
A filename or source description, a problem input line, a line number, a byte offset,...
const SHAPE_LINE_CHAIN chain
wxLogTrace helper definitions.
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.
@ PCB_SHAPE_T
class PCB_SHAPE, a segment not on copper layers
@ PCB_DIM_ORTHOGONAL_T
class PCB_DIM_ORTHOGONAL, a linear dimension constrained to x/y
@ PCB_DIM_LEADER_T
class PCB_DIM_LEADER, a leader dimension (graphic item)
@ PCB_GENERATOR_T
class PCB_GENERATOR, generator on a layer
@ PCB_VIA_T
class PCB_VIA, a via (like a track segment on a copper layer)
@ PCB_DIM_CENTER_T
class PCB_DIM_CENTER, a center point marking (graphic item)
@ PCB_GROUP_T
class PCB_GROUP, a set of BOARD_ITEMs
@ PCB_TEXTBOX_T
class PCB_TEXTBOX, wrapped text on a layer
@ PCB_ZONE_T
class ZONE, a copper pour area
@ PCB_TEXT_T
class PCB_TEXT, text on a layer
@ PCB_REFERENCE_IMAGE_T
class PCB_REFERENCE_IMAGE, bitmap on a layer
@ PCB_FIELD_T
class PCB_FIELD, text associated with a footprint property
@ PCB_TARGET_T
class PCB_TARGET, a target (graphic item)
@ PCB_TABLECELL_T
class PCB_TABLECELL, PCB_TEXTBOX for use in tables
@ PCB_FOOTPRINT_T
class FOOTPRINT, a footprint
@ PCB_DIM_ALIGNED_T
class PCB_DIM_ALIGNED, a linear dimension (graphic item)
@ PCB_PAD_T
class PAD, a pad in a footprint
@ PCB_ARC_T
class PCB_ARC, an arc track segment on a copper layer
@ PCB_TABLE_T
class PCB_TABLE, table of PCB_TABLECELLs
@ PCB_TRACE_T
class PCB_TRACK, a track segment (segment on a copper layer)
@ PCB_DIM_RADIAL_T
class PCB_DIM_RADIAL, a radius or diameter dimension
VECTOR2< int32_t > VECTOR2I
Definition of file extensions used in Kicad.