30#include <wx/mstream.h>
58#include <schematic_lexer.h>
67#include <boost/algorithm/string/join.hpp>
69using namespace TSCHEMATIC_T;
72#define SCH_PARSE_ERROR( text, reader, pos ) \
73 THROW_PARSE_ERROR( text, reader.GetSource(), reader.Line(), \
74 reader.LineNumber(), pos - reader.Line() )
78 m_progressReporter( nullptr )
106 wxASSERT( !aFileName || aSchematic !=
nullptr );
111 wxFileName fn = aFileName;
116 wxASSERT( fn.IsAbsolute() );
126 if( !normedFn.IsAbsolute() )
128 if( aFileName.Right( normedFn.GetFullPath().Length() ) == normedFn.GetFullPath() )
129 m_path = aFileName.Left( aFileName.Length() - normedFn.GetFullPath().Length() );
143 init( aSchematic, aProperties );
145 if( aAppendToMe ==
nullptr )
148 std::unique_ptr<SCH_SHEET> newSheet = std::make_unique<SCH_SHEET>( aSchematic );
150 wxFileName relPath( aFileName );
156 newSheet->SetFileName( relPath.GetFullPath() );
161 sheet = newSheet.release();
166 wxCHECK_MSG( aSchematic->
IsValid(),
nullptr,
"Can't append to a schematic with no root!" );
195 if( !fileName.IsAbsolute() )
204 wxLogTrace(
traceSchPlugin,
"Loading '%s'", fileName.GetFullPath() );
208 while( !ancestorSheetPath.
empty() )
215 m_error += wxString::Format(
_(
"Could not load sheet '%s' because it already "
216 "appears as a direct ancestor in the schematic "
218 fileName.GetFullPath() );
220 fileName = wxEmptyString;
228 if( ancestorSheetPath.
empty() )
249 loadFile( fileName.GetFullPath(), aSheet );
264 if( fileName.FileExists() )
302 size_t lineCount = 0;
338 wxCHECK_RET( aSheet !=
nullptr,
"NULL SCH_SHEET object." );
339 wxCHECK_RET( !aFileName.IsEmpty(),
"No schematic file name defined." );
343 init( aSchematic, aProperties );
345 wxFileName fn = aFileName;
349 wxASSERT( fn.IsAbsolute() );
364 wxCHECK_RET( aSheet !=
nullptr,
"NULL SCH_SHEET* object." );
365 wxCHECK_RET(
m_schematic !=
nullptr,
"NULL SCHEMATIC* object." );
371 m_out->
Print( 0,
"(kicad_sch (version %d) (generator \"eeschema\") (generator_version \"%s\")\n\n",
383 for(
const auto& [ libItemName, libSymbol ] : screen->
GetLibSymbols() )
388 for(
const std::shared_ptr<BUS_ALIAS>& alias : screen->
GetBusAliases() )
395 if( a->
Type() != b->Type() )
396 return a->
Type() < b->Type();
398 return a->
m_Uuid < b->m_Uuid;
401 std::multiset<
SCH_ITEM*,
decltype( cmp )> save_map( cmp );
407 save_map.insert( item );
415 if( itemType != item->Type() )
417 itemType = item->Type();
427 switch( item->Type() )
457 if( layer != item->GetLayer() )
461 layer = item->GetLayer();
465 layer = item->GetLayer();
490 wxASSERT(
"Unexpected schematic object type in SCH_SEXPR_PLUGIN::Format()" );
496 std::vector< SCH_SHEET_INSTANCE> instances;
510 wxCHECK( aSelection && aSelectionPath && aFormatter, );
520 std::map<wxString, LIB_SYMBOL*> libSymbols;
523 for( i = 0; i < aSelection->
GetSize(); ++i )
527 wxCHECK2( item,
continue );
534 wxCHECK2( symbol,
continue );
544 libSymbols[ libSymbolLookup ] = it->second;
547 if( !libSymbols.empty() )
551 for(
const std::pair<const wxString, LIB_SYMBOL*>& libSymbol : libSymbols )
557 for( i = 0; i < aSelection->
GetSize(); ++i )
561 switch( item->
Type() )
610 wxASSERT(
"Unexpected schematic object type in SCH_SEXPR_PLUGIN::Format()" );
617 int aNestLevel,
bool aForClipboard,
620 wxCHECK_RET( aSymbol !=
nullptr &&
m_out !=
nullptr,
"" );
629 if( symbol_name.size() )
635 libName =
"_NONAME_";
658 m_out->
Print( 0,
" (lib_id %s) (at %s %s %s)",
669 if( mirrorX || mirrorY )
688 if( aForClipboard && aRelativePath )
693 unit = unitInstance.
m_Unit;
703 m_out->
Print( aNestLevel + 1,
"(exclude_from_sim %s)",
710 m_out->
Print( 0,
" (fields_autoplaced yes)" );
720 int id = field.GetId();
721 wxString value = field.GetText();
757 field.SetText( value );
763 field.SetText( value );
766 for(
const std::unique_ptr<SCH_PIN>&
pin : aSymbol->
GetRawPins() )
768 if(
pin->GetAlt().IsEmpty() )
778 m_out->
Print( aNestLevel + 1,
" (alternate %s))\n",
785 m_out->
Print( aNestLevel + 1,
"(instances\n" );
787 KIID lastProjectUuid;
790 bool project_open =
false;
810 project_open =
false;
818 wxString projectName;
826 m_out->
Print( aNestLevel + 2,
"(project %s\n",
834 if( aForClipboard && aRelativePath )
841 m_out->
Print( aNestLevel + 4,
"(reference %s) (unit %d)\n",
850 project_open =
false;
863 wxCHECK_RET( aField !=
nullptr &&
m_out !=
nullptr,
"" );
869 if( aField->
GetId() == -1 )
873 if( !aField->
GetName().IsEmpty() )
884 m_out->
Print( aNestLevel,
"(property %s %s (at %s %s %s)",
915 wxCHECK_RET( aBitmap !=
nullptr &&
m_out !=
nullptr,
"" );
919 wxCHECK_RET(
image !=
nullptr,
"wxImage* is NULL" );
921 m_out->
Print( aNestLevel,
"(image (at %s %s)",
950#define MIME_BASE64_LENGTH 76
954 while( first < out.Length() )
969 wxCHECK_RET( aSheet !=
nullptr &&
m_out !=
nullptr,
"" );
971 m_out->
Print( aNestLevel,
"(sheet (at %s %s) (size %s %s)",
982 m_out->
Print( 0,
" (fields_autoplaced yes)" );
993 m_out->
Print( aNestLevel + 1,
"(fill (color %d %d %d %0.4f))\n",
1010 m_out->
Print( aNestLevel + 1,
"(pin %s %s (at %s %s %s)\n",
1014 pin->GetPosition().x ).c_str(),
1016 pin->GetPosition().y ).c_str(),
1019 pin->Format(
m_out, aNestLevel + 1, 0 );
1027 std::vector< SCH_SHEET_INSTANCE > sheetInstances = aSheet->
GetInstances();
1029 auto it = sheetInstances.begin();
1031 while( it != sheetInstances.end() )
1033 if( it->m_Path.size() == 0 )
1034 it = sheetInstances.erase( it );
1039 if( !sheetInstances.empty() )
1041 m_out->
Print( aNestLevel + 1,
"(instances\n" );
1043 KIID lastProjectUuid;
1046 bool project_open =
false;
1048 for(
size_t i = 0; i < sheetInstances.size(); i++ )
1055 if( ( sheetInstances[i].m_Path[0] == rootSheetUuid )
1058 if( project_open && ( ( i + 1 == sheetInstances.size() )
1059 || lastProjectUuid != sheetInstances[i+1].m_Path[0] ) )
1062 project_open =
false;
1068 if( lastProjectUuid != sheetInstances[i].m_Path[0] )
1070 wxString projectName;
1072 if( sheetInstances[i].m_Path[0] == rootSheetUuid )
1075 projectName = sheetInstances[i].m_ProjectName;
1077 lastProjectUuid = sheetInstances[i].m_Path[0];
1078 m_out->
Print( aNestLevel + 2,
"(project %s\n",
1080 project_open =
true;
1083 wxString
path = sheetInstances[i].m_Path.AsString();
1085 m_out->
Print( aNestLevel + 3,
"(path %s (page %s))\n",
1087 m_out->
Quotew( sheetInstances[i].m_PageNumber ).c_str() );
1089 if( project_open && ( ( i + 1 == sheetInstances.size() )
1090 || lastProjectUuid != sheetInstances[i+1].m_Path[0] ) )
1093 project_open =
false;
1106 wxCHECK_RET( aJunction !=
nullptr &&
m_out !=
nullptr,
"" );
1108 m_out->
Print( aNestLevel,
"(junction (at %s %s) (diameter %s) (color %d %d %d %s)\n",
1128 wxCHECK_RET( aNoConnect !=
nullptr &&
m_out !=
nullptr,
"" );
1130 m_out->
Print( aNestLevel,
"(no_connect (at %s %s)",
1142 wxCHECK_RET( aBusEntry !=
nullptr &&
m_out !=
nullptr,
"" );
1145 if( aBusEntry->
GetClass() ==
"SCH_BUS_BUS_ENTRY" )
1150 saveLine( &busEntryLine, aNestLevel );
1154 m_out->
Print( aNestLevel,
"(bus_entry (at %s %s) (size %s %s)\n",
1162 aBusEntry->
GetSize().
y ).c_str() );
1177 wxCHECK_RET( aShape !=
nullptr &&
m_out !=
nullptr,
"" );
1186 case SHAPE_T::CIRCLE:
1191 case SHAPE_T::RECTANGLE:
1196 case SHAPE_T::BEZIER:
1214 wxCHECK_RET( aLine !=
nullptr &&
m_out !=
nullptr,
"" );
1222 case LAYER_BUS: lineType =
"bus";
break;
1229 m_out->
Print( aNestLevel,
"(%s (pts (xy %s %s) (xy %s %s))\n",
1251 wxCHECK_RET( aText !=
nullptr &&
m_out !=
nullptr,
"" );
1270 flag->GetPinLength() ).c_str() );
1296 if( aText->
GetText().Length() < 50 )
1308 m_out->
Print( aNestLevel + 1,
"(at %s %s %s)",
1317 m_out->
Print( 0,
" (fields_autoplaced yes)" );
1320 aText->EDA_TEXT::Format(
m_out, aNestLevel, 0 );
1336 wxCHECK_RET( aTextBox !=
nullptr &&
m_out !=
nullptr,
"" );
1344 m_out->
Print( aNestLevel + 1,
"(exclude_from_sim %s) (at %s %s %s) (size %s %s)\n",
1357 aTextBox->EDA_TEXT::Format(
m_out, aNestLevel, 0 );
1368 wxCHECK_RET( aAlias !=
nullptr,
"BUS_ALIAS* is NULL" );
1372 for(
const wxString& member : aAlias->Members() )
1374 if( !members.IsEmpty() )
1375 members += wxS(
" " );
1380 m_out->
Print( aNestLevel,
"(bus_alias %s (members %s))\n",
1389 if( aInstances.size() )
1392 m_out->
Print( aNestLevel,
"(sheet_instances\n" );
1396 wxString
path = instance.m_Path.AsString();
1398 if(
path.IsEmpty() )
1401 m_out->
Print( aNestLevel + 1,
"(path %s (page %s))\n",
1443 const wxString& aLibraryPath,
1448 bool powerSymbolsOnly = ( aProperties &&
1451 cacheLib( aLibraryPath, aProperties );
1455 for( LIB_SYMBOL_MAP::const_iterator it = symbols.begin(); it != symbols.end(); ++it )
1457 if( !powerSymbolsOnly || it->second->IsPower() )
1458 aSymbolNameList.Add( it->first );
1464 const wxString& aLibraryPath,
1469 bool powerSymbolsOnly = ( aProperties &&
1472 cacheLib( aLibraryPath, aProperties );
1476 for( LIB_SYMBOL_MAP::const_iterator it = symbols.begin(); it != symbols.end(); ++it )
1478 if( !powerSymbolsOnly || it->second->IsPower() )
1479 aSymbolList.push_back( it->second );
1489 cacheLib( aLibraryPath, aProperties );
1491 LIB_SYMBOL_MAP::const_iterator it =
m_cache->
m_symbols.find( aSymbolName );
1497 if( it ==
m_cache->
m_symbols.end() && aSymbolName.Contains( wxT(
"{slash}" ) ) )
1499 wxString unescaped = aSymbolName;
1500 unescaped.Replace( wxT(
"{slash}" ), wxT(
"/" ) );
1516 cacheLib( aLibraryPath, aProperties );
1530 cacheLib( aLibraryPath, aProperties );
1542 if( wxFileExists( aLibraryPath ) )
1544 THROW_IO_ERROR( wxString::Format(
_(
"Symbol library '%s' already exists." ),
1545 aLibraryPath.GetData() ) );
1561 wxFileName fn = aLibraryPath;
1563 if( !fn.FileExists() )
1568 if( wxRemove( aLibraryPath ) )
1570 THROW_IO_ERROR( wxString::Format(
_(
"Symbol library '%s' cannot be deleted." ),
1571 aLibraryPath.GetData() ) );
1605 wxFileName fn( aLibraryPath );
1607 return ( fn.FileExists() && fn.IsFileWritable() ) || fn.IsDirWritable();
1618 std::set<wxString> fieldNames;
1620 for( LIB_SYMBOL_MAP::const_iterator it = symbols.begin(); it != symbols.end(); ++it )
1622 std::vector<LIB_FIELD*> fields;
1623 it->second->GetFields( fields );
1627 if( field->IsMandatory() )
1632 fieldNames.insert( field->GetName() );
1636 std::copy( fieldNames.begin(), fieldNames.end(), std::back_inserter( aNames ) );
1647 std::string aSource,
1654 std::vector<LIB_SYMBOL*> newSymbols;
1655 std::unique_ptr<STRING_LINE_READER> reader = std::make_unique<STRING_LINE_READER>( aSymbolText, aSource );
1661 newSymbol = parser.
ParseSymbol( map, aFileVersion );
1664 newSymbols.emplace_back( newSymbol );
constexpr EDA_IU_SCALE schIUScale
wxString GetMajorMinorVersion()
Get only the major and minor version in a string major.minor.
This class handle bitmap images in KiCad.
const wxMemoryBuffer & GetImageDataBuffer() const
KICAD_T Type() const
Returns the type of object.
virtual void SetParent(EDA_ITEM *aParent)
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
int GetTextHeight() const
bool IsDefaultFormatting() const
const EDA_ANGLE & GetTextAngle() const
virtual const wxString & GetText() const
Return the string associated with the text object.
virtual void Format(OUTPUTFORMATTER *aFormatter, int aNestLevel, int aControlBits) const
Output the object to aFormatter in s-expression form.
EE_TYPE OfType(KICAD_T aType) 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.
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()
bool MakeRelativeTo(const KIID_PATH &aPath)
wxString AsString() const
Field object used in symbol libraries.
Define a library symbol object.
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.
void Format(OUTPUTFORMATTER *aFormatter, int aNestLevel, int aControlBits) const
Output the page class to aFormatter in s-expression form.
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.
virtual const wxString GetProjectPath() const
Return the full path of the project.
virtual const wxString GetProjectName() const
Return the short name of the project.
Holds all the data relating to one schematic.
SCH_SHEET_LIST GetSheets() const override
Builds and returns an updated schematic hierarchy TODO: can this be cached?
bool IsValid() const
A simple test if the schematic is loaded, not a complete one.
PROJECT & Prj() const override
Return a reference to the project this schematic is part of.
Object to handle a bitmap image that can be inserted in a schematic.
VECTOR2I GetPosition() const override
BITMAP_BASE * GetImage() const
Base class for a bus or wire entry.
VECTOR2I GetPosition() const override
virtual STROKE_PARAMS GetStroke() const override
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
VECTOR2I GetPosition() const override
wxString GetCanonicalName() const
Get a non-language-specific name for a field which can be used for storage, variable look-up,...
wxString GetName(bool aUseDefaultName=true) const
Return the field name (not translated).
bool CanAutoplace() const
Base class for any item which can be embedded within the SCHEMATIC container class,...
virtual wxString GetClass() const override
Return the class name.
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
FIELDS_AUTOPLACED GetFieldsAutoplaced() const
Return whether the fields have been automatically placed.
VECTOR2I GetPosition() const override
SPIN_STYLE GetSpinStyle() const
LABEL_FLAG_SHAPE GetShape() const
std::vector< SCH_FIELD > & GetFields()
bool IsFile(const wxString &aFullPathAndFileName) const
wxString GetFileName() const
bool IsFileChanged() const
void SetFileName(const wxString &aFileName)
virtual void AddSymbol(const LIB_SYMBOL *aSymbol)
void SetModified(bool aModified=true)
Segment description base class to describe items which have 2 end points (track, wire,...
virtual STROKE_PARAMS GetStroke() const override
VECTOR2I GetEndPoint() const
VECTOR2I GetStartPoint() const
void SetEndPoint(const VECTOR2I &aPosition)
VECTOR2I GetPosition() const override
const PAGE_INFO & GetPageSettings() const
auto & GetBusAliases() const
Return a set of bus aliases defined in this screen.
const std::map< wxString, LIB_SYMBOL * > & GetLibSymbols() const
Fetch a list of unique LIB_SYMBOL object pointers required to properly render each SCH_SYMBOL in this...
EE_RTREE & Items()
Gets the full RTree, usually for iterating.
const wxString & GetFileName() const
void SetFileName(const wxString &aFileName)
Set the file name for this screen to aFileName.
const TITLE_BLOCK & GetTitleBlock() const
KIID m_uuid
A unique identifier for each schematic file.
void SetFileReadOnly(bool aIsReadOnly)
void SetFileExists(bool aFileExists)
Object to parser s-expression symbol library and schematic file formats.
void ParseSchematic(SCH_SHEET *aSheet, bool aIsCopyablyOnly=false, int aFileVersion=SEXPR_SCHEMATIC_FILE_VERSION)
Parse the internal LINE_READER object into aSheet.
LIB_SYMBOL * ParseSymbol(LIB_SYMBOL_MAP &aSymbolLibMap, int aFileVersion=SEXPR_SYMBOL_LIB_FILE_VERSION)
Parse internal LINE_READER object into symbols and return all found.
A cache assistant for the KiCad s-expression symbol libraries.
static void SaveSymbol(LIB_SYMBOL *aSymbol, OUTPUTFORMATTER &aFormatter, int aNestLevel=0, const wxString &aLibName=wxEmptyString)
void Save(const std::optional< bool > &aOpt=std::nullopt) override
Save the entire library to file m_libFileName;.
void DeleteSymbol(const wxString &aName) override
wxString m_error
For throwing exceptions or errors on partial loads.
void saveBusAlias(std::shared_ptr< BUS_ALIAS > aAlias, int aNestLevel)
void GetDefaultSymbolFields(std::vector< wxString > &aNames) override
Retrieves a list of (custom) field names that should be shown by default for this library in the symb...
SCH_SHEET_PATH m_currentSheetPath
void cacheLib(const wxString &aLibraryFileName, const STRING_UTF8_MAP *aProperties)
wxString m_path
Root project path for loading child sheets.
void saveField(SCH_FIELD *aField, int aNestLevel)
void saveTextBox(SCH_TEXTBOX *aText, int aNestLevel)
OUTPUTFORMATTER * m_out
The formatter for saving SCH_SCREEN objects.
void Format(SCH_SHEET *aSheet)
void SaveSymbol(const wxString &aLibraryPath, const LIB_SYMBOL *aSymbol, const STRING_UTF8_MAP *aProperties=nullptr) override
Write aSymbol to an existing library located at aLibraryPath.
static void FormatLibSymbol(LIB_SYMBOL *aPart, OUTPUTFORMATTER &aFormatter)
void SaveLibrary(const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr) override
void GetAvailableSymbolFields(std::vector< wxString > &aNames) override
Retrieves a list of (custom) field names that are present on symbols in this library.
bool DeleteSymbolLib(const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr) override
Delete an existing symbol library and returns true if successful, or if library does not exist return...
std::stack< wxString > m_currentPath
Stack to maintain nested sheet paths.
void loadFile(const wxString &aFileName, SCH_SHEET *aSheet)
void saveLine(SCH_LINE *aLine, int aNestLevel)
void saveInstances(const std::vector< SCH_SHEET_INSTANCE > &aSheets, int aNestLevel)
virtual ~SCH_SEXPR_PLUGIN()
bool m_appending
Schematic load append status.
SCH_SHEET * m_rootSheet
The root sheet of the schematic being loaded.
void DeleteSymbol(const wxString &aLibraryPath, const wxString &aSymbolName, const STRING_UTF8_MAP *aProperties=nullptr) override
Delete the entire LIB_SYMBOL associated with aAliasName from the library aLibraryPath.
SCH_SHEET * LoadSchematicFile(const wxString &aFileName, SCHEMATIC *aSchematic, SCH_SHEET *aAppendToMe=nullptr, const STRING_UTF8_MAP *aProperties=nullptr) override
Load information from some input file format that this SCH_PLUGIN implementation knows about,...
void saveText(SCH_TEXT *aText, int aNestLevel)
void EnumerateSymbolLib(wxArrayString &aSymbolNameList, const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr) override
Populate a list of LIB_SYMBOL alias names contained within the library aLibraryPath.
void saveSheet(SCH_SHEET *aSheet, int aNestLevel)
SCH_SEXPR_PLUGIN_CACHE * m_cache
void CreateSymbolLib(const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr) override
Create a new empty symbol library at aLibraryPath.
void LoadContent(LINE_READER &aReader, SCH_SHEET *aSheet, int aVersion=SEXPR_SCHEMATIC_FILE_VERSION)
void saveSymbol(SCH_SYMBOL *aSymbol, const SCHEMATIC &aSchematic, int aNestLevel, bool aForClipboard, const SCH_SHEET_PATH *aRelativePath=nullptr)
bool IsSymbolLibWritable(const wxString &aLibraryPath) override
Return true if the library at aLibraryPath is writable.
void loadHierarchy(const SCH_SHEET_PATH &aParentSheetPath, SCH_SHEET *aSheet)
static std::vector< LIB_SYMBOL * > ParseLibSymbols(std::string &aSymbolText, std::string aSource, int aFileVersion=SEXPR_SCHEMATIC_FILE_VERSION)
bool isBuffering(const STRING_UTF8_MAP *aProperties)
PROGRESS_REPORTER * m_progressReporter
void init(SCHEMATIC *aSchematic, const STRING_UTF8_MAP *aProperties=nullptr)
initialize PLUGIN like a constructor would.
static const char * PropBuffering
The property used internally by the plugin to enable cache buffering which prevents the library file ...
void saveShape(SCH_SHAPE *aShape, int aNestLevel)
LIB_SYMBOL * LoadSymbol(const wxString &aLibraryPath, const wxString &aAliasName, const STRING_UTF8_MAP *aProperties=nullptr) override
Load a LIB_SYMBOL object having aPartName from the aLibraryPath containing a library format that this...
void saveBitmap(SCH_BITMAP *aBitmap, int aNestLevel)
void SaveSchematicFile(const wxString &aFileName, SCH_SHEET *aSheet, SCHEMATIC *aSchematic, const STRING_UTF8_MAP *aProperties=nullptr) override
Write aSchematic to a storage file in a format that this SCH_PLUGIN implementation knows about,...
void saveBusEntry(SCH_BUS_ENTRY_BASE *aBusEntry, int aNestLevel)
int m_version
Version of file being loaded.
int GetModifyHash() const override
Return the modification hash from the library cache.
void saveNoConnect(SCH_NO_CONNECT *aNoConnect, int aNestLevel)
void saveJunction(SCH_JUNCTION *aJunction, int aNestLevel)
STROKE_PARAMS GetStroke() const override
A container for handling SCH_SHEET_PATH objects in a flattened hierarchy.
std::optional< SCH_SHEET_PATH > GetSheetPathByKIIDPath(const KIID_PATH &aPath, bool aIncludeLastSheet=true) const
Finds a SCH_SHEET_PATH that matches the provided KIID_PATH.
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
bool empty() const
Forwarded method from std::vector.
KIID_PATH Path() const
Get the sheet path as an KIID_PATH.
SCH_SCREEN * LastScreen()
SCH_SHEET * at(size_t aIndex) const
Forwarded method from std::vector.
void push_back(SCH_SHEET *aSheet)
Forwarded method from std::vector.
void pop_back()
Forwarded method from std::vector.
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
wxString GetFileName() const
Return the filename corresponding to this sheet.
bool HasRootInstance() const
Check to see if this sheet has a root sheet instance.
std::vector< SCH_FIELD > & GetFields()
bool SearchHierarchy(const wxString &aFilename, SCH_SCREEN **aScreen)
Search the existing hierarchy for an instance of screen loaded from aFileName.
SCH_SCREEN * GetScreen() const
VECTOR2I GetPosition() const override
void SetScreen(SCH_SCREEN *aScreen)
Set the SCH_SCREEN associated with this sheet to aScreen.
const SCH_SHEET_INSTANCE & GetRootInstance() const
Return the root sheet instance data.
KIGFX::COLOR4D GetBorderColor() const
int GetBorderWidth() const
std::vector< SCH_SHEET_PIN * > & GetPins()
const std::vector< SCH_SHEET_INSTANCE > & GetInstances() const
KIGFX::COLOR4D GetBackgroundColor() const
std::vector< std::unique_ptr< SCH_PIN > > & GetRawPins()
const std::vector< SCH_SYMBOL_INSTANCE > & GetInstanceReferences() const
bool UseLibIdLookup() const
wxString GetSchSymbolLibraryName() const
SCH_FIELD * GetField(MANDATORY_FIELD_T aFieldType)
Return a mandatory field in this symbol.
bool GetExcludedFromBOM() const
VECTOR2I GetPosition() const override
bool GetExcludedFromSim() const override
bool GetInstance(SCH_SYMBOL_INSTANCE &aInstance, const KIID_PATH &aSheetPath, bool aTestFromEnd=false) const
int GetOrientation() const
Get the display symbol orientation.
const LIB_ID & GetLibId() const
bool GetExcludedFromBoard() const
void GetFields(std::vector< SCH_FIELD * > &aVector, bool aVisibleOnly)
Populate a std::vector with SCH_FIELDs.
void SortInstances(bool(*aSortFunction)(const SCH_SYMBOL_INSTANCE &aLhs, const SCH_SYMBOL_INSTANCE &aRhs))
bool GetExcludedFromSim() const override
VECTOR2I GetPosition() const override
bool GetExcludedFromSim() const override
virtual KIGFX::VIEW_ITEM * GetItem(unsigned int aIdx) const override
virtual unsigned int GetSize() const override
Return the number of stored items.
Is a LINE_READER that reads from a multiline 8 bit wide std::string.
A name/value tuple with unique names and optional values.
bool Exists(const std::string &aProperty) const
Simple container to manage line stroke parameters.
void SetWidth(int aWidth)
void Format(OUTPUTFORMATTER *out, const EDA_IU_SCALE &aIuScale, int nestLevel) const
static const char * PropPowerSymsOnly
virtual void Format(OUTPUTFORMATTER *aFormatter, int aNestLevel, int aControlBits) const
Output the object to aFormatter in s-expression form.
#define MIME_BASE64_LENGTH
static constexpr EDA_ANGLE & ANGLE_180
static constexpr EDA_ANGLE & ANGLE_90
static constexpr EDA_ANGLE & ANGLE_0
static constexpr EDA_ANGLE & ANGLE_270
#define DEFAULT_SIZE_TEXT
This is the "default-of-the-default" hardcoded text size; individual application define their own def...
const wxChar *const traceSchPlugin
Flag to enable legacy schematic plugin debug output.
#define THROW_IO_ERROR(msg)
wxString LayerName(int aLayer)
Returns the default display name for a given layer.
SCH_LAYER_ID
Eeschema drawing layers.
#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)
Converts aAngle from board units to a string appropriate for writing to file.
#define SEXPR_SCHEMATIC_FILE_VERSION
Schematic file version.
Schematic and symbol library s-expression file format parser definitions.
void formatCircle(OUTPUTFORMATTER *aFormatter, int aNestLevel, EDA_SHAPE *aCircle, bool aIsPrivate, const STROKE_PARAMS &aStroke, FILL_T aFillMode, const COLOR4D &aFillColor, const KIID &aUuid)
void formatArc(OUTPUTFORMATTER *aFormatter, int aNestLevel, EDA_SHAPE *aArc, bool aIsPrivate, const STROKE_PARAMS &aStroke, FILL_T aFillMode, const COLOR4D &aFillColor, const KIID &aUuid)
const char * getSheetPinShapeToken(LABEL_FLAG_SHAPE aShape)
void formatFill(OUTPUTFORMATTER *aFormatter, int aNestLevel, FILL_T aFillMode, const COLOR4D &aFillColor)
Fill token formatting helper.
const char * getTextTypeToken(KICAD_T aType)
void formatRect(OUTPUTFORMATTER *aFormatter, int aNestLevel, EDA_SHAPE *aRect, bool aIsPrivate, const STROKE_PARAMS &aStroke, FILL_T aFillMode, const COLOR4D &aFillColor, const KIID &aUuid)
void formatBezier(OUTPUTFORMATTER *aFormatter, int aNestLevel, EDA_SHAPE *aBezier, bool aIsPrivate, const STROKE_PARAMS &aStroke, FILL_T aFillMode, const COLOR4D &aFillColor, const KIID &aUuid)
void formatPoly(OUTPUTFORMATTER *aFormatter, int aNestLevel, EDA_SHAPE *aPolyLine, bool aIsPrivate, const STROKE_PARAMS &aStroke, FILL_T aFillMode, const COLOR4D &aFillColor, const KIID &aUuid)
EDA_ANGLE getSheetPinAngle(SHEET_SIDE aSide)
@ SHEET_MANDATORY_FIELDS
The first 2 are mandatory, and must be instantiated in SCH_SHEET.
bool SortSymbolInstancesByProjectUuid(const SCH_SYMBOL_INSTANCE &aLhs, const SCH_SYMBOL_INSTANCE &aRhs)
std::string toUTFTildaText(const wxString &txt)
Convert a wxString to UTF8 and replace any control characters with a ~, where a control character is ...
std::string FormatDouble2Str(double aValue)
Print a float number without using scientific notation and no trailing 0 This function is intended in...
std::string EscapedUTF8(const wxString &aString)
Return an 8 bit UTF8 string given aString in Unicode form.
wxString EscapeString(const wxString &aSource, ESCAPE_CONTEXT aContext)
The Escape/Unescape routines use HTML-entity-reference-style encoding to handle characters which are:...
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
constexpr int MilsToIU(int mils) const
A simple container for sheet instance information.
A simple container for schematic symbol instance information.
std::map< wxString, LIB_SYMBOL *, LibSymbolMapSort > LIB_SYMBOL_MAP
@ FOOTPRINT_FIELD
Field Name Module PCB, i.e. "16DIP300".
@ VALUE_FIELD
Field Value of part, i.e. "3.3K".
@ MANDATORY_FIELDS
The first 5 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors.
@ REFERENCE_FIELD
Field Reference of part, i.e. "IC21".
wxLogTrace helper definitions.
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".