77 std::placeholders::_1 ) );
93 const wxString& aDrawingSheetOverride )
110 [&](
const wxString&
path ) ->
bool
127 if( !aDrawingSheetOverride.IsEmpty() && loadSheet( aDrawingSheetOverride ) )
152 std::unique_ptr<KIGFX::SCH_RENDER_SETTINGS> renderSettings =
153 std::make_unique<KIGFX::SCH_RENDER_SETTINGS>();
156 std::unique_ptr<SCH_PLOTTER> schPlotter = std::make_unique<SCH_PLOTTER>( sch );
161 case SCH_PLOT_FORMAT::DXF: format = PLOT_FORMAT::DXF;
break;
162 case SCH_PLOT_FORMAT::PDF: format = PLOT_FORMAT::PDF;
break;
163 case SCH_PLOT_FORMAT::SVG: format = PLOT_FORMAT::SVG;
break;
164 case SCH_PLOT_FORMAT::POST: format = PLOT_FORMAT::POST;
break;
165 case SCH_PLOT_FORMAT::HPGL: format = PLOT_FORMAT::HPGL;
break;
166 case SCH_PLOT_FORMAT::GERBER: format = PLOT_FORMAT::GERBER;
break;
172 case JOB_HPGL_PAGE_SIZE::DEFAULT: hpglPageSize = HPGL_PAGE_SIZE::DEFAULT;
break;
173 case JOB_HPGL_PAGE_SIZE::SIZE_A: hpglPageSize = HPGL_PAGE_SIZE::SIZE_A;
break;
174 case JOB_HPGL_PAGE_SIZE::SIZE_A0: hpglPageSize = HPGL_PAGE_SIZE::SIZE_A0;
break;
175 case JOB_HPGL_PAGE_SIZE::SIZE_A1: hpglPageSize = HPGL_PAGE_SIZE::SIZE_A1;
break;
176 case JOB_HPGL_PAGE_SIZE::SIZE_A2: hpglPageSize = HPGL_PAGE_SIZE::SIZE_A2;
break;
177 case JOB_HPGL_PAGE_SIZE::SIZE_A3: hpglPageSize = HPGL_PAGE_SIZE::SIZE_A3;
break;
178 case JOB_HPGL_PAGE_SIZE::SIZE_A4: hpglPageSize = HPGL_PAGE_SIZE::SIZE_A4;
break;
179 case JOB_HPGL_PAGE_SIZE::SIZE_A5: hpglPageSize = HPGL_PAGE_SIZE::SIZE_A5;
break;
180 case JOB_HPGL_PAGE_SIZE::SIZE_B: hpglPageSize = HPGL_PAGE_SIZE::SIZE_B;
break;
181 case JOB_HPGL_PAGE_SIZE::SIZE_C: hpglPageSize = HPGL_PAGE_SIZE::SIZE_C;
break;
182 case JOB_HPGL_PAGE_SIZE::SIZE_D: hpglPageSize = HPGL_PAGE_SIZE::SIZE_D;
break;
183 case JOB_HPGL_PAGE_SIZE::SIZE_E: hpglPageSize = HPGL_PAGE_SIZE::SIZE_E;
break;
189 case JOB_HPGL_PLOT_ORIGIN_AND_UNITS::PLOTTER_BOT_LEFT:
190 hpglOrigin = HPGL_PLOT_ORIGIN_AND_UNITS::PLOTTER_BOT_LEFT;
192 case JOB_HPGL_PLOT_ORIGIN_AND_UNITS::PLOTTER_CENTER:
193 hpglOrigin = HPGL_PLOT_ORIGIN_AND_UNITS::PLOTTER_CENTER;
195 case JOB_HPGL_PLOT_ORIGIN_AND_UNITS::USER_FIT_CONTENT:
196 hpglOrigin = HPGL_PLOT_ORIGIN_AND_UNITS::USER_FIT_CONTENT;
198 case JOB_HPGL_PLOT_ORIGIN_AND_UNITS::USER_FIT_PAGE:
199 hpglOrigin = HPGL_PLOT_ORIGIN_AND_UNITS::USER_FIT_PAGE;
203 int pageSizeSelect = PageFormatReq::PAGE_SIZE_AUTO;
207 case JOB_PAGE_SIZE::PAGE_SIZE_A: pageSizeSelect = PageFormatReq::PAGE_SIZE_A;
break;
208 case JOB_PAGE_SIZE::PAGE_SIZE_A4: pageSizeSelect = PageFormatReq::PAGE_SIZE_A4;
break;
209 case JOB_PAGE_SIZE::PAGE_SIZE_AUTO: pageSizeSelect = PageFormatReq::PAGE_SIZE_AUTO;
break;
228 schPlotter->Plot( format, settings, renderSettings.get(),
m_reporter );
262 m_reporter->
Report(
_(
"Warning: schematic has annotation errors, please use the "
263 "schematic editor to fix them\n" ),
271 if(
erc.TestDuplicateSheetNames(
false ) > 0 )
274 std::unique_ptr<NETLIST_EXPORTER_BASE> helper;
275 unsigned netlistOption = 0;
283 helper = std::make_unique<NETLIST_EXPORTER_KICAD>( sch );
288 helper = std::make_unique<NETLIST_EXPORTER_ORCADPCB2>( sch );
293 helper = std::make_unique<NETLIST_EXPORTER_CADSTAR>( sch );
299 helper = std::make_unique<NETLIST_EXPORTER_SPICE>( sch );
304 helper = std::make_unique<NETLIST_EXPORTER_SPICE_MODEL>( sch );
308 fileExt = wxS(
"xml" );
309 helper = std::make_unique<NETLIST_EXPORTER_XML>( sch );
313 fileExt = wxS(
"asc" );
314 helper = std::make_unique<NETLIST_EXPORTER_PADS>( sch );
318 fileExt = wxS(
"txt" );
319 helper = std::make_unique<NETLIST_EXPORTER_ALLEGRO>( sch );
330 fn.SetName( fn.GetName() );
331 fn.SetExt( fileExt );
371 if(
copy.CheckAnnotation(
379 _(
"Warning: schematic has annotation errors, please use the schematic "
380 "editor to fix them\n" ),
388 if(
erc.TestDuplicateSheetNames(
false ) > 0 )
400 std::set<wxString> userFieldNames;
402 for(
size_t i = 0; i < referenceList.
GetCount(); ++i )
404 SCH_SYMBOL* symbol = referenceList[i].GetSymbol();
407 userFieldNames.insert( symbol->
GetFields()[j].GetName() );
410 for(
const wxString& fieldName : userFieldNames )
417 if( userFieldNames.count( templateFieldname.m_Name ) == 0 )
447 m_reporter->
Report( wxString::Format(
_(
"BOM preset '%s' not found" ) + wxS(
"\n" ),
464 if( fieldName == wxS(
"*" ) )
470 field.
name = modelField.name;
475 bool fieldAlreadyPresent =
false;
478 if( presetField.
name == field.
name )
480 fieldAlreadyPresent =
true;
485 bool fieldLaterInList =
false;
488 if( fieldInList == field.
name )
490 fieldLaterInList =
true;
495 if( !fieldAlreadyPresent && !fieldLaterInList )
504 field.
name = fieldName;
533 fn.SetName( fn.GetName() );
574 wxString::Format(
_(
"BOM format preset '%s' not found" ) + wxS(
"\n" ),
593 bool res = f.Write( dataModel.
Export( fmt ) );
631 _(
"Warning: schematic has annotation errors, please use the schematic "
632 "editor to fix them\n" ),
640 if(
erc.TestDuplicateSheetNames(
false ) > 0 )
643 std::unique_ptr<NETLIST_EXPORTER_XML> xmlNetlist =
644 std::make_unique<NETLIST_EXPORTER_XML>( sch );
649 fn.SetName( fn.GetName() +
"-bom" );
668 wxASSERT( symbol !=
nullptr );
670 if( symbol ==
nullptr )
680 symbolToPlot = parent.get();
697 pin.SetVisible(
true );
702 for(
int unit = 1; unit < symbol->
GetUnitCount() + 1; unit++ )
708 size_t forbidden_char;
713 filename = symbol->
GetName().Lower();
715 while( wxString::npos
716 != ( forbidden_char = filename.find_first_of(
717 wxFileName::GetForbiddenChars( wxPATH_DOS ) ) ) )
719 filename = filename.replace( forbidden_char, 1, wxS(
'_' ) );
725 filename += wxString::Format(
"_%d", unit );
728 filename += wxS(
"_demorgan" );
730 fn.SetName( filename );
731 m_reporter->
Report( wxString::Format(
_(
"Plotting symbol '%s' unit %d to '%s'\n" ),
732 symbol->
GetName(), unit, fn.GetFullPath() ),
738 filename += wxS(
"_demorgan" );
740 fn.SetName( filename );
742 symbol->
GetName(), fn.GetFullPath() ),
747 BOX2I symbolBB = symbol->
Flatten()->GetUnitBoundingBox( unit, bodyStyle,
false );
758 const double scale = 1.0;
765 if( !plotter->
OpenFile( fn.GetFullPath() ) )
768 wxString::Format(
_(
"Unable to open destination '%s'" ) + wxS(
"\n" ),
780 bool background =
true;
788 symbolToPlot->
Plot( plotter, unit, bodyStyle, background, plotPos, temp,
false );
789 symbol->
PlotLibFields( plotter, unit, bodyStyle, background, plotPos, temp,
false,
792 symbolToPlot->
Plot( plotter, unit, bodyStyle, !background, plotPos, temp,
false );
793 symbol->
PlotLibFields( plotter, unit, bodyStyle, !background, plotPos, temp,
false,
863 for(
const std::pair<const wxString, LIB_SYMBOL*>& entry : libSymMap )
865 exitCode =
doSymExportSvg( svgJob, &renderSettings, entry.second );
898 else if(
fileType != SCH_IO_MGR::SCH_KICAD )
900 m_reporter->
Report(
_(
"Output path must be specified to convert legacy and non-KiCad libraries\n" ),
906 if(
fileType == SCH_IO_MGR::SCH_KICAD )
984 fn.SetName( fn.GetName() );
1001 default: units = EDA_UNITS::MILLIMETRES;
break;
1004 std::shared_ptr<SHEETLIST_ERC_ITEMS_PROVIDER> markersProvider =
1005 std::make_shared<SHEETLIST_ERC_ITEMS_PROVIDER>( sch );
1015 markersProvider->SetSeverities( ercJob->
m_severity );
1018 markersProvider->GetCount() ),
1023 bool wroteReport =
false;
1043 if( markersProvider->GetCount() > 0 )
1068 return drawingSheet;
constexpr EDA_IU_SCALE schIUScale
int GetVirtualPageNumber() const
const wxString & GetPageNumber() const
coord_type GetHeight() const
coord_type GetWidth() const
Color settings are a bit different than most of the settings objects in that there can be more than o...
static DS_DATA_MODEL & GetTheInstance()
static function: returns the instance of DS_DATA_MODEL used in the application
static const wxString ResolvePath(const wxString &aPath, const wxString &aProjectPath)
Resolve a path which might be project-relative or contain env variable references.
void SetSheetPath(const std::string &aSheetPath)
Set the sheet path displayed in the title block.
void SetSheetCount(int aSheetCount)
Changes the sheet-count number displayed in the title block.
void SetPageNumber(const std::string &aPageNumber)
Changes the page number displayed in the title block.
void SetSheetName(const std::string &aSheetName)
Set the sheet name displayed in the title block.
void SetPageBorderColorLayer(int aLayerId)
Overrides the layer used to pick the color of the page border (normally LAYER_GRID)
void SetIsFirstPage(bool aIsFirstPage)
Change if this is first page.
void SetFileName(const std::string &aFileName)
Set the file name displayed in the title block.
void SetColorLayer(int aLayerId)
Can be used to override which layer ID is used for drawing sheet item colors.
static SCHEMATIC * LoadSchematic(wxString &aFileName, bool aSetActive)
int JobExportNetlist(JOB *aJob)
int JobSymUpgrade(JOB *aJob)
int JobExportBom(JOB *aJob)
void InitRenderSettings(KIGFX::SCH_RENDER_SETTINGS *aRenderSettings, const wxString &aTheme, SCHEMATIC *aSch, const wxString &aDrawingSheetOverride=wxEmptyString)
Configure the SCH_RENDER_SETTINGS object with the correct data to be used with plotting.
int JobSymExportSvg(JOB *aJob)
DS_PROXY_VIEW_ITEM * getDrawingSheetProxyView(SCHEMATIC *aSch)
int JobExportPythonBom(JOB *aJob)
int doSymExportSvg(JOB_SYM_EXPORT_SVG *aSvgJob, KIGFX::SCH_RENDER_SETTINGS *aRenderSettings, LIB_SYMBOL *symbol)
EESCHEMA_JOBS_HANDLER(KIWAY *aKiway)
int JobExportPlot(JOB *aJob)
bool WriteJsonReport(const wxString &aFullFileName)
Writes a JSON formatted ERC Report to the given file path.
bool WriteTextReport(const wxString &aFullFileName)
Writes the text report also available via GetTextReport directly to a given file path.
void RunTests(DS_PROXY_VIEW_ITEM *aDrawingSheet, SCH_EDIT_FRAME *aEditFrame, KIFACE *aCvPcb, PROJECT *aProject, PROGRESS_REPORTER *aProgressReporter)
void ApplyBomPreset(const BOM_PRESET &preset)
wxString Export(const BOM_FMT_PRESET &settings)
void AddColumn(const wxString &aFieldName, const wxString &aLabel, bool aAddedByUser)
const std::vector< BOM_FIELD > GetFieldsOrdered()
PROGRESS_REPORTER * m_progressReporter
void Register(const std::string &aJobTypeName, std::function< int(JOB *job)> aHandler)
std::vector< wxString > m_fieldsLabels
std::vector< wxString > m_fieldsOrdered
wxString m_refRangeDelimiter
std::vector< wxString > m_fieldsGroupBy
wxString m_stringDelimiter
wxString m_fieldDelimiter
wxString m_bomFmtPresetName
JOB_PAGE_SIZE m_pageSizeSelect
SCH_PLOT_FORMAT m_plotFormat
bool m_useBackgroundColor
wxString m_outputDirectory
JOB_HPGL_PLOT_ORIGIN_AND_UNITS m_HPGLPlotOrigin
std::vector< wxString > m_plotPages
JOB_HPGL_PAGE_SIZE m_HPGLPaperSizeSelect
bool m_exitCodeViolations
wxString m_outputDirectory
bool m_includeHiddenFields
wxString m_outputLibraryPath
An simple container class that lets us dispatch output jobs to kifaces.
const std::map< wxString, wxString > & GetVarOverrides() const
void SetDefaultPenWidth(int aWidth)
void SetGapLengthRatio(double aRatio)
void SetDashLengthRatio(double aRatio)
Store schematic specific render settings.
void LoadColors(const COLOR_SETTINGS *aSettings) override
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
virtual KIFACE * KiFACE(FACE_T aFaceId, bool doLoad=true)
Return the KIFACE* given a FACE_T.
The base class for drawable items used by schematic library symbols.
Define a library symbol object.
bool HasAlternateBodyStyle() const
Test if symbol has more than one body conversion type (DeMorgan).
void PlotLibFields(PLOTTER *aPlotter, int aUnit, int aBodyStyle, bool aBackground, const VECTOR2I &aOffset, const TRANSFORM &aTransform, bool aDimmed, bool aPlotHidden=true)
Plot Lib Fields only of the symbol to plotter.
LIB_ITEMS_CONTAINER & GetDrawItems()
Return a reference to the draw item list.
wxString GetName() const override
void Plot(PLOTTER *aPlotter, int aUnit, int aBodyStyle, bool aBackground, const VECTOR2I &aOffset, const TRANSFORM &aTransform, bool aDimmed) const
Plot lib symbol to plotter.
int GetUnitCount() const override
For items with units, return the number of units.
std::unique_ptr< LIB_SYMBOL > Flatten() const
Return a flattened symbol inheritance to the caller.
LIB_SYMBOL_SPTR GetRootSymbol() const
Get the parent symbol that does not have another parent.
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Describe the page size and margins of a paper page on which to eventually print or plot.
int GetHeightIU(double aIUScale) const
Gets the page height in IU.
static const wxChar Custom[]
"User" defined page type
void SetHeightMils(double aHeightInMils)
int GetWidthIU(double aIUScale) const
Gets the page width in IU.
void SetWidthMils(double aWidthInMils)
virtual SETTINGS_MANAGER & GetSettingsManager() const
virtual bool OpenFile(const wxString &aFullFilename)
Open or create the plot file aFullFilename.
virtual void SetPageSettings(const PAGE_INFO &aPageSettings)
void SetRenderSettings(RENDER_SETTINGS *aSettings)
virtual void SetCreator(const wxString &aCreator)
virtual void SetColorMode(bool aColorMode)
Plot in B/W or color.
virtual const wxString GetProjectPath() const
Return the full path of the project.
virtual void ApplyTextVars(const std::map< wxString, wxString > &aVarsMap)
Applies the given var map, it will create or update existing vars.
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)=0
Report a string with a given severity.
wxString m_SchDrawingSheetFileName
TEMPLATES m_TemplateFieldNames
std::vector< BOM_PRESET > m_BomPresets
double m_DashedLineGapRatio
std::vector< BOM_FMT_PRESET > m_BomFmtPresets
double m_DashedLineDashRatio
Holds all the data relating to one schematic.
wxString GetFileName() const override
Helper to retrieve the filename from the root sheet screen.
SCHEMATIC_SETTINGS & Settings() const
SCH_SHEET_LIST GetSheets() const override
Builds and returns an updated schematic hierarchy TODO: can this be cached?
SCH_SCREEN * RootScreen() const
Helper to retrieve the screen of the root sheet.
const std::map< wxString, wxString > * GetProperties()
PROJECT & Prj() const override
Return a reference to the project this schematic is part of.
A cache assistant for the KiCad s-expression symbol libraries.
int GetFileFormatVersionAtLoad() const
void Save(const std::optional< bool > &aOpt=std::nullopt) override
Save the entire library to file m_libFileName;.
virtual LIB_SYMBOL * GetSymbol(const wxString &aName)
void SetFileName(const wxString &aFileName)
const LIB_SYMBOL_MAP & GetSymbolMap() const
void SetModified(bool aModified=true)
static bool ConvertLibrary(STRING_UTF8_MAP *aOldFileProps, const wxString &aOldFilePath, const wxString &aNewFilepath)
Convert a schematic symbol library to the latest KiCad format.
static SCH_FILE_T GuessPluginTypeFromLibPath(const wxString &aLibPath, int aCtl=0)
Return a plugin type given a symbol library using the file extension of aLibPath.
Container to create a flattened list of symbols because in a complex hierarchy, a symbol can be used ...
int CheckAnnotation(ANNOTATION_ERROR_HANDLER aErrorHandler)
Check for annotations errors.
A helper to define a symbol's reference designator in a schematic.
const PAGE_INFO & GetPageSettings() const
const wxString & GetFileName() const
const TITLE_BLOCK & GetTitleBlock() const
void GetSymbols(SCH_REFERENCE_LIST &aReferences, bool aIncludePowerSymbols=true, bool aForceIncludeOrphanSymbols=false) const
Add a SCH_REFERENCE object to aReferences for each symbol in the list of sheets.
int GetFieldCount() const
Return the number of fields in this symbol.
void GetFields(std::vector< SCH_FIELD * > &aVector, bool aVisibleOnly)
Populate a std::vector with SCH_FIELDs.
COLOR_SETTINGS * GetColorSettings(const wxString &aName="user")
Retrieves a color settings object that applications can read colors from.
virtual bool StartPlot(const wxString &aPageNumber) override
Create SVG file header.
virtual void SetViewport(const VECTOR2I &aOffset, double aIusPerDecimil, double aScale, bool aMirror) override
Set the plot offset and scaling for the current plot.
virtual bool EndPlot() override
const TEMPLATE_FIELDNAMES & GetTemplateFieldNames()
Return a template field name list for read only access.
bool IsTextVar(const wxString &aSource)
Returns true if the string is a text var, e.g starts with ${.
wxString GetTextVars(const wxString &aSource)
Returns any variables unexpanded, e.g.
#define DEFAULT_LINE_WIDTH_MILS
The default wire width in mils. (can be changed in preference menu)
static const std::string CadstarNetlistFileExtension
static const std::string NetlistFileExtension
static const std::string ReportFileExtension
static const std::string JsonFileExtension
static const std::string XmlFileExtension
static const std::string OrCadPcb2NetlistFileExtension
static const std::string CsvFileExtension
static const std::string SpiceFileExtension
static const std::string SVGFileExtension
@ LAYER_SCHEMATIC_DRAWINGSHEET
@ LAYER_SCHEMATIC_PAGE_LIMITS
std::shared_ptr< LIB_SYMBOL > LIB_SYMBOL_SPTR
shared pointer to LIB_SYMBOL
static const int ERR_ARGS
static const int ERR_RC_VIOLATIONS
static const int ERR_INVALID_INPUT_FILE
static const int ERR_INVALID_OUTPUT_CONFLICT
Rules check violation count was greater than 0.
static const int ERR_UNKNOWN
PGM_BASE & Pgm()
The global Program "get" accessor.
PLOT_FORMAT
The set of supported output plot formats.
Plotting engines similar to ps (PostScript, Gerber, svg)
#define SEXPR_SYMBOL_LIB_FILE_VERSION
This file contains the file format version information for the s-expression schematic and symbol libr...
HPGL_PLOT_ORIGIN_AND_UNITS
MODEL3D_FORMAT_TYPE fileType(const char *aFileName)
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
static std::vector< BOM_FMT_PRESET > BuiltInPresets()
wxString refRangeDelimiter
std::vector< BOM_FIELD > fieldsOrdered
static std::vector< BOM_PRESET > BuiltInPresets()
constexpr int IUToMils(int iu) const
HPGL_PAGE_SIZE m_HPGLPaperSizeSelect
HPGL_PLOT_ORIGIN_AND_UNITS m_HPGLPlotOrigin
bool m_useBackgroundColor
std::vector< wxString > m_plotPages
wxString m_outputDirectory
Hold a name of a symbol's field, field value, and default visibility.
static const wxString GetDefaultFieldName(int aFieldNdx, bool aTranslateForHI=false)
Return a default symbol field name for field aFieldNdx for all components.
std::map< wxString, LIB_SYMBOL *, LibSymbolMapSort > LIB_SYMBOL_MAP
@ MANDATORY_FIELDS
The first 5 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors.
Definition of file extensions used in Kicad.