7
mirror of https://gitlab.com/kicad/code/kicad.git synced 2024-11-25 08:45:00 +00:00
kicad/pcbnew/pcb_io/altium/altium_pcb_compound_file.h
Seth Hillbrand 77797103f7 Add ability to embed files in various elements
Schematics, symbols, boards and footprints all get the ability to store
files inside their file structures.  File lookups now have a
kicad-embed:// URI to allow various parts of KiCad to refer to files
stored in this manner.

kicad-embed://datasheet.pdf references the file named "datasheet.pdf"
embedded in the document.  Embeds are allowed in schematics, boards,
symbols and footprints.  Currently supported embeddings are Datasheets,
3D Models and drawingsheets

Fixes https://gitlab.com/kicad/code/kicad/-/issues/6918

Fixes https://gitlab.com/kicad/code/kicad/-/issues/2376

Fixes https://gitlab.com/kicad/code/kicad/-/issues/17827
2024-07-15 16:06:55 -07:00

56 lines
2.0 KiB
C++

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2024 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, you may find one here:
* http://www.gnu.org/licenses/gpl-3.0.html
* or you may search the http://www.gnu.org website for the version 3 license,
* or you may write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#ifndef ALTIUM_PCB_COMPOUND_FILE_H
#define ALTIUM_PCB_COMPOUND_FILE_H
#include <memory>
#include <altium_parser_pcb.h>
#include <io/altium/altium_binary_parser.h>
class ALTIUM_PCB_COMPOUND_FILE : public ALTIUM_COMPOUND_FILE
{
public:
ALTIUM_PCB_COMPOUND_FILE( const wxString& aFilePath );
ALTIUM_PCB_COMPOUND_FILE( const void* aBuffer, size_t aLen );
~ALTIUM_PCB_COMPOUND_FILE();
std::map<wxString, wxString> ListLibFootprints();
std::tuple<wxString, const CFB::COMPOUND_FILE_ENTRY*> FindLibFootprintDirName( const wxString& aFpUnicodeName );
const std::pair<AMODEL, std::vector<char>>* GetLibModel( const wxString& aModelID ) const;
bool CacheLibModels();
private:
void cacheLibFootprintNames();
std::map<wxString, const CFB::COMPOUND_FILE_ENTRY*> m_libFootprintNameCache;
std::map<wxString, wxString> m_libFootprintDirNameCache;
std::map<wxString, std::pair<AMODEL, std::vector<char>>> m_libModelsCache;
};
#endif // ALTIUM_PCB_COMPOUND_FILE_H