22#include <fmt/format.h>
62 wxString::Format(
"Cannot use relative file paths in sexpr plugin to "
90 auto formatter = std::make_unique<PRETTIFIED_FILE_OUTPUTFORMATTER>( fn.GetFullPath() );
92 formatter->Print(
"(kicad_symbol_lib (version %d) (generator \"kicad_symbol_editor\") "
93 "(generator_version \"%s\")",
97 std::vector<LIB_SYMBOL*> orderedSymbols;
102 orderedSymbols.push_back( symbol );
106 std::sort( orderedSymbols.begin(), orderedSymbols.end(),
109 unsigned int lhDepth = aLhs->GetInheritanceDepth();
110 unsigned int rhDepth = aRhs->GetInheritanceDepth();
112 if( lhDepth == rhDepth )
113 return aLhs->GetName() < aRhs->GetName();
115 return lhDepth < rhDepth;
121 formatter->Print(
")" );
131 const wxString& aLibName,
bool aIncludeData )
133 wxCHECK_RET( aSymbol,
"Invalid LIB_SYMBOL pointer." );
143 std::vector<SCH_FIELD*> orderedFields;
147 if( !aLibName.IsEmpty() )
153 wxCHECK2( unitId.
Parse( aLibName ) < 0, );
160 aFormatter.
Print(
"(symbol %s",
name.c_str() );
163 aFormatter.
Print(
"(power global)" );
165 aFormatter.
Print(
"(power local)" );
172 aFormatter.
Print(
"(pin_numbers (hide yes))" );
177 aFormatter.
Print(
"(pin_names" );
181 aFormatter.
Print(
"(offset %s)",
189 aFormatter.
Print(
")" );
199 const std::vector<std::set<wxString>>& jumperGroups = aSymbol->
JumperPinGroups();
201 if( !jumperGroups.empty() )
203 aFormatter.
Print(
"(jumper_pin_groups" );
205 for(
const std::set<wxString>&
group : jumperGroups )
207 aFormatter.
Print(
"(" );
209 for(
const wxString& padName :
group )
210 aFormatter.
Print(
"%s ", aFormatter.
Quotew( padName ).c_str() );
212 aFormatter.
Print(
")" );
215 aFormatter.
Print(
")" );
240 std::sort( units.begin(), units.end(),
243 if( a.m_unit == b.m_unit )
244 return a.m_bodyStyle < b.m_bodyStyle;
246 return a.m_unit < b.m_unit;
255 aFormatter.
Print(
"(symbol %s_%d_%d\"",
264 aFormatter.
Print(
"(unit_name %s)", aFormatter.
Quotes(
name ).c_str() );
274 std::multiset<
SCH_ITEM*,
decltype( cmp )> save_map( cmp );
276 for(
SCH_ITEM* item : unit.m_items )
277 save_map.insert( item );
282 aFormatter.
Print(
")" );
292 std::shared_ptr<LIB_SYMBOL> parent = aSymbol->
GetParent().lock();
296 aFormatter.
Print(
"(symbol %s (extends %s)",
298 aFormatter.
Quotew( parent->GetName() ).c_str() );
308 aFormatter.
Print(
")" );
315 wxCHECK_RET( aSymbol,
"Invalid LIB_SYMBOL pointer." );
319 SCH_FIELD keywords(
nullptr, FIELD_T::USER, wxString(
"ki_keywords" ) );
327 if( !fpFilters.IsEmpty() )
331 for(
const wxString&
filter : fpFilters )
339 tmp +=
" " + curr_filter;
342 SCH_FIELD description(
nullptr, FIELD_T::USER, wxString(
"ki_fp_filters" ) );
352 wxCHECK_RET( aItem,
"Invalid SCH_ITEM pointer." );
354 switch( aItem->
Type() )
367 formatArc( &aFormatter, shape, isPrivate, stroke, fillMode, fillColor,
true );
370 case SHAPE_T::CIRCLE:
371 formatCircle( &aFormatter, shape, isPrivate, stroke, fillMode, fillColor,
true );
374 case SHAPE_T::RECTANGLE:
375 formatRect( &aFormatter, shape, isPrivate, stroke, fillMode, fillColor,
true );
378 case SHAPE_T::BEZIER:
379 formatBezier(&aFormatter, shape, isPrivate, stroke, fillMode, fillColor,
true );
383 formatPoly( &aFormatter, shape, isPrivate, stroke, fillMode, fillColor,
true );
413 wxCHECK_RET( aField && aField->
Type() ==
SCH_FIELD_T,
"Invalid SCH_FIELD object." );
415 wxString fieldName = aField->
GetName();
420 aFormatter.
Print(
"(property %s %s %s (at %s %s %s)",
422 aFormatter.
Quotew( fieldName ).c_str(),
431 aFormatter.
Print(
"(show_name)" );
434 aFormatter.
Print(
"(do_not_autoplace)" );
439 aField->
Format( &aFormatter, 0 );
440 aFormatter.
Print(
")" );
446 wxCHECK_RET( aPin && aPin->
Type() ==
SCH_PIN_T,
"Invalid SCH_PIN object." );
450 aFormatter.
Print(
"(pin %s %s (at %s %s %s) (length %s)",
465 aFormatter.
Print(
"(name %s (effects (font (size %s %s))))",
472 aFormatter.
Print(
"(number %s (effects (font (size %s %s))))",
480 for(
const std::pair<const wxString, SCH_PIN::ALT>& alt : aPin->
GetAlternates() )
485 if( alt.second.m_Name.IsEmpty() )
488 aFormatter.
Print(
"(alternate %s %s %s)",
489 aFormatter.
Quotew( alt.second.m_Name ).c_str(),
494 aFormatter.
Print(
")" );
500 wxCHECK_RET( aText && aText->
Type() ==
SCH_TEXT_T,
"Invalid SCH_TEXT object." );
502 aFormatter.
Print(
"(text %s %s (at %s %s %d)",
511 aText->EDA_TEXT::Format( &aFormatter, 0 );
512 aFormatter.
Print(
")" );
518 wxCHECK_RET( aTextBox && aTextBox->
Type() ==
SCH_TEXTBOX_T,
"Invalid SCH_TEXTBOX object." );
520 aFormatter.
Print(
"(text_box %s %s",
527 aFormatter.
Print(
"(at %s %s %s) (size %s %s) (margins %s %s %s %s)",
540 aTextBox->EDA_TEXT::Format( &aFormatter, 0 );
541 aFormatter.
Print(
")" );
547 LIB_SYMBOL_MAP::iterator it =
m_symbols.find( aSymbolName );
550 THROW_IO_ERROR( wxString::Format(
_(
"library %s does not contain a symbol named %s" ),
562 LIB_SYMBOL_MAP::iterator it1 =
m_symbols.begin();
566 if( it1->second->IsDerived()
567 && it1->second->GetParent().lock() == rootSymbol->
SharedPtr() )
constexpr EDA_IU_SCALE schIUScale
wxString GetMajorMinorVersion()
Get only the major and minor version in a string major.minor.
int AsTenthsOfADegree() const
KICAD_T Type() const
Returns the type of object.
void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
FILL_T GetFillMode() const
const VECTOR2I & GetEnd() const
Return the ending point of the graphic.
const VECTOR2I & GetStart() const
Return the starting point of the graphic.
COLOR4D GetFillColor() const
wxString SHAPE_T_asString() const
const EDA_ANGLE & GetTextAngle() const
virtual const wxString & GetText() const
Return the string associated with the text object.
virtual bool IsVisible() const
virtual void Format(OUTPUTFORMATTER *aFormatter, int aControlBits) const
Output the object to aFormatter in s-expression form.
virtual void SetVisible(bool aVisible)
void WriteEmbeddedFiles(OUTPUTFORMATTER &aOut, bool aWriteData) const
Output formatter for the embedded files.
void ClearEmbeddedFonts()
Remove all embedded fonts from the collection.
const std::map< wxString, EMBEDDED_FILE * > & EmbeddedFileMap() const
bool GetAreFontsEmbedded() const
A LINE_READER that reads from an open file.
A color representation with 4 components: red, green, blue, alpha.
A logical library item identifier and consists of various portions much like a URI.
int Parse(const UTF8 &aId, bool aFix=false)
Parse LIB_ID with the information from aId.
const UTF8 & GetLibItemName() const
Define a library symbol object.
const LIB_ID & GetLibId() const override
wxString GetKeyWords() const override
bool HasUnitDisplayName(int aUnit) const
Return true if the given unit aUnit has a display name defined.
void GetFields(std::vector< SCH_FIELD * > &aList, bool aVisibleOnly=false) const override
Populate a std::vector with SCH_FIELDs, sorted in ordinal order.
bool UnitsLocked() const
Check whether symbol units are interchangeable.
bool IsRoot() const override
For symbols derived from other symbols, IsRoot() indicates no derivation.
std::vector< struct LIB_SYMBOL_UNIT > GetUnitDrawItems()
Return a list of SCH_ITEM objects separated by unit and convert number.
bool IsLocalPower() const override
wxArrayString GetFPFilters() const
LIB_SYMBOL_SPTR SharedPtr() const
http://www.boost.org/doc/libs/1_55_0/libs/smart_ptr/sp_techniques.html#weak_without_shared.
EMBEDDED_FILES * GetEmbeddedFiles() override
bool IsGlobalPower() const override
bool GetDuplicatePinNumbersAreJumpers() const
LIB_SYMBOL_REF & GetParent()
std::vector< std::set< wxString > > & JumperPinGroups()
Each jumper pin group is a set of pin numbers that should be treated as internally connected.
wxString GetUnitDisplayName(int aUnit, bool aLabel) const override
Return the user-defined display name for aUnit for symbols with units.
void EmbedFonts() override
VECTOR2I GetPosition() const override
wxString GetName(bool aUseDefaultName=true) const
Return the field name (not translated).
bool CanAutoplace() const
void SetText(const wxString &aText) override
int m_fileFormatVersionAtLoad
static void saveSymbolDrawItem(SCH_ITEM *aItem, OUTPUTFORMATTER &aFormatter)
SCH_IO_KICAD_SEXPR_LIB_CACHE(const wxString &aLibraryPath)
static void saveDcmInfoAsFields(LIB_SYMBOL *aSymbol, OUTPUTFORMATTER &aFormatter)
virtual ~SCH_IO_KICAD_SEXPR_LIB_CACHE()
static void SaveSymbol(LIB_SYMBOL *aSymbol, OUTPUTFORMATTER &aFormatter, const wxString &aLibName=wxEmptyString, bool aIncludeData=true)
static void saveTextBox(SCH_TEXTBOX *aTextBox, OUTPUTFORMATTER &aFormatter)
static void saveField(SCH_FIELD *aField, OUTPUTFORMATTER &aFormatter)
void DeleteSymbol(const wxString &aName) override
static void savePin(SCH_PIN *aPin, OUTPUTFORMATTER &aFormatter)
static void saveText(SCH_TEXT *aText, OUTPUTFORMATTER &aFormatter)
void SetFileFormatVersionAtLoad(int aVersion)
void Save(const std::optional< bool > &aOpt=std::nullopt) override
Save the entire library to file m_libFileName;.
Object to parser s-expression symbol library and schematic file formats.
int GetParsedRequiredVersion() const
void ParseLib(LIB_SYMBOL_MAP &aSymbolLibMap)
A base cache assistant implementation for the symbol library portion of the SCH_IO API.
wxDateTime GetLibModificationTime()
wxFileName GetRealFile() const
void IncrementModifyHash()
Base class for any item which can be embedded within the SCHEMATIC container class,...
wxString GetClass() const override
Return the class name.
int GetNumberTextSize() const
const std::map< wxString, ALT > & GetAlternates() const
const wxString & GetName() const
PIN_ORIENTATION GetOrientation() const
VECTOR2I GetPosition() const override
int GetNameTextSize() const
const wxString & GetNumber() const
GRAPHIC_PINSHAPE GetShape() const
ELECTRICAL_PINTYPE GetType() const
STROKE_PARAMS GetStroke() const override
int GetMarginBottom() const
int GetMarginLeft() const
int GetMarginRight() const
VECTOR2I GetPosition() const override
Simple container to manage line stroke parameters.
void Format(OUTPUTFORMATTER *out, const EDA_IU_SCALE &aIuScale) const
int GetPinNameOffset() const
bool GetExcludedFromBoard() const override
virtual bool GetShowPinNames() const
virtual bool GetShowPinNumbers() const
bool GetExcludedFromBOM() const override
bool GetExcludedFromSim() const override
#define DEFAULT_PIN_NAME_OFFSET
The intersheets references prefix string.
#define IS_CHANGED
Item was edited, and modified.
const wxChar *const traceSchLegacyPlugin
Flag to enable legacy schematic plugin debug output.
#define THROW_IO_ERROR(msg)
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.
#define SEXPR_SYMBOL_LIB_FILE_VERSION
This file contains the file format version information for the s-expression schematic and symbol libr...
EDA_ANGLE getPinAngle(PIN_ORIENTATION aOrientation)
void formatArc(OUTPUTFORMATTER *aFormatter, EDA_SHAPE *aArc, bool aIsPrivate, const STROKE_PARAMS &aStroke, FILL_T aFillMode, const COLOR4D &aFillColor, bool aInvertY, const KIID &aUuid)
void formatCircle(OUTPUTFORMATTER *aFormatter, EDA_SHAPE *aCircle, bool aIsPrivate, const STROKE_PARAMS &aStroke, FILL_T aFillMode, const COLOR4D &aFillColor, bool aInvertY, const KIID &aUuid)
const char * getPinElectricalTypeToken(ELECTRICAL_PINTYPE aType)
void formatBezier(OUTPUTFORMATTER *aFormatter, EDA_SHAPE *aBezier, bool aIsPrivate, const STROKE_PARAMS &aStroke, FILL_T aFillMode, const COLOR4D &aFillColor, bool aInvertY, const KIID &aUuid)
void formatRect(OUTPUTFORMATTER *aFormatter, EDA_SHAPE *aRect, bool aIsPrivate, const STROKE_PARAMS &aStroke, FILL_T aFillMode, const COLOR4D &aFillColor, bool aInvertY, const KIID &aUuid)
void formatPoly(OUTPUTFORMATTER *aFormatter, EDA_SHAPE *aPolyLine, bool aIsPrivate, const STROKE_PARAMS &aStroke, FILL_T aFillMode, const COLOR4D &aFillColor, bool aInvertY, const KIID &aUuid)
void formatFill(OUTPUTFORMATTER *aFormatter, FILL_T aFillMode, const COLOR4D &aFillColor)
Fill token formatting helper.
const char * getPinShapeToken(GRAPHIC_PINSHAPE aShape)
wxString EscapeString(const wxString &aSource, ESCAPE_CONTEXT aContext)
The Escape/Unescape routines use HTML-entity-reference-style encoding to handle characters which are:...
constexpr int MilsToIU(int mils) const
wxString GetCanonicalFieldName(FIELD_T aFieldType)
wxLogTrace helper definitions.