KiCad PCB EDA Suite
SCH_LEGACY_PLUGIN Class Reference

A SCH_PLUGIN derivation for loading schematic files created before the new s-expression file format. More...

#include <sch_legacy_plugin.h>

Inheritance diagram for SCH_LEGACY_PLUGIN:
SCH_PLUGIN

Public Member Functions

 SCH_LEGACY_PLUGIN ()
 
virtual ~SCH_LEGACY_PLUGIN ()
 
const wxString GetName () const override
 Returns a brief hard coded name for this SCH_PLUGIN. More...
 
const wxString GetFileExtension () const override
 Returns the file extension for the SCH_PLUGIN. More...
 
int GetModifyHash () const override
 Return the modification hash from the library cache. More...
 
SCH_SHEETLoad (const wxString &aFileName, KIWAY *aKiway, SCH_SHEET *aAppendToMe=nullptr, const PROPERTIES *aProperties=nullptr) override
 Load information from some input file format that this SCH_PLUGIN implementation knows about, into either a new SCH_SHEET or an existing one. More...
 
void LoadContent (LINE_READER &aReader, SCH_SCREEN *aScreen, int version=EESCHEMA_VERSION)
 
void Save (const wxString &aFileName, SCH_SCREEN *aScreen, KIWAY *aKiway, const PROPERTIES *aProperties=nullptr) override
 Write aSchematic to a storage file in a format that this SCH_PLUGIN implementation knows about, or it can be used to write a portion of aSchematic to a special kind of export file. More...
 
void Format (SCH_SCREEN *aScreen)
 
void Format (SELECTION *aSelection, OUTPUTFORMATTER *aFormatter)
 
void EnumerateSymbolLib (wxArrayString &aAliasNameList, const wxString &aLibraryPath, const PROPERTIES *aProperties=nullptr) override
 Populate a list of LIB_PART alias names contained within the library aLibraryPath. More...
 
void EnumerateSymbolLib (std::vector< LIB_ALIAS * > &aAliasList, const wxString &aLibraryPath, const PROPERTIES *aProperties=nullptr) override
 Populate a list of LIB_PART aliases contained within the library aLibraryPath. More...
 
LIB_ALIASLoadSymbol (const wxString &aLibraryPath, const wxString &aAliasName, const PROPERTIES *aProperties=nullptr) override
 Load a LIB_ALIAS object having aAliasName from the aLibraryPath containing a library format that this SCH_PLUGIN knows about. More...
 
void SaveSymbol (const wxString &aLibraryPath, const LIB_PART *aSymbol, const PROPERTIES *aProperties=nullptr) override
 Write aSymbol to an existing library located at aLibraryPath. More...
 
void DeleteAlias (const wxString &aLibraryPath, const wxString &aAliasName, const PROPERTIES *aProperties=nullptr) override
 Delete aAliasName from the library at aLibraryPath. More...
 
void DeleteSymbol (const wxString &aLibraryPath, const wxString &aAliasName, const PROPERTIES *aProperties=nullptr) override
 Delete the entire LIB_PART associated with aAliasName from the library aLibraryPath. More...
 
void CreateSymbolLib (const wxString &aLibraryPath, const PROPERTIES *aProperties=nullptr) override
 Create a new empty symbol library at aLibraryPath. More...
 
bool DeleteSymbolLib (const wxString &aLibraryPath, const PROPERTIES *aProperties=nullptr) override
 Delete an existing symbol library and returns true if successful, or if library does not exist returns false, or throws an exception if library exists but is read only or cannot be deleted for some other reason. More...
 
void SaveLibrary (const wxString &aLibraryPath, const PROPERTIES *aProperties=nullptr) override
 
bool CheckHeader (const wxString &aFileName) override
 Return true if the first line in aFileName begins with the expected header. More...
 
bool IsSymbolLibWritable (const wxString &aLibraryPath) override
 Return true if the library at aLibraryPath is writable. More...
 
const wxString & GetError () const override
 Return an error string to the caller. More...
 
virtual void SymbolLibOptions (PROPERTIES *aListToAppendTo) const
 Append supported SCH_PLUGIN options to aListToAppenTo along with internationalized descriptions. More...
 

Static Public Member Functions

static LIB_PARTParsePart (LINE_READER &aReader, int majorVersion=0, int minorVersion=0)
 
static void FormatPart (LIB_PART *aPart, OUTPUTFORMATTER &aFormatter)
 

Static Public Attributes

static const char * PropBuffering = "buffering"
 const char* PropBuffering More...
 
static const char * PropNoDocFile = "no_doc_file"
 const char* PropBuffering More...
 

Protected Member Functions

void init (KIWAY *aKiway, const PROPERTIES *aProperties=nullptr)
 initialize PLUGIN like a constructor would. More...
 

Protected Attributes

int m_version
 Version of file being loaded. More...
 
wxString m_error
 For throwing exceptions or errors on partial schematic loads. More...
 
wxString m_path
 Root project path for loading child sheets. More...
 
std::stack< wxString > m_currentPath
 Stack to maintain nested sheet paths. More...
 
const PROPERTIESm_props
 Passed via Save() or Load(), no ownership, may be nullptr. More...
 
KIWAYm_kiway
 Required for path to legacy component libraries. More...
 
SCH_SHEETm_rootSheet
 The root sheet of the schematic being loaded.. More...
 
OUTPUTFORMATTERm_out
 The output formatter for saving SCH_SCREEN objects. More...
 
SCH_LEGACY_PLUGIN_CACHEm_cache
 

Private Member Functions

void loadHierarchy (SCH_SHEET *aSheet)
 
void loadHeader (LINE_READER &aReader, SCH_SCREEN *aScreen)
 
void loadPageSettings (LINE_READER &aReader, SCH_SCREEN *aScreen)
 
void loadFile (const wxString &aFileName, SCH_SCREEN *aScreen)
 
SCH_SHEETloadSheet (LINE_READER &aReader)
 
SCH_BITMAPloadBitmap (LINE_READER &aReader)
 
SCH_JUNCTIONloadJunction (LINE_READER &aReader)
 
SCH_NO_CONNECTloadNoConnect (LINE_READER &aReader)
 
SCH_LINEloadWire (LINE_READER &aReader)
 
SCH_BUS_ENTRY_BASEloadBusEntry (LINE_READER &aReader)
 
SCH_TEXTloadText (LINE_READER &aReader)
 
SCH_COMPONENTloadComponent (LINE_READER &aReader)
 
std::shared_ptr< BUS_ALIASloadBusAlias (LINE_READER &aReader, SCH_SCREEN *aScreen)
 
void saveComponent (SCH_COMPONENT *aComponent)
 
void saveField (SCH_FIELD *aField)
 
void saveBitmap (SCH_BITMAP *aBitmap)
 
void saveSheet (SCH_SHEET *aSheet)
 
void saveJunction (SCH_JUNCTION *aJunction)
 
void saveNoConnect (SCH_NO_CONNECT *aNoConnect)
 
void saveBusEntry (SCH_BUS_ENTRY_BASE *aBusEntry)
 
void saveLine (SCH_LINE *aLine)
 
void saveText (SCH_TEXT *aText)
 
void saveBusAlias (std::shared_ptr< BUS_ALIAS > aAlias)
 
void cacheLib (const wxString &aLibraryFileName)
 
bool writeDocFile (const PROPERTIES *aProperties)
 
bool isBuffering (const PROPERTIES *aProperties)
 

Detailed Description

A SCH_PLUGIN derivation for loading schematic files created before the new s-expression file format.

The legacy parser and formatter attempt to be compatible with the legacy file format. The original parser was very forgiving in that it would parse only part of a keyword. So "$C", "$Co", and "$Com" could be used for "$Comp" and the old parser would allow this. This parser is not that forgiving and sticks to the legacy file format document.

As with all SCH_PLUGINs there is no UI dependencies i.e. windowing calls allowed.

Definition at line 64 of file sch_legacy_plugin.h.

Constructor & Destructor Documentation

◆ SCH_LEGACY_PLUGIN()

SCH_LEGACY_PLUGIN::SCH_LEGACY_PLUGIN ( )

Definition at line 560 of file sch_legacy_plugin.cpp.

561 {
562  init( NULL );
563 }
void init(KIWAY *aKiway, const PROPERTIES *aProperties=nullptr)
initialize PLUGIN like a constructor would.

References init().

◆ ~SCH_LEGACY_PLUGIN()

SCH_LEGACY_PLUGIN::~SCH_LEGACY_PLUGIN ( )
virtual

Definition at line 566 of file sch_legacy_plugin.cpp.

567 {
568  delete m_cache;
569 }
SCH_LEGACY_PLUGIN_CACHE * m_cache

References m_cache.

Member Function Documentation

◆ cacheLib()

void SCH_LEGACY_PLUGIN::cacheLib ( const wxString &  aLibraryFileName)
private

Definition at line 4206 of file sch_legacy_plugin.cpp.

4207 {
4208  if( !m_cache || !m_cache->IsFile( aLibraryFileName ) || m_cache->IsFileChanged() )
4209  {
4210  // a spectacular episode in memory management:
4211  delete m_cache;
4212  m_cache = new SCH_LEGACY_PLUGIN_CACHE( aLibraryFileName );
4213 
4214  // Because m_cache is rebuilt, increment PART_LIBS::s_modify_generation
4215  // to modify the hash value that indicate component to symbol links
4216  // must be updated.
4218 
4219  if( !isBuffering( m_props ) )
4220  m_cache->Load();
4221  }
4222 }
static int s_modify_generation
helper for GetModifyHash()
SCH_LEGACY_PLUGIN_CACHE * m_cache
A cache assistant for the part library portion of the SCH_PLUGIN API, and only for the SCH_LEGACY_PLU...
bool isBuffering(const PROPERTIES *aProperties)
bool IsFile(const wxString &aFullPathAndFileName) const
const PROPERTIES * m_props
Passed via Save() or Load(), no ownership, may be nullptr.

References isBuffering(), SCH_LEGACY_PLUGIN_CACHE::IsFile(), SCH_LEGACY_PLUGIN_CACHE::IsFileChanged(), SCH_LEGACY_PLUGIN_CACHE::Load(), m_cache, m_props, and PART_LIBS::s_modify_generation.

Referenced by DeleteAlias(), DeleteSymbol(), EnumerateSymbolLib(), LoadSymbol(), and SaveSymbol().

◆ CheckHeader()

bool SCH_LEGACY_PLUGIN::CheckHeader ( const wxString &  aFileName)
overridevirtual

Return true if the first line in aFileName begins with the expected header.

Parameters
aFileNameis the name of the file to use as input

Reimplemented from SCH_PLUGIN.

Definition at line 4423 of file sch_legacy_plugin.cpp.

4424 {
4425  // Open file and check first line
4426  wxTextFile tempFile;
4427 
4428  tempFile.Open( aFileName );
4429  wxString firstline;
4430  // read the first line
4431  firstline = tempFile.GetFirstLine();
4432  tempFile.Close();
4433 
4434  return firstline.StartsWith( "EESchema" );
4435 }

◆ CreateSymbolLib()

void SCH_LEGACY_PLUGIN::CreateSymbolLib ( const wxString &  aLibraryPath,
const PROPERTIES aProperties = nullptr 
)
overridevirtual

Create a new empty symbol library at aLibraryPath.

It is an error to attempt to create an existing library or to attempt to create on a "read only" location.

Parameters
aLibraryPathis a locator for the "library", usually a directory, file, or URL containing several footprints.
aPropertiesis an associative array that can be used to tell the library create function anything special, because it can take any number of additional named tuning arguments that the plugin is known to support. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL.
Exceptions
IO_ERRORif there is a problem finding the library, or creating it.

Reimplemented from SCH_PLUGIN.

Definition at line 4356 of file sch_legacy_plugin.cpp.

4358 {
4359  if( wxFileExists( aLibraryPath ) )
4360  {
4362  _( "symbol library \"%s\" already exists, cannot create a new library" ),
4363  aLibraryPath.GetData() ) );
4364  }
4365 
4366  LOCALE_IO toggle;
4367 
4368  m_props = aProperties;
4369 
4370  delete m_cache;
4371  m_cache = new SCH_LEGACY_PLUGIN_CACHE( aLibraryPath );
4372  m_cache->SetModified();
4373  m_cache->Save( writeDocFile( aProperties ) );
4374  m_cache->Load(); // update m_writable and m_mod_time
4375 }
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: common.h:175
SCH_LEGACY_PLUGIN_CACHE * m_cache
A cache assistant for the part library portion of the SCH_PLUGIN API, and only for the SCH_LEGACY_PLU...
#define THROW_IO_ERROR(msg)
void SetModified(bool aModified=true)
#define _(s)
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205
void Save(bool aSaveDocFile=true)
Save the entire library to file m_libFileName;.
bool writeDocFile(const PROPERTIES *aProperties)
const PROPERTIES * m_props
Passed via Save() or Load(), no ownership, may be nullptr.

References _, Format(), SCH_LEGACY_PLUGIN_CACHE::Load(), m_cache, m_props, SCH_LEGACY_PLUGIN_CACHE::Save(), SCH_LEGACY_PLUGIN_CACHE::SetModified(), THROW_IO_ERROR, and writeDocFile().

◆ DeleteAlias()

void SCH_LEGACY_PLUGIN::DeleteAlias ( const wxString &  aLibraryPath,
const wxString &  aAliasName,
const PROPERTIES aProperties = nullptr 
)
overridevirtual

Delete aAliasName from the library at aLibraryPath.

If aAliasName refers the the root LIB_PART object, the part is renamed to the next or previous LIB_ALIAS in the LIB_PART if one exists. If the LIB_ALIAS is the last alias referring to the root LIB_PART, the LIB_PART is also removed from the library.

Parameters
aLibraryPathis a locator for the "library", usually a directory, file, or URL containing several symbols.
aAliasNameis the name of a LIB_ALIAS to delete from the specified library.
aPropertiesis an associative array that can be used to tell the library delete function anything special, because it can take any number of additional named tuning arguments that the plugin is known to support. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL.
Exceptions
IO_ERRORif there is a problem finding the alias or the library or deleting it.

Reimplemented from SCH_PLUGIN.

Definition at line 4328 of file sch_legacy_plugin.cpp.

4330 {
4331  m_props = aProperties;
4332 
4333  cacheLib( aLibraryPath );
4334 
4335  m_cache->DeleteAlias( aAliasName );
4336 
4337  if( !isBuffering( aProperties ) )
4338  m_cache->Save( writeDocFile( aProperties ) );
4339 }
SCH_LEGACY_PLUGIN_CACHE * m_cache
bool isBuffering(const PROPERTIES *aProperties)
void DeleteAlias(const wxString &aAliasName)
void cacheLib(const wxString &aLibraryFileName)
void Save(bool aSaveDocFile=true)
Save the entire library to file m_libFileName;.
bool writeDocFile(const PROPERTIES *aProperties)
const PROPERTIES * m_props
Passed via Save() or Load(), no ownership, may be nullptr.

References cacheLib(), SCH_LEGACY_PLUGIN_CACHE::DeleteAlias(), isBuffering(), m_cache, m_props, SCH_LEGACY_PLUGIN_CACHE::Save(), and writeDocFile().

◆ DeleteSymbol()

void SCH_LEGACY_PLUGIN::DeleteSymbol ( const wxString &  aLibraryPath,
const wxString &  aAliasName,
const PROPERTIES aProperties = nullptr 
)
overridevirtual

Delete the entire LIB_PART associated with aAliasName from the library aLibraryPath.

Parameters
aLibraryPathis a locator for the "library", usually a directory, file, or URL containing several symbols.
aAliasNameis the name of a LIB_ALIAS associated with it's root LIB_PART object to delete from the specified library.
aPropertiesis an associative array that can be used to tell the library delete function anything special, because it can take any number of additional named tuning arguments that the plugin is known to support. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL.
Exceptions
IO_ERRORif there is a problem finding the alias or the library or deleting it.

Reimplemented from SCH_PLUGIN.

Definition at line 4342 of file sch_legacy_plugin.cpp.

4344 {
4345  m_props = aProperties;
4346 
4347  cacheLib( aLibraryPath );
4348 
4349  m_cache->DeleteSymbol( aAliasName );
4350 
4351  if( !isBuffering( aProperties ) )
4352  m_cache->Save( writeDocFile( aProperties ) );
4353 }
SCH_LEGACY_PLUGIN_CACHE * m_cache
bool isBuffering(const PROPERTIES *aProperties)
void cacheLib(const wxString &aLibraryFileName)
void Save(bool aSaveDocFile=true)
Save the entire library to file m_libFileName;.
void DeleteSymbol(const wxString &aAliasName)
bool writeDocFile(const PROPERTIES *aProperties)
const PROPERTIES * m_props
Passed via Save() or Load(), no ownership, may be nullptr.

References cacheLib(), SCH_LEGACY_PLUGIN_CACHE::DeleteSymbol(), isBuffering(), m_cache, m_props, SCH_LEGACY_PLUGIN_CACHE::Save(), and writeDocFile().

◆ DeleteSymbolLib()

bool SCH_LEGACY_PLUGIN::DeleteSymbolLib ( const wxString &  aLibraryPath,
const PROPERTIES aProperties = nullptr 
)
overridevirtual

Delete an existing symbol library and returns true if successful, or if library does not exist returns false, or throws an exception if library exists but is read only or cannot be deleted for some other reason.

Parameters
aLibraryPathis a locator for the "library", usually a directory or file which will contain symbols.
aPropertiesis an associative array that can be used to tell the library delete implementation function anything special, because it can take any number of additional named tuning arguments that the plugin is known to support. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL.
Returns
true if library deleted or false if library did not exist.
Exceptions
IO_ERRORif there is a problem deleting an existing library.

Reimplemented from SCH_PLUGIN.

Definition at line 4378 of file sch_legacy_plugin.cpp.

4380 {
4381  wxFileName fn = aLibraryPath;
4382 
4383  if( !fn.FileExists() )
4384  return false;
4385 
4386  // Some of the more elaborate wxRemoveFile() crap puts up its own wxLog dialog
4387  // we don't want that. we want bare metal portability with no UI here.
4388  if( wxRemove( aLibraryPath ) )
4389  {
4390  THROW_IO_ERROR( wxString::Format( _( "library \"%s\" cannot be deleted" ),
4391  aLibraryPath.GetData() ) );
4392  }
4393 
4394  if( m_cache && m_cache->IsFile( aLibraryPath ) )
4395  {
4396  delete m_cache;
4397  m_cache = 0;
4398  }
4399 
4400  return true;
4401 }
SCH_LEGACY_PLUGIN_CACHE * m_cache
#define THROW_IO_ERROR(msg)
#define _(s)
bool IsFile(const wxString &aFullPathAndFileName) const
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:205

References _, Format(), SCH_LEGACY_PLUGIN_CACHE::IsFile(), m_cache, and THROW_IO_ERROR.

◆ EnumerateSymbolLib() [1/2]

void SCH_LEGACY_PLUGIN::EnumerateSymbolLib ( wxArrayString &  aAliasNameList,
const wxString &  aLibraryPath,
const PROPERTIES aProperties = nullptr 
)
overridevirtual

Populate a list of LIB_PART alias names contained within the library aLibraryPath.

Parameters
aAliasNameListis an array to populate with the LIB_ALIAS names associated with the library.
aLibraryPathis a locator for the "library", usually a directory, file, or URL containing one or more LIB_PART objects.
aPropertiesis an associative array that can be used to tell the plugin anything needed about how to perform with respect to aLibraryPath. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL.
Exceptions
IO_ERRORif the library cannot be found, the part library cannot be loaded.

Reimplemented from SCH_PLUGIN.

Definition at line 4252 of file sch_legacy_plugin.cpp.

4255 {
4256  LOCALE_IO toggle; // toggles on, then off, the C locale.
4257 
4258  m_props = aProperties;
4259 
4260  bool powerSymbolsOnly = ( aProperties &&
4261  aProperties->find( SYMBOL_LIB_TABLE::PropPowerSymsOnly ) != aProperties->end() );
4262  cacheLib( aLibraryPath );
4263 
4264  const LIB_ALIAS_MAP& aliases = m_cache->m_aliases;
4265 
4266  for( LIB_ALIAS_MAP::const_iterator it = aliases.begin(); it != aliases.end(); ++it )
4267  {
4268  if( !powerSymbolsOnly || it->second->GetPart()->IsPower() )
4269  aAliasNameList.Add( it->first );
4270  }
4271 }
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: common.h:175
SCH_LEGACY_PLUGIN_CACHE * m_cache
std::map< wxString, LIB_ALIAS *, AliasMapSort > LIB_ALIAS_MAP
Alias map used by part library object.
void cacheLib(const wxString &aLibraryFileName)
static const char * PropPowerSymsOnly
const PROPERTIES * m_props
Passed via Save() or Load(), no ownership, may be nullptr.

References cacheLib(), SCH_LEGACY_PLUGIN_CACHE::m_aliases, m_cache, m_props, and SYMBOL_LIB_TABLE::PropPowerSymsOnly.

◆ EnumerateSymbolLib() [2/2]

void SCH_LEGACY_PLUGIN::EnumerateSymbolLib ( std::vector< LIB_ALIAS * > &  aAliasList,
const wxString &  aLibraryPath,
const PROPERTIES aProperties = nullptr 
)
overridevirtual

Populate a list of LIB_PART aliases contained within the library aLibraryPath.

Parameters
aAliasListis an array to populate with the LIB_ALIAS pointers associated with the library.
aLibraryPathis a locator for the "library", usually a directory, file, or URL containing one or more LIB_PART objects.
aPropertiesis an associative array that can be used to tell the plugin anything needed about how to perform with respect to aLibraryPath. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL.
Exceptions
IO_ERRORif the library cannot be found, the part library cannot be loaded.

Reimplemented from SCH_PLUGIN.

Definition at line 4274 of file sch_legacy_plugin.cpp.

4277 {
4278  LOCALE_IO toggle; // toggles on, then off, the C locale.
4279 
4280  m_props = aProperties;
4281 
4282  bool powerSymbolsOnly = ( aProperties &&
4283  aProperties->find( SYMBOL_LIB_TABLE::PropPowerSymsOnly ) != aProperties->end() );
4284  cacheLib( aLibraryPath );
4285 
4286  const LIB_ALIAS_MAP& aliases = m_cache->m_aliases;
4287 
4288  for( LIB_ALIAS_MAP::const_iterator it = aliases.begin(); it != aliases.end(); ++it )
4289  {
4290  if( !powerSymbolsOnly || it->second->GetPart()->IsPower() )
4291  aAliasList.push_back( it->second );
4292  }
4293 }
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: common.h:175
SCH_LEGACY_PLUGIN_CACHE * m_cache
std::map< wxString, LIB_ALIAS *, AliasMapSort > LIB_ALIAS_MAP
Alias map used by part library object.
void cacheLib(const wxString &aLibraryFileName)
static const char * PropPowerSymsOnly
const PROPERTIES * m_props
Passed via Save() or Load(), no ownership, may be nullptr.

References cacheLib(), SCH_LEGACY_PLUGIN_CACHE::m_aliases, m_cache, m_props, and SYMBOL_LIB_TABLE::PropPowerSymsOnly.

◆ Format() [1/2]

void SCH_LEGACY_PLUGIN::Format ( SCH_SCREEN aScreen)

Definition at line 1783 of file sch_legacy_plugin.cpp.

1784 {
1785  wxCHECK_RET( aScreen != NULL, "NULL SCH_SCREEN* object." );
1786  wxCHECK_RET( m_kiway != NULL, "NULL KIWAY* object." );
1787 
1788  // Write the header
1789  m_out->Print( 0, "%s %s %d\n", "EESchema", SCHEMATIC_HEAD_STRING, EESCHEMA_VERSION );
1790 
1791  // Write the project libraries.
1792  for( const PART_LIB& lib : *m_kiway->Prj().SchLibs() )
1793  m_out->Print( 0, "LIBS:%s\n", TO_UTF8( lib.GetName() ) );
1794 
1795  // This section is not used, but written for file compatibility
1796  m_out->Print( 0, "EELAYER %d %d\n", SCH_LAYER_ID_COUNT, 0 );
1797  m_out->Print( 0, "EELAYER END\n" );
1798 
1799  /* Write page info, ScreenNumber and NumberOfScreen; not very meaningful for
1800  * SheetNumber and Sheet Count in a complex hierarchy, but useful in
1801  * simple hierarchy and flat hierarchy. Used also to search the root
1802  * sheet ( ScreenNumber = 1 ) within the files
1803  */
1804  const TITLE_BLOCK& tb = aScreen->GetTitleBlock();
1805  const PAGE_INFO& page = aScreen->GetPageSettings();
1806 
1807  m_out->Print( 0, "$Descr %s %d %d%s\n", TO_UTF8( page.GetType() ),
1808  page.GetWidthMils(),
1809  page.GetHeightMils(),
1810  !page.IsCustom() && page.IsPortrait() ? " portrait" : "" );
1811  m_out->Print( 0, "encoding utf-8\n" );
1812  m_out->Print( 0, "Sheet %d %d\n", aScreen->m_ScreenNumber, aScreen->m_NumberOfScreens );
1813  m_out->Print( 0, "Title %s\n", EscapedUTF8( tb.GetTitle() ).c_str() );
1814  m_out->Print( 0, "Date %s\n", EscapedUTF8( tb.GetDate() ).c_str() );
1815  m_out->Print( 0, "Rev %s\n", EscapedUTF8( tb.GetRevision() ).c_str() );
1816  m_out->Print( 0, "Comp %s\n", EscapedUTF8( tb.GetCompany() ).c_str() );
1817  m_out->Print( 0, "Comment1 %s\n", EscapedUTF8( tb.GetComment1() ).c_str() );
1818  m_out->Print( 0, "Comment2 %s\n", EscapedUTF8( tb.GetComment2() ).c_str() );
1819  m_out->Print( 0, "Comment3 %s\n", EscapedUTF8( tb.GetComment3() ).c_str() );
1820  m_out->Print( 0, "Comment4 %s\n", EscapedUTF8( tb.GetComment4() ).c_str() );
1821  m_out->Print( 0, "$EndDescr\n" );
1822 
1823  for( auto alias : aScreen->GetBusAliases() )
1824  {
1825  saveBusAlias( alias );
1826  }
1827 
1828  for( SCH_ITEM* item = aScreen->GetDrawItems(); item; item = item->Next() )
1829  {
1830  switch( item->Type() )
1831  {
1832  case SCH_COMPONENT_T:
1833  saveComponent( static_cast< SCH_COMPONENT* >( item ) );
1834  break;
1835  case SCH_BITMAP_T:
1836  saveBitmap( static_cast< SCH_BITMAP* >( item ) );
1837  break;
1838  case SCH_SHEET_T:
1839  saveSheet( static_cast< SCH_SHEET* >( item ) );
1840  break;
1841  case SCH_JUNCTION_T:
1842  saveJunction( static_cast< SCH_JUNCTION* >( item ) );
1843  break;
1844  case SCH_NO_CONNECT_T:
1845  saveNoConnect( static_cast< SCH_NO_CONNECT* >( item ) );
1846  break;
1847  case SCH_BUS_WIRE_ENTRY_T:
1848  case SCH_BUS_BUS_ENTRY_T:
1849  saveBusEntry( static_cast< SCH_BUS_ENTRY_BASE* >( item ) );
1850  break;
1851  case SCH_LINE_T:
1852  saveLine( static_cast< SCH_LINE* >( item ) );
1853  break;
1854  case SCH_TEXT_T:
1855  case SCH_LABEL_T:
1856  case SCH_GLOBAL_LABEL_T:
1857  case SCH_HIER_LABEL_T:
1858  saveText( static_cast< SCH_TEXT* >( item ) );
1859  break;
1860  default:
1861  wxASSERT( "Unexpected schematic object type in SCH_LEGACY_PLUGIN::Format()" );
1862  }
1863  }
1864 
1865  m_out->Print( 0, "$EndSCHEMATC\n" );
1866 }
int m_ScreenNumber
Definition: base_screen.h:135
SCH_ITEM * Next() const
Definition: sch_item.h:153
void saveLine(SCH_LINE *aLine)
int GetHeightMils() const
Definition: page_info.h:140
VTBL_ENTRY PROJECT & Prj() const
Function Prj returns the PROJECT associated with this KIWAY.
Definition: kiway.cpp:163
const wxString & GetComment4() const
Definition: title_block.h:124
void saveText(SCH_TEXT *aText)
const TITLE_BLOCK & GetTitleBlock() const
Definition: sch_screen.h:123
const wxString & GetType() const
Definition: page_info.h:97
#define SCH_LAYER_ID_COUNT
void saveNoConnect(SCH_NO_CONNECT *aNoConnect)
bool IsCustom() const
Function IsCustom returns true if the type is Custom.
Definition: page_info.cpp:176
Class TITLE_BLOCK holds the information shown in the lower right corner of a plot,...
Definition: title_block.h:40
const PAGE_INFO & GetPageSettings() const
Definition: sch_screen.h:113
void saveSheet(SCH_SHEET *aSheet)
void saveJunction(SCH_JUNCTION *aJunction)
#define SCHEMATIC_HEAD_STRING
Definition: general.h:43
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:48
std::string EscapedUTF8(const wxString &aString)
Function EscapedUTF8 returns an 8 bit UTF8 string given aString in unicode form.
Definition: string.cpp:241
#define EESCHEMA_VERSION
Definition: general.h:42
const wxString & GetRevision() const
Definition: title_block.h:89
Class PAGE_INFO describes the page size and margins of a paper page on which to eventually print or p...
Definition: page_info.h:54
const wxString & GetCompany() const
Definition: title_block.h:99
const wxString & GetComment3() const
Definition: title_block.h:123
void saveBitmap(SCH_BITMAP *aBitmap)
void saveComponent(SCH_COMPONENT *aComponent)
const wxString & GetDate() const
Definition: title_block.h:79
const wxString & GetComment2() const
Definition: title_block.h:122
void saveBusAlias(std::shared_ptr< BUS_ALIAS > aAlias)
OUTPUTFORMATTER * m_out
The output formatter for saving SCH_SCREEN objects.
bool IsPortrait() const
Definition: page_info.h:121
const wxString & GetComment1() const
Definition: title_block.h:121
int m_NumberOfScreens
Definition: base_screen.h:136
const wxString & GetTitle() const
Definition: title_block.h:65
KIWAY * m_kiway
Required for path to legacy component libraries.
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:404
Object used to load, save, search, and otherwise manipulate symbol library files.
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
Definition: sch_item.h:114
void saveBusEntry(SCH_BUS_ENTRY_BASE *aBusEntry)
std::unordered_set< std::shared_ptr< BUS_ALIAS > > GetBusAliases()
Returns a list of bus aliases defined in this screen.
Definition: sch_screen.h:459
int GetWidthMils() const
Definition: page_info.h:137
SCH_ITEM * GetDrawItems() const
Definition: sch_screen.h:147

References EESCHEMA_VERSION, EscapedUTF8(), SCH_SCREEN::GetBusAliases(), TITLE_BLOCK::GetComment1(), TITLE_BLOCK::GetComment2(), TITLE_BLOCK::GetComment3(), TITLE_BLOCK::GetComment4(), TITLE_BLOCK::GetCompany(), TITLE_BLOCK::GetDate(), SCH_SCREEN::GetDrawItems(), PAGE_INFO::GetHeightMils(), SCH_SCREEN::GetPageSettings(), TITLE_BLOCK::GetRevision(), TITLE_BLOCK::GetTitle(), SCH_SCREEN::GetTitleBlock(), PAGE_INFO::GetType(), PAGE_INFO::GetWidthMils(), PAGE_INFO::IsCustom(), PAGE_INFO::IsPortrait(), m_kiway, BASE_SCREEN::m_NumberOfScreens, m_out, BASE_SCREEN::m_ScreenNumber, SCH_ITEM::Next(), OUTPUTFORMATTER::Print(), KIWAY::Prj(), saveBitmap(), saveBusAlias(), saveBusEntry(), saveComponent(), saveJunction(), saveLine(), saveNoConnect(), saveSheet(), saveText(), SCH_BITMAP_T, SCH_BUS_BUS_ENTRY_T, SCH_BUS_WIRE_ENTRY_T, SCH_COMPONENT_T, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_JUNCTION_T, SCH_LABEL_T, SCH_LAYER_ID_COUNT, SCH_LINE_T, SCH_NO_CONNECT_T, SCH_SHEET_T, SCH_TEXT_T, SCHEMATIC_HEAD_STRING, and TO_UTF8.

Referenced by SCH_EDITOR_CONTROL::doCopy(), and Save().

◆ Format() [2/2]

void SCH_LEGACY_PLUGIN::Format ( SELECTION aSelection,
OUTPUTFORMATTER aFormatter 
)

Definition at line 1869 of file sch_legacy_plugin.cpp.

1870 {
1871  m_out = aFormatter;
1872 
1873  for( unsigned i = 0; i < aSelection->GetSize(); ++i )
1874  {
1875  SCH_ITEM* item = (SCH_ITEM*) aSelection->GetItem( i );
1876 
1877  switch( item->Type() )
1878  {
1879  case SCH_COMPONENT_T:
1880  saveComponent( static_cast< SCH_COMPONENT* >( item ) );
1881  break;
1882  case SCH_BITMAP_T:
1883  saveBitmap( static_cast< SCH_BITMAP* >( item ) );
1884  break;
1885  case SCH_SHEET_T:
1886  saveSheet( static_cast< SCH_SHEET* >( item ) );
1887  break;
1888  case SCH_JUNCTION_T:
1889  saveJunction( static_cast< SCH_JUNCTION* >( item ) );
1890  break;
1891  case SCH_NO_CONNECT_T:
1892  saveNoConnect( static_cast< SCH_NO_CONNECT* >( item ) );
1893  break;
1894  case SCH_BUS_WIRE_ENTRY_T:
1895  case SCH_BUS_BUS_ENTRY_T:
1896  saveBusEntry( static_cast< SCH_BUS_ENTRY_BASE* >( item ) );
1897  break;
1898  case SCH_LINE_T:
1899  saveLine( static_cast< SCH_LINE* >( item ) );
1900  break;
1901  case SCH_TEXT_T:
1902  case SCH_LABEL_T:
1903  case SCH_GLOBAL_LABEL_T:
1904  case SCH_HIER_LABEL_T:
1905  saveText( static_cast< SCH_TEXT* >( item ) );
1906  break;
1907  default:
1908  wxASSERT( "Unexpected schematic object type in SCH_LEGACY_PLUGIN::Format()" );
1909  }
1910  }
1911 }
void saveLine(SCH_LINE *aLine)
void saveText(SCH_TEXT *aText)
void saveNoConnect(SCH_NO_CONNECT *aNoConnect)
void saveSheet(SCH_SHEET *aSheet)
void saveJunction(SCH_JUNCTION *aJunction)
void saveBitmap(SCH_BITMAP *aBitmap)
virtual KIGFX::VIEW_ITEM * GetItem(unsigned int aIdx) const override
Definition: selection.h:103
void saveComponent(SCH_COMPONENT *aComponent)
virtual unsigned int GetSize() const override
Function GetSize() Returns the number of stored items.
Definition: selection.h:98
OUTPUTFORMATTER * m_out
The output formatter for saving SCH_SCREEN objects.
size_t i
Definition: json11.cpp:597
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
Definition: sch_item.h:114
void saveBusEntry(SCH_BUS_ENTRY_BASE *aBusEntry)
KICAD_T Type() const
Function Type()
Definition: base_struct.h:210

References SELECTION::GetItem(), SELECTION::GetSize(), i, m_out, saveBitmap(), saveBusEntry(), saveComponent(), saveJunction(), saveLine(), saveNoConnect(), saveSheet(), saveText(), SCH_BITMAP_T, SCH_BUS_BUS_ENTRY_T, SCH_BUS_WIRE_ENTRY_T, SCH_COMPONENT_T, SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_JUNCTION_T, SCH_LABEL_T, SCH_LINE_T, SCH_NO_CONNECT_T, SCH_SHEET_T, SCH_TEXT_T, and EDA_ITEM::Type().

◆ FormatPart()

void SCH_LEGACY_PLUGIN::FormatPart ( LIB_PART aPart,
OUTPUTFORMATTER aFormatter 
)
static

Definition at line 4451 of file sch_legacy_plugin.cpp.

4452 {
4453  SCH_LEGACY_PLUGIN_CACHE::SaveSymbol( part, formatter );
4454 }
static void SaveSymbol(LIB_PART *aSymbol, OUTPUTFORMATTER &aFormatter)

References SCH_LEGACY_PLUGIN_CACHE::SaveSymbol().

Referenced by LIB_EDIT_TOOL::Copy(), and LIB_EDIT_FRAME::CopyPartToClipboard().

◆ GetError()

const wxString& SCH_LEGACY_PLUGIN::GetError ( ) const
inlineoverridevirtual

Return an error string to the caller.

This is useful for schematic loaders that can load partial schematics where throwing an exception would be problematic such as the KiCad legacy plugin.

Returns
an unformatted string containing errors if any.

Reimplemented from SCH_PLUGIN.

Definition at line 138 of file sch_legacy_plugin.h.

138 { return m_error; }
wxString m_error
For throwing exceptions or errors on partial schematic loads.

References m_error.

◆ GetFileExtension()

const wxString SCH_LEGACY_PLUGIN::GetFileExtension ( ) const
inlineoverridevirtual

Returns the file extension for the SCH_PLUGIN.

Implements SCH_PLUGIN.

Definition at line 76 of file sch_legacy_plugin.h.

77  {
78  return wxT( "sch" );
79  }

◆ GetModifyHash()

int SCH_LEGACY_PLUGIN::GetModifyHash ( ) const
overridevirtual

Return the modification hash from the library cache.

Note
This is temporary until the new s-expr file format is implement. The new file format will embed symbols instead of referencing them from the library. This function can be removed when the new file format is implemented.
Returns
the modification hash of the library cache.

Implements SCH_PLUGIN.

Definition at line 4242 of file sch_legacy_plugin.cpp.

4243 {
4244  if( m_cache )
4245  return m_cache->GetModifyHash();
4246 
4247  // If the cache hasn't been loaded, it hasn't been modified.
4248  return 0;
4249 }
SCH_LEGACY_PLUGIN_CACHE * m_cache

References SCH_LEGACY_PLUGIN_CACHE::GetModifyHash(), and m_cache.

◆ GetName()

const wxString SCH_LEGACY_PLUGIN::GetName ( ) const
inlineoverridevirtual

Returns a brief hard coded name for this SCH_PLUGIN.

Implements SCH_PLUGIN.

Definition at line 71 of file sch_legacy_plugin.h.

72  {
73  return wxT( "Eeschema-Legacy" );
74  }

◆ init()

void SCH_LEGACY_PLUGIN::init ( KIWAY aKiway,
const PROPERTIES aProperties = nullptr 
)
protected

initialize PLUGIN like a constructor would.

Definition at line 572 of file sch_legacy_plugin.cpp.

573 {
574  m_version = 0;
575  m_rootSheet = NULL;
576  m_props = aProperties;
577  m_kiway = aKiway;
578  m_cache = NULL;
579  m_out = NULL;
580 }
SCH_LEGACY_PLUGIN_CACHE * m_cache
SCH_SHEET * m_rootSheet
The root sheet of the schematic being loaded..
int m_version
Version of file being loaded.
OUTPUTFORMATTER * m_out
The output formatter for saving SCH_SCREEN objects.
KIWAY * m_kiway
Required for path to legacy component libraries.
const PROPERTIES * m_props
Passed via Save() or Load(), no ownership, may be nullptr.

References m_cache, m_kiway, m_out, m_props, m_rootSheet, and m_version.

Referenced by Load(), Save(), and SCH_LEGACY_PLUGIN().

◆ isBuffering()

bool SCH_LEGACY_PLUGIN::isBuffering ( const PROPERTIES aProperties)
private

Definition at line 4236 of file sch_legacy_plugin.cpp.

4237 {
4238  return ( aProperties && aProperties->Exists( SCH_LEGACY_PLUGIN::PropBuffering ) );
4239 }
bool Exists(const std::string &aProperty) const
Definition: properties.h:44
static const char * PropBuffering
const char* PropBuffering

References PROPERTIES::Exists(), and PropBuffering.

Referenced by cacheLib(), DeleteAlias(), DeleteSymbol(), and SaveSymbol().

◆ IsSymbolLibWritable()

bool SCH_LEGACY_PLUGIN::IsSymbolLibWritable ( const wxString &  aLibraryPath)
overridevirtual

Return true if the library at aLibraryPath is writable.

(Often system libraries are read only because of where they are installed.)

Parameters
aLibraryPathis a locator for the "library", usually a directory, file, or URL containing several symbols.
Exceptions
IO_ERRORif no library at aLibraryPath exists.

Reimplemented from SCH_PLUGIN.

Definition at line 4438 of file sch_legacy_plugin.cpp.

4439 {
4440  return wxFileName::IsFileWritable( aLibraryPath );
4441 }

◆ Load()

SCH_SHEET * SCH_LEGACY_PLUGIN::Load ( const wxString &  aFileName,
KIWAY aKiway,
SCH_SHEET aAppendToMe = nullptr,
const PROPERTIES aProperties = nullptr 
)
overridevirtual

Load information from some input file format that this SCH_PLUGIN implementation knows about, into either a new SCH_SHEET or an existing one.

This may be used to load an entire new SCH_SHEET, or to augment an existing one if aAppendToMe is not NULL.

Parameters
aFileNameis the name of the file to use as input and may be foreign in nature or native in nature.
aKiwayis the KIWAY object used to access the component libraries loaded by the project.
aAppendToMeis an existing SCH_SHEET to append to, but if NULL then this means "do not append, rather load anew".
aPropertiesis an associative array that can be used to tell the loader how to load the file, because it can take any number of additional named arguments that the plugin is known to support. These are tuning parameters for the import or load. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL.
Returns
the successfully loaded schematic, or the same one as aAppendToMe if aAppendToMe was not NULL, and the caller owns it.
Exceptions
IO_ERRORif there is a problem loading, and its contents should say what went wrong, using line number and character offsets of the input file if possible.

Reimplemented from SCH_PLUGIN.

Definition at line 583 of file sch_legacy_plugin.cpp.

585 {
586  wxASSERT( !aFileName || aKiway != NULL );
587 
588  LOCALE_IO toggle; // toggles on, then off, the C locale.
589  SCH_SHEET* sheet;
590 
591  wxFileName fn = aFileName;
592 
593  // Unfortunately child sheet file names the legacy schematic file format are not fully
594  // qualified and are always appended to the project path. The aFileName attribute must
595  // always be an absolute path so the project path can be used for load child sheet files.
596  wxASSERT( fn.IsAbsolute() );
597 
598  if( aAppendToMe )
599  {
600  wxLogTrace( traceSchLegacyPlugin, "Append \"%s\" to sheet \"%s\".",
601  aFileName, aAppendToMe->GetFileName() );
602 
603  wxFileName normedFn = aAppendToMe->GetFileName();
604 
605  if( !normedFn.IsAbsolute() )
606  {
607  if( aFileName.Right( normedFn.GetFullPath().Length() ) == normedFn.GetFullPath() )
608  m_path = aFileName.Left( aFileName.Length() - normedFn.GetFullPath().Length() );
609  }
610 
611  if( m_path.IsEmpty() )
612  m_path = aKiway->Prj().GetProjectPath();
613 
614  wxLogTrace( traceSchLegacyPlugin, "Normalized append path \"%s\".", m_path );
615  }
616  else
617  {
618  m_path = aKiway->Prj().GetProjectPath();
619  }
620 
621  m_currentPath.push( m_path );
622  init( aKiway, aProperties );
623 
624  if( aAppendToMe == NULL )
625  {
626  // Clean up any allocated memory if an exception occurs loading the schematic.
627  std::unique_ptr< SCH_SHEET > newSheet( new SCH_SHEET );
628  newSheet->SetFileName( aFileName );
629  m_rootSheet = newSheet.get();
630  loadHierarchy( newSheet.get() );
631 
632  // If we got here, the schematic loaded successfully.
633  sheet = newSheet.release();
634  }
635  else
636  {
637  m_rootSheet = aAppendToMe->GetRootSheet();
638  wxASSERT( m_rootSheet != NULL );
639  sheet = aAppendToMe;
640  loadHierarchy( sheet );
641  }
642 
643  wxASSERT( m_currentPath.size() == 1 ); // only the project path should remain
644 
645  return sheet;
646 }
void init(KIWAY *aKiway, const PROPERTIES *aProperties=nullptr)
initialize PLUGIN like a constructor would.
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: common.h:175
VTBL_ENTRY PROJECT & Prj() const
Function Prj returns the PROJECT associated with this KIWAY.
Definition: kiway.cpp:163
const wxChar *const traceSchLegacyPlugin
Flag to enable legacy schematic plugin debug output.
SCH_SHEET * m_rootSheet
The root sheet of the schematic being loaded..
SCH_SHEET * GetRootSheet()
Return the root sheet of this SCH_SHEET object.
Definition: sch_sheet.cpp:136
VTBL_ENTRY const wxString GetProjectPath() const
Function GetProjectPath returns the full path of the project.
Definition: project.cpp:102
wxString m_path
Root project path for loading child sheets.
void loadHierarchy(SCH_SHEET *aSheet)
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:204
wxString GetFileName(void) const
Return the filename corresponding to this sheet.
Definition: sch_sheet.cpp:629
std::stack< wxString > m_currentPath
Stack to maintain nested sheet paths.

References SCH_SHEET::GetFileName(), PROJECT::GetProjectPath(), SCH_SHEET::GetRootSheet(), init(), loadHierarchy(), m_currentPath, m_path, m_rootSheet, KIWAY::Prj(), and traceSchLegacyPlugin.

◆ loadBitmap()

SCH_BITMAP * SCH_LEGACY_PLUGIN::loadBitmap ( LINE_READER aReader)
private

Definition at line 1064 of file sch_legacy_plugin.cpp.

1065 {
1066  std::unique_ptr< SCH_BITMAP > bitmap( new SCH_BITMAP );
1067 
1068  const char* line = aReader.Line();
1069 
1070  wxCHECK( strCompare( "$Bitmap", line, &line ), NULL );
1071 
1072  line = aReader.ReadLine();
1073 
1074  while( line != NULL )
1075  {
1076  if( strCompare( "Pos", line, &line ) )
1077  {
1078  wxPoint position;
1079 
1080  position.x = parseInt( aReader, line, &line );
1081  position.y = parseInt( aReader, line, &line );
1082  bitmap->SetPosition( position );
1083  }
1084  else if( strCompare( "Scale", line, &line ) )
1085  {
1086  auto scalefactor = parseDouble( aReader, line, &line );
1087 
1088  // Prevent scalefactor values that cannot be displayed.
1089  // In the case of a bad value, we accept that the image might be mis-scaled
1090  // rather than removing the full image. Users can then edit the scale factor in
1091  // Eeschema to the appropriate value
1092  if( !std::isnormal( scalefactor ) )
1093  scalefactor = 1.0;
1094 
1095  bitmap->GetImage()->SetScale( scalefactor );
1096  }
1097  else if( strCompare( "Data", line, &line ) )
1098  {
1099  wxMemoryOutputStream stream;
1100 
1101  while( line )
1102  {
1103  if( !aReader.ReadLine() )
1104  SCH_PARSE_ERROR( _( "Unexpected end of file" ), aReader, line );
1105 
1106  line = aReader.Line();
1107 
1108  if( strCompare( "EndData", line ) )
1109  {
1110  // all the PNG date is read.
1111  // We expect here m_image and m_bitmap are void
1112  wxImage* image = new wxImage();
1113  wxMemoryInputStream istream( stream );
1114  image->LoadFile( istream, wxBITMAP_TYPE_PNG );
1115  bitmap->GetImage()->SetImage( image );
1116  bitmap->GetImage()->SetBitmap( new wxBitmap( *image ) );
1117  break;
1118  }
1119 
1120  // Read PNG data, stored in hexadecimal,
1121  // each byte = 2 hexadecimal digits and a space between 2 bytes
1122  // and put it in memory stream buffer
1123  int len = strlen( line );
1124 
1125  for( ; len > 0 && !isspace( *line ); len -= 3, line += 3 )
1126  {
1127  int value = 0;
1128 
1129  if( sscanf( line, "%X", &value ) == 1 )
1130  stream.PutC( (char) value );
1131  else
1132  THROW_IO_ERROR( "invalid PNG data" );
1133  }
1134  }
1135 
1136  if( line == NULL )
1137  THROW_IO_ERROR( _( "unexpected end of file" ) );
1138  }
1139  else if( strCompare( "$EndBitmap", line ) )
1140  return bitmap.release();
1141 
1142  line = aReader.ReadLine();
1143  }
1144 
1145  THROW_IO_ERROR( _( "unexpected end of file" ) );
1146 }
char * Line() const
Function Line returns a pointer to the last line that was read in.
Definition: richio.h:139
static double parseDouble(LINE_READER &aReader, const char *aLine, const char **aOutput=NULL)
Parses an ASCII point string with possible leading whitespace into a double precision floating point ...
#define THROW_IO_ERROR(msg)
static int parseInt(LINE_READER &aReader, const char *aLine, const char **aOutput=NULL)
Parse an ASCII integer string with possible leading whitespace into an integer and updates the pointe...
#define _(s)
Object to handle a bitmap image that can be inserted in a schematic.
Definition: sch_bitmap.h:42
virtual char * ReadLine()=0
Function ReadLine reads a line of text into the buffer and increments the line number counter.
#define SCH_PARSE_ERROR(text, reader, pos)
static bool strCompare(const char *aString, const char *aLine, const char **aOutput=NULL)
Compare aString to the string starting at aLine and advances the character point to the end of String...

References _, LINE_READER::Line(), parseDouble(), parseInt(), LINE_READER::ReadLine(), SCH_PARSE_ERROR, strCompare(), and THROW_IO_ERROR.

Referenced by LoadContent().

◆ loadBusAlias()

std::shared_ptr< BUS_ALIAS > SCH_LEGACY_PLUGIN::loadBusAlias ( LINE_READER aReader,
SCH_SCREEN aScreen 
)
private

Definition at line 1733 of file sch_legacy_plugin.cpp.

1735 {
1736  auto busAlias = std::make_shared< BUS_ALIAS >( aScreen );
1737  const char* line = aReader.Line();
1738 
1739  wxCHECK( strCompare( "BusAlias", line, &line ), NULL );
1740 
1741  wxString buf;
1742  parseUnquotedString( buf, aReader, line, &line );
1743  busAlias->SetName( buf );
1744 
1745  while( *line != '\0' )
1746  {
1747  buf.clear();
1748  parseUnquotedString( buf, aReader, line, &line, true );
1749  if( buf.Len() > 0 )
1750  {
1751  busAlias->AddMember( buf );
1752  }
1753  }
1754 
1755  return busAlias;
1756 }
char * Line() const
Function Line returns a pointer to the last line that was read in.
Definition: richio.h:139
static void parseUnquotedString(wxString &aString, LINE_READER &aReader, const char *aCurrentToken, const char **aNextToken=NULL, bool aCanBeEmpty=false)
Parse an unquoted utf8 string and updates the pointer at aOutput if it is not NULL.
static bool strCompare(const char *aString, const char *aLine, const char **aOutput=NULL)
Compare aString to the string starting at aLine and advances the character point to the end of String...

References LINE_READER::Line(), parseUnquotedString(), and strCompare().

Referenced by LoadContent().

◆ loadBusEntry()

SCH_BUS_ENTRY_BASE * SCH_LEGACY_PLUGIN::loadBusEntry ( LINE_READER aReader)
private

Definition at line 1291 of file sch_legacy_plugin.cpp.

1292 {
1293  const char* line = aReader.Line();
1294 
1295  wxCHECK( strCompare( "Entry", line, &line ), NULL );
1296 
1297  std::unique_ptr< SCH_BUS_ENTRY_BASE > busEntry;
1298 
1299  if( strCompare( "Wire", line, &line ) )
1300  {
1301  busEntry.reset( new SCH_BUS_WIRE_ENTRY );
1302 
1303  if( !strCompare( "Line", line, &line ) )
1304  SCH_PARSE_ERROR( "invalid bus entry definition expected 'Line'", aReader, line );
1305  }
1306  else if( strCompare( "Bus", line, &line ) )
1307  {
1308  busEntry.reset( new SCH_BUS_BUS_ENTRY );
1309 
1310  if( !strCompare( "Bus", line, &line ) )
1311  SCH_PARSE_ERROR( "invalid bus entry definition expected 'Bus'", aReader, line );
1312  }
1313  else
1314  SCH_PARSE_ERROR( "invalid bus entry type", aReader, line );
1315 
1316  line = aReader.ReadLine();
1317 
1318  wxPoint pos;
1319  wxSize size;
1320 
1321  pos.x = parseInt( aReader, line, &line );
1322  pos.y = parseInt( aReader, line, &line );
1323  size.x = parseInt( aReader, line, &line );
1324  size.y = parseInt( aReader, line, &line );
1325 
1326  size.x -= pos.x;
1327  size.y -= pos.y;
1328 
1329  busEntry->SetPosition( pos );
1330  busEntry->SetSize( size );
1331 
1332  return busEntry.release();
1333 }
Class for a bus to bus entry.
char * Line() const
Function Line returns a pointer to the last line that was read in.
Definition: richio.h:139
static int parseInt(LINE_READER &aReader, const char *aLine, const char **aOutput=NULL)
Parse an ASCII integer string with possible leading whitespace into an integer and updates the pointe...
virtual char * ReadLine()=0
Function ReadLine reads a line of text into the buffer and increments the line number counter.
#define SCH_PARSE_ERROR(text, reader, pos)
static bool strCompare(const char *aString, const char *aLine, const char **aOutput=NULL)
Compare aString to the string starting at aLine and advances the character point to the end of String...
Class for a wire to bus entry.

References LINE_READER::Line(), parseInt(), LINE_READER::ReadLine(), SCH_PARSE_ERROR, and strCompare().

Referenced by LoadContent().

◆ loadComponent()

SCH_COMPONENT * SCH_LEGACY_PLUGIN::loadComponent ( LINE_READER aReader)
private

Definition at line 1436 of file sch_legacy_plugin.cpp.

1437 {
1438  const char* line = aReader.Line();
1439 
1440  wxCHECK( strCompare( "$Comp", line, &line ), NULL );
1441 
1442  std::unique_ptr< SCH_COMPONENT > component( new SCH_COMPONENT() );
1443 
1444  line = aReader.ReadLine();
1445 
1446  while( line != NULL )
1447  {
1448  if( strCompare( "L", line, &line ) )
1449  {
1450  wxString libName;
1451  size_t pos = 2; // "X" plus ' ' space character.
1452  wxString utf8Line = wxString::FromUTF8( line );
1453  wxStringTokenizer tokens( utf8Line, " \r\n\t" );
1454 
1455  if( tokens.CountTokens() < 2 )
1456  THROW_PARSE_ERROR( "invalid symbol library definition", aReader.GetSource(),
1457  aReader.Line(), aReader.LineNumber(), pos );
1458 
1459  libName = tokens.GetNextToken();
1460  libName.Replace( "~", " " );
1461 
1462  LIB_ID libId;
1463 
1464  // Prior to schematic version 4, library IDs did not have a library nickname so
1465  // parsing the symbol name with LIB_ID::Parse() would break symbol library links
1466  // that contained '/' and ':' characters.
1467  if( m_version > 3 )
1468  libId.Parse( libName, LIB_ID::ID_SCH, true );
1469  else
1470  libId.SetLibItemName( libName, false );
1471 
1472  component->SetLibId( libId );
1473 
1474  wxString refDesignator = tokens.GetNextToken();
1475 
1476  refDesignator.Replace( "~", " " );
1477 
1478  wxString prefix = refDesignator;
1479 
1480  while( prefix.Length() )
1481  {
1482  if( ( prefix.Last() < '0' || prefix.Last() > '9') && prefix.Last() != '?' )
1483  break;
1484 
1485  prefix.RemoveLast();
1486  }
1487 
1488  // Avoid a prefix containing trailing/leading spaces
1489  prefix.Trim( true );
1490  prefix.Trim( false );
1491 
1492  if( prefix.IsEmpty() )
1493  component->SetPrefix( wxString( "U" ) );
1494  else
1495  component->SetPrefix( prefix );
1496  }
1497  else if( strCompare( "U", line, &line ) )
1498  {
1499  // This fixes a potentially buggy files caused by unit being set to zero which
1500  // causes netlist issues. See https://bugs.launchpad.net/kicad/+bug/1677282.
1501  int unit = parseInt( aReader, line, &line );
1502 
1503  if( unit == 0 )
1504  {
1505  unit = 1;
1506 
1507  // Set the file as modified so the user can be warned.
1508  if( m_rootSheet && m_rootSheet->GetScreen() )
1510  }
1511 
1512  component->SetUnit( unit );
1513 
1514  // Same can also happen with the convert parameter
1515  int convert = parseInt( aReader, line, &line );
1516 
1517  if( convert == 0 )
1518  {
1519  convert = 1;
1520 
1521  // Set the file as modified so the user can be warned.
1522  if( m_rootSheet && m_rootSheet->GetScreen() )
1524  }
1525 
1526  component->SetConvert( convert );
1527 
1528  component->SetTimeStamp( parseHex( aReader, line, &line ) );
1529  }
1530  else if( strCompare( "P", line, &line ) )
1531  {
1532  wxPoint pos;
1533 
1534  pos.x = parseInt( aReader, line, &line );
1535  pos.y = parseInt( aReader, line, &line );
1536  component->SetPosition( pos );
1537  }
1538  else if( strCompare( "AR", line, &line ) )
1539  {
1540  const char* strCompare = "Path=";
1541  int len = strlen( strCompare );
1542 
1543  if( strncasecmp( strCompare, line, len ) != 0 )
1544  SCH_PARSE_ERROR( "missing 'Path=' token", aReader, line );
1545 
1546  line += len;
1547  wxString path, reference, unit;
1548 
1549  parseQuotedString( path, aReader, line, &line );
1550 
1551  strCompare = "Ref=";
1552  len = strlen( strCompare );
1553 
1554  if( strncasecmp( strCompare, line, len ) != 0 )
1555  SCH_PARSE_ERROR( "missing 'Ref=' token", aReader, line );
1556 
1557  line+= len;
1558  parseQuotedString( reference, aReader, line, &line );
1559 
1560  strCompare = "Part=";
1561  len = strlen( strCompare );
1562 
1563  if( strncasecmp( strCompare, line, len ) != 0 )
1564  SCH_PARSE_ERROR( "missing 'Part=' token", aReader, line );
1565 
1566  line+= len;
1567  parseQuotedString( unit, aReader, line, &line );
1568 
1569  long tmp;
1570 
1571  if( !unit.ToLong( &tmp, 10 ) )
1572  SCH_PARSE_ERROR( "expected integer value", aReader, line );
1573 
1574  if( tmp < 0 || tmp > MAX_UNIT_COUNT_PER_PACKAGE )
1575  SCH_PARSE_ERROR( "unit value out of range", aReader, line );
1576 
1577  component->AddHierarchicalReference( path, reference, (int)tmp );
1578  component->GetField( REFERENCE )->SetText( reference );
1579 
1580  }
1581  else if( strCompare( "F", line, &line ) )
1582  {
1583  int index = parseInt( aReader, line, &line );
1584 
1585  wxString text, name;
1586 
1587  parseQuotedString( text, aReader, line, &line, true );
1588 
1589  char orientation = parseChar( aReader, line, &line );
1590  wxPoint pos;
1591  pos.x = parseInt( aReader, line, &line );
1592  pos.y = parseInt( aReader, line, &line );
1593  int size = parseInt( aReader, line, &line );
1594  int attributes = parseHex( aReader, line, &line );
1595 
1596  if( index >= component->GetFieldCount() )
1597  {
1598  // The first MANDATOR_FIELDS _must_ be constructed within
1599  // the SCH_COMPONENT constructor. This assert is simply here
1600  // to guard against a change in that constructor.
1601  wxASSERT( component->GetFieldCount() >= MANDATORY_FIELDS );
1602 
1603  // Ignore the _supplied_ fieldNdx. It is not important anymore
1604  // if within the user defined fields region (i.e. >= MANDATORY_FIELDS).
1605  // We freely renumber the index to fit the next available field slot.
1606  index = component->GetFieldCount(); // new has this index after insertion
1607 
1608  SCH_FIELD field( wxPoint( 0, 0 ), -1, component.get(), name );
1609  component->AddField( field );
1610  }
1611 
1612  // Prior to version 2 of the schematic file format, none of the following existed.
1613  if( m_version > 1 )
1614  {
1615  wxString textAttrs;
1616  char hjustify = parseChar( aReader, line, &line );
1617 
1618  parseUnquotedString( textAttrs, aReader, line, &line );
1619 
1620  // The name of the field is optional.
1621  parseQuotedString( name, aReader, line, &line, true );
1622 
1623  if( hjustify == 'L' )
1624  component->GetField( index )->SetHorizJustify( GR_TEXT_HJUSTIFY_LEFT );
1625  else if( hjustify == 'R' )
1626  component->GetField( index )->SetHorizJustify( GR_TEXT_HJUSTIFY_RIGHT );
1627  else if( hjustify != 'C' )
1628  SCH_PARSE_ERROR( "component field text horizontal justification must be "
1629  "L, R, or C", aReader, line );
1630 
1631  // We are guaranteed to have a least one character here for older file formats
1632  // otherwise an exception would have been raised..
1633  if( textAttrs[0] == 'T' )
1634  component->GetField( index )->SetVertJustify( GR_TEXT_VJUSTIFY_TOP );
1635  else if( textAttrs[0] == 'B' )
1636  component->GetField( index )->SetVertJustify( GR_TEXT_VJUSTIFY_BOTTOM );
1637  else if( textAttrs[0] != 'C' )
1638  SCH_PARSE_ERROR( "component field text vertical justification must be "
1639  "B, T, or C", aReader, line );
1640 
1641  // Newer file formats include the bold and italics text attribute.
1642  if( textAttrs.Length() > 1 )
1643  {
1644  if( textAttrs.Length() != 3 )
1645  SCH_PARSE_ERROR( _( "component field text attributes must be 3 characters wide" ),
1646  aReader, line );
1647 
1648  if( textAttrs[1] == 'I' )
1649  component->GetField( index )->SetItalic( true );
1650  else if( textAttrs[1] != 'N' )
1651  SCH_PARSE_ERROR( "component field text italics indicator must be I or N",
1652  aReader, line );
1653 
1654  if( textAttrs[2] == 'B' )
1655  component->GetField( index )->SetBold( true );
1656  else if( textAttrs[2] != 'N' )
1657  SCH_PARSE_ERROR( "component field text bold indicator must be B or N",
1658  aReader, line );
1659  }
1660  }
1661 
1662  component->GetField( index )->SetText( text );
1663  component->GetField( index )->SetTextPos( pos );
1664  component->GetField( index )->SetVisible( !attributes );
1665  component->GetField( index )->SetTextSize( wxSize( size, size ) );
1666 
1667  if( orientation == 'H' )
1668  component->GetField( index )->SetTextAngle( TEXT_ANGLE_HORIZ );
1669  else if( orientation == 'V' )
1670  component->GetField( index )->SetTextAngle( TEXT_ANGLE_VERT );
1671  else
1672  SCH_PARSE_ERROR( "component field orientation must be H or V",
1673  aReader, line );
1674 
1675  if( name.IsEmpty() )
1677 
1678  component->GetField( index )->SetName( name );
1679  }
1680  else if( strCompare( "$EndComp", line ) )
1681  {
1682  // Ensure all flags (some are set by previous initializations) are reset:
1683  component->ClearFlags();
1684  return component.release();
1685  }
1686  else
1687  {
1688  // There are two lines that begin with a tab or spaces that includes a line with the
1689  // redundant position information and the transform matrix settings.
1690 
1691  // Parse the redundant position information just the same to check for formatting
1692  // errors.
1693  parseInt( aReader, line, &line ); // Always 1.
1694  parseInt( aReader, line, &line ); // The X coordinate.
1695  parseInt( aReader, line, &line ); // The Y coordinate.
1696 
1697  line = aReader.ReadLine();
1698 
1699  TRANSFORM transform;
1700 
1701  transform.x1 = parseInt( aReader, line, &line );
1702 
1703  if( transform.x1 < -1 || transform.x1 > 1 )
1704  SCH_PARSE_ERROR( "invalid component X1 transform value", aReader, line );
1705 
1706  transform.y1 = parseInt( aReader, line, &line );
1707 
1708  if( transform.y1 < -1 || transform.y1 > 1 )
1709  SCH_PARSE_ERROR( "invalid component Y1 transform value", aReader, line );
1710 
1711  transform.x2 = parseInt( aReader, line, &line );
1712 
1713  if( transform.x2 < -1 || transform.x2 > 1 )
1714  SCH_PARSE_ERROR( "invalid component X2 transform value", aReader, line );
1715 
1716  transform.y2 = parseInt( aReader, line, &line );
1717 
1718  if( transform.y2 < -1 || transform.y2 > 1 )
1719  SCH_PARSE_ERROR( "invalid component Y2 transform value", aReader, line );
1720 
1721  component->SetTransform( transform );
1722  }
1723 
1724  line = aReader.ReadLine();
1725  }
1726 
1727  SCH_PARSE_ERROR( "invalid component line", aReader, line );
1728 
1729  return NULL; // Prevents compiler warning. Should never get here.
1730 }
#define TEXT_ANGLE_HORIZ
Class SCH_FIELD instances are attached to a component and provide a place for the component's value,...
Definition: sch_field.h:52
char * Line() const
Function Line returns a pointer to the last line that was read in.
Definition: richio.h:139
int y2
Definition: transform.h:51
virtual const wxString & GetSource() const
Function GetSource returns the name of the source of the lines in an abstract sense.
Definition: richio.h:130
#define TEXT_ANGLE_VERT
static uint32_t parseHex(LINE_READER &aReader, const char *aLine, const char **aOutput=NULL)
Parse an ASCII hex integer string with possible leading whitespace into a long integer and updates th...
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors.
int x2
Definition: transform.h:50
static void parseQuotedString(wxString &aString, LINE_READER &aReader, const char *aCurrentToken, const char **aNextToken=NULL, bool aCanBeEmpty=false)
Parse an quoted ASCII utf8 and updates the pointer at aOutput if it is not NULL.
SCH_SHEET * m_rootSheet
The root sheet of the schematic being loaded..
int x1
Definition: transform.h:48
static const wxString GetDefaultFieldName(int aFieldNdx)
Function GetDefaultFieldName returns a default symbol field name for field aFieldNdx for all componen...
#define MAX_UNIT_COUNT_PER_PACKAGE
The maximum number of units per package.
Definition: eeschema_id.h:44
static void parseUnquotedString(wxString &aString, LINE_READER &aReader, const char *aCurrentToken, const char **aNextToken=NULL, bool aCanBeEmpty=false)
Parse an unquoted utf8 string and updates the pointer at aOutput if it is not NULL.
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
SCH_SCREEN * GetScreen()
Definition: sch_sheet.h:271
Field Reference of part, i.e. "IC21".
int m_version
Version of file being loaded.
int y1
Definition: transform.h:49
Class for tranforming drawing coordinates for a wxDC device context.
Definition: transform.h:45
virtual unsigned LineNumber() const
Function Line Number returns the line number of the last line read from this LINE_READER.
Definition: richio.h:159
static char parseChar(LINE_READER &aReader, const char *aCurrentToken, const char **aNextToken=NULL)
Parse a single ASCII character and updates the pointer at aOutput if it is not NULL.
#define THROW_PARSE_ERROR(aProblem, aSource, aInputLine, aLineNumber, aByteIndex)
static int parseInt(LINE_READER &aReader, const char *aLine, const char **aOutput=NULL)
Parse an ASCII integer string with possible leading whitespace into an integer and updates the pointe...
#define _(s)
int SetLibItemName(const UTF8 &aLibItemName, bool aTestForRev=true)
Override the library item name portion of the LIB_ID to aLibItemName.
Definition: lib_id.cpp:206
virtual char * ReadLine()=0
Function ReadLine reads a line of text into the buffer and increments the line number counter.
#define SCH_PARSE_ERROR(text, reader, pos)
const char * name
Definition: DXF_plotter.cpp:61
Class SCH_COMPONENT describes a real schematic component.
Definition: sch_component.h:73
static bool strCompare(const char *aString, const char *aLine, const char **aOutput=NULL)
Compare aString to the string starting at aLine and advances the character point to the end of String...
void SetModify()
Definition: base_screen.h:224
int Parse(const UTF8 &aId, LIB_ID_TYPE aType, bool aFix=false)
Parse LIB_ID with the information from aId.
Definition: lib_id.cpp:122

References _, TEMPLATE_FIELDNAME::GetDefaultFieldName(), SCH_SHEET::GetScreen(), LINE_READER::GetSource(), GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_HJUSTIFY_RIGHT, GR_TEXT_VJUSTIFY_BOTTOM, GR_TEXT_VJUSTIFY_TOP, LIB_ID::ID_SCH, LINE_READER::Line(), LINE_READER::LineNumber(), m_rootSheet, m_version, MANDATORY_FIELDS, MAX_UNIT_COUNT_PER_PACKAGE, name, LIB_ID::Parse(), parseChar(), parseHex(), parseInt(), parseQuotedString(), parseUnquotedString(), LINE_READER::ReadLine(), REFERENCE, SCH_PARSE_ERROR, LIB_ID::SetLibItemName(), BASE_SCREEN::SetModify(), strCompare(), TEXT_ANGLE_HORIZ, TEXT_ANGLE_VERT, THROW_PARSE_ERROR, TRANSFORM::x1, TRANSFORM::x2, TRANSFORM::y1, and TRANSFORM::y2.

Referenced by LoadContent().

◆ LoadContent()

void SCH_LEGACY_PLUGIN::LoadContent ( LINE_READER aReader,
SCH_SCREEN aScreen,
int  version = EESCHEMA_VERSION 
)

Definition at line 755 of file sch_legacy_plugin.cpp.

756 {
757  m_version = version;
758 
759  while( aReader.ReadLine() )
760  {
761  char* line = aReader.Line();
762 
763  while( *line == ' ' )
764  line++;
765 
766  // Either an object will be loaded properly or the file load will fail and raise
767  // an exception.
768  if( strCompare( "$Descr", line ) )
769  loadPageSettings( aReader, aScreen );
770  else if( strCompare( "$Comp", line ) )
771  aScreen->Append( loadComponent( aReader ) );
772  else if( strCompare( "$Sheet", line ) )
773  aScreen->Append( loadSheet( aReader ) );
774  else if( strCompare( "$Bitmap", line ) )
775  aScreen->Append( loadBitmap( aReader ) );
776  else if( strCompare( "Connection", line ) )
777  aScreen->Append( loadJunction( aReader ) );
778  else if( strCompare( "NoConn", line ) )
779  aScreen->Append( loadNoConnect( aReader ) );
780  else if( strCompare( "Wire", line ) )
781  aScreen->Append( loadWire( aReader ) );
782  else if( strCompare( "Entry", line ) )
783  aScreen->Append( loadBusEntry( aReader ) );
784  else if( strCompare( "Text", line ) )
785  aScreen->Append( loadText( aReader ) );
786  else if( strCompare( "BusAlias", line ) )
787  aScreen->AddBusAlias( loadBusAlias( aReader, aScreen ) );
788  else if( strCompare( "$EndSCHEMATC", line ) )
789  return;
790  else
791  SCH_PARSE_ERROR( "unrecognized token", aReader, line );
792  }
793 }
SCH_SHEET * loadSheet(LINE_READER &aReader)
SCH_JUNCTION * loadJunction(LINE_READER &aReader)
char * Line() const
Function Line returns a pointer to the last line that was read in.
Definition: richio.h:139
SCH_COMPONENT * loadComponent(LINE_READER &aReader)
SCH_BUS_ENTRY_BASE * loadBusEntry(LINE_READER &aReader)
int m_version
Version of file being loaded.
void loadPageSettings(LINE_READER &aReader, SCH_SCREEN *aScreen)
SCH_BITMAP * loadBitmap(LINE_READER &aReader)
virtual char * ReadLine()=0
Function ReadLine reads a line of text into the buffer and increments the line number counter.
#define SCH_PARSE_ERROR(text, reader, pos)
void AddBusAlias(std::shared_ptr< BUS_ALIAS > aAlias)
Adds a bus alias definition (and transfers ownership of the pointer)
Definition: sch_screen.cpp:917
void Append(SCH_ITEM *aItem)
Definition: sch_screen.h:149
static bool strCompare(const char *aString, const char *aLine, const char **aOutput=NULL)
Compare aString to the string starting at aLine and advances the character point to the end of String...
SCH_NO_CONNECT * loadNoConnect(LINE_READER &aReader)
SCH_LINE * loadWire(LINE_READER &aReader)
SCH_TEXT * loadText(LINE_READER &aReader)
std::shared_ptr< BUS_ALIAS > loadBusAlias(LINE_READER &aReader, SCH_SCREEN *aScreen)

References SCH_SCREEN::AddBusAlias(), SCH_SCREEN::Append(), LINE_READER::Line(), loadBitmap(), loadBusAlias(), loadBusEntry(), loadComponent(), loadJunction(), loadNoConnect(), loadPageSettings(), loadSheet(), loadText(), loadWire(), m_version, LINE_READER::ReadLine(), SCH_PARSE_ERROR, and strCompare().

Referenced by loadFile(), and SCH_EDITOR_CONTROL::Paste().

◆ loadFile()

void SCH_LEGACY_PLUGIN::loadFile ( const wxString &  aFileName,
SCH_SCREEN aScreen 
)
private

Definition at line 732 of file sch_legacy_plugin.cpp.

733 {
734  FILE_LINE_READER reader( aFileName );
735 
736  loadHeader( reader, aScreen );
737 
738  LoadContent( reader, aScreen, m_version );
739 
740  // Unfortunately schematic files prior to version 2 are not terminated with $EndSCHEMATC
741  // so checking for it's existance will fail so just exit here and take our chances. :(
742  if( m_version > 1 )
743  {
744  char* line = reader.Line();
745 
746  while( *line == ' ' )
747  line++;
748 
749  if( !strCompare( "$EndSCHEMATC", line ) )
750  THROW_IO_ERROR( "'$EndSCHEMATC' not found" );
751  }
752 }
void LoadContent(LINE_READER &aReader, SCH_SCREEN *aScreen, int version=EESCHEMA_VERSION)
int m_version
Version of file being loaded.
Class FILE_LINE_READER is a LINE_READER that reads from an open file.
Definition: richio.h:180
#define THROW_IO_ERROR(msg)
static bool strCompare(const char *aString, const char *aLine, const char **aOutput=NULL)
Compare aString to the string starting at aLine and advances the character point to the end of String...
void loadHeader(LINE_READER &aReader, SCH_SCREEN *aScreen)

References LINE_READER::Line(), LoadContent(), loadHeader(), m_version, strCompare(), and THROW_IO_ERROR.

Referenced by loadHierarchy().

◆ loadHeader()

void SCH_LEGACY_PLUGIN::loadHeader ( LINE_READER aReader,
SCH_SCREEN aScreen 
)
private

Definition at line 796 of file sch_legacy_plugin.cpp.

797 {
798  const char* line = aReader.ReadLine();
799 
800  if( !line || !strCompare( "Eeschema Schematic File Version", line, &line ) )
801  {
802  m_error.Printf( _( "\"%s\" does not appear to be an Eeschema file" ),
803  GetChars( aScreen->GetFileName() ) );
805  }
806 
807  // get the file version here.
808  m_version = parseInt( aReader, line, &line );
809 
810  // The next lines are the lib list section, and are mainly comments, like:
811  // LIBS:power
812  // the lib list is not used, but is in schematic file just in case.
813  // It is usually not empty, but we accept empty list.
814  // If empty, there is a legacy section, not used
815  // EELAYER i j
816  // and the last line is
817  // EELAYER END
818  // Skip all lines until the end of header "EELAYER END" is found
819  while( aReader.ReadLine() )
820  {
821  line = aReader.Line();
822 
823  while( *line == ' ' )
824  line++;
825 
826  if( strCompare( "EELAYER END", line ) )
827  return;
828  }
829 
830  THROW_IO_ERROR( _( "Missing 'EELAYER END'" ) );
831 }
const wxString & GetFileName() const
Definition: sch_screen.h:118
char * Line() const
Function Line returns a pointer to the last line that was read in.
Definition: richio.h:139
wxString m_error
For throwing exceptions or errors on partial schematic loads.
int m_version
Version of file being loaded.
#define THROW_IO_ERROR(msg)
static int parseInt(LINE_READER &aReader, const char *aLine, const char **aOutput=NULL)
Parse an ASCII integer string with possible leading whitespace into an integer and updates the pointe...
#define _(s)
virtual char * ReadLine()=0
Function ReadLine reads a line of text into the buffer and increments the line number counter.
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:101
static bool strCompare(const char *aString, const char *aLine, const char **aOutput=NULL)
Compare aString to the string starting at aLine and advances the character point to the end of String...

References _, GetChars(), SCH_SCREEN::GetFileName(), LINE_READER::Line(), m_error, m_version, parseInt(), LINE_READER::ReadLine(), strCompare(), and THROW_IO_ERROR.

Referenced by loadFile().

◆ loadHierarchy()

void SCH_LEGACY_PLUGIN::loadHierarchy ( SCH_SHEET aSheet)
private

Definition at line 651 of file sch_legacy_plugin.cpp.

652 {
653  SCH_SCREEN* screen = NULL;
654 
655  if( !aSheet->GetScreen() )
656  {
657  // SCH_SCREEN objects store the full path and file name where the SCH_SHEET object only
658  // stores the file name and extension. Add the project path to the file name and
659  // extension to compare when calling SCH_SHEET::SearchHierarchy().
660  wxFileName fileName = aSheet->GetFileName();
661 
662  if( !fileName.IsAbsolute() )
663  fileName.MakeAbsolute( m_currentPath.top() );
664 
665  // Save the current path so that it gets restored when decending and ascending the
666  // sheet hierarchy which allows for sheet schematic files to be nested in folders
667  // relative to the last path a schematic was loaded from.
668  wxLogTrace( traceSchLegacyPlugin, "Saving path \"%s\"", m_currentPath.top() );
669  m_currentPath.push( fileName.GetPath() );
670  wxLogTrace( traceSchLegacyPlugin, "Current path \"%s\"", m_currentPath.top() );
671  wxLogTrace( traceSchLegacyPlugin, "Loading \"%s\"", fileName.GetFullPath() );
672 
673  m_rootSheet->SearchHierarchy( fileName.GetFullPath(), &screen );
674 
675  if( screen )
676  {
677  aSheet->SetScreen( screen );
678 
679  // Do not need to load the sub-sheets - this has already been done.
680  }
681  else
682  {
683  aSheet->SetScreen( new SCH_SCREEN( m_kiway ) );
684  aSheet->GetScreen()->SetFileName( fileName.GetFullPath() );
685 
686  try
687  {
688  loadFile( fileName.GetFullPath(), aSheet->GetScreen() );
689 
690  EDA_ITEM* item = aSheet->GetScreen()->GetDrawItems();
691 
692  while( item )
693  {
694  if( item->Type() == SCH_SHEET_T )
695  {
696  SCH_SHEET* sheet = (SCH_SHEET*) item;
697 
698  // Set the parent to aSheet. This effectively creates a method to find
699  // the root sheet from any sheet so a pointer to the root sheet does not
700  // need to be stored globally. Note: this is not the same as a hierarchy.
701  // Complex hierarchies can have multiple copies of a sheet. This only
702  // provides a simple tree to find the root sheet.
703  sheet->SetParent( aSheet );
704 
705  // Recursion starts here.
706  loadHierarchy( sheet );
707  }
708 
709  item = item->Next();
710  }
711  }
712  catch( const IO_ERROR& ioe )
713  {
714  // If there is a problem loading the root sheet, there is no recovery.
715  if( aSheet == m_rootSheet )
716  throw( ioe );
717 
718  // For all subsheets, queue up the error message for the caller.
719  if( !m_error.IsEmpty() )
720  m_error += "\n";
721 
722  m_error += ioe.What();
723  }
724  }
725 
726  m_currentPath.pop();
727  wxLogTrace( traceSchLegacyPlugin, "Restoring path \"%s\"", m_currentPath.top() );
728  }
729 }
bool SearchHierarchy(const wxString &aFilename, SCH_SCREEN **aScreen)
Search the existing hierarchy for an instance of screen loaded from aFileName.
Definition: sch_sheet.cpp:542
wxString m_error
For throwing exceptions or errors on partial schematic loads.
void SetScreen(SCH_SCREEN *aScreen)
Set the SCH_SCREEN associated with this sheet to aScreen.
Definition: sch_sheet.cpp:104
const wxChar *const traceSchLegacyPlugin
Flag to enable legacy schematic plugin debug output.
SCH_SHEET * m_rootSheet
The root sheet of the schematic being loaded..
SCH_SCREEN * GetScreen()
Definition: sch_sheet.h:271
void loadFile(const wxString &aFileName, SCH_SCREEN *aScreen)
void loadHierarchy(SCH_SHEET *aSheet)
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:33
void SetParent(EDA_ITEM *aParent)
Definition: base_struct.h:225
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:204
wxString GetFileName(void) const
Return the filename corresponding to this sheet.
Definition: sch_sheet.cpp:629
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:163
void SetFileName(const wxString &aFileName)
Definition: sch_screen.h:116
KIWAY * m_kiway
Required for path to legacy component libraries.
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:76
std::stack< wxString > m_currentPath
Stack to maintain nested sheet paths.
SCH_ITEM * GetDrawItems() const
Definition: sch_screen.h:147

References SCH_SCREEN::GetDrawItems(), SCH_SHEET::GetFileName(), SCH_SHEET::GetScreen(), loadFile(), m_currentPath, m_error, m_kiway, m_rootSheet, SCH_SHEET_T, SCH_SHEET::SearchHierarchy(), SCH_SCREEN::SetFileName(), EDA_ITEM::SetParent(), SCH_SHEET::SetScreen(), traceSchLegacyPlugin, and IO_ERROR::What().

Referenced by Load().

◆ loadJunction()

SCH_JUNCTION * SCH_LEGACY_PLUGIN::loadJunction ( LINE_READER aReader)
private

Definition at line 1149 of file sch_legacy_plugin.cpp.

1150 {
1151  std::unique_ptr< SCH_JUNCTION > junction( new SCH_JUNCTION );
1152 
1153  const char* line = aReader.Line();
1154 
1155  wxCHECK( strCompare( "Connection", line, &line ), NULL );
1156 
1157  wxString name;
1158 
1159  parseUnquotedString( name, aReader, line, &line );
1160 
1161  wxPoint position;
1162 
1163  position.x = parseInt( aReader, line, &line );
1164  position.y = parseInt( aReader, line, &line );
1165  junction->SetPosition( position );
1166 
1167  return junction.release();
1168 }
char * Line() const
Function Line returns a pointer to the last line that was read in.
Definition: richio.h:139
static void parseUnquotedString(wxString &aString, LINE_READER &aReader, const char *aCurrentToken, const char **aNextToken=NULL, bool aCanBeEmpty=false)
Parse an unquoted utf8 string and updates the pointer at aOutput if it is not NULL.
static int parseInt(LINE_READER &aReader, const char *aLine, const char **aOutput=NULL)
Parse an ASCII integer string with possible leading whitespace into an integer and updates the pointe...
const char * name
Definition: DXF_plotter.cpp:61
static bool strCompare(const char *aString, const char *aLine, const char **aOutput=NULL)
Compare aString to the string starting at aLine and advances the character point to the end of String...

References LINE_READER::Line(), name, parseInt(), parseUnquotedString(), and strCompare().

Referenced by LoadContent().

◆ loadNoConnect()

SCH_NO_CONNECT * SCH_LEGACY_PLUGIN::loadNoConnect ( LINE_READER aReader)
private

Definition at line 1171 of file sch_legacy_plugin.cpp.

1172 {
1173  std::unique_ptr< SCH_NO_CONNECT > no_connect( new SCH_NO_CONNECT );
1174 
1175  const char* line = aReader.Line();
1176 
1177  wxCHECK( strCompare( "NoConn", line, &line ), NULL );
1178 
1179  wxString name;
1180 
1181  parseUnquotedString( name, aReader, line, &line );
1182 
1183  wxPoint position;
1184 
1185  position.x = parseInt( aReader, line, &line );
1186  position.y = parseInt( aReader, line, &line );
1187  no_connect->SetPosition( position );
1188 
1189  return no_connect.release();
1190 }
char * Line() const
Function Line returns a pointer to the last line that was read in.
Definition: richio.h:139
static void parseUnquotedString(wxString &aString, LINE_READER &aReader, const char *aCurrentToken, const char **aNextToken=NULL, bool aCanBeEmpty=false)
Parse an unquoted utf8 string and updates the pointer at aOutput if it is not NULL.
static int parseInt(LINE_READER &aReader, const char *aLine, const char **aOutput=NULL)
Parse an ASCII integer string with possible leading whitespace into an integer and updates the pointe...
const char * name
Definition: DXF_plotter.cpp:61
static bool strCompare(const char *aString, const char *aLine, const char **aOutput=NULL)
Compare aString to the string starting at aLine and advances the character point to the end of String...

References LINE_READER::Line(), name, parseInt(), parseUnquotedString(), and strCompare().

Referenced by LoadContent().

◆ loadPageSettings()

void SCH_LEGACY_PLUGIN::loadPageSettings ( LINE_READER aReader,
SCH_SCREEN aScreen 
)
private

Definition at line 834 of file sch_legacy_plugin.cpp.

835 {
836  wxASSERT( aScreen != NULL );
837 
838  wxString buf;
839  const char* line = aReader.Line();
840 
841  PAGE_INFO pageInfo;
842  TITLE_BLOCK tb;
843 
844  wxCHECK_RET( strCompare( "$Descr", line, &line ), "Invalid sheet description" );
845 
846  parseUnquotedString( buf, aReader, line, &line );
847 
848  if( !pageInfo.SetType( buf ) )
849  SCH_PARSE_ERROR( "invalid page size", aReader, line );
850 
851  int pagew = parseInt( aReader, line, &line );
852  int pageh = parseInt( aReader, line, &line );
853 
854  if( buf == PAGE_INFO::Custom )
855  {
856  pageInfo.SetWidthMils( pagew );
857  pageInfo.SetHeightMils( pageh );
858  }
859  else
860  {
861  wxString orientation;
862 
863  // Non custom size, set portrait if its present. Can be empty string which defaults
864  // to landscape.
865  parseUnquotedString( orientation, aReader, line, &line, true );
866 
867  if( orientation == "portrait" )
868  pageInfo.SetPortrait( true );
869  }
870 
871  aScreen->SetPageSettings( pageInfo );
872 
873  while( line != NULL )
874  {
875  buf.clear();
876 
877  if( !aReader.ReadLine() )
878  SCH_PARSE_ERROR( _( "unexpected end of file" ), aReader, line );
879 
880  line = aReader.Line();
881 
882  if( strCompare( "Sheet", line, &line ) )
883  {
884  aScreen->m_ScreenNumber = parseInt( aReader, line, &line );
885  aScreen->m_NumberOfScreens = parseInt( aReader, line, &line );
886  }
887  else if( strCompare( "Title", line, &line ) )
888  {
889  parseQuotedString( buf, aReader, line, &line, true );
890  tb.SetTitle( buf );
891  }
892  else if( strCompare( "Date", line, &line ) )
893  {
894  parseQuotedString( buf, aReader, line, &line, true );
895  tb.SetDate( buf );
896  }
897  else if( strCompare( "Rev", line, &line ) )
898  {
899  parseQuotedString( buf, aReader, line, &line, true );
900  tb.SetRevision( buf );
901  }
902  else if( strCompare( "Comp", line, &line ) )
903  {
904  parseQuotedString( buf, aReader, line, &line, true );
905  tb.SetCompany( buf );
906  }
907  else if( strCompare( "Comment1", line, &line ) )
908  {
909  parseQuotedString( buf, aReader, line, &line, true );
910  tb.SetComment1( buf );
911  }
912  else if( strCompare( "Comment2", line, &line ) )
913  {
914  parseQuotedString( buf, aReader, line, &line, true );
915  tb.SetComment2( buf );
916  }
917  else if( strCompare( "Comment3", line, &line ) )
918  {
919  parseQuotedString( buf, aReader, line, &line, true );
920  tb.SetComment3( buf );
921  }
922  else if( strCompare( "Comment4", line, &line ) )
923  {
924  parseQuotedString( buf, aReader, line, &line, true );
925  tb.SetComment4( buf );
926  }
927  else if( strCompare( "$EndDescr", line ) )
928  {
929  aScreen->SetTitleBlock( tb );
930  return;
931  }
932  }
933 
934  SCH_PARSE_ERROR( "missing 'EndDescr'", aReader, line );
935 }
void SetComment1(const wxString &aComment)
Definition: title_block.h:117
int m_ScreenNumber
Definition: base_screen.h:135
char * Line() const
Function Line returns a pointer to the last line that was read in.
Definition: richio.h:139
void SetRevision(const wxString &aRevision)
Definition: title_block.h:84
bool SetType(const wxString &aStandardPageDescriptionName, bool aIsPortrait=false)
Function SetType sets the name of the page type and also the sizes and margins commonly associated wi...
Definition: page_info.cpp:117
static void parseQuotedString(wxString &aString, LINE_READER &aReader, const char *aCurrentToken, const char **aNextToken=NULL, bool aCanBeEmpty=false)
Parse an quoted ASCII utf8 and updates the pointer at aOutput if it is not NULL.
void SetDate(const wxString &aDate)
Function SetDate sets the date field, and defaults to the current time and date.
Definition: title_block.h:74
void SetPageSettings(const PAGE_INFO &aPageSettings)
Definition: sch_screen.h:114
static const wxChar Custom[]
"User" defined page type
Definition: page_info.h:78
static void parseUnquotedString(wxString &aString, LINE_READER &aReader, const char *aCurrentToken, const char **aNextToken=NULL, bool aCanBeEmpty=false)
Parse an unquoted utf8 string and updates the pointer at aOutput if it is not NULL.
Class TITLE_BLOCK holds the information shown in the lower right corner of a plot,...
Definition: title_block.h:40
void SetComment4(const wxString &aComment)
Definition: title_block.h:120
Class PAGE_INFO describes the page size and margins of a paper page on which to eventually print or p...
Definition: page_info.h:54
void SetCompany(const wxString &aCompany)
Definition: title_block.h:94
void SetTitleBlock(const TITLE_BLOCK &aTitleBlock)
Definition: sch_screen.h:125
static int parseInt(LINE_READER &aReader, const char *aLine, const char **aOutput=NULL)
Parse an ASCII integer string with possible leading whitespace into an integer and updates the pointe...
void SetTitle(const wxString &aTitle)
Definition: title_block.h:60
#define _(s)
void SetHeightMils(int aHeightInMils)
Definition: page_info.cpp:253
void SetComment2(const wxString &aComment)
Definition: title_block.h:118
virtual char * ReadLine()=0
Function ReadLine reads a line of text into the buffer and increments the line number counter.
#define SCH_PARSE_ERROR(text, reader, pos)
void SetWidthMils(int aWidthInMils)
Definition: page_info.cpp:239
static bool strCompare(const char *aString, const char *aLine, const char **aOutput=NULL)
Compare aString to the string starting at aLine and advances the character point to the end of String...
int m_NumberOfScreens
Definition: base_screen.h:136
void SetComment3(const wxString &aComment)
Definition: title_block.h:119
void SetPortrait(bool aIsPortrait)
Function SetPortrait will rotate the paper page 90 degrees.
Definition: page_info.cpp:182

References _, PAGE_INFO::Custom, LINE_READER::Line(), BASE_SCREEN::m_NumberOfScreens, BASE_SCREEN::m_ScreenNumber, parseInt(), parseQuotedString(), parseUnquotedString(), LINE_READER::ReadLine(), SCH_PARSE_ERROR, TITLE_BLOCK::SetComment1(), TITLE_BLOCK::SetComment2(), TITLE_BLOCK::SetComment3(), TITLE_BLOCK::SetComment4(), TITLE_BLOCK::SetCompany(), TITLE_BLOCK::SetDate(), PAGE_INFO::SetHeightMils(), SCH_SCREEN::SetPageSettings(), PAGE_INFO::SetPortrait(), TITLE_BLOCK::SetRevision(), TITLE_BLOCK::SetTitle(), SCH_SCREEN::SetTitleBlock(), PAGE_INFO::SetType(), PAGE_INFO::SetWidthMils(), and strCompare().

Referenced by LoadContent().

◆ loadSheet()

SCH_SHEET * SCH_LEGACY_PLUGIN::loadSheet ( LINE_READER aReader)
private

Definition at line 938 of file sch_legacy_plugin.cpp.

939 {
940  std::unique_ptr< SCH_SHEET > sheet( new SCH_SHEET() );
941 
942  sheet->SetTimeStamp( GetNewTimeStamp() );
943 
944  const char* line = aReader.ReadLine();
945 
946  while( line != NULL )
947  {
948  if( strCompare( "S", line, &line ) ) // Sheet dimensions.
949  {
950  wxPoint position;
951 
952  position.x = parseInt( aReader, line, &line );
953  position.y = parseInt( aReader, line, &line );
954  sheet->SetPosition( position );
955 
956  wxSize size;
957 
958  size.SetWidth( parseInt( aReader, line, &line ) );
959  size.SetHeight( parseInt( aReader, line, &line ) );
960  sheet->SetSize( size );
961  }
962  else if( strCompare( "U", line, &line ) ) // Sheet time stamp.
963  {
964  sheet->SetTimeStamp( parseHex( aReader, line ) );
965  }
966  else if( *line == 'F' ) // Sheet field.
967  {
968  line++;
969 
970  wxString text;
971  int size;
972  int fieldId = parseInt( aReader, line, &line );
973 
974  if( fieldId == 0 || fieldId == 1 ) // Sheet name and file name.
975  {
976  parseQuotedString( text, aReader, line, &line );
977  size = parseInt( aReader, line, &line );
978 
979  if( fieldId == 0 )
980  {
981  sheet->SetName( text );
982  sheet->SetSheetNameSize( size );
983  }
984  else
985  {
986  sheet->SetFileName( text );
987  sheet->SetFileNameSize( size );
988  }
989  }
990  else // Sheet pin.
991  {
992  std::unique_ptr< SCH_SHEET_PIN > sheetPin( new SCH_SHEET_PIN( sheet.get() ) );
993 
994  sheetPin->SetNumber( fieldId );
995 
996  // Can be empty fields.
997  parseQuotedString( text, aReader, line, &line, true );
998 
999  sheetPin->SetText( text );
1000 
1001  if( line == NULL )
1002  THROW_IO_ERROR( _( "unexpected end of line" ) );
1003 
1004  switch( parseChar( aReader, line, &line ) )
1005  {
1006  case 'I':
1007  sheetPin->SetShape( NET_INPUT );
1008  break;
1009 
1010  case 'O':
1011  sheetPin->SetShape( NET_OUTPUT );
1012  break;
1013 
1014  case 'B':
1015  sheetPin->SetShape( NET_BIDI );
1016  break;
1017 
1018  case 'T':
1019  sheetPin->SetShape( NET_TRISTATE );
1020  break;
1021 
1022  case 'U':
1023  sheetPin->SetShape( NET_UNSPECIFIED );
1024  break;
1025  default:
1026  SCH_PARSE_ERROR( "invalid sheet pin type", aReader, line );
1027  }
1028 
1029  switch( parseChar( aReader, line, &line ) )
1030  {
1031  case 'R': sheetPin->SetEdge( SHEET_RIGHT_SIDE ); break;
1032  case 'T': sheetPin->SetEdge( SHEET_TOP_SIDE ); break;
1033  case 'B': sheetPin->SetEdge( SHEET_BOTTOM_SIDE ); break;
1034  case 'L': sheetPin->SetEdge( SHEET_LEFT_SIDE ); break;
1035  default:
1036  SCH_PARSE_ERROR( "invalid sheet pin side", aReader, line );
1037  }
1038 
1039  wxPoint position;
1040 
1041  position.x = parseInt( aReader, line, &line );
1042  position.y = parseInt( aReader, line, &line );
1043  sheetPin->SetPosition( position );
1044 
1045  size = parseInt( aReader, line, &line );
1046 
1047  sheetPin->SetTextSize( wxSize( size, size ) );
1048 
1049  sheet->AddPin( sheetPin.release() );
1050  }
1051  }
1052  else if( strCompare( "$EndSheet", line ) )
1053  return sheet.release();
1054 
1055  line = aReader.ReadLine();
1056  }
1057 
1058  SCH_PARSE_ERROR( "missing '$EndSheet`", aReader, line );
1059 
1060  return NULL; // Prevents compiler warning. Should never get here.
1061 }
static uint32_t parseHex(LINE_READER &aReader, const char *aLine, const char **aOutput=NULL)
Parse an ASCII hex integer string with possible leading whitespace into a long integer and updates th...
static void parseQuotedString(wxString &aString, LINE_READER &aReader, const char *aCurrentToken, const char **aNextToken=NULL, bool aCanBeEmpty=false)
Parse an quoted ASCII utf8 and updates the pointer at aOutput if it is not NULL.
timestamp_t GetNewTimeStamp()
Definition: common.cpp:217
static char parseChar(LINE_READER &aReader, const char *aCurrentToken, const char **aNextToken=NULL)
Parse a single ASCII character and updates the pointer at aOutput if it is not NULL.
#define THROW_IO_ERROR(msg)
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:75
static int parseInt(LINE_READER &aReader, const char *aLine, const char **aOutput=NULL)
Parse an ASCII integer string with possible leading whitespace into an integer and updates the pointe...
#define _(s)
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:204
virtual char * ReadLine()=0
Function ReadLine reads a line of text into the buffer and increments the line number counter.
#define SCH_PARSE_ERROR(text, reader, pos)
static bool strCompare(const char *aString, const char *aLine, const char **aOutput=NULL)
Compare aString to the string starting at aLine and advances the character point to the end of String...

References _, GetNewTimeStamp(), NET_BIDI, NET_INPUT, NET_OUTPUT, NET_TRISTATE, NET_UNSPECIFIED, parseChar(), parseHex(), parseInt(), parseQuotedString(), LINE_READER::ReadLine(), SCH_PARSE_ERROR, SHEET_BOTTOM_SIDE, SHEET_LEFT_SIDE, SHEET_RIGHT_SIDE, SHEET_TOP_SIDE, strCompare(), and THROW_IO_ERROR.

Referenced by LoadContent().

◆ LoadSymbol()

LIB_ALIAS * SCH_LEGACY_PLUGIN::LoadSymbol ( const wxString &  aLibraryPath,
const wxString &  aAliasName,
const PROPERTIES aProperties = nullptr 
)
overridevirtual

Load a LIB_ALIAS object having aAliasName from the aLibraryPath containing a library format that this SCH_PLUGIN knows about.

The LIB_PART should be accessed indirectly using the LIB_ALIAS it is associated with.

Parameters
aLibraryPathis a locator for the "library", usually a directory, file, or URL containing several symbols.
aAliasNameis the alias name of the LIB_PART to load.
aPropertiesis an associative array that can be used to tell the loader implementation to do something special, because it can take any number of additional named tuning arguments that the plugin is known to support. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL.
Returns
the alias if found caller shares it or NULL if not found.
Exceptions
IO_ERRORif the library cannot be found or read. No exception is thrown in the case where aAliasName cannot be found.

Reimplemented from SCH_PLUGIN.

Definition at line 4296 of file sch_legacy_plugin.cpp.

4298 {
4299  LOCALE_IO toggle; // toggles on, then off, the C locale.
4300 
4301  m_props = aProperties;
4302 
4303  cacheLib( aLibraryPath );
4304 
4305  LIB_ALIAS_MAP::const_iterator it = m_cache->m_aliases.find( aAliasName );
4306 
4307  if( it == m_cache->m_aliases.end() )
4308  return NULL;
4309 
4310  return it->second;
4311 }
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: common.h:175
SCH_LEGACY_PLUGIN_CACHE * m_cache
void cacheLib(const wxString &aLibraryFileName)
const PROPERTIES * m_props
Passed via Save() or Load(), no ownership, may be nullptr.

References cacheLib(), SCH_LEGACY_PLUGIN_CACHE::m_aliases, m_cache, and m_props.

◆ loadText()

SCH_TEXT * SCH_LEGACY_PLUGIN::loadText ( LINE_READER aReader)
private

Definition at line 1336 of file sch_legacy_plugin.cpp.

1337 {
1338  const char* line = aReader.Line();
1339 
1340  wxCHECK( strCompare( "Text", line, &line ), NULL );
1341 
1342  std::unique_ptr< SCH_TEXT> text;
1343 
1344  if( strCompare( "Notes", line, &line ) )
1345  text.reset( new SCH_TEXT );
1346  else if( strCompare( "Label", line, &line ) )
1347  text.reset( new SCH_LABEL );
1348  else if( strCompare( "HLabel", line, &line ) )
1349  text.reset( new SCH_HIERLABEL );
1350  else if( strCompare( "GLabel", line, &line ) )
1351  {
1352  // Prior to version 2, the SCH_GLOBALLABEL object did not exist.
1353  if( m_version == 1 )
1354  text.reset( new SCH_HIERLABEL );
1355  else
1356  text.reset( new SCH_GLOBALLABEL );
1357  }
1358  else
1359  SCH_PARSE_ERROR( "unknown Text type", aReader, line );
1360 
1361  // Parse the parameters common to all text objects.
1362  wxPoint position;
1363 
1364  position.x = parseInt( aReader, line, &line );
1365  position.y = parseInt( aReader, line, &line );
1366  text->SetPosition( position );
1367  text->SetLabelSpinStyle( parseInt( aReader, line, &line ) );
1368 
1369  int size = parseInt( aReader, line, &line );
1370 
1371  text->SetTextSize( wxSize( size, size ) );
1372 
1373  // Parse the global and hierarchical label type.
1374  if( text->Type() == SCH_HIER_LABEL_T || text->Type() == SCH_GLOBAL_LABEL_T )
1375  {
1376  if( strCompare( SheetLabelType[NET_INPUT], line, &line ) )
1377  text->SetShape( NET_INPUT );
1378  else if( strCompare( SheetLabelType[NET_OUTPUT], line, &line ) )
1379  text->SetShape( NET_OUTPUT );
1380  else if( strCompare( SheetLabelType[NET_BIDI], line, &line ) )
1381  text->SetShape( NET_BIDI );
1382  else if( strCompare( SheetLabelType[NET_TRISTATE], line, &line ) )
1383  text->SetShape( NET_TRISTATE );
1384  else if( strCompare( SheetLabelType[NET_UNSPECIFIED], line, &line ) )
1385  text->SetShape( NET_UNSPECIFIED );
1386  else
1387  SCH_PARSE_ERROR( "invalid label type", aReader, line );
1388  }
1389 
1390  int thickness = 0;
1391 
1392  // The following tokens do not exist in version 1 schematic files,
1393  // and not always in version 2 for HLabels and GLabels
1394  if( m_version > 1 )
1395  {
1396  if( m_version > 2 || *line >= ' ' )
1397  {
1398  if( strCompare( "Italic", line, &line ) )
1399  text->SetItalic( true );
1400  else if( !strCompare( "~", line, &line ) )
1401  SCH_PARSE_ERROR( _( "expected 'Italics' or '~'" ), aReader, line );
1402  }
1403 
1404  // The thickness token does not exist in older versions of the schematic file format
1405  // so calling parseInt will be made only if the EOL is not reached.
1406  if( *line >= ' ' )
1407  thickness = parseInt( aReader, line, &line );
1408  }
1409 
1410  text->SetBold( thickness != 0 );
1411  text->SetThickness( thickness != 0 ? GetPenSizeForBold( size ) : 0 );
1412 
1413  // Read the text string for the text.
1414  char* tmp = aReader.ReadLine();
1415 
1416  tmp = strtok( tmp, "\r\n" );
1417  wxString val = FROM_UTF8( tmp );
1418 
1419  for( ; ; )
1420  {
1421  int i = val.find( wxT( "\\n" ) );
1422 
1423  if( i == wxNOT_FOUND )
1424  break;
1425 
1426  val.erase( i, 2 );
1427  val.insert( i, wxT( "\n" ) );
1428  }
1429 
1430  text->SetText( val );
1431 
1432  return text.release();
1433 }
char * Line() const
Function Line returns a pointer to the last line that was read in.
Definition: richio.h:139
static wxString FROM_UTF8(const char *cstring)
function FROM_UTF8 converts a UTF8 encoded C string to a wxString for all wxWidgets build modes.
Definition: macros.h:62
int GetPenSizeForBold(int aTextSize)
Function GetPensizeForBold.
Definition: gr_text.cpp:49
const char * SheetLabelType[]
Definition: sch_text.cpp:57
int m_version
Version of file being loaded.
static int parseInt(LINE_READER &aReader, const char *aLine, const char **aOutput=NULL)
Parse an ASCII integer string with possible leading whitespace into an integer and updates the pointe...
#define _(s)
virtual char * ReadLine()=0
Function ReadLine reads a line of text into the buffer and increments the line number counter.
#define SCH_PARSE_ERROR(text, reader, pos)
size_t i
Definition: json11.cpp:597
static bool strCompare(const char *aString, const char *aLine, const char **aOutput=NULL)
Compare aString to the string starting at aLine and advances the character point to the end of String...

References _, FROM_UTF8(), GetPenSizeForBold(), i, LINE_READER::Line(), m_version, NET_BIDI, NET_INPUT, NET_OUTPUT, NET_TRISTATE, NET_UNSPECIFIED, parseInt(), LINE_READER::ReadLine(), SCH_GLOBAL_LABEL_T, SCH_HIER_LABEL_T, SCH_PARSE_ERROR, SheetLabelType, and strCompare().

Referenced by LoadContent().

◆ loadWire()

SCH_LINE * SCH_LEGACY_PLUGIN::loadWire ( LINE_READER aReader)
private

Definition at line 1193 of file sch_legacy_plugin.cpp.

1194 {
1195  std::unique_ptr< SCH_LINE > wire( new SCH_LINE );
1196 
1197  const char* line = aReader.Line();
1198 
1199  wxCHECK( strCompare( "Wire", line, &line ), NULL );
1200 
1201  if( strCompare( "Wire", line, &line ) )
1202  wire->SetLayer( LAYER_WIRE );
1203  else if( strCompare( "Bus", line, &line ) )
1204  wire->SetLayer( LAYER_BUS );
1205  else if( strCompare( "Notes", line, &line ) )
1206  wire->SetLayer( LAYER_NOTES );
1207  else
1208  SCH_PARSE_ERROR( "invalid line type", aReader, line );
1209 
1210  if( !strCompare( "Line", line, &line ) )
1211  SCH_PARSE_ERROR( "invalid wire definition", aReader, line );
1212 
1213  // Since Sept 15, 2017, a line style is alloved (width, style, color)
1214  // Only non default values are stored
1215  while( !is_eol( *line ) )
1216  {
1217  wxString buf;
1218 
1219  parseUnquotedString( buf, aReader, line, &line );
1220 
1221  if( buf == ")" )
1222  continue;
1223 
1224  else if( buf == T_WIDTH )
1225  {
1226  int size = parseInt( aReader, line, &line );
1227  wire->SetLineWidth( size );
1228  }
1229  else if( buf == T_STYLE )
1230  {
1231  parseUnquotedString( buf, aReader, line, &line );
1232  int style = SCH_LINE::GetLineStyleInternalId( buf );
1233  wire->SetLineStyle( style );
1234  }
1235  else // should be the color parameter.
1236  {
1237  // The color param is something like rgb(150, 40, 191)
1238  // and because there is no space between ( and 150
1239  // the first param is inside buf.
1240  // So break keyword and the first param into 2 separate strings.
1241  wxString prm, keyword;
1242  keyword = buf.BeforeLast( '(', &prm );
1243 
1244  if( ( keyword == T_COLOR ) || ( keyword == T_COLORA ) )
1245  {
1246  long color[4] = { 0 };
1247 
1248  int ii = 0;
1249 
1250  if( !prm.IsEmpty() )
1251  {
1252  prm.ToLong( &color[ii] );
1253  ii++;
1254  }
1255 
1256  int prm_count = ( keyword == T_COLORA ) ? 4 : 3;
1257  // fix opacity to 1.0 or 255, when not exists in file
1258  color[3] = 255;
1259 
1260  for(; ii < prm_count && !is_eol( *line ); ii++ )
1261  {
1262  color[ii] = parseInt( aReader, line, &line );
1263 
1264  // Skip the separator between values
1265  if( *line == ',' || *line == ' ')
1266  line++;
1267  }
1268 
1269  wire->SetLineColor( color[0]/255.0, color[1]/255.0, color[2]/255.0,color[3]/255.0 );
1270  }
1271  }
1272  }
1273 
1274  // Read the segment en points coordinates:
1275  line = aReader.ReadLine();
1276 
1277  wxPoint begin, end;
1278 
1279  begin.x = parseInt( aReader, line, &line );
1280  begin.y = parseInt( aReader, line, &line );
1281  end.x = parseInt( aReader, line, &line );
1282  end.y = parseInt( aReader, line, &line );
1283 
1284  wire->SetStartPoint( begin );
1285  wire->SetEndPoint( end );
1286 
1287  return wire.release();
1288 }
char * Line() const
Function Line returns a pointer to the last line that was read in.
Definition: richio.h:139
int color
Definition: DXF_plotter.cpp:62
static void parseUnquotedString(wxString &aString, LINE_READER &aReader, const char *aCurrentToken, const char **aNextToken=NULL, bool aCanBeEmpty=false)
Parse an unquoted utf8 string and updates the pointer at aOutput if it is not NULL.
#define T_WIDTH
#define T_STYLE
static bool is_eol(char c)
#define T_COLOR
static int parseInt(LINE_READER &aReader, const char *aLine, const char **aOutput=NULL)
Parse an ASCII integer string with possible leading whitespace into an integer and updates the pointe...
static int GetLineStyleInternalId(const wxString &aStyleName)
Definition: sch_line.cpp:137
virtual char * ReadLine()=0
Function ReadLine reads a line of text into the buffer and increments the line number counter.
#define SCH_PARSE_ERROR(text, reader, pos)
Segment description base class to describe items which have 2 end points (track, wire,...
Definition: sch_line.h:37
static bool strCompare(const char *aString, const char *aLine, const char **aOutput=NULL)
Compare aString to the string starting at aLine and advances the character point to the end of String...
#define T_COLORA

References color, SCH_LINE::GetLineStyleInternalId(), is_eol(), LAYER_BUS, LAYER_NOTES, LAYER_WIRE, LINE_READER::Line(), parseInt(), parseUnquotedString(), LINE_READER::ReadLine(), SCH_PARSE_ERROR, strCompare(), T_COLOR, T_COLORA, T_STYLE, and T_WIDTH.

Referenced by LoadContent().

◆ ParsePart()

LIB_PART * SCH_LEGACY_PLUGIN::ParsePart ( LINE_READER aReader,
int  majorVersion = 0,
int  minorVersion = 0 
)
static

Definition at line 4444 of file sch_legacy_plugin.cpp.

4446 {
4447  return SCH_LEGACY_PLUGIN_CACHE::LoadPart( reader, aMajorVersion, aMinorVersion );
4448 }
static LIB_PART * LoadPart(LINE_READER &aReader, int aMajorVersion, int aMinorVersion)

References SCH_LEGACY_PLUGIN_CACHE::LoadPart().

Referenced by LIB_EDIT_FRAME::DuplicatePart(), and LIB_EDIT_TOOL::Paste().

◆ Save()

void SCH_LEGACY_PLUGIN::Save ( const wxString &  aFileName,
SCH_SCREEN aSchematic,
KIWAY aKiway,
const PROPERTIES aProperties = nullptr 
)
overridevirtual

Write aSchematic to a storage file in a format that this SCH_PLUGIN implementation knows about, or it can be used to write a portion of aSchematic to a special kind of export file.

Parameters
aFileNameis the name of a file to save to on disk.
aSchematicis the class SCH_SCREEN in memory document tree from which to extract information when writing to aFileName. The caller continues to own the SCHEMATIC, and the plugin should refrain from modifying the SCHEMATIC if possible.
aKiwayis the KIWAY object used to access the component libraries loaded by the project.
aPropertiesis an associative array that can be used to tell the saver how to save the file, because it can take any number of additional named tuning arguments that the plugin is known to support. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL.
Exceptions
IO_ERRORif there is a problem saving or exporting.

Reimplemented from SCH_PLUGIN.

Definition at line 1759 of file sch_legacy_plugin.cpp.

1761 {
1762  wxCHECK_RET( aScreen != NULL, "NULL SCH_SCREEN object." );
1763  wxCHECK_RET( !aFileName.IsEmpty(), "No schematic file name defined." );
1764 
1765  LOCALE_IO toggle; // toggles on, then off, the C locale, to write floating point values.
1766 
1767  init( aKiway, aProperties );
1768 
1769  wxFileName fn = aFileName;
1770 
1771  // File names should be absolute. Don't assume everything relative to the project path
1772  // works properly.
1773  wxASSERT( fn.IsAbsolute() );
1774 
1775  FILE_OUTPUTFORMATTER formatter( fn.GetFullPath() );
1776 
1777  m_out = &formatter; // no ownership
1778 
1779  Format( aScreen );
1780 }
void init(KIWAY *aKiway, const PROPERTIES *aProperties=nullptr)
initialize PLUGIN like a constructor would.
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: common.h:175
void Format(SCH_SCREEN *aScreen)
OUTPUTFORMATTER * m_out
The output formatter for saving SCH_SCREEN objects.
Class FILE_OUTPUTFORMATTER may be used for text file output.
Definition: richio.h:492

References Format(), init(), and m_out.

◆ saveBitmap()

void SCH_LEGACY_PLUGIN::saveBitmap ( SCH_BITMAP aBitmap)
private

Definition at line 2051 of file sch_legacy_plugin.cpp.

2052 {
2053  wxCHECK_RET( aBitmap != NULL, "SCH_BITMAP* is NULL" );
2054 
2055  const wxImage* image = aBitmap->GetImage()->GetImageData();
2056 
2057  wxCHECK_RET( image != NULL, "wxImage* is NULL" );
2058 
2059  m_out->Print( 0, "$Bitmap\n" );
2060  m_out->Print( 0, "Pos %-4d %-4d\n", aBitmap->GetPosition().x, aBitmap->GetPosition().y );
2061  m_out->Print( 0, "Scale %f\n", aBitmap->GetImage()->GetScale() );
2062  m_out->Print( 0, "Data\n" );
2063 
2064  wxMemoryOutputStream stream;
2065 
2066  image->SaveFile( stream, wxBITMAP_TYPE_PNG );
2067 
2068  // Write binary data in hexadecimal form (ASCII)
2069  wxStreamBuffer* buffer = stream.GetOutputStreamBuffer();
2070  char* begin = (char*) buffer->GetBufferStart();
2071 
2072  for( int ii = 0; begin < buffer->GetBufferEnd(); begin++, ii++ )
2073  {
2074  if( ii >= 32 )
2075  {
2076  ii = 0;
2077 
2078  m_out->Print( 0, "\n" );
2079  }
2080 
2081  m_out->Print( 0, "%2.2X ", *begin & 0xFF );
2082  }
2083 
2084  m_out->Print( 0, "\nEndData\n" );
2085  m_out->Print( 0, "$EndBitmap\n" );
2086 }
double GetScale() const
Definition: bitmap_base.h:92
wxImage * GetImageData()
Definition: bitmap_base.h:83
wxPoint GetPosition() const override
Function GetPosition.
Definition: sch_bitmap.h:135
BITMAP_BASE * GetImage()
Definition: sch_bitmap.h:59
OUTPUTFORMATTER * m_out
The output formatter for saving SCH_SCREEN objects.
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:404

References SCH_BITMAP::GetImage(), BITMAP_BASE::GetImageData(), SCH_BITMAP::GetPosition(), BITMAP_BASE::GetScale(), m_out, and OUTPUTFORMATTER::Print().

Referenced by Format().

◆ saveBusAlias()

void SCH_LEGACY_PLUGIN::saveBusAlias ( std::shared_ptr< BUS_ALIAS aAlias)
private

Definition at line 2277 of file sch_legacy_plugin.cpp.

2278 {
2279  wxCHECK_RET( aAlias != NULL, "BUS_ALIAS* is NULL" );
2280 
2281  wxString members = boost::algorithm::join( aAlias->Members(), " " );
2282 
2283  m_out->Print( 0, "BusAlias %s %s\n",
2284  TO_UTF8( aAlias->GetName() ), TO_UTF8( members ) );
2285 }
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:48
OUTPUTFORMATTER * m_out
The output formatter for saving SCH_SCREEN objects.
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:404

References m_out, OUTPUTFORMATTER::Print(), and TO_UTF8.

Referenced by Format().

◆ saveBusEntry()

void SCH_LEGACY_PLUGIN::saveBusEntry ( SCH_BUS_ENTRY_BASE aBusEntry)
private

Definition at line 2162 of file sch_legacy_plugin.cpp.

2163 {
2164  wxCHECK_RET( aBusEntry != NULL, "SCH_BUS_ENTRY_BASE* is NULL" );
2165 
2166  if( aBusEntry->GetLayer() == LAYER_WIRE )
2167  m_out->Print( 0, "Entry Wire Line\n\t%-4d %-4d %-4d %-4d\n",
2168  aBusEntry->GetPosition().x, aBusEntry->GetPosition().y,
2169  aBusEntry->m_End().x, aBusEntry->m_End().y );
2170  else
2171  m_out->Print( 0, "Entry Bus Bus\n\t%-4d %-4d %-4d %-4d\n",
2172  aBusEntry->GetPosition().x, aBusEntry->GetPosition().y,
2173  aBusEntry->m_End().x, aBusEntry->m_End().y );
2174 }
wxPoint m_End() const
SCH_LAYER_ID GetLayer() const
Function GetLayer returns the layer this item is on.
Definition: sch_item.h:193
OUTPUTFORMATTER * m_out
The output formatter for saving SCH_SCREEN objects.
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:404
wxPoint GetPosition() const override
Function GetPosition.

References SCH_ITEM::GetLayer(), SCH_BUS_ENTRY_BASE::GetPosition(), LAYER_WIRE, SCH_BUS_ENTRY_BASE::m_End(), m_out, and OUTPUTFORMATTER::Print().

Referenced by Format().

◆ saveComponent()

void SCH_LEGACY_PLUGIN::saveComponent ( SCH_COMPONENT aComponent)
private

Definition at line 1914 of file sch_legacy_plugin.cpp.

1915 {
1916  std::string name1;
1917  std::string name2;
1918  wxArrayString reference_fields;
1919 
1920  static wxString delimiters( wxT( " " ) );
1921 
1922  // This is redundant with the AR entries below, but it makes the files backwards-compatible.
1923  if( aComponent->GetPathsAndReferences().GetCount() > 0 )
1924  {
1925  reference_fields = wxStringTokenize( aComponent->GetPathsAndReferences()[0], delimiters );
1926  name1 = toUTFTildaText( reference_fields[1] );
1927  }
1928  else
1929  {
1930  if( aComponent->GetField( REFERENCE )->GetText().IsEmpty() )
1931  name1 = toUTFTildaText( aComponent->GetPrefix() );
1932  else
1933  name1 = toUTFTildaText( aComponent->GetField( REFERENCE )->GetText() );
1934  }
1935 
1936  wxString part_name = aComponent->GetLibId().Format();
1937 
1938  if( part_name.size() )
1939  {
1940  name2 = toUTFTildaText( part_name );
1941  }
1942  else
1943  {
1944  name2 = "_NONAME_";
1945  }
1946 
1947  m_out->Print( 0, "$Comp\n" );
1948  m_out->Print( 0, "L %s %s\n", name2.c_str(), name1.c_str() );
1949 
1950  // Generate unit number, convert and time stamp
1951  m_out->Print( 0, "U %d %d %8.8X\n", aComponent->GetUnit(), aComponent->GetConvert(),
1952  aComponent->GetTimeStamp() );
1953 
1954  // Save the position
1955  m_out->Print( 0, "P %d %d\n", aComponent->GetPosition().x, aComponent->GetPosition().y );
1956 
1957  /* If this is a complex hierarchy; save hierarchical references.
1958  * but for simple hierarchies it is not necessary.
1959  * the reference inf is already saved
1960  * this is useful for old Eeschema version compatibility
1961  */
1962  if( aComponent->GetPathsAndReferences().GetCount() > 1 )
1963  {
1964  for( unsigned int ii = 0; ii < aComponent->GetPathsAndReferences().GetCount(); ii++ )
1965  {
1966  /*format:
1967  * AR Path="/140/2" Ref="C99" Part="1"
1968  * where 140 is the uid of the containing sheet
1969  * and 2 is the timestamp of this component.
1970  * (timestamps are actually 8 hex chars)
1971  * Ref is the conventional component reference for this 'path'
1972  * Part is the conventional component part selection for this 'path'
1973  */
1974  reference_fields = wxStringTokenize( aComponent->GetPathsAndReferences()[ii],
1975  delimiters );
1976 
1977  m_out->Print( 0, "AR Path=\"%s\" Ref=\"%s\" Part=\"%s\" \n",
1978  TO_UTF8( reference_fields[0] ),
1979  TO_UTF8( reference_fields[1] ),
1980  TO_UTF8( reference_fields[2] ) );
1981  }
1982  }
1983 
1984  // update the ugly field index, which I would like to see go away someday soon.
1985  for( int i = 0; i < aComponent->GetFieldCount(); ++i )
1986  aComponent->GetField( i )->SetId( i );
1987 
1988  // Fixed fields:
1989  // Save mandatory fields even if they are blank,
1990  // because the visibility, size and orientation are set from libary editor.
1991  for( unsigned i = 0; i < MANDATORY_FIELDS; ++i )
1992  saveField( aComponent->GetField( i ) );
1993 
1994  // User defined fields:
1995  // The *policy* about which user defined fields are part of a symbol is now
1996  // only in the dialog editors. No policy should be enforced here, simply
1997  // save all the user defined fields, they are present because a dialog editor
1998  // thought they should be. If you disagree, go fix the dialog editors.
1999  for( int i = MANDATORY_FIELDS; i < aComponent->GetFieldCount(); ++i )
2000  saveField( aComponent->GetField( i ) );
2001 
2002  // Unit number, position, box ( old standard )
2003  m_out->Print( 0, "\t%-4d %-4d %-4d\n", aComponent->GetUnit(), aComponent->GetPosition().x,
2004  aComponent->GetPosition().y );
2005 
2006  TRANSFORM transform = aComponent->GetTransform();
2007 
2008  m_out->Print( 0, "\t%-4d %-4d %-4d %-4d\n",
2009  transform.x1, transform.y1, transform.x2, transform.y2 );
2010  m_out->Print( 0, "$EndComp\n" );
2011 }
int y2
Definition: transform.h:51
The first 4 are mandatory, and must be instantiated in SCH_COMPONENT and LIB_PART constructors.
int x2
Definition: transform.h:50
wxString GetPrefix() const
int x1
Definition: transform.h:48
Field Reference of part, i.e. "IC21".
const wxArrayString & GetPathsAndReferences() const
void saveField(SCH_FIELD *aField)
SCH_FIELD * GetField(int aFieldNdx) const
Returns a field in this symbol.
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:48
int y1
Definition: transform.h:49
int GetUnit() const
Class for tranforming drawing coordinates for a wxDC device context.
Definition: transform.h:45
TRANSFORM & GetTransform() const
std::string toUTFTildaText(const wxString &txt)
Function toUTFTildaText convert a wxString to UTF8 and replace any control characters with a ~,...
timestamp_t GetTimeStamp() const
Definition: base_struct.h:216
int GetFieldCount() const
Return the number of fields in this symbol.
UTF8 Format() const
Definition: lib_id.cpp:237
OUTPUTFORMATTER * m_out
The output formatter for saving SCH_SCREEN objects.
size_t i
Definition: json11.cpp:597
wxPoint GetPosition() const override
Function GetPosition.
int GetConvert() const
void SetId(int aId)
Definition: sch_field.h:105
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:404
const LIB_ID & GetLibId() const
virtual const wxString & GetText() const
Function GetText returns the string associated with the text object.
Definition: eda_text.h:124

References LIB_ID::Format(), SCH_COMPONENT::GetConvert(), SCH_COMPONENT::GetField(), SCH_COMPONENT::GetFieldCount(), SCH_COMPONENT::GetLibId(), SCH_COMPONENT::GetPathsAndReferences(), SCH_COMPONENT::GetPosition(), SCH_COMPONENT::GetPrefix(), EDA_TEXT::GetText(), EDA_ITEM::GetTimeStamp(), SCH_COMPONENT::GetTransform(), SCH_COMPONENT::GetUnit(), i, m_out, MANDATORY_FIELDS, OUTPUTFORMATTER::Print(), REFERENCE, saveField(), SCH_FIELD::SetId(), TO_UTF8, toUTFTildaText(), TRANSFORM::x1, TRANSFORM::x2, TRANSFORM::y1, and TRANSFORM::y2.

Referenced by Format().

◆ saveField()

void SCH_LEGACY_PLUGIN::saveField ( SCH_FIELD aField)
private

Definition at line 2014 of file sch_legacy_plugin.cpp.

2015 {
2016  char hjustify = 'C';
2017 
2018  if( aField->GetHorizJustify() == GR_TEXT_HJUSTIFY_LEFT )
2019  hjustify = 'L';
2020  else if( aField->GetHorizJustify() == GR_TEXT_HJUSTIFY_RIGHT )
2021  hjustify = 'R';
2022 
2023  char vjustify = 'C';
2024 
2025  if( aField->GetVertJustify() == GR_TEXT_VJUSTIFY_BOTTOM )
2026  vjustify = 'B';
2027  else if( aField->GetVertJustify() == GR_TEXT_VJUSTIFY_TOP )
2028  vjustify = 'T';
2029 
2030  m_out->Print( 0, "F %d %s %c %-3d %-3d %-3d %4.4X %c %c%c%c",
2031  aField->GetId(),
2032  EscapedUTF8( aField->GetText() ).c_str(), // wraps in quotes too
2033  aField->GetTextAngle() == TEXT_ANGLE_HORIZ ? 'H' : 'V',
2034  aField->GetLibPosition().x, aField->GetLibPosition().y,
2035  aField->GetTextWidth(),
2036  !aField->IsVisible(),
2037  hjustify, vjustify,
2038  aField->IsItalic() ? 'I' : 'N',
2039  aField->IsBold() ? 'B' : 'N' );
2040 
2041  // Save field name, if the name is user definable
2042  if( aField->GetId() >= FIELD1 )
2043  {
2044  m_out->Print( 0, " %s", EscapedUTF8( aField->GetName() ).c_str() );
2045  }
2046 
2047  m_out->Print( 0, "\n" );
2048 }
#define TEXT_ANGLE_HORIZ
bool IsBold() const
Definition: eda_text.h:167
EDA_TEXT_VJUSTIFY_T GetVertJustify() const
Definition: eda_text.h:185
bool IsVisible() const
Definition: eda_text.h:170
double GetTextAngle() const
Definition: eda_text.h:158
int GetId() const
Definition: sch_field.h:103
bool IsItalic() const
Definition: eda_text.h:164
std::string EscapedUTF8(const wxString &aString)
Function EscapedUTF8 returns an 8 bit UTF8 string given aString in unicode form.
Definition: string.cpp:241
EDA_TEXT_HJUSTIFY_T GetHorizJustify() const
Definition: eda_text.h:184
wxPoint GetLibPosition() const
Definition: sch_field.h:187
int GetTextWidth() const
Definition: eda_text.h:224
OUTPUTFORMATTER * m_out
The output formatter for saving SCH_SCREEN objects.
wxString GetName(bool aUseDefaultName=true) const
Function GetName returns the field name.
Definition: sch_field.cpp:370
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:404
virtual const wxString & GetText() const
Function GetText returns the string associated with the text object.
Definition: eda_text.h:124

References EscapedUTF8(), FIELD1, EDA_TEXT::GetHorizJustify(), SCH_FIELD::GetId(), SCH_FIELD::GetLibPosition(), SCH_FIELD::GetName(), EDA_TEXT::GetText(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextWidth(), EDA_TEXT::GetVertJustify(), GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_HJUSTIFY_RIGHT, GR_TEXT_VJUSTIFY_BOTTOM, GR_TEXT_VJUSTIFY_TOP, EDA_TEXT::IsBold(), EDA_TEXT::IsItalic(), EDA_TEXT::IsVisible(), m_out, OUTPUTFORMATTER::Print(), and TEXT_ANGLE_HORIZ.

Referenced by saveComponent().

◆ saveJunction()

void SCH_LEGACY_PLUGIN::saveJunction ( SCH_JUNCTION aJunction)
private

Definition at line 2144 of file sch_legacy_plugin.cpp.

2145 {
2146  wxCHECK_RET( aJunction != NULL, "SCH_JUNCTION* is NULL" );
2147 
2148  m_out->Print( 0, "Connection ~ %-4d %-4d\n",
2149  aJunction->GetPosition().x, aJunction->GetPosition().y );
2150 }
wxPoint GetPosition() const override
Function GetPosition.
Definition: sch_junction.h:95
OUTPUTFORMATTER * m_out
The output formatter for saving SCH_SCREEN objects.
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:404

References SCH_JUNCTION::GetPosition(), m_out, and OUTPUTFORMATTER::Print().

Referenced by Format().

◆ SaveLibrary()

void SCH_LEGACY_PLUGIN::SaveLibrary ( const wxString &  aLibraryPath,
const PROPERTIES aProperties = nullptr 
)
overridevirtual

Reimplemented from SCH_PLUGIN.

Definition at line 4404 of file sch_legacy_plugin.cpp.

4405 {
4406  if( !m_cache )
4407  m_cache = new SCH_LEGACY_PLUGIN_CACHE( aLibraryPath );
4408 
4409  wxString oldFileName = m_cache->GetFileName();
4410 
4411  if( !m_cache->IsFile( aLibraryPath ) )
4412  {
4413  m_cache->SetFileName( aLibraryPath );
4414  }
4415 
4416  // This is a forced save.
4417  m_cache->SetModified();
4418  m_cache->Save( writeDocFile( aProperties ) );
4419  m_cache->SetFileName( oldFileName );
4420 }
SCH_LEGACY_PLUGIN_CACHE * m_cache
A cache assistant for the part library portion of the SCH_PLUGIN API, and only for the SCH_LEGACY_PLU...
void SetModified(bool aModified=true)
void SetFileName(const wxString &aFileName)
bool IsFile(const wxString &aFullPathAndFileName) const
void Save(bool aSaveDocFile=true)
Save the entire library to file m_libFileName;.
bool writeDocFile(const PROPERTIES *aProperties)

References SCH_LEGACY_PLUGIN_CACHE::GetFileName(), SCH_LEGACY_PLUGIN_CACHE::IsFile(), m_cache, SCH_LEGACY_PLUGIN_CACHE::Save(), SCH_LEGACY_PLUGIN_CACHE::SetFileName(), SCH_LEGACY_PLUGIN_CACHE::SetModified(), and writeDocFile().

◆ saveLine()

void SCH_LEGACY_PLUGIN::saveLine ( SCH_LINE aLine)
private

Definition at line 2177 of file sch_legacy_plugin.cpp.

2178 {
2179  wxCHECK_RET( aLine != NULL, "SCH_LINE* is NULL" );
2180 
2181  const char* layer = "Notes";
2182  const char* width = "Line";
2183 
2184  if( aLine->GetLayer() == LAYER_WIRE )
2185  layer = "Wire";
2186  else if( aLine->GetLayer() == LAYER_BUS )
2187  layer = "Bus";
2188 
2189  m_out->Print( 0, "Wire %s %s", layer, width );
2190 
2191  // Write line style (width, type, color) only for non default values
2192  if( aLine->GetLayer() == LAYER_NOTES )
2193  {
2194  if( aLine->GetPenSize() != aLine->GetDefaultWidth() )
2195  m_out->Print( 0, " %s %d", T_WIDTH, aLine->GetLineSize() );
2196 
2197  if( aLine->GetLineStyle() != aLine->GetDefaultStyle() )
2198  m_out->Print( 0, " %s %s", T_STYLE, SCH_LINE::GetLineStyleName( aLine->GetLineStyle() ) );
2199 
2200  if( aLine->GetLineColor() != aLine->GetDefaultColor() )
2201  m_out->Print( 0, " %s",
2202  TO_UTF8( aLine->GetLineColor().ToColour().GetAsString( wxC2S_CSS_SYNTAX ) ) );
2203  }
2204 
2205  m_out->Print( 0, "\n" );
2206 
2207  m_out->Print( 0, "\t%-4d %-4d %-4d %-4d",
2208  aLine->GetStartPoint().x, aLine->GetStartPoint().y,
2209  aLine->GetEndPoint().x, aLine->GetEndPoint().y );
2210 
2211  m_out->Print( 0, "\n");
2212 }
COLOR4D GetLineColor() const
Definition: sch_line.cpp:263
wxPoint GetStartPoint() const
Definition: sch_line.h:90
#define T_WIDTH
int GetDefaultWidth() const
Definition: sch_line.cpp:298
#define T_STYLE
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:48
int GetDefaultStyle() const
Definition: sch_line.cpp:271
SCH_LAYER_ID GetLayer() const
Function GetLayer returns the layer this item is on.
Definition: sch_item.h:193
int GetLineSize() const
Definition: sch_line.h:121
COLOR4D GetDefaultColor() const
Definition: sch_line.cpp:233
OUTPUTFORMATTER * m_out
The output formatter for saving SCH_SCREEN objects.
static const char * GetLineStyleName(int aStyle)
Definition: sch_line.cpp:109
int GetPenSize() const override
Function GetPenSize virtual pure.
Definition: sch_line.cpp:318
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:404
int GetLineStyle() const
Definition: sch_line.cpp:289
wxPoint GetEndPoint() const
Definition: sch_line.h:93

References SCH_LINE::GetDefaultColor(), SCH_LINE::GetDefaultStyle(), SCH_LINE::GetDefaultWidth(), SCH_LINE::GetEndPoint(), SCH_ITEM::GetLayer(), SCH_LINE::GetLineColor(), SCH_LINE::GetLineSize(), SCH_LINE::GetLineStyle(), SCH_LINE::GetLineStyleName(), SCH_LINE::GetPenSize(), SCH_LINE::GetStartPoint(), LAYER_BUS, LAYER_NOTES, LAYER_WIRE, m_out, OUTPUTFORMATTER::Print(), T_STYLE, T_WIDTH, and TO_UTF8.

Referenced by Format().

◆ saveNoConnect()

void SCH_LEGACY_PLUGIN::saveNoConnect ( SCH_NO_CONNECT aNoConnect)
private

Definition at line 2153 of file sch_legacy_plugin.cpp.

2154 {
2155  wxCHECK_RET( aNoConnect != NULL, "SCH_NOCONNECT* is NULL" );
2156 
2157  m_out->Print( 0, "NoConn ~ %-4d %-4d\n", aNoConnect->GetPosition().x,
2158  aNoConnect->GetPosition().y );
2159 }
wxPoint GetPosition() const override
Function GetPosition.
OUTPUTFORMATTER * m_out
The output formatter for saving SCH_SCREEN objects.
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:404

References SCH_NO_CONNECT::GetPosition(), m_out, and OUTPUTFORMATTER::Print().

Referenced by Format().

◆ saveSheet()

void SCH_LEGACY_PLUGIN::saveSheet ( SCH_SHEET aSheet)
private

Definition at line 2089 of file sch_legacy_plugin.cpp.

2090 {
2091  wxCHECK_RET( aSheet != NULL, "SCH_SHEET* is NULL" );
2092 
2093  m_out->Print( 0, "$Sheet\n" );
2094  m_out->Print( 0, "S %-4d %-4d %-4d %-4d\n",
2095  aSheet->GetPosition().x, aSheet->GetPosition().y,
2096  aSheet->GetSize().x, aSheet->GetSize().y );
2097 
2098  m_out->Print( 0, "U %8.8X\n", aSheet->GetTimeStamp() );
2099 
2100  if( !aSheet->GetName().IsEmpty() )
2101  m_out->Print( 0, "F0 %s %d\n", EscapedUTF8( aSheet->GetName() ).c_str(),
2102  aSheet->GetSheetNameSize() );
2103 
2104  if( !aSheet->GetFileName().IsEmpty() )
2105  m_out->Print( 0, "F1 %s %d\n", EscapedUTF8( aSheet->GetFileName() ).c_str(),
2106  aSheet->GetFileNameSize() );
2107 
2108  for( const SCH_SHEET_PIN& pin : aSheet->GetPins() )
2109  {
2110  int type, side;
2111 
2112  if( pin.GetText().IsEmpty() )
2113  break;
2114 
2115  switch( pin.GetEdge() )
2116  {
2117  default:
2118  case SHEET_LEFT_SIDE: side = 'L'; break;
2119  case SHEET_RIGHT_SIDE: side = 'R'; break;
2120  case SHEET_TOP_SIDE: side = 'T'; break;
2121  case SHEET_BOTTOM_SIDE: side = 'B'; break;
2122  }
2123 
2124  switch( pin.GetShape() )
2125  {
2126  case NET_INPUT: type = 'I'; break;
2127  case NET_OUTPUT: type = 'O'; break;
2128  case NET_BIDI: type = 'B'; break;
2129  case NET_TRISTATE: type = 'T'; break;
2130  default:
2131  case NET_UNSPECIFIED: type = 'U'; break;
2132  }
2133 
2134  m_out->Print( 0, "F%d %s %c %c %-3d %-3d %-3d\n", pin.GetNumber(),
2135  EscapedUTF8( pin.GetText() ).c_str(), // supplies wrapping quotes
2136  type, side, pin.GetPosition().x, pin.GetPosition().y,
2137  pin.GetTextWidth() );
2138  }
2139 
2140  m_out->Print( 0, "$EndSheet\n" );
2141 }
SCH_SHEET_PINS & GetPins()
Definition: sch_sheet.h:325
int GetFileNameSize() const
Definition: sch_sheet.h:268
std::string EscapedUTF8(const wxString &aString)
Function EscapedUTF8 returns an 8 bit UTF8 string given aString in unicode form.
Definition: string.cpp:241
int GetSheetNameSize() const
Definition: sch_sheet.h:265
wxString GetName() const
Definition: sch_sheet.h:262
timestamp_t GetTimeStamp() const
Definition: base_struct.h:216
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet.h:75
wxPoint GetPosition() const override
Function GetPosition.
Definition: sch_sheet.h:533
wxString GetFileName(void) const
Return the filename corresponding to this sheet.
Definition: sch_sheet.cpp:629
OUTPUTFORMATTER * m_out
The output formatter for saving SCH_SCREEN objects.
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:404
wxSize GetSize()
Definition: sch_sheet.h:273

References EscapedUTF8(), SCH_SHEET::GetFileName(), SCH_SHEET::GetFileNameSize(), SCH_SHEET::GetName(), SCH_SHEET::GetPins(), SCH_SHEET::GetPosition(), SCH_SHEET::GetSheetNameSize(), SCH_SHEET::GetSize(), EDA_ITEM::GetTimeStamp(), m_out, NET_BIDI, NET_INPUT, NET_OUTPUT, NET_TRISTATE, NET_UNSPECIFIED, OUTPUTFORMATTER::Print(), SHEET_BOTTOM_SIDE, SHEET_LEFT_SIDE, SHEET_RIGHT_SIDE, and SHEET_TOP_SIDE.

Referenced by Format().

◆ SaveSymbol()

void SCH_LEGACY_PLUGIN::SaveSymbol ( const wxString &  aLibraryPath,
const LIB_PART aSymbol,
const PROPERTIES aProperties = nullptr 
)
overridevirtual

Write aSymbol to an existing library located at aLibraryPath.

If a LIB_PART by the same name already exists or there are any conflicting alias names, the new LIB_PART will silently overwrite any existing aliases and/or part becaue libraries cannot have duplicate alias names. It is the responsibility of the caller to check the library for conflicts before saving.

Parameters
aLibraryPathis a locator for the "library", usually a directory, file, or URL containing several symbols.
aSymbolis what to store in the library. The library is refreshed and the caller must update any LIB_PART pointers that may have changed.
aPropertiesis an associative array that can be used to tell the saver how to save the symbol, because it can take any number of additional named tuning arguments that the plugin is known to support. The caller continues to own this object (plugin may not delete it), and plugins should expect it to be optionally NULL.
Exceptions
IO_ERRORif there is a problem saving.

Reimplemented from SCH_PLUGIN.

Definition at line 4314 of file sch_legacy_plugin.cpp.

4316 {
4317  m_props = aProperties;
4318 
4319  cacheLib( aLibraryPath );
4320 
4321  m_cache->AddSymbol( aSymbol );
4322 
4323  if( !isBuffering( aProperties ) )
4324  m_cache->Save( writeDocFile( aProperties ) );
4325 }
SCH_LEGACY_PLUGIN_CACHE * m_cache
bool isBuffering(const PROPERTIES *aProperties)
void cacheLib(const wxString &aLibraryFileName)
void Save(bool aSaveDocFile=true)
Save the entire library to file m_libFileName;.
void AddSymbol(const LIB_PART *aPart)
bool writeDocFile(const PROPERTIES *aProperties)
const PROPERTIES * m_props
Passed via Save() or Load(), no ownership, may be nullptr.

References SCH_LEGACY_PLUGIN_CACHE::AddSymbol(), cacheLib(), isBuffering(), m_cache, m_props, SCH_LEGACY_PLUGIN_CACHE::Save(), and writeDocFile().

◆ saveText()

void SCH_LEGACY_PLUGIN::saveText ( SCH_TEXT aText)
private

Definition at line 2215 of file sch_legacy_plugin.cpp.

2216 {
2217  wxCHECK_RET( aText != NULL, "SCH_TEXT* is NULL" );
2218 
2219  const char* italics = "~";
2220  const char* textType = "Notes";
2221 
2222  if( aText->IsItalic() )
2223  italics = "Italic";
2224 
2225  wxString text = aText->GetText();
2226 
2227  SCH_LAYER_ID layer = aText->GetLayer();
2228 
2229  if( layer == LAYER_NOTES || layer == LAYER_LOCLABEL )
2230  {
2231  if( layer == LAYER_NOTES )
2232  {
2233  // For compatibility reasons, the text must be saved in only one text line
2234  // so replace all EOLs with \\n
2235  text.Replace( wxT( "\n" ), wxT( "\\n" ) );
2236 
2237  // Here we should have no CR or LF character in line
2238  // This is not always the case if a multiline text was copied (using a copy/paste
2239  // function) from a text that uses E.O.L characters that differs from the current
2240  // EOL format. This is mainly the case under Linux using LF symbol when copying
2241  // a text from Windows (using CRLF symbol) so we must just remove the extra CR left
2242  // (or LF left under MacOSX)
2243  for( unsigned ii = 0; ii < text.Len(); )
2244  {
2245  if( text[ii] == 0x0A || text[ii] == 0x0D )
2246  text.erase( ii, 1 );
2247  else
2248  ii++;
2249  }
2250  }
2251  else
2252  {
2253  textType = "Label";
2254  }
2255 
2256  m_out->Print( 0, "Text %s %-4d %-4d %-4d %-4d %s %d\n%s\n", textType,
2257  aText->GetPosition().x, aText->GetPosition().y,
2258  aText->GetLabelSpinStyle(),
2259  aText->GetTextWidth(),
2260  italics, aText->GetThickness(), TO_UTF8( text ) );
2261  }
2262  else if( layer == LAYER_GLOBLABEL || layer == LAYER_HIERLABEL )
2263  {
2264  textType = ( layer == LAYER_GLOBLABEL ) ? "GLabel" : "HLabel";
2265 
2266  m_out->Print( 0, "Text %s %-4d %-4d %-4d %-4d %s %s %d\n%s\n", textType,
2267  aText->GetPosition().x, aText->GetPosition().y,
2268  aText->GetLabelSpinStyle(),
2269  aText->GetTextWidth(),
2270  SheetLabelType[aText->GetShape()],
2271  italics,
2272  aText->GetThickness(), TO_UTF8( text ) );
2273  }
2274 }
int GetThickness() const
Function GetThickness returns pen width.
Definition: eda_text.h:148
const char * SheetLabelType[]
Definition: sch_text.cpp:57
bool IsItalic() const
Definition: eda_text.h:164
int GetLabelSpinStyle() const
Definition: sch_text.h:119
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:48
SCH_LAYER_ID
Eeschema drawing layers.
wxPoint GetPosition() const override
Function GetPosition.
Definition: sch_text.h:193
SCH_LAYER_ID GetLayer() const
Function GetLayer returns the layer this item is on.
Definition: sch_item.h:193
int GetTextWidth() const
Definition: eda_text.h:224
OUTPUTFORMATTER * m_out
The output formatter for saving SCH_SCREEN objects.
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:404
virtual const wxString & GetText() const
Function GetText returns the string associated with the text object.
Definition: eda_text.h:124
PINSHEETLABEL_SHAPE GetShape() const
Definition: sch_text.h:121

References SCH_TEXT::GetLabelSpinStyle(), SCH_ITEM::GetLayer(), SCH_TEXT::GetPosition(), SCH_TEXT::GetShape(), EDA_TEXT::GetText(), EDA_TEXT::GetTextWidth(), EDA_TEXT::GetThickness(), EDA_TEXT::IsItalic(), LAYER_GLOBLABEL, LAYER_HIERLABEL, LAYER_LOCLABEL, LAYER_NOTES, m_out, OUTPUTFORMATTER::Print(), SheetLabelType, and TO_UTF8.

Referenced by Format().

◆ SymbolLibOptions()

void SCH_PLUGIN::SymbolLibOptions ( PROPERTIES aListToAppendTo) const
virtualinherited

Append supported SCH_PLUGIN options to aListToAppenTo along with internationalized descriptions.

Options are typically appended so that a derived SCH_PLUGIN can call its base class function by the same name first, thus inheriting options declared there. (Some base class options could pertain to all Symbol*() functions in all derived SCH_PLUGINs.) Note that since aListToAppendTo is a PROPERTIES object, all options will be unique and last guy wins.

Parameters
aListToAppendToholds a tuple of
option
This eventually is what shows up into the fp-lib-table "options" field, possibly combined with others.
internationalized description
The internationalized description is displayed in DIALOG_FP_SCH_PLUGIN_OPTIONS. It may be multi-line and be quite explanatory of the option.

In the future perhaps aListToAppendTo evolves to something capable of also holding a wxValidator for the cells in said dialog: http://forums.wxwidgets.org/viewtopic.php?t=23277&p=104180. This would require a 3 column list, and introducing wx GUI knowledge to SCH_PLUGIN, which has been avoided to date.

Definition at line 140 of file sch_plugin.cpp.

141 {
142  // disable all these in another couple of months, after everyone has seen them:
143 #if 1
144  (*aListToAppendTo)["debug_level"] = UTF8( _(
145  "Enable <b>debug</b> logging for Symbol*() functions in this SCH_PLUGIN."
146  ) );
147 
148  (*aListToAppendTo)["read_filter_regex"] = UTF8( _(
149  "Regular expression <b>symbol name</b> filter."
150  ) );
151 
152  (*aListToAppendTo)["enable_transaction_logging"] = UTF8( _(
153  "Enable transaction logging. The mere presence of this option turns on the "
154  "logging, no need to set a Value."
155  ) );
156 
157  (*aListToAppendTo)["username"] = UTF8( _(
158  "User name for <b>login</b> to some special library server."
159  ));
160 
161  (*aListToAppendTo)["password"] = UTF8( _(
162  "Password for <b>login</b> to some special library server."
163  ) );
164 #endif
165 
166 #if 1
167  // Suitable for a C++ to python SCH_PLUGIN::Footprint*() adapter, move it to the adapter
168  // if and when implemented.
169  (*aListToAppendTo)["python_symbol_plugin"] = UTF8( _(
170  "Enter the python symbol which implements the SCH_PLUGIN::Symbol*() functions."
171  ) );
172 #endif
173 }
Class UTF8 is an 8 bit string that is assuredly encoded in UTF8, and supplies special conversion supp...
Definition: utf8.h:73
#define _(s)

References _.

◆ writeDocFile()

bool SCH_LEGACY_PLUGIN::writeDocFile ( const PROPERTIES aProperties)
private

Definition at line 4225 of file sch_legacy_plugin.cpp.

4226 {
4227  std::string propName( SCH_LEGACY_PLUGIN::PropNoDocFile );
4228 
4229  if( aProperties && aProperties->find( propName ) != aProperties->end() )
4230  return false;
4231 
4232  return true;
4233 }
static const char * PropNoDocFile
const char* PropBuffering

References PropNoDocFile.

Referenced by CreateSymbolLib(), DeleteAlias(), DeleteSymbol(), SaveLibrary(), and SaveSymbol().

Member Data Documentation

◆ m_cache

◆ m_currentPath

std::stack<wxString> SCH_LEGACY_PLUGIN::m_currentPath
protected

Stack to maintain nested sheet paths.

Definition at line 180 of file sch_legacy_plugin.h.

Referenced by Load(), and loadHierarchy().

◆ m_error

wxString SCH_LEGACY_PLUGIN::m_error
protected

For throwing exceptions or errors on partial schematic loads.

Definition at line 177 of file sch_legacy_plugin.h.

Referenced by GetError(), loadHeader(), and loadHierarchy().

◆ m_kiway

KIWAY* SCH_LEGACY_PLUGIN::m_kiway
protected

Required for path to legacy component libraries.

Definition at line 182 of file sch_legacy_plugin.h.

Referenced by Format(), init(), and loadHierarchy().

◆ m_out

OUTPUTFORMATTER* SCH_LEGACY_PLUGIN::m_out
protected

◆ m_path

wxString SCH_LEGACY_PLUGIN::m_path
protected

Root project path for loading child sheets.

Definition at line 179 of file sch_legacy_plugin.h.

Referenced by Load().

◆ m_props

const PROPERTIES* SCH_LEGACY_PLUGIN::m_props
protected

Passed via Save() or Load(), no ownership, may be nullptr.

Definition at line 181 of file sch_legacy_plugin.h.

Referenced by cacheLib(), CreateSymbolLib(), DeleteAlias(), DeleteSymbol(), EnumerateSymbolLib(), init(), LoadSymbol(), and SaveSymbol().

◆ m_rootSheet

SCH_SHEET* SCH_LEGACY_PLUGIN::m_rootSheet
protected

The root sheet of the schematic being loaded..

Definition at line 183 of file sch_legacy_plugin.h.

Referenced by init(), Load(), loadComponent(), and loadHierarchy().

◆ m_version

int SCH_LEGACY_PLUGIN::m_version
protected

Version of file being loaded.

Definition at line 174 of file sch_legacy_plugin.h.

Referenced by init(), loadComponent(), LoadContent(), loadFile(), loadHeader(), and loadText().

◆ PropBuffering

const char * SCH_LEGACY_PLUGIN::PropBuffering = "buffering"
static

const char* PropBuffering

is a property used internally by the plugin to enable cache buffering which prevents the library file from being written every time the cache is changed. This is useful when writing the schematic cache library file or saving a library to a new file name.

Definition at line 88 of file sch_legacy_plugin.h.

Referenced by PART_LIB::EnableBuffering(), isBuffering(), PART_LIB::IsBuffering(), SCH_EAGLE_PLUGIN::Load(), SYMBOL_LIB_TABLE_RESCUER::OpenRescueLibrary(), LIB_MANAGER::LIB_BUFFER::SaveBuffer(), and LIB_MANAGER::SaveLibrary().

◆ PropNoDocFile

const char * SCH_LEGACY_PLUGIN::PropNoDocFile = "no_doc_file"
static

const char* PropBuffering

is a property used internally by the plugin to disable writing the library documentation (.dcm) file when saving the library cache.

Definition at line 96 of file sch_legacy_plugin.h.

Referenced by PART_LIB::IsCache(), PART_LIB::Save(), LIB_EDIT_FRAME::SaveOneSymbol(), PART_LIB::SetCache(), and writeDocFile().


The documentation for this class was generated from the following files: