SCH_ALTIUM_PLUGIN Class Reference

SCH_ALTIUM_PLUGIN is a SCH_PLUGIN derivation for loading Altium .SchDoc schematic files. More...

#include <sch_altium_plugin.h>

Inheritance diagram for SCH_ALTIUM_PLUGIN:

Public Member Functions
	SCH_ALTIUM_PLUGIN ()
	~SCH_ALTIUM_PLUGIN ()
const wxString	GetName () const override
	Return a brief hard coded name for this SCH_PLUGIN. More...
void	SetReporter (REPORTER *aReporter) override
	Set an optional reporter for warnings/errors. More...
const wxString	GetFileExtension () const override
	Return the file extension for the SCH_PLUGIN. More...
const wxString	GetLibraryFileExtension () const override
	Return the library file extension for the SCH_PLUGIN object. More...
int	GetModifyHash () const override
	Return the modification hash from the library cache. More...
SCH_SHEET *	Load (const wxString &aFileName, SCHEMATIC *aSchematic, 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...
bool	CheckHeader (const wxString &aFileName) override
	Return true if the first line in aFileName begins with the expected header. More...
wxString	getLibName ()
wxFileName	getLibFileName ()
void	ParseAltiumSch (const wxString &aFileName)
void	ParseStorage (const CFB::CompoundFileReader &aReader)
void	ParseFileHeader (const CFB::CompoundFileReader &aReader)
virtual void	SetProgressReporter (PROGRESS_REPORTER *aReporter)
	Set an optional progress reporter. More...
virtual void	SaveLibrary (const wxString &aFileName, const PROPERTIES *aProperties=nullptr)
virtual void	Save (const wxString &aFileName, SCH_SHEET *aSheet, SCHEMATIC *aSchematic, const PROPERTIES *aProperties=nullptr)
	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...
virtual void	EnumerateSymbolLib (wxArrayString &aSymbolNameList, const wxString &aLibraryPath, const PROPERTIES *aProperties=nullptr)
	Populate a list of LIB_SYMBOL alias names contained within the library aLibraryPath. More...
virtual void	EnumerateSymbolLib (std::vector< LIB_SYMBOL * > &aSymbolList, const wxString &aLibraryPath, const PROPERTIES *aProperties=nullptr)
	Populate a list of LIB_SYMBOL aliases contained within the library aLibraryPath. More...
virtual LIB_SYMBOL *	LoadSymbol (const wxString &aLibraryPath, const wxString &aPartName, const PROPERTIES *aProperties=nullptr)
	Load a LIB_SYMBOL object having aPartName from the aLibraryPath containing a library format that this SCH_PLUGIN knows about. More...
virtual void	SaveSymbol (const wxString &aLibraryPath, const LIB_SYMBOL *aSymbol, const PROPERTIES *aProperties=nullptr)
	Write aSymbol to an existing library located at aLibraryPath. More...
virtual void	DeleteSymbol (const wxString &aLibraryPath, const wxString &aSymbolName, const PROPERTIES *aProperties=nullptr)
	Delete the entire LIB_SYMBOL associated with aAliasName from the library aLibraryPath. More...
virtual void	CreateSymbolLib (const wxString &aLibraryPath, const PROPERTIES *aProperties=nullptr)
	Create a new empty symbol library at aLibraryPath. More...
virtual bool	DeleteSymbolLib (const wxString &aLibraryPath, const PROPERTIES *aProperties=nullptr)
	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...
virtual bool	IsSymbolLibWritable (const wxString &aLibraryPath)
	Return true if the library at aLibraryPath is writable. More...
virtual void	SymbolLibOptions (PROPERTIES *aListToAppendTo) const
	Append supported SCH_PLUGIN options to aListToAppenTo along with internationalized descriptions. More...
virtual const wxString &	GetError () const
	Return an error string to the caller. More...

Private Member Functions
bool	IsComponentPartVisible (int aOwnerindex, int aOwnerpartdisplaymode) const
const ASCH_STORAGE_FILE *	GetFileFromStorage (const wxString &aFilename) const
void	ParseComponent (int aIndex, const std::map< wxString, wxString > &aProperties)
void	ParsePin (const std::map< wxString, wxString > &aProperties)
void	ParseLabel (const std::map< wxString, wxString > &aProperties)
void	ParseTextFrame (const std::map< wxString, wxString > &aProperties)
void	ParseNote (const std::map< wxString, wxString > &aProperties)
void	ParseBezier (const std::map< wxString, wxString > &aProperties)
void	ParsePolyline (const std::map< wxString, wxString > &aProperties)
void	ParsePolygon (const std::map< wxString, wxString > &aProperties)
void	ParseRoundRectangle (const std::map< wxString, wxString > &aProperties)
void	ParseArc (const std::map< wxString, wxString > &aProperties)
void	ParseLine (const std::map< wxString, wxString > &aProperties)
void	ParseRectangle (const std::map< wxString, wxString > &aProperties)
void	ParseSheetSymbol (int aIndex, const std::map< wxString, wxString > &aProperties)
void	ParseSheetEntry (const std::map< wxString, wxString > &aProperties)
void	ParsePowerPort (const std::map< wxString, wxString > &aProperties)
void	ParsePort (const ASCH_PORT &aElem)
void	ParseNoERC (const std::map< wxString, wxString > &aProperties)
void	ParseNetLabel (const std::map< wxString, wxString > &aProperties)
void	ParseBus (const std::map< wxString, wxString > &aProperties)
void	ParseWire (const std::map< wxString, wxString > &aProperties)
void	ParseJunction (const std::map< wxString, wxString > &aProperties)
void	ParseImage (const std::map< wxString, wxString > &aProperties)
void	ParseSheet (const std::map< wxString, wxString > &aProperties)
void	ParseSheetName (const std::map< wxString, wxString > &aProperties)
void	ParseFileName (const std::map< wxString, wxString > &aProperties)
void	ParseDesignator (const std::map< wxString, wxString > &aProperties)
void	ParseBusEntry (const std::map< wxString, wxString > &aProperties)
void	ParseParameter (const std::map< wxString, wxString > &aProperties)
void	ParseImplementationList (int aIndex, const std::map< wxString, wxString > &aProperties)
void	ParseImplementation (const std::map< wxString, wxString > &aProperties)

Private Attributes
REPORTER *	m_reporter
SCH_SHEET *	m_rootSheet
SCH_SHEET *	m_currentSheet
SCHEMATIC *	m_schematic
wxString	m_libName
SCH_PLUGIN::SCH_PLUGIN_RELEASER	m_pi
std::unique_ptr< PROPERTIES >	m_properties
std::unique_ptr< TITLE_BLOCK >	m_currentTitleBlock
wxPoint	m_sheetOffset
std::unique_ptr< ASCH_SHEET >	m_altiumSheet
std::map< int, SCH_SYMBOL * >	m_symbols
std::map< int, SCH_SHEET * >	m_sheets
std::map< int, LIB_SYMBOL * >	m_libSymbols
std::map< wxString, LIB_SYMBOL * >	m_powerSymbols
std::vector< ASCH_STORAGE_FILE >	m_altiumStorage
std::map< int, ASCH_SYMBOL >	m_altiumComponents
std::map< int, int >	m_altiumImplementationList
std::vector< ASCH_PORT >	m_altiumPortsCurrentSheet

Detailed Description

SCH_ALTIUM_PLUGIN is a SCH_PLUGIN derivation for loading Altium .SchDoc schematic files.

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

Definition at line 51 of file sch_altium_plugin.h.

Constructor & Destructor Documentation

SCH_ALTIUM_PLUGIN()

SCH_ALTIUM_PLUGIN::SCH_ALTIUM_PLUGIN

(

)

Definition at line 79 of file sch_altium_plugin.cpp.

{
 m_rootSheet = nullptr;
 m_currentSheet = nullptr;
 m_schematic = nullptr;

 m_reporter = &WXLOG_REPORTER::GetInstance();
}

References WXLOG_REPORTER::GetInstance(), m_currentSheet, m_reporter, m_rootSheet, and m_schematic.

~SCH_ALTIUM_PLUGIN()

SCH_ALTIUM_PLUGIN::~SCH_ALTIUM_PLUGIN

(

)

Definition at line 89 of file sch_altium_plugin.cpp.

{
}

Member Function Documentation

CheckHeader()

bool SCH_ALTIUM_PLUGIN::CheckHeader ( const wxString &  aFileName )

overridevirtual

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

Parameters

aFileName

is the name of the file to use as input

Reimplemented from SCH_PLUGIN.

Definition at line 118 of file sch_altium_plugin.cpp.

{
 // TODO

 return true;
}

CreateSymbolLib()

void SCH_PLUGIN::CreateSymbolLib ( const wxString &  aLibraryPath, const PROPERTIES *  aProperties = nullptr  )

virtualinherited

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

aLibraryPath	is a locator for the "library", usually a directory, file, or URL containing several footprints.
aProperties	is 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_ERROR

if there is a problem finding the library, or creating it.

Reimplemented in SCH_LEGACY_PLUGIN, and SCH_SEXPR_PLUGIN.

Definition at line 110 of file sch_plugin.cpp.

{
 // not pure virtual so that plugins only have to implement subset of the SCH_PLUGIN interface.
 not_implemented( this, __FUNCTION__ );
}

References not_implemented().

DeleteSymbol()

void SCH_PLUGIN::DeleteSymbol ( const wxString &  aLibraryPath, const wxString &  aSymbolName, const PROPERTIES *  aProperties = nullptr  )

virtualinherited

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

Parameters

aLibraryPath	is a locator for the "library", usually a directory, file, or URL containing several symbols.
aSymbolName	is the name of a LIB_SYMBOL associated with it's root LIB_SYMBOL object to delete from the specified library.
aProperties	is 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_ERROR

if there is a problem finding the alias or the library or deleting it.

Reimplemented in SCH_LEGACY_PLUGIN, and SCH_SEXPR_PLUGIN.

Definition at line 102 of file sch_plugin.cpp.

{
 // not pure virtual so that plugins only have to implement subset of the SCH_PLUGIN interface.
 not_implemented( this, __FUNCTION__ );
}

References not_implemented().

Referenced by SYMBOL_LIBRARY_MANAGER::LIB_BUFFER::SaveBuffer().

DeleteSymbolLib()

bool SCH_PLUGIN::DeleteSymbolLib ( const wxString &  aLibraryPath, const PROPERTIES *  aProperties = nullptr  )

virtualinherited

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

aLibraryPath	is a locator for the "library", usually a directory or file which will contain symbols.
aProperties	is 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_ERROR

if there is a problem deleting an existing library.

Reimplemented in SCH_LEGACY_PLUGIN, and SCH_SEXPR_PLUGIN.

Definition at line 117 of file sch_plugin.cpp.

{
 // not pure virtual so that plugins only have to implement subset of the SCH_PLUGIN interface.
 not_implemented( this, __FUNCTION__ );
 return false;
}

References not_implemented().

EnumerateSymbolLib() [1/2]

void SCH_PLUGIN::EnumerateSymbolLib ( wxArrayString &  aSymbolNameList, const wxString &  aLibraryPath, const PROPERTIES *  aProperties = nullptr  )

virtualinherited

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

Parameters

aSymbolNameList	is an array to populate with the LIB_SYMBOL names associated with the library.
aLibraryPath	is a locator for the "library", usually a directory, file, or URL containing one or more LIB_SYMBOL objects.
aProperties	is 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_ERROR

if the library cannot be found, the part library cannot be loaded.

Reimplemented in SCH_LEGACY_PLUGIN, and SCH_SEXPR_PLUGIN.

Definition at line 67 of file sch_plugin.cpp.

{
 // not pure virtual so that plugins only have to implement subset of the SCH_PLUGIN interface.
 not_implemented( this, __FUNCTION__ );
}

References not_implemented().

EnumerateSymbolLib() [2/2]

void SCH_PLUGIN::EnumerateSymbolLib ( std::vector< LIB_SYMBOL * > &  aSymbolList, const wxString &  aLibraryPath, const PROPERTIES *  aProperties = nullptr  )

virtualinherited

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

Note

It is the responsibility of the caller to delete the returned object from the heap. Failure to do this will result in memory leaks.

Parameters

aSymbolList	is an array to populate with the LIB_SYMBOL pointers associated with the library.
aLibraryPath	is a locator for the "library", usually a directory, file, or URL containing one or more LIB_SYMBOL objects.
aProperties	is 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_ERROR

if the library cannot be found, the part library cannot be loaded.

Reimplemented in SCH_LEGACY_PLUGIN, and SCH_SEXPR_PLUGIN.

Definition at line 76 of file sch_plugin.cpp.

{
 // not pure virtual so that plugins only have to implement subset of the SCH_PLUGIN interface.
 not_implemented( this, __FUNCTION__ );
}

References not_implemented().

GetError()

const wxString & SCH_PLUGIN::GetError ( ) const

virtualinherited

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 in SCH_LEGACY_PLUGIN, and SCH_SEXPR_PLUGIN.

Definition at line 177 of file sch_plugin.cpp.

{
 // not pure virtual so that plugins only have to implement subset of the SCH_PLUGIN interface.
 not_implemented( this, __FUNCTION__ );
 static wxString error;
 return error;
}

References not_implemented().

Referenced by TEST_SCH_SHEET_LIST_FIXTURE::loadSchematic(), and TEST_NETLISTS_FIXTURE::loadSchematic().

GetFileExtension()

const wxString SCH_ALTIUM_PLUGIN::GetFileExtension ( ) const

overridevirtual

Return the file extension for the SCH_PLUGIN.

Implements SCH_PLUGIN.

Definition at line 100 of file sch_altium_plugin.cpp.

{
 return wxT( "SchDoc" );
}

Referenced by ParseFileName().

GetFileFromStorage()

const ASCH_STORAGE_FILE * SCH_ALTIUM_PLUGIN::GetFileFromStorage ( const wxString &  aFilename ) const

private

Definition at line 544 of file sch_altium_plugin.cpp.

{
 const ASCH_STORAGE_FILE* nonExactMatch = nullptr;

 for( const ASCH_STORAGE_FILE& file : m_altiumStorage )
 {
 if( file.filename.IsSameAs( aFilename ) )
 return &file;

 if( file.filename.EndsWith( aFilename ) )
 nonExactMatch = &file;
 }

 return nonExactMatch;
}

References m_altiumStorage.

Referenced by ParseImage().

getLibFileName()

wxFileName SCH_ALTIUM_PLUGIN::getLibFileName

(

)

Definition at line 150 of file sch_altium_plugin.cpp.

{
 wxFileName fn( m_schematic->Prj().GetProjectPath(), getLibName(), KiCadSymbolLibFileExtension );

 return fn;
}

References getLibName(), PROJECT::GetProjectPath(), KiCadSymbolLibFileExtension, m_schematic, and SCHEMATIC::Prj().

Referenced by Load(), ParseFileHeader(), and ParsePowerPort().

getLibName()

wxString SCH_ALTIUM_PLUGIN::getLibName

(

)

Definition at line 126 of file sch_altium_plugin.cpp.

{
 if( m_libName.IsEmpty() )
 {
 // Try to come up with a meaningful name
 m_libName = m_schematic->Prj().GetProjectName();

 if( m_libName.IsEmpty() )
 {
 wxFileName fn( m_rootSheet->GetFileName() );
 m_libName = fn.GetName();
 }

 if( m_libName.IsEmpty() )
 m_libName = wxT( "noname" );

 m_libName += wxT( "-altium-import" );
 m_libName = LIB_ID::FixIllegalChars( m_libName, true );
 }

 return m_libName;
}

References LIB_ID::FixIllegalChars(), SCH_SHEET::GetFileName(), PROJECT::GetProjectName(), m_libName, m_rootSheet, m_schematic, and SCHEMATIC::Prj().

Referenced by getLibFileName(), Load(), ParseComponent(), and ParsePowerPort().

GetLibraryFileExtension()

const wxString SCH_ALTIUM_PLUGIN::GetLibraryFileExtension ( ) const

overridevirtual

Return the library file extension for the SCH_PLUGIN object.

Implements SCH_PLUGIN.

Definition at line 106 of file sch_altium_plugin.cpp.

{
 return wxT( "SchLib" );
}

GetModifyHash()

int SCH_ALTIUM_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 112 of file sch_altium_plugin.cpp.

{
 return 0;
}

GetName()

const wxString SCH_ALTIUM_PLUGIN::GetName ( ) const

overridevirtual

Return a brief hard coded name for this SCH_PLUGIN.

Implements SCH_PLUGIN.

Definition at line 94 of file sch_altium_plugin.cpp.

{
 return wxT( "Altium" );
}

IsComponentPartVisible()

bool SCH_ALTIUM_PLUGIN::IsComponentPartVisible ( int  aOwnerindex, int  aOwnerpartdisplaymode  ) const

private

Definition at line 533 of file sch_altium_plugin.cpp.

{
 const auto& component = m_altiumComponents.find( aOwnerindex );

 if( component == m_altiumComponents.end() )
 return false;

 return component->second.displaymode == aOwnerpartdisplaymode;
}

References m_altiumComponents.

Referenced by ParseArc(), ParseBezier(), ParseLine(), ParsePin(), ParsePolygon(), ParsePolyline(), ParseRectangle(), and ParseRoundRectangle().

IsSymbolLibWritable()

bool SCH_PLUGIN::IsSymbolLibWritable ( const wxString &  aLibraryPath )

virtualinherited

Return true if the library at aLibraryPath is writable.

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

Parameters

aLibraryPath

is a locator for the "library", usually a directory, file, or URL containing several symbols.

Exceptions

IO_ERROR

if no library at aLibraryPath exists.

Reimplemented in SCH_LEGACY_PLUGIN, and SCH_SEXPR_PLUGIN.

Definition at line 125 of file sch_plugin.cpp.

{
 // not pure virtual so that plugins only have to implement subset of the SCH_PLUGIN interface.
 not_implemented( this, __FUNCTION__ );
 return false;
}

References not_implemented().

Load()

SCH_SHEET * SCH_ALTIUM_PLUGIN::Load ( const wxString &  aFileName, SCHEMATIC *  aSchematic, 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

aFileName	is the name of the file to use as input and may be foreign in nature or native in nature.
aKiway	is the KIWAY object used to access the symbol libraries loaded by the project.
aAppendToMe	is an existing SCH_SHEET to append to, but if NULL then this means "do not append, rather load anew".
aProperties	is 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_ERROR

if 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.

Note

No check is being done here to see if the existing symbol library exists so this will overwrite the existing one.

Reimplemented from SCH_PLUGIN.

Definition at line 158 of file sch_altium_plugin.cpp.

{
 wxASSERT( !aFileName || aSchematic != nullptr );

 wxFileName fileName( aFileName );
 fileName.SetExt( KiCadSchematicFileExtension );
 m_schematic = aSchematic;

 // Delete on exception, if I own m_rootSheet, according to aAppendToMe
 std::unique_ptr<SCH_SHEET> deleter( aAppendToMe ? nullptr : m_rootSheet );

 if( aAppendToMe )
 {
 wxCHECK_MSG( aSchematic->IsValid(), nullptr, wxT( "Can't append to a schematic with no root!" ) );
 m_rootSheet = &aSchematic->Root();
 }
 else
 {
 m_rootSheet = new SCH_SHEET( aSchematic );
 m_rootSheet->SetFileName( fileName.GetFullPath() );

 aSchematic->SetRoot( m_rootSheet );

 SCH_SHEET_PATH sheetpath;
 sheetpath.push_back( m_rootSheet );

 m_rootSheet->AddInstance( sheetpath );
 m_rootSheet->SetPageNumber( sheetpath, wxT( "#" ) ); // We'll update later if we find a
 // pageNumber record for it
 }

 if( !m_rootSheet->GetScreen() )
 {
 SCH_SCREEN* screen = new SCH_SCREEN( m_schematic );
 screen->SetFileName( aFileName );
 m_rootSheet->SetScreen( screen );
 }

 SYMBOL_LIB_TABLE* libTable = m_schematic->Prj().SchSymbolLibTable();

 wxCHECK_MSG( libTable, nullptr, wxT( "Could not load symbol lib table." ) );

 m_pi.set( SCH_IO_MGR::FindPlugin( SCH_IO_MGR::SCH_KICAD ) );

 if( !libTable->HasLibrary( getLibName() ) )
 {
 // Create a new empty symbol library.
 m_pi->CreateSymbolLib( getLibFileName().GetFullPath() );
 wxString libTableUri = wxT( "${KIPRJMOD}/" ) + getLibFileName().GetFullName();

 // Add the new library to the project symbol library table.
 libTable->InsertRow( new SYMBOL_LIB_TABLE_ROW( getLibName(), libTableUri,
 wxString( wxT( "KiCad" ) ) ) );

 // Save project symbol library table.
 wxFileName fn( m_schematic->Prj().GetProjectPath(),
 SYMBOL_LIB_TABLE::GetSymbolLibTableFileName() );

 // So output formatter goes out of scope and closes the file before reloading.
 {
 FILE_OUTPUTFORMATTER formatter( fn.GetFullPath() );
 libTable->Format( &formatter, 0 );
 }

 // Reload the symbol library table.
 m_schematic->Prj().SetElem( PROJECT::ELEM_SYMBOL_LIB_TABLE, nullptr );
 m_schematic->Prj().SchSymbolLibTable();
 }

 m_currentSheet = m_rootSheet;
 ParseAltiumSch( aFileName );

 m_pi->SaveLibrary( getLibFileName().GetFullPath() );

 SCH_SCREENS allSheets( m_rootSheet );
 allSheets.UpdateSymbolLinks(); // Update all symbol library links for all sheets.
 allSheets.ClearEditFlags();

 return m_rootSheet;
}

References SCH_SHEET::AddInstance(), SCH_SCREENS::ClearEditFlags(), PROJECT::ELEM_SYMBOL_LIB_TABLE, SYMBOL_LIB_TABLE::Format(), getLibFileName(), getLibName(), PROJECT::GetProjectPath(), SCH_SHEET::GetScreen(), SYMBOL_LIB_TABLE::GetSymbolLibTableFileName(), LIB_TABLE::HasLibrary(), LIB_TABLE::InsertRow(), SCHEMATIC::IsValid(), KiCadSchematicFileExtension, m_currentSheet, m_pi, m_rootSheet, m_schematic, ParseAltiumSch(), SCHEMATIC::Prj(), SCH_SHEET_PATH::push_back(), SCHEMATIC::Root(), SCH_PLUGIN::SCH_PLUGIN_RELEASER::set(), PROJECT::SetElem(), SCH_SCREEN::SetFileName(), SCH_SHEET::SetFileName(), SCH_SHEET::SetPageNumber(), SCHEMATIC::SetRoot(), SCH_SHEET::SetScreen(), and SCH_SCREENS::UpdateSymbolLinks().

LoadSymbol()

LIB_SYMBOL * SCH_PLUGIN::LoadSymbol ( const wxString &  aLibraryPath, const wxString &  aPartName, const PROPERTIES *  aProperties = nullptr  )

virtualinherited

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

Parameters

aLibraryPath	is a locator for the "library", usually a directory, file, or URL containing several symbols.
aPartName	is the name of the LIB_SYMBOL to load.
aProperties	is 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 part created on the heap if found caller shares it or NULL if not found.

Exceptions

IO_ERROR

if the library cannot be found or read. No exception is thrown in the case where aAliasName cannot be found.

Reimplemented in SCH_LEGACY_PLUGIN, and SCH_SEXPR_PLUGIN.

Definition at line 85 of file sch_plugin.cpp.

{
 // not pure virtual so that plugins only have to implement subset of the SCH_PLUGIN interface.
 not_implemented( this, __FUNCTION__ );
 return nullptr;
}

References not_implemented().

Referenced by SYMBOL_LIBRARY_MANAGER::LIB_BUFFER::SaveBuffer().

ParseAltiumSch()

void SCH_ALTIUM_PLUGIN::ParseAltiumSch

(

const wxString &

aFileName

)

Definition at line 243 of file sch_altium_plugin.cpp.

{
 // Open file
 FILE* fp = wxFopen( aFileName, wxT( "rb" ) );

 if( fp == nullptr )
 {
 m_reporter->Report( wxString::Format( _( "Cannot open file '%s'." ), aFileName ),
 RPT_SEVERITY_ERROR );
 return;
 }

 fseek( fp, 0, SEEK_END );
 long len = ftell( fp );

 if( len < 0 )
 {
 fclose( fp );
 THROW_IO_ERROR( wxT( "Read error, cannot determine length of file." ) );
 }

 std::unique_ptr<unsigned char[]> buffer( new unsigned char[len] );
 fseek( fp, 0, SEEK_SET );

 size_t bytesRead = fread( buffer.get(), sizeof( unsigned char ), len, fp );
 fclose( fp );

 if( static_cast<size_t>( len ) != bytesRead )
 THROW_IO_ERROR( wxT( "Read error." ) );

 try
 {
 CFB::CompoundFileReader reader( buffer.get(), bytesRead );
 ParseStorage( reader ); // we need this before parsing the FileHeader
 ParseFileHeader( reader );
 }
 catch( CFB::CFBException& exception )
 {
 THROW_IO_ERROR( exception.what() );
 }
}

References _, Format(), m_reporter, ParseFileHeader(), ParseStorage(), REPORTER::Report(), RPT_SEVERITY_ERROR, and THROW_IO_ERROR.

Referenced by Load().

ParseArc()

void SCH_ALTIUM_PLUGIN::ParseArc ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 1318 of file sch_altium_plugin.cpp.

{
 ASCH_ARC elem( aProperties );

 if( elem.ownerpartid == ALTIUM_COMPONENT_NONE )
 {
 m_reporter->Report( _( "Arcs on schematic not currently supported." ),
 RPT_SEVERITY_ERROR );
 }
 else
 {
 const auto& libSymbolIt = m_libSymbols.find( elem.ownerindex );

 if( libSymbolIt == m_libSymbols.end() )
 {
 // TODO: e.g. can depend on Template (RECORD=39
 m_reporter->Report( wxString::Format( _( "Arc's owner (%d) not found." ),
 elem.ownerindex ),
 RPT_SEVERITY_ERROR );
 return;
 }

 if( !IsComponentPartVisible( elem.ownerindex, elem.ownerpartdisplaymode ) )
 return;

 SCH_SYMBOL* symbol = m_symbols.at( libSymbolIt->first );

 if( elem.startAngle == 0 && ( elem.endAngle == 0 || elem.endAngle == 360 ) )
 {
 LIB_SHAPE* circle = new LIB_SHAPE( libSymbolIt->second, SHAPE_T::CIRCLE );
 libSymbolIt->second->AddDrawItem( circle );

 circle->SetUnit( elem.ownerpartid );

 circle->SetPosition( GetRelativePosition( elem.center + m_sheetOffset, symbol ) );
 circle->SetEnd( circle->GetPosition() + wxPoint( elem.radius, 0 ) );
 circle->SetWidth( elem.lineWidth );
 }
 else
 {
 LIB_SHAPE* arc = new LIB_SHAPE( libSymbolIt->second, SHAPE_T::ARC );
 libSymbolIt->second->AddDrawItem( arc );
 arc->SetUnit( elem.ownerpartid );

 arc->SetCenter( GetRelativePosition( elem.center + m_sheetOffset, symbol ) );

 wxPoint arcStart( elem.radius, 0 );
 RotatePoint( &arcStart.x, &arcStart.y, -elem.startAngle * 10.0 );
 arcStart += arc->GetCenter();
 arc->SetStart( arcStart );

 wxPoint arcEnd( elem.radius, 0 );
 RotatePoint( &arcEnd.x, &arcEnd.y, -elem.endAngle * 10.0 );
 arcEnd += arc->GetCenter();
 arc->SetEnd( arcEnd );

 arc->SetWidth( elem.lineWidth );
 }
 }
}

References _, ALTIUM_COMPONENT_NONE, ARC, ASCH_ARC::center, CIRCLE, ASCH_ARC::endAngle, Format(), LIB_SHAPE::GetCenter(), LIB_SHAPE::GetPosition(), GetRelativePosition(), IsComponentPartVisible(), ASCH_ARC::lineWidth, m_libSymbols, m_reporter, m_sheetOffset, m_symbols, ASCH_ARC::ownerindex, ASCH_ARC::ownerpartdisplaymode, ASCH_ARC::ownerpartid, ASCH_ARC::radius, REPORTER::Report(), RotatePoint(), RPT_SEVERITY_ERROR, EDA_SHAPE::SetCenter(), EDA_SHAPE::SetEnd(), LIB_SHAPE::SetPosition(), EDA_SHAPE::SetStart(), LIB_ITEM::SetUnit(), EDA_SHAPE::SetWidth(), and ASCH_ARC::startAngle.

Referenced by ParseFileHeader().

ParseBezier()

void SCH_ALTIUM_PLUGIN::ParseBezier ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 972 of file sch_altium_plugin.cpp.

{
 ASCH_BEZIER elem( aProperties );

 if( elem.points.size() < 2 )
 {
 m_reporter->Report( wxString::Format( _( "Bezier has %d control points. At least 2 are "
 "expected." ),
 static_cast<int>( elem.points.size() ) ),
 RPT_SEVERITY_WARNING );
 return;
 }

 if( elem.ownerpartid == ALTIUM_COMPONENT_NONE )
 {
 for( size_t i = 0; i + 1 < elem.points.size(); i += 3 )
 {
 if( i + 2 == elem.points.size() )
 {
 // special case: single line
 SCH_LINE* line = new SCH_LINE( elem.points.at( i ) + m_sheetOffset,
 SCH_LAYER_ID::LAYER_NOTES );

 line->SetEndPoint( elem.points.at( i + 1 ) + m_sheetOffset );
 line->SetLineWidth( elem.lineWidth );
 line->SetLineStyle( PLOT_DASH_TYPE::SOLID );

 line->SetFlags( IS_NEW );
 m_currentSheet->GetScreen()->Append( line );
 }
 else
 {
 // simulate Bezier using line segments
 std::vector<wxPoint> bezierPoints;
 std::vector<wxPoint> polyPoints;

 for( size_t j = i; j < elem.points.size() && j < i + 4; j++ )
 bezierPoints.push_back( elem.points.at( j ) + m_sheetOffset );

 BEZIER_POLY converter( bezierPoints );
 converter.GetPoly( polyPoints );

 for( size_t k = 0; k + 1 < polyPoints.size(); k++ )
 {
 SCH_LINE* line = new SCH_LINE( polyPoints.at( k ) + m_sheetOffset,
 SCH_LAYER_ID::LAYER_NOTES );

 line->SetEndPoint( polyPoints.at( k + 1 ) + m_sheetOffset );
 line->SetLineWidth( elem.lineWidth );

 line->SetFlags( IS_NEW );
 m_currentSheet->GetScreen()->Append( line );
 }
 }
 }
  }
 else
 {
 const auto& libSymbolIt = m_libSymbols.find( elem.ownerindex );

 if( libSymbolIt == m_libSymbols.end() )
 {
 // TODO: e.g. can depend on Template (RECORD=39
 m_reporter->Report( wxString::Format( _( "Bezier's owner (%d) not found." ),
 elem.ownerindex ),
 RPT_SEVERITY_ERROR );
 return;
 }

 if( !IsComponentPartVisible( elem.ownerindex, elem.ownerpartdisplaymode ) )
 return;

 SCH_SYMBOL* symbol = m_symbols.at( libSymbolIt->first );

 for( size_t i = 0; i + 1 < elem.points.size(); i += 3 )
 {
 if( i + 2 == elem.points.size() )
 {
 // special case: single line
 LIB_SHAPE* line = new LIB_SHAPE( libSymbolIt->second, SHAPE_T::POLY );
 libSymbolIt->second->AddDrawItem( line );

 line->SetUnit( elem.ownerpartid );

 for( size_t j = i; j < elem.points.size() && j < i + 2; j++ )
 {
 line->AddPoint( GetRelativePosition( elem.points.at( j ) + m_sheetOffset,
 symbol ) );
 }

 line->SetWidth( elem.lineWidth );
 }
 else if( i + 3 == elem.points.size() )
 {
 // TODO: special case of a single line with an extra point?
 // I haven't a clue what this is all about, but the sample document we have in
 // https://gitlab.com/kicad/code/kicad/-/issues/8974 responds best by treating it
 // as another single line special case.
 LIB_SHAPE* line = new LIB_SHAPE( libSymbolIt->second, SHAPE_T::POLY );
 libSymbolIt->second->AddDrawItem( line );

 line->SetUnit( elem.ownerpartid );

 for( size_t j = i; j < elem.points.size() && j < i + 2; j++ )
 {
 line->AddPoint( GetRelativePosition( elem.points.at( j ) + m_sheetOffset,
 symbol ) );
 }

 line->SetWidth( elem.lineWidth );
 }
 else
 {
 // Bezier always has exactly 4 control points
 LIB_SHAPE* bezier = new LIB_SHAPE( libSymbolIt->second, SHAPE_T::BEZIER );
 libSymbolIt->second->AddDrawItem( bezier );

 bezier->SetUnit( elem.ownerpartid );

 for( size_t j = i; j < elem.points.size() && j < i + 4; j++ )
 {
 wxPoint pos = GetRelativePosition( elem.points.at( j ) + m_sheetOffset, symbol );

 switch( j - i )
 {
 case 0: bezier->SetStart( pos ); break;
 case 1: bezier->SetBezierC1( pos ); break;
 case 2: bezier->SetBezierC2( pos ); break;
 case 3: bezier->SetEnd( pos ); break;
 default: break; // Can't get here but silence warnings
 }
 }

 bezier->SetWidth( elem.lineWidth );
 }
 }
 }
}

References _, LIB_SHAPE::AddPoint(), ALTIUM_COMPONENT_NONE, SCH_SCREEN::Append(), BEZIER, Format(), BEZIER_POLY::GetPoly(), GetRelativePosition(), SCH_SHEET::GetScreen(), IS_NEW, IsComponentPartVisible(), LAYER_NOTES, ASCH_BEZIER::lineWidth, m_currentSheet, m_libSymbols, m_reporter, m_sheetOffset, m_symbols, ASCH_BEZIER::ownerindex, ASCH_BEZIER::ownerpartdisplaymode, ASCH_BEZIER::ownerpartid, ASCH_BEZIER::points, POLY, REPORTER::Report(), RPT_SEVERITY_ERROR, RPT_SEVERITY_WARNING, EDA_SHAPE::SetBezierC1(), EDA_SHAPE::SetBezierC2(), EDA_SHAPE::SetEnd(), SCH_LINE::SetEndPoint(), EDA_ITEM::SetFlags(), SCH_LINE::SetLineStyle(), SCH_LINE::SetLineWidth(), EDA_SHAPE::SetStart(), LIB_ITEM::SetUnit(), EDA_SHAPE::SetWidth(), and SOLID.

Referenced by ParseFileHeader().

ParseBus()

void SCH_ALTIUM_PLUGIN::ParseBus ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 2077 of file sch_altium_plugin.cpp.

{
 ASCH_BUS elem( aProperties );

 for( size_t i = 0; i + 1 < elem.points.size(); i++ )
 {
 SCH_LINE* bus = new SCH_LINE( elem.points.at( i ) + m_sheetOffset,
 SCH_LAYER_ID::LAYER_BUS );
 bus->SetEndPoint( elem.points.at( i + 1 ) + m_sheetOffset );
 bus->SetLineWidth( elem.lineWidth );

 bus->SetFlags( IS_NEW );
 m_currentSheet->GetScreen()->Append( bus );
 }
}

References SCH_SCREEN::Append(), SCH_SHEET::GetScreen(), IS_NEW, LAYER_BUS, ASCH_BUS::lineWidth, m_currentSheet, m_sheetOffset, ASCH_BUS::points, SCH_LINE::SetEndPoint(), EDA_ITEM::SetFlags(), and SCH_LINE::SetLineWidth().

Referenced by ParseFileHeader().

ParseBusEntry()

void SCH_ALTIUM_PLUGIN::ParseBusEntry ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 2311 of file sch_altium_plugin.cpp.

{
 ASCH_BUS_ENTRY elem( aProperties );

 SCH_BUS_WIRE_ENTRY* busWireEntry = new SCH_BUS_WIRE_ENTRY( elem.location + m_sheetOffset );

 wxPoint vector = elem.corner - elem.location;
 busWireEntry->SetSize( { vector.x, vector.y } );

 busWireEntry->SetFlags( IS_NEW );
 m_currentSheet->GetScreen()->Append( busWireEntry );
}

References SCH_SCREEN::Append(), ASCH_BUS_ENTRY::corner, SCH_SHEET::GetScreen(), IS_NEW, ASCH_BUS_ENTRY::location, m_currentSheet, m_sheetOffset, EDA_ITEM::SetFlags(), and SCH_BUS_ENTRY_BASE::SetSize().

Referenced by ParseFileHeader().

ParseComponent()

void SCH_ALTIUM_PLUGIN::ParseComponent ( int  aIndex, const std::map< wxString, wxString > &  aProperties  )

private

Definition at line 561 of file sch_altium_plugin.cpp.

{
 auto pair = m_altiumComponents.insert( { aIndex, ASCH_SYMBOL( aProperties ) } );
 const ASCH_SYMBOL& elem = pair.first->second;

 // TODO: this is a hack until we correctly apply all transformations to every element
 wxString name = wxString::Format( wxT( "%d%s_%s" ),
 elem.orientation,
 elem.isMirrored ? wxT( "_mirrored" ) : wxEmptyString,
 elem.libreference );
 LIB_ID libId = AltiumToKiCadLibID( getLibName(), name );

 LIB_SYMBOL* ksymbol = new LIB_SYMBOL( wxEmptyString );
 ksymbol->SetName( name );
 ksymbol->SetDescription( elem.componentdescription );
 ksymbol->SetLibId( libId );
 m_libSymbols.insert( { aIndex, ksymbol } );

 // each component has its own symbol for now
 SCH_SYMBOL* symbol = new SCH_SYMBOL();

 symbol->SetPosition( elem.location + m_sheetOffset );

 // TODO: keep it simple for now, and only set position.
 //component->SetOrientation( elem.orientation );
 symbol->SetLibId( libId );

 symbol->SetUnit( elem.currentpartid );

 m_currentSheet->GetScreen()->Append( symbol );

 m_symbols.insert( { aIndex, symbol } );
}

References AltiumToKiCadLibID(), SCH_SCREEN::Append(), ASCH_SYMBOL::componentdescription, ASCH_SYMBOL::currentpartid, Format(), getLibName(), SCH_SHEET::GetScreen(), ASCH_SYMBOL::isMirrored, ASCH_SYMBOL::libreference, ASCH_SYMBOL::location, m_altiumComponents, m_currentSheet, m_libSymbols, m_sheetOffset, m_symbols, name, ASCH_SYMBOL::orientation, LIB_SYMBOL::SetDescription(), LIB_SYMBOL::SetLibId(), SCH_SYMBOL::SetLibId(), LIB_SYMBOL::SetName(), SCH_SYMBOL::SetPosition(), and SCH_SYMBOL::SetUnit().

Referenced by ParseFileHeader().

ParseDesignator()

void SCH_ALTIUM_PLUGIN::ParseDesignator ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 2282 of file sch_altium_plugin.cpp.

{
 ASCH_DESIGNATOR elem( aProperties );

 const auto& libSymbolIt = m_libSymbols.find( elem.ownerindex );

 if( libSymbolIt == m_libSymbols.end() )
 {
 // TODO: e.g. can depend on Template (RECORD=39
 m_reporter->Report( wxString::Format( _( "Designator's owner (%d) not found." ),
 elem.ownerindex ),
 RPT_SEVERITY_ERROR );
 return;
 }

 SCH_SYMBOL* symbol = m_symbols.at( libSymbolIt->first );
 SCH_SHEET_PATH sheetpath;
 m_rootSheet->LocatePathOfScreen( m_currentSheet->GetScreen(), &sheetpath );

 symbol->SetRef( &sheetpath, elem.text );

 SCH_FIELD* refField = symbol->GetField( REFERENCE_FIELD );

 refField->SetPosition( elem.location + m_sheetOffset );
 refField->SetVisible( true );
 SetTextPositioning( refField, elem.justification, elem.orientation );
}

References _, Format(), SCH_SYMBOL::GetField(), SCH_SHEET::GetScreen(), ASCH_DESIGNATOR::justification, SCH_SHEET::LocatePathOfScreen(), ASCH_DESIGNATOR::location, m_currentSheet, m_libSymbols, m_reporter, m_rootSheet, m_sheetOffset, m_symbols, ASCH_DESIGNATOR::orientation, ASCH_DESIGNATOR::ownerindex, REFERENCE_FIELD, REPORTER::Report(), RPT_SEVERITY_ERROR, SCH_FIELD::SetPosition(), SCH_SYMBOL::SetRef(), SetTextPositioning(), EDA_TEXT::SetVisible(), and ASCH_DESIGNATOR::text.

Referenced by ParseFileHeader().

ParseFileHeader()

void SCH_ALTIUM_PLUGIN::ParseFileHeader

(

const CFB::CompoundFileReader &

aReader

)

Definition at line 322 of file sch_altium_plugin.cpp.

{
 const CFB::COMPOUND_FILE_ENTRY* file = FindStream( aReader, "FileHeader" );

 if( file == nullptr )
 THROW_IO_ERROR( wxT( "FileHeader not found" ) );

 ALTIUM_PARSER reader( aReader, file );

 if( reader.GetRemainingBytes() <= 0 )
 {
 THROW_IO_ERROR( wxT( "FileHeader does not contain any data" ) );
 }
 else
 {
 std::map<wxString, wxString> properties = reader.ReadProperties();

 int recordId = ALTIUM_PARSER::ReadInt( properties, wxT( "RECORD" ), 0 );
 ALTIUM_SCH_RECORD record = static_cast<ALTIUM_SCH_RECORD>( recordId );

 if( record != ALTIUM_SCH_RECORD::HEADER )
 THROW_IO_ERROR( wxT( "Header expected" ) );
 }

 // Prepare some local variables
 wxASSERT( m_altiumPortsCurrentSheet.empty() );
 wxASSERT( !m_currentTitleBlock );

 m_currentTitleBlock = std::make_unique<TITLE_BLOCK>();

 // index is required to resolve OWNERINDEX
 for( int index = 0; reader.GetRemainingBytes() > 0; index++ )
 {
 std::map<wxString, wxString> properties = reader.ReadProperties();

 int recordId = ALTIUM_PARSER::ReadInt( properties, wxT( "RECORD" ), 0 );
 ALTIUM_SCH_RECORD record = static_cast<ALTIUM_SCH_RECORD>( recordId );

 // see: https://github.com/vadmium/python-altium/blob/master/format.md
 switch( record )
 {
 case ALTIUM_SCH_RECORD::HEADER:
 THROW_IO_ERROR( wxT( "Header already parsed" ) );
 case ALTIUM_SCH_RECORD::COMPONENT:
 ParseComponent( index, properties );
 break;
 case ALTIUM_SCH_RECORD::PIN:
 ParsePin( properties );
 break;
 case ALTIUM_SCH_RECORD::IEEE_SYMBOL:
 break;
 case ALTIUM_SCH_RECORD::LABEL:
 ParseLabel( properties );
 break;
 case ALTIUM_SCH_RECORD::BEZIER:
 ParseBezier( properties );
 break;
 case ALTIUM_SCH_RECORD::POLYLINE:
 ParsePolyline( properties );
 break;
 case ALTIUM_SCH_RECORD::POLYGON:
 ParsePolygon( properties );
 break;
 case ALTIUM_SCH_RECORD::ELLIPSE:
 break;
 case ALTIUM_SCH_RECORD::PIECHART:
 break;
 case ALTIUM_SCH_RECORD::ROUND_RECTANGLE:
 ParseRoundRectangle( properties );
 break;
 case ALTIUM_SCH_RECORD::ELLIPTICAL_ARC:
 break;
 case ALTIUM_SCH_RECORD::ARC:
 ParseArc( properties );
 break;
 case ALTIUM_SCH_RECORD::LINE:
 ParseLine( properties );
 break;
 case ALTIUM_SCH_RECORD::RECTANGLE:
 ParseRectangle( properties );
 break;
 case ALTIUM_SCH_RECORD::SHEET_SYMBOL:
 ParseSheetSymbol( index, properties );
 break;
 case ALTIUM_SCH_RECORD::SHEET_ENTRY:
 ParseSheetEntry( properties );
 break;
 case ALTIUM_SCH_RECORD::POWER_PORT:
 ParsePowerPort( properties );
 break;
 case ALTIUM_SCH_RECORD::PORT:
 // Ports are parsed after the sheet was parsed
 // This is required because we need all electrical connection points before placing.
 m_altiumPortsCurrentSheet.emplace_back( properties );
 break;
 case ALTIUM_SCH_RECORD::NO_ERC:
 ParseNoERC( properties );
 break;
 case ALTIUM_SCH_RECORD::NET_LABEL:
 ParseNetLabel( properties );
 break;
 case ALTIUM_SCH_RECORD::BUS:
 ParseBus( properties );
 break;
 case ALTIUM_SCH_RECORD::WIRE:
 ParseWire( properties );
 break;
 case ALTIUM_SCH_RECORD::TEXT_FRAME:
 ParseTextFrame( properties );
 break;
 case ALTIUM_SCH_RECORD::JUNCTION:
 ParseJunction( properties );
 break;
 case ALTIUM_SCH_RECORD::IMAGE:
 ParseImage( properties );
 break;
 case ALTIUM_SCH_RECORD::SHEET:
 ParseSheet( properties );
 break;
 case ALTIUM_SCH_RECORD::SHEET_NAME:
 ParseSheetName( properties );
 break;
 case ALTIUM_SCH_RECORD::FILE_NAME:
 ParseFileName( properties );
 break;
 case ALTIUM_SCH_RECORD::DESIGNATOR:
 ParseDesignator( properties );
 break;
 case ALTIUM_SCH_RECORD::BUS_ENTRY:
 ParseBusEntry( properties );
 break;
 case ALTIUM_SCH_RECORD::TEMPLATE:
 break;
 case ALTIUM_SCH_RECORD::PARAMETER:
 ParseParameter( properties );
 break;
 case ALTIUM_SCH_RECORD::WARNING_SIGN:
 break;
 case ALTIUM_SCH_RECORD::IMPLEMENTATION_LIST:
 ParseImplementationList( index, properties );
 break;
 case ALTIUM_SCH_RECORD::IMPLEMENTATION:
 ParseImplementation( properties );
 break;
 case ALTIUM_SCH_RECORD::RECORD_46:
 break;
 case ALTIUM_SCH_RECORD::RECORD_47:
 break;
 case ALTIUM_SCH_RECORD::RECORD_48:
 break;
 case ALTIUM_SCH_RECORD::NOTE:
 ParseNote( properties );
 break;
 case ALTIUM_SCH_RECORD::COMPILE_MASK:
 m_reporter->Report( _( "Compile mask not currently supported." ), RPT_SEVERITY_ERROR );
 break;
 case ALTIUM_SCH_RECORD::RECORD_215:
 break;
 case ALTIUM_SCH_RECORD::RECORD_216:
 break;
 case ALTIUM_SCH_RECORD::RECORD_217:
 break;
 case ALTIUM_SCH_RECORD::RECORD_218:
 break;
 case ALTIUM_SCH_RECORD::RECORD_226:
 break;
 default:
 m_reporter->Report( wxString::Format( _( "Unknown Record id: %d." ), recordId ),
 RPT_SEVERITY_ERROR );
 break;
 }
 }

 if( reader.HasParsingError() )
 THROW_IO_ERROR( wxT( "stream was not parsed correctly!" ) );

 if( reader.GetRemainingBytes() != 0 )
 THROW_IO_ERROR( wxT( "stream is not fully parsed" ) );

 // assign LIB_SYMBOL -> COMPONENT
 for( std::pair<const int, SCH_SYMBOL*>& symbol : m_symbols )
 {
 auto libSymbolIt = m_libSymbols.find( symbol.first );

 if( libSymbolIt == m_libSymbols.end() )
 THROW_IO_ERROR( wxT( "every symbol should have a symbol attached" ) );

 m_pi->SaveSymbol( getLibFileName().GetFullPath(),
 new LIB_SYMBOL( *( libSymbolIt->second ) ), m_properties.get() );

 symbol.second->SetLibSymbol( libSymbolIt->second );
 }

 // Handle title blocks
 m_currentSheet->GetScreen()->SetTitleBlock( *m_currentTitleBlock );
 m_currentTitleBlock.reset();

 // Handle Ports
 for( const ASCH_PORT& port : m_altiumPortsCurrentSheet )
 ParsePort( port );

 m_altiumPortsCurrentSheet.clear();

 m_symbols.clear();
 m_libSymbols.clear();

 // Otherwise we cannot save the imported sheet?
 m_currentSheet->SetModified();
}

References _, ARC, BEZIER, BUS, BUS_ENTRY, COMPILE_MASK, COMPONENT, DESIGNATOR, ELLIPSE, ELLIPTICAL_ARC, FILE_NAME, FindStream(), Format(), getLibFileName(), ALTIUM_PARSER::GetRemainingBytes(), SCH_SHEET::GetScreen(), ALTIUM_PARSER::HasParsingError(), HEADER, IEEE_SYMBOL, IMAGE, IMPLEMENTATION, IMPLEMENTATION_LIST, JUNCTION, LABEL, LINE, m_altiumPortsCurrentSheet, m_currentSheet, m_currentTitleBlock, m_libSymbols, m_pi, m_properties, m_reporter, m_symbols, NET_LABEL, NO_ERC, NOTE, PARAMETER, ParseArc(), ParseBezier(), ParseBus(), ParseBusEntry(), ParseComponent(), ParseDesignator(), ParseFileName(), ParseImage(), ParseImplementation(), ParseImplementationList(), ParseJunction(), ParseLabel(), ParseLine(), ParseNetLabel(), ParseNoERC(), ParseNote(), ParseParameter(), ParsePin(), ParsePolygon(), ParsePolyline(), ParsePort(), ParsePowerPort(), ParseRectangle(), ParseRoundRectangle(), ParseSheet(), ParseSheetEntry(), ParseSheetName(), ParseSheetSymbol(), ParseTextFrame(), ParseWire(), PIECHART, PIN, POLYGON, POLYLINE, PORT, POWER_PORT, ALTIUM_PARSER::ReadInt(), ALTIUM_PARSER::ReadProperties(), RECORD_215, RECORD_216, RECORD_217, RECORD_218, RECORD_226, RECORD_46, RECORD_47, RECORD_48, RECTANGLE, REPORTER::Report(), ROUND_RECTANGLE, RPT_SEVERITY_ERROR, EDA_ITEM::SetModified(), SCH_SCREEN::SetTitleBlock(), SHEET, SHEET_ENTRY, SHEET_NAME, SHEET_SYMBOL, TEMPLATE, TEXT_FRAME, THROW_IO_ERROR, WARNING_SIGN, and WIRE.

Referenced by ParseAltiumSch().

ParseFileName()

void SCH_ALTIUM_PLUGIN::ParseFileName ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 2249 of file sch_altium_plugin.cpp.

{
 ASCH_FILE_NAME elem( aProperties );

 const auto& sheetIt = m_sheets.find( elem.ownerindex );

 if( sheetIt == m_sheets.end() )
 {
 m_reporter->Report( wxString::Format( _( "Filename's owner (%d) not found." ),
 elem.ownerindex ),
 RPT_SEVERITY_ERROR );
 return;
 }

 SCH_FIELD& filenameField = sheetIt->second->GetFields()[SHEETFILENAME];

 filenameField.SetPosition( elem.location + m_sheetOffset );

 // If last symbols are ".sChDoC", change them to ".kicad_sch"
 if( ( elem.text.Right( GetFileExtension().length() + 1 ).Lower() )
 == ( wxT( "." ) + GetFileExtension().Lower() ) )
 {
 elem.text.RemoveLast( GetFileExtension().length() );
 elem.text += KiCadSchematicFileExtension;
 }

 filenameField.SetText( elem.text );

 filenameField.SetVisible( !elem.isHidden );
 SetTextPositioning( &filenameField, ASCH_LABEL_JUSTIFICATION::BOTTOM_LEFT, elem.orientation );
}

References _, BOTTOM_LEFT, Format(), GetFileExtension(), ASCH_FILE_NAME::isHidden, KiCadSchematicFileExtension, ASCH_FILE_NAME::location, m_reporter, m_sheetOffset, m_sheets, ASCH_FILE_NAME::orientation, ASCH_FILE_NAME::ownerindex, REPORTER::Report(), RPT_SEVERITY_ERROR, SCH_FIELD::SetPosition(), EDA_TEXT::SetText(), SetTextPositioning(), EDA_TEXT::SetVisible(), SHEETFILENAME, and ASCH_FILE_NAME::text.

Referenced by ParseFileHeader().

ParseImage()

void SCH_ALTIUM_PLUGIN::ParseImage ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 2122 of file sch_altium_plugin.cpp.

{
 ASCH_IMAGE elem( aProperties );

 wxPoint center = ( elem.location + elem.corner ) / 2 + m_sheetOffset;
 std::unique_ptr<SCH_BITMAP> bitmap = std::make_unique<SCH_BITMAP>( center );

 if( elem.embedimage )
 {
 const ASCH_STORAGE_FILE* storageFile = GetFileFromStorage( elem.filename );

 if( !storageFile )
 {
 wxString msg = wxString::Format( _( "Embedded file %s not found in storage." ),
 elem.filename );
 m_reporter->Report( msg, RPT_SEVERITY_ERROR );
 return;
 }

 wxString storagePath = wxFileName::CreateTempFileName( wxT( "kicad_import_" ) );

 // As wxZlibInputStream is not seekable, we need to write a temporary file
 wxMemoryInputStream fileStream( storageFile->data.data(), storageFile->data.size() );
 wxZlibInputStream zlibInputStream( fileStream );
 wxFFileOutputStream outputStream( storagePath );
 outputStream.Write( zlibInputStream );
 outputStream.Close();

 if( !bitmap->ReadImageFile( storagePath ) )
 {
 m_reporter->Report( wxString::Format( _( "Error reading image %s." ), storagePath ),
 RPT_SEVERITY_ERROR );
 return;
 }

 // Remove temporary file
 wxRemoveFile( storagePath );
 }
 else
 {
 if( !wxFileExists( elem.filename ) )
 {
 m_reporter->Report( wxString::Format( _( "File not found %s." ), elem.filename ),
 RPT_SEVERITY_ERROR );
 return;
 }

 if( !bitmap->ReadImageFile( elem.filename ) )
 {
 m_reporter->Report( wxString::Format( _( "Error reading image %s." ), elem.filename ),
 RPT_SEVERITY_ERROR );
 return;
 }
 }

 // we only support one scale, thus we need to select one in case it does not keep aspect ratio
 wxSize currentImageSize = bitmap->GetSize();
 wxPoint expectedImageSize = elem.location - elem.corner;
 double scaleX = std::abs( static_cast<double>( expectedImageSize.x ) / currentImageSize.x );
 double scaleY = std::abs( static_cast<double>( expectedImageSize.y ) / currentImageSize.y );
 bitmap->SetImageScale( std::min( scaleX, scaleY ) );

 bitmap->SetFlags( IS_NEW );
 m_currentSheet->GetScreen()->Append( bitmap.release() );
}

References _, SCH_SCREEN::Append(), ASCH_IMAGE::corner, ASCH_STORAGE_FILE::data, ASCH_IMAGE::embedimage, ASCH_IMAGE::filename, Format(), GetFileFromStorage(), SCH_SHEET::GetScreen(), IS_NEW, ASCH_IMAGE::location, m_currentSheet, m_reporter, m_sheetOffset, REPORTER::Report(), and RPT_SEVERITY_ERROR.

Referenced by ParseFileHeader().

ParseImplementation()

void SCH_ALTIUM_PLUGIN::ParseImplementation ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 2415 of file sch_altium_plugin.cpp.

{
 ASCH_IMPLEMENTATION elem( aProperties );

 // Only get footprint, currently assigned only
 if( ( elem.type == wxT( "PCBLIB" ) ) && ( elem.isCurrent ) )
 {
 const auto& implementationOwnerIt = m_altiumImplementationList.find( elem.ownerindex );

 if( implementationOwnerIt == m_altiumImplementationList.end() )
 {
 m_reporter->Report( wxString::Format( _( "Implementation's owner (%d) not found." ),
 elem.ownerindex ),
 RPT_SEVERITY_ERROR );
 return;
 }

 const auto& libSymbolIt = m_libSymbols.find( implementationOwnerIt->second );

 if( libSymbolIt == m_libSymbols.end() )
 {
 m_reporter->Report( wxString::Format( _( "Footprint's owner (%d) not found." ),
 implementationOwnerIt->second ),
 RPT_SEVERITY_ERROR );
 return;
 }

 LIB_ID fpLibId = AltiumToKiCadLibID( elem.libname, elem.name );
 wxArrayString fpFilters;
 fpFilters.Add( fpLibId.Format() );

 libSymbolIt->second->SetFPFilters( fpFilters ); // TODO: not ideal as we overwrite it

 SCH_SYMBOL* symbol = m_symbols.at( libSymbolIt->first );

 symbol->SetFootprint( fpLibId.Format() );
 }
}

References _, AltiumToKiCadLibID(), LIB_ID::Format(), Format(), ASCH_IMPLEMENTATION::isCurrent, ASCH_IMPLEMENTATION::libname, m_altiumImplementationList, m_libSymbols, m_reporter, m_symbols, ASCH_IMPLEMENTATION::name, ASCH_IMPLEMENTATION::ownerindex, REPORTER::Report(), RPT_SEVERITY_ERROR, SCH_SYMBOL::SetFootprint(), and ASCH_IMPLEMENTATION::type.

Referenced by ParseFileHeader().

ParseImplementationList()

void SCH_ALTIUM_PLUGIN::ParseImplementationList ( int  aIndex, const std::map< wxString, wxString > &  aProperties  )

private

Definition at line 2406 of file sch_altium_plugin.cpp.

{
 ASCH_IMPLEMENTATION_LIST elem( aProperties );

 m_altiumImplementationList.emplace( aIndex, elem.ownerindex );
}

References m_altiumImplementationList, and ASCH_IMPLEMENTATION_LIST::ownerindex.

Referenced by ParseFileHeader().

ParseJunction()

void SCH_ALTIUM_PLUGIN::ParseJunction ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 2111 of file sch_altium_plugin.cpp.

{
 ASCH_JUNCTION elem( aProperties );

 SCH_JUNCTION* junction = new SCH_JUNCTION( elem.location + m_sheetOffset );

 junction->SetFlags( IS_NEW );
 m_currentSheet->GetScreen()->Append( junction );
}

References SCH_SCREEN::Append(), SCH_SHEET::GetScreen(), IS_NEW, ASCH_JUNCTION::location, m_currentSheet, m_sheetOffset, and EDA_ITEM::SetFlags().

Referenced by ParseFileHeader().

ParseLabel()

void SCH_ALTIUM_PLUGIN::ParseLabel ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 817 of file sch_altium_plugin.cpp.

{
 ASCH_LABEL elem( aProperties );

 if( elem.ownerpartid == ALTIUM_COMPONENT_NONE )
 {
 std::map<wxString, wxString> variableMap = {
 { wxT( "APPLICATION_BUILDNUMBER" ), wxT( "KICAD_VERSION" ) },
 { wxT( "SHEETNUMBER" ), wxT( "#" ) },
 { wxT( "SHEETTOTAL" ), wxT( "##" ) },
 { wxT( "TITLE" ), wxT( "TITLE" ) }, // 1:1 maps are sort of useless, but it makes it
 { wxT( "REVISION" ), wxT( "REVISION" ) }, // easier to see that the list is complete
 { wxT( "DATE" ), wxT( "ISSUE_DATE" ) },
 { wxT( "CURRENTDATE" ), wxT( "CURRENT_DATE" ) },
 { wxT( "COMPANYNAME" ), wxT( "COMPANY" ) },
 { wxT( "DOCUMENTNAME" ), wxT( "FILENAME" ) },
 { wxT( "PROJECTNAME" ), wxT( "PROJECTNAME" ) },
 };

 wxString kicadText = AltiumSpecialStringsToKiCadVariables( elem.text, variableMap );
 SCH_TEXT* textItem = new SCH_TEXT( elem.location + m_sheetOffset, kicadText );

 SetTextPositioning( textItem, elem.justification, elem.orientation );

 size_t fontId = static_cast<int>( elem.fontId );

 if( m_altiumSheet && fontId > 0 && fontId <= m_altiumSheet->fonts.size() )
 {
 const ASCH_SHEET_FONT& font = m_altiumSheet->fonts.at( fontId - 1 );
 textItem->SetItalic( font.italic );
 textItem->SetBold( font.bold );
 textItem->SetTextSize( { font.size / 2, font.size / 2 } );
 }

 textItem->SetFlags(IS_NEW );
 m_currentSheet->GetScreen()->Append( textItem );
 }
 else
 {
 const auto& libSymbolIt = m_libSymbols.find( elem.ownerindex );

 if( libSymbolIt == m_libSymbols.end() )
 {
 // TODO: e.g. can depend on Template (RECORD=39
 m_reporter->Report( wxString::Format( _( "Label's owner (%d) not found." ),
 elem.ownerindex ),
 RPT_SEVERITY_ERROR );
 return;
 }

 SCH_SYMBOL* symbol = m_symbols.at( libSymbolIt->first );
 LIB_TEXT* textItem = new LIB_TEXT( libSymbolIt->second );
 libSymbolIt->second->AddDrawItem( textItem );

 textItem->SetUnit( elem.ownerpartid );

 textItem->SetPosition( GetRelativePosition( elem.location + m_sheetOffset, symbol ) );
 textItem->SetText( elem.text );
 SetTextPositioning( textItem, elem.justification, elem.orientation );

 size_t fontId = static_cast<int>( elem.fontId );

 if( m_altiumSheet && fontId > 0 && fontId <= m_altiumSheet->fonts.size() )
 {
 const ASCH_SHEET_FONT& font = m_altiumSheet->fonts.at( fontId - 1 );
 textItem->SetItalic( font.italic );
 textItem->SetBold( font.bold );
 textItem->SetTextSize( { font.size / 2, font.size / 2 } );
 }
 }
}

References _, ALTIUM_COMPONENT_NONE, AltiumSpecialStringsToKiCadVariables(), SCH_SCREEN::Append(), ASCH_SHEET_FONT::bold, ASCH_LABEL::fontId, fonts, Format(), GetRelativePosition(), SCH_SHEET::GetScreen(), IS_NEW, ASCH_SHEET_FONT::italic, ASCH_LABEL::justification, ASCH_LABEL::location, m_altiumSheet, m_currentSheet, m_libSymbols, m_reporter, m_sheetOffset, m_symbols, ASCH_LABEL::orientation, ASCH_LABEL::ownerindex, ASCH_LABEL::ownerpartid, REPORTER::Report(), RPT_SEVERITY_ERROR, EDA_TEXT::SetBold(), EDA_ITEM::SetFlags(), EDA_TEXT::SetItalic(), LIB_ITEM::SetPosition(), EDA_TEXT::SetText(), SetTextPositioning(), EDA_TEXT::SetTextSize(), LIB_ITEM::SetUnit(), ASCH_SHEET_FONT::size, and ASCH_LABEL::text.

Referenced by ParseFileHeader().

ParseLine()

void SCH_ALTIUM_PLUGIN::ParseLine ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 1380 of file sch_altium_plugin.cpp.

{
 ASCH_LINE elem( aProperties );

 if( elem.ownerpartid == ALTIUM_COMPONENT_NONE )
 {
 // close polygon
 SCH_LINE* line = new SCH_LINE( elem.point1 + m_sheetOffset, SCH_LAYER_ID::LAYER_NOTES );
 line->SetEndPoint( elem.point2 + m_sheetOffset );
 line->SetLineWidth( elem.lineWidth );
 line->SetLineStyle( PLOT_DASH_TYPE::SOLID ); // TODO?

 line->SetFlags( IS_NEW );
 m_currentSheet->GetScreen()->Append( line );
 }
 else
 {
 const auto& libSymbolIt = m_libSymbols.find( elem.ownerindex );

 if( libSymbolIt == m_libSymbols.end() )
 {
 // TODO: e.g. can depend on Template (RECORD=39
 m_reporter->Report( wxString::Format( _( "Line's owner (%d) not found." ),
 elem.ownerindex ),
 RPT_SEVERITY_ERROR );
 return;
 }

 if( !IsComponentPartVisible( elem.ownerindex, elem.ownerpartdisplaymode ) )
 return;

 SCH_SYMBOL* symbol = m_symbols.at( libSymbolIt->first );
 LIB_SHAPE* line = new LIB_SHAPE( libSymbolIt->second, SHAPE_T::POLY );
 libSymbolIt->second->AddDrawItem( line );

 line->SetUnit( elem.ownerpartid );

 line->AddPoint( GetRelativePosition( elem.point1 + m_sheetOffset, symbol ) );
 line->AddPoint( GetRelativePosition( elem.point2 + m_sheetOffset, symbol ) );

 line->SetWidth( elem.lineWidth );
 }
}

References _, LIB_SHAPE::AddPoint(), ALTIUM_COMPONENT_NONE, SCH_SCREEN::Append(), Format(), GetRelativePosition(), SCH_SHEET::GetScreen(), IS_NEW, IsComponentPartVisible(), LAYER_NOTES, ASCH_LINE::lineWidth, m_currentSheet, m_libSymbols, m_reporter, m_sheetOffset, m_symbols, ASCH_LINE::ownerindex, ASCH_LINE::ownerpartdisplaymode, ASCH_LINE::ownerpartid, ASCH_LINE::point1, ASCH_LINE::point2, POLY, REPORTER::Report(), RPT_SEVERITY_ERROR, SCH_LINE::SetEndPoint(), EDA_ITEM::SetFlags(), SCH_LINE::SetLineStyle(), SCH_LINE::SetLineWidth(), LIB_ITEM::SetUnit(), EDA_SHAPE::SetWidth(), and SOLID.

Referenced by ParseFileHeader().

ParseNetLabel()

void SCH_ALTIUM_PLUGIN::ParseNetLabel ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 2048 of file sch_altium_plugin.cpp.

{
 ASCH_NET_LABEL elem( aProperties );

 SCH_LABEL* label = new SCH_LABEL( elem.location + m_sheetOffset, elem.text );

 switch( elem.orientation )
 {
 case ASCH_RECORD_ORIENTATION::RIGHTWARDS:
 label->SetLabelSpinStyle( LABEL_SPIN_STYLE::RIGHT );
 break;
 case ASCH_RECORD_ORIENTATION::UPWARDS:
 label->SetLabelSpinStyle( LABEL_SPIN_STYLE::UP );
 break;
 case ASCH_RECORD_ORIENTATION::LEFTWARDS:
 label->SetLabelSpinStyle( LABEL_SPIN_STYLE::LEFT );
 break;
 case ASCH_RECORD_ORIENTATION::DOWNWARDS:
 label->SetLabelSpinStyle( LABEL_SPIN_STYLE::BOTTOM );
 break;
 default:
 break;
 }

 label->SetFlags( IS_NEW );
 m_currentSheet->GetScreen()->Append( label );
}

References SCH_SCREEN::Append(), LABEL_SPIN_STYLE::BOTTOM, DOWNWARDS, SCH_SHEET::GetScreen(), IS_NEW, LABEL_SPIN_STYLE::LEFT, LEFTWARDS, ASCH_NET_LABEL::location, m_currentSheet, m_sheetOffset, ASCH_NET_LABEL::orientation, LABEL_SPIN_STYLE::RIGHT, RIGHTWARDS, EDA_ITEM::SetFlags(), SCH_TEXT::SetLabelSpinStyle(), ASCH_NET_LABEL::text, LABEL_SPIN_STYLE::UP, and UPWARDS.

Referenced by ParseFileHeader().

ParseNoERC()

void SCH_ALTIUM_PLUGIN::ParseNoERC ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 2034 of file sch_altium_plugin.cpp.

{
 ASCH_NO_ERC elem( aProperties );

 if( elem.isActive )
 {
 SCH_NO_CONNECT* noConnect = new SCH_NO_CONNECT( elem.location + m_sheetOffset );

 noConnect->SetFlags( IS_NEW );
 m_currentSheet->GetScreen()->Append( noConnect );
 }
}

References SCH_SCREEN::Append(), SCH_SHEET::GetScreen(), IS_NEW, ASCH_NO_ERC::isActive, ASCH_NO_ERC::location, m_currentSheet, m_sheetOffset, and EDA_ITEM::SetFlags().

Referenced by ParseFileHeader().

ParseNote()

void SCH_ALTIUM_PLUGIN::ParseNote ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 930 of file sch_altium_plugin.cpp.

{
 ASCH_NOTE elem( aProperties );

 SCH_TEXT* text = new SCH_TEXT( elem.location + m_sheetOffset, elem.text );

 switch( elem.alignment )
 {
 default:
 case ASCH_TEXT_FRAME_ALIGNMENT::LEFT:
 text->SetLabelSpinStyle( LABEL_SPIN_STYLE::SPIN::RIGHT );
 break;
 case ASCH_TEXT_FRAME_ALIGNMENT::CENTER:
 // No support for centered text in Eeschema yet...
 text->SetLabelSpinStyle( LABEL_SPIN_STYLE::SPIN::RIGHT );
 break;
 case ASCH_TEXT_FRAME_ALIGNMENT::RIGHT:
 text->SetLabelSpinStyle( LABEL_SPIN_STYLE::SPIN::LEFT );
 break;
 }

 // TODO: set size and word-wrap once KiCad supports wrapped text.

 // TODO: set border and background color once KiCad supports them.

 // TODO: need some sort of property system for storing author....

 size_t fontId = static_cast<int>( elem.fontId );

 if( m_altiumSheet && fontId > 0 && fontId <= m_altiumSheet->fonts.size() )
 {
 const ASCH_SHEET_FONT& font = m_altiumSheet->fonts.at( fontId - 1 );
 text->SetItalic( font.italic );
 text->SetBold( font.bold );
 text->SetTextSize( { font.size / 2, font.size / 2 } );
 }

 text->SetFlags( IS_NEW );
 m_currentSheet->GetScreen()->Append( text );
}

References ASCH_TEXT_FRAME::alignment, SCH_SCREEN::Append(), ASCH_SHEET_FONT::bold, CENTER, ASCH_TEXT_FRAME::fontId, fonts, SCH_SHEET::GetScreen(), IS_NEW, ASCH_SHEET_FONT::italic, LEFT, ASCH_TEXT_FRAME::location, m_altiumSheet, m_currentSheet, m_sheetOffset, RIGHT, ASCH_SHEET_FONT::size, ASCH_TEXT_FRAME::text, and text.

Referenced by ParseFileHeader().

ParseParameter()

void SCH_ALTIUM_PLUGIN::ParseParameter ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 2325 of file sch_altium_plugin.cpp.

{
 ASCH_PARAMETER elem( aProperties );

 // TODO: fill in replacements from variant, sheet and project
 std::map<wxString, wxString> variableMap = {
 { wxT( "COMMENT" ), wxT( "VALUE" ) },
 { wxT( "VALUE" ), wxT( "ALTIUM_VALUE" ) },
 };

 if( elem.ownerindex <= 0 && elem.ownerpartid == ALTIUM_COMPONENT_NONE )
 {
 // This is some sheet parameter
 if( elem.text == wxT( "*" ) )
 return; // indicates parameter not set?

 wxString paramName = elem.name.Upper();

 if( paramName == wxT( "SHEETNUMBER" ) )
 {
 SCH_SHEET_PATH sheetpath;
 m_rootSheet->LocatePathOfScreen( m_currentSheet->GetScreen(), &sheetpath );

 m_rootSheet->SetPageNumber( sheetpath, elem.text );
 }
 else if( paramName == wxT( "TITLE" ) )
 {
 m_currentTitleBlock->SetTitle( elem.text );
 }
 else if( paramName == wxT( "REVISION" ) )
 {
 m_currentTitleBlock->SetRevision( elem.text );
 }
 else if( paramName == wxT( "DATE" ) )
 {
 m_currentTitleBlock->SetDate( elem.text );
 }
 else if( paramName == wxT( "COMPANYNAME" ) )
 {
 m_currentTitleBlock->SetCompany( elem.text );
 }
 else
 {
 m_schematic->Prj().GetTextVars()[ paramName ] = elem.text;
 }
 }
 else
 {
 const auto& libSymbolIt = m_libSymbols.find( elem.ownerindex );

 if( libSymbolIt == m_libSymbols.end() )
 {
 // TODO: e.g. can depend on Template (RECORD=39
 return;
 }

 SCH_SYMBOL* symbol = m_symbols.at( libSymbolIt->first );
 SCH_FIELD* field = nullptr;

 if( elem.name.Upper() == wxT( "COMMENT" ) )
 field = symbol->GetField( VALUE_FIELD );
 else
 {
 int fieldIdx = symbol->GetFieldCount();
 wxString fieldName = elem.name.Upper();

 if( fieldName == wxT( "VALUE" ) )
 fieldName = wxT( "ALTIUM_VALUE" );

 field = symbol->AddField( SCH_FIELD( wxPoint(), fieldIdx, symbol, fieldName ) );
 }

 wxString kicadText = AltiumSpecialStringsToKiCadVariables( elem.text, variableMap );
 field->SetText( kicadText );
 field->SetPosition( elem.location + m_sheetOffset );
 field->SetVisible( !elem.isHidden );
 SetTextPositioning( field, elem.justification, elem.orientation );
 }
}

References SCH_SYMBOL::AddField(), ALTIUM_COMPONENT_NONE, AltiumSpecialStringsToKiCadVariables(), SCH_SYMBOL::GetField(), SCH_SYMBOL::GetFieldCount(), SCH_SHEET::GetScreen(), PROJECT::GetTextVars(), ASCH_PARAMETER::isHidden, ASCH_PARAMETER::justification, SCH_SHEET::LocatePathOfScreen(), ASCH_PARAMETER::location, m_currentSheet, m_currentTitleBlock, m_libSymbols, m_rootSheet, m_schematic, m_sheetOffset, m_symbols, ASCH_PARAMETER::name, ASCH_PARAMETER::orientation, ASCH_PARAMETER::ownerindex, ASCH_PARAMETER::ownerpartid, SCHEMATIC::Prj(), SCH_SHEET::SetPageNumber(), SCH_FIELD::SetPosition(), EDA_TEXT::SetText(), SetTextPositioning(), EDA_TEXT::SetVisible(), ASCH_PARAMETER::text, and VALUE_FIELD.

Referenced by ParseFileHeader().

ParsePin()

void SCH_ALTIUM_PLUGIN::ParsePin ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 597 of file sch_altium_plugin.cpp.

{
 ASCH_PIN elem( aProperties );

 const auto& libSymbolIt = m_libSymbols.find( elem.ownerindex );

 if( libSymbolIt == m_libSymbols.end() )
 {
 // TODO: e.g. can depend on Template (RECORD=39
 m_reporter->Report( wxString::Format( _( "Pin's owner (%d) not found." ), elem.ownerindex ),
 RPT_SEVERITY_ERROR );
 return;
 }

 if( !IsComponentPartVisible( elem.ownerindex, elem.ownerpartdisplaymode ) )
 return;

 SCH_SYMBOL* symbol = m_symbols.at( libSymbolIt->first );
 LIB_PIN* pin = new LIB_PIN( libSymbolIt->second );
 libSymbolIt->second->AddDrawItem( pin );

 pin->SetUnit( elem.ownerpartid );

 pin->SetName( elem.name );
 pin->SetNumber( elem.designator );
 pin->SetLength( elem.pinlength );

 if( !elem.showDesignator )
 pin->SetNumberTextSize( 0 );

 if( !elem.showPinName )
 pin->SetNameTextSize( 0 );

 wxPoint pinLocation = elem.location; // the location given is not the connection point!

 switch( elem.orientation )
 {
 case ASCH_RECORD_ORIENTATION::RIGHTWARDS:
 pin->SetOrientation( DrawPinOrient::PIN_LEFT );
 pinLocation.x += elem.pinlength;
 break;
 case ASCH_RECORD_ORIENTATION::UPWARDS:
 pin->SetOrientation( DrawPinOrient::PIN_DOWN );
 pinLocation.y -= elem.pinlength;
 break;
 case ASCH_RECORD_ORIENTATION::LEFTWARDS:
 pin->SetOrientation( DrawPinOrient::PIN_RIGHT );
 pinLocation.x -= elem.pinlength;
 break;
 case ASCH_RECORD_ORIENTATION::DOWNWARDS:
 pin->SetOrientation( DrawPinOrient::PIN_UP );
 pinLocation.y += elem.pinlength;
 break;
 default:
 m_reporter->Report( _( "Pin has unexpected orientation." ), RPT_SEVERITY_WARNING );
 break;
 }

 // TODO: position can be sometimes off a little bit!
 pin->SetPosition( GetRelativePosition( pinLocation + m_sheetOffset, symbol ) );

 // TODO: the following fix is even worse for now?
 // pin->SetPosition( GetRelativePosition( elem.kicadLocation, symbol ) );

 switch( elem.electrical )
 {
 case ASCH_PIN_ELECTRICAL::INPUT:
 pin->SetType( ELECTRICAL_PINTYPE::PT_INPUT );
 break;
 case ASCH_PIN_ELECTRICAL::BIDI:
 pin->SetType( ELECTRICAL_PINTYPE::PT_BIDI );
 break;
 case ASCH_PIN_ELECTRICAL::OUTPUT:
 pin->SetType( ELECTRICAL_PINTYPE::PT_OUTPUT );
 break;
 case ASCH_PIN_ELECTRICAL::OPEN_COLLECTOR:
 pin->SetType( ELECTRICAL_PINTYPE::PT_OPENCOLLECTOR );
 break;
 case ASCH_PIN_ELECTRICAL::PASSIVE:
 pin->SetType( ELECTRICAL_PINTYPE::PT_PASSIVE );
 break;
 case ASCH_PIN_ELECTRICAL::TRISTATE:
 pin->SetType( ELECTRICAL_PINTYPE::PT_TRISTATE );
 break;
 case ASCH_PIN_ELECTRICAL::OPEN_EMITTER:
 pin->SetType( ELECTRICAL_PINTYPE::PT_OPENEMITTER );
 break;
 case ASCH_PIN_ELECTRICAL::POWER:
 pin->SetType( ELECTRICAL_PINTYPE::PT_POWER_IN );
 break;
 case ASCH_PIN_ELECTRICAL::UNKNOWN:
 default:
 pin->SetType( ELECTRICAL_PINTYPE::PT_UNSPECIFIED );
 m_reporter->Report( _( "Pin has unexpected electrical type." ), RPT_SEVERITY_WARNING );
 break;
 }

 if( elem.symbolOuterEdge == ASCH_PIN_SYMBOL_OUTEREDGE::UNKNOWN )
 m_reporter->Report( _( "Pin has unexpected outer edge type." ), RPT_SEVERITY_WARNING );

 if( elem.symbolInnerEdge == ASCH_PIN_SYMBOL_INNEREDGE::UNKNOWN )
 m_reporter->Report( _( "Pin has unexpected inner edge type." ), RPT_SEVERITY_WARNING );

 if( elem.symbolOuterEdge == ASCH_PIN_SYMBOL_OUTEREDGE::NEGATED )
 {
 switch( elem.symbolInnerEdge )
 {
 case ASCH_PIN_SYMBOL_INNEREDGE::CLOCK:
 pin->SetShape( GRAPHIC_PINSHAPE::INVERTED_CLOCK );
 break;
 default:
 pin->SetShape( GRAPHIC_PINSHAPE::INVERTED );
 break;
 }
 }
 else if( elem.symbolOuterEdge == ASCH_PIN_SYMBOL_OUTEREDGE::LOW_INPUT )
 {
 switch( elem.symbolInnerEdge )
 {
 case ASCH_PIN_SYMBOL_INNEREDGE::CLOCK:
 pin->SetShape( GRAPHIC_PINSHAPE::CLOCK_LOW );
 break;
 default:
 pin->SetShape( GRAPHIC_PINSHAPE::INPUT_LOW );
 break;
 }
 }
 else if( elem.symbolOuterEdge == ASCH_PIN_SYMBOL_OUTEREDGE::LOW_OUTPUT )
 {
 pin->SetShape( GRAPHIC_PINSHAPE::OUTPUT_LOW );
 }
 else
 {
 switch( elem.symbolInnerEdge )
 {
 case ASCH_PIN_SYMBOL_INNEREDGE::CLOCK:
 pin->SetShape( GRAPHIC_PINSHAPE::CLOCK );
 break;
 default:
 pin->SetShape( GRAPHIC_PINSHAPE::LINE ); // nothing to do
 break;
 }
 }
}

References _, BIDI, CLOCK, CLOCK_LOW, ASCH_PIN::designator, DOWNWARDS, ASCH_PIN::electrical, Format(), GetRelativePosition(), INPUT, INPUT_LOW, INVERTED, INVERTED_CLOCK, IsComponentPartVisible(), LEFTWARDS, LINE, ASCH_PIN::location, LOW_INPUT, LOW_OUTPUT, m_libSymbols, m_reporter, m_sheetOffset, m_symbols, ASCH_PIN::name, NEGATED, OPEN_COLLECTOR, OPEN_EMITTER, ASCH_PIN::orientation, OUTPUT, OUTPUT_LOW, ASCH_PIN::ownerindex, ASCH_PIN::ownerpartdisplaymode, ASCH_PIN::ownerpartid, PASSIVE, pin, PIN_DOWN, PIN_LEFT, PIN_RIGHT, PIN_UP, ASCH_PIN::pinlength, POWER, PT_BIDI, PT_INPUT, PT_OPENCOLLECTOR, PT_OPENEMITTER, PT_OUTPUT, PT_PASSIVE, PT_POWER_IN, PT_TRISTATE, PT_UNSPECIFIED, REPORTER::Report(), RIGHTWARDS, RPT_SEVERITY_ERROR, RPT_SEVERITY_WARNING, ASCH_PIN::showDesignator, ASCH_PIN::showPinName, ASCH_PIN::symbolInnerEdge, ASCH_PIN::symbolOuterEdge, TRISTATE, UNKNOWN, and UPWARDS.

Referenced by ParseFileHeader().

ParsePolygon()

void SCH_ALTIUM_PLUGIN::ParsePolygon ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 1171 of file sch_altium_plugin.cpp.

{
 ASCH_POLYGON elem( aProperties );

 if( elem.ownerpartid == ALTIUM_COMPONENT_NONE )
 {
 // TODO: we cannot fill this polygon, only draw it for now
 for( size_t i = 0; i + 1 < elem.points.size(); i++ )
 {
 SCH_LINE* line = new SCH_LINE( elem.points.at( i ) + m_sheetOffset,
 SCH_LAYER_ID::LAYER_NOTES );
 line->SetEndPoint( elem.points.at( i + 1 ) + m_sheetOffset );
 line->SetLineWidth( elem.lineWidth );
 line->SetLineStyle( PLOT_DASH_TYPE::SOLID );

 line->SetFlags( IS_NEW );
 m_currentSheet->GetScreen()->Append( line );
 }

 // close polygon
 SCH_LINE* line = new SCH_LINE( elem.points.front() + m_sheetOffset,
 SCH_LAYER_ID::LAYER_NOTES );
 line->SetEndPoint( elem.points.back() + m_sheetOffset );
 line->SetLineWidth( elem.lineWidth );
 line->SetLineStyle( PLOT_DASH_TYPE::SOLID );

 line->SetFlags( IS_NEW );
 m_currentSheet->GetScreen()->Append( line );
 }
 else
 {
 const auto& libSymbolIt = m_libSymbols.find( elem.ownerindex );

 if( libSymbolIt == m_libSymbols.end() )
 {
 // TODO: e.g. can depend on Template (RECORD=39
 m_reporter->Report( wxString::Format( _( "Polygon's owner (%d) not found." ),
 elem.ownerindex ),
 RPT_SEVERITY_ERROR );
 return;
 }

 if( !IsComponentPartVisible( elem.ownerindex, elem.ownerpartdisplaymode ) )
 return;

 SCH_SYMBOL* symbol = m_symbols.at( libSymbolIt->first );
 LIB_SHAPE* line = new LIB_SHAPE( libSymbolIt->second, SHAPE_T::POLY );
 libSymbolIt->second->AddDrawItem( line );

 line->SetUnit( elem.ownerpartid );

 for( wxPoint& point : elem.points )
 line->AddPoint( GetRelativePosition( point + m_sheetOffset, symbol ) );

 line->AddPoint( GetRelativePosition( elem.points.front() + m_sheetOffset, symbol ) );

 line->SetWidth( elem.lineWidth );

 if( !elem.isSolid )
 line->SetFillMode( FILL_T::NO_FILL );
 else if( elem.color == elem.areacolor )
 line->SetFillMode( FILL_T::FILLED_SHAPE );
 else
 line->SetFillMode( FILL_T::FILLED_WITH_BG_BODYCOLOR );
 }
}

References _, LIB_SHAPE::AddPoint(), ALTIUM_COMPONENT_NONE, SCH_SCREEN::Append(), ASCH_POLYGON::areacolor, ASCH_POLYGON::color, FILLED_SHAPE, FILLED_WITH_BG_BODYCOLOR, Format(), GetRelativePosition(), SCH_SHEET::GetScreen(), IS_NEW, IsComponentPartVisible(), ASCH_POLYGON::isSolid, LAYER_NOTES, ASCH_POLYGON::lineWidth, m_currentSheet, m_libSymbols, m_reporter, m_sheetOffset, m_symbols, NO_FILL, ASCH_POLYGON::ownerindex, ASCH_POLYGON::ownerpartdisplaymode, ASCH_POLYGON::ownerpartid, ASCH_POLYGON::points, POLY, REPORTER::Report(), RPT_SEVERITY_ERROR, SCH_LINE::SetEndPoint(), EDA_SHAPE::SetFillMode(), EDA_ITEM::SetFlags(), SCH_LINE::SetLineStyle(), SCH_LINE::SetLineWidth(), LIB_ITEM::SetUnit(), EDA_SHAPE::SetWidth(), and SOLID.

Referenced by ParseFileHeader().

ParsePolyline()

void SCH_ALTIUM_PLUGIN::ParsePolyline ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 1112 of file sch_altium_plugin.cpp.

{
 ASCH_POLYLINE elem( aProperties );

 if( elem.ownerpartid == ALTIUM_COMPONENT_NONE )
 {
 PLOT_DASH_TYPE dashType = PLOT_DASH_TYPE::DEFAULT;
 switch( elem.linestyle )
 {
 default:
 case ASCH_POLYLINE_LINESTYLE::SOLID: dashType = PLOT_DASH_TYPE::SOLID; break;
 case ASCH_POLYLINE_LINESTYLE::DASHED: dashType = PLOT_DASH_TYPE::DASH; break;
 case ASCH_POLYLINE_LINESTYLE::DOTTED: dashType = PLOT_DASH_TYPE::DOT; break;
  case ASCH_POLYLINE_LINESTYLE::DASH_DOTTED: dashType = PLOT_DASH_TYPE::DASHDOT; break;
 }

 for( size_t i = 0; i + 1 < elem.points.size(); i++ )
 {
 SCH_LINE* line = new SCH_LINE( elem.points.at( i ) + m_sheetOffset,
 SCH_LAYER_ID::LAYER_NOTES );

 line->SetEndPoint( elem.points.at( i + 1 ) + m_sheetOffset );
 line->SetLineWidth( elem.lineWidth );
 line->SetLineStyle( dashType );

 line->SetFlags( IS_NEW );
 m_currentSheet->GetScreen()->Append( line );
 }
 }
 else
 {
 const auto& libSymbolIt = m_libSymbols.find( elem.ownerindex );

 if( libSymbolIt == m_libSymbols.end() )
 {
 // TODO: e.g. can depend on Template (RECORD=39
 m_reporter->Report( wxString::Format( _( "Polyline's owner (%d) not found." ),
 elem.ownerindex ),
 RPT_SEVERITY_ERROR );
 return;
 }

 if( !IsComponentPartVisible( elem.ownerindex, elem.ownerpartdisplaymode ) )
 return;

 SCH_SYMBOL* symbol = m_symbols.at( libSymbolIt->first );
 LIB_SHAPE* line = new LIB_SHAPE( libSymbolIt->second, SHAPE_T::POLY );
 libSymbolIt->second->AddDrawItem( line );

 line->SetUnit( elem.ownerpartid );

 for( wxPoint& point : elem.points )
 line->AddPoint( GetRelativePosition( point + m_sheetOffset, symbol ) );

 line->SetWidth( elem.lineWidth );
 }
}

References _, LIB_SHAPE::AddPoint(), ALTIUM_COMPONENT_NONE, SCH_SCREEN::Append(), DASH, DASH_DOTTED, DASHDOT, DASHED, DEFAULT, DOT, DOTTED, Format(), GetRelativePosition(), SCH_SHEET::GetScreen(), IS_NEW, IsComponentPartVisible(), LAYER_NOTES, ASCH_POLYLINE::linestyle, ASCH_POLYLINE::lineWidth, m_currentSheet, m_libSymbols, m_reporter, m_sheetOffset, m_symbols, ASCH_POLYLINE::ownerindex, ASCH_POLYLINE::ownerpartdisplaymode, ASCH_POLYLINE::ownerpartid, ASCH_POLYLINE::points, POLY, REPORTER::Report(), RPT_SEVERITY_ERROR, SCH_LINE::SetEndPoint(), EDA_ITEM::SetFlags(), SCH_LINE::SetLineStyle(), SCH_LINE::SetLineWidth(), LIB_ITEM::SetUnit(), EDA_SHAPE::SetWidth(), and SOLID.

Referenced by ParseFileHeader().

ParsePort()

void SCH_ALTIUM_PLUGIN::ParsePort ( const ASCH_PORT &  aElem )

private

Definition at line 1903 of file sch_altium_plugin.cpp.

{
 bool isHarness = !aElem.harnessType.IsEmpty();
 wxPoint start = aElem.location + m_sheetOffset;
 wxPoint end = start;

 switch( aElem.style )
 {
 default:
 case ASCH_PORT_STYLE::NONE_HORIZONTAL:
 case ASCH_PORT_STYLE::LEFT:
 case ASCH_PORT_STYLE::RIGHT:
 case ASCH_PORT_STYLE::LEFT_RIGHT:
 end.x += aElem.width;
 break;
 case ASCH_PORT_STYLE::NONE_VERTICAL:
 case ASCH_PORT_STYLE::TOP:
 case ASCH_PORT_STYLE::BOTTOM:
 case ASCH_PORT_STYLE::TOP_BOTTOM:
 end.y -= aElem.width;
 break;
 }

 // Check which connection points exists in the schematic
 SCH_SCREEN* screen = m_currentSheet->GetScreen();

 bool startIsWireTerminal = screen->IsTerminalPoint( start, LAYER_WIRE );
 bool startIsBusTerminal = screen->IsTerminalPoint( start, LAYER_BUS );

 bool endIsWireTerminal = screen->IsTerminalPoint( end, LAYER_WIRE );
 bool endIsBusTerminal = screen->IsTerminalPoint( end, LAYER_BUS );

 // check if any of the points is a terminal point
 // TODO: there seems a problem to detect approximated connections towards component pins?
 bool connectionFound = startIsWireTerminal
 || startIsBusTerminal
 || endIsWireTerminal
 || endIsBusTerminal;

 if( !isHarness && !connectionFound )
 {
 m_reporter->Report( wxString::Format( _( "Port %s has no connections." ), aElem.name ),
 RPT_SEVERITY_WARNING );
 }

 // Select label position. In case both match, we will add a line later.
 wxPoint position = ( startIsWireTerminal || startIsBusTerminal ) ? start : end;
 SCH_TEXT* label;

 if( isHarness )
 {
 wxString name = wxT( "HARNESS: " ) + aElem.name;

 if( aElem.harnessType != aElem.name )
 name += wxString::Format( wxT( " (%s)" ), aElem.harnessType );

 label = new SCH_TEXT( position, name );
 }
 // TODO: detect correct label type depending on sheet settings, etc.
 //{
 // label = new SCH_HIERLABEL( elem.location + m_sheetOffset, elem.name );
 //}
 else
 {

 label = new SCH_GLOBALLABEL( position, aElem.name );
 }

 switch( aElem.iotype )
 {
 default:
 case ASCH_PORT_IOTYPE::UNSPECIFIED:
 label->SetShape( PINSHEETLABEL_SHAPE::PS_UNSPECIFIED );
 break;
 case ASCH_PORT_IOTYPE::OUTPUT:
 label->SetShape( PINSHEETLABEL_SHAPE::PS_OUTPUT );
 break;
 case ASCH_PORT_IOTYPE::INPUT:
 label->SetShape( PINSHEETLABEL_SHAPE::PS_INPUT );
 break;
 case ASCH_PORT_IOTYPE::BIDI:
 label->SetShape( PINSHEETLABEL_SHAPE::PS_BIDI );
 break;
 }

 switch( aElem.style )
 {
 default:
 case ASCH_PORT_STYLE::NONE_HORIZONTAL:
 case ASCH_PORT_STYLE::LEFT:
 case ASCH_PORT_STYLE::RIGHT:
 case ASCH_PORT_STYLE::LEFT_RIGHT:
 if( ( startIsWireTerminal || startIsBusTerminal ) )
 label->SetLabelSpinStyle( LABEL_SPIN_STYLE::RIGHT );
 else
 label->SetLabelSpinStyle( LABEL_SPIN_STYLE::LEFT );
 break;
 case ASCH_PORT_STYLE::NONE_VERTICAL:
 case ASCH_PORT_STYLE::TOP:
 case ASCH_PORT_STYLE::BOTTOM:
 case ASCH_PORT_STYLE::TOP_BOTTOM:
 if( ( startIsWireTerminal || startIsBusTerminal ) )
 label->SetLabelSpinStyle( LABEL_SPIN_STYLE::UP );
 else
 label->SetLabelSpinStyle( LABEL_SPIN_STYLE::BOTTOM );
 break;
 }

 label->SetFlags( IS_NEW );
 m_currentSheet->GetScreen()->Append( label );

 // This is a hack, for the case both connection points are valid: add a small wire
 if( ( startIsWireTerminal && endIsWireTerminal ) )
 {
 SCH_LINE* wire = new SCH_LINE( start, SCH_LAYER_ID::LAYER_WIRE );
 wire->SetEndPoint( end );
 wire->SetLineWidth( Mils2iu( 2 ) );
 wire->SetFlags( IS_NEW );
 m_currentSheet->GetScreen()->Append( wire );
 }
 else if( startIsBusTerminal && endIsBusTerminal )
 {
 SCH_LINE* wire = new SCH_LINE( start, SCH_LAYER_ID::LAYER_BUS );
 wire->SetEndPoint( end );
 wire->SetLineWidth( Mils2iu( 2 ) );
 wire->SetFlags( IS_NEW );
 m_currentSheet->GetScreen()->Append( wire );
 }
}

References _, SCH_SCREEN::Append(), BIDI, LABEL_SPIN_STYLE::BOTTOM, BOTTOM, Format(), SCH_SHEET::GetScreen(), ASCH_PORT::harnessType, INPUT, ASCH_PORT::iotype, IS_NEW, SCH_SCREEN::IsTerminalPoint(), LAYER_BUS, LAYER_WIRE, LABEL_SPIN_STYLE::LEFT, LEFT, LEFT_RIGHT, ASCH_PORT::location, m_currentSheet, m_reporter, m_sheetOffset, name, ASCH_PORT::name, NONE_HORIZONTAL, NONE_VERTICAL, OUTPUT, PS_BIDI, PS_INPUT, PS_OUTPUT, PS_UNSPECIFIED, REPORTER::Report(), LABEL_SPIN_STYLE::RIGHT, RIGHT, RPT_SEVERITY_WARNING, SCH_LINE::SetEndPoint(), EDA_ITEM::SetFlags(), SCH_TEXT::SetLabelSpinStyle(), SCH_LINE::SetLineWidth(), SCH_TEXT::SetShape(), ASCH_PORT::style, TOP, TOP_BOTTOM, UNSPECIFIED, LABEL_SPIN_STYLE::UP, and ASCH_PORT::width.

Referenced by ParseFileHeader().

ParsePowerPort()

void SCH_ALTIUM_PLUGIN::ParsePowerPort ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 1808 of file sch_altium_plugin.cpp.

{
 ASCH_POWER_PORT elem( aProperties );
 LIB_ID libId = AltiumToKiCadLibID( getLibName(), elem.text );
 LIB_SYMBOL* libSymbol = nullptr;

 const auto& powerSymbolIt = m_powerSymbols.find( elem.text );

 if( powerSymbolIt != m_powerSymbols.end() )
 {
 libSymbol = powerSymbolIt->second; // cache hit
 }
 else
 {
 libSymbol = new LIB_SYMBOL( wxEmptyString );
 libSymbol->SetPower();
 libSymbol->SetName( elem.text );
 libSymbol->GetReferenceField().SetText( wxT( "#PWR" ) );
 libSymbol->GetValueField().SetText( elem.text );
 libSymbol->GetValueField().SetVisible( true );
 libSymbol->SetDescription( wxString::Format( _( "Power symbol creates a global "
 "label with name '%s'" ), elem.text ) );
 libSymbol->SetKeyWords( wxT( "power-flag" ) );
 libSymbol->SetLibId( libId );

 // generate graphic
 LIB_PIN* pin = new LIB_PIN( libSymbol );
 libSymbol->AddDrawItem( pin );

 pin->SetName( elem.text );
 pin->SetPosition( { 0, 0 } );
 pin->SetLength( 0 );

 // marks the pin as a global label
 pin->SetType( ELECTRICAL_PINTYPE::PT_POWER_IN );
 pin->SetVisible( false );

 wxPoint valueFieldPos = HelperGeneratePowerPortGraphics( libSymbol, elem.style, m_reporter );

 libSymbol->GetValueField().SetPosition( valueFieldPos );

 // this has to be done after parsing the LIB_SYMBOL!
 m_pi->SaveSymbol( getLibFileName().GetFullPath(), libSymbol, m_properties.get() );
 m_powerSymbols.insert( { elem.text, libSymbol } );
 }

 SCH_SHEET_PATH sheetpath;
 m_rootSheet->LocatePathOfScreen( m_currentSheet->GetScreen(), &sheetpath );

 // each symbol has its own powerSymbolIt for now
 SCH_SYMBOL* symbol = new SCH_SYMBOL();
 symbol->SetRef( &sheetpath, wxT( "#PWR?" ) );
 symbol->SetValue( elem.text );
 symbol->SetLibId( libId );
 symbol->SetLibSymbol( new LIB_SYMBOL( *libSymbol ) );

 SCH_FIELD* valueField = symbol->GetField( VALUE_FIELD );
 valueField->SetVisible( elem.showNetName );

 // TODO: Why do I need to set this a second time?
 valueField->SetPosition( libSymbol->GetValueField().GetPosition() );

 symbol->SetPosition( elem.location + m_sheetOffset );

 switch( elem.orientation )
 {
 case ASCH_RECORD_ORIENTATION::RIGHTWARDS:
 symbol->SetOrientation( SYMBOL_ORIENTATION_T::SYM_ORIENT_90 );
 valueField->SetTextAngle( TEXT_ANGLE_VERT );
 valueField->SetHorizJustify( EDA_TEXT_HJUSTIFY_T::GR_TEXT_HJUSTIFY_RIGHT );
 break;
 case ASCH_RECORD_ORIENTATION::UPWARDS:
 symbol->SetOrientation( SYMBOL_ORIENTATION_T::SYM_ORIENT_180 );
 valueField->SetTextAngle( TEXT_ANGLE_HORIZ );
 valueField->SetHorizJustify( EDA_TEXT_HJUSTIFY_T::GR_TEXT_HJUSTIFY_CENTER );
 break;
 case ASCH_RECORD_ORIENTATION::LEFTWARDS:
 symbol->SetOrientation( SYMBOL_ORIENTATION_T::SYM_ORIENT_270 );
 valueField->SetTextAngle( TEXT_ANGLE_VERT );
 valueField->SetHorizJustify( EDA_TEXT_HJUSTIFY_T::GR_TEXT_HJUSTIFY_RIGHT );
 break;
 case ASCH_RECORD_ORIENTATION::DOWNWARDS:
  symbol->SetOrientation( SYMBOL_ORIENTATION_T::SYM_ORIENT_0 );
 valueField->SetTextAngle( TEXT_ANGLE_HORIZ );
 valueField->SetHorizJustify( EDA_TEXT_HJUSTIFY_T::GR_TEXT_HJUSTIFY_CENTER );
 break;
 default:
 m_reporter->Report( _( "Pin has unexpected orientation." ), RPT_SEVERITY_WARNING );
 break;
 }

 m_currentSheet->GetScreen()->Append( symbol );
}

References _, LIB_SYMBOL::AddDrawItem(), AltiumToKiCadLibID(), SCH_SCREEN::Append(), DOWNWARDS, Format(), SCH_SYMBOL::GetField(), getLibFileName(), getLibName(), LIB_FIELD::GetPosition(), LIB_SYMBOL::GetReferenceField(), SCH_SHEET::GetScreen(), LIB_SYMBOL::GetValueField(), GR_TEXT_HJUSTIFY_CENTER, GR_TEXT_HJUSTIFY_RIGHT, HelperGeneratePowerPortGraphics(), LEFTWARDS, SCH_SHEET::LocatePathOfScreen(), ASCH_POWER_PORT::location, m_currentSheet, m_pi, m_powerSymbols, m_properties, m_reporter, m_rootSheet, m_sheetOffset, ASCH_POWER_PORT::orientation, pin, PT_POWER_IN, REPORTER::Report(), RIGHTWARDS, RPT_SEVERITY_WARNING, LIB_SYMBOL::SetDescription(), EDA_TEXT::SetHorizJustify(), LIB_SYMBOL::SetKeyWords(), LIB_SYMBOL::SetLibId(), SCH_SYMBOL::SetLibId(), SCH_SYMBOL::SetLibSymbol(), LIB_SYMBOL::SetName(), SCH_SYMBOL::SetOrientation(), SCH_FIELD::SetPosition(), LIB_ITEM::SetPosition(), SCH_SYMBOL::SetPosition(), LIB_SYMBOL::SetPower(), SCH_SYMBOL::SetRef(), EDA_TEXT::SetText(), EDA_TEXT::SetTextAngle(), SCH_SYMBOL::SetValue(), EDA_TEXT::SetVisible(), ASCH_POWER_PORT::showNetName, ASCH_POWER_PORT::style, SYM_ORIENT_0, SYM_ORIENT_180, SYM_ORIENT_270, SYM_ORIENT_90, ASCH_POWER_PORT::text, TEXT_ANGLE_HORIZ, TEXT_ANGLE_VERT, UPWARDS, and VALUE_FIELD.

Referenced by ParseFileHeader().

ParseRectangle()

void SCH_ALTIUM_PLUGIN::ParseRectangle ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 1425 of file sch_altium_plugin.cpp.

{
 ASCH_RECTANGLE elem( aProperties );

 wxPoint sheetTopRight = elem.topRight + m_sheetOffset;
 wxPoint sheetBottomLeft = elem.bottomLeft + m_sheetOffset;

 if( elem.ownerpartid == ALTIUM_COMPONENT_NONE )
 {
 const wxPoint topLeft = { sheetBottomLeft.x, sheetTopRight.y };
 const wxPoint bottomRight = { sheetTopRight.x, sheetBottomLeft.y };

 // TODO: we cannot fill this rectangle, only draw it for now
 SCH_LINE* lineTop = new SCH_LINE( sheetTopRight, SCH_LAYER_ID::LAYER_NOTES );
 lineTop->SetEndPoint( topLeft );
 lineTop->SetLineWidth( elem.lineWidth );
 lineTop->SetLineStyle( PLOT_DASH_TYPE::SOLID );
 lineTop->SetFlags( IS_NEW );
 m_currentSheet->GetScreen()->Append( lineTop );

 SCH_LINE* lineBottom = new SCH_LINE( sheetBottomLeft, SCH_LAYER_ID::LAYER_NOTES );
 lineBottom->SetEndPoint( bottomRight );
 lineBottom->SetLineWidth( elem.lineWidth );
 lineBottom->SetLineStyle( PLOT_DASH_TYPE::SOLID );
 lineBottom->SetFlags( IS_NEW );
 m_currentSheet->GetScreen()->Append( lineBottom );

 SCH_LINE* lineRight = new SCH_LINE( sheetTopRight, SCH_LAYER_ID::LAYER_NOTES );
 lineRight->SetEndPoint( bottomRight );
 lineRight->SetLineWidth( elem.lineWidth );
 lineRight->SetLineStyle( PLOT_DASH_TYPE::SOLID );
 lineRight->SetFlags( IS_NEW );
 m_currentSheet->GetScreen()->Append( lineRight );

 SCH_LINE* lineLeft = new SCH_LINE( sheetBottomLeft, SCH_LAYER_ID::LAYER_NOTES );
 lineLeft->SetEndPoint( topLeft );
 lineLeft->SetLineWidth( elem.lineWidth );
 lineLeft->SetLineStyle( PLOT_DASH_TYPE::SOLID );
 lineLeft->SetFlags( IS_NEW );
 m_currentSheet->GetScreen()->Append( lineLeft );
 }
 else
 {
 const auto& libSymbolIt = m_libSymbols.find( elem.ownerindex );

 if( libSymbolIt == m_libSymbols.end() )
 {
 // TODO: e.g. can depend on Template (RECORD=39
 m_reporter->Report( wxString::Format( _( "Rectangle's owner (%d) not found." ),
 elem.ownerindex ),
 RPT_SEVERITY_ERROR );
 return;
 }

 if( !IsComponentPartVisible( elem.ownerindex, elem.ownerpartdisplaymode ) )
 return;

 SCH_SYMBOL* symbol = m_symbols.at( libSymbolIt->first );
 LIB_SHAPE* rect = new LIB_SHAPE( libSymbolIt->second, SHAPE_T::RECT );
 libSymbolIt->second->AddDrawItem( rect );

 rect->SetUnit( elem.ownerpartid );

 rect->SetPosition( GetRelativePosition( sheetTopRight, symbol ) );
 rect->SetEnd( GetRelativePosition( sheetBottomLeft, symbol ) );
 rect->SetWidth( elem.lineWidth );

 if( !elem.isSolid )
 rect->SetFillMode( FILL_T::NO_FILL );
 else if( elem.color == elem.areacolor )
 rect->SetFillMode( FILL_T::FILLED_SHAPE );
 else
 rect->SetFillMode( FILL_T::FILLED_WITH_BG_BODYCOLOR );
 }
}

References _, ALTIUM_COMPONENT_NONE, SCH_SCREEN::Append(), ASCH_RECTANGLE::areacolor, ASCH_RECTANGLE::bottomLeft, ASCH_RECTANGLE::color, FILLED_SHAPE, FILLED_WITH_BG_BODYCOLOR, Format(), GetRelativePosition(), SCH_SHEET::GetScreen(), IS_NEW, IsComponentPartVisible(), ASCH_RECTANGLE::isSolid, LAYER_NOTES, ASCH_RECTANGLE::lineWidth, m_currentSheet, m_libSymbols, m_reporter, m_sheetOffset, m_symbols, NO_FILL, ASCH_RECTANGLE::ownerindex, ASCH_RECTANGLE::ownerpartdisplaymode, ASCH_RECTANGLE::ownerpartid, RECT, REPORTER::Report(), RPT_SEVERITY_ERROR, EDA_SHAPE::SetEnd(), SCH_LINE::SetEndPoint(), EDA_SHAPE::SetFillMode(), EDA_ITEM::SetFlags(), SCH_LINE::SetLineStyle(), SCH_LINE::SetLineWidth(), LIB_SHAPE::SetPosition(), LIB_ITEM::SetUnit(), EDA_SHAPE::SetWidth(), SOLID, and ASCH_RECTANGLE::topRight.

Referenced by ParseFileHeader().

ParseRoundRectangle()

void SCH_ALTIUM_PLUGIN::ParseRoundRectangle ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 1239 of file sch_altium_plugin.cpp.

{
 ASCH_ROUND_RECTANGLE elem( aProperties );

 wxPoint sheetTopRight = elem.topRight + m_sheetOffset;
 wxPoint sheetBottomLeft = elem.bottomLeft + m_sheetOffset;

 if( elem.ownerpartid == ALTIUM_COMPONENT_NONE )
 {
 const wxPoint topLeft = { sheetBottomLeft.x, sheetTopRight.y };
 const wxPoint bottomRight = { sheetTopRight.x, sheetBottomLeft.y };

 // TODO: we cannot fill this rectangle, only draw it for now
 // TODO: misses rounded edges
 SCH_LINE* lineTop = new SCH_LINE( sheetTopRight, SCH_LAYER_ID::LAYER_NOTES );
 lineTop->SetEndPoint( topLeft );
 lineTop->SetLineWidth( elem.lineWidth );
 lineTop->SetLineStyle( PLOT_DASH_TYPE::SOLID );
 lineTop->SetFlags( IS_NEW );
 m_currentSheet->GetScreen()->Append( lineTop );

 SCH_LINE* lineBottom = new SCH_LINE( sheetBottomLeft, SCH_LAYER_ID::LAYER_NOTES );
 lineBottom->SetEndPoint( bottomRight );
 lineBottom->SetLineWidth( elem.lineWidth );
 lineBottom->SetLineStyle( PLOT_DASH_TYPE::SOLID );
 lineBottom->SetFlags( IS_NEW );
 m_currentSheet->GetScreen()->Append( lineBottom );

 SCH_LINE* lineRight = new SCH_LINE( sheetTopRight, SCH_LAYER_ID::LAYER_NOTES );
 lineRight->SetEndPoint( bottomRight );
 lineRight->SetLineWidth( elem.lineWidth );
 lineRight->SetLineStyle( PLOT_DASH_TYPE::SOLID );
 lineRight->SetFlags( IS_NEW );
 m_currentSheet->GetScreen()->Append( lineRight );

 SCH_LINE* lineLeft = new SCH_LINE( sheetBottomLeft, SCH_LAYER_ID::LAYER_NOTES );
 lineLeft->SetEndPoint( topLeft );
 lineLeft->SetLineWidth( elem.lineWidth );
 lineLeft->SetLineStyle( PLOT_DASH_TYPE::SOLID );
 lineLeft->SetFlags( IS_NEW );
 m_currentSheet->GetScreen()->Append( lineLeft );
 }
 else
 {
 const auto& libSymbolIt = m_libSymbols.find( elem.ownerindex );

 if( libSymbolIt == m_libSymbols.end() )
 {
 // TODO: e.g. can depend on Template (RECORD=39
 m_reporter->Report( wxString::Format( _( "Rounded rectangle's owner (%d) not found." ),
 elem.ownerindex ),
 RPT_SEVERITY_ERROR );
 return;
 }

 if( !IsComponentPartVisible( elem.ownerindex, elem.ownerpartdisplaymode ) )
 return;

 SCH_SYMBOL* symbol = m_symbols.at( libSymbolIt->first );
 // TODO: misses rounded edges
 LIB_SHAPE* rect = new LIB_SHAPE( libSymbolIt->second, SHAPE_T::RECT );
 libSymbolIt->second->AddDrawItem( rect );

 rect->SetUnit( elem.ownerpartid );

 rect->SetPosition( GetRelativePosition( elem.topRight + m_sheetOffset, symbol ) );
 rect->SetEnd( GetRelativePosition( elem.bottomLeft + m_sheetOffset, symbol ) );
 rect->SetWidth( elem.lineWidth );

 if( !elem.isSolid )
 rect->SetFillMode( FILL_T::NO_FILL );
 else if( elem.color == elem.areacolor )
 rect->SetFillMode( FILL_T::FILLED_SHAPE );
 else
 rect->SetFillMode( FILL_T::FILLED_WITH_BG_BODYCOLOR );
 }
}

References _, ALTIUM_COMPONENT_NONE, SCH_SCREEN::Append(), ASCH_ROUND_RECTANGLE::areacolor, ASCH_ROUND_RECTANGLE::bottomLeft, ASCH_ROUND_RECTANGLE::color, FILLED_SHAPE, FILLED_WITH_BG_BODYCOLOR, Format(), GetRelativePosition(), SCH_SHEET::GetScreen(), IS_NEW, IsComponentPartVisible(), ASCH_ROUND_RECTANGLE::isSolid, LAYER_NOTES, ASCH_ROUND_RECTANGLE::lineWidth, m_currentSheet, m_libSymbols, m_reporter, m_sheetOffset, m_symbols, NO_FILL, ASCH_ROUND_RECTANGLE::ownerindex, ASCH_ROUND_RECTANGLE::ownerpartdisplaymode, ASCH_ROUND_RECTANGLE::ownerpartid, RECT, REPORTER::Report(), RPT_SEVERITY_ERROR, EDA_SHAPE::SetEnd(), SCH_LINE::SetEndPoint(), EDA_SHAPE::SetFillMode(), EDA_ITEM::SetFlags(), SCH_LINE::SetLineStyle(), SCH_LINE::SetLineWidth(), LIB_SHAPE::SetPosition(), LIB_ITEM::SetUnit(), EDA_SHAPE::SetWidth(), SOLID, and ASCH_ROUND_RECTANGLE::topRight.

Referenced by ParseFileHeader().

ParseSheet()

void SCH_ALTIUM_PLUGIN::ParseSheet ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 2189 of file sch_altium_plugin.cpp.

{
 m_altiumSheet = std::make_unique<ASCH_SHEET>( aProperties );

 PAGE_INFO pageInfo;

 bool isPortrait = m_altiumSheet->sheetOrientation == ASCH_SHEET_WORKSPACEORIENTATION::PORTRAIT;

 switch( m_altiumSheet->sheetSize )
 {
 default:
 case ASCH_SHEET_SIZE::A4: pageInfo.SetType( wxT( "A4" ), isPortrait ); break;
 case ASCH_SHEET_SIZE::A3: pageInfo.SetType( wxT( "A3" ), isPortrait ); break;
 case ASCH_SHEET_SIZE::A2: pageInfo.SetType( wxT( "A2" ), isPortrait ); break;
 case ASCH_SHEET_SIZE::A1: pageInfo.SetType( wxT( "A1" ), isPortrait ); break;
 case ASCH_SHEET_SIZE::A0: pageInfo.SetType( wxT( "A0" ), isPortrait ); break;
 case ASCH_SHEET_SIZE::A: pageInfo.SetType( wxT( "A" ), isPortrait ); break;
 case ASCH_SHEET_SIZE::B: pageInfo.SetType( wxT( "B" ), isPortrait ); break;
 case ASCH_SHEET_SIZE::C: pageInfo.SetType( wxT( "C" ), isPortrait ); break;
 case ASCH_SHEET_SIZE::D: pageInfo.SetType( wxT( "D" ), isPortrait ); break;
 case ASCH_SHEET_SIZE::E: pageInfo.SetType( wxT( "E" ), isPortrait ); break;
 case ASCH_SHEET_SIZE::LETTER: pageInfo.SetType( wxT( "USLetter" ), isPortrait ); break;
 case ASCH_SHEET_SIZE::LEGAL: pageInfo.SetType( wxT( "USLegal" ), isPortrait ); break;
 case ASCH_SHEET_SIZE::TABLOID: pageInfo.SetType( wxT( "A3" ), isPortrait ); break;
 case ASCH_SHEET_SIZE::ORCAD_A: pageInfo.SetType( wxT( "A" ), isPortrait ); break;
 case ASCH_SHEET_SIZE::ORCAD_B: pageInfo.SetType( wxT( "B" ), isPortrait ); break;
 case ASCH_SHEET_SIZE::ORCAD_C: pageInfo.SetType( wxT( "C" ), isPortrait ); break;
 case ASCH_SHEET_SIZE::ORCAD_D: pageInfo.SetType( wxT( "D" ), isPortrait ); break;
 case ASCH_SHEET_SIZE::ORCAD_E: pageInfo.SetType( wxT( "E" ), isPortrait ); break;
 }

 m_currentSheet->GetScreen()->SetPageSettings( pageInfo );

 m_sheetOffset = { 0, pageInfo.GetHeightIU() };
}

References A, A0, A1, A2, A3, A4, B, C, D, E, SCH_SHEET::GetScreen(), LEGAL, LETTER, m_altiumSheet, m_currentSheet, m_sheetOffset, ORCAD_A, ORCAD_B, ORCAD_C, ORCAD_D, ORCAD_E, PORTRAIT, SCH_SCREEN::SetPageSettings(), PAGE_INFO::SetType(), and TABLOID.

Referenced by ParseFileHeader().

ParseSheetEntry()

void SCH_ALTIUM_PLUGIN::ParseSheetEntry ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 1533 of file sch_altium_plugin.cpp.

{
 ASCH_SHEET_ENTRY elem( aProperties );

 const auto& sheetIt = m_sheets.find( elem.ownerindex );

 if( sheetIt == m_sheets.end() )
 {
 m_reporter->Report( wxString::Format( _( "Sheet entry's owner (%d) not found." ),
 elem.ownerindex ),
 RPT_SEVERITY_ERROR );
 return;
 }

 SCH_SHEET_PIN* sheetPin = new SCH_SHEET_PIN( sheetIt->second );
 sheetIt->second->AddPin( sheetPin );

 sheetPin->SetText( elem.name );
 sheetPin->SetShape( PINSHEETLABEL_SHAPE::PS_UNSPECIFIED );
 //sheetPin->SetLabelSpinStyle( getSpinStyle( term.OrientAngle, false ) );
 //sheetPin->SetPosition( getKiCadPoint( term.Position ) );

 wxPoint pos = sheetIt->second->GetPosition();
 wxSize size = sheetIt->second->GetSize();

 switch( elem.side )
 {
 default:
 case ASCH_SHEET_ENTRY_SIDE::LEFT:
 sheetPin->SetPosition( { pos.x, pos.y + elem.distanceFromTop } );
 sheetPin->SetLabelSpinStyle( LABEL_SPIN_STYLE::LEFT );
 sheetPin->SetSide( SHEET_SIDE::LEFT );
 break;
 case ASCH_SHEET_ENTRY_SIDE::RIGHT:
 sheetPin->SetPosition( { pos.x + size.x, pos.y + elem.distanceFromTop } );
 sheetPin->SetLabelSpinStyle( LABEL_SPIN_STYLE::RIGHT );
 sheetPin->SetSide( SHEET_SIDE::RIGHT );
 break;
 case ASCH_SHEET_ENTRY_SIDE::TOP:
 sheetPin->SetPosition( { pos.x + elem.distanceFromTop, pos.y } );
 sheetPin->SetLabelSpinStyle( LABEL_SPIN_STYLE::UP );
 sheetPin->SetSide( SHEET_SIDE::TOP );
 break;
 case ASCH_SHEET_ENTRY_SIDE::BOTTOM:
 sheetPin->SetPosition( { pos.x + elem.distanceFromTop, pos.y + size.y } );
 sheetPin->SetLabelSpinStyle( LABEL_SPIN_STYLE::BOTTOM );
 sheetPin->SetSide( SHEET_SIDE::BOTTOM );
 break;
 }

 switch( elem.iotype )
 {
 default:
 case ASCH_PORT_IOTYPE::UNSPECIFIED:
 sheetPin->SetShape( PINSHEETLABEL_SHAPE::PS_UNSPECIFIED );
 break;
 case ASCH_PORT_IOTYPE::OUTPUT:
 sheetPin->SetShape( PINSHEETLABEL_SHAPE::PS_OUTPUT );
 break;
 case ASCH_PORT_IOTYPE::INPUT:
 sheetPin->SetShape( PINSHEETLABEL_SHAPE::PS_INPUT );
 break;
 case ASCH_PORT_IOTYPE::BIDI:
 sheetPin->SetShape( PINSHEETLABEL_SHAPE::PS_BIDI );
 break;
 }
}

References _, BIDI, LABEL_SPIN_STYLE::BOTTOM, BOTTOM, ASCH_SHEET_ENTRY::distanceFromTop, Format(), INPUT, ASCH_SHEET_ENTRY::iotype, LABEL_SPIN_STYLE::LEFT, LEFT, m_reporter, m_sheets, ASCH_SHEET_ENTRY::name, OUTPUT, ASCH_SHEET_ENTRY::ownerindex, PS_BIDI, PS_INPUT, PS_OUTPUT, PS_UNSPECIFIED, REPORTER::Report(), LABEL_SPIN_STYLE::RIGHT, RIGHT, RPT_SEVERITY_ERROR, SCH_HIERLABEL::SetLabelSpinStyle(), SCH_SHEET_PIN::SetPosition(), SCH_TEXT::SetShape(), SCH_SHEET_PIN::SetSide(), EDA_TEXT::SetText(), ASCH_SHEET_ENTRY::side, TOP, UNSPECIFIED, and LABEL_SPIN_STYLE::UP.

Referenced by ParseFileHeader().

ParseSheetName()

void SCH_ALTIUM_PLUGIN::ParseSheetName ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 2226 of file sch_altium_plugin.cpp.

{
 ASCH_SHEET_NAME elem( aProperties );

 const auto& sheetIt = m_sheets.find( elem.ownerindex );

 if( sheetIt == m_sheets.end() )
 {
 m_reporter->Report( wxString::Format( _( "Sheetname's owner (%d) not found." ),
 elem.ownerindex ),
 RPT_SEVERITY_ERROR );
 return;
 }

 SCH_FIELD& sheetNameField = sheetIt->second->GetFields()[SHEETNAME];

 sheetNameField.SetPosition( elem.location + m_sheetOffset );
 sheetNameField.SetText( elem.text );
 sheetNameField.SetVisible( !elem.isHidden );
 SetTextPositioning( &sheetNameField, ASCH_LABEL_JUSTIFICATION::BOTTOM_LEFT, elem.orientation );
}

References _, BOTTOM_LEFT, Format(), ASCH_SHEET_NAME::isHidden, ASCH_SHEET_NAME::location, m_reporter, m_sheetOffset, m_sheets, ASCH_SHEET_NAME::orientation, ASCH_SHEET_NAME::ownerindex, REPORTER::Report(), RPT_SEVERITY_ERROR, SCH_FIELD::SetPosition(), EDA_TEXT::SetText(), SetTextPositioning(), EDA_TEXT::SetVisible(), SHEETNAME, and ASCH_SHEET_NAME::text.

Referenced by ParseFileHeader().

ParseSheetSymbol()

void SCH_ALTIUM_PLUGIN::ParseSheetSymbol ( int  aIndex, const std::map< wxString, wxString > &  aProperties  )

private

Definition at line 1502 of file sch_altium_plugin.cpp.

{
 ASCH_SHEET_SYMBOL elem( aProperties );

 SCH_SHEET* sheet = new SCH_SHEET( m_currentSheet, elem.location + m_sheetOffset );
 SCH_SCREEN* screen = new SCH_SCREEN( m_schematic );

 sheet->SetSize( elem.size );
 sheet->SetBorderColor( GetColorFromInt( elem.color ) );

 if( elem.isSolid )
 sheet->SetBackgroundColor( GetColorFromInt( elem.areacolor ) );

 sheet->SetScreen( screen );

 sheet->SetFlags( IS_NEW );
 m_currentSheet->GetScreen()->Append( sheet );

 SCH_SHEET_PATH sheetpath;
 m_rootSheet->LocatePathOfScreen( m_currentSheet->GetScreen(), &sheetpath );
 sheetpath.push_back( sheet );

 sheet->AddInstance( sheetpath );
 sheet->SetPageNumber( sheetpath, wxT( "#" ) ); // We'll update later if we find a pageNumber
 // record for it

 m_sheets.insert( { aIndex, sheet } );
}

References SCH_SHEET::AddInstance(), SCH_SCREEN::Append(), ASCH_SHEET_SYMBOL::areacolor, ASCH_SHEET_SYMBOL::color, GetColorFromInt(), SCH_SHEET::GetScreen(), IS_NEW, ASCH_SHEET_SYMBOL::isSolid, SCH_SHEET::LocatePathOfScreen(), ASCH_SHEET_SYMBOL::location, m_currentSheet, m_rootSheet, m_schematic, m_sheetOffset, m_sheets, SCH_SHEET_PATH::push_back(), SCH_SHEET::SetBackgroundColor(), SCH_SHEET::SetBorderColor(), EDA_ITEM::SetFlags(), SCH_SHEET::SetPageNumber(), SCH_SHEET::SetScreen(), SCH_SHEET::SetSize(), and ASCH_SHEET_SYMBOL::size.

Referenced by ParseFileHeader().

ParseStorage()

void SCH_ALTIUM_PLUGIN::ParseStorage

(

const CFB::CompoundFileReader &

aReader

)

Definition at line 286 of file sch_altium_plugin.cpp.

{
 const CFB::COMPOUND_FILE_ENTRY* file = FindStream( aReader, "Storage" );

 if( file == nullptr )
 return;

 ALTIUM_PARSER reader( aReader, file );

 std::map<wxString, wxString> properties = reader.ReadProperties();
 wxString header = ALTIUM_PARSER::ReadString( properties, wxT( "HEADER" ), wxEmptyString );
 int weight = ALTIUM_PARSER::ReadInt( properties, wxT( "WEIGHT" ), 0 );

 if( weight < 0 )
 THROW_IO_ERROR( wxT( "Storage weight is negative!" ) );

 for( int i = 0; i < weight; i++ )
 {
 m_altiumStorage.emplace_back( reader );
 }

 if( reader.HasParsingError() )
 THROW_IO_ERROR( wxT( "stream was not parsed correctly!" ) );

 // TODO pointhi: is it possible to have multiple headers in one Storage file? Otherwise
 // throw IO Error.
 if( reader.GetRemainingBytes() != 0 )
 {
 m_reporter->Report( wxString::Format( _( "Storage file not fully parsed "
 wxT( "(%d bytes remaining)." ) ),
 reader.GetRemainingBytes() ),
 RPT_SEVERITY_ERROR );
 }
}

References _, FindStream(), Format(), ALTIUM_PARSER::GetRemainingBytes(), ALTIUM_PARSER::HasParsingError(), m_altiumStorage, m_reporter, ALTIUM_PARSER::ReadInt(), ALTIUM_PARSER::ReadProperties(), ALTIUM_PARSER::ReadString(), REPORTER::Report(), RPT_SEVERITY_ERROR, and THROW_IO_ERROR.

Referenced by ParseAltiumSch().

ParseTextFrame()

void SCH_ALTIUM_PLUGIN::ParseTextFrame ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 890 of file sch_altium_plugin.cpp.

{
 ASCH_TEXT_FRAME elem( aProperties );

 SCH_TEXT* text = new SCH_TEXT( elem.location + m_sheetOffset, elem.text );

 switch( elem.alignment )
 {
 default:
 case ASCH_TEXT_FRAME_ALIGNMENT::LEFT:
 text->SetLabelSpinStyle( LABEL_SPIN_STYLE::SPIN::RIGHT );
 break;
 case ASCH_TEXT_FRAME_ALIGNMENT::CENTER:
 // No support for centered text in Eeschema yet...
 text->SetLabelSpinStyle( LABEL_SPIN_STYLE::SPIN::RIGHT );
 break;
 case ASCH_TEXT_FRAME_ALIGNMENT::RIGHT:
 text->SetLabelSpinStyle( LABEL_SPIN_STYLE::SPIN::LEFT );
 break;
 }

 // TODO: set size and word-wrap once KiCad supports wrapped text.

 // TODO: set border and background color once KiCad supports them.

 size_t fontId = static_cast<int>( elem.fontId );

 if( m_altiumSheet && fontId > 0 && fontId <= m_altiumSheet->fonts.size() )
 {
 const ASCH_SHEET_FONT& font = m_altiumSheet->fonts.at( fontId - 1 );
 text->SetItalic( font.italic );
 text->SetBold( font.bold );
 text->SetTextSize( { font.size / 2, font.size / 2 } );
 }

 text->SetFlags( IS_NEW );
 m_currentSheet->GetScreen()->Append( text );
}

References ASCH_TEXT_FRAME::alignment, SCH_SCREEN::Append(), ASCH_SHEET_FONT::bold, CENTER, ASCH_TEXT_FRAME::fontId, fonts, SCH_SHEET::GetScreen(), IS_NEW, ASCH_SHEET_FONT::italic, LEFT, ASCH_TEXT_FRAME::location, m_altiumSheet, m_currentSheet, m_sheetOffset, RIGHT, ASCH_SHEET_FONT::size, ASCH_TEXT_FRAME::text, and text.

Referenced by ParseFileHeader().

ParseWire()

void SCH_ALTIUM_PLUGIN::ParseWire ( const std::map< wxString, wxString > &  aProperties )

private

Definition at line 2094 of file sch_altium_plugin.cpp.

{
 ASCH_WIRE elem( aProperties );

 for( size_t i = 0; i + 1 < elem.points.size(); i++ )
 {
 SCH_LINE* wire =
 new SCH_LINE( elem.points.at( i ) + m_sheetOffset, SCH_LAYER_ID::LAYER_WIRE );
 wire->SetEndPoint( elem.points.at( i + 1 ) + m_sheetOffset );
 wire->SetLineWidth( elem.lineWidth );

 wire->SetFlags( IS_NEW );
 m_currentSheet->GetScreen()->Append( wire );
 }
}

References SCH_SCREEN::Append(), SCH_SHEET::GetScreen(), IS_NEW, LAYER_WIRE, ASCH_WIRE::lineWidth, m_currentSheet, m_sheetOffset, ASCH_WIRE::points, SCH_LINE::SetEndPoint(), EDA_ITEM::SetFlags(), and SCH_LINE::SetLineWidth().

Referenced by ParseFileHeader().

Save()

void SCH_PLUGIN::Save ( const wxString &  aFileName, SCH_SHEET *  aSheet, SCHEMATIC *  aSchematic, const PROPERTIES *  aProperties = nullptr  )

virtualinherited

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

aFileName	is the name of a file to save to on disk.
aSheet	is the class SCH_SHEET 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.
aSchematic	is the SCHEMATIC object used to access any schematic-wide or project information needed to save the document.
aProperties	is 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. Set the #PropSaveCurrentSheetOnly property to only save the current sheet. Otherwise, all hierarchical sheets are saved.

Exceptions

IO_ERROR

if there is a problem saving or exporting.

Reimplemented in SCH_LEGACY_PLUGIN, and SCH_SEXPR_PLUGIN.

Definition at line 59 of file sch_plugin.cpp.

{
 // not pure virtual so that plugins only have to implement subset of the SCH_PLUGIN interface.
 not_implemented( this, __FUNCTION__ );
}

References not_implemented().

SaveLibrary()

void SCH_PLUGIN::SaveLibrary ( const wxString &  aFileName, const PROPERTIES *  aProperties = nullptr  )

virtualinherited

Reimplemented in SCH_LEGACY_PLUGIN, and SCH_SEXPR_PLUGIN.

Definition at line 45 of file sch_plugin.cpp.

{
 not_implemented( this, __FUNCTION__ );
}

References not_implemented().

SaveSymbol()

void SCH_PLUGIN::SaveSymbol ( const wxString &  aLibraryPath, const LIB_SYMBOL *  aSymbol, const PROPERTIES *  aProperties = nullptr  )

virtualinherited

Write aSymbol to an existing library located at aLibraryPath.

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

Parameters

aLibraryPath	is a locator for the "library", usually a directory, file, or URL containing several symbols.
aSymbol	is what to store in the library. The library is refreshed and the caller must update any LIB_SYMBOL pointers that may have changed.
aProperties	is 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_ERROR

if there is a problem saving.

Reimplemented in SCH_LEGACY_PLUGIN, and SCH_SEXPR_PLUGIN.

Definition at line 94 of file sch_plugin.cpp.

{
 // not pure virtual so that plugins only have to implement subset of the SCH_PLUGIN interface.
 not_implemented( this, __FUNCTION__ );
}

References not_implemented().

Referenced by SYMBOL_LIBRARY_MANAGER::LIB_BUFFER::SaveBuffer().

SetProgressReporter()

virtual void SCH_PLUGIN::SetProgressReporter ( PROGRESS_REPORTER *  aReporter )

inlinevirtualinherited

Set an optional progress reporter.

Reimplemented in SCH_EAGLE_PLUGIN, SCH_LEGACY_PLUGIN, SCH_SEXPR_PLUGIN, and CADSTAR_SCH_ARCHIVE_PLUGIN.

Definition at line 171 of file sch_io_mgr.h.

{}

SetReporter()

void SCH_ALTIUM_PLUGIN::SetReporter ( REPORTER *  aReporter )

inlineoverridevirtual

Set an optional reporter for warnings/errors.

Reimplemented from SCH_PLUGIN.

Definition at line 59 of file sch_altium_plugin.h.

{ m_reporter = aReporter; }

References m_reporter.

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

aListToAppendTo

holds 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 133 of file sch_plugin.cpp.

{
 // disable all these in another couple of months, after everyone has seen them:
#if 1
 (*aListToAppendTo)["debug_level"] = UTF8( _(
 "Enable <b>debug</b> logging for Symbol*() functions in this SCH_PLUGIN."
 ) );

 (*aListToAppendTo)["read_filter_regex"] = UTF8( _(
 "Regular expression <b>symbol name</b> filter."
 ) );

 (*aListToAppendTo)["enable_transaction_logging"] = UTF8( _(
 "Enable transaction logging. The mere presence of this option turns on the "
 "logging, no need to set a Value."
 ) );

 (*aListToAppendTo)["username"] = UTF8( _(
 "User name for <b>login</b> to some special library server."
 ) );

 (*aListToAppendTo)["password"] = UTF8( _(
 "Password for <b>login</b> to some special library server."
 ) );
#endif

#if 1
 // Suitable for a C++ to python SCH_PLUGIN::Footprint*() adapter, move it to the adapter
 // if and when implemented.
 (*aListToAppendTo)["python_symbol_plugin"] = UTF8( _(
 "Enter the python symbol which implements the SCH_PLUGIN::Symbol*() functions."
 ) );
#endif
}

References _.

Member Data Documentation

m_altiumComponents

std::map<int, ASCH_SYMBOL> SCH_ALTIUM_PLUGIN::m_altiumComponents

private

Definition at line 169 of file sch_altium_plugin.h.

Referenced by IsComponentPartVisible(), and ParseComponent().

m_altiumImplementationList

std::map<int, int> SCH_ALTIUM_PLUGIN::m_altiumImplementationList

private

Definition at line 170 of file sch_altium_plugin.h.

Referenced by ParseImplementation(), and ParseImplementationList().

m_altiumPortsCurrentSheet

std::vector<ASCH_PORT> SCH_ALTIUM_PLUGIN::m_altiumPortsCurrentSheet

private

Definition at line 171 of file sch_altium_plugin.h.

Referenced by ParseFileHeader().

m_altiumSheet

std::unique_ptr<ASCH_SHEET> SCH_ALTIUM_PLUGIN::m_altiumSheet

private

Definition at line 161 of file sch_altium_plugin.h.

Referenced by ParseLabel(), ParseNote(), ParseSheet(), and ParseTextFrame().

m_altiumStorage

std::vector<ASCH_STORAGE_FILE> SCH_ALTIUM_PLUGIN::m_altiumStorage

private

Definition at line 167 of file sch_altium_plugin.h.

Referenced by GetFileFromStorage(), and ParseStorage().

m_currentSheet

SCH_SHEET* SCH_ALTIUM_PLUGIN::m_currentSheet

private

Definition at line 150 of file sch_altium_plugin.h.

Referenced by Load(), ParseBezier(), ParseBus(), ParseBusEntry(), ParseComponent(), ParseDesignator(), ParseFileHeader(), ParseImage(), ParseJunction(), ParseLabel(), ParseLine(), ParseNetLabel(), ParseNoERC(), ParseNote(), ParseParameter(), ParsePolygon(), ParsePolyline(), ParsePort(), ParsePowerPort(), ParseRectangle(), ParseRoundRectangle(), ParseSheet(), ParseSheetSymbol(), ParseTextFrame(), ParseWire(), and SCH_ALTIUM_PLUGIN().

m_currentTitleBlock

std::unique_ptr<TITLE_BLOCK> SCH_ALTIUM_PLUGIN::m_currentTitleBlock

private

Definition at line 157 of file sch_altium_plugin.h.

Referenced by ParseFileHeader(), and ParseParameter().

m_libName

wxString SCH_ALTIUM_PLUGIN::m_libName

private

Definition at line 152 of file sch_altium_plugin.h.

Referenced by getLibName().

m_libSymbols

std::map<int, LIB_SYMBOL*> SCH_ALTIUM_PLUGIN::m_libSymbols

private

Definition at line 164 of file sch_altium_plugin.h.

Referenced by ParseArc(), ParseBezier(), ParseComponent(), ParseDesignator(), ParseFileHeader(), ParseImplementation(), ParseLabel(), ParseLine(), ParseParameter(), ParsePin(), ParsePolygon(), ParsePolyline(), ParseRectangle(), and ParseRoundRectangle().

m_pi

SCH_PLUGIN::SCH_PLUGIN_RELEASER SCH_ALTIUM_PLUGIN::m_pi

private

Definition at line 154 of file sch_altium_plugin.h.

Referenced by Load(), ParseFileHeader(), and ParsePowerPort().

m_powerSymbols

std::map<wxString, LIB_SYMBOL*> SCH_ALTIUM_PLUGIN::m_powerSymbols

private

Definition at line 166 of file sch_altium_plugin.h.

Referenced by ParsePowerPort().

m_properties

std::unique_ptr<PROPERTIES> SCH_ALTIUM_PLUGIN::m_properties

private

Definition at line 155 of file sch_altium_plugin.h.

Referenced by ParseFileHeader(), and ParsePowerPort().

m_reporter

REPORTER* SCH_ALTIUM_PLUGIN::m_reporter

private

Definition at line 147 of file sch_altium_plugin.h.

Referenced by ParseAltiumSch(), ParseArc(), ParseBezier(), ParseDesignator(), ParseFileHeader(), ParseFileName(), ParseImage(), ParseImplementation(), ParseLabel(), ParseLine(), ParsePin(), ParsePolygon(), ParsePolyline(), ParsePort(), ParsePowerPort(), ParseRectangle(), ParseRoundRectangle(), ParseSheetEntry(), ParseSheetName(), ParseStorage(), SCH_ALTIUM_PLUGIN(), and SetReporter().

m_rootSheet

SCH_SHEET* SCH_ALTIUM_PLUGIN::m_rootSheet

private

Definition at line 149 of file sch_altium_plugin.h.

Referenced by getLibName(), Load(), ParseDesignator(), ParseParameter(), ParsePowerPort(), ParseSheetSymbol(), and SCH_ALTIUM_PLUGIN().

m_schematic

SCHEMATIC* SCH_ALTIUM_PLUGIN::m_schematic

private

Definition at line 151 of file sch_altium_plugin.h.

Referenced by getLibFileName(), getLibName(), Load(), ParseParameter(), ParseSheetSymbol(), and SCH_ALTIUM_PLUGIN().

m_sheetOffset

wxPoint SCH_ALTIUM_PLUGIN::m_sheetOffset

private

Definition at line 160 of file sch_altium_plugin.h.

Referenced by ParseArc(), ParseBezier(), ParseBus(), ParseBusEntry(), ParseComponent(), ParseDesignator(), ParseFileName(), ParseImage(), ParseJunction(), ParseLabel(), ParseLine(), ParseNetLabel(), ParseNoERC(), ParseNote(), ParseParameter(), ParsePin(), ParsePolygon(), ParsePolyline(), ParsePort(), ParsePowerPort(), ParseRectangle(), ParseRoundRectangle(), ParseSheet(), ParseSheetName(), ParseSheetSymbol(), ParseTextFrame(), and ParseWire().

m_sheets

std::map<int, SCH_SHEET*> SCH_ALTIUM_PLUGIN::m_sheets

private

Definition at line 163 of file sch_altium_plugin.h.

Referenced by ParseFileName(), ParseSheetEntry(), ParseSheetName(), and ParseSheetSymbol().

m_symbols

std::map<int, SCH_SYMBOL*> SCH_ALTIUM_PLUGIN::m_symbols

private

Definition at line 162 of file sch_altium_plugin.h.

Referenced by ParseArc(), ParseBezier(), ParseComponent(), ParseDesignator(), ParseFileHeader(), ParseImplementation(), ParseLabel(), ParseLine(), ParseParameter(), ParsePin(), ParsePolygon(), ParsePolyline(), ParseRectangle(), and ParseRoundRectangle().

---

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

• sch_altium_plugin.h
• sch_altium_plugin.cpp