1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
|
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2017 Chris Pavlina <pavlina.chris@gmail.com>
* Copyright The KiCad Developers, see AUTHORS.txt for contributors.
*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
* Free Software Foundation, either version 3 of the License, or (at your
* option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include <generate_alias_info.h>
#include <string_utils.h>
#include <template_fieldnames.h>
#include <lib_symbol.h>
#include <symbol_lib_table.h>
#include <wx/log.h>
static const wxString DescriptionFormat = wxS(
"<b>__NAME__</b>"
"__ALIASOF__"
"__DESC__"
"__KEY__"
"<hr><table border=0>"
"__FIELDS__"
"</table>" );
static const wxString AliasOfFormat = wxS( "<br><i>" ) + _( "Derived from" ) +
wxS( " %s (%s)</i>" );
static const wxString DescFormat = wxS( "<br>%s" );
static const wxString KeywordsFormat = wxS( "<br>" ) + _( "Keywords" ) + wxS( ": %s" );
static const wxString FieldFormat = wxS(
"<tr>"
" <td><b>__NAME__</b></td>"
" <td>__VALUE__</td>"
"</tr>" );
static const wxString DatasheetLinkFormat = wxS( "<a href=\"__HREF__\">__TEXT__</a>" );
class FOOTPRINT_INFO_GENERATOR
{
wxString m_html;
SYMBOL_LIB_TABLE* m_sym_lib_table;
LIB_ID const m_lib_id;
LIB_SYMBOL* m_symbol;
int m_unit;
public:
FOOTPRINT_INFO_GENERATOR( SYMBOL_LIB_TABLE* aSymbolLibTable, LIB_ID const& aLibId, int aUnit )
: m_html( DescriptionFormat ),
m_sym_lib_table( aSymbolLibTable ),
m_lib_id( aLibId ),
m_symbol( nullptr ),
m_unit( aUnit )
{ }
/**
* Generate the HTML internally.
*/
void GenerateHtml()
{
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();
}
}
/**
* Return the generated HTML.
*/
wxString GetHtml() const
{
return m_html;
}
protected:
void SetHtmlName()
{
m_html.Replace( wxS( "__NAME__" ), EscapeHTML( UnescapeString( m_symbol->GetName() ) ) );
}
void SetHtmlAliasOf()
{
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->GetDesc();
}
m_html.Replace( wxS( "__ALIASOF__" ),
wxString::Format( AliasOfFormat,
EscapeHTML( UnescapeString( root_name ) ),
EscapeHTML( root_desc ) ) );
}
}
void SetHtmlDesc()
{
wxString esc_desc = EscapeHTML( UnescapeString( m_symbol->GetDescription() ) );
// Add line breaks
esc_desc.Replace( wxS( "\n" ), wxS( "<br>" ) );
// Add links
esc_desc = LinkifyHTML( esc_desc );
m_html.Replace( wxS( "__DESC__" ), wxString::Format( DescFormat, esc_desc ) );
}
void SetHtmlKeywords()
{
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 ) ) );
}
wxString GetHtmlFieldRow( const SCH_FIELD& aField ) const
{
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( 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( false );
fieldhtml.Replace( wxS( "__VALUE__" ), EscapeHTML( text ) );
}
return fieldhtml;
}
void SetHtmlFieldTable()
{
wxString fieldtable;
std::vector<SCH_FIELD*> fields;
m_symbol->GetFields( fields );
for( const SCH_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<SCH_FIELD*> parentFields;
parent->GetFields( parentFields );
for( const SCH_FIELD* parentField : parentFields )
{
if( m_symbol->FindField( parentField->GetCanonicalName() ) )
continue;
fieldtable += GetHtmlFieldRow( *parentField );
}
}
}
m_html.Replace( wxS( "__FIELDS__" ), fieldtable );
}
};
wxString GenerateAliasInfo( SYMBOL_LIB_TABLE* aSymLibTable, LIB_ID const& aLibId, int aUnit )
{
FOOTPRINT_INFO_GENERATOR gen( aSymLibTable, aLibId, aUnit );
gen.GenerateHtml();
return gen.GetHtml();
}
|
