KiCad PCB EDA Suite
Loading...
Searching...
No Matches
pcb_io_altium_designer.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) 2019 Thomas Pointhuber <[email protected]>
5 * Copyright (C) 2020-2023 KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, you may find one here:
19 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20 * or you may search the http://www.gnu.org website for the version 2 license,
21 * or you may write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23 */
24
29#include <wx/string.h>
30
31#include <font/fontconfig.h>
33#include <altium_pcb.h>
35#include <io/io_utils.h>
37#include <pcb_io/pcb_io.h>
38#include <reporter.h>
39
40#include <board.h>
41
42#include <compoundfilereader.h>
43#include <utf.h>
44
46 PCB_IO( wxS( "Altium Designer" ) )
47{
49
51}
52
53
55{
56}
57
58
60 const std::vector<INPUT_LAYER_DESC>& aInputLayerDescriptionVector )
61{
62 std::map<wxString, PCB_LAYER_ID> retval;
63
64 // Just return a the auto-mapped layers
65 for( INPUT_LAYER_DESC layerDesc : aInputLayerDescriptionVector )
66 {
67 retval.insert( { layerDesc.Name, layerDesc.AutoMapLayer } );
68 }
69
70 return retval;
71}
72
73
74bool PCB_IO_ALTIUM_DESIGNER::checkFileHeader( const wxString& aFileName )
75{
76 // Compound File Binary Format header
78}
79
80
81bool PCB_IO_ALTIUM_DESIGNER::CanReadBoard( const wxString& aFileName ) const
82{
83 if( !PCB_IO::CanReadBoard( aFileName ) )
84 return false;
85
86 return checkFileHeader( aFileName );
87}
88
89
90bool PCB_IO_ALTIUM_DESIGNER::CanReadLibrary( const wxString& aFileName ) const
91{
92 if( !PCB_IO::CanReadLibrary( aFileName ) )
93 return false;
94
95 return checkFileHeader( aFileName );
96}
97
98
99BOARD* PCB_IO_ALTIUM_DESIGNER::LoadBoard( const wxString& aFileName, BOARD* aAppendToMe,
100 const STRING_UTF8_MAP* aProperties, PROJECT* aProject )
101{
102
103 m_props = aProperties;
104
105 m_board = aAppendToMe ? aAppendToMe : new BOARD();
106
108
109 // Give the filename to the board if it's new
110 if( !aAppendToMe )
111 m_board->SetFileName( aFileName );
112
113 // clang-format off
114 const std::map<ALTIUM_PCB_DIR, std::string> mapping = {
115 { ALTIUM_PCB_DIR::FILE_HEADER, "FileHeader" },
116 { ALTIUM_PCB_DIR::ARCS6, "Arcs6" },
117 { ALTIUM_PCB_DIR::BOARD6, "Board6" },
118 { ALTIUM_PCB_DIR::BOARDREGIONS, "BoardRegions" },
119 { ALTIUM_PCB_DIR::CLASSES6, "Classes6" },
120 { ALTIUM_PCB_DIR::COMPONENTS6, "Components6" },
121 { ALTIUM_PCB_DIR::COMPONENTBODIES6, "ComponentBodies6" },
122 { ALTIUM_PCB_DIR::DIMENSIONS6, "Dimensions6" },
123 { ALTIUM_PCB_DIR::EXTENDPRIMITIVEINFORMATION, "ExtendedPrimitiveInformation" },
124 { ALTIUM_PCB_DIR::FILLS6, "Fills6" },
125 { ALTIUM_PCB_DIR::MODELS, "Models" },
126 { ALTIUM_PCB_DIR::NETS6, "Nets6" },
127 { ALTIUM_PCB_DIR::PADS6, "Pads6" },
128 { ALTIUM_PCB_DIR::POLYGONS6, "Polygons6" },
129 { ALTIUM_PCB_DIR::REGIONS6, "Regions6" },
130 { ALTIUM_PCB_DIR::RULES6, "Rules6" },
131 { ALTIUM_PCB_DIR::SHAPEBASEDREGIONS6, "ShapeBasedRegions6" },
132 { ALTIUM_PCB_DIR::TEXTS6, "Texts6" },
133 { ALTIUM_PCB_DIR::TRACKS6, "Tracks6" },
134 { ALTIUM_PCB_DIR::VIAS6, "Vias6" },
135 { ALTIUM_PCB_DIR::WIDESTRINGS6, "WideStrings6" }
136 };
137 // clang-format on
138
139 ALTIUM_PCB_COMPOUND_FILE altiumPcbFile( aFileName );
140
141 try
142 {
143 // Parse File
145 pcb.Parse( altiumPcbFile, mapping );
146 }
147 catch( CFB::CFBException& exception )
148 {
149 THROW_IO_ERROR( exception.what() );
150 }
151
152 return m_board;
153}
154
155
156long long PCB_IO_ALTIUM_DESIGNER::GetLibraryTimestamp( const wxString& aLibraryPath ) const
157{
158 // File hasn't been loaded yet.
159 if( aLibraryPath.IsEmpty() )
160 {
161 return 0;
162 }
163
164 wxFileName fn( aLibraryPath );
165
166 if( fn.IsFileReadable() && fn.GetModificationTime().IsValid() )
167 {
168 return fn.GetModificationTime().GetValue().GetValue();
169 }
170 else
171 {
172 return 0;
173 }
174}
175
176
177void PCB_IO_ALTIUM_DESIGNER::loadAltiumLibrary( const wxString& aLibraryPath )
178{
180
181 try
182 {
183 auto it = m_fplibFiles.find( aLibraryPath );
184
185 if( it != m_fplibFiles.end() )
186 return; // Already loaded
187
188 if( aLibraryPath.Lower().EndsWith( wxS( ".pcblib" ) ) )
189 {
190 m_fplibFiles[aLibraryPath].emplace_back(
191 std::make_unique<ALTIUM_PCB_COMPOUND_FILE>( aLibraryPath ) );
192 }
193 else if( aLibraryPath.Lower().EndsWith( wxS( ".intlib" ) ) )
194 {
195 std::unique_ptr<ALTIUM_PCB_COMPOUND_FILE> intCom =
196 std::make_unique<ALTIUM_PCB_COMPOUND_FILE>( aLibraryPath );
197
198 std::map<wxString, const CFB::COMPOUND_FILE_ENTRY*> pcbLibFiles =
199 intCom->EnumDir( L"PCBLib" );
200 for( const auto& [pcbLibName, pcbCfe] : pcbLibFiles )
201 {
202 auto decodedStream = intCom->DecodeIntLibStream( *pcbCfe );
203 m_fplibFiles[aLibraryPath].push_back(
204 std::unique_ptr<ALTIUM_PCB_COMPOUND_FILE>(
205 static_cast<ALTIUM_PCB_COMPOUND_FILE*>(decodedStream.release())
206 )
207 );
208 }
209 }
210 }
211 catch( CFB::CFBException& exception )
212 {
213 THROW_IO_ERROR( exception.what() );
214 }
215}
216
217
218void PCB_IO_ALTIUM_DESIGNER::FootprintEnumerate( wxArrayString& aFootprintNames,
219 const wxString& aLibraryPath, bool aBestEfforts,
220 const STRING_UTF8_MAP* aProperties )
221{
222 loadAltiumLibrary( aLibraryPath );
223
224 auto it = m_fplibFiles.find( aLibraryPath );
225
226 if( it == m_fplibFiles.end() )
227 return; // No footprint libraries in file, ignore.
228
229 try
230 {
231 for( auto& altiumLibFile : it->second )
232 {
233 // Map code-page-dependent names to unicode names
234 std::map<wxString, wxString> patternMap = altiumLibFile->ListLibFootprints();
235
236 const std::vector<std::string> streamName = { "Library", "Data" };
237 const CFB::COMPOUND_FILE_ENTRY* libraryData = altiumLibFile->FindStream( streamName );
238
239 if( libraryData == nullptr )
240 {
241 THROW_IO_ERROR( wxString::Format( _( "File not found: '%s'." ),
242 FormatPath( streamName ) ) );
243 }
244
245 ALTIUM_BINARY_PARSER parser( *altiumLibFile, libraryData );
246
247 std::map<wxString, wxString> properties = parser.ReadProperties();
248
249 uint32_t numberOfFootprints = parser.Read<uint32_t>();
250 aFootprintNames.Alloc( numberOfFootprints );
251
252 for( size_t i = 0; i < numberOfFootprints; i++ )
253 {
255
256 wxScopedCharBuffer charBuffer = parser.ReadCharBuffer();
257 wxString fpPattern( charBuffer, wxConvISO8859_1 );
258
259 auto it = patternMap.find( fpPattern );
260 if( it != patternMap.end() )
261 {
262 aFootprintNames.Add( it->second ); // Proper unicode name
263 }
264 else
265 {
267 wxString::Format( "Component name not found: '%s'", fpPattern ) );
268 }
269
270 parser.SkipSubrecord();
271 }
272
273 if( parser.HasParsingError() )
274 {
275 THROW_IO_ERROR( wxString::Format( "%s stream was not parsed correctly",
276 FormatPath( streamName ) ) );
277 }
278
279 if( parser.GetRemainingBytes() != 0 )
280 {
281 THROW_IO_ERROR( wxString::Format( "%s stream is not fully parsed",
282 FormatPath( streamName ) ) );
283 }
284 }
285 }
286 catch( CFB::CFBException& exception )
287 {
288 THROW_IO_ERROR( exception.what() );
289 }
290}
291
292
294 const wxString& aFootprintName, bool aKeepUUID,
295 const STRING_UTF8_MAP* aProperties )
296{
297 loadAltiumLibrary( aLibraryPath );
298
299 auto it = m_fplibFiles.find( aLibraryPath );
300
301 if( it == m_fplibFiles.end() )
302 THROW_IO_ERROR( wxString::Format( _( "No footprints in library '%s'" ), aLibraryPath ) );
303
304 try
305 {
306 for( std::unique_ptr<ALTIUM_PCB_COMPOUND_FILE>& altiumLibFile : it->second )
307 {
308 altiumLibFile->CacheLibModels();
309 auto [dirName, fpCfe] = altiumLibFile->FindLibFootprintDirName( aFootprintName );
310
311 if( dirName.IsEmpty() )
312 continue;
313
314 // Parse File
315 ALTIUM_PCB pcb( m_board, nullptr, m_layer_mapping_handler, m_reporter, aLibraryPath, aFootprintName );
316 return pcb.ParseFootprint( *altiumLibFile, aFootprintName );
317 }
318 }
319 catch( CFB::CFBException& exception )
320 {
321 THROW_IO_ERROR( exception.what() );
322 }
323
324 THROW_IO_ERROR( wxString::Format( _( "Footprint '%s' not found in '%s'." ),
325 aFootprintName,
326 aLibraryPath ) );
327}
std::string FormatPath(const std::vector< std::string > &aVectorPath)
Helper for debug logging (vector -> string)
size_t GetRemainingBytes() const
wxScopedCharBuffer ReadCharBuffer()
std::map< wxString, wxString > ReadProperties(std::function< std::map< wxString, wxString >(const std::string &)> handleBinaryData=[](const std::string &) { return std::map< wxString, wxString >();})
FOOTPRINT * ParseFootprint(ALTIUM_PCB_COMPOUND_FILE &altiumLibFile, const wxString &aFootprintName)
Definition: altium_pcb.cpp:658
void Parse(const ALTIUM_PCB_COMPOUND_FILE &aAltiumPcbFile, const std::map< ALTIUM_PCB_DIR, std::string > &aFileMapping)
Definition: altium_pcb.cpp:317
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:289
void SetFileName(const wxString &aFileName)
Definition: board.h:324
REPORTER * m_reporter
Reporter to log errors/warnings to, may be nullptr.
Definition: io_base.h:215
PROGRESS_REPORTER * m_progressReporter
Progress reporter to track the progress of the operation, may be nullptr.
Definition: io_base.h:218
virtual bool CanReadLibrary(const wxString &aFileName) const
Checks if this IO object can read the specified library file/directory.
Definition: io_base.cpp:69
virtual void RegisterCallback(LAYER_MAPPING_HANDLER aLayerMappingHandler)
Register a different handler to be called when mapping of input layers to KiCad layers occurs.
LAYER_MAPPING_HANDLER m_layer_mapping_handler
Callback to get layer mapping.
long long GetLibraryTimestamp(const wxString &aLibraryPath) const override
Generate a timestamp representing all the files in the library (including the library directory).
BOARD * LoadBoard(const wxString &aFileName, BOARD *aAppendToMe, const STRING_UTF8_MAP *aProperties, PROJECT *aProject=nullptr) override
Load information from some input file format that this PCB_IO implementation knows about into either ...
FOOTPRINT * FootprintLoad(const wxString &aLibraryPath, const wxString &aFootprintName, bool aKeepUUID=false, const STRING_UTF8_MAP *aProperties=nullptr) override
Load a footprint having aFootprintName from the aLibraryPath containing a library format that this PC...
std::map< wxString, std::vector< std::unique_ptr< ALTIUM_PCB_COMPOUND_FILE > > > m_fplibFiles
static bool checkFileHeader(const wxString &aFileName)
PCB_IO_ALTIUM_DESIGNER()
Pcbnew PLUGIN for Altium *.PcbDoc format.
bool CanReadBoard(const wxString &aFileName) const override
Checks if this PCB_IO can read the specified board file.
void loadAltiumLibrary(const wxString &aLibraryPath)
static std::map< wxString, PCB_LAYER_ID > DefaultLayerMappingCallback(const std::vector< INPUT_LAYER_DESC > &aInputLayerDescriptionVector)
Return the automapped layers.
void FootprintEnumerate(wxArrayString &aFootprintNames, const wxString &aLibraryPath, bool aBestEfforts, const STRING_UTF8_MAP *aProperties=nullptr) override
Return a list of footprint names contained within the library at aLibraryPath.
bool CanReadLibrary(const wxString &aFileName) const override
Checks if this IO object can read the specified library file/directory.
A base class that BOARD loading and saving plugins should derive from.
Definition: pcb_io.h:72
BOARD * m_board
The board BOARD being worked on, no ownership here.
Definition: pcb_io.h:343
const STRING_UTF8_MAP * m_props
Properties passed via Save() or Load(), no ownership, may be NULL.
Definition: pcb_io.h:346
virtual bool CanReadBoard(const wxString &aFileName) const
Checks if this PCB_IO can read the specified board file.
Definition: pcb_io.cpp:43
Container for project specific data.
Definition: project.h:62
A name/value tuple with unique names and optional values.
static REPORTER & GetInstance()
Definition: reporter.cpp:212
static void SetReporter(REPORTER *aReporter)
Set the reporter to use for reporting font substitution warnings.
Definition: fontconfig.cpp:64
#define _(s)
#define THROW_IO_ERROR(msg)
Definition: ki_exception.h:39
static const std::vector< uint8_t > COMPOUND_FILE_HEADER
Definition: io_utils.h:35
bool fileStartsWithBinaryHeader(const wxString &aFilePath, const std::vector< uint8_t > &aHeader)
Check if a file starts with a defined binary header.
Definition: io_utils.cpp:57
Describes an imported layer and how it could be mapped to KiCad Layers.