FOOTPRINT_INFO_GENERATOR Class Reference

Public Member Functions
	FOOTPRINT_INFO_GENERATOR (SYMBOL_LIB_TABLE *aSymbolLibTable, LIB_ID const &aLibId, int aUnit)
void	GenerateHtml ()
	Generate the HTML internally. More...
wxString	GetHtml () const
	Return the generated HTML. More...
	FOOTPRINT_INFO_GENERATOR (FP_LIB_TABLE *aFpLibTable, LIB_ID const &aLibId)
void	GenerateHtml ()
	Generate the HTML internally. More...
wxString	GetHtml ()
	Return the generated HTML. More...

Protected Member Functions
void	SetHtmlName ()
void	SetHtmlAliasOf ()
void	SetHtmlDesc ()
void	SetHtmlKeywords ()
wxString	GetHtmlFieldRow (const LIB_FIELD &aField) const
void	SetHtmlFieldTable ()

Private Attributes
wxString	m_html
SYMBOL_LIB_TABLE *	m_sym_lib_table
LIB_ID const	m_lib_id
LIB_SYMBOL *	m_symbol
int	m_unit
FP_LIB_TABLE *	m_fp_lib_table
const FOOTPRINT *	m_footprint

Detailed Description

Definition at line 48 of file generate_alias_info.cpp.

Constructor & Destructor Documentation

FOOTPRINT_INFO_GENERATOR() [1/2]

FOOTPRINT_INFO_GENERATOR::FOOTPRINT_INFO_GENERATOR ( SYMBOL_LIB_TABLE *  aSymbolLibTable, LIB_ID const &  aLibId, int  aUnit  )

inline

Definition at line 57 of file generate_alias_info.cpp.

 : m_html( DescriptionFormat ),
 m_sym_lib_table( aSymbolLibTable ),
 m_lib_id( aLibId ),
 m_symbol( nullptr ),
 m_unit( aUnit )
 { }

FOOTPRINT_INFO_GENERATOR() [2/2]

FOOTPRINT_INFO_GENERATOR::FOOTPRINT_INFO_GENERATOR ( FP_LIB_TABLE *  aFpLibTable, LIB_ID const &  aLibId  )

inline

Definition at line 57 of file generate_footprint_info.cpp.

 : m_html( DescriptionFormat ),
 m_fp_lib_table( aFpLibTable ),
 m_lib_id( aLibId ),
 m_footprint( nullptr )
 { }

Member Function Documentation

GenerateHtml() [1/2]

void FOOTPRINT_INFO_GENERATOR::GenerateHtml ( )

inline

Generate the HTML internally.

Definition at line 68 of file generate_alias_info.cpp.

 {
 wxCHECK_RET( m_sym_lib_table, "Symbol library table pointer is not valid" );
 
 if( !m_lib_id.IsValid() )
 return;
 
 try
 {
 m_symbol = m_sym_lib_table->LoadSymbol( m_lib_id );
 }
 catch( const IO_ERROR& ioe )
 {
 wxLogError( _( "Error loading symbol %s from library '%s'." ) + wxS( "\n%s" ),
 m_lib_id.GetLibItemName().wx_str(),
 m_lib_id.GetLibNickname().wx_str(),
 ioe.What() );
 return;
 }
 
 if( m_symbol )
 {
 SetHtmlName();
 SetHtmlAliasOf();
 SetHtmlDesc();
 SetHtmlKeywords();
 SetHtmlFieldTable();
 }
 }

References _, LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), LIB_ID::IsValid(), SYMBOL_LIB_TABLE::LoadSymbol(), m_lib_id, m_sym_lib_table, m_symbol, SetHtmlAliasOf(), SetHtmlDesc(), SetHtmlFieldTable(), SetHtmlKeywords(), SetHtmlName(), IO_ERROR::What(), and UTF8::wx_str().

Referenced by GenerateAliasInfo(), and GenerateFootprintInfo().

GenerateHtml() [2/2]

void FOOTPRINT_INFO_GENERATOR::GenerateHtml ( )

inline

Generate the HTML internally.

Definition at line 67 of file generate_footprint_info.cpp.

 {
 wxCHECK_RET( m_fp_lib_table, wxT( "Footprint library table pointer is not valid" ) );
 
 if( !m_lib_id.IsValid() )
 return;
 
 try
 {
 m_footprint = m_fp_lib_table->GetEnumeratedFootprint( m_lib_id.GetLibNickname(),
 m_lib_id.GetLibItemName() );
 }
 catch( const IO_ERROR& ioe )
 {
 wxLogError( _( "Error loading footprint %s from library '%s'." ) + wxS( "\n%s" ),
 m_lib_id.GetLibItemName().wx_str(),
 m_lib_id.GetLibNickname().wx_str(),
 ioe.What() );
 return;
 }
 
 if( m_footprint )
 {
 wxString name = m_lib_id.GetLibItemName();
 wxString desc = m_footprint->GetDescription();
 wxString keywords = m_footprint->GetKeywords();
 wxString doc;
 
 // It is currently common practice to store a documentation link in the description.
 int idx = desc.find( wxT( "http:" ) );
 
 if( idx < 0 )
 idx = desc.find( wxT( "https:" ) );
 
 if( idx >= 0 )
 {
 int nesting = 0;
 
 for( auto chit = desc.begin() + idx; chit != desc.end(); ++chit )
 {
 int ch = *chit;
 
 // Break on invalid URI characters
 if( ch <= 0x20 || ch >= 0x7F || ch == '"' )
 break;
 
 // Check for nesting parentheses, e.g. (Body style from: https://this.url/part.pdf)
 if( ch == '(' )
 ++nesting;
 else if( ch == ')' && --nesting < 0 )
 break;
 
 doc += ch;
 }
 
 desc.Replace( doc, _( "doc url" ) );
 }
 
 m_html.Replace( "__NAME__", EscapeHTML( name ) );
 m_html.Replace( "__DESC__", EscapeHTML( desc ) );
 
 wxString keywordsHtml = KeywordsFormat;
 keywordsHtml.Replace( "__KEYWORDS__", EscapeHTML( keywords ) );
 
 wxString docHtml = DocFormat;
 docHtml.Replace( "__HREF__", EscapeHTML( doc ) );
 
 if( doc.Length() > 75 )
 doc = doc.Left( 72 ) + wxT( "..." );
 
 docHtml.Replace( "__TEXT__", EscapeHTML( doc ) );
 
 m_html.Replace( "__FIELDS__", keywordsHtml + docHtml );
 }
 }

References _, DocFormat, EscapeHTML(), FOOTPRINT::GetDescription(), FP_LIB_TABLE::GetEnumeratedFootprint(), FOOTPRINT::GetKeywords(), LIB_ID::GetLibItemName(), LIB_ID::GetLibNickname(), LIB_ID::IsValid(), KeywordsFormat, m_footprint, m_fp_lib_table, m_html, m_lib_id, name, IO_ERROR::What(), and UTF8::wx_str().

GetHtml() [1/2]

wxString FOOTPRINT_INFO_GENERATOR::GetHtml ( )

inline

Return the generated HTML.

Definition at line 146 of file generate_footprint_info.cpp.

 {
 return m_html;
 }

References m_html.

GetHtml() [2/2]

wxString FOOTPRINT_INFO_GENERATOR::GetHtml ( ) const

inline

Return the generated HTML.

Definition at line 101 of file generate_alias_info.cpp.

 {
 return m_html;
 }

References m_html.

Referenced by GenerateAliasInfo(), and GenerateFootprintInfo().

GetHtmlFieldRow()

wxString FOOTPRINT_INFO_GENERATOR::GetHtmlFieldRow ( const LIB_FIELD &  aField ) const

inlineprotected

Definition at line 158 of file generate_alias_info.cpp.

 {
 wxString name = aField.GetCanonicalName();
 wxString text;
 wxString fieldhtml = FieldFormat;
 
 fieldhtml.Replace( wxS( "__NAME__" ), EscapeHTML( name ) );
 
 switch( aField.GetId() )
 {
 case DATASHEET_FIELD:
 text = m_symbol->GetDatasheetField().GetShownText( 0, false );
 
 if( text.IsEmpty() || text == wxT( "~" ) )
 {
 fieldhtml.Replace( wxS( "__VALUE__" ), text );
 }
 else
 {
 wxString datasheetlink = DatasheetLinkFormat;
 datasheetlink.Replace( wxS( "__HREF__" ), EscapeHTML( text ) );
 
 if( text.Length() > 75 )
 text = text.Left( 72 ) + wxT( "..." );
 
 datasheetlink.Replace( wxS( "__TEXT__" ), EscapeHTML( text ) );
 
 fieldhtml.Replace( wxS( "__VALUE__" ), datasheetlink );
 }
 
 break;
 
 case VALUE_FIELD:
 // showing the value just repeats the name, so that's not much use...
 return wxEmptyString;
 
 case REFERENCE_FIELD:
 text = aField.GetFullText( m_unit > 0 ? m_unit : 1 );
 fieldhtml.Replace( wxS( "__VALUE__" ), EscapeHTML( text ) );
 break;
 
 default:
 text = aField.GetShownText( 0, false );
 fieldhtml.Replace( wxS( "__VALUE__" ), EscapeHTML( text ) );
 }
 
 return fieldhtml;
 }

References DATASHEET_FIELD, DatasheetLinkFormat, EscapeHTML(), FieldFormat, LIB_FIELD::GetCanonicalName(), LIB_SYMBOL::GetDatasheetField(), LIB_FIELD::GetFullText(), LIB_FIELD::GetId(), LIB_FIELD::GetShownText(), m_symbol, m_unit, name, REFERENCE_FIELD, text, and VALUE_FIELD.

Referenced by SetHtmlFieldTable().

SetHtmlAliasOf()

void FOOTPRINT_INFO_GENERATOR::SetHtmlAliasOf ( )

inlineprotected

Definition at line 113 of file generate_alias_info.cpp.

 {
 if( m_symbol->IsRoot() )
 {
 m_html.Replace( "__ALIASOF__", wxEmptyString );
 }
 else
 {
 wxString root_name = _( "Unknown" );
 wxString root_desc = wxS( "" );
 
 std::shared_ptr< LIB_SYMBOL > parent = m_symbol->GetParent().lock();
 
 if( parent )
 {
 root_name = parent->GetName();
 root_desc = parent->GetDescription();
 }
 
 m_html.Replace( wxS( "__ALIASOF__" ), wxString::Format( AliasOfFormat,
 EscapeHTML( UnescapeString( root_name ) ),
 EscapeHTML( root_desc ) ) );
 }
 }

References _, AliasOfFormat, EscapeHTML(), Format(), LIB_SYMBOL::GetParent(), LIB_SYMBOL::IsRoot(), m_html, m_symbol, and UnescapeString().

Referenced by GenerateHtml().

SetHtmlDesc()

void FOOTPRINT_INFO_GENERATOR::SetHtmlDesc ( )

inlineprotected

Definition at line 139 of file generate_alias_info.cpp.

 {
 wxString raw_desc = m_symbol->GetDescription();
 
 m_html.Replace( wxS( "__DESC__" ), wxString::Format( DescFormat, EscapeHTML( raw_desc ) ) );
 }

References DescFormat, EscapeHTML(), Format(), LIB_SYMBOL::GetDescription(), m_html, and m_symbol.

Referenced by GenerateHtml().

SetHtmlFieldTable()

void FOOTPRINT_INFO_GENERATOR::SetHtmlFieldTable ( )

inlineprotected

Definition at line 208 of file generate_alias_info.cpp.

 {
 wxString fieldtable;
 std::vector<LIB_FIELD*> fields;
 
 m_symbol->GetFields( fields );
 
 for( const LIB_FIELD* field: fields )
 fieldtable += GetHtmlFieldRow( *field );
 
 if( m_symbol->IsAlias() )
 {
 std::shared_ptr<LIB_SYMBOL> parent = m_symbol->GetParent().lock();
 
 // Append all of the unique parent fields if this is an alias.
 if( parent )
 {
 std::vector<LIB_FIELD*> parentFields;
 
 parent->GetFields( parentFields );
 
 for( const LIB_FIELD* parentField : parentFields )
 {
 if( m_symbol->FindField( parentField->GetCanonicalName() ) )
 continue;
 
 fieldtable += GetHtmlFieldRow( *parentField );
 }
 }
 }
 
 m_html.Replace( wxS( "__FIELDS__" ), fieldtable );
 }

References LIB_SYMBOL::FindField(), LIB_SYMBOL::GetFields(), GetHtmlFieldRow(), LIB_SYMBOL::GetParent(), LIB_SYMBOL::IsAlias(), m_html, and m_symbol.

Referenced by GenerateHtml().

SetHtmlKeywords()

void FOOTPRINT_INFO_GENERATOR::SetHtmlKeywords ( )

inlineprotected

Definition at line 147 of file generate_alias_info.cpp.

 {
 wxString keywords = m_symbol->GetKeyWords();
 
 if( keywords.empty() )
 m_html.Replace( wxS( "__KEY__" ), wxEmptyString );
 else
 m_html.Replace( wxS( "__KEY__" ), wxString::Format( KeywordsFormat, EscapeHTML( keywords ) ) );
 }

References EscapeHTML(), Format(), LIB_SYMBOL::GetKeyWords(), KeywordsFormat, m_html, and m_symbol.

Referenced by GenerateHtml().

SetHtmlName()

void FOOTPRINT_INFO_GENERATOR::SetHtmlName ( )

inlineprotected

Definition at line 107 of file generate_alias_info.cpp.

 {
 m_html.Replace( wxS( "__NAME__" ), EscapeHTML( UnescapeString( m_symbol->GetName() ) ) );
 }

References EscapeHTML(), LIB_SYMBOL::GetName(), m_html, m_symbol, and UnescapeString().

Referenced by GenerateHtml().

Member Data Documentation

m_footprint

const FOOTPRINT* FOOTPRINT_INFO_GENERATOR::m_footprint

private

Definition at line 54 of file generate_footprint_info.cpp.

Referenced by GenerateHtml().

m_fp_lib_table

FP_LIB_TABLE* FOOTPRINT_INFO_GENERATOR::m_fp_lib_table

private

Definition at line 51 of file generate_footprint_info.cpp.

Referenced by GenerateHtml().

m_html

wxString FOOTPRINT_INFO_GENERATOR::m_html

private

Definition at line 50 of file generate_alias_info.cpp.

Referenced by GenerateHtml(), GetHtml(), SetHtmlAliasOf(), SetHtmlDesc(), SetHtmlFieldTable(), SetHtmlKeywords(), and SetHtmlName().

m_lib_id

LIB_ID const FOOTPRINT_INFO_GENERATOR::m_lib_id

private

Definition at line 52 of file generate_alias_info.cpp.

Referenced by GenerateHtml().

m_sym_lib_table

SYMBOL_LIB_TABLE* FOOTPRINT_INFO_GENERATOR::m_sym_lib_table

private

Definition at line 51 of file generate_alias_info.cpp.

Referenced by GenerateHtml().

m_symbol

LIB_SYMBOL* FOOTPRINT_INFO_GENERATOR::m_symbol

private

Definition at line 53 of file generate_alias_info.cpp.

Referenced by GenerateHtml(), GetHtmlFieldRow(), SetHtmlAliasOf(), SetHtmlDesc(), SetHtmlFieldTable(), SetHtmlKeywords(), and SetHtmlName().

m_unit

int FOOTPRINT_INFO_GENERATOR::m_unit

private

Definition at line 54 of file generate_alias_info.cpp.

Referenced by GetHtmlFieldRow().

---

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

• generate_alias_info.cpp
• generate_footprint_info.cpp