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 STRING_UTF8_MAP *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 ALTIUM_COMPOUND_FILE &aAltiumSchFile)
void	ParseAdditional (const ALTIUM_COMPOUND_FILE &aAltiumSchFile)
void	ParseFileHeader (const ALTIUM_COMPOUND_FILE &aAltiumSchFile)
virtual void	SetProgressReporter (PROGRESS_REPORTER *aReporter)
	Set an optional progress reporter. More...
virtual void	SaveLibrary (const wxString &aFileName, const STRING_UTF8_MAP *aProperties=nullptr)
virtual void	Save (const wxString &aFileName, SCH_SHEET *aSheet, SCHEMATIC *aSchematic, const STRING_UTF8_MAP *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 STRING_UTF8_MAP *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 STRING_UTF8_MAP *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 STRING_UTF8_MAP *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 STRING_UTF8_MAP *aProperties=nullptr)
	Write aSymbol to an existing library located at aLibraryPath. More...
virtual void	DeleteSymbol (const wxString &aLibraryPath, const wxString &aSymbolName, const STRING_UTF8_MAP *aProperties=nullptr)
	Delete the entire LIB_SYMBOL associated with aAliasName from the library aLibraryPath. More...
virtual void	CreateSymbolLib (const wxString &aLibraryPath, const STRING_UTF8_MAP *aProperties=nullptr)
	Create a new empty symbol library at aLibraryPath. More...
virtual bool	DeleteSymbolLib (const wxString &aLibraryPath, const STRING_UTF8_MAP *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 (STRING_UTF8_MAP *aListToAppendTo) const
	Append supported SCH_PLUGIN options to aListToAppenTo along with internationalized descriptions. More...
virtual bool	SupportsSubLibraries () const
virtual void	GetSubLibraryNames (std::vector< wxString > &aNames)
	Retrieves a list of sub-libraries in this library. More...
virtual void	GetAvailableSymbolFields (std::vector< wxString > &aNames)
	Retrieves a list of (custom) field names that are present on symbols in this library. More...
virtual void	GetDefaultSymbolFields (std::vector< wxString > &aNames)
	Retrieves a list of (custom) field names that should be shown by default for this library in the symbol chooser. More...
virtual const wxString &	GetError () const
	Return an error string to the caller. More...
virtual void	SetLibTable (SYMBOL_LIB_TABLE *aTable)
	Some library plugins need to have access to their parent library table. More...

Private Member Functions
SCH_SCREEN *	getCurrentScreen ()
SCH_SHEET *	getCurrentSheet ()
bool	IsComponentPartVisible (int aOwnerindex, int aOwnerpartdisplaymode) const
const ASCH_STORAGE_FILE *	GetFileFromStorage (const wxString &aFilename) const
void	AddTextBox (const ASCH_TEXT_FRAME *aElem)
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	ParseEllipse (const std::map< wxString, wxString > &aProperties)
void	ParseLine (const std::map< wxString, wxString > &aProperties)
void	ParseSignalHarness (const std::map< wxString, wxString > &aProperties)
void	ParseHarnessConnector (int aIndex, const std::map< wxString, wxString > &aProperties)
void	ParseHarnessEntry (const std::map< wxString, wxString > &aProperties)
void	ParseHarnessType (const std::map< wxString, wxString > &aProperties)
void	ParseHarnessPort (const ASCH_PORT &aElem)
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_PATH	m_sheetPath
SCHEMATIC *	m_schematic
wxString	m_libName
SCH_PLUGIN::SCH_PLUGIN_RELEASER	m_pi
std::unique_ptr< STRING_UTF8_MAP >	m_properties
std::unique_ptr< TITLE_BLOCK >	m_currentTitleBlock
VECTOR2I	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::vector< ASCH_ADDITIONAL_FILE >	m_altiumAdditional
std::map< int, ASCH_SYMBOL >	m_altiumComponents
std::map< int, int >	m_altiumImplementationList
std::vector< ASCH_PORT >	m_altiumPortsCurrentSheet
std::vector< ASCH_PORT >	m_altiumHarnessPortsCurrentSheet
int	m_harnessOwnerIndexOffset
int	m_harnessEntryParent

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 48 of file sch_altium_plugin.h.

Constructor & Destructor Documentation

SCH_ALTIUM_PLUGIN()

SCH_ALTIUM_PLUGIN::SCH_ALTIUM_PLUGIN

(

)

Definition at line 142 of file sch_altium_plugin.cpp.

{
 m_rootSheet = nullptr;
 m_schematic = nullptr;
 m_harnessOwnerIndexOffset = 0;
 m_harnessEntryParent = 0;
 
 m_reporter = &WXLOG_REPORTER::GetInstance();
}

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

~SCH_ALTIUM_PLUGIN()

SCH_ALTIUM_PLUGIN::~SCH_ALTIUM_PLUGIN

(

)

Definition at line 153 of file sch_altium_plugin.cpp.

{
}

Member Function Documentation

AddTextBox()

void SCH_ALTIUM_PLUGIN::AddTextBox ( const ASCH_TEXT_FRAME *  aElem )

private

Definition at line 1188 of file sch_altium_plugin.cpp.

 {
 SCH_TEXTBOX* textBox = new SCH_TEXTBOX();
 
 VECTOR2I sheetTopRight = aElem->TopRight + m_sheetOffset;
 VECTOR2I sheetBottomLeft = aElem->BottomLeft + m_sheetOffset;
 textBox->SetStart( sheetTopRight );
 textBox->SetEnd( sheetBottomLeft );
 
 textBox->SetText( aElem->Text );
 
 textBox->SetFillColor( GetColorFromInt( aElem->AreaColor ) );
 
 if( aElem->IsSolid)
 textBox->SetFillMode( FILL_T::FILLED_WITH_COLOR );
 else
 textBox->SetFilled( false );
 
 if( aElem->ShowBorder )
 textBox->SetStroke( STROKE_PARAMS( 0, PLOT_DASH_TYPE::DEFAULT,
 GetColorFromInt( aElem->BorderColor ) ) );
 else
 textBox->SetStroke( STROKE_PARAMS( -1, PLOT_DASH_TYPE::DEFAULT,
  GetColorFromInt( aElem->BorderColor ) ) );
 
 switch( aElem->Alignment )
 {
 default:
 case ASCH_TEXT_FRAME_ALIGNMENT::LEFT:
 textBox->SetHorizJustify( GR_TEXT_H_ALIGN_LEFT );
 break;
 case ASCH_TEXT_FRAME_ALIGNMENT::CENTER:
 textBox->SetHorizJustify( GR_TEXT_H_ALIGN_CENTER );
 break;
 case ASCH_TEXT_FRAME_ALIGNMENT::RIGHT:
 textBox->SetHorizJustify( GR_TEXT_H_ALIGN_RIGHT );
 break;
 }
 
 // JEY TODO: word-wrap once KiCad supports wrapped text.
 
 size_t fontId = static_cast<int>( aElem->FontID );
 
 if( m_altiumSheet && fontId > 0 && fontId <= m_altiumSheet->fonts.size() )
 {
 const ASCH_SHEET_FONT& font = m_altiumSheet->fonts.at( fontId - 1 );
 textBox->SetItalic( font.Italic );
 textBox->SetBold( font.Bold );
 textBox->SetTextSize( { font.Size / 2, font.Size / 2 } );
 //textBox->SetFont( //how to set font, we have a font mane here: ( font.fontname );
 }
 
 textBox->SetFlags( IS_NEW );
 
 SCH_SCREEN* screen = getCurrentScreen();
 wxCHECK( screen, /* void */ );
 
 screen->Append( textBox );
}

References ASCH_TEXT_FRAME::Alignment, SCH_SCREEN::Append(), ASCH_TEXT_FRAME::AreaColor, ASCH_SHEET_FONT::Bold, ASCH_TEXT_FRAME::BorderColor, ASCH_TEXT_FRAME::BottomLeft, CENTER, DEFAULT, FILLED_WITH_COLOR, ASCH_TEXT_FRAME::FontID, fonts, GetColorFromInt(), getCurrentScreen(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_H_ALIGN_LEFT, GR_TEXT_H_ALIGN_RIGHT, IS_NEW, ASCH_TEXT_FRAME::IsSolid, ASCH_SHEET_FONT::Italic, LEFT, m_altiumSheet, m_sheetOffset, RIGHT, EDA_TEXT::SetBold(), EDA_SHAPE::SetEnd(), EDA_SHAPE::SetFillColor(), EDA_SHAPE::SetFilled(), EDA_SHAPE::SetFillMode(), EDA_ITEM::SetFlags(), EDA_TEXT::SetHorizJustify(), EDA_TEXT::SetItalic(), EDA_SHAPE::SetStart(), SCH_SHAPE::SetStroke(), EDA_TEXT::SetText(), EDA_TEXT::SetTextSize(), ASCH_TEXT_FRAME::ShowBorder, ASCH_SHEET_FONT::Size, ASCH_TEXT_FRAME::Text, and ASCH_TEXT_FRAME::TopRight.

Referenced by ParseNote(), and ParseTextFrame().

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 182 of file sch_altium_plugin.cpp.

{
 // TODO
 
 return true;
}

CreateSymbolLib()

void SCH_PLUGIN::CreateSymbolLib ( const wxString &  aLibraryPath, const STRING_UTF8_MAP *  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_SEXPR_PLUGIN, and SCH_LEGACY_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().

Referenced by SYMBOL_LIB_TABLE::CreateSymbolLib(), SYMBOL_EDIT_FRAME::ExportSymbol(), Load(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), and SCH_EAGLE_PLUGIN::Load().

DeleteSymbol()

void SCH_PLUGIN::DeleteSymbol ( const wxString &  aLibraryPath, const wxString &  aSymbolName, const STRING_UTF8_MAP *  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_SEXPR_PLUGIN, and SCH_LEGACY_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_LIB_TABLE::DeleteSymbol(), and SYMBOL_LIBRARY_MANAGER::LIB_BUFFER::SaveBuffer().

DeleteSymbolLib()

bool SCH_PLUGIN::DeleteSymbolLib ( const wxString &  aLibraryPath, const STRING_UTF8_MAP *  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_SEXPR_PLUGIN, and SCH_LEGACY_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().

Referenced by SYMBOL_LIB_TABLE::DeleteSymbolLib().

EnumerateSymbolLib() [1/2]

void SCH_PLUGIN::EnumerateSymbolLib ( std::vector< LIB_SYMBOL * > &  aSymbolList, const wxString &  aLibraryPath, const STRING_UTF8_MAP *  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_DATABASE_PLUGIN, SCH_SEXPR_PLUGIN, and SCH_LEGACY_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().

EnumerateSymbolLib() [2/2]

void SCH_PLUGIN::EnumerateSymbolLib ( wxArrayString &  aSymbolNameList, const wxString &  aLibraryPath, const STRING_UTF8_MAP *  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_DATABASE_PLUGIN, SCH_SEXPR_PLUGIN, and SCH_LEGACY_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().

Referenced by PANEL_SYM_LIB_TABLE::convertLibrary(), SYMBOL_LIB_TABLE::EnumerateSymbolLib(), SYMBOL_EDIT_FRAME::ImportSymbol(), SYMBOL_LIB_TABLE::LoadSymbolLib(), and SYMBOL_LIB_TABLE_ROW::Refresh().

GetAvailableSymbolFields()

virtual void SCH_PLUGIN::GetAvailableSymbolFields ( std::vector< wxString > &  aNames )

inlinevirtualinherited

Retrieves a list of (custom) field names that are present on symbols in this library.

The plugin is responsible for guaranteeing that this list contains the set of unique custom field names present on any symbols contained in the library.

The required KiCad fields are not included in this list.

Parameters

aNames

will be filled with any custom fields present in this library.

Reimplemented in SCH_DATABASE_PLUGIN, and SCH_SEXPR_PLUGIN.

Definition at line 474 of file sch_io_mgr.h.

{}

Referenced by SYMBOL_LIB_TABLE_ROW::GetAvailableSymbolFields(), and SCH_PLUGIN::GetDefaultSymbolFields().

getCurrentScreen()

SCH_SCREEN * SCH_ALTIUM_PLUGIN::getCurrentScreen ( )

private

Definition at line 318 of file sch_altium_plugin.cpp.

{
 return m_sheetPath.LastScreen();
}

References SCH_SHEET_PATH::LastScreen(), and m_sheetPath.

Referenced by AddTextBox(), ParseAltiumSch(), ParseArc(), ParseBezier(), ParseBus(), ParseBusEntry(), ParseComponent(), ParseDesignator(), ParseEllipse(), ParseFileHeader(), ParseHarnessConnector(), ParseHarnessPort(), ParseImage(), ParseJunction(), ParseLabel(), ParseLine(), ParseNetLabel(), ParseNoERC(), ParseParameter(), ParsePolygon(), ParsePolyline(), ParsePort(), ParsePowerPort(), ParseRectangle(), ParseRoundRectangle(), ParseSheet(), ParseSheetSymbol(), ParseSignalHarness(), and ParseWire().

getCurrentSheet()

SCH_SHEET * SCH_ALTIUM_PLUGIN::getCurrentSheet ( )

private

Definition at line 324 of file sch_altium_plugin.cpp.

{
 return m_sheetPath.Last();
}

References SCH_SHEET_PATH::Last(), and m_sheetPath.

Referenced by ParseFileHeader(), ParseHarnessConnector(), and ParseSheetSymbol().

GetDefaultSymbolFields()

virtual void SCH_PLUGIN::GetDefaultSymbolFields ( std::vector< wxString > &  aNames )

inlinevirtualinherited

Retrieves a list of (custom) field names that should be shown by default for this library in the symbol chooser.

This list should be a subset of the result returned by GetAvailableSymbolFields().

The preference for which fields to hide and show for a given library is stored on a per-library basis in a user's preferences (or in the project local settings for a project- local library). The set of fields returned by GetDefaultSymbolFields() will be used if this preference is missing.

Parameters

aNames

will be filled with the custom field names that should be shown by default

Reimplemented in SCH_DATABASE_PLUGIN, and SCH_SEXPR_PLUGIN.

Definition at line 488 of file sch_io_mgr.h.

 {
 return GetAvailableSymbolFields( aNames );
 }

References SCH_PLUGIN::GetAvailableSymbolFields().

Referenced by SYMBOL_LIB_TABLE_ROW::GetDefaultSymbolFields().

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_SEXPR_PLUGIN, and SCH_LEGACY_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 KI_TEST::SCHEMATIC_TEST_FIXTURE::LoadSchematic(), SCH_EDIT_FRAME::LoadSheetFromFile(), and SCH_EDIT_FRAME::OpenProjectFiles().

GetFileExtension()

const wxString SCH_ALTIUM_PLUGIN::GetFileExtension ( ) const

overridevirtual

Return the file extension for the SCH_PLUGIN.

Implements SCH_PLUGIN.

Definition at line 164 of file sch_altium_plugin.cpp.

{
 return "SchDoc";
}

GetFileFromStorage()

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

private

Definition at line 773 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 214 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 190 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 = "noname";
 
 m_libName += "-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 170 of file sch_altium_plugin.cpp.

{
 return "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 176 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 158 of file sch_altium_plugin.cpp.

{
 return "Altium";
}

GetSubLibraryNames()

virtual void SCH_PLUGIN::GetSubLibraryNames ( std::vector< wxString > &  aNames )

inlinevirtualinherited

Retrieves a list of sub-libraries in this library.

Some types of symbol library support sub-libraries, which are a single-level organizational hierarchy that is implementation-defined per plugin. Most of KiCad ignores sub-libraries and treats the hierarchy between library and symbol as flat, but the sub-libraries are used for sorting and grouping symbols in the symbol chooser.

Has no effect if SupportsSubLibraries() returns false.

Parameters

aNames

will be filled with a list of sub-libraries within this symbol library

Reimplemented in SCH_DATABASE_PLUGIN.

Definition at line 463 of file sch_io_mgr.h.

{}

Referenced by SYMBOL_LIB_TABLE_ROW::GetSubLibraryNames().

IsComponentPartVisible()

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

private

Definition at line 762 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_DATABASE_PLUGIN, SCH_SEXPR_PLUGIN, and SCH_LEGACY_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().

Referenced by SYMBOL_LIB_TABLE::IsSymbolLibWritable(), and SYMBOL_LIB_TABLE::SaveSymbol().

Load()

SCH_SHEET * SCH_ALTIUM_PLUGIN::Load ( const wxString &  aFileName, SCHEMATIC *  aSchematic, SCH_SHEET *  aAppendToMe = nullptr, const STRING_UTF8_MAP *  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 222 of file sch_altium_plugin.cpp.

{
 wxCHECK( !aFileName.IsEmpty() && 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, "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 );
 
 // We'll update later if we find a pageNumber record for it.
 sheetpath.SetPageNumber( "#" );
 }
 
 if( !m_rootSheet->GetScreen() )
 {
 SCH_SCREEN* screen = new SCH_SCREEN( m_schematic );
 screen->SetFileName( aFileName );
 m_rootSheet->SetScreen( screen );
 const_cast<KIID&>( m_rootSheet->m_Uuid ) = screen->GetUuid();
 }
 
 SYMBOL_LIB_TABLE* libTable = m_schematic->Prj().SchSymbolLibTable();
 
 wxCHECK_MSG( libTable, nullptr, "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 = "${KIPRJMOD}/" + getLibFileName().GetFullName();
 
 // Add the new library to the project symbol library table.
 libTable->InsertRow( new SYMBOL_LIB_TABLE_ROW( getLibName(), libTableUri,
 wxString( "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_sheetPath.push_back( m_rootSheet );
 
 SCH_SCREEN* rootScreen = m_rootSheet->GetScreen();
 wxCHECK( rootScreen, nullptr );
 
 SCH_SHEET_INSTANCE sheetInstance;
 
 sheetInstance.m_Path = m_sheetPath.Path();
 sheetInstance.m_PageNumber = wxT( "#" );
 
 rootScreen->m_sheetInstances.emplace_back( sheetInstance );
 
 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_SCREENS::ClearEditFlags(), SCH_PLUGIN::CreateSymbolLib(), PROJECT::ELEM_SYMBOL_LIB_TABLE, SYMBOL_LIB_TABLE::Format(), getLibFileName(), getLibName(), PROJECT::GetProjectPath(), SCH_SHEET::GetScreen(), SYMBOL_LIB_TABLE::GetSymbolLibTableFileName(), SCH_SCREEN::GetUuid(), LIB_TABLE::HasLibrary(), LIB_TABLE::InsertRow(), SCHEMATIC::IsValid(), KiCadSchematicFileExtension, SCH_SHEET_INSTANCE::m_PageNumber, SCH_SHEET_INSTANCE::m_Path, m_pi, m_rootSheet, m_schematic, SCH_SCREEN::m_sheetInstances, m_sheetPath, EDA_ITEM::m_Uuid, ParseAltiumSch(), SCH_SHEET_PATH::Path(), SCHEMATIC::Prj(), SCH_SHEET_PATH::push_back(), SCHEMATIC::Root(), SCH_PLUGIN::SaveLibrary(), SCH_PLUGIN::SCH_PLUGIN_RELEASER::set(), PROJECT::SetElem(), SCH_SCREEN::SetFileName(), SCH_SHEET::SetFileName(), SCH_SHEET_PATH::SetPageNumber(), SCHEMATIC::SetRoot(), SCH_SHEET::SetScreen(), and SCH_SCREENS::UpdateSymbolLinks().

LoadSymbol()

LIB_SYMBOL * SCH_PLUGIN::LoadSymbol ( const wxString &  aLibraryPath, const wxString &  aPartName, const STRING_UTF8_MAP *  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_DATABASE_PLUGIN, SCH_SEXPR_PLUGIN, and SCH_LEGACY_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_EDIT_FRAME::ExportSymbol(), SYMBOL_EDIT_FRAME::ImportSymbol(), SCH_EAGLE_PLUGIN::loadInstance(), SYMBOL_LIB_TABLE::LoadSymbol(), SYMBOL_LIBRARY_MANAGER::LIB_BUFFER::SaveBuffer(), SYMBOL_LIBRARY_MANAGER::SaveLibrary(), and SYMBOL_LIB_TABLE::SaveSymbol().

ParseAdditional()

void SCH_ALTIUM_PLUGIN::ParseAdditional

(

const ALTIUM_COMPOUND_FILE &

aAltiumSchFile

)

Definition at line 431 of file sch_altium_plugin.cpp.

{
 const CFB::COMPOUND_FILE_ENTRY* file = aAltiumSchFile.FindStream( { "Additional" } );
 
 if( file == nullptr )
 return;
 
 ALTIUM_PARSER reader( aAltiumSchFile, file );
 
 
 if( reader.GetRemainingBytes() <= 0 )
 {
 THROW_IO_ERROR( "Additional section does not contain any data" );
 }
 else
 {
 std::map<wxString, wxString> properties = reader.ReadProperties();
 
 int recordId = ALTIUM_PARSER::ReadInt( properties, "RECORD", 0 );
 ALTIUM_SCH_RECORD record = static_cast<ALTIUM_SCH_RECORD>( recordId );
 
 if( record != ALTIUM_SCH_RECORD::HEADER )
 THROW_IO_ERROR( "Header expected" );
 }
 
 for( int index = 0; reader.GetRemainingBytes() > 0; index++ )
 {
 std::map<wxString, wxString> properties = reader.ReadProperties();
 
 int recordId = ALTIUM_PARSER::ReadInt( properties, "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::HARNESS_CONNECTOR:
 ParseHarnessConnector( index, properties );
 break;
 
 case ALTIUM_SCH_RECORD::HARNESS_ENTRY:
 ParseHarnessEntry( properties );
 break;
 
 case ALTIUM_SCH_RECORD::HARNESS_TYPE:
 ParseHarnessType( properties );
 break;
 
 case ALTIUM_SCH_RECORD::SIGNAL_HARNESS:
 ParseSignalHarness( properties );
 break;
 
 default:
 m_reporter->Report( wxString::Format( _( "Unknown or unexpected record ID %d found "
 "inside \"Additional\" section." ),
 recordId ),
 RPT_SEVERITY_ERROR );
 break;
 }
 }
 
 // Handle harness Ports
 for( const ASCH_PORT& port : m_altiumHarnessPortsCurrentSheet )
 ParseHarnessPort( port );
 
 if( reader.HasParsingError() )
 THROW_IO_ERROR( "stream was not parsed correctly!" );
 
 if( reader.GetRemainingBytes() != 0 )
 THROW_IO_ERROR( "stream is not fully parsed" );
}

References _, ALTIUM_COMPOUND_FILE::FindStream(), Format(), ALTIUM_PARSER::GetRemainingBytes(), HARNESS_CONNECTOR, HARNESS_ENTRY, HARNESS_TYPE, ALTIUM_PARSER::HasParsingError(), HEADER, m_altiumHarnessPortsCurrentSheet, m_reporter, ParseHarnessConnector(), ParseHarnessEntry(), ParseHarnessPort(), ParseHarnessType(), ParseSignalHarness(), ALTIUM_PARSER::ReadInt(), ALTIUM_PARSER::ReadProperties(), REPORTER::Report(), RPT_SEVERITY_ERROR, SIGNAL_HARNESS, and THROW_IO_ERROR.

Referenced by ParseAltiumSch().

ParseAltiumSch()

void SCH_ALTIUM_PLUGIN::ParseAltiumSch

(

const wxString &

aFileName

)

Definition at line 330 of file sch_altium_plugin.cpp.

{
 ALTIUM_COMPOUND_FILE altiumSchFile( aFileName );
 
 // Load path may be different from the project path.
 wxFileName parentFileName = aFileName;
 
 try
 {
 ParseStorage( altiumSchFile ); // we need this before parsing the FileHeader
 ParseFileHeader( altiumSchFile );
 
 // Parse "Additional" because sheet is set up during "FileHeader" parsing.
 ParseAdditional( altiumSchFile );
 }
 catch( CFB::CFBException& exception )
 {
 THROW_IO_ERROR( exception.what() );
 }
 
 SCH_SCREEN* currentScreen = getCurrentScreen();
 wxCHECK( currentScreen, /* void */ );
 
 // Descend the sheet hierarchy.
 for( SCH_ITEM* item : currentScreen->Items().OfType( SCH_SHEET_T ) )
 {
 SCH_SCREEN* loadedScreen = nullptr;
  SCH_SHEET* sheet = dynamic_cast<SCH_SHEET*>( item );
 
 wxCHECK2( sheet, continue );
 
 // The assumption is that all of the Altium schematic files will be in the same
 // path as the parent sheet path.
 wxFileName loadAltiumFileName( parentFileName.GetPath(), sheet->GetFileName() );
 
 m_rootSheet->SearchHierarchy( loadAltiumFileName.GetFullPath(), &loadedScreen );
 
 if( loadedScreen )
 {
 sheet->SetScreen( loadedScreen );
 // Do not need to load the sub-sheets - this has already been done.
 }
 else
 {
 sheet->SetScreen( new SCH_SCREEN( m_schematic ) );
 SCH_SCREEN* screen = sheet->GetScreen();
 sheet->SetName( loadAltiumFileName.GetName() );
 wxCHECK2( screen, continue );
 
 m_sheetPath.push_back( sheet );
 ParseAltiumSch( loadAltiumFileName.GetFullPath() );
 
 // Map the loaded Altium file to the project file.
 wxFileName projectFileName = loadAltiumFileName;
 projectFileName.SetPath( m_schematic->Prj().GetProjectPath() );
 projectFileName.SetExt( KiCadSchematicFileExtension );
 sheet->SetFileName( projectFileName.GetFullName() );
 screen->SetFileName( projectFileName.GetFullPath() );
 
 m_sheetPath.pop_back();
 }
 }
}

References getCurrentScreen(), SCH_SHEET::GetFileName(), PROJECT::GetProjectPath(), SCH_SHEET::GetScreen(), SCH_SCREEN::Items(), KiCadSchematicFileExtension, m_rootSheet, m_schematic, m_sheetPath, EE_RTREE::OfType(), ParseAdditional(), ParseAltiumSch(), ParseFileHeader(), ParseStorage(), SCH_SHEET_PATH::pop_back(), SCHEMATIC::Prj(), SCH_SHEET_PATH::push_back(), SCH_SHEET_T, SCH_SHEET::SearchHierarchy(), SCH_SCREEN::SetFileName(), SCH_SHEET::SetFileName(), SCH_SHEET::SetName(), SCH_SHEET::SetScreen(), and THROW_IO_ERROR.

Referenced by Load(), and ParseAltiumSch().

ParseArc()

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

private

Definition at line 1548 of file sch_altium_plugin.cpp.

{
 // The Arc can be ALTIUM_SCH_RECORD::ELLIPTICAL_ARC or ALTIUM_SCH_RECORD::ARC
 // Elliptical arcs are not handled in kicad. So use an arc instead
 // TODO: handle elliptical arc better.
 
 ASCH_ARC elem( aProperties );
 
 SCH_SCREEN* screen = getCurrentScreen();
 wxCHECK( screen, /* void */ );
 
 int arc_radius = elem.m_Radius;
 
 // Try to approxiammate this ellipse by an arc. use the biggest of radius and secondary radius
 // One can of course use another recipe
 if( elem.m_IsElliptical )
 arc_radius = std::max( elem.m_Radius, elem.m_SecondaryRadius );
 
 if( elem.ownerpartid == ALTIUM_COMPONENT_NONE )
 {
 if( elem.m_StartAngle == 0 && ( elem.m_EndAngle == 0 || elem.m_EndAngle == 360 ) )
 {
 SCH_SHAPE* circle = new SCH_SHAPE( SHAPE_T::CIRCLE );
 
 circle->SetPosition( elem.m_Center + m_sheetOffset );
 circle->SetEnd( circle->GetPosition() + VECTOR2I( arc_radius, 0 ) );
 circle->SetStroke( STROKE_PARAMS( elem.m_LineWidth, PLOT_DASH_TYPE::SOLID ) );
 
 screen->Append( circle );
 }
 else
 {
 SCH_SHAPE* arc = new SCH_SHAPE( SHAPE_T::ARC );
 EDA_ANGLE includedAngle( elem.m_EndAngle - elem.m_StartAngle, DEGREES_T );
 EDA_ANGLE startAngle( elem.m_EndAngle, DEGREES_T );
 VECTOR2I startOffset( KiROUND( arc_radius * startAngle.Cos() ),
 -KiROUND( arc_radius * startAngle.Sin() ) );
 
 arc->SetCenter( elem.m_Center + m_sheetOffset );
 arc->SetStart( elem.m_Center + startOffset + m_sheetOffset );
 arc->SetArcAngleAndEnd( includedAngle.Normalize(), true );
 
 arc->SetStroke( STROKE_PARAMS( elem.m_LineWidth, PLOT_DASH_TYPE::SOLID ) );
 
 screen->Append( arc );
 }
 }
 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( wxT( "Arc's owner (%d) not found." ),
 elem.ownerindex ),
 RPT_SEVERITY_DEBUG );
 return;
 }
 
 if( !IsComponentPartVisible( elem.ownerindex, elem.ownerpartdisplaymode ) )
 return;
 
 SCH_SYMBOL* symbol = m_symbols.at( libSymbolIt->first );
 
 if( elem.m_StartAngle == 0 && ( elem.m_EndAngle == 0 || elem.m_EndAngle == 360 ) )
 {
 LIB_SHAPE* circle = new LIB_SHAPE( libSymbolIt->second, SHAPE_T::CIRCLE );
 libSymbolIt->second->AddDrawItem( circle );
 
 circle->SetUnit( std::max( 0, elem.ownerpartid ) );
 
 circle->SetPosition( GetRelativePosition( elem.m_Center + m_sheetOffset, symbol ) );
 circle->SetEnd( circle->GetPosition() + VECTOR2I( arc_radius, 0 ) );
 circle->SetStroke( STROKE_PARAMS( elem.m_LineWidth, PLOT_DASH_TYPE::SOLID ) );
 }
 else
 {
 LIB_SHAPE* arc = new LIB_SHAPE( libSymbolIt->second, SHAPE_T::ARC );
 libSymbolIt->second->AddDrawItem( arc );
 arc->SetUnit( std::max( 0, elem.ownerpartid ) );
 
 arc->SetCenter( GetRelativePosition( elem.m_Center + m_sheetOffset, symbol ) );
 
 VECTOR2I arcStart( arc_radius, 0 );
 RotatePoint( arcStart, -EDA_ANGLE( elem.m_StartAngle, DEGREES_T ) );
 arcStart += arc->GetCenter();
 arc->SetStart( arcStart );
 
 VECTOR2I arcEnd( arc_radius, 0 );
 RotatePoint( arcEnd, -EDA_ANGLE( elem.m_EndAngle, DEGREES_T ) );
 arcEnd += arc->GetCenter();
 arc->SetEnd( arcEnd );
 
 arc->SetStroke( STROKE_PARAMS( elem.m_LineWidth, PLOT_DASH_TYPE::SOLID ) );
 }
 }
}

References ALTIUM_COMPONENT_NONE, SCH_SCREEN::Append(), ARC, CIRCLE, EDA_ANGLE::Cos(), DEGREES_T, Format(), LIB_SHAPE::GetCenter(), getCurrentScreen(), LIB_SHAPE::GetPosition(), SCH_SHAPE::GetPosition(), GetRelativePosition(), IsComponentPartVisible(), KiROUND(), ASCH_ARC::m_Center, ASCH_ARC::m_EndAngle, ASCH_ARC::m_IsElliptical, m_libSymbols, ASCH_ARC::m_LineWidth, ASCH_ARC::m_Radius, m_reporter, ASCH_ARC::m_SecondaryRadius, m_sheetOffset, ASCH_ARC::m_StartAngle, m_symbols, EDA_ANGLE::Normalize(), ASCH_ARC::ownerindex, ASCH_ARC::ownerpartdisplaymode, ASCH_ARC::ownerpartid, REPORTER::Report(), RotatePoint(), RPT_SEVERITY_DEBUG, EDA_SHAPE::SetArcAngleAndEnd(), EDA_SHAPE::SetCenter(), EDA_SHAPE::SetEnd(), SCH_SHAPE::SetPosition(), LIB_SHAPE::SetPosition(), EDA_SHAPE::SetStart(), LIB_SHAPE::SetStroke(), SCH_SHAPE::SetStroke(), LIB_ITEM::SetUnit(), EDA_ANGLE::Sin(), and SOLID.

Referenced by ParseFileHeader().

ParseBezier()

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

private

Definition at line 1249 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;
 }
 
 SCH_SCREEN* screen = getCurrentScreen();
 wxCHECK( screen, /* void */ );
 
 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->SetStroke( STROKE_PARAMS( elem.lineWidth, PLOT_DASH_TYPE::SOLID ) );
 
 line->SetFlags( IS_NEW );
 
 screen->Append( line );
 }
 else
 {
 // simulate Bezier using line segments
 std::vector<VECTOR2I> bezierPoints;
 std::vector<VECTOR2I> polyPoints;
 
 for( size_t j = i; j < elem.points.size() && j < i + 4; j++ )
 bezierPoints.push_back( elem.points.at( j ) );
 
 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->SetStroke( STROKE_PARAMS( elem.lineWidth, PLOT_DASH_TYPE::SOLID ) );
 
 line->SetFlags( IS_NEW );
 screen->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( wxT( "Bezier's owner (%d) not found." ),
 elem.ownerindex ),
 RPT_SEVERITY_DEBUG );
 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( std::max( 0, 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->SetStroke( STROKE_PARAMS( elem.lineWidth, PLOT_DASH_TYPE::SOLID ) );
 }
 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( std::max( 0, 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->SetStroke( STROKE_PARAMS( elem.lineWidth, PLOT_DASH_TYPE::SOLID ) );
 }
 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( std::max( 0, elem.ownerpartid ) );
 
 for( size_t j = i; j < elem.points.size() && j < i + 4; j++ )
 {
 VECTOR2I 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->SetStroke( STROKE_PARAMS( elem.lineWidth, PLOT_DASH_TYPE::SOLID ) );
 }
 }
 }
}

References _, LIB_SHAPE::AddPoint(), ALTIUM_COMPONENT_NONE, SCH_SCREEN::Append(), BEZIER, Format(), getCurrentScreen(), BEZIER_POLY::GetPoly(), GetRelativePosition(), IS_NEW, IsComponentPartVisible(), LAYER_NOTES, ASCH_BEZIER::lineWidth, 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_DEBUG, RPT_SEVERITY_WARNING, EDA_SHAPE::SetBezierC1(), EDA_SHAPE::SetBezierC2(), EDA_SHAPE::SetEnd(), SCH_LINE::SetEndPoint(), EDA_ITEM::SetFlags(), EDA_SHAPE::SetStart(), LIB_SHAPE::SetStroke(), SCH_LINE::SetStroke(), LIB_ITEM::SetUnit(), and SOLID.

Referenced by ParseFileHeader().

ParseBus()

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

private

Definition at line 2638 of file sch_altium_plugin.cpp.

{
 ASCH_BUS elem( aProperties );
 
 SCH_SCREEN* screen = getCurrentScreen();
 wxCHECK( screen, /* void */ );
 
 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 );
 screen->Append( bus );
 }
}

References SCH_SCREEN::Append(), getCurrentScreen(), IS_NEW, LAYER_BUS, ASCH_BUS::lineWidth, 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 2889 of file sch_altium_plugin.cpp.

{
 ASCH_BUS_ENTRY elem( aProperties );
 
 SCH_SCREEN* screen = getCurrentScreen();
 wxCHECK( screen, /* void */ );
 
 SCH_BUS_WIRE_ENTRY* busWireEntry = new SCH_BUS_WIRE_ENTRY( elem.location + m_sheetOffset );
 
 VECTOR2I vector = elem.corner - elem.location;
 busWireEntry->SetSize( { vector.x, vector.y } );
 
 busWireEntry->SetFlags( IS_NEW );
 screen->Append( busWireEntry );
}

References SCH_SCREEN::Append(), ASCH_BUS_ENTRY::corner, getCurrentScreen(), IS_NEW, ASCH_BUS_ENTRY::location, m_sheetOffset, EDA_ITEM::SetFlags(), SCH_BUS_ENTRY_BASE::SetSize(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by ParseFileHeader().

ParseComponent()

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

private

Definition at line 790 of file sch_altium_plugin.cpp.

{
 SCH_SHEET* currentSheet = m_sheetPath.Last();
 wxCHECK( currentSheet, /* void */ );
 
 wxString sheetName = currentSheet->GetName();
 
 if( sheetName.IsEmpty() )
 sheetName = wxT( "root" );
 
 ASCH_SYMBOL altiumSymbol( aProperties );
 
 if( m_altiumComponents.count( aIndex ) )
 {
 const ASCH_SYMBOL& currentSymbol = m_altiumComponents.at( aIndex );
 
 m_reporter->Report( wxString::Format( _( "Symbol \"%s\" in sheet \"%s\" at index %d "
 "replaced with symbol \"%s\"." ),
 currentSymbol.libreference,
 sheetName,
 aIndex,
 altiumSymbol.libreference ),
 RPT_SEVERITY_ERROR );
 }
 
 auto pair = m_altiumComponents.insert( { aIndex, altiumSymbol } );
 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( "%s_%d%s_%s",
 sheetName,
 elem.orientation,
 elem.isMirrored ? "_mirrored" : "",
 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( std::max( 0, elem.currentpartid ) );
 
 SCH_SCREEN* screen = getCurrentScreen();
 wxCHECK( screen, /* void */ );
 
 screen->Append( symbol );
 
 m_symbols.insert( { aIndex, symbol } );
}

References _, AltiumToKiCadLibID(), SCH_SCREEN::Append(), ASCH_SYMBOL::componentdescription, ASCH_SYMBOL::currentpartid, Format(), getCurrentScreen(), getLibName(), SCH_SHEET::GetName(), ASCH_SYMBOL::isMirrored, SCH_SHEET_PATH::Last(), ASCH_SYMBOL::libreference, ASCH_SYMBOL::location, m_altiumComponents, m_libSymbols, m_reporter, m_sheetOffset, m_sheetPath, m_symbols, name, ASCH_SYMBOL::orientation, REPORTER::Report(), RPT_SEVERITY_ERROR, 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 2850 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( wxT( "Designator's owner (%d) not found." ),
 elem.ownerindex ),
 RPT_SEVERITY_DEBUG );
  return;
 }
 
 SCH_SYMBOL* symbol = m_symbols.at( libSymbolIt->first );
 SCH_SHEET_PATH sheetpath;
 
 SCH_SCREEN* screen = getCurrentScreen();
 wxCHECK( screen, /* void */ );
 
 // Graphics symbols have no reference. '#GRAPHIC' allows them to not have footprint associated.
 // Note: not all unnamed imported symbols are necessarily graphics.
 bool emptyRef = elem.text.IsEmpty();
 symbol->SetRef( &m_sheetPath, emptyRef ? "#GRAPHIC" : elem.text );
 
 // I am not sure value and ref should be invisible just because emptyRef is true
 // I have examples with this criteria fully incorrect.
 bool visible = !emptyRef;
 
 symbol->GetField( VALUE_FIELD )->SetVisible( visible );
 symbol->GetField( REFERENCE_FIELD )->SetVisible( visible );
 
 SCH_FIELD* field = symbol->GetField( REFERENCE_FIELD );
 field->SetPosition( elem.location + m_sheetOffset );
 SetTextPositioning( field, elem.justification, elem.orientation );
}

References Format(), getCurrentScreen(), SCH_SYMBOL::GetField(), ASCH_DESIGNATOR::justification, ASCH_DESIGNATOR::location, m_libSymbols, m_reporter, m_sheetOffset, m_sheetPath, m_symbols, ASCH_DESIGNATOR::orientation, ASCH_DESIGNATOR::ownerindex, REFERENCE_FIELD, REPORTER::Report(), RPT_SEVERITY_DEBUG, SCH_FIELD::SetPosition(), SCH_SYMBOL::SetRef(), SetTextPositioning(), EDA_TEXT::SetVisible(), ASCH_DESIGNATOR::text, and VALUE_FIELD.

Referenced by ParseFileHeader().

ParseEllipse()

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

private

Definition at line 1648 of file sch_altium_plugin.cpp.

{
 ASCH_ELLIPSE elem( aProperties );
 
 SCH_SCREEN* screen = getCurrentScreen();
 wxCHECK( screen, /* void */ );
 
 // To do: Import true ellipses when KiCad supports them
 if( elem.Radius != elem.SecondaryRadius )
 {
 m_reporter->Report( wxString::Format( _( "Unsupported ellipse was not imported at "
 "(X = %d; Y = %d)." ),
 ( elem.Center + m_sheetOffset ).x,
 ( elem.Center + m_sheetOffset ).y ),
 RPT_SEVERITY_ERROR );
 return;
 }
 
 if( elem.OwnerPartID == ALTIUM_COMPONENT_NONE )
 {
 SCH_SHAPE* circle = new SCH_SHAPE( SHAPE_T::CIRCLE );
 
 circle->SetPosition( elem.Center + m_sheetOffset );
 circle->SetEnd( circle->GetPosition() + VECTOR2I( elem.Radius, 0 ) );
 circle->SetStroke( STROKE_PARAMS( 1, PLOT_DASH_TYPE::SOLID ) );
 
 circle->SetFillColor( GetColorFromInt( elem.AreaColor ) );
 
 if( elem.IsSolid )
 circle->SetFillMode( FILL_T::FILLED_WITH_COLOR );
 else
 circle->SetFilled( false );
 
 screen->Append( circle );
 }
 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( wxT( "Ellipse's owner (%d) not found." ),
 elem.OwnerIndex ),
 RPT_SEVERITY_DEBUG );
 return;
 }
 
 SCH_SYMBOL* symbol = m_symbols.at( libSymbolIt->first );
 
 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() + VECTOR2I( elem.Radius, 0 ) );
 circle->SetStroke( STROKE_PARAMS( 1, PLOT_DASH_TYPE::SOLID ) );
 
 circle->SetFillColor( GetColorFromInt( elem.AreaColor ) );
 
 if( elem.IsSolid )
 circle->SetFillMode( FILL_T::FILLED_WITH_COLOR );
 else
 circle->SetFilled( false );
 }
}

References _, ALTIUM_COMPONENT_NONE, SCH_SCREEN::Append(), ASCH_ELLIPSE::AreaColor, ASCH_ELLIPSE::Center, CIRCLE, FILLED_WITH_COLOR, Format(), GetColorFromInt(), getCurrentScreen(), LIB_SHAPE::GetPosition(), SCH_SHAPE::GetPosition(), GetRelativePosition(), ASCH_ELLIPSE::IsSolid, m_libSymbols, m_reporter, m_sheetOffset, m_symbols, ASCH_ELLIPSE::OwnerIndex, ASCH_ELLIPSE::OwnerPartID, ASCH_ELLIPSE::Radius, REPORTER::Report(), RPT_SEVERITY_DEBUG, RPT_SEVERITY_ERROR, ASCH_ELLIPSE::SecondaryRadius, EDA_SHAPE::SetEnd(), EDA_SHAPE::SetFillColor(), EDA_SHAPE::SetFilled(), EDA_SHAPE::SetFillMode(), SCH_SHAPE::SetPosition(), LIB_SHAPE::SetPosition(), LIB_SHAPE::SetStroke(), SCH_SHAPE::SetStroke(), LIB_ITEM::SetUnit(), and SOLID.

Referenced by ParseFileHeader().

ParseFileHeader()

void SCH_ALTIUM_PLUGIN::ParseFileHeader

(

const ALTIUM_COMPOUND_FILE &

aAltiumSchFile

)

Definition at line 503 of file sch_altium_plugin.cpp.

{
 const CFB::COMPOUND_FILE_ENTRY* file = aAltiumSchFile.FindStream( { "FileHeader" } );
 
 if( file == nullptr )
 THROW_IO_ERROR( "FileHeader not found" );
 
 ALTIUM_PARSER reader( aAltiumSchFile, file );
 
 if( reader.GetRemainingBytes() <= 0 )
 {
 THROW_IO_ERROR( "FileHeader does not contain any data" );
 }
 else
 {
 std::map<wxString, wxString> properties = reader.ReadProperties();
 
 int recordId = ALTIUM_PARSER::ReadInt( properties, "RECORD", 0 );
 ALTIUM_SCH_RECORD record = static_cast<ALTIUM_SCH_RECORD>( recordId );
 
 if( record != ALTIUM_SCH_RECORD::HEADER )
 THROW_IO_ERROR( "Header expected" );
 }
 
 // Prepare some local variables
 wxCHECK( m_altiumPortsCurrentSheet.empty(), /* void */ );
 wxCHECK( !m_currentTitleBlock, /* void */ );
 
 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, "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( "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:
 m_reporter->Report( _( "Record 'IEEE_SYMBOL' not handled." ),
 RPT_SEVERITY_INFO );
 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:
 ParseEllipse( properties );
 break;
 
 case ALTIUM_SCH_RECORD::PIECHART:
 m_reporter->Report( _( "Record 'PIECHART' not handled." ),
 RPT_SEVERITY_INFO );
 break;
 
 case ALTIUM_SCH_RECORD::ROUND_RECTANGLE:
 ParseRoundRectangle( properties );
 break;
 
 case ALTIUM_SCH_RECORD::ELLIPTICAL_ARC:
 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_226:
 break;
 
 default:
 m_reporter->Report( wxString::Format( _( "Unknown or unexpected record id %d found "
 "inside \"FileHeader\" section." ),
 recordId ),
 RPT_SEVERITY_ERROR );
 break;
 }
 
 SCH_ALTIUM_PLUGIN::m_harnessOwnerIndexOffset = index;
 }
 
 if( reader.HasParsingError() )
 THROW_IO_ERROR( "stream was not parsed correctly!" );
 
 if( reader.GetRemainingBytes() != 0 )
 THROW_IO_ERROR( "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( "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 );
 }
 
 SCH_SCREEN* screen = getCurrentScreen();
 wxCHECK( screen, /* void */ );
 
 // Handle title blocks
 screen->SetTitleBlock( *m_currentTitleBlock );
 m_currentTitleBlock.reset();
 
 // Handle Ports
 for( const ASCH_PORT& port : m_altiumPortsCurrentSheet )
 ParsePort( port );
 
 m_altiumPortsCurrentSheet.clear();
 m_altiumComponents.clear();
 m_symbols.clear();
 m_libSymbols.clear();
 
 // Otherwise we cannot save the imported sheet?
 SCH_SHEET* sheet = getCurrentSheet();
 
 wxCHECK( sheet, /* void */ );
 
 sheet->SetModified();
}

References _, ARC, BEZIER, BUS, BUS_ENTRY, COMPILE_MASK, COMPONENT, DESIGNATOR, ELLIPSE, ELLIPTICAL_ARC, FILE_NAME, ALTIUM_COMPOUND_FILE::FindStream(), Format(), getCurrentScreen(), getCurrentSheet(), getLibFileName(), ALTIUM_PARSER::GetRemainingBytes(), ALTIUM_PARSER::HasParsingError(), HEADER, IEEE_SYMBOL, IMAGE, IMPLEMENTATION, IMPLEMENTATION_LIST, JUNCTION, LABEL, LINE, m_altiumComponents, m_altiumPortsCurrentSheet, m_currentTitleBlock, m_harnessOwnerIndexOffset, m_libSymbols, m_pi, m_properties, m_reporter, m_symbols, NET_LABEL, NO_ERC, NOTE, PARAMETER, ParseArc(), ParseBezier(), ParseBus(), ParseBusEntry(), ParseComponent(), ParseDesignator(), ParseEllipse(), 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_226, RECORD_46, RECORD_47, RECORD_48, RECTANGLE, REPORTER::Report(), ROUND_RECTANGLE, RPT_SEVERITY_ERROR, RPT_SEVERITY_INFO, SCH_PLUGIN::SaveSymbol(), 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 2825 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( wxT( "Filename's owner (%d) not found." ),
 elem.ownerindex ),
 RPT_SEVERITY_DEBUG );
 return;
 }
 
 SCH_FIELD& filenameField = sheetIt->second->GetFields()[SHEETFILENAME];
 
 filenameField.SetPosition( elem.location + m_sheetOffset );
 
 // Keep the filename of the Altium file until after the file is actually loaded.
 filenameField.SetText( elem.text );
 filenameField.SetVisible( !elem.isHidden );
 SetTextPositioning( &filenameField, ASCH_LABEL_JUSTIFICATION::BOTTOM_LEFT, elem.orientation );
}

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

Referenced by ParseFileHeader().

ParseHarnessConnector()

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

private

Definition at line 1793 of file sch_altium_plugin.cpp.

{
 ASCH_HARNESS_CONNECTOR elem( aProperties );
 
 SCH_SCREEN* currentScreen = getCurrentScreen();
 wxCHECK( currentScreen, /* void */ );
 
 if( elem.OwnerPartID == ALTIUM_COMPONENT_NONE )
 {
 SCH_SHEET* sheet = new SCH_SHEET( getCurrentSheet(), elem.Location + m_sheetOffset,
 elem.Size );
 
 sheet->SetBackgroundColor( GetColorFromInt( elem.AreaColor ) );
 sheet->SetBorderColor( GetColorFromInt( elem.Color ) );
 
 currentScreen->Append( sheet );
 
 SCH_SHEET_PATH sheetpath = m_sheetPath;
 sheetpath.push_back( sheet );
 
 sheetpath.SetPageNumber( "Harness #" );
 
 m_harnessEntryParent = aIndex + m_harnessOwnerIndexOffset;
 m_sheets.insert( { m_harnessEntryParent, sheet } );
 }
 else
 {
 // I have no clue if this situation can ever exist
 m_reporter->Report( wxT( "Harness connector, belonging to the part is not currently "
 "supported." ),
 RPT_SEVERITY_DEBUG );
 }
}

References ALTIUM_COMPONENT_NONE, SCH_SCREEN::Append(), ASCH_HARNESS_CONNECTOR::AreaColor, ASCH_HARNESS_CONNECTOR::Color, GetColorFromInt(), getCurrentScreen(), getCurrentSheet(), ASCH_HARNESS_CONNECTOR::Location, m_harnessEntryParent, m_harnessOwnerIndexOffset, m_reporter, m_sheetOffset, m_sheetPath, m_sheets, ASCH_HARNESS_CONNECTOR::OwnerPartID, SCH_SHEET_PATH::push_back(), REPORTER::Report(), RPT_SEVERITY_DEBUG, SCH_SHEET::SetBackgroundColor(), SCH_SHEET::SetBorderColor(), SCH_SHEET_PATH::SetPageNumber(), and ASCH_HARNESS_CONNECTOR::Size.

Referenced by ParseAdditional().

ParseHarnessEntry()

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

private

Definition at line 1829 of file sch_altium_plugin.cpp.

{
 ASCH_HARNESS_ENTRY elem( aProperties );
 
 const auto& sheetIt = m_sheets.find( m_harnessEntryParent );
 
 if( sheetIt == m_sheets.end() )
 {
 m_reporter->Report( wxString::Format( wxT( "Harness entry's parent (%d) not found." ),
 SCH_ALTIUM_PLUGIN::m_harnessEntryParent ),
 RPT_SEVERITY_DEBUG );
 return;
 }
 
 SCH_SHEET_PIN* sheetPin = new SCH_SHEET_PIN( sheetIt->second );
 sheetIt->second->AddPin( sheetPin );
 
 sheetPin->SetText( elem.Name );
 sheetPin->SetShape( LABEL_FLAG_SHAPE::L_UNSPECIFIED );
 
 VECTOR2I 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->SetTextSpinStyle( TEXT_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->SetTextSpinStyle( TEXT_SPIN_STYLE::RIGHT );
 sheetPin->SetSide( SHEET_SIDE::RIGHT );
 break;
 case ASCH_SHEET_ENTRY_SIDE::TOP:
 sheetPin->SetPosition( { pos.x + elem.DistanceFromTop, pos.y } );
 sheetPin->SetTextSpinStyle( TEXT_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->SetTextSpinStyle( TEXT_SPIN_STYLE::BOTTOM );
 sheetPin->SetSide( SHEET_SIDE::BOTTOM );
 break;
 }
}

References BOTTOM, TEXT_SPIN_STYLE::BOTTOM, ASCH_HARNESS_ENTRY::DistanceFromTop, Format(), L_UNSPECIFIED, LEFT, TEXT_SPIN_STYLE::LEFT, m_harnessEntryParent, m_reporter, m_sheets, ASCH_HARNESS_ENTRY::Name, REPORTER::Report(), RIGHT, TEXT_SPIN_STYLE::RIGHT, RPT_SEVERITY_DEBUG, SCH_SHEET_PIN::SetPosition(), SCH_LABEL_BASE::SetShape(), SCH_SHEET_PIN::SetSide(), EDA_TEXT::SetText(), SCH_HIERLABEL::SetTextSpinStyle(), ASCH_HARNESS_ENTRY::Side, TOP, TEXT_SPIN_STYLE::UP, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by ParseAdditional().

ParseHarnessPort()

void SCH_ALTIUM_PLUGIN::ParseHarnessPort ( const ASCH_PORT &  aElem )

private

Definition at line 2381 of file sch_altium_plugin.cpp.

{
 SCH_TEXTBOX* textBox = new SCH_TEXTBOX();
 
 textBox->SetText( aElem.Name );
 textBox->SetTextColor( GetColorFromInt( aElem.TextColor ) );
 
 int height = aElem.Height;
 if( height <= 0 )
 height = schIUScale.MilsToIU( 100 ); // chose default 50 grid
 
 textBox->SetStartX( ( aElem.Location + m_sheetOffset ).x );
 textBox->SetStartY( ( aElem.Location + m_sheetOffset ).y - ( height / 2 ) );
 textBox->SetEndX( ( aElem.Location + m_sheetOffset ).x + ( aElem.Width ) );
 textBox->SetEndY( ( aElem.Location + m_sheetOffset ).y + ( height / 2 ) );
 
 textBox->SetFillColor( HARNESS_PORT_COLOR_DEFAULT_BACKGROUND );
 textBox->SetFillMode( FILL_T::FILLED_WITH_COLOR );
 
 textBox->SetStroke( STROKE_PARAMS( 2, PLOT_DASH_TYPE::DEFAULT,
 HARNESS_PORT_COLOR_DEFAULT_OUTLINE ) );
 
 switch( aElem.Alignment )
 {
 default:
 case ASCH_TEXT_FRAME_ALIGNMENT::LEFT:
 textBox->SetHorizJustify( GR_TEXT_H_ALIGN_LEFT );
 break;
 
 case ASCH_TEXT_FRAME_ALIGNMENT::CENTER:
 textBox->SetHorizJustify( GR_TEXT_H_ALIGN_CENTER );
 break;
 
 case ASCH_TEXT_FRAME_ALIGNMENT::RIGHT:
 textBox->SetHorizJustify( GR_TEXT_H_ALIGN_RIGHT );
 break;
 }
 
 size_t fontId = static_cast<int>( aElem.FontID );
 
 if( m_altiumSheet && fontId > 0 && fontId <= m_altiumSheet->fonts.size() )
 {
 const ASCH_SHEET_FONT& font = m_altiumSheet->fonts.at( fontId - 1 );
 textBox->SetItalic( font.Italic );
 textBox->SetBold( font.Bold );
 textBox->SetTextSize( { font.Size / 2, font.Size / 2 } );
 //textBox->SetFont( //how to set font, we have a font mane here: ( font.fontname );
 }
 
 textBox->SetFlags( IS_NEW );
 
 SCH_SCREEN* screen = getCurrentScreen();
 wxCHECK( screen, /* void */ );
 
 screen->Append( textBox );
 
 m_reporter->Report( wxString::Format( _( "Altium's harness port (%s) was imported as "
 "a text box. Please review the imported "
 "schematic." ),
 aElem.Name ),
 RPT_SEVERITY_WARNING );
}

References _, ASCH_PORT::Alignment, SCH_SCREEN::Append(), ASCH_SHEET_FONT::Bold, CENTER, DEFAULT, FILLED_WITH_COLOR, ASCH_PORT::FontID, fonts, Format(), GetColorFromInt(), getCurrentScreen(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_H_ALIGN_LEFT, GR_TEXT_H_ALIGN_RIGHT, HARNESS_PORT_COLOR_DEFAULT_BACKGROUND, HARNESS_PORT_COLOR_DEFAULT_OUTLINE, ASCH_PORT::Height, IS_NEW, ASCH_SHEET_FONT::Italic, LEFT, ASCH_PORT::Location, m_altiumSheet, m_reporter, m_sheetOffset, EDA_IU_SCALE::MilsToIU(), ASCH_PORT::Name, REPORTER::Report(), RIGHT, RPT_SEVERITY_WARNING, schIUScale, EDA_TEXT::SetBold(), EDA_SHAPE::SetEndX(), EDA_SHAPE::SetEndY(), EDA_SHAPE::SetFillColor(), EDA_SHAPE::SetFillMode(), EDA_ITEM::SetFlags(), EDA_TEXT::SetHorizJustify(), EDA_TEXT::SetItalic(), EDA_SHAPE::SetStartX(), EDA_SHAPE::SetStartY(), SCH_SHAPE::SetStroke(), EDA_TEXT::SetText(), EDA_TEXT::SetTextColor(), EDA_TEXT::SetTextSize(), ASCH_SHEET_FONT::Size, ASCH_PORT::TextColor, and ASCH_PORT::Width.

Referenced by ParseAdditional().

ParseHarnessType()

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

private

Definition at line 1879 of file sch_altium_plugin.cpp.

{
 ASCH_HARNESS_TYPE elem( aProperties );
 
 const auto& sheetIt = m_sheets.find( m_harnessEntryParent );
 
 if( sheetIt == m_sheets.end() )
 {
 m_reporter->Report( wxString::Format( wxT( "Harness type's parent (%d) not found." ),
 m_harnessEntryParent ),
 RPT_SEVERITY_DEBUG );
 return;
 }
 
 SCH_FIELD& sheetNameField = sheetIt->second->GetFields()[SHEETNAME];
 
 sheetNameField.SetPosition( elem.Location + m_sheetOffset );
 sheetNameField.SetText( elem.Text );
 
 // Always set as visible so user is aware about ( !elem.isHidden );
 sheetNameField.SetVisible( true );
 SetTextPositioning( &sheetNameField, ASCH_LABEL_JUSTIFICATION::BOTTOM_LEFT,
 ASCH_RECORD_ORIENTATION::RIGHTWARDS );
 sheetNameField.SetTextColor( GetColorFromInt( elem.Color ) );
 
 m_reporter->Report( wxString::Format( _( "Altium's harness connector (%s) was imported as a "
 "hierarchical sheet. Please review the imported "
 "schematic." ),
 elem.Text ),
 RPT_SEVERITY_WARNING );
}

References _, BOTTOM_LEFT, ASCH_HARNESS_TYPE::Color, Format(), GetColorFromInt(), ASCH_HARNESS_TYPE::Location, m_harnessEntryParent, m_reporter, m_sheetOffset, m_sheets, REPORTER::Report(), RIGHTWARDS, RPT_SEVERITY_DEBUG, RPT_SEVERITY_WARNING, SCH_FIELD::SetPosition(), EDA_TEXT::SetText(), EDA_TEXT::SetTextColor(), SetTextPositioning(), EDA_TEXT::SetVisible(), SHEETNAME, and ASCH_HARNESS_TYPE::Text.

Referenced by ParseAdditional().

ParseImage()

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

private

Definition at line 2692 of file sch_altium_plugin.cpp.

{
 ASCH_IMAGE elem( aProperties );
 
 VECTOR2I center = ( elem.location + elem.corner ) / 2 + m_sheetOffset;
 std::unique_ptr<SCH_BITMAP> bitmap = std::make_unique<SCH_BITMAP>( center );
 
 SCH_SCREEN* screen = getCurrentScreen();
 wxCHECK( screen, /* void */ );
 
 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( "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
 VECTOR2I currentImageSize = bitmap->GetSize();
 VECTOR2I 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 );
 screen->Append( bitmap.release() );
}

References _, std::abs(), SCH_SCREEN::Append(), ASCH_IMAGE::corner, ASCH_STORAGE_FILE::data, ASCH_IMAGE::embedimage, ASCH_IMAGE::filename, Format(), getCurrentScreen(), GetFileFromStorage(), IS_NEW, ASCH_IMAGE::location, m_reporter, m_sheetOffset, REPORTER::Report(), RPT_SEVERITY_ERROR, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by ParseFileHeader().

ParseImplementation()

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

private

Definition at line 3010 of file sch_altium_plugin.cpp.

{
 ASCH_IMPLEMENTATION elem( aProperties );
 
 // Only get footprint, currently assigned only
 if( ( elem.type == "PCBLIB" ) && ( elem.isCurrent ) )
 {
 const auto& implementationOwnerIt = m_altiumImplementationList.find( elem.ownerindex );
 
 if( implementationOwnerIt == m_altiumImplementationList.end() )
 {
 m_reporter->Report( wxString::Format( wxT( "Implementation's owner (%d) not found." ),
 elem.ownerindex ),
 RPT_SEVERITY_DEBUG );
 return;
 }
 
 const auto& libSymbolIt = m_libSymbols.find( implementationOwnerIt->second );
 
 if( libSymbolIt == m_libSymbols.end() )
 {
 m_reporter->Report( wxString::Format( wxT( "Footprint's owner (%d) not found." ),
 implementationOwnerIt->second ),
 RPT_SEVERITY_DEBUG );
 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->SetFootprintFieldText( 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_DEBUG, SCH_SYMBOL::SetFootprintFieldText(), 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 3001 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 2678 of file sch_altium_plugin.cpp.

{
 ASCH_JUNCTION elem( aProperties );
 
 SCH_JUNCTION* junction = new SCH_JUNCTION( elem.location + m_sheetOffset );
 
 SCH_SCREEN* screen = getCurrentScreen();
 wxCHECK( screen, /* void */ );
 
 junction->SetFlags( IS_NEW );
 screen->Append( junction );
}

References SCH_SCREEN::Append(), getCurrentScreen(), IS_NEW, ASCH_JUNCTION::location, 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 1095 of file sch_altium_plugin.cpp.

{
 ASCH_LABEL elem( aProperties );
 
 if( elem.ownerpartid == ALTIUM_COMPONENT_NONE )
 {
 std::map<wxString, wxString> variableMap = {
 { "APPLICATION_BUILDNUMBER", "KICAD_VERSION" },
 { "SHEETNUMBER", "#" },
 { "SHEETTOTAL", "##" },
 { "TITLE", "TITLE" }, // 1:1 maps are sort of useless, but it makes it
 { "REVISION", "REVISION" }, // easier to see that the list is complete
 { "DATE", "ISSUE_DATE" },
 { "CURRENTDATE", "CURRENT_DATE" },
 { "COMPANYNAME", "COMPANY" },
 { "DOCUMENTNAME", "FILENAME" },
 { "PROJECTNAME", "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 );
 
 SCH_SCREEN* screen = getCurrentScreen();
 wxCHECK( screen, /* void */ );
 
 screen->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( wxT( "Label's owner (%d) not found." ),
 elem.ownerindex ),
 RPT_SEVERITY_DEBUG );
 return;
 }
 
 SCH_SYMBOL* symbol = m_symbols.at( libSymbolIt->first );
 LIB_TEXT* textItem = new LIB_TEXT( libSymbolIt->second );
 libSymbolIt->second->AddDrawItem( textItem );
 
 textItem->SetUnit( std::max( 0, 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(), getCurrentScreen(), GetRelativePosition(), IS_NEW, ASCH_SHEET_FONT::Italic, ASCH_LABEL::justification, ASCH_LABEL::location, m_altiumSheet, m_libSymbols, m_reporter, m_sheetOffset, m_symbols, ASCH_LABEL::orientation, ASCH_LABEL::ownerindex, ASCH_LABEL::ownerpartid, REPORTER::Report(), RPT_SEVERITY_DEBUG, 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 1717 of file sch_altium_plugin.cpp.

{
 ASCH_LINE elem( aProperties );
 
 SCH_SCREEN* screen = getCurrentScreen();
 wxCHECK( screen, /* void */ );
 
 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->SetStroke( STROKE_PARAMS( elem.lineWidth, PLOT_DASH_TYPE::SOLID ) ); // TODO?
 
 line->SetFlags( IS_NEW );
 screen->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( wxT( "Line's owner (%d) not found." ),
 elem.ownerindex ),
 RPT_SEVERITY_DEBUG );
 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( std::max( 0, elem.ownerpartid ) );
 
 line->AddPoint( GetRelativePosition( elem.point1 + m_sheetOffset, symbol ) );
 line->AddPoint( GetRelativePosition( elem.point2 + m_sheetOffset, symbol ) );
 
 line->SetStroke( STROKE_PARAMS( elem.lineWidth, PLOT_DASH_TYPE::SOLID ) );
 }
}

References LIB_SHAPE::AddPoint(), ALTIUM_COMPONENT_NONE, SCH_SCREEN::Append(), Format(), getCurrentScreen(), GetRelativePosition(), IS_NEW, IsComponentPartVisible(), LAYER_NOTES, ASCH_LINE::lineWidth, 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_DEBUG, SCH_LINE::SetEndPoint(), EDA_ITEM::SetFlags(), LIB_SHAPE::SetStroke(), SCH_LINE::SetStroke(), LIB_ITEM::SetUnit(), and SOLID.

Referenced by ParseFileHeader().

ParseNetLabel()

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

private

Definition at line 2602 of file sch_altium_plugin.cpp.

{
 ASCH_NET_LABEL elem( aProperties );
 
 SCH_LABEL* label = new SCH_LABEL( elem.location + m_sheetOffset, elem.text );
 
 SCH_SCREEN* screen = getCurrentScreen();
 wxCHECK( screen, /* void */ );
 
 switch( elem.orientation )
 {
 case ASCH_RECORD_ORIENTATION::RIGHTWARDS:
 label->SetTextSpinStyle( TEXT_SPIN_STYLE::RIGHT );
 break;
 
 case ASCH_RECORD_ORIENTATION::UPWARDS:
 label->SetTextSpinStyle( TEXT_SPIN_STYLE::UP );
 break;
 
 case ASCH_RECORD_ORIENTATION::LEFTWARDS:
 label->SetTextSpinStyle( TEXT_SPIN_STYLE::LEFT );
 break;
 
 case ASCH_RECORD_ORIENTATION::DOWNWARDS:
 label->SetTextSpinStyle( TEXT_SPIN_STYLE::BOTTOM );
 break;
 
 default:
 break;
 }
 
 label->SetFlags( IS_NEW );
 screen->Append( label );
}

References SCH_SCREEN::Append(), TEXT_SPIN_STYLE::BOTTOM, DOWNWARDS, getCurrentScreen(), IS_NEW, TEXT_SPIN_STYLE::LEFT, LEFTWARDS, ASCH_NET_LABEL::location, m_sheetOffset, ASCH_NET_LABEL::orientation, TEXT_SPIN_STYLE::RIGHT, RIGHTWARDS, EDA_ITEM::SetFlags(), SCH_TEXT::SetTextSpinStyle(), ASCH_NET_LABEL::text, TEXT_SPIN_STYLE::UP, and UPWARDS.

Referenced by ParseFileHeader().

ParseNoERC()

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

private

Definition at line 2585 of file sch_altium_plugin.cpp.

{
 ASCH_NO_ERC elem( aProperties );
 
 SCH_SCREEN* screen = getCurrentScreen();
 wxCHECK( screen, /* void */ );
 
 if( elem.isActive )
 {
 SCH_NO_CONNECT* noConnect = new SCH_NO_CONNECT( elem.location + m_sheetOffset );
 
 noConnect->SetFlags( IS_NEW );
 screen->Append( noConnect );
 }
}

References SCH_SCREEN::Append(), getCurrentScreen(), IS_NEW, ASCH_NO_ERC::isActive, ASCH_NO_ERC::location, 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 1179 of file sch_altium_plugin.cpp.

 {
 ASCH_NOTE elem( aProperties );
 AddTextBox( static_cast<ASCH_TEXT_FRAME*>( &elem ) );
 
 // TODO: need some sort of property system for storing author....
}

References AddTextBox().

Referenced by ParseFileHeader().

ParseParameter()

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

private

Definition at line 2906 of file sch_altium_plugin.cpp.

{
 ASCH_PARAMETER elem( aProperties );
 
 SCH_SCREEN* screen = getCurrentScreen();
 wxCHECK( screen, /* void */ );
 
 // TODO: fill in replacements from variant, sheet and project
 std::map<wxString, wxString> variableMap = {
 { "COMMENT", "VALUE" },
 { "VALUE", "ALTIUM_VALUE" },
 };
 
 if( elem.ownerindex <= 0 && elem.ownerpartid == ALTIUM_COMPONENT_NONE )
 {
 // This is some sheet parameter
 if( elem.text == "*" )
 return; // indicates parameter not set?
 
 wxString paramName = elem.name.Upper();
 
 if( paramName == "SHEETNUMBER" )
 {
 m_sheetPath.SetPageNumber( elem.text );
 }
 else if( paramName == "TITLE" )
 {
 m_currentTitleBlock->SetTitle( elem.text );
 }
 else if( paramName == "REVISION" )
 {
 m_currentTitleBlock->SetRevision( elem.text );
 }
 else if( paramName == "DATE" )
 {
 m_currentTitleBlock->SetDate( elem.text );
 }
 else if( paramName == "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;
 wxString upperName = elem.name.Upper();
 
 if( upperName == "COMMENT" )
 {
 field = symbol->GetField( VALUE_FIELD );
 }
 else
 {
 int fieldIdx = symbol->GetFieldCount();
 wxString fieldName = elem.name.Upper();
 
 if( fieldName.IsEmpty() )
 {
 int disambiguate = 1;
 
 do
 {
 fieldName = wxString::Format( "ALTIUM_UNNAMED_%d", disambiguate++ );
 } while( !symbol->GetFieldText( fieldName ).IsEmpty() );
 }
 else if( fieldName == "VALUE" )
 {
 fieldName = "ALTIUM_VALUE";
 }
 
 field = symbol->AddField( SCH_FIELD( VECTOR2I(), 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(), Format(), getCurrentScreen(), SCH_SYMBOL::GetField(), SCH_SYMBOL::GetFieldCount(), SCH_SYMBOL::GetFieldText(), PROJECT::GetTextVars(), ASCH_PARAMETER::isHidden, ASCH_PARAMETER::justification, ASCH_PARAMETER::location, m_currentTitleBlock, m_libSymbols, m_schematic, m_sheetOffset, m_sheetPath, m_symbols, ASCH_PARAMETER::name, ASCH_PARAMETER::orientation, ASCH_PARAMETER::ownerindex, ASCH_PARAMETER::ownerpartid, SCHEMATIC::Prj(), SCH_SHEET_PATH::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 852 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( wxT( "Pin's owner (%d) not found." ),
 elem.ownerindex ),
 RPT_SEVERITY_DEBUG );
 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( std::max( 0, 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 );
 
 VECTOR2I 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_DEBUG, RPT_SEVERITY_WARNING, ASCH_PIN::showDesignator, ASCH_PIN::showPinName, ASCH_PIN::symbolInnerEdge, ASCH_PIN::symbolOuterEdge, TRISTATE, UNKNOWN, UPWARDS, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by ParseFileHeader().

ParsePolygon()

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

private

Definition at line 1444 of file sch_altium_plugin.cpp.

{
 ASCH_POLYGON elem( aProperties );
 
 SCH_SCREEN* screen = getCurrentScreen();
 wxCHECK( screen, /* void */ );
 
 if( elem.OwnerPartID == ALTIUM_COMPONENT_NONE )
 {
 SCH_SHAPE* poly = new SCH_SHAPE( SHAPE_T::POLY );
 
 for( VECTOR2I& point : elem.points )
 poly->AddPoint( point + m_sheetOffset );
 poly->AddPoint( elem.points.front() + m_sheetOffset );
 
 SetSchShapeFillAndColor( elem, poly );
 poly->SetFlags( IS_NEW );
 
 screen->Append( poly );
 }
 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( wxT( "Polygon's owner (%d) not found." ),
 elem.OwnerIndex ),
 RPT_SEVERITY_DEBUG );
 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( VECTOR2I& point : elem.points )
 line->AddPoint( GetRelativePosition( point + m_sheetOffset, symbol ) );
 
 line->AddPoint( GetRelativePosition( elem.points.front() + m_sheetOffset, symbol ) );
 SetLibShapeFillAndColor( elem, line );
 }
}

References LIB_SHAPE::AddPoint(), SCH_SHAPE::AddPoint(), ALTIUM_COMPONENT_NONE, SCH_SCREEN::Append(), Format(), getCurrentScreen(), GetRelativePosition(), IS_NEW, IsComponentPartVisible(), m_libSymbols, m_reporter, m_sheetOffset, m_symbols, ASCH_SHAPE_INTERFACE::OwnerIndex, ASCH_SHAPE_INTERFACE::OwnerPartDisplayMode, ASCH_SHAPE_INTERFACE::OwnerPartID, ASCH_POLYGON::points, POLY, REPORTER::Report(), RPT_SEVERITY_DEBUG, EDA_ITEM::SetFlags(), SetLibShapeFillAndColor(), SetSchShapeFillAndColor(), and LIB_ITEM::SetUnit().

Referenced by ParseFileHeader().

ParsePolyline()

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

private

Definition at line 1393 of file sch_altium_plugin.cpp.

{
 ASCH_POLYLINE elem( aProperties );
 
 SCH_SCREEN* screen = getCurrentScreen();
 wxCHECK( screen, /* void */ );
 
 if( elem.OwnerPartID == ALTIUM_COMPONENT_NONE )
 {
 SCH_SHAPE* poly = new SCH_SHAPE( SHAPE_T::POLY );
 
 for( VECTOR2I& point : elem.Points )
 poly->AddPoint( point + m_sheetOffset );
 
 poly->SetStroke( STROKE_PARAMS( elem.LineWidth, GetPlotDashType( elem.LineStyle ),
 GetColorFromInt( elem.Color ) ) );
 poly->SetFlags( IS_NEW );
 
 screen->Append( poly );
 }
 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( wxT( "Polyline's owner (%d) not found." ),
 elem.OwnerIndex ),
 RPT_SEVERITY_DEBUG );
 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( VECTOR2I& point : elem.Points )
 line->AddPoint( GetRelativePosition( point + m_sheetOffset, symbol ) );
 
 line->SetStroke( STROKE_PARAMS( elem.LineWidth, GetPlotDashType( elem.LineStyle ),
 GetColorFromInt( elem.Color ) ) );
 }
}

References LIB_SHAPE::AddPoint(), SCH_SHAPE::AddPoint(), ALTIUM_COMPONENT_NONE, SCH_SCREEN::Append(), ASCH_POLYLINE::Color, Format(), GetColorFromInt(), getCurrentScreen(), GetPlotDashType(), GetRelativePosition(), IS_NEW, IsComponentPartVisible(), ASCH_POLYLINE::LineStyle, ASCH_POLYLINE::LineWidth, 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_DEBUG, EDA_ITEM::SetFlags(), LIB_SHAPE::SetStroke(), SCH_SHAPE::SetStroke(), and LIB_ITEM::SetUnit().

Referenced by ParseFileHeader().

ParsePort()

void SCH_ALTIUM_PLUGIN::ParsePort ( const ASCH_PORT &  aElem )

private

Definition at line 2445 of file sch_altium_plugin.cpp.

{
 if( !aElem.HarnessType.IsEmpty() )
 {
 // Parse harness ports after "Additional" compound section is parsed
 m_altiumHarnessPortsCurrentSheet.emplace_back( aElem );
 return;
 }
 
 VECTOR2I start = aElem.Location + m_sheetOffset;
 VECTOR2I 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 = getCurrentScreen();
 wxCHECK( screen, /* void */ );
 
 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( !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.
 VECTOR2I position = ( startIsWireTerminal || startIsBusTerminal ) ? start : end;
 SCH_LABEL_BASE* label;
 
 // TODO: detect correct label type depending on sheet settings, etc.
 #if 1 // Set to 1 to use SCH_HIERLABEL label, 0 to use SCH_GLOBALLABEL
 {
 label = new SCH_HIERLABEL( position, aElem.Name );
 }
 #else
 label = new SCH_GLOBALLABEL( position, aElem.Name );
 #endif
 
 switch( aElem.IOtype )
 {
 default:
 case ASCH_PORT_IOTYPE::UNSPECIFIED:
 label->SetShape( LABEL_FLAG_SHAPE::L_UNSPECIFIED );
 break;
 
 case ASCH_PORT_IOTYPE::OUTPUT:
 label->SetShape( LABEL_FLAG_SHAPE::L_OUTPUT );
 break;
 
 case ASCH_PORT_IOTYPE::INPUT:
 label->SetShape( LABEL_FLAG_SHAPE::L_INPUT );
 break;
 
 case ASCH_PORT_IOTYPE::BIDI:
 label->SetShape( LABEL_FLAG_SHAPE::L_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->SetTextSpinStyle( TEXT_SPIN_STYLE::RIGHT );
 else
 label->SetTextSpinStyle( TEXT_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->SetTextSpinStyle( TEXT_SPIN_STYLE::UP );
 else
 label->SetTextSpinStyle( TEXT_SPIN_STYLE::BOTTOM );
 break;
 }
 
 label->AutoplaceFields( screen, false );
 
 // Default "Sheet References" field should be hidden, at least for now
 if( label->GetFields().size() > 0 )
 label->GetFields()[0].SetVisible( false );
 
 label->SetFlags( IS_NEW );
 
 screen->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( schIUScale.MilsToIU( 2 ) );
 wire->SetFlags( IS_NEW );
 screen->Append( wire );
 }
 else if( startIsBusTerminal && endIsBusTerminal )
 {
 SCH_LINE* wire = new SCH_LINE( start, SCH_LAYER_ID::LAYER_BUS );
 wire->SetEndPoint( end );
 wire->SetLineWidth( schIUScale.MilsToIU( 2 ) );
 wire->SetFlags( IS_NEW );
 screen->Append( wire );
 }
}

References _, SCH_SCREEN::Append(), SCH_LABEL_BASE::AutoplaceFields(), BIDI, BOTTOM, TEXT_SPIN_STYLE::BOTTOM, Format(), getCurrentScreen(), SCH_LABEL_BASE::GetFields(), ASCH_PORT::HarnessType, INPUT, ASCH_PORT::IOtype, IS_NEW, SCH_SCREEN::IsTerminalPoint(), L_BIDI, L_INPUT, L_OUTPUT, L_UNSPECIFIED, LAYER_BUS, LAYER_WIRE, LEFT, TEXT_SPIN_STYLE::LEFT, LEFT_RIGHT, ASCH_PORT::Location, m_altiumHarnessPortsCurrentSheet, m_reporter, m_sheetOffset, EDA_IU_SCALE::MilsToIU(), ASCH_PORT::Name, NONE_HORIZONTAL, NONE_VERTICAL, OUTPUT, REPORTER::Report(), RIGHT, TEXT_SPIN_STYLE::RIGHT, RPT_SEVERITY_WARNING, schIUScale, SCH_LINE::SetEndPoint(), EDA_ITEM::SetFlags(), SCH_LINE::SetLineWidth(), SCH_LABEL_BASE::SetShape(), SCH_TEXT::SetTextSpinStyle(), ASCH_PORT::Style, TOP, TOP_BOTTOM, UNSPECIFIED, TEXT_SPIN_STYLE::UP, ASCH_PORT::Width, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by ParseFileHeader().

ParsePowerPort()

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

private

Definition at line 2281 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( "#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( "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 );
 
 VECTOR2I 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_SCREEN* screen = getCurrentScreen();
 wxCHECK( screen, /* void */ );
 
 // each symbol has its own powerSymbolIt for now
 SCH_SYMBOL* symbol = new SCH_SYMBOL();
 symbol->SetRef( &m_sheetPath, "#PWR?" );
 symbol->SetValueFieldText( 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( ANGLE_VERTICAL );
 valueField->SetHorizJustify( GR_TEXT_H_ALIGN_RIGHT );
 break;
 
 case ASCH_RECORD_ORIENTATION::UPWARDS:
 symbol->SetOrientation( SYMBOL_ORIENTATION_T::SYM_ORIENT_180 );
 valueField->SetTextAngle( ANGLE_HORIZONTAL );
 valueField->SetHorizJustify( GR_TEXT_H_ALIGN_CENTER );
 break;
 
 case ASCH_RECORD_ORIENTATION::LEFTWARDS:
 symbol->SetOrientation( SYMBOL_ORIENTATION_T::SYM_ORIENT_270 );
 valueField->SetTextAngle( ANGLE_VERTICAL );
 valueField->SetHorizJustify( GR_TEXT_H_ALIGN_RIGHT );
 break;
 
 case ASCH_RECORD_ORIENTATION::DOWNWARDS:
 symbol->SetOrientation( SYMBOL_ORIENTATION_T::SYM_ORIENT_0 );
 valueField->SetTextAngle( ANGLE_HORIZONTAL );
 valueField->SetHorizJustify( GR_TEXT_H_ALIGN_CENTER );
 break;
 
 default:
 m_reporter->Report( _( "Pin has unexpected orientation." ), RPT_SEVERITY_WARNING );
 break;
 }
 
 screen->Append( symbol );
}

References _, LIB_SYMBOL::AddDrawItem(), AltiumToKiCadLibID(), ANGLE_HORIZONTAL, ANGLE_VERTICAL, SCH_SCREEN::Append(), DOWNWARDS, Format(), getCurrentScreen(), SCH_SYMBOL::GetField(), getLibFileName(), getLibName(), LIB_FIELD::GetPosition(), LIB_SYMBOL::GetReferenceField(), LIB_SYMBOL::GetValueField(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_H_ALIGN_RIGHT, HelperGeneratePowerPortGraphics(), LEFTWARDS, ASCH_POWER_PORT::location, m_pi, m_powerSymbols, m_properties, m_reporter, m_sheetOffset, m_sheetPath, ASCH_POWER_PORT::orientation, pin, PT_POWER_IN, REPORTER::Report(), RIGHTWARDS, RPT_SEVERITY_WARNING, SCH_PLUGIN::SaveSymbol(), LIB_SYMBOL::SetDescription(), EDA_TEXT::SetHorizJustify(), LIB_SYMBOL::SetKeyWords(), LIB_SYMBOL::SetLibId(), SCH_SYMBOL::SetLibId(), SCH_SYMBOL::SetLibSymbol(), LIB_SYMBOL::SetName(), SCH_SYMBOL::SetOrientation(), LIB_ITEM::SetPosition(), SCH_FIELD::SetPosition(), SCH_SYMBOL::SetPosition(), LIB_SYMBOL::SetPower(), SCH_SYMBOL::SetRef(), EDA_TEXT::SetText(), EDA_TEXT::SetTextAngle(), SCH_SYMBOL::SetValueFieldText(), 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, UPWARDS, and VALUE_FIELD.

Referenced by ParseFileHeader().

ParseRectangle()

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

private

Definition at line 1912 of file sch_altium_plugin.cpp.

{
 ASCH_RECTANGLE elem( aProperties );
 
 VECTOR2I sheetTopRight = elem.TopRight + m_sheetOffset;
 VECTOR2I sheetBottomLeft = elem.BottomLeft + m_sheetOffset;
 
 SCH_SCREEN* screen = getCurrentScreen();
 wxCHECK( screen, /* void */ );
 
 if( elem.OwnerPartID == ALTIUM_COMPONENT_NONE )
 {
 SCH_SHAPE* rect = new SCH_SHAPE( SHAPE_T::RECT );
 
 rect->SetPosition( sheetTopRight );
 rect->SetEnd( sheetBottomLeft );
 SetSchShapeFillAndColor( elem, rect );
 rect->SetFlags( IS_NEW );
 
 screen->Append( rect );
 }
 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( wxT( "Rectangle's owner (%d) not found." ),
 elem.OwnerIndex ),
 RPT_SEVERITY_DEBUG );
 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 ) );
 SetLibShapeFillAndColor( elem, rect );
 }
}

References ALTIUM_COMPONENT_NONE, SCH_SCREEN::Append(), ASCH_RECTANGLE::BottomLeft, Format(), getCurrentScreen(), GetRelativePosition(), IS_NEW, IsComponentPartVisible(), m_libSymbols, m_reporter, m_sheetOffset, m_symbols, ASCH_SHAPE_INTERFACE::OwnerIndex, ASCH_SHAPE_INTERFACE::OwnerPartDisplayMode, ASCH_SHAPE_INTERFACE::OwnerPartID, RECT, REPORTER::Report(), RPT_SEVERITY_DEBUG, EDA_SHAPE::SetEnd(), EDA_ITEM::SetFlags(), SetLibShapeFillAndColor(), SCH_SHAPE::SetPosition(), LIB_SHAPE::SetPosition(), SetSchShapeFillAndColor(), LIB_ITEM::SetUnit(), and ASCH_RECTANGLE::TopRight.

Referenced by ParseFileHeader().

ParseRoundRectangle()

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

private

Definition at line 1495 of file sch_altium_plugin.cpp.

{
 ASCH_ROUND_RECTANGLE elem( aProperties );
 
 VECTOR2I sheetTopRight = elem.TopRight + m_sheetOffset;
 VECTOR2I sheetBottomLeft = elem.BottomLeft + m_sheetOffset;
 
 SCH_SCREEN* screen = getCurrentScreen();
 wxCHECK( screen, /* void */ );
 
 if( elem.OwnerPartID == ALTIUM_COMPONENT_NONE )
 {
 // TODO: misses rounded edges
 SCH_SHAPE* rect = new SCH_SHAPE( SHAPE_T::RECT );
 
 rect->SetPosition( sheetTopRight );
 rect->SetEnd( sheetBottomLeft );
 SetSchShapeFillAndColor( elem, rect );
 rect->SetFlags( IS_NEW );
 
 screen->Append( rect );
 }
 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( wxT( "Rounded rectangle's owner (%d) not "
 "found." ),
 elem.OwnerIndex ),
 RPT_SEVERITY_DEBUG );
 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 ) );
 SetLibShapeFillAndColor( elem, rect );
 }
}

References ALTIUM_COMPONENT_NONE, SCH_SCREEN::Append(), ASCH_ROUND_RECTANGLE::BottomLeft, Format(), getCurrentScreen(), GetRelativePosition(), IS_NEW, IsComponentPartVisible(), m_libSymbols, m_reporter, m_sheetOffset, m_symbols, ASCH_SHAPE_INTERFACE::OwnerIndex, ASCH_SHAPE_INTERFACE::OwnerPartDisplayMode, ASCH_SHAPE_INTERFACE::OwnerPartID, RECT, REPORTER::Report(), RPT_SEVERITY_DEBUG, EDA_SHAPE::SetEnd(), EDA_ITEM::SetFlags(), SetLibShapeFillAndColor(), SCH_SHAPE::SetPosition(), LIB_SHAPE::SetPosition(), SetSchShapeFillAndColor(), LIB_ITEM::SetUnit(), and ASCH_ROUND_RECTANGLE::TopRight.

Referenced by ParseFileHeader().

ParseSheet()

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

private

Definition at line 2762 of file sch_altium_plugin.cpp.

{
 m_altiumSheet = std::make_unique<ASCH_SHEET>( aProperties );
 
 SCH_SCREEN* screen = getCurrentScreen();
 wxCHECK( screen, /* void */ );
 
 PAGE_INFO pageInfo;
 
 bool isPortrait = m_altiumSheet->sheetOrientation == ASCH_SHEET_WORKSPACEORIENTATION::PORTRAIT;
 
 switch( m_altiumSheet->sheetSize )
 {
 default:
 case ASCH_SHEET_SIZE::A4: pageInfo.SetType( "A4", isPortrait ); break;
 case ASCH_SHEET_SIZE::A3: pageInfo.SetType( "A3", isPortrait ); break;
 case ASCH_SHEET_SIZE::A2: pageInfo.SetType( "A2", isPortrait ); break;
 case ASCH_SHEET_SIZE::A1: pageInfo.SetType( "A1", isPortrait ); break;
 case ASCH_SHEET_SIZE::A0: pageInfo.SetType( "A0", isPortrait ); break;
 case ASCH_SHEET_SIZE::A: pageInfo.SetType( "A", isPortrait ); break;
 case ASCH_SHEET_SIZE::B: pageInfo.SetType( "B", isPortrait ); break;
 case ASCH_SHEET_SIZE::C: pageInfo.SetType( "C", isPortrait ); break;
 case ASCH_SHEET_SIZE::D: pageInfo.SetType( "D", isPortrait ); break;
 case ASCH_SHEET_SIZE::E: pageInfo.SetType( "E", isPortrait ); break;
 case ASCH_SHEET_SIZE::LETTER: pageInfo.SetType( "USLetter", isPortrait ); break;
 case ASCH_SHEET_SIZE::LEGAL: pageInfo.SetType( "USLegal", isPortrait ); break;
 case ASCH_SHEET_SIZE::TABLOID: pageInfo.SetType( "A3", isPortrait ); break;
 case ASCH_SHEET_SIZE::ORCAD_A: pageInfo.SetType( "A", isPortrait ); break;
 case ASCH_SHEET_SIZE::ORCAD_B: pageInfo.SetType( "B", isPortrait ); break;
 case ASCH_SHEET_SIZE::ORCAD_C: pageInfo.SetType( "C", isPortrait ); break;
 case ASCH_SHEET_SIZE::ORCAD_D: pageInfo.SetType( "D", isPortrait ); break;
 case ASCH_SHEET_SIZE::ORCAD_E: pageInfo.SetType( "E", isPortrait ); break;
 }
 
 screen->SetPageSettings( pageInfo );
 
 m_sheetOffset = { 0, pageInfo.GetHeightIU( schIUScale.IU_PER_MILS ) };
}

References A, A0, A1, A2, A3, A4, B, C, D, E, getCurrentScreen(), PAGE_INFO::GetHeightIU(), EDA_IU_SCALE::IU_PER_MILS, LEGAL, LETTER, m_altiumSheet, m_sheetOffset, ORCAD_A, ORCAD_B, ORCAD_C, ORCAD_D, ORCAD_E, PORTRAIT, schIUScale, 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 2000 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( wxT( "Sheet entry's owner (%d) not found." ),
 elem.ownerindex ),
 RPT_SEVERITY_DEBUG );
 return;
 }
 
 SCH_SHEET_PIN* sheetPin = new SCH_SHEET_PIN( sheetIt->second );
 sheetIt->second->AddPin( sheetPin );
 
 sheetPin->SetText( elem.name );
 sheetPin->SetShape( LABEL_FLAG_SHAPE::L_UNSPECIFIED );
 //sheetPin->SetTextSpinStyle( getSpinStyle( term.OrientAngle, false ) );
 //sheetPin->SetPosition( getKiCadPoint( term.Position ) );
 
 VECTOR2I 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->SetTextSpinStyle( TEXT_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->SetTextSpinStyle( TEXT_SPIN_STYLE::RIGHT );
 sheetPin->SetSide( SHEET_SIDE::RIGHT );
 break;
 
 case ASCH_SHEET_ENTRY_SIDE::TOP:
 sheetPin->SetPosition( { pos.x + elem.distanceFromTop, pos.y } );
 sheetPin->SetTextSpinStyle( TEXT_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->SetTextSpinStyle( TEXT_SPIN_STYLE::BOTTOM );
 sheetPin->SetSide( SHEET_SIDE::BOTTOM );
 break;
 }
 
 switch( elem.iotype )
 {
 default:
 case ASCH_PORT_IOTYPE::UNSPECIFIED:
 sheetPin->SetShape( LABEL_FLAG_SHAPE::L_UNSPECIFIED );
 break;
 
 case ASCH_PORT_IOTYPE::OUTPUT:
 sheetPin->SetShape( LABEL_FLAG_SHAPE::L_OUTPUT );
 break;
 
 case ASCH_PORT_IOTYPE::INPUT:
 sheetPin->SetShape( LABEL_FLAG_SHAPE::L_INPUT );
 break;
 
 case ASCH_PORT_IOTYPE::BIDI:
 sheetPin->SetShape( LABEL_FLAG_SHAPE::L_BIDI );
 break;
 }
}

References BIDI, BOTTOM, TEXT_SPIN_STYLE::BOTTOM, ASCH_SHEET_ENTRY::distanceFromTop, Format(), INPUT, ASCH_SHEET_ENTRY::iotype, L_BIDI, L_INPUT, L_OUTPUT, L_UNSPECIFIED, LEFT, TEXT_SPIN_STYLE::LEFT, m_reporter, m_sheets, ASCH_SHEET_ENTRY::name, OUTPUT, ASCH_SHEET_ENTRY::ownerindex, REPORTER::Report(), RIGHT, TEXT_SPIN_STYLE::RIGHT, RPT_SEVERITY_DEBUG, SCH_SHEET_PIN::SetPosition(), SCH_LABEL_BASE::SetShape(), SCH_SHEET_PIN::SetSide(), EDA_TEXT::SetText(), SCH_HIERLABEL::SetTextSpinStyle(), ASCH_SHEET_ENTRY::side, TOP, UNSPECIFIED, TEXT_SPIN_STYLE::UP, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by ParseFileHeader().

ParseSheetName()

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

private

Definition at line 2802 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( wxT( "Sheetname's owner (%d) not found." ),
 elem.ownerindex ),
 RPT_SEVERITY_DEBUG );
 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_DEBUG, 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 1962 of file sch_altium_plugin.cpp.

{
 ASCH_SHEET_SYMBOL elem( aProperties );
 
 SCH_SHEET* sheet = new SCH_SHEET( getCurrentSheet(), elem.location + m_sheetOffset,
 elem.size );
 
 sheet->SetBorderColor( GetColorFromInt( elem.color ) );
 
 if( elem.isSolid )
 sheet->SetBackgroundColor( GetColorFromInt( elem.areacolor ) );
 
 sheet->SetFlags( IS_NEW );
 
 SCH_SCREEN* currentScreen = getCurrentScreen();
 wxCHECK( currentScreen, /* void */ );
 currentScreen->Append( sheet );
 
 SCH_SHEET_PATH sheetpath = m_sheetPath;
 sheetpath.push_back( sheet );
 
 // We'll update later if we find a pageNumber record for it.
 sheetpath.SetPageNumber( "#" );
 
 SCH_SCREEN* rootScreen = m_rootSheet->GetScreen();
 wxCHECK( rootScreen, /* void */ );
 
 SCH_SHEET_INSTANCE sheetInstance;
 
 sheetInstance.m_Path = sheetpath.Path();
 sheetInstance.m_PageNumber = wxT( "#" );
 
 rootScreen->m_sheetInstances.emplace_back( sheetInstance );
 m_sheets.insert( { aIndex, sheet } );
}

References SCH_SCREEN::Append(), ASCH_SHEET_SYMBOL::areacolor, ASCH_SHEET_SYMBOL::color, GetColorFromInt(), getCurrentScreen(), getCurrentSheet(), SCH_SHEET::GetScreen(), IS_NEW, ASCH_SHEET_SYMBOL::isSolid, ASCH_SHEET_SYMBOL::location, SCH_SHEET_INSTANCE::m_PageNumber, SCH_SHEET_INSTANCE::m_Path, m_rootSheet, SCH_SCREEN::m_sheetInstances, m_sheetOffset, m_sheetPath, m_sheets, SCH_SHEET_PATH::Path(), SCH_SHEET_PATH::push_back(), SCH_SHEET::SetBackgroundColor(), SCH_SHEET::SetBorderColor(), EDA_ITEM::SetFlags(), SCH_SHEET_PATH::SetPageNumber(), and ASCH_SHEET_SYMBOL::size.

Referenced by ParseFileHeader().

ParseSignalHarness()

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

private

Definition at line 1764 of file sch_altium_plugin.cpp.

{
 ASCH_SIGNAL_HARNESS elem( aProperties );
 
 SCH_SCREEN* screen = getCurrentScreen();
 wxCHECK( screen, /* void */ );
 
 if( elem.OwnerPartID == ALTIUM_COMPONENT_NONE )
 {
 SCH_SHAPE* poly = new SCH_SHAPE( SHAPE_T::POLY );
 
 for( VECTOR2I& point : elem.Points )
 poly->AddPoint( point + m_sheetOffset );
 
 poly->SetStroke( STROKE_PARAMS( elem.LineWidth, PLOT_DASH_TYPE::SOLID,
 GetColorFromInt( elem.Color ) ) );
 poly->SetFlags( IS_NEW );
 
 screen->Append( poly );
 }
 else
 {
 // No clue if this situation can ever exist
 m_reporter->Report( wxT( "Signal harness, belonging to the part is not currently "
 "supported." ), RPT_SEVERITY_DEBUG );
 }
}

References SCH_SHAPE::AddPoint(), ALTIUM_COMPONENT_NONE, SCH_SCREEN::Append(), ASCH_SIGNAL_HARNESS::Color, GetColorFromInt(), getCurrentScreen(), IS_NEW, ASCH_SIGNAL_HARNESS::LineWidth, m_reporter, m_sheetOffset, ASCH_SIGNAL_HARNESS::OwnerPartID, ASCH_SIGNAL_HARNESS::Points, POLY, REPORTER::Report(), RPT_SEVERITY_DEBUG, EDA_ITEM::SetFlags(), SCH_SHAPE::SetStroke(), and SOLID.

Referenced by ParseAdditional().

ParseStorage()

void SCH_ALTIUM_PLUGIN::ParseStorage

(

const ALTIUM_COMPOUND_FILE &

aAltiumSchFile

)

Definition at line 395 of file sch_altium_plugin.cpp.

{
 const CFB::COMPOUND_FILE_ENTRY* file = aAltiumSchFile.FindStream( { "Storage" } );
 
 if( file == nullptr )
 return;
 
 ALTIUM_PARSER reader( aAltiumSchFile, file );
 
 std::map<wxString, wxString> properties = reader.ReadProperties();
 wxString header = ALTIUM_PARSER::ReadString( properties, "HEADER", "" );
 int weight = ALTIUM_PARSER::ReadInt( properties, "WEIGHT", 0 );
 
 if( weight < 0 )
 THROW_IO_ERROR( "Storage weight is negative!" );
 
 for( int i = 0; i < weight; i++ )
 {
 m_altiumStorage.emplace_back( reader );
 }
 
 if( reader.HasParsingError() )
 THROW_IO_ERROR( "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 "
 "(%d bytes remaining)." ),
 reader.GetRemainingBytes() ),
 RPT_SEVERITY_ERROR );
 }
}

References _, ALTIUM_COMPOUND_FILE::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 1172 of file sch_altium_plugin.cpp.

{
 ASCH_TEXT_FRAME elem( aProperties );
 AddTextBox( &elem );
}

References AddTextBox().

Referenced by ParseFileHeader().

ParseWire()

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

private

Definition at line 2658 of file sch_altium_plugin.cpp.

{
 ASCH_WIRE elem( aProperties );
 
 SCH_SCREEN* screen = getCurrentScreen();
 wxCHECK( screen, /* void */ );
 
 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 );
 screen->Append( wire );
 }
}

References SCH_SCREEN::Append(), getCurrentScreen(), IS_NEW, LAYER_WIRE, ASCH_WIRE::lineWidth, 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 STRING_UTF8_MAP *  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().

Referenced by DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged(), and SCH_EDIT_FRAME::saveSchematicFile().

SaveLibrary()

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

virtualinherited

Reimplemented in SCH_SEXPR_PLUGIN, and SCH_LEGACY_PLUGIN.

Definition at line 45 of file sch_plugin.cpp.

{
 not_implemented( this, __FUNCTION__ );
}

References not_implemented().

Referenced by Load(), CADSTAR_SCH_ARCHIVE_PLUGIN::Load(), SCH_EAGLE_PLUGIN::Load(), SCH_EAGLE_PLUGIN::loadSchematic(), SYMBOL_LIBRARY_MANAGER::SaveLibrary(), and SYMBOL_LIB_TABLE_RESCUER::WriteRescueLibrary().

SaveSymbol()

void SCH_PLUGIN::SaveSymbol ( const wxString &  aLibraryPath, const LIB_SYMBOL *  aSymbol, const STRING_UTF8_MAP *  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_SEXPR_PLUGIN, and SCH_LEGACY_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 PANEL_SYM_LIB_TABLE::convertLibrary(), SYMBOL_EDIT_FRAME::ExportSymbol(), SCH_EDITOR_CONTROL::ExportSymbolsToLibrary(), SCH_EAGLE_PLUGIN::loadLibrary(), ParseFileHeader(), ParsePowerPort(), SYMBOL_LIBRARY_MANAGER::LIB_BUFFER::SaveBuffer(), SYMBOL_LIBRARY_MANAGER::SaveLibrary(), SYMBOL_LIB_TABLE::SaveSymbol(), and SYMBOL_LIB_TABLE_RESCUER::WriteRescueLibrary().

SetLibTable()

virtual void SCH_PLUGIN::SetLibTable ( SYMBOL_LIB_TABLE *  aTable )

inlinevirtualinherited

Some library plugins need to have access to their parent library table.

Parameters

aTable

is the table this plugin is registered within.

Reimplemented in SCH_DATABASE_PLUGIN.

Definition at line 515 of file sch_io_mgr.h.

{}

Referenced by SYMBOL_LIB_TABLE::FindRow(), and SYMBOL_LIB_TABLE_ROW::Refresh().

SetProgressReporter()

virtual void SCH_PLUGIN::SetProgressReporter ( PROGRESS_REPORTER *  aReporter )

inlinevirtualinherited

Set an optional progress reporter.

Reimplemented in CADSTAR_SCH_ARCHIVE_PLUGIN, SCH_EAGLE_PLUGIN, SCH_SEXPR_PLUGIN, and SCH_LEGACY_PLUGIN.

Definition at line 173 of file sch_io_mgr.h.

{}

Referenced by SCH_EDIT_FRAME::importFile(), and SCH_EDIT_FRAME::OpenProjectFiles().

SetReporter()

void SCH_ALTIUM_PLUGIN::SetReporter ( REPORTER *  aReporter )

inlineoverridevirtual

Set an optional reporter for warnings/errors.

Reimplemented from SCH_PLUGIN.

Definition at line 56 of file sch_altium_plugin.h.

{ m_reporter = aReporter; }

References m_reporter.

SupportsSubLibraries()

virtual bool SCH_PLUGIN::SupportsSubLibraries ( ) const

inlinevirtualinherited

Returns

true if this plugin supports libraries that contain sub-libraries.

Reimplemented in SCH_DATABASE_PLUGIN.

Definition at line 449 of file sch_io_mgr.h.

{ return false; }

Referenced by SYMBOL_LIB_TABLE_ROW::SupportsSubLibraries().

SymbolLibOptions()

void SCH_PLUGIN::SymbolLibOptions ( STRING_UTF8_MAP *  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_altiumAdditional

std::vector<ASCH_ADDITIONAL_FILE> SCH_ALTIUM_PLUGIN::m_altiumAdditional

private

Definition at line 176 of file sch_altium_plugin.h.

m_altiumComponents

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

private

Definition at line 178 of file sch_altium_plugin.h.

Referenced by IsComponentPartVisible(), ParseComponent(), and ParseFileHeader().

m_altiumHarnessPortsCurrentSheet

std::vector<ASCH_PORT> SCH_ALTIUM_PLUGIN::m_altiumHarnessPortsCurrentSheet

private

Definition at line 183 of file sch_altium_plugin.h.

Referenced by ParseAdditional(), and ParsePort().

m_altiumImplementationList

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

private

Definition at line 179 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 180 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 169 of file sch_altium_plugin.h.

Referenced by AddTextBox(), ParseHarnessPort(), ParseLabel(), and ParseSheet().

m_altiumStorage

std::vector<ASCH_STORAGE_FILE> SCH_ALTIUM_PLUGIN::m_altiumStorage

private

Definition at line 175 of file sch_altium_plugin.h.

Referenced by GetFileFromStorage(), and ParseStorage().

m_currentTitleBlock

std::unique_ptr<TITLE_BLOCK> SCH_ALTIUM_PLUGIN::m_currentTitleBlock

private

Definition at line 165 of file sch_altium_plugin.h.

Referenced by ParseFileHeader(), and ParseParameter().

m_harnessEntryParent

int SCH_ALTIUM_PLUGIN::m_harnessEntryParent

private

Definition at line 187 of file sch_altium_plugin.h.

Referenced by ParseHarnessConnector(), ParseHarnessEntry(), ParseHarnessType(), and SCH_ALTIUM_PLUGIN().

m_harnessOwnerIndexOffset

int SCH_ALTIUM_PLUGIN::m_harnessOwnerIndexOffset

private

Definition at line 186 of file sch_altium_plugin.h.

Referenced by ParseFileHeader(), ParseHarnessConnector(), and SCH_ALTIUM_PLUGIN().

m_libName

wxString SCH_ALTIUM_PLUGIN::m_libName

private

Definition at line 160 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 172 of file sch_altium_plugin.h.

Referenced by ParseArc(), ParseBezier(), ParseComponent(), ParseDesignator(), ParseEllipse(), 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 162 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 174 of file sch_altium_plugin.h.

Referenced by ParsePowerPort().

m_properties

std::unique_ptr<STRING_UTF8_MAP> SCH_ALTIUM_PLUGIN::m_properties

private

Definition at line 163 of file sch_altium_plugin.h.

Referenced by ParseFileHeader(), and ParsePowerPort().

m_reporter

REPORTER* SCH_ALTIUM_PLUGIN::m_reporter

private

Definition at line 155 of file sch_altium_plugin.h.

Referenced by ParseAdditional(), ParseArc(), ParseBezier(), ParseComponent(), ParseDesignator(), ParseEllipse(), ParseFileHeader(), ParseFileName(), ParseHarnessConnector(), ParseHarnessEntry(), ParseHarnessPort(), ParseHarnessType(), ParseImage(), ParseImplementation(), ParseLabel(), ParseLine(), ParsePin(), ParsePolygon(), ParsePolyline(), ParsePort(), ParsePowerPort(), ParseRectangle(), ParseRoundRectangle(), ParseSheetEntry(), ParseSheetName(), ParseSignalHarness(), ParseStorage(), SCH_ALTIUM_PLUGIN(), and SetReporter().

m_rootSheet

SCH_SHEET* SCH_ALTIUM_PLUGIN::m_rootSheet

private

Definition at line 157 of file sch_altium_plugin.h.

Referenced by getLibName(), Load(), ParseAltiumSch(), ParseSheetSymbol(), and SCH_ALTIUM_PLUGIN().

m_schematic

SCHEMATIC* SCH_ALTIUM_PLUGIN::m_schematic

private

Definition at line 159 of file sch_altium_plugin.h.

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

m_sheetOffset

VECTOR2I SCH_ALTIUM_PLUGIN::m_sheetOffset

private

Definition at line 168 of file sch_altium_plugin.h.

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

m_sheetPath

SCH_SHEET_PATH SCH_ALTIUM_PLUGIN::m_sheetPath

private

Definition at line 158 of file sch_altium_plugin.h.

Referenced by getCurrentScreen(), getCurrentSheet(), Load(), ParseAltiumSch(), ParseComponent(), ParseDesignator(), ParseHarnessConnector(), ParseParameter(), ParsePowerPort(), and ParseSheetSymbol().

m_sheets

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

private

Definition at line 171 of file sch_altium_plugin.h.

Referenced by ParseFileName(), ParseHarnessConnector(), ParseHarnessEntry(), ParseHarnessType(), ParseSheetEntry(), ParseSheetName(), and ParseSheetSymbol().

m_symbols

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

private

Definition at line 170 of file sch_altium_plugin.h.

Referenced by ParseArc(), ParseBezier(), ParseComponent(), ParseDesignator(), ParseEllipse(), 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