KiCad PCB EDA Suite
Loading...
Searching...
No Matches
KICAD_FORMAT::LEGACY Namespace Reference

Classes

struct  FP_DRAWING_ORDER
 Every branch falls through to the uuid. More...
 
struct  TUNING_PROPERTY
 

Typedefs

using FP_DRAWING_ORDER_V9 = FP_DRAWING_ORDER<false>
 KiCad 9 ordered only shapes by geometry. KiCad 10 also ordered text by position.
 
using FP_DRAWING_ORDER_V10 = FP_DRAWING_ORDER<true>
 

Enumerations

enum class  TUNING_PROPERTY_TYPE {
  NUMBER , BOOL , TEXT , POINT ,
  LINE_CHAIN
}
 

Functions

bool IsDefaultTextV10 (const EDA_TEXT &aText)
 
void FormatBool (OUTPUTFORMATTER *aOut, const wxString &aKey, bool aValue)
 
void FormatOptBool (OUTPUTFORMATTER *aOut, const wxString &aKey, std::optional< bool > aValue)
 
void FormatUuid (OUTPUTFORMATTER *aOut, const KIID &aUuid)
 
UTF8 FormatLibId (const LIB_ID &aId)
 
void FormatStreamData (OUTPUTFORMATTER &aOut, const wxStreamBuffer &aStream)
 
const char * LineStyleToken (LINE_STYLE aStyle)
 
void FormatStroke (OUTPUTFORMATTER *aOut, const STROKE_PARAMS &aStroke, const EDA_IU_SCALE &aScale)
 
const char * PageTypeToken (PAGE_SIZE_TYPE aType)
 
void FormatPageV9 (OUTPUTFORMATTER *aOut, const PAGE_INFO &aPage)
 
void FormatPageV10 (OUTPUTFORMATTER *aOut, const PAGE_INFO &aPage)
 
void FormatTitle (OUTPUTFORMATTER *aOut, const TITLE_BLOCK &aTitle)
 
void FormatText (OUTPUTFORMATTER *aOut, const EDA_TEXT &aText, const EDA_IU_SCALE &aScale, int aControlBits, bool aV9)
 
void FormatTextV9 (OUTPUTFORMATTER *aOut, const EDA_TEXT &aText, const EDA_IU_SCALE &aScale, int aControlBits)
 
void FormatTextV10 (OUTPUTFORMATTER *aOut, const EDA_TEXT &aText, const EDA_IU_SCALE &aScale, int aControlBits)
 
std::string EmbeddedFileChecksum (const EMBEDDED_FILES::EMBEDDED_FILE &aFile)
 
void FormatEmbeddedFiles (OUTPUTFORMATTER &aOut, const EMBEDDED_FILES &aFiles, bool aWriteData, bool aV9)
 
void FormatEmbeddedFilesV9 (OUTPUTFORMATTER &aOut, const EMBEDDED_FILES &aFiles, bool aWriteData)
 
void FormatEmbeddedFilesV10 (OUTPUTFORMATTER &aOut, const EMBEDDED_FILES &aFiles, bool aWriteData)
 
std::string FormatLayerSet (const LSET &aLayers)
 
int PlotFormatValue (PLOT_FORMAT aFormat)
 
void FormatPlot (OUTPUTFORMATTER *aOut, const PCB_PLOT_PARAMS &aPlot, bool aV9)
 
void FormatPlotV9 (OUTPUTFORMATTER *aOut, const PCB_PLOT_PARAMS &aPlot)
 
void FormatPlotV10 (OUTPUTFORMATTER *aOut, const PCB_PLOT_PARAMS &aPlot)
 
bool IsReviewedTuningValue (const wxAny &aValue, TUNING_PROPERTY_TYPE aType)
 
bool AreTuningPropertiesReviewed (const STRING_ANY_MAP &aProperties)
 
STRING_ANY_MAP TuningPropertiesForEra (const PCB_GENERATOR &aGenerator, bool aV9)
 
std::optional< bool > orderPoints (const VECTOR2I &aFirst, const VECTOR2I &aSecond)
 The released comparators ordered footprint graphics in board coordinates.
 
std::optional< bool > orderFpShapes (const PCB_SHAPE *aFirst, const PCB_SHAPE *aSecond)
 
std::optional< bool > orderFpTexts (const PCB_TEXT *aFirst, const PCB_TEXT *aSecond)
 

Variables

constexpr int OMIT_HIDE = 1 << 6
 
constexpr TUNING_PROPERTY TUNING_PROPERTIES []
 

Typedef Documentation

◆ FP_DRAWING_ORDER_V10

◆ FP_DRAWING_ORDER_V9

KiCad 9 ordered only shapes by geometry. KiCad 10 also ordered text by position.

Definition at line 156 of file legacy_item_order.h.

Enumeration Type Documentation

◆ TUNING_PROPERTY_TYPE

Enumerator
NUMBER 
BOOL 
TEXT 
POINT 
LINE_CHAIN 

Definition at line 33 of file legacy_tuning_pattern.h.

Function Documentation

◆ AreTuningPropertiesReviewed()

bool KICAD_FORMAT::LEGACY::AreTuningPropertiesReviewed ( const STRING_ANY_MAP & aProperties)
inline

◆ EmbeddedFileChecksum()

◆ FormatBool()

void KICAD_FORMAT::LEGACY::FormatBool ( OUTPUTFORMATTER * aOut,
const wxString & aKey,
bool aValue )
inline

Definition at line 60 of file legacy_format.h.

References OUTPUTFORMATTER::Print().

Referenced by SCH_WRITER_V10::Format(), SCH_WRITER_V9::Format(), PCB_WRITER_V10::format(), PCB_WRITER_V10::format(), PCB_WRITER_V10::format(), PCB_WRITER_V10::format(), PCB_WRITER_V10::format(), PCB_WRITER_V10::format(), PCB_WRITER_V10::format(), PCB_WRITER_V10::format(), PCB_WRITER_V10::format(), PCB_WRITER_V10::format(), PCB_WRITER_V10::format(), PCB_WRITER_V10::format(), PCB_WRITER_V10::format(), PCB_WRITER_V9::format(), PCB_WRITER_V9::format(), PCB_WRITER_V9::format(), PCB_WRITER_V9::format(), PCB_WRITER_V9::format(), PCB_WRITER_V9::format(), PCB_WRITER_V9::format(), PCB_WRITER_V9::format(), PCB_WRITER_V9::format(), PCB_WRITER_V9::format(), PCB_WRITER_V9::format(), PCB_WRITER_V9::format(), formatBoardStackupV10(), formatBoardStackupV9(), PCB_WRITER_V10::formatGeneral(), PCB_WRITER_V9::formatGeneral(), FormatOptBool(), FormatPlot(), PCB_WRITER_V10::formatSetup(), PCB_WRITER_V9::formatSetup(), PCB_WRITER_V10::formatTeardropParameters(), PCB_WRITER_V9::formatTeardropParameters(), FormatText(), libSaveField(), libSavePin(), libSavePin(), libSaveSymbol(), libSaveSymbol(), SCH_WRITER_V10::saveField(), SCH_WRITER_V9::saveField(), SCH_WRITER_V10::saveGroup(), SCH_WRITER_V10::saveRuleArea(), SCH_WRITER_V10::saveSheet(), SCH_WRITER_V9::saveSheet(), SCH_WRITER_V10::saveSymbol(), SCH_WRITER_V9::saveSymbol(), SCH_WRITER_V10::saveTable(), SCH_WRITER_V9::saveTable(), SCH_WRITER_V10::saveText(), SCH_WRITER_V9::saveText(), SCH_WRITER_V10::saveTextBox(), and SCH_WRITER_V9::saveTextBox().

◆ FormatEmbeddedFiles()

◆ FormatEmbeddedFilesV10()

void KICAD_FORMAT::LEGACY::FormatEmbeddedFilesV10 ( OUTPUTFORMATTER & aOut,
const EMBEDDED_FILES & aFiles,
bool aWriteData )
inline

◆ FormatEmbeddedFilesV9()

void KICAD_FORMAT::LEGACY::FormatEmbeddedFilesV9 ( OUTPUTFORMATTER & aOut,
const EMBEDDED_FILES & aFiles,
bool aWriteData )
inline

◆ FormatLayerSet()

std::string KICAD_FORMAT::LEGACY::FormatLayerSet ( const LSET & aLayers)
inline

Definition at line 30 of file legacy_pcb_plot_format.h.

References index, result, and THROW_IO_ERROR.

Referenced by FormatPlot().

◆ FormatLibId()

◆ FormatOptBool()

void KICAD_FORMAT::LEGACY::FormatOptBool ( OUTPUTFORMATTER * aOut,
const wxString & aKey,
std::optional< bool > aValue )
inline

Definition at line 66 of file legacy_format.h.

References FormatBool(), and OUTPUTFORMATTER::Print().

Referenced by PCB_WRITER_V10::format(), and PCB_WRITER_V10::format().

◆ FormatPageV10()

◆ FormatPageV9()

◆ FormatPlot()

void KICAD_FORMAT::LEGACY::FormatPlot ( OUTPUTFORMATTER * aOut,
const PCB_PLOT_PARAMS & aPlot,
bool aV9 )
inline

Definition at line 79 of file legacy_pcb_plot_format.h.

References FormatBool(), FormatDouble2Str(), FormatLayerSet(), PCB_PLOT_PARAMS::GetA4Output(), PCB_PLOT_PARAMS::GetBlackAndWhite(), PCB_PLOT_PARAMS::GetCreateGerberJobFile(), PCB_PLOT_PARAMS::GetCrossoutDNPFPsOnFabLayers(), PCB_PLOT_PARAMS::GetDashedLineDashRatio(), PCB_PLOT_PARAMS::GetDashedLineGapRatio(), PCB_PLOT_PARAMS::GetDisableGerberMacros(), PCB_PLOT_PARAMS::GetDrillMarksType(), PCB_PLOT_PARAMS::GetDXFPlotMode(), PCB_PLOT_PARAMS::GetDXFPlotPolygonMode(), PCB_PLOT_PARAMS::GetDXFPlotUnits(), PCB_PLOT_PARAMS::GetFormat(), PCB_PLOT_PARAMS::GetGerberPrecision(), PCB_PLOT_PARAMS::GetHideDNPFPsOnFabLayers(), PCB_PLOT_PARAMS::GetIncludeGerberNetlistInfo(), PCB_PLOT_PARAMS::GetLayerSelection(), PCB_PLOT_PARAMS::GetMirror(), PCB_PLOT_PARAMS::GetNegative(), PCB_PLOT_PARAMS::GetOutputDirectory(), PCB_PLOT_PARAMS::GetPlotFrameRef(), PCB_PLOT_PARAMS::GetPlotOnAllLayersSequence(), PCB_PLOT_PARAMS::GetPlotPadNumbers(), PCB_PLOT_PARAMS::GetScaleSelection(), PCB_PLOT_PARAMS::GetSketchDNPFPsOnFabLayers(), PCB_PLOT_PARAMS::GetSketchPadsOnFabLayers(), PCB_PLOT_PARAMS::GetSubtractMaskFromSilk(), PCB_PLOT_PARAMS::GetSvgPrecision(), PCB_PLOT_PARAMS::GetTextMode(), PCB_PLOT_PARAMS::GetUseAuxOrigin(), PCB_PLOT_PARAMS::GetUseGerberProtelExtensions(), PCB_PLOT_PARAMS::GetUseGerberX2format(), INCH, PCB_PLOT_PARAMS::m_PDFBackFPPropertyPopups, PCB_PLOT_PARAMS::m_PDFFrontFPPropertyPopups, PCB_PLOT_PARAMS::m_PDFMetadata, PCB_PLOT_PARAMS::m_PDFSingle, NATIVE, PlotFormatValue(), OUTPUTFORMATTER::Print(), OUTPUTFORMATTER::Quotew(), BASE_SET::set(), and SKETCH.

Referenced by FormatPlotV10(), and FormatPlotV9().

◆ FormatPlotV10()

void KICAD_FORMAT::LEGACY::FormatPlotV10 ( OUTPUTFORMATTER * aOut,
const PCB_PLOT_PARAMS & aPlot )
inline

Definition at line 154 of file legacy_pcb_plot_format.h.

References FormatPlot().

Referenced by PCB_WRITER_V10::formatSetup().

◆ FormatPlotV9()

void KICAD_FORMAT::LEGACY::FormatPlotV9 ( OUTPUTFORMATTER * aOut,
const PCB_PLOT_PARAMS & aPlot )
inline

Definition at line 148 of file legacy_pcb_plot_format.h.

References FormatPlot().

Referenced by PCB_WRITER_V9::formatSetup().

◆ FormatStreamData()

void KICAD_FORMAT::LEGACY::FormatStreamData ( OUTPUTFORMATTER & aOut,
const wxStreamBuffer & aStream )
inline

◆ FormatStroke()

◆ FormatText()

◆ FormatTextV10()

void KICAD_FORMAT::LEGACY::FormatTextV10 ( OUTPUTFORMATTER * aOut,
const EDA_TEXT & aText,
const EDA_IU_SCALE & aScale,
int aControlBits )
inline

◆ FormatTextV9()

void KICAD_FORMAT::LEGACY::FormatTextV9 ( OUTPUTFORMATTER * aOut,
const EDA_TEXT & aText,
const EDA_IU_SCALE & aScale,
int aControlBits )
inline

◆ FormatTitle()

◆ FormatUuid()

void KICAD_FORMAT::LEGACY::FormatUuid ( OUTPUTFORMATTER * aOut,
const KIID & aUuid )
inline

◆ IsDefaultTextV10()

◆ IsReviewedTuningValue()

bool KICAD_FORMAT::LEGACY::IsReviewedTuningValue ( const wxAny & aValue,
TUNING_PROPERTY_TYPE aType )
inline

Definition at line 87 of file legacy_tuning_pattern.h.

References BOOL, LINE_CHAIN, NUMBER, POINT, and TEXT.

Referenced by AreTuningPropertiesReviewed().

◆ LineStyleToken()

const char * KICAD_FORMAT::LEGACY::LineStyleToken ( LINE_STYLE aStyle)
inline

Definition at line 108 of file legacy_format.h.

References DASH, DASHDOT, DASHDOTDOT, DEFAULT, DOT, SOLID, and THROW_IO_ERROR.

Referenced by FormatStroke().

◆ orderFpShapes()

◆ orderFpTexts()

◆ orderPoints()

std::optional< bool > KICAD_FORMAT::LEGACY::orderPoints ( const VECTOR2I & aFirst,
const VECTOR2I & aSecond )
inline

The released comparators ordered footprint graphics in board coordinates.

The current one uses library coordinates, which sorts a flipped or rotated footprint's items differently, so the frozen writers need the target's own ordering to reproduce its output.

Definition at line 23 of file legacy_item_order.h.

References VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by orderFpShapes(), and orderFpTexts().

◆ PageTypeToken()

const char * KICAD_FORMAT::LEGACY::PageTypeToken ( PAGE_SIZE_TYPE aType)
inline

Definition at line 145 of file legacy_format.h.

References A, A0, A1, A2, A3, A4, A5, B, C, D, E, GERBER, THROW_IO_ERROR, User, USLedger, USLegal, and USLetter.

Referenced by FormatPageV10(), and FormatPageV9().

◆ PlotFormatValue()

int KICAD_FORMAT::LEGACY::PlotFormatValue ( PLOT_FORMAT aFormat)
inline

Definition at line 63 of file legacy_pcb_plot_format.h.

References DXF, GERBER, HPGL, PDF, POST, SVG, THROW_IO_ERROR, and UNDEFINED.

Referenced by FormatPlot().

◆ TuningPropertiesForEra()

STRING_ANY_MAP KICAD_FORMAT::LEGACY::TuningPropertiesForEra ( const PCB_GENERATOR & aGenerator,
bool aV9 )
inline

Variable Documentation

◆ OMIT_HIDE

int KICAD_FORMAT::LEGACY::OMIT_HIDE = 1 << 6
inlineconstexpr

◆ TUNING_PROPERTIES

TUNING_PROPERTY KICAD_FORMAT::LEGACY::TUNING_PROPERTIES[]
inlineconstexpr

Definition at line 53 of file legacy_tuning_pattern.h.

Referenced by AreTuningPropertiesReviewed(), and TuningPropertiesForEra().