KiCad PCB EDA Suite
Loading...
Searching...
No Matches
easyedapro_import_utils.h
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) 2023 Alex Shvartzkop <[email protected]>
5 * Copyright (C) 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
25#ifndef EASYEDAPRO_IMPORT_UTILS_H_
26#define EASYEDAPRO_IMPORT_UTILS_H_
27
28#include <set>
29#include <wx/stream.h>
30#include <wx/string.h>
31#include <lib_id.h>
32#include <nlohmann/json_fwd.hpp>
33
35
36#define EASY_IT_CONTINUE return false
37#define EASY_IT_BREAK return true
38
39namespace EASYEDAPRO
40{
41
42wxString ShortenLibName( wxString aProjectName );
43
44LIB_ID ToKiCadLibID( const wxString& aLibName, const wxString& aLibReference );
45
46std::vector<IMPORT_PROJECT_DESC> ProjectToSelectorDialog( const nlohmann::json& aProject,
47 bool aPcbOnly = false,
48 bool aSchOnly = false );
49
50nlohmann::json FindJsonFile( const wxString& aZipFileName, const std::set<wxString>& aFileNames );
51
52nlohmann::json ReadProjectOrDeviceFile( const wxString& aZipFileName );
53
55 const wxString& aFileName,
56 std::function<bool( const wxString&, const wxString&, wxInputStream& )> aCallback );
57
58std::vector<nlohmann::json> ParseJsonLines( wxInputStream& aInput, const wxString& aSource );
59
60} // namespace EASYEDAPRO
61
62
63#endif // EASYEDAPRO_IMPORT_UTILS_H_
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:49
LIB_ID ToKiCadLibID(const wxString &aLibName, const wxString &aLibReference)
void IterateZipFiles(const wxString &aFileName, std::function< bool(const wxString &, const wxString &, wxInputStream &)> aCallback)
std::vector< nlohmann::json > ParseJsonLines(wxInputStream &aInput, const wxString &aSource)
nlohmann::json FindJsonFile(const wxString &aZipFileName, const std::set< wxString > &aFileNames)
std::vector< IMPORT_PROJECT_DESC > ProjectToSelectorDialog(const nlohmann::json &aProject, bool aPcbOnly=false, bool aSchOnly=false)
nlohmann::json ReadProjectOrDeviceFile(const wxString &aZipFileName)
wxString ShortenLibName(wxString aProjectName)
Describes how non-KiCad boards and schematics should be imported as KiCad projects.