KiCad PCB EDA Suite
Loading...
Searching...
No Matches
generate_footprint_info.cpp
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2017 Chris Pavlina <[email protected]>
5 * Copyright (C) 2017-2023 KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software: you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation, either version 3 of the License, or (at your
10 * option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License along
18 * with this program. If not, see <http://www.gnu.org/licenses/>.
19 */
20
22#include <string_utils.h>
23#include <footprint.h>
24#include <fp_lib_table.h>
25#include <wx/log.h>
26
27
28static const wxString DescriptionFormat = wxT(
29 "<b>__NAME__</b>"
30 "<br>__DESC__"
31 "<hr><table border=0>"
32 "__FIELDS__"
33 "</table>" );
34
35static const wxString KeywordsFormat = wxT(
36 "<tr>"
37 " <td><b>" + _( "Keywords" ) + "</b></td>"
38 " <td>__KEYWORDS__</td>"
39 "</tr>" );
40
41static const wxString DocFormat = wxT(
42 "<tr>"
43 " <td><b>" + _( "Documentation" ) + "</b></td>"
44 " <td><a href=\"__HREF__\">__TEXT__</a></td>"
45 "</tr>" );
46
47
49{
50 wxString m_html;
52 LIB_ID const m_lib_id;
53
55
56public:
57 FOOTPRINT_INFO_GENERATOR( FP_LIB_TABLE* aFpLibTable, LIB_ID const& aLibId )
59 m_fp_lib_table( aFpLibTable ),
60 m_lib_id( aLibId ),
61 m_footprint( nullptr )
62 { }
63
68 {
69 wxCHECK_RET( m_fp_lib_table, wxT( "Footprint library table pointer is not valid" ) );
70
71 if( !m_lib_id.IsValid() )
72 return;
73
74 try
75 {
78 }
79 catch( const IO_ERROR& ioe )
80 {
81 wxLogError( _( "Error loading footprint %s from library '%s'." ) + wxS( "\n%s" ),
84 ioe.What() );
85 return;
86 }
87
88 if( m_footprint )
89 {
90 wxString name = m_lib_id.GetLibItemName();
91 wxString desc = m_footprint->GetLibDescription();
92 wxString keywords = m_footprint->GetKeywords();
93 wxString doc;
94
95 // It is currently common practice to store a documentation link in the description.
96 size_t idx = desc.find( wxT( "http:" ) );
97
98 if( idx == wxString::npos )
99 idx = desc.find( wxT( "https:" ) );
100
101 if( idx != wxString::npos )
102 {
103 int nesting = 0;
104
105 for( auto chit = desc.begin() + idx; chit != desc.end(); ++chit )
106 {
107 int ch = *chit;
108
109 // Break on invalid URI characters
110 if( ch <= 0x20 || ch >= 0x7F || ch == '"' )
111 break;
112
113 // Check for nesting parentheses, e.g. (Body style from: https://this.url/part.pdf)
114 if( ch == '(' )
115 ++nesting;
116 else if( ch == ')' && --nesting < 0 )
117 break;
118
119 doc += ch;
120 }
121
122 // Trim trailing punctuation
123 static wxString punct = wxS( ".,:;" );
124
125 if( punct.find( doc.Last() ) != wxString::npos )
126 doc = doc.Left( doc.Length() - 1 );
127 }
128
129 wxString esc_desc = EscapeHTML( UnescapeString( desc ) );
130
131 // Add line breaks
132 esc_desc.Replace( wxS( "\n" ), wxS( "<br>" ) );
133
134 // Add links
135 esc_desc = LinkifyHTML( esc_desc );
136
137 m_html.Replace( "__DESC__", esc_desc );
138 m_html.Replace( "__NAME__", EscapeHTML( name ) );
139
140 wxString keywordsHtml = KeywordsFormat;
141 keywordsHtml.Replace( "__KEYWORDS__", EscapeHTML( keywords ) );
142
143 wxString docHtml = DocFormat;
144 docHtml.Replace( "__HREF__", EscapeHTML( doc ) );
145
146 if( doc.Length() > 75 )
147 doc = doc.Left( 72 ) + wxT( "..." );
148
149 docHtml.Replace( "__TEXT__", EscapeHTML( doc ) );
150
151 m_html.Replace( "__FIELDS__", keywordsHtml + docHtml );
152 }
153 }
154
158 wxString GetHtml()
159 {
160 return m_html;
161 }
162
163};
164
165
166wxString GenerateFootprintInfo( FP_LIB_TABLE* aFpLibTable, LIB_ID const& aLibId )
167{
168 FOOTPRINT_INFO_GENERATOR gen( aFpLibTable, aLibId );
169 gen.GenerateHtml();
170 return gen.GetHtml();
171}
const char * name
Definition: DXF_plotter.cpp:57
FOOTPRINT_INFO_GENERATOR(FP_LIB_TABLE *aFpLibTable, LIB_ID const &aLibId)
void GenerateHtml()
Generate the HTML internally.
wxString GetHtml() const
Return the generated HTML.
wxString GetHtml()
Return the generated HTML.
wxString GetLibDescription() const
Definition: footprint.h:256
wxString GetKeywords() const
Definition: footprint.h:259
const FOOTPRINT * GetEnumeratedFootprint(const wxString &aNickname, const wxString &aFootprintName)
A version of FootprintLoad() for use after FootprintEnumerate() for more efficient cache management.
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:77
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:30
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:49
bool IsValid() const
Check if this LID_ID is valid.
Definition: lib_id.h:172
const UTF8 & GetLibItemName() const
Definition: lib_id.h:102
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Definition: lib_id.h:87
wxString wx_str() const
Definition: utf8.cpp:45
#define _(s)
static const wxString KeywordsFormat
wxString GenerateFootprintInfo(FP_LIB_TABLE *aFpLibTable, LIB_ID const &aLibId)
Return an HTML page describing a LIB_ID in a FP_LIB_TABLE.
static const wxString DescriptionFormat
static const wxString DocFormat
wxString EscapeHTML(const wxString &aString)
Return a new wxString escaped for embedding in HTML.
wxString UnescapeString(const wxString &aSource)
wxString LinkifyHTML(wxString aStr)
Wraps links in HTML tags.