KiCad PCB EDA Suite
Loading...
Searching...
No Matches
altium_circuit_studio_plugin.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
30#include <wx/string.h>
31
34#include <altium_pcb.h>
36
37#include <board.h>
38
39#include <compoundfilereader.h>
40#include <utf.h>
41
43{
44 m_board = nullptr;
45 m_props = nullptr;
46}
47
48
50{
51}
52
53
55{
56 return wxT( "Altium Circuit Studio" );
57}
58
59
61{
62 return PLUGIN_FILE_DESC( _HKI( "Altium Circuit Studio PCB files" ), { "CSPcbDoc" } );
63}
64
65
66bool ALTIUM_CIRCUIT_STUDIO_PLUGIN::CanReadBoard( const wxString& aFileName ) const
67{
68 if( !PLUGIN::CanReadBoard( aFileName ) )
69 return false;
70
72}
73
74
75BOARD* ALTIUM_CIRCUIT_STUDIO_PLUGIN::LoadBoard( const wxString& aFileName, BOARD* aAppendToMe,
76 const STRING_UTF8_MAP* aProperties,
77 PROJECT* aProject,
78 PROGRESS_REPORTER* aProgressReporter )
79{
80 m_props = aProperties;
81
82 m_board = aAppendToMe ? aAppendToMe : new BOARD();
83
84 // Give the filename to the board if it's new
85 if( !aAppendToMe )
86 m_board->SetFileName( aFileName );
87
88 // clang-format off
89 const std::map<ALTIUM_PCB_DIR, std::string> mapping = {
90 { ALTIUM_PCB_DIR::FILE_HEADER, "FileHeader" },
91 { ALTIUM_PCB_DIR::ARCS6, "00C595EB90524FFC8C3BD9670020A2" },
92 { ALTIUM_PCB_DIR::BOARD6, "88857D7F1DF64F7BBB61848C965636" },
93 { ALTIUM_PCB_DIR::BOARDREGIONS, "8957CF30F167408D9D263D23FE7C89" },
94 { ALTIUM_PCB_DIR::CLASSES6, "847EFBF87A5149B1AA326A52AD6357" },
95 { ALTIUM_PCB_DIR::COMPONENTS6, "465416896A15486999A39C643935D2" },
96 { ALTIUM_PCB_DIR::COMPONENTBODIES6, "1849D9B5512D452A93EABF4E40B122" }, // or B6AD30D75241498BA2536EBF001752 ?
97 { ALTIUM_PCB_DIR::DIMENSIONS6, "16C81DBC13C447FF8B42A426677F3C" },
98 { ALTIUM_PCB_DIR::FILLS6, "4E83BDC3253747F08E9006D7F57020" },
99 { ALTIUM_PCB_DIR::MODELS, "C0F7599ECC6A4D648DF5BB557679AF" },
100 { ALTIUM_PCB_DIR::NETS6, "D95A0DA2FE9047779A5194C127F30B" },
101 { ALTIUM_PCB_DIR::PADS6, "47D69BC5107A4B8DB8DAA23E39C238" },
102 { ALTIUM_PCB_DIR::POLYGONS6, "D7038392280E4E229B9D9B5426B295" },
103 { ALTIUM_PCB_DIR::REGIONS6, "FFDDC21382BB42FE8A7D0C328D272C" },
104 { ALTIUM_PCB_DIR::RULES6, "48B2FA96DB7546818752B34373D6C6" },
105 { ALTIUM_PCB_DIR::SHAPEBASEDREGIONS6, "D5F54B536E124FB89E2D51B1121508" },
106 { ALTIUM_PCB_DIR::TEXTS6, "349ABBB211DB4F5B8AE41B1B49555A" },
107 { ALTIUM_PCB_DIR::TRACKS6, "530C20C225354B858B2578CAB8C08D" },
108 { ALTIUM_PCB_DIR::VIAS6, "CA5F5989BCDB404DA70A9D1D3D5758" },
109 { ALTIUM_PCB_DIR::WIDESTRINGS6, "87FBF0C5BC194B909FF42199450A76" }
110 };
111 // clang-format on
112
113 ALTIUM_COMPOUND_FILE altiumPcbFile( aFileName );
114
115 try
116 {
117 // Parse File
118 ALTIUM_PCB pcb( m_board, aProgressReporter );
119 pcb.Parse( altiumPcbFile, mapping );
120 }
121 catch( CFB::CFBException& exception )
122 {
123 THROW_IO_ERROR( exception.what() );
124 }
125
126 return m_board;
127}
PLUGIN_FILE_DESC GetBoardFileDesc() const override
Returns board file description for the PLUGIN.
BOARD * LoadBoard(const wxString &aFileName, BOARD *aAppendToMe, const STRING_UTF8_MAP *aProperties, PROJECT *aProject, PROGRESS_REPORTER *aProgressReporter=nullptr) override
Load information from some input file format that this PLUGIN implementation knows about into either ...
bool CanReadBoard(const wxString &aFileName) const override
Checks if this PLUGIN can read the specified board file.
const wxString PluginName() const override
Return a brief hard coded name for this PLUGIN.
static bool checkFileHeader(const wxString &aFileName)
void Parse(const ALTIUM_COMPOUND_FILE &aAltiumPcbFile, const std::map< ALTIUM_PCB_DIR, std::string > &aFileMapping)
Definition: altium_pcb.cpp:298
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:271
void SetFileName(const wxString &aFileName)
Definition: board.h:306
virtual bool CanReadBoard(const wxString &aFileName) const
Checks if this PLUGIN can read the specified board file.
Definition: plugin.cpp:61
A progress reporter interface for use in multi-threaded environments.
Container for project specific data.
Definition: project.h:62
A name/value tuple with unique names and optional values.
#define _HKI(x)
#define THROW_IO_ERROR(msg)
Definition: ki_exception.h:39
Container that describes file type info.