remote_symbol_import_utils.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * 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/>.
 */
 
#ifndef REMOTE_SYMBOL_IMPORT_UTILS_H
#define REMOTE_SYMBOL_IMPORT_UTILS_H
 
#include <cstdint>
#include <memory>
#include <vector>
 
#include <lib_id.h>
 
#include <wx/filename.h>
#include <wx/string.h>
 
class LIB_SYMBOL;
class SCH_EDIT_FRAME;
enum class LIBRARY_TABLE_TYPE;
 

wxString SanitizeRemoteFileComponent( const wxString& aValue, const wxString& aDefault,
                                      bool aLower = false );

wxString RemoteLibraryPrefix();

bool WriteRemoteBinaryFile( const wxFileName& aOutput, const std::vector<uint8_t>& aPayload,
                            wxString& aError );

bool EnsureRemoteDestinationRoot( wxFileName& aOutDir, wxString& aError );

bool EnsureRemoteLibraryEntry( LIBRARY_TABLE_TYPE aTableType, const wxFileName& aLibraryPath,
                                const wxString& aNickname, bool aGlobalTable, bool aStrict,
                                wxString& aError );

bool PlaceRemoteDownloadedSymbol( SCH_EDIT_FRAME* aFrame, const wxString& aNickname,
                                  const wxString& aLibItemName, wxString& aError );

std::unique_ptr<LIB_SYMBOL> LoadRemoteSymbolFromPayload( const std::vector<uint8_t>& aPayload,
                                                        const wxString& aLibItemName,
                                                        wxString& aError );

LIB_ID BuildRemoteLibId( const wxString& aResolvedLibrary, const wxString& aResolvedItemName );

void ApplyFootprintLinks( LIB_SYMBOL& aSymbol, const std::vector<LIB_ID>& aLinks );
 
#endif // REMOTE_SYMBOL_IMPORT_UTILS_H