diff --git a/3d-viewer/3d_cache/3d_cache.cpp b/3d-viewer/3d_cache/3d_cache.cpp
index 33c04d0fff..b016b15e73 100644
--- a/3d-viewer/3d_cache/3d_cache.cpp
+++ b/3d-viewer/3d_cache/3d_cache.cpp
@@ -202,12 +202,12 @@ S3D_CACHE::~S3D_CACHE()
SCENEGRAPH* S3D_CACHE::load( const wxString& aModelFile, const wxString& aBasePath,
- S3D_CACHE_ENTRY** aCachePtr )
+ S3D_CACHE_ENTRY** aCachePtr, const EMBEDDED_FILES* aEmbeddedFiles )
{
if( aCachePtr )
*aCachePtr = nullptr;
- wxString full3Dpath = m_FNResolver->ResolvePath( aModelFile, aBasePath );
+ wxString full3Dpath = m_FNResolver->ResolvePath( aModelFile, aBasePath, aEmbeddedFiles );
if( full3Dpath.empty() )
{
@@ -272,9 +272,9 @@ SCENEGRAPH* S3D_CACHE::load( const wxString& aModelFile, const wxString& aBasePa
}
-SCENEGRAPH* S3D_CACHE::Load( const wxString& aModelFile, const wxString& aBasePath )
+SCENEGRAPH* S3D_CACHE::Load( const wxString& aModelFile, const wxString& aBasePath, const EMBEDDED_FILES* aEmbeddedFiles )
{
- return load( aModelFile, aBasePath );
+ return load( aModelFile, aBasePath, nullptr, aEmbeddedFiles );
}
@@ -631,10 +631,11 @@ void S3D_CACHE::ClosePlugins()
}
-S3DMODEL* S3D_CACHE::GetModel( const wxString& aModelFileName, const wxString& aBasePath )
+S3DMODEL* S3D_CACHE::GetModel( const wxString& aModelFileName, const wxString& aBasePath,
+ const EMBEDDED_FILES* aEmbeddedFiles )
{
S3D_CACHE_ENTRY* cp = nullptr;
- SCENEGRAPH* sp = load( aModelFileName, aBasePath,&cp );
+ SCENEGRAPH* sp = load( aModelFileName, aBasePath, &cp, aEmbeddedFiles );
if( !sp )
return nullptr;
diff --git a/3d-viewer/3d_cache/3d_cache.h b/3d-viewer/3d_cache/3d_cache.h
index 4abc62e78b..16268ab9a5 100644
--- a/3d-viewer/3d_cache/3d_cache.h
+++ b/3d-viewer/3d_cache/3d_cache.h
@@ -38,6 +38,7 @@
#include <project.h>
#include <wx/string.h>
+class EMBEDDED_FILES;
class PGM_BASE;
class S3D_CACHE_ENTRY;
class SCENEGRAPH;
@@ -93,9 +94,10 @@ public:
*
* @param aModelFile is the partial or full path to the model to be loaded.
* @param aBasePath is the path to search for any relative files
+ * @param aEmbeddedFiles is a pointer to the embedded files list.
* @return true if the model was successfully loaded, otherwise false.
*/
- SCENEGRAPH* Load( const wxString& aModelFile, const wxString& aBasePath );
+ SCENEGRAPH* Load( const wxString& aModelFile, const wxString& aBasePath, const EMBEDDED_FILES* aEmbeddedFiles );
FILENAME_RESOLVER* GetResolver() noexcept;
@@ -123,9 +125,11 @@ public:
* structure for display by a renderer.
*
* @param aModelFileName is the full path to the model to be loaded.
+ * @param aBasePath is the path to search for any relative files.
+ * @param aEmbeddedFiles is a pointer to the embedded files list.
* @return is a pointer to the render data or NULL if not available.
*/
- S3DMODEL* GetModel( const wxString& aModelFileName, const wxString& aBasePath );
+ S3DMODEL* GetModel( const wxString& aModelFileName, const wxString& aBasePath, const EMBEDDED_FILES* aEmbeddedFiles );
/**
* Delete up old cache files in cache directory.
@@ -165,7 +169,9 @@ private:
bool saveCacheData( S3D_CACHE_ENTRY* aCacheItem );
// the real load function (can supply a cache entry pointer to member functions)
- SCENEGRAPH* load( const wxString& aModelFile, const wxString& aBasePath, S3D_CACHE_ENTRY** aCachePtr = nullptr );
+ SCENEGRAPH* load( const wxString& aModelFile, const wxString& aBasePath,
+ S3D_CACHE_ENTRY** aCachePtr = nullptr,
+ const EMBEDDED_FILES* aEmbeddedFiles = nullptr );
/// cache entries
std::list< S3D_CACHE_ENTRY* > m_CacheList;
diff --git a/3d-viewer/3d_model_viewer/eda_3d_model_viewer.cpp b/3d-viewer/3d_model_viewer/eda_3d_model_viewer.cpp
index fc1b7eaf72..9b1824672b 100644
--- a/3d-viewer/3d_model_viewer/eda_3d_model_viewer.cpp
+++ b/3d-viewer/3d_model_viewer/eda_3d_model_viewer.cpp
@@ -156,7 +156,7 @@ void EDA_3D_MODEL_VIEWER::Set3DModel( const wxString& aModelPathName)
if( m_cacheManager )
{
- const S3DMODEL* model = m_cacheManager->GetModel( aModelPathName, wxEmptyString );
+ const S3DMODEL* model = m_cacheManager->GetModel( aModelPathName, wxEmptyString, nullptr );
if( model )
Set3DModel( (const S3DMODEL &)*model );
diff --git a/3d-viewer/3d_model_viewer/eda_3d_model_viewer.h b/3d-viewer/3d_model_viewer/eda_3d_model_viewer.h
index a85fc66a06..161597dc4d 100644
--- a/3d-viewer/3d_model_viewer/eda_3d_model_viewer.h
+++ b/3d-viewer/3d_model_viewer/eda_3d_model_viewer.h
@@ -66,7 +66,9 @@ public:
/**
* Set this model to be displayed.
*
- * @param aModelPathName 3D model path name.
+ * N.B. This will not load a model from the internal cache. Only from on disk.
+ *
+ * @param aModelPathName 3D model path name. Must be a file on disk.
*/
void Set3DModel( const wxString& aModelPathName );
diff --git a/3d-viewer/3d_rendering/opengl/create_scene.cpp b/3d-viewer/3d_rendering/opengl/create_scene.cpp
index f2faab5c69..3079dd4ed3 100644
--- a/3d-viewer/3d_rendering/opengl/create_scene.cpp
+++ b/3d-viewer/3d_rendering/opengl/create_scene.cpp
@@ -974,7 +974,7 @@ void RENDER_3D_OPENGL::load3dModels( REPORTER* aStatusReporter )
{
// It is not present, try get it from cache
const S3DMODEL* modelPtr =
- m_boardAdapter.Get3dCacheManager()->GetModel( fp_model.m_Filename, footprintBasePath );
+ m_boardAdapter.Get3dCacheManager()->GetModel( fp_model.m_Filename, footprintBasePath, footprint );
// only add it if the return is not NULL
if( modelPtr )
diff --git a/3d-viewer/3d_rendering/raytracing/create_scene.cpp b/3d-viewer/3d_rendering/raytracing/create_scene.cpp
index a2cbc78c56..3ceacc0acd 100644
--- a/3d-viewer/3d_rendering/raytracing/create_scene.cpp
+++ b/3d-viewer/3d_rendering/raytracing/create_scene.cpp
@@ -1247,8 +1247,6 @@ void RENDER_3D_RAYTRACE_BASE::load3DModels( CONTAINER_3D& aDstContainer, bool aS
// Get the list of model files for this model
S3D_CACHE* cacheMgr = m_boardAdapter.Get3dCacheManager();
- auto sM = fp->Models().begin();
- auto eM = fp->Models().end();
wxString libraryName = fp->GetFPID().GetLibNickname();
@@ -1271,44 +1269,38 @@ void RENDER_3D_RAYTRACE_BASE::load3DModels( CONTAINER_3D& aDstContainer, bool aS
}
}
- while( sM != eM )
+ for( FP_3DMODEL& model : fp->Models() )
{
- if( ( static_cast<float>( sM->m_Opacity ) > FLT_EPSILON )
- && ( sM->m_Show && !sM->m_Filename.empty() ) )
+ // get it from cache
+ const S3DMODEL* modelPtr =
+ cacheMgr->GetModel( model.m_Filename, footprintBasePath, fp );
+
+ // only add it if the return is not NULL.
+ if( modelPtr )
{
- // get it from cache
- const S3DMODEL* modelPtr =
- cacheMgr->GetModel( sM->m_Filename, footprintBasePath );
+ glm::mat4 modelMatrix = fpMatrix;
- // only add it if the return is not NULL.
- if( modelPtr )
- {
- glm::mat4 modelMatrix = fpMatrix;
+ modelMatrix = glm::translate( modelMatrix,
+ SFVEC3F( model.m_Offset.x, model.m_Offset.y, model.m_Offset.z ) );
- modelMatrix = glm::translate( modelMatrix,
- SFVEC3F( sM->m_Offset.x, sM->m_Offset.y, sM->m_Offset.z ) );
+ modelMatrix = glm::rotate( modelMatrix,
+ (float) -( model.m_Rotation.z / 180.0f ) * glm::pi<float>(),
+ SFVEC3F( 0.0f, 0.0f, 1.0f ) );
- modelMatrix = glm::rotate( modelMatrix,
- (float) -( sM->m_Rotation.z / 180.0f ) * glm::pi<float>(),
- SFVEC3F( 0.0f, 0.0f, 1.0f ) );
+ modelMatrix = glm::rotate( modelMatrix,
+ (float) -( model.m_Rotation.y / 180.0f ) * glm::pi<float>(),
+ SFVEC3F( 0.0f, 1.0f, 0.0f ) );
- modelMatrix = glm::rotate( modelMatrix,
- (float) -( sM->m_Rotation.y / 180.0f ) * glm::pi<float>(),
- SFVEC3F( 0.0f, 1.0f, 0.0f ) );
+ modelMatrix = glm::rotate( modelMatrix,
+ (float) -( model.m_Rotation.x / 180.0f ) * glm::pi<float>(),
+ SFVEC3F( 1.0f, 0.0f, 0.0f ) );
- modelMatrix = glm::rotate( modelMatrix,
- (float) -( sM->m_Rotation.x / 180.0f ) * glm::pi<float>(),
- SFVEC3F( 1.0f, 0.0f, 0.0f ) );
+ modelMatrix = glm::scale( modelMatrix,
+ SFVEC3F( model.m_Scale.x, model.m_Scale.y, model.m_Scale.z ) );
- modelMatrix = glm::scale( modelMatrix,
- SFVEC3F( sM->m_Scale.x, sM->m_Scale.y, sM->m_Scale.z ) );
-
- addModels( aDstContainer, modelPtr, modelMatrix, (float) sM->m_Opacity,
- aSkipMaterialInformation, boardItem );
- }
+ addModels( aDstContainer, modelPtr, modelMatrix, (float) model.m_Opacity,
+ aSkipMaterialInformation, boardItem );
}
-
- ++sM;
}
}
}
diff --git a/3d-viewer/CMakeLists.txt b/3d-viewer/CMakeLists.txt
index 73db487ad9..23a2c75b03 100644
--- a/3d-viewer/CMakeLists.txt
+++ b/3d-viewer/CMakeLists.txt
@@ -91,7 +91,6 @@ set(3D-VIEWER_SRCS
common_ogl/ogl_utils.cpp
3d_fastmath.cpp
3d_math.cpp
- dialogs/3d_cache_dialogs.cpp
dialogs/appearance_controls_3D.cpp
dialogs/appearance_controls_3D_base.cpp
dialogs/dialog_select_3d_model_base.cpp
diff --git a/3d-viewer/dialogs/3d_cache_dialogs.cpp b/3d-viewer/dialogs/3d_cache_dialogs.cpp
deleted file mode 100644
index 676726141f..0000000000
--- a/3d-viewer/dialogs/3d_cache_dialogs.cpp
+++ /dev/null
@@ -1,52 +0,0 @@
-/*
- * This program source code file is part of KiCad, a free EDA CAD application.
- *
- * Copyright (C) 2015-2016 Cirilo Bernardo <cirilo.bernardo@gmail.com>
- * Copyright (C) 2020-2021 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 2
- * 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/old-licenses/gpl-2.0.html
- * or you may search the http://www.gnu.org website for the version 2 license,
- * or you may write to the Free Software Foundation, Inc.,
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
- */
-
-#include <dialogs/dialog_configure_paths.h>
-
-#include "3d_info.h"
-#include "3d_cache.h"
-#include "3d_cache_dialogs.h"
-#include "dialog_select_3d_model.h"
-
-
-bool S3D::Select3DModel( wxWindow* aParent, S3D_CACHE* aCache, wxString& prevModelSelectDir,
- int& prevModelWildcard, FP_3DMODEL* aModel )
-{
- if( nullptr == aModel )
- return false;
-
- DIALOG_SELECT_3DMODEL dm( aParent, aCache, aModel, prevModelSelectDir, prevModelWildcard );
-
- // Use QuasiModal so that Configure3DPaths (and its help window) will work
- return dm.ShowQuasiModal() == wxID_OK;
-}
-
-
-bool S3D::Configure3DPaths( wxWindow* aParent, FILENAME_RESOLVER* aResolver )
-{
- DIALOG_CONFIGURE_PATHS dlg( aParent );
-
- // Use QuasiModal so that HTML help window will work
- return( dlg.ShowQuasiModal() == wxID_OK );
-}
diff --git a/3d-viewer/dialogs/3d_cache_dialogs.h b/3d-viewer/dialogs/3d_cache_dialogs.h
deleted file mode 100644
index 89412255f0..0000000000
--- a/3d-viewer/dialogs/3d_cache_dialogs.h
+++ /dev/null
@@ -1,40 +0,0 @@
-/*
- * This program source code file is part of KiCad, a free EDA CAD application.
- *
- * Copyright (C) 2015 Cirilo Bernardo <cirilo.bernardo@gmail.com>
- *
- * 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 2
- * 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/old-licenses/gpl-2.0.html
- * or you may search the http://www.gnu.org website for the version 2 license,
- * or you may write to the Free Software Foundation, Inc.,
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
- */
-
-#ifndef CACHE_DIALOGS_3D_H
-#define CACHE_DIALOGS_3D_H
-
-#include <wx/window.h>
-
-class S3D_CACHE;
-class FILENAME_RESOLVER;
-
-namespace S3D
-{
- bool Select3DModel( wxWindow* aParent, S3D_CACHE* aCache, wxString& prevModelSelectDir,
- int& prevModelWildcard, FP_3DMODEL* aModel );
-
- bool Configure3DPaths( wxWindow* aParent, FILENAME_RESOLVER* aResolver );
-}
-
-#endif // CACHE_DIALOGS_3D_H
diff --git a/3d-viewer/dialogs/dialog_select_3d_model.cpp b/3d-viewer/dialogs/dialog_select_3d_model.cpp
index c1a1452c40..3c3d7f272f 100644
--- a/3d-viewer/dialogs/dialog_select_3d_model.cpp
+++ b/3d-viewer/dialogs/dialog_select_3d_model.cpp
@@ -29,9 +29,9 @@
#include "project.h"
#include "3d_cache/3d_info.h"
#include "3d_cache/3d_cache.h"
-#include "3d_cache_dialogs.h"
#include <3d_model_viewer/eda_3d_model_viewer.h>
#include <common_ogl/ogl_attr_list.h>
+#include <dialogs/dialog_configure_paths.h>
#include <filename_resolver.h>
#include <pcbnew/footprint.h>
#include <wx_filename.h>
@@ -197,7 +197,9 @@ void DIALOG_SELECT_3DMODEL::SetRootDir( wxCommandEvent& event )
void DIALOG_SELECT_3DMODEL::Cfg3DPaths( wxCommandEvent& event )
{
- if( S3D::Configure3DPaths( this, m_resolver ) )
+ DIALOG_CONFIGURE_PATHS dlg( this );
+
+ if( dlg.ShowQuasiModal() == wxID_OK )
updateDirChoiceList();
}
diff --git a/3d-viewer/dialogs/dialog_select_3d_model.h b/3d-viewer/dialogs/dialog_select_3d_model.h
index 29c8d7fd1a..7445d9f184 100644
--- a/3d-viewer/dialogs/dialog_select_3d_model.h
+++ b/3d-viewer/dialogs/dialog_select_3d_model.h
@@ -44,6 +44,11 @@ public:
void SetRootDir( wxCommandEvent& event ) override;
void Cfg3DPaths( wxCommandEvent& event ) override;
+ bool IsEmbedded3DModel() const
+ {
+ return m_EmbedModelCb->IsChecked();
+ }
+
private:
void updateDirChoiceList( void );
diff --git a/3d-viewer/dialogs/dialog_select_3d_model_base.cpp b/3d-viewer/dialogs/dialog_select_3d_model_base.cpp
index 5e1825dfc0..620526b281 100644
--- a/3d-viewer/dialogs/dialog_select_3d_model_base.cpp
+++ b/3d-viewer/dialogs/dialog_select_3d_model_base.cpp
@@ -1,5 +1,5 @@
///////////////////////////////////////////////////////////////////////////
-// C++ code generated with wxFormBuilder (version 3.10.1-0-g8feb16b)
+// C++ code generated with wxFormBuilder (version 4.0.0-0-g0efcecf0)
// http://www.wxformbuilder.org/
//
// PLEASE DO *NOT* EDIT THIS FILE!
@@ -35,6 +35,12 @@ DIALOG_SELECT_3D_MODEL_BASE::DIALOG_SELECT_3D_MODEL_BASE( wxWindow* parent, wxWi
bSizerLeft->Add( m_FileTree, 1, wxALL|wxEXPAND, 5 );
+ wxBoxSizer* bSizer7;
+ bSizer7 = new wxBoxSizer( wxHORIZONTAL );
+
+
+ bSizerLeft->Add( bSizer7, 0, wxEXPAND, 5 );
+
m_panelLeft->SetSizer( bSizerLeft );
m_panelLeft->Layout();
@@ -70,6 +76,15 @@ DIALOG_SELECT_3D_MODEL_BASE::DIALOG_SELECT_3D_MODEL_BASE( wxWindow* parent, wxWi
bSizerMain->Add( bSizerLower, 0, wxEXPAND, 5 );
+ wxBoxSizer* bSizer6;
+ bSizer6 = new wxBoxSizer( wxHORIZONTAL );
+
+ m_EmbedModelCb = new wxCheckBox( this, wxID_ANY, _("Embed Model"), wxDefaultPosition, wxDefaultSize, 0 );
+ bSizer6->Add( m_EmbedModelCb, 0, wxALL, 5 );
+
+
+ bSizer6->Add( 0, 0, 1, wxEXPAND, 5 );
+
m_sdbSizer = new wxStdDialogButtonSizer();
m_sdbSizerOK = new wxButton( this, wxID_OK );
m_sdbSizer->AddButton( m_sdbSizerOK );
@@ -77,7 +92,10 @@ DIALOG_SELECT_3D_MODEL_BASE::DIALOG_SELECT_3D_MODEL_BASE( wxWindow* parent, wxWi
m_sdbSizer->AddButton( m_sdbSizerCancel );
m_sdbSizer->Realize();
- bSizerMain->Add( m_sdbSizer, 0, wxEXPAND|wxALL, 5 );
+ bSizer6->Add( m_sdbSizer, 0, wxEXPAND|wxALL, 5 );
+
+
+ bSizerMain->Add( bSizer6, 0, wxEXPAND, 5 );
this->SetSizer( bSizerMain );
diff --git a/3d-viewer/dialogs/dialog_select_3d_model_base.fbp b/3d-viewer/dialogs/dialog_select_3d_model_base.fbp
index 5d4b0626ec..b0293cf861 100644
--- a/3d-viewer/dialogs/dialog_select_3d_model_base.fbp
+++ b/3d-viewer/dialogs/dialog_select_3d_model_base.fbp
@@ -1,554 +1,659 @@
-<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<wxFormBuilder_Project>
- <FileVersion major="1" minor="16" />
- <object class="Project" expanded="1">
- <property name="class_decoration">; </property>
- <property name="code_generation">C++</property>
- <property name="disconnect_events">1</property>
- <property name="disconnect_mode">source_name</property>
- <property name="disconnect_php_events">0</property>
- <property name="disconnect_python_events">0</property>
- <property name="embedded_files_path">res</property>
- <property name="encoding">UTF-8</property>
- <property name="event_generation">connect</property>
- <property name="file">dialog_select_3d_model_base</property>
- <property name="first_id">1000</property>
- <property name="help_provider">none</property>
- <property name="image_path_wrapper_function_name"></property>
- <property name="indent_with_spaces"></property>
- <property name="internationalize">1</property>
- <property name="name">dialog_select_3d_model_base</property>
- <property name="namespace"></property>
- <property name="path">.</property>
- <property name="precompiled_header"></property>
- <property name="relative_path">1</property>
- <property name="skip_lua_events">1</property>
- <property name="skip_php_events">1</property>
- <property name="skip_python_events">1</property>
- <property name="ui_table">UI</property>
- <property name="use_array_enum">0</property>
- <property name="use_enum">0</property>
- <property name="use_microsoft_bom">0</property>
- <object class="Dialog" expanded="1">
- <property name="aui_managed">0</property>
- <property name="aui_manager_style">wxAUI_MGR_DEFAULT</property>
- <property name="bg"></property>
- <property name="center">wxBOTH</property>
- <property name="context_help"></property>
- <property name="context_menu">1</property>
- <property name="enabled">1</property>
- <property name="event_handler">impl_virtual</property>
- <property name="extra_style"></property>
- <property name="fg"></property>
- <property name="font"></property>
- <property name="hidden">0</property>
- <property name="id">wxID_ANY</property>
- <property name="maximum_size"></property>
- <property name="minimum_size"></property>
- <property name="name">DIALOG_SELECT_3D_MODEL_BASE</property>
- <property name="pos"></property>
- <property name="size">-1,-1</property>
- <property name="style">wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER</property>
- <property name="subclass">DIALOG_SHIM; dialog_shim.h; forward_declare</property>
- <property name="title">Select 3D Model</property>
- <property name="tooltip"></property>
- <property name="two_step_creation">0</property>
- <property name="window_extra_style"></property>
- <property name="window_name"></property>
- <property name="window_style"></property>
- <object class="wxBoxSizer" expanded="1">
+ <FileVersion major="1" minor="17"/>
+ <object class="Project" expanded="true">
+ <property name="class_decoration">; </property>
+ <property name="code_generation">C++</property>
+ <property name="disconnect_events">1</property>
+ <property name="disconnect_mode">source_name</property>
+ <property name="disconnect_php_events">0</property>
+ <property name="disconnect_python_events">0</property>
+ <property name="embedded_files_path">res</property>
+ <property name="encoding">UTF-8</property>
+ <property name="event_generation">connect</property>
+ <property name="file">dialog_select_3d_model_base</property>
+ <property name="first_id">1000</property>
+ <property name="help_provider">none</property>
+ <property name="image_path_wrapper_function_name"></property>
+ <property name="indent_with_spaces"></property>
+ <property name="internationalize">1</property>
+ <property name="name">dialog_select_3d_model_base</property>
+ <property name="namespace"></property>
+ <property name="path">.</property>
+ <property name="precompiled_header"></property>
+ <property name="relative_path">1</property>
+ <property name="skip_lua_events">1</property>
+ <property name="skip_php_events">1</property>
+ <property name="skip_python_events">1</property>
+ <property name="ui_table">UI</property>
+ <property name="use_array_enum">0</property>
+ <property name="use_enum">0</property>
+ <property name="use_microsoft_bom">0</property>
+ <object class="Dialog" expanded="true">
+ <property name="aui_managed">0</property>
+ <property name="aui_manager_style">wxAUI_MGR_DEFAULT</property>
+ <property name="bg"></property>
+ <property name="center">wxBOTH</property>
+ <property name="context_help"></property>
+ <property name="context_menu">1</property>
+ <property name="drag_accept_files">0</property>
+ <property name="enabled">1</property>
+ <property name="event_handler">impl_virtual</property>
+ <property name="extra_style"></property>
+ <property name="fg"></property>
+ <property name="font"></property>
+ <property name="hidden">0</property>
+ <property name="id">wxID_ANY</property>
+ <property name="maximum_size"></property>
+ <property name="minimum_size"></property>
+ <property name="name">DIALOG_SELECT_3D_MODEL_BASE</property>
+ <property name="pos"></property>
+ <property name="size">-1,-1</property>
+ <property name="style">wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER</property>
+ <property name="subclass">DIALOG_SHIM; dialog_shim.h; forward_declare</property>
+ <property name="title">Select 3D Model</property>
+ <property name="tooltip"></property>
+ <property name="two_step_creation">0</property>
+ <property name="window_extra_style"></property>
+ <property name="window_name"></property>
+ <property name="window_style"></property>
+ <object class="wxBoxSizer" expanded="true">
+ <property name="minimum_size"></property>
+ <property name="name">bSizerMain</property>
+ <property name="orient">wxVERTICAL</property>
+ <property name="permission">none</property>
+ <object class="sizeritem" expanded="true">
+ <property name="border">5</property>
+ <property name="flag">wxEXPAND</property>
+ <property name="proportion">1</property>
+ <object class="wxBoxSizer" expanded="true">
+ <property name="minimum_size">-1,400</property>
+ <property name="name">bSizerUpper</property>
+ <property name="orient">wxHORIZONTAL</property>
+ <property name="permission">none</property>
+ <object class="sizeritem" expanded="true">
+ <property name="border">5</property>
+ <property name="flag">wxEXPAND</property>
+ <property name="proportion">1</property>
+ <object class="wxSplitterWindow" expanded="true">
+ <property name="BottomDockable">1</property>
+ <property name="LeftDockable">1</property>
+ <property name="RightDockable">1</property>
+ <property name="TopDockable">1</property>
+ <property name="aui_layer"></property>
+ <property name="aui_name"></property>
+ <property name="aui_position"></property>
+ <property name="aui_row"></property>
+ <property name="best_size"></property>
+ <property name="bg"></property>
+ <property name="caption"></property>
+ <property name="caption_visible">1</property>
+ <property name="center_pane">0</property>
+ <property name="close_button">1</property>
+ <property name="context_help"></property>
+ <property name="context_menu">1</property>
+ <property name="default_pane">0</property>
+ <property name="dock">Dock</property>
+ <property name="dock_fixed">0</property>
+ <property name="docking">Left</property>
+ <property name="drag_accept_files">0</property>
+ <property name="enabled">1</property>
+ <property name="fg"></property>
+ <property name="floatable">1</property>
+ <property name="font"></property>
+ <property name="gripper">0</property>
+ <property name="hidden">0</property>
+ <property name="id">wxID_ANY</property>
+ <property name="max_size"></property>
+ <property name="maximize_button">0</property>
+ <property name="maximum_size"></property>
+ <property name="min_pane_size">0</property>
+ <property name="min_size"></property>
+ <property name="minimize_button">0</property>
<property name="minimum_size"></property>
- <property name="name">bSizerMain</property>
- <property name="orient">wxVERTICAL</property>
- <property name="permission">none</property>
- <object class="sizeritem" expanded="1">
- <property name="border">5</property>
- <property name="flag">wxEXPAND</property>
- <property name="proportion">1</property>
- <object class="wxBoxSizer" expanded="1">
- <property name="minimum_size">-1,400</property>
- <property name="name">bSizerUpper</property>
- <property name="orient">wxHORIZONTAL</property>
- <property name="permission">none</property>
- <object class="sizeritem" expanded="1">
- <property name="border">5</property>
- <property name="flag">wxEXPAND</property>
- <property name="proportion">1</property>
- <object class="wxSplitterWindow" expanded="1">
- <property name="BottomDockable">1</property>
- <property name="LeftDockable">1</property>
- <property name="RightDockable">1</property>
- <property name="TopDockable">1</property>
- <property name="aui_layer"></property>
- <property name="aui_name"></property>
- <property name="aui_position"></property>
- <property name="aui_row"></property>
- <property name="best_size"></property>
- <property name="bg"></property>
- <property name="caption"></property>
- <property name="caption_visible">1</property>
- <property name="center_pane">0</property>
- <property name="close_button">1</property>
- <property name="context_help"></property>
- <property name="context_menu">1</property>
- <property name="default_pane">0</property>
- <property name="dock">Dock</property>
- <property name="dock_fixed">0</property>
- <property name="docking">Left</property>
- <property name="enabled">1</property>
- <property name="fg"></property>
- <property name="floatable">1</property>
- <property name="font"></property>
- <property name="gripper">0</property>
- <property name="hidden">0</property>
- <property name="id">wxID_ANY</property>
- <property name="max_size"></property>
- <property name="maximize_button">0</property>
- <property name="maximum_size"></property>
- <property name="min_pane_size">0</property>
- <property name="min_size"></property>
- <property name="minimize_button">0</property>
- <property name="minimum_size"></property>
- <property name="moveable">1</property>
- <property name="name">m_splitterWin</property>
- <property name="pane_border">1</property>
- <property name="pane_position"></property>
- <property name="pane_size"></property>
- <property name="permission">protected</property>
- <property name="pin_button">1</property>
- <property name="pos"></property>
- <property name="resize">Resizable</property>
- <property name="sashgravity">0.35</property>
- <property name="sashpos">300</property>
- <property name="sashsize">-1</property>
- <property name="show">1</property>
- <property name="size"></property>
- <property name="splitmode">wxSPLIT_VERTICAL</property>
- <property name="style">wxSP_3D</property>
- <property name="subclass">; ; forward_declare</property>
- <property name="toolbar_pane">0</property>
- <property name="tooltip"></property>
- <property name="window_extra_style"></property>
- <property name="window_name"></property>
- <property name="window_style"></property>
- <object class="splitteritem" expanded="1">
- <object class="wxPanel" expanded="1">
- <property name="BottomDockable">1</property>
- <property name="LeftDockable">1</property>
- <property name="RightDockable">1</property>
- <property name="TopDockable">1</property>
- <property name="aui_layer"></property>
- <property name="aui_name"></property>
- <property name="aui_position"></property>
- <property name="aui_row"></property>
- <property name="best_size"></property>
- <property name="bg"></property>
- <property name="caption"></property>
- <property name="caption_visible">1</property>
- <property name="center_pane">0</property>
- <property name="close_button">1</property>
- <property name="context_help"></property>
- <property name="context_menu">1</property>
- <property name="default_pane">0</property>
- <property name="dock">Dock</property>
- <property name="dock_fixed">0</property>
- <property name="docking">Left</property>
- <property name="enabled">1</property>
- <property name="fg"></property>
- <property name="floatable">1</property>
- <property name="font"></property>
- <property name="gripper">0</property>
- <property name="hidden">0</property>
- <property name="id">wxID_ANY</property>
- <property name="max_size"></property>
- <property name="maximize_button">0</property>
- <property name="maximum_size"></property>
- <property name="min_size"></property>
- <property name="minimize_button">0</property>
- <property name="minimum_size"></property>
- <property name="moveable">1</property>
- <property name="name">m_panelLeft</property>
- <property name="pane_border">1</property>
- <property name="pane_position"></property>
- <property name="pane_size"></property>
- <property name="permission">protected</property>
- <property name="pin_button">1</property>
- <property name="pos"></property>
- <property name="resize">Resizable</property>
- <property name="show">1</property>
- <property name="size"></property>
- <property name="subclass">; ; forward_declare</property>
- <property name="toolbar_pane">0</property>
- <property name="tooltip"></property>
- <property name="window_extra_style"></property>
- <property name="window_name"></property>
- <property name="window_style">wxTAB_TRAVERSAL</property>
- <object class="wxBoxSizer" expanded="1">
- <property name="minimum_size"></property>
- <property name="name">bSizerLeft</property>
- <property name="orient">wxVERTICAL</property>
- <property name="permission">none</property>
- <object class="sizeritem" expanded="1">
- <property name="border">5</property>
- <property name="flag">wxALL|wxEXPAND</property>
- <property name="proportion">1</property>
- <object class="wxGenericDirCtrl" expanded="1">
- <property name="BottomDockable">1</property>
- <property name="LeftDockable">1</property>
- <property name="RightDockable">1</property>
- <property name="TopDockable">1</property>
- <property name="aui_layer"></property>
- <property name="aui_name"></property>
- <property name="aui_position"></property>
- <property name="aui_row"></property>
- <property name="best_size"></property>
- <property name="bg"></property>
- <property name="caption"></property>
- <property name="caption_visible">1</property>
- <property name="center_pane">0</property>
- <property name="close_button">1</property>
- <property name="context_help"></property>
- <property name="context_menu">1</property>
- <property name="default_pane">0</property>
- <property name="defaultfilter">0</property>
- <property name="defaultfolder"></property>
- <property name="dock">Dock</property>
- <property name="dock_fixed">0</property>
- <property name="docking">Left</property>
- <property name="enabled">1</property>
- <property name="fg"></property>
- <property name="filter"></property>
- <property name="floatable">1</property>
- <property name="font"></property>
- <property name="gripper">0</property>
- <property name="hidden">0</property>
- <property name="id">wxID_ANY</property>
- <property name="max_size"></property>
- <property name="maximize_button">0</property>
- <property name="maximum_size"></property>
- <property name="min_size"></property>
- <property name="minimize_button">0</property>
- <property name="minimum_size">300,-1</property>
- <property name="moveable">1</property>
- <property name="name">m_FileTree</property>
- <property name="pane_border">1</property>
- <property name="pane_position"></property>
- <property name="pane_size"></property>
- <property name="permission">protected</property>
- <property name="pin_button">1</property>
- <property name="pos"></property>
- <property name="resize">Resizable</property>
- <property name="show">1</property>
- <property name="show_hidden">0</property>
- <property name="size"></property>
- <property name="style">wxDIRCTRL_3D_INTERNAL|wxDIRCTRL_EDIT_LABELS|wxDIRCTRL_SELECT_FIRST|wxDIRCTRL_SHOW_FILTERS</property>
- <property name="subclass">; ; forward_declare</property>
- <property name="toolbar_pane">0</property>
- <property name="tooltip"></property>
- <property name="window_extra_style"></property>
- <property name="window_name"></property>
- <property name="window_style">wxBORDER_DEFAULT</property>
- <event name="OnDirctrlFileActivated">OnFileActivated</event>
- <event name="OnDirctrlSelectionChanged">OnSelectionChanged</event>
- </object>
- </object>
- </object>
- </object>
- </object>
- <object class="splitteritem" expanded="1">
- <object class="wxPanel" expanded="1">
- <property name="BottomDockable">1</property>
- <property name="LeftDockable">1</property>
- <property name="RightDockable">1</property>
- <property name="TopDockable">1</property>
- <property name="aui_layer"></property>
- <property name="aui_name"></property>
- <property name="aui_position"></property>
- <property name="aui_row"></property>
- <property name="best_size"></property>
- <property name="bg"></property>
- <property name="caption"></property>
- <property name="caption_visible">1</property>
- <property name="center_pane">0</property>
- <property name="close_button">1</property>
- <property name="context_help"></property>
- <property name="context_menu">1</property>
- <property name="default_pane">0</property>
- <property name="dock">Dock</property>
- <property name="dock_fixed">0</property>
- <property name="docking">Left</property>
- <property name="enabled">1</property>
- <property name="fg"></property>
- <property name="floatable">1</property>
- <property name="font"></property>
- <property name="gripper">0</property>
- <property name="hidden">0</property>
- <property name="id">wxID_ANY</property>
- <property name="max_size"></property>
- <property name="maximize_button">0</property>
- <property name="maximum_size"></property>
- <property name="min_size"></property>
- <property name="minimize_button">0</property>
- <property name="minimum_size"></property>
- <property name="moveable">1</property>
- <property name="name">m_pane3Dviewer</property>
- <property name="pane_border">1</property>
- <property name="pane_position"></property>
- <property name="pane_size"></property>
- <property name="permission">protected</property>
- <property name="pin_button">1</property>
- <property name="pos"></property>
- <property name="resize">Resizable</property>
- <property name="show">1</property>
- <property name="size"></property>
- <property name="subclass">; ; forward_declare</property>
- <property name="toolbar_pane">0</property>
- <property name="tooltip"></property>
- <property name="window_extra_style"></property>
- <property name="window_name"></property>
- <property name="window_style">wxTAB_TRAVERSAL</property>
- <object class="wxBoxSizer" expanded="1">
- <property name="minimum_size"></property>
- <property name="name">m_Sizer3Dviewer</property>
- <property name="orient">wxVERTICAL</property>
- <property name="permission">protected</property>
- </object>
- </object>
- </object>
- </object>
+ <property name="moveable">1</property>
+ <property name="name">m_splitterWin</property>
+ <property name="pane_border">1</property>
+ <property name="pane_position"></property>
+ <property name="pane_size"></property>
+ <property name="permission">protected</property>
+ <property name="pin_button">1</property>
+ <property name="pos"></property>
+ <property name="resize">Resizable</property>
+ <property name="sashgravity">0.35</property>
+ <property name="sashpos">300</property>
+ <property name="sashsize">-1</property>
+ <property name="show">1</property>
+ <property name="size"></property>
+ <property name="splitmode">wxSPLIT_VERTICAL</property>
+ <property name="style">wxSP_3D</property>
+ <property name="subclass">; ; forward_declare</property>
+ <property name="toolbar_pane">0</property>
+ <property name="tooltip"></property>
+ <property name="window_extra_style"></property>
+ <property name="window_name"></property>
+ <property name="window_style"></property>
+ <object class="splitteritem" expanded="true">
+ <object class="wxPanel" expanded="true">
+ <property name="BottomDockable">1</property>
+ <property name="LeftDockable">1</property>
+ <property name="RightDockable">1</property>
+ <property name="TopDockable">1</property>
+ <property name="aui_layer"></property>
+ <property name="aui_name"></property>
+ <property name="aui_position"></property>
+ <property name="aui_row"></property>
+ <property name="best_size"></property>
+ <property name="bg"></property>
+ <property name="caption"></property>
+ <property name="caption_visible">1</property>
+ <property name="center_pane">0</property>
+ <property name="close_button">1</property>
+ <property name="context_help"></property>
+ <property name="context_menu">1</property>
+ <property name="default_pane">0</property>
+ <property name="dock">Dock</property>
+ <property name="dock_fixed">0</property>
+ <property name="docking">Left</property>
+ <property name="drag_accept_files">0</property>
+ <property name="enabled">1</property>
+ <property name="fg"></property>
+ <property name="floatable">1</property>
+ <property name="font"></property>
+ <property name="gripper">0</property>
+ <property name="hidden">0</property>
+ <property name="id">wxID_ANY</property>
+ <property name="max_size"></property>
+ <property name="maximize_button">0</property>
+ <property name="maximum_size"></property>
+ <property name="min_size"></property>
+ <property name="minimize_button">0</property>
+ <property name="minimum_size"></property>
+ <property name="moveable">1</property>
+ <property name="name">m_panelLeft</property>
+ <property name="pane_border">1</property>
+ <property name="pane_position"></property>
+ <property name="pane_size"></property>
+ <property name="permission">protected</property>
+ <property name="pin_button">1</property>
+ <property name="pos"></property>
+ <property name="resize">Resizable</property>
+ <property name="show">1</property>
+ <property name="size"></property>
+ <property name="subclass">; ; forward_declare</property>
+ <property name="toolbar_pane">0</property>
+ <property name="tooltip"></property>
+ <property name="window_extra_style"></property>
+ <property name="window_name"></property>
+ <property name="window_style">wxTAB_TRAVERSAL</property>
+ <object class="wxBoxSizer" expanded="true">
+ <property name="minimum_size"></property>
+ <property name="name">bSizerLeft</property>
+ <property name="orient">wxVERTICAL</property>
+ <property name="permission">none</property>
+ <object class="sizeritem" expanded="false">
+ <property name="border">5</property>
+ <property name="flag">wxALL|wxEXPAND</property>
+ <property name="proportion">1</property>
+ <object class="wxGenericDirCtrl" expanded="false">
+ <property name="BottomDockable">1</property>
+ <property name="LeftDockable">1</property>
+ <property name="RightDockable">1</property>
+ <property name="TopDockable">1</property>
+ <property name="aui_layer"></property>
+ <property name="aui_name"></property>
+ <property name="aui_position"></property>
+ <property name="aui_row"></property>
+ <property name="best_size"></property>
+ <property name="bg"></property>
+ <property name="caption"></property>
+ <property name="caption_visible">1</property>
+ <property name="center_pane">0</property>
+ <property name="close_button">1</property>
+ <property name="context_help"></property>
+ <property name="context_menu">1</property>
+ <property name="default_pane">0</property>
+ <property name="defaultfilter">0</property>
+ <property name="defaultfolder"></property>
+ <property name="dock">Dock</property>
+ <property name="dock_fixed">0</property>
+ <property name="docking">Left</property>
+ <property name="drag_accept_files">0</property>
+ <property name="enabled">1</property>
+ <property name="fg"></property>
+ <property name="filter"></property>
+ <property name="floatable">1</property>
+ <property name="font"></property>
+ <property name="gripper">0</property>
+ <property name="hidden">0</property>
+ <property name="id">wxID_ANY</property>
+ <property name="max_size"></property>
+ <property name="maximize_button">0</property>
+ <property name="maximum_size"></property>
+ <property name="min_size"></property>
+ <property name="minimize_button">0</property>
+ <property name="minimum_size">300,-1</property>
+ <property name="moveable">1</property>
+ <property name="name">m_FileTree</property>
+ <property name="pane_border">1</property>
+ <property name="pane_position"></property>
+ <property name="pane_size"></property>
+ <property name="permission">protected</property>
+ <property name="pin_button">1</property>
+ <property name="pos"></property>
+ <property name="resize">Resizable</property>
+ <property name="show">1</property>
+ <property name="show_hidden">0</property>
+ <property name="size"></property>
+ <property name="style">wxDIRCTRL_3D_INTERNAL|wxDIRCTRL_EDIT_LABELS|wxDIRCTRL_SELECT_FIRST|wxDIRCTRL_SHOW_FILTERS</property>
+ <property name="subclass">; ; forward_declare</property>
+ <property name="toolbar_pane">0</property>
+ <property name="tooltip"></property>
+ <property name="window_extra_style"></property>
+ <property name="window_name"></property>
+ <property name="window_style">wxBORDER_DEFAULT</property>
+ <event name="OnDirctrlFileActivated">OnFileActivated</event>
+ <event name="OnDirctrlSelectionChanged">OnSelectionChanged</event>
</object>
+ </object>
+ <object class="sizeritem" expanded="true">
+ <property name="border">5</property>
+ <property name="flag">wxEXPAND</property>
+ <property name="proportion">0</property>
+ <object class="wxBoxSizer" expanded="true">
+ <property name="minimum_size"></property>
+ <property name="name">bSizer7</property>
+ <property name="orient">wxHORIZONTAL</property>
+ <property name="permission">none</property>
+ </object>
+ </object>
</object>
+ </object>
</object>
- <object class="sizeritem" expanded="1">
- <property name="border">5</property>
- <property name="flag">wxEXPAND</property>
- <property name="proportion">0</property>
- <object class="wxBoxSizer" expanded="1">
- <property name="minimum_size"></property>
- <property name="name">bSizerLower</property>
- <property name="orient">wxHORIZONTAL</property>
- <property name="permission">none</property>
- <object class="sizeritem" expanded="1">
- <property name="border">5</property>
- <property name="flag">wxALIGN_CENTER_VERTICAL|wxBOTTOM|wxLEFT|wxRIGHT|wxTOP</property>
- <property name="proportion">0</property>
- <object class="wxStaticText" expanded="1">
- <property name="BottomDockable">1</property>
- <property name="LeftDockable">1</property>
- <property name="RightDockable">1</property>
- <property name="TopDockable">1</property>
- <property name="aui_layer"></property>
- <property name="aui_name"></property>
- <property name="aui_position"></property>
- <property name="aui_row"></property>
- <property name="best_size"></property>
- <property name="bg"></property>
- <property name="caption"></property>
- <property name="caption_visible">1</property>
- <property name="center_pane">0</property>
- <property name="close_button">1</property>
- <property name="context_help"></property>
- <property name="context_menu">1</property>
- <property name="default_pane">0</property>
- <property name="dock">Dock</property>
- <property name="dock_fixed">0</property>
- <property name="docking">Left</property>
- <property name="enabled">1</property>
- <property name="fg"></property>
- <property name="floatable">1</property>
- <property name="font"></property>
- <property name="gripper">0</property>
- <property name="hidden">0</property>
- <property name="id">wxID_ANY</property>
- <property name="label">Available paths:</property>
- <property name="markup">0</property>
- <property name="max_size"></property>
- <property name="maximize_button">0</property>
- <property name="maximum_size"></property>
- <property name="min_size"></property>
- <property name="minimize_button">0</property>
- <property name="minimum_size"></property>
- <property name="moveable">1</property>
- <property name="name">m_stDirChoice</property>
- <property name="pane_border">1</property>
- <property name="pane_position"></property>
- <property name="pane_size"></property>
- <property name="permission">protected</property>
- <property name="pin_button">1</property>
- <property name="pos"></property>
- <property name="resize">Resizable</property>
- <property name="show">1</property>
- <property name="size"></property>
- <property name="style"></property>
- <property name="subclass">; ; forward_declare</property>
- <property name="toolbar_pane">0</property>
- <property name="tooltip"></property>
- <property name="window_extra_style"></property>
- <property name="window_name"></property>
- <property name="window_style"></property>
- <property name="wrap">-1</property>
- </object>
- </object>
- <object class="sizeritem" expanded="1">
- <property name="border">5</property>
- <property name="flag">wxTOP|wxBOTTOM|wxRIGHT</property>
- <property name="proportion">1</property>
- <object class="wxChoice" expanded="1">
- <property name="BottomDockable">1</property>
- <property name="LeftDockable">1</property>
- <property name="RightDockable">1</property>
- <property name="TopDockable">1</property>
- <property name="aui_layer"></property>
- <property name="aui_name"></property>
- <property name="aui_position"></property>
- <property name="aui_row"></property>
- <property name="best_size"></property>
- <property name="bg"></property>
- <property name="caption"></property>
- <property name="caption_visible">1</property>
- <property name="center_pane">0</property>
- <property name="choices"></property>
- <property name="close_button">1</property>
- <property name="context_help"></property>
- <property name="context_menu">1</property>
- <property name="default_pane">0</property>
- <property name="dock">Dock</property>
- <property name="dock_fixed">0</property>
- <property name="docking">Left</property>
- <property name="enabled">1</property>
- <property name="fg"></property>
- <property name="floatable">1</property>
- <property name="font"></property>
- <property name="gripper">0</property>
- <property name="hidden">0</property>
- <property name="id">wxID_ANY</property>
- <property name="max_size"></property>
- <property name="maximize_button">0</property>
- <property name="maximum_size"></property>
- <property name="min_size"></property>
- <property name="minimize_button">0</property>
- <property name="minimum_size"></property>
- <property name="moveable">1</property>
- <property name="name">m_dirChoices</property>
- <property name="pane_border">1</property>
- <property name="pane_position"></property>
- <property name="pane_size"></property>
- <property name="permission">protected</property>
- <property name="pin_button">1</property>
- <property name="pos"></property>
- <property name="resize">Resizable</property>
- <property name="selection">0</property>
- <property name="show">1</property>
- <property name="size"></property>
- <property name="style"></property>
- <property name="subclass">; ; forward_declare</property>
- <property name="toolbar_pane">0</property>
- <property name="tooltip"></property>
- <property name="validator_data_type"></property>
- <property name="validator_style">wxFILTER_NONE</property>
- <property name="validator_type">wxDefaultValidator</property>
- <property name="validator_variable"></property>
- <property name="window_extra_style"></property>
- <property name="window_name"></property>
- <property name="window_style"></property>
- <event name="OnChoice">SetRootDir</event>
- </object>
- </object>
- <object class="sizeritem" expanded="1">
- <property name="border">5</property>
- <property name="flag">wxALL|wxALIGN_CENTER_VERTICAL</property>
- <property name="proportion">0</property>
- <object class="wxButton" expanded="1">
- <property name="BottomDockable">1</property>
- <property name="LeftDockable">1</property>
- <property name="RightDockable">1</property>
- <property name="TopDockable">1</property>
- <property name="aui_layer"></property>
- <property name="aui_name"></property>
- <property name="aui_position"></property>
- <property name="aui_row"></property>
- <property name="auth_needed">0</property>
- <property name="best_size"></property>
- <property name="bg"></property>
- <property name="bitmap"></property>
- <property name="caption"></property>
- <property name="caption_visible">1</property>
- <property name="center_pane">0</property>
- <property name="close_button">1</property>
- <property name="context_help"></property>
- <property name="context_menu">1</property>
- <property name="current"></property>
- <property name="default">0</property>
- <property name="default_pane">0</property>
- <property name="disabled"></property>
- <property name="dock">Dock</property>
- <property name="dock_fixed">0</property>
- <property name="docking">Left</property>
- <property name="enabled">1</property>
- <property name="fg"></property>
- <property name="floatable">1</property>
- <property name="focus"></property>
- <property name="font"></property>
- <property name="gripper">0</property>
- <property name="hidden">0</property>
- <property name="id">wxID_ANY</property>
- <property name="label">Configure Paths</property>
- <property name="margins"></property>
- <property name="markup">0</property>
- <property name="max_size"></property>
- <property name="maximize_button">0</property>
- <property name="maximum_size"></property>
- <property name="min_size"></property>
- <property name="minimize_button">0</property>
- <property name="minimum_size"></property>
- <property name="moveable">1</property>
- <property name="name">m_cfgPathsButt</property>
- <property name="pane_border">1</property>
- <property name="pane_position"></property>
- <property name="pane_size"></property>
- <property name="permission">protected</property>
- <property name="pin_button">1</property>
- <property name="pos"></property>
- <property name="position"></property>
- <property name="pressed"></property>
- <property name="resize">Resizable</property>
- <property name="show">1</property>
- <property name="size"></property>
- <property name="style"></property>
- <property name="subclass">; ; forward_declare</property>
- <property name="toolbar_pane">0</property>
- <property name="tooltip"></property>
- <property name="validator_data_type"></property>
- <property name="validator_style">wxFILTER_NONE</property>
- <property name="validator_type">wxDefaultValidator</property>
- <property name="validator_variable"></property>
- <property name="window_extra_style"></property>
- <property name="window_name"></property>
- <property name="window_style"></property>
- <event name="OnButtonClick">Cfg3DPaths</event>
- </object>
- </object>
- </object>
- </object>
- <object class="sizeritem" expanded="1">
- <property name="border">5</property>
- <property name="flag">wxEXPAND|wxALL</property>
- <property name="proportion">0</property>
- <object class="wxStdDialogButtonSizer" expanded="1">
- <property name="Apply">0</property>
- <property name="Cancel">1</property>
- <property name="ContextHelp">0</property>
- <property name="Help">0</property>
- <property name="No">0</property>
- <property name="OK">1</property>
- <property name="Save">0</property>
- <property name="Yes">0</property>
- <property name="minimum_size"></property>
- <property name="name">m_sdbSizer</property>
- <property name="permission">protected</property>
+ <object class="splitteritem" expanded="false">
+ <object class="wxPanel" expanded="false">
+ <property name="BottomDockable">1</property>
+ <property name="LeftDockable">1</property>
+ <property name="RightDockable">1</property>
+ <property name="TopDockable">1</property>
+ <property name="aui_layer"></property>
+ <property name="aui_name"></property>
+ <property name="aui_position"></property>
+ <property name="aui_row"></property>
+ <property name="best_size"></property>
+ <property name="bg"></property>
+ <property name="caption"></property>
+ <property name="caption_visible">1</property>
+ <property name="center_pane">0</property>
+ <property name="close_button">1</property>
+ <property name="context_help"></property>
+ <property name="context_menu">1</property>
+ <property name="default_pane">0</property>
+ <property name="dock">Dock</property>
+ <property name="dock_fixed">0</property>
+ <property name="docking">Left</property>
+ <property name="drag_accept_files">0</property>
+ <property name="enabled">1</property>
+ <property name="fg"></property>
+ <property name="floatable">1</property>
+ <property name="font"></property>
+ <property name="gripper">0</property>
+ <property name="hidden">0</property>
+ <property name="id">wxID_ANY</property>
+ <property name="max_size"></property>
+ <property name="maximize_button">0</property>
+ <property name="maximum_size"></property>
+ <property name="min_size"></property>
+ <property name="minimize_button">0</property>
+ <property name="minimum_size"></property>
+ <property name="moveable">1</property>
+ <property name="name">m_pane3Dviewer</property>
+ <property name="pane_border">1</property>
+ <property name="pane_position"></property>
+ <property name="pane_size"></property>
+ <property name="permission">protected</property>
+ <property name="pin_button">1</property>
+ <property name="pos"></property>
+ <property name="resize">Resizable</property>
+ <property name="show">1</property>
+ <property name="size"></property>
+ <property name="subclass">; ; forward_declare</property>
+ <property name="toolbar_pane">0</property>
+ <property name="tooltip"></property>
+ <property name="window_extra_style"></property>
+ <property name="window_name"></property>
+ <property name="window_style">wxTAB_TRAVERSAL</property>
+ <object class="wxBoxSizer" expanded="false">
+ <property name="minimum_size"></property>
+ <property name="name">m_Sizer3Dviewer</property>
+ <property name="orient">wxVERTICAL</property>
+ <property name="permission">protected</property>
</object>
+ </object>
</object>
+ </object>
</object>
+ </object>
</object>
+ <object class="sizeritem" expanded="true">
+ <property name="border">5</property>
+ <property name="flag">wxEXPAND</property>
+ <property name="proportion">0</property>
+ <object class="wxBoxSizer" expanded="false">
+ <property name="minimum_size"></property>
+ <property name="name">bSizerLower</property>
+ <property name="orient">wxHORIZONTAL</property>
+ <property name="permission">none</property>
+ <object class="sizeritem" expanded="false">
+ <property name="border">5</property>
+ <property name="flag">wxALIGN_CENTER_VERTICAL|wxBOTTOM|wxLEFT|wxRIGHT|wxTOP</property>
+ <property name="proportion">0</property>
+ <object class="wxStaticText" expanded="false">
+ <property name="BottomDockable">1</property>
+ <property name="LeftDockable">1</property>
+ <property name="RightDockable">1</property>
+ <property name="TopDockable">1</property>
+ <property name="aui_layer"></property>
+ <property name="aui_name"></property>
+ <property name="aui_position"></property>
+ <property name="aui_row"></property>
+ <property name="best_size"></property>
+ <property name="bg"></property>
+ <property name="caption"></property>
+ <property name="caption_visible">1</property>
+ <property name="center_pane">0</property>
+ <property name="close_button">1</property>
+ <property name="context_help"></property>
+ <property name="context_menu">1</property>
+ <property name="default_pane">0</property>
+ <property name="dock">Dock</property>
+ <property name="dock_fixed">0</property>
+ <property name="docking">Left</property>
+ <property name="drag_accept_files">0</property>
+ <property name="enabled">1</property>
+ <property name="fg"></property>
+ <property name="floatable">1</property>
+ <property name="font"></property>
+ <property name="gripper">0</property>
+ <property name="hidden">0</property>
+ <property name="id">wxID_ANY</property>
+ <property name="label">Available paths:</property>
+ <property name="markup">0</property>
+ <property name="max_size"></property>
+ <property name="maximize_button">0</property>
+ <property name="maximum_size"></property>
+ <property name="min_size"></property>
+ <property name="minimize_button">0</property>
+ <property name="minimum_size"></property>
+ <property name="moveable">1</property>
+ <property name="name">m_stDirChoice</property>
+ <property name="pane_border">1</property>
+ <property name="pane_position"></property>
+ <property name="pane_size"></property>
+ <property name="permission">protected</property>
+ <property name="pin_button">1</property>
+ <property name="pos"></property>
+ <property name="resize">Resizable</property>
+ <property name="show">1</property>
+ <property name="size"></property>
+ <property name="style"></property>
+ <property name="subclass">; ; forward_declare</property>
+ <property name="toolbar_pane">0</property>
+ <property name="tooltip"></property>
+ <property name="window_extra_style"></property>
+ <property name="window_name"></property>
+ <property name="window_style"></property>
+ <property name="wrap">-1</property>
+ </object>
+ </object>
+ <object class="sizeritem" expanded="false">
+ <property name="border">5</property>
+ <property name="flag">wxTOP|wxBOTTOM|wxRIGHT</property>
+ <property name="proportion">1</property>
+ <object class="wxChoice" expanded="false">
+ <property name="BottomDockable">1</property>
+ <property name="LeftDockable">1</property>
+ <property name="RightDockable">1</property>
+ <property name="TopDockable">1</property>
+ <property name="aui_layer"></property>
+ <property name="aui_name"></property>
+ <property name="aui_position"></property>
+ <property name="aui_row"></property>
+ <property name="best_size"></property>
+ <property name="bg"></property>
+ <property name="caption"></property>
+ <property name="caption_visible">1</property>
+ <property name="center_pane">0</property>
+ <property name="choices"></property>
+ <property name="close_button">1</property>
+ <property name="context_help"></property>
+ <property name="context_menu">1</property>
+ <property name="default_pane">0</property>
+ <property name="dock">Dock</property>
+ <property name="dock_fixed">0</property>
+ <property name="docking">Left</property>
+ <property name="drag_accept_files">0</property>
+ <property name="enabled">1</property>
+ <property name="fg"></property>
+ <property name="floatable">1</property>
+ <property name="font"></property>
+ <property name="gripper">0</property>
+ <property name="hidden">0</property>
+ <property name="id">wxID_ANY</property>
+ <property name="max_size"></property>
+ <property name="maximize_button">0</property>
+ <property name="maximum_size"></property>
+ <property name="min_size"></property>
+ <property name="minimize_button">0</property>
+ <property name="minimum_size"></property>
+ <property name="moveable">1</property>
+ <property name="name">m_dirChoices</property>
+ <property name="pane_border">1</property>
+ <property name="pane_position"></property>
+ <property name="pane_size"></property>
+ <property name="permission">protected</property>
+ <property name="pin_button">1</property>
+ <property name="pos"></property>
+ <property name="resize">Resizable</property>
+ <property name="selection">0</property>
+ <property name="show">1</property>
+ <property name="size"></property>
+ <property name="style"></property>
+ <property name="subclass">; ; forward_declare</property>
+ <property name="toolbar_pane">0</property>
+ <property name="tooltip"></property>
+ <property name="validator_data_type"></property>
+ <property name="validator_style">wxFILTER_NONE</property>
+ <property name="validator_type">wxDefaultValidator</property>
+ <property name="validator_variable"></property>
+ <property name="window_extra_style"></property>
+ <property name="window_name"></property>
+ <property name="window_style"></property>
+ <event name="OnChoice">SetRootDir</event>
+ </object>
+ </object>
+ <object class="sizeritem" expanded="false">
+ <property name="border">5</property>
+ <property name="flag">wxALL|wxALIGN_CENTER_VERTICAL</property>
+ <property name="proportion">0</property>
+ <object class="wxButton" expanded="false">
+ <property name="BottomDockable">1</property>
+ <property name="LeftDockable">1</property>
+ <property name="RightDockable">1</property>
+ <property name="TopDockable">1</property>
+ <property name="aui_layer"></property>
+ <property name="aui_name"></property>
+ <property name="aui_position"></property>
+ <property name="aui_row"></property>
+ <property name="auth_needed">0</property>
+ <property name="best_size"></property>
+ <property name="bg"></property>
+ <property name="bitmap"></property>
+ <property name="caption"></property>
+ <property name="caption_visible">1</property>
+ <property name="center_pane">0</property>
+ <property name="close_button">1</property>
+ <property name="context_help"></property>
+ <property name="context_menu">1</property>
+ <property name="current"></property>
+ <property name="default">0</property>
+ <property name="default_pane">0</property>
+ <property name="disabled"></property>
+ <property name="dock">Dock</property>
+ <property name="dock_fixed">0</property>
+ <property name="docking">Left</property>
+ <property name="drag_accept_files">0</property>
+ <property name="enabled">1</property>
+ <property name="fg"></property>
+ <property name="floatable">1</property>
+ <property name="focus"></property>
+ <property name="font"></property>
+ <property name="gripper">0</property>
+ <property name="hidden">0</property>
+ <property name="id">wxID_ANY</property>
+ <property name="label">Configure Paths</property>
+ <property name="margins"></property>
+ <property name="markup">0</property>
+ <property name="max_size"></property>
+ <property name="maximize_button">0</property>
+ <property name="maximum_size"></property>
+ <property name="min_size"></property>
+ <property name="minimize_button">0</property>
+ <property name="minimum_size"></property>
+ <property name="moveable">1</property>
+ <property name="name">m_cfgPathsButt</property>
+ <property name="pane_border">1</property>
+ <property name="pane_position"></property>
+ <property name="pane_size"></property>
+ <property name="permission">protected</property>
+ <property name="pin_button">1</property>
+ <property name="pos"></property>
+ <property name="position"></property>
+ <property name="pressed"></property>
+ <property name="resize">Resizable</property>
+ <property name="show">1</property>
+ <property name="size"></property>
+ <property name="style"></property>
+ <property name="subclass">; ; forward_declare</property>
+ <property name="toolbar_pane">0</property>
+ <property name="tooltip"></property>
+ <property name="validator_data_type"></property>
+ <property name="validator_style">wxFILTER_NONE</property>
+ <property name="validator_type">wxDefaultValidator</property>
+ <property name="validator_variable"></property>
+ <property name="window_extra_style"></property>
+ <property name="window_name"></property>
+ <property name="window_style"></property>
+ <event name="OnButtonClick">Cfg3DPaths</event>
+ </object>
+ </object>
+ </object>
+ </object>
+ <object class="sizeritem" expanded="true">
+ <property name="border">5</property>
+ <property name="flag">wxEXPAND</property>
+ <property name="proportion">0</property>
+ <object class="wxBoxSizer" expanded="true">
+ <property name="minimum_size"></property>
+ <property name="name">bSizer6</property>
+ <property name="orient">wxHORIZONTAL</property>
+ <property name="permission">none</property>
+ <object class="sizeritem" expanded="true">
+ <property name="border">5</property>
+ <property name="flag">wxALL</property>
+ <property name="proportion">0</property>
+ <object class="wxCheckBox" expanded="true">
+ <property name="BottomDockable">1</property>
+ <property name="LeftDockable">1</property>
+ <property name="RightDockable">1</property>
+ <property name="TopDockable">1</property>
+ <property name="aui_layer"></property>
+ <property name="aui_name"></property>
+ <property name="aui_position"></property>
+ <property name="aui_row"></property>
+ <property name="best_size"></property>
+ <property name="bg"></property>
+ <property name="caption"></property>
+ <property name="caption_visible">1</property>
+ <property name="center_pane">0</property>
+ <property name="checked">0</property>
+ <property name="close_button">1</property>
+ <property name="context_help"></property>
+ <property name="context_menu">1</property>
+ <property name="default_pane">0</property>
+ <property name="dock">Dock</property>
+ <property name="dock_fixed">0</property>
+ <property name="docking">Left</property>
+ <property name="drag_accept_files">0</property>
+ <property name="enabled">1</property>
+ <property name="fg"></property>
+ <property name="floatable">1</property>
+ <property name="font"></property>
+ <property name="gripper">0</property>
+ <property name="hidden">0</property>
+ <property name="id">wxID_ANY</property>
+ <property name="label">Embed Model</property>
+ <property name="max_size"></property>
+ <property name="maximize_button">0</property>
+ <property name="maximum_size"></property>
+ <property name="min_size"></property>
+ <property name="minimize_button">0</property>
+ <property name="minimum_size"></property>
+ <property name="moveable">1</property>
+ <property name="name">m_EmbedModelCb</property>
+ <property name="pane_border">1</property>
+ <property name="pane_position"></property>
+ <property name="pane_size"></property>
+ <property name="permission">protected</property>
+ <property name="pin_button">1</property>
+ <property name="pos"></property>
+ <property name="resize">Resizable</property>
+ <property name="show">1</property>
+ <property name="size"></property>
+ <property name="style"></property>
+ <property name="subclass">; ; forward_declare</property>
+ <property name="toolbar_pane">0</property>
+ <property name="tooltip"></property>
+ <property name="validator_data_type"></property>
+ <property name="validator_style">wxFILTER_NONE</property>
+ <property name="validator_type">wxDefaultValidator</property>
+ <property name="validator_variable"></property>
+ <property name="window_extra_style"></property>
+ <property name="window_name"></property>
+ <property name="window_style"></property>
+ </object>
+ </object>
+ <object class="sizeritem" expanded="true">
+ <property name="border">5</property>
+ <property name="flag">wxEXPAND</property>
+ <property name="proportion">1</property>
+ <object class="spacer" expanded="true">
+ <property name="height">0</property>
+ <property name="permission">protected</property>
+ <property name="width">0</property>
+ </object>
+ </object>
+ <object class="sizeritem" expanded="true">
+ <property name="border">5</property>
+ <property name="flag">wxEXPAND|wxALL</property>
+ <property name="proportion">0</property>
+ <object class="wxStdDialogButtonSizer" expanded="true">
+ <property name="Apply">0</property>
+ <property name="Cancel">1</property>
+ <property name="ContextHelp">0</property>
+ <property name="Help">0</property>
+ <property name="No">0</property>
+ <property name="OK">1</property>
+ <property name="Save">0</property>
+ <property name="Yes">0</property>
+ <property name="minimum_size"></property>
+ <property name="name">m_sdbSizer</property>
+ <property name="permission">protected</property>
+ </object>
+ </object>
+ </object>
+ </object>
+ </object>
</object>
+ </object>
</wxFormBuilder_Project>
diff --git a/3d-viewer/dialogs/dialog_select_3d_model_base.h b/3d-viewer/dialogs/dialog_select_3d_model_base.h
index d0b50f2228..325d5b5b44 100644
--- a/3d-viewer/dialogs/dialog_select_3d_model_base.h
+++ b/3d-viewer/dialogs/dialog_select_3d_model_base.h
@@ -1,5 +1,5 @@
///////////////////////////////////////////////////////////////////////////
-// C++ code generated with wxFormBuilder (version 3.10.1-0-g8feb16b)
+// C++ code generated with wxFormBuilder (version 4.0.0-0-g0efcecf0)
// http://www.wxformbuilder.org/
//
// PLEASE DO *NOT* EDIT THIS FILE!
@@ -26,6 +26,7 @@
#include <wx/bitmap.h>
#include <wx/image.h>
#include <wx/icon.h>
+#include <wx/checkbox.h>
#include <wx/dialog.h>
///////////////////////////////////////////////////////////////////////////
@@ -47,6 +48,7 @@ class DIALOG_SELECT_3D_MODEL_BASE : public DIALOG_SHIM
wxStaticText* m_stDirChoice;
wxChoice* m_dirChoices;
wxButton* m_cfgPathsButt;
+ wxCheckBox* m_EmbedModelCb;
wxStdDialogButtonSizer* m_sdbSizer;
wxButton* m_sdbSizerOK;
wxButton* m_sdbSizerCancel;
diff --git a/3d-viewer/dialogs/panel_preview_3d_model.h b/3d-viewer/dialogs/panel_preview_3d_model.h
index b60a56143c..b4c7e6f8c2 100644
--- a/3d-viewer/dialogs/panel_preview_3d_model.h
+++ b/3d-viewer/dialogs/panel_preview_3d_model.h
@@ -92,6 +92,12 @@ public:
*/
void UpdateDummyFootprint( bool aRelaodRequired = true );
+ /**
+ * Get the dummy footprint that is used for previewing the 3D model.
+ * We use this to hold the temporary 3D model shapes.
+ */
+ FOOTPRINT* GetDummyFootprint() const { return m_dummyFootprint; }
+
private:
/**
* Load 3D relevant settings from the user configuration
diff --git a/CMakeLists.txt b/CMakeLists.txt
index 56e8ca2316..d0b1f00972 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -809,6 +809,11 @@ include_directories( SYSTEM ${GLM_INCLUDE_DIR} )
#
find_package(ZLIB REQUIRED)
+#
+# Find Zstd library, required
+#
+find_package(ZSTD REQUIRED)
+
#
# Find libcurl, required
#
diff --git a/cmake/BuildSteps/TokenList2DsnLexer.cmake b/cmake/BuildSteps/TokenList2DsnLexer.cmake
index de14e6b17d..6f6c4fd6c1 100644
--- a/cmake/BuildSteps/TokenList2DsnLexer.cmake
+++ b/cmake/BuildSteps/TokenList2DsnLexer.cmake
@@ -145,6 +145,7 @@ namespace ${enum}
// these first few are negative special ones for syntax, and are
// inherited from DSNLEXER.
T_NONE = DSN_NONE,
+ T_BAR = DSN_BAR, // Also called pipe: '|'
T_COMMENT = DSN_COMMENT,
T_STRING_QUOTE = DSN_STRING_QUOTE,
T_QUOTE_DEF = DSN_QUOTE_DEF,
diff --git a/cmake/FindZSTD.cmake b/cmake/FindZSTD.cmake
new file mode 100644
index 0000000000..98175e8a42
--- /dev/null
+++ b/cmake/FindZSTD.cmake
@@ -0,0 +1,41 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+#
+# - Try to find Facebook zstd library
+# This will define
+# ZSTD_FOUND
+# ZSTD_INCLUDE_DIR
+# ZSTD_LIBRARY
+#
+
+find_path(ZSTD_INCLUDE_DIR NAMES zstd.h)
+
+find_library(ZSTD_LIBRARY_DEBUG NAMES zstdd zstd_staticd)
+find_library(ZSTD_LIBRARY_RELEASE NAMES zstd zstd_static)
+
+include(SelectLibraryConfigurations)
+SELECT_LIBRARY_CONFIGURATIONS(ZSTD)
+
+include(FindPackageHandleStandardArgs)
+FIND_PACKAGE_HANDLE_STANDARD_ARGS(
+ ZSTD DEFAULT_MSG
+ ZSTD_LIBRARY ZSTD_INCLUDE_DIR
+)
+
+if (ZSTD_FOUND)
+ message(STATUS "Found Zstd: ${ZSTD_LIBRARY}")
+endif()
+
+mark_as_advanced(ZSTD_INCLUDE_DIR ZSTD_LIBRARY)
\ No newline at end of file
diff --git a/common/CMakeLists.txt b/common/CMakeLists.txt
index bc0ec154f7..a6d56122ba 100644
--- a/common/CMakeLists.txt
+++ b/common/CMakeLists.txt
@@ -195,6 +195,8 @@ target_link_libraries( kicommon
nlohmann_json
fmt::fmt
CURL::libcurl
+ picosha2
+ zstd
${wxWidgets_LIBRARIES}
${LIBGIT2_LIBRARIES}
@@ -267,6 +269,7 @@ target_include_directories( kicommon
$<TARGET_PROPERTY:pegtl,INTERFACE_INCLUDE_DIRECTORIES>
$<TARGET_PROPERTY:expected,INTERFACE_INCLUDE_DIRECTORIES>
$<TARGET_PROPERTY:kiapi,INTERFACE_INCLUDE_DIRECTORIES>
+ $<TARGET_PROPERTY:picosha2,INTERFACE_INCLUDE_DIRECTORIES>
)
add_dependencies( kicommon pegtl version_header )
@@ -304,6 +307,7 @@ set( COMMON_DLG_SRCS
dialogs/dialog_configure_paths_base.cpp
dialogs/dialog_display_html_text_base.cpp
dialogs/dialog_edit_library_tables.cpp
+ dialogs/dialog_embed_files.cpp
dialogs/dialog_global_lib_table_config.cpp
dialogs/dialog_global_lib_table_config_base.cpp
dialogs/dialog_grid_settings.cpp
@@ -338,6 +342,8 @@ set( COMMON_DLG_SRCS
dialogs/panel_color_settings.cpp
dialogs/panel_common_settings.cpp
dialogs/panel_common_settings_base.cpp
+ dialogs/panel_embedded_files.cpp
+ dialogs/panel_embedded_files_base.cpp
dialogs/panel_gal_display_options.cpp
dialogs/panel_hotkeys_editor.cpp
dialogs/panel_image_editor.cpp
@@ -534,6 +540,7 @@ set( COMMON_SRCS
eda_shape.cpp
eda_text.cpp
eda_tools.cpp
+ embedded_files.cpp
env_paths.cpp
executable_names.cpp
filename_resolver.cpp
@@ -589,6 +596,7 @@ set( COMMON_SRCS
tool/edit_constraints.cpp
tool/edit_points.cpp
tool/editor_conditions.cpp
+ tool/embed_tool.cpp
tool/grid_helper.cpp
tool/grid_menu.cpp
tool/picker_tool.cpp
@@ -921,6 +929,17 @@ make_lexer_export(
kicommon.h
)
+# auto-generate embedded files lexer and keywords
+make_lexer_export(
+ kicommon
+ embedded_files.keywords
+ embedded_files_lexer.h
+ embedded_files_keywords.cpp
+ EMBEDDED_FILES_T
+ KICOMMON_API
+ kicommon.h
+)
+
# This one gets made only when testing.
# to build it, first enable #define STAND_ALONE at top of dsnlexer.cpp
add_executable( dsntest EXCLUDE_FROM_ALL dsnlexer.cpp )
diff --git a/common/dialogs/dialog_embed_files.cpp b/common/dialogs/dialog_embed_files.cpp
new file mode 100644
index 0000000000..c39eaa1610
--- /dev/null
+++ b/common/dialogs/dialog_embed_files.cpp
@@ -0,0 +1,78 @@
+/*
+ * 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, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <wx/button.h>
+#include <wx/sizer.h>
+
+#include <dialogs/dialog_embed_files.h>
+
+
+DIALOG_EMBED_FILES::DIALOG_EMBED_FILES( wxWindow* aParent, const wxString& aTitle ) :
+ DIALOG_SHIM( aParent, wxID_ANY, aTitle, wxDefaultPosition, wxDefaultSize,
+ wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER ),
+ m_contentPanel( nullptr )
+{
+ // Construction delayed until after panel is installed
+}
+
+
+void DIALOG_EMBED_FILES::InstallPanel( wxPanel* aPanel )
+{
+ m_contentPanel = aPanel;
+
+ // Now perform the body of the constructor
+ auto mainSizer = new wxBoxSizer( wxVERTICAL );
+ SetSizer( mainSizer );
+
+ mainSizer->Add( m_contentPanel, 1, wxEXPAND|wxLEFT|wxTOP|wxRIGHT, 5 );
+ m_contentPanel->SetMinSize( FromDIP( wxSize( 1000, 600 ) ) );
+
+ auto sdbSizer = new wxStdDialogButtonSizer();
+ auto sdbSizerOK = new wxButton( this, wxID_OK );
+ sdbSizer->AddButton( sdbSizerOK );
+ auto sdbSizerCancel = new wxButton( this, wxID_CANCEL );
+ sdbSizer->AddButton( sdbSizerCancel );
+ sdbSizer->Realize();
+
+ mainSizer->Add( sdbSizer, 0, wxALL|wxEXPAND, 5 );
+
+ SetupStandardButtons();
+
+ finishDialogSettings();
+
+ // On some windows manager (Unity, XFCE), this dialog is not always raised, depending
+ // on how the dialog is run.
+ Raise();
+}
+
+
+bool DIALOG_EMBED_FILES::TransferDataToWindow()
+{
+ return m_contentPanel->TransferDataToWindow();
+}
+
+
+bool DIALOG_EMBED_FILES::TransferDataFromWindow()
+{
+ /**
+ * N.B. *do not* call wxDialog::TransferDataFromWindow() in the dialog code.
+ */
+ return m_contentPanel->TransferDataFromWindow();
+}
+
diff --git a/common/dialogs/dialog_page_settings.cpp b/common/dialogs/dialog_page_settings.cpp
index ccb56ce47c..03a32a8009 100644
--- a/common/dialogs/dialog_page_settings.cpp
+++ b/common/dialogs/dialog_page_settings.cpp
@@ -26,6 +26,8 @@
#include <dialogs/dialog_page_settings.h>
#include <eda_draw_frame.h>
#include <eda_item.h>
+#include <embedded_files.h>
+#include <filename_resolver.h>
#include <gr_basic.h>
#include <kiface_base.h>
#include <macros.h>
@@ -38,6 +40,7 @@
#include <drawing_sheet/ds_painter.h>
#include <string_utils.h>
#include <widgets/std_bitmap_button.h>
+#include <widgets/filedlg_open_embed_file.h>
#include <wx/valgen.h>
#include <wx/tokenzr.h>
#include <wx/filedlg.h>
@@ -75,7 +78,7 @@ static const wxString pageFmts[] =
// to be recognized in code
};
-DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS( EDA_DRAW_FRAME* aParent, double aIuPerMils,
+DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS( EDA_DRAW_FRAME* aParent, EMBEDDED_FILES* aEmbeddedFiles, double aIuPerMils,
const VECTOR2D& aMaxUserSizeMils ) :
DIALOG_PAGES_SETTINGS_BASE( aParent ),
m_parent( aParent ),
@@ -83,6 +86,7 @@ DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS( EDA_DRAW_FRAME* aParent, double aI
m_initialized( false ),
m_pageBitmap( nullptr ),
m_iuPerMils( aIuPerMils ),
+ m_embeddedFiles( aEmbeddedFiles ),
m_customSizeX( aParent, m_userSizeXLabel, m_userSizeXCtrl, m_userSizeXUnits ),
m_customSizeY( aParent, m_userSizeYLabel, m_userSizeYCtrl, m_userSizeYUnits )
{
@@ -114,6 +118,10 @@ DIALOG_PAGES_SETTINGS::DIALOG_PAGES_SETTINGS( EDA_DRAW_FRAME* aParent, double aI
m_staticTextTitleBlock->SetLabel( _( "Title Block" ) );
}
+ m_filenameResolver = new FILENAME_RESOLVER;
+ m_filenameResolver->SetProject( &Prj() );
+ m_filenameResolver->SetProgramBase( &Pgm() );
+
SetupStandardButtons();
Centre();
@@ -467,7 +475,8 @@ bool DIALOG_PAGES_SETTINGS::SavePageSettings()
if( fileName != BASE_SCREEN::m_DrawingSheetFileName )
{
- wxString fullFileName = DS_DATA_MODEL::ResolvePath( fileName, m_projectPath );
+
+ wxString fullFileName = m_filenameResolver->ResolvePath( fileName, m_projectPath, m_embeddedFiles );
BASE_SCREEN::m_DrawingSheetFileName = fileName;
@@ -794,19 +803,30 @@ void DIALOG_PAGES_SETTINGS::OnWksFileSelection( wxCommandEvent& event )
}
// Display a file picker dialog
+ FILEDLG_OPEN_EMBED_FILE customize;
wxFileDialog fileDialog( this, _( "Drawing Sheet File" ), path, name,
FILEEXT::DrawingSheetFileWildcard(),
wxFD_DEFAULT_STYLE | wxFD_FILE_MUST_EXIST );
+ if( m_embeddedFiles )
+ fileDialog.SetCustomizeHook( customize );
+
if( fileDialog.ShowModal() != wxID_OK )
return;
wxString fileName = fileDialog.GetPath();
wxString shortFileName;
- // Try to use a project-relative path first:
- if( !m_projectPath.IsEmpty() && fileName.StartsWith( m_projectPath ) )
+ if( m_embeddedFiles && customize.GetEmbed() )
{
+ fn.Assign( fileName );
+ EMBEDDED_FILES::EMBEDDED_FILE* result = m_embeddedFiles->AddFile( fn, false );
+ shortFileName = result->GetLink();
+ fileName = m_embeddedFiles->GetTempFileName( result->name ).GetFullPath();
+ }
+ else if( !m_projectPath.IsEmpty() && fileName.StartsWith( m_projectPath ) )
+ {
+ // Try to use a project-relative path
fn = wxFileName( fileName );
fn.MakeRelativeTo( m_projectPath );
shortFileName = fn.GetFullPath();
diff --git a/common/dialogs/panel_embedded_files.cpp b/common/dialogs/panel_embedded_files.cpp
new file mode 100644
index 0000000000..236ff009ac
--- /dev/null
+++ b/common/dialogs/panel_embedded_files.cpp
@@ -0,0 +1,314 @@
+/*
+ * 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
+ */
+
+#include <bitmaps.h>
+#include <dialogs/panel_embedded_files.h>
+#include <embedded_files.h>
+#include <kidialog.h>
+#include <widgets/std_bitmap_button.h>
+#include <widgets/wx_grid.h>
+
+#include <wx/clipbrd.h>
+#include <wx/dirdlg.h>
+#include <wx/ffile.h>
+#include <wx/filedlg.h>
+#include <wx/filename.h>
+#include <wx/menu.h>
+
+PANEL_EMBEDDED_FILES::PANEL_EMBEDDED_FILES( wxWindow* parent, EMBEDDED_FILES* aFiles ) :
+ PANEL_EMBEDDED_FILES_BASE( parent ),
+ m_files( aFiles )
+{
+ m_localFiles = new EMBEDDED_FILES();
+
+ for( auto& [name, file] : m_files->EmbeddedFileMap() )
+ {
+ EMBEDDED_FILES::EMBEDDED_FILE* newFile = new EMBEDDED_FILES::EMBEDDED_FILE( *file );
+ m_localFiles->AddFile( newFile );
+ }
+
+ // Set up the standard buttons
+ m_delete_button->SetBitmap( KiBitmapBundle( BITMAPS::small_trash ) );
+ m_browse_button->SetBitmap( KiBitmapBundle( BITMAPS::small_folder ) );
+ m_files_grid->SetMargins( 0 - wxSYS_VSCROLL_X, 0 );
+ m_files_grid->EnableAlternateRowColors();
+}
+
+
+void PANEL_EMBEDDED_FILES::onSize( wxSizeEvent& event )
+{
+ resizeGrid();
+}
+
+
+void PANEL_EMBEDDED_FILES::resizeGrid()
+{
+ int panel_width = GetClientRect().GetWidth();
+ int first_width = m_files_grid->GetColSize( 0 );
+ int second_width = m_files_grid->GetColSize( 1 );
+
+ double ratio;
+
+ if( first_width + second_width > 0 )
+ ratio = (double)first_width / (double)( first_width + second_width );
+ else
+ ratio = 0.3;
+
+
+ m_files_grid->SetColSize( 0, panel_width * ratio );
+ m_files_grid->SetColSize( 1, panel_width * ( 1 - ratio ) );
+ Layout();
+}
+
+
+void PANEL_EMBEDDED_FILES::onGridRightClick( wxGridEvent& event )
+{
+ wxMenu menu;
+ menu.Append( wxID_COPY, _( "Copy Embedded Reference" ) );
+
+ menu.Bind( wxEVT_COMMAND_MENU_SELECTED,
+ [&]( wxCommandEvent& )
+ {
+ int row = event.GetRow();
+ if( row >= 0 && row < m_files_grid->GetNumberRows() )
+ {
+ wxString cellValue = m_files_grid->GetCellValue( row, 1 );
+
+ if( wxTheClipboard->Open() )
+ {
+ wxTheClipboard->SetData( new wxTextDataObject( cellValue ) );
+ wxTheClipboard->Close();
+ }
+ }
+ }, wxID_COPY );
+
+ PopupMenu( &menu );
+}
+
+
+bool PANEL_EMBEDDED_FILES::TransferDataToWindow()
+{
+ m_files_grid->ClearGrid();
+
+ if( m_files_grid->GetNumberRows() > 0 )
+ m_files_grid->DeleteRows( 0, m_files_grid->GetNumberRows() );
+
+ int ii = 0;
+ for( auto& [name, file] : m_localFiles->EmbeddedFileMap() )
+ {
+ while( m_files_grid->GetNumberRows() < ii + 1 )
+ m_files_grid->AppendRows( 1 );
+
+ m_files_grid->SetCellValue( ii, 0, name );
+ m_files_grid->SetCellValue( ii, 1, file->GetLink() );
+
+ ii++;
+ }
+
+ m_cbEmbedFonts->SetValue( m_files->GetAreFontsEmbedded() );
+
+ resizeGrid();
+
+ return true;
+}
+
+
+bool PANEL_EMBEDDED_FILES::TransferDataFromWindow()
+{
+ m_files->ClearEmbeddedFiles();
+
+ std::vector<EMBEDDED_FILES::EMBEDDED_FILE*> files;
+
+ for( auto it = m_localFiles->EmbeddedFileMap().begin(); it != m_localFiles->EmbeddedFileMap().end(); it++ )
+ files.push_back( it->second );
+
+ for( auto& file : files )
+ {
+ m_files->AddFile( file );
+ m_localFiles->RemoveFile( file->name, false );
+ }
+
+ m_files->SetAreFontsEmbedded( m_cbEmbedFonts->IsChecked() );
+
+ return true;
+}
+
+
+void PANEL_EMBEDDED_FILES::onAddEmbeddedFile( wxCommandEvent& event )
+{
+ wxFileDialog fileDialog( this, _( "Select a file to embed" ), wxEmptyString, wxEmptyString,
+ _( "All files|*.*" ), wxFD_OPEN | wxFD_FILE_MUST_EXIST );
+
+ if( fileDialog.ShowModal() == wxID_OK )
+ {
+ wxFileName fileName( fileDialog.GetPath() );
+ wxString name = fileName.GetFullName();
+
+ if( m_localFiles->HasFile( name ) )
+ {
+ wxString msg = wxString::Format( _( "File '%s' already exists." ),
+ name );
+
+ KIDIALOG errorDlg( m_parent, msg, _( "Confirmation" ),
+ wxOK | wxCANCEL | wxICON_WARNING );
+ errorDlg.SetOKLabel( _( "Overwrite" ) );
+
+ if( errorDlg.ShowModal() != wxID_OK )
+ return;
+
+ for( int ii = 0; ii < m_files_grid->GetNumberRows(); ii++ )
+ {
+ if( m_files_grid->GetCellValue( ii, 0 ) == name )
+ {
+ m_files_grid->DeleteRows( ii );
+ break;
+ }
+ }
+ }
+
+ EMBEDDED_FILES::EMBEDDED_FILE* result = m_localFiles->AddFile( fileName, true );
+
+ if( !result )
+ {
+ wxString msg = wxString::Format( _( "Failed to add file '%s'." ),
+ name );
+
+ KIDIALOG errorDlg( m_parent, msg, _( "Error" ), wxOK | wxICON_ERROR );
+ errorDlg.ShowModal();
+ return;
+ }
+
+ m_files_grid->AppendRows( 1 );
+ int ii = m_files_grid->GetNumberRows() - 1;
+ m_files_grid->SetCellValue( ii, 0, name );
+ m_files_grid->SetCellValue( ii, 1, result->GetLink() );
+ }
+}
+
+void PANEL_EMBEDDED_FILES::onDeleteEmbeddedFile( wxCommandEvent& event )
+{
+ int row = m_files_grid->GetGridCursorRow();
+
+ if( row < 0 )
+ return;
+
+ wxString name = m_files_grid->GetCellValue( row, 0 );
+
+ m_localFiles->RemoveFile( name );
+
+ m_files_grid->DeleteRows( row );
+
+ if( row < m_files_grid->GetNumberRows() )
+ m_files_grid->SetGridCursor( row, 0 );
+ else if( m_files_grid->GetNumberRows() > 0 )
+ m_files_grid->SetGridCursor( m_files_grid->GetNumberRows() - 1, 0 );
+}
+
+
+void PANEL_EMBEDDED_FILES::onExportFiles( wxCommandEvent& event )
+{
+ wxDirDialog dirDialog( this, _( "Select a directory to export files" ) );
+
+ if( dirDialog.ShowModal() != wxID_OK )
+ return;
+
+ wxString path = dirDialog.GetPath();
+
+ for( auto& [name, file] : m_localFiles->EmbeddedFileMap() )
+ {
+ wxFileName fileName( path, name );
+
+ if( fileName.FileExists() )
+ {
+ wxString msg = wxString::Format( _( "File '%s' already exists." ),
+ fileName.GetFullName() );
+
+ KIDIALOG errorDlg( m_parent, msg, _( "Confirmation" ),
+ wxOK | wxCANCEL | wxICON_WARNING );
+ errorDlg.SetOKCancelLabels( _( "Overwrite" ), _( "Skip" ) );
+ errorDlg.DoNotShowCheckbox( __FILE__, __LINE__ );
+
+ if( errorDlg.ShowModal() != wxID_OK )
+ continue;
+ }
+
+ bool skip_file = false;
+
+ while( 1 )
+ {
+ if( !fileName.IsDirWritable() )
+ {
+#ifndef __WXMAC__
+ wxString msg = wxString::Format( _( "Directory '%s' is not writable." ),
+ fileName.GetFullName() );
+#else
+ wxString msg = wxString::Format( _( "Folder '%s' is not writable." ),
+ fileName.GetPath() );
+#endif
+ // Don't set a 'do not show again' checkbox for this dialog
+ KIDIALOG errorDlg( m_parent, msg, _( "Error" ), wxYES_NO | wxCANCEL | wxICON_ERROR );
+ errorDlg.SetYesNoCancelLabels( _( "Retry" ), _( "Skip" ), _( "Cancel" ) );
+
+ int result = errorDlg.ShowModal();
+
+ if( result == wxID_CANCEL )
+ {
+ return;
+ }
+ else if( result == wxID_NO )
+ {
+ skip_file = true;
+ break;
+ }
+ }
+ else
+ {
+ break;
+ }
+ }
+
+ if( skip_file )
+ continue;
+
+ wxFFile ffile( fileName.GetFullPath(), wxT( "w" ) );
+
+ if( !ffile.IsOpened() )
+ {
+ wxString msg = wxString::Format( _( "Failed to open file '%s'." ),
+ fileName.GetFullName() );
+
+ KIDIALOG errorDlg( m_parent, msg, _( "Error" ), wxOK | wxICON_ERROR );
+ errorDlg.ShowModal();
+ continue;
+ }
+
+ if( !ffile.Write( file->decompressedData.data(), file->decompressedData.size() ) )
+ {
+ wxString msg = wxString::Format( _( "Failed to write file '%s'." ),
+ fileName.GetFullName() );
+
+ KIDIALOG errorDlg( m_parent, msg, _( "Error" ), wxOK | wxICON_ERROR );
+ errorDlg.ShowModal();
+ }
+ }
+}
\ No newline at end of file
diff --git a/common/dialogs/panel_embedded_files.h b/common/dialogs/panel_embedded_files.h
new file mode 100644
index 0000000000..b5d184cdd7
--- /dev/null
+++ b/common/dialogs/panel_embedded_files.h
@@ -0,0 +1,58 @@
+/*
+ * This program source code file is part of KiCad, a free EDA CAD application.
+ *
+ * Copyright (C) 2023 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 PANEL_EMBEDDED_FILES_H
+#define PANEL_EMBEDDED_FILES_H
+
+#include "panel_embedded_files_base.h"
+
+class EMBEDDED_FILES;
+
+class PANEL_EMBEDDED_FILES : public PANEL_EMBEDDED_FILES_BASE
+{
+public:
+ PANEL_EMBEDDED_FILES( wxWindow* parent, EMBEDDED_FILES* aFiles );
+ ~PANEL_EMBEDDED_FILES() override {};
+
+ bool TransferDataFromWindow() override;
+ bool TransferDataToWindow() override;
+ bool GetEmbedFonts() const { return m_cbEmbedFonts->GetValue(); }
+
+protected:
+
+ void onGridRightClick( wxGridEvent& event ) override;
+ void onAddEmbeddedFile( wxCommandEvent& event ) override;
+ void onDeleteEmbeddedFile( wxCommandEvent& event ) override;
+ void onExportFiles( wxCommandEvent& event ) override;
+ void onSize( wxSizeEvent& event ) override;
+
+private:
+
+ void resizeGrid();
+
+ EMBEDDED_FILES* m_files;
+ EMBEDDED_FILES* m_localFiles;
+};
+
+
+#endif // PANEL_EMBEDDED_FILES_H
\ No newline at end of file
diff --git a/common/dialogs/panel_embedded_files_base.cpp b/common/dialogs/panel_embedded_files_base.cpp
new file mode 100644
index 0000000000..77ff4830fe
--- /dev/null
+++ b/common/dialogs/panel_embedded_files_base.cpp
@@ -0,0 +1,118 @@
+///////////////////////////////////////////////////////////////////////////
+// C++ code generated with wxFormBuilder (version 4.2.1-0-g80c4cb6a-dirty)
+// http://www.wxformbuilder.org/
+//
+// PLEASE DO *NOT* EDIT THIS FILE!
+///////////////////////////////////////////////////////////////////////////
+
+#include "widgets/std_bitmap_button.h"
+#include "widgets/wx_grid.h"
+
+#include "panel_embedded_files_base.h"
+
+///////////////////////////////////////////////////////////////////////////
+
+PANEL_EMBEDDED_FILES_BASE::PANEL_EMBEDDED_FILES_BASE( wxWindow* parent, wxWindowID id, const wxPoint& pos, const wxSize& size, long style, const wxString& name ) : wxPanel( parent, id, pos, size, style, name )
+{
+ wxBoxSizer* bMainSizer;
+ bMainSizer = new wxBoxSizer( wxVERTICAL );
+
+ wxBoxSizer* m_global_sizer;
+ m_global_sizer = new wxBoxSizer( wxVERTICAL );
+
+ m_files_grid = new WX_GRID( this, wxID_ANY, wxDefaultPosition, wxDefaultSize, 0 );
+
+ // Grid
+ m_files_grid->CreateGrid( 1, 2 );
+ m_files_grid->EnableEditing( false );
+ m_files_grid->EnableGridLines( true );
+ m_files_grid->EnableDragGridSize( false );
+ m_files_grid->SetMargins( 0, 0 );
+
+ // Columns
+ m_files_grid->SetColSize( 0, 440 );
+ m_files_grid->SetColSize( 1, 180 );
+ m_files_grid->EnableDragColMove( false );
+ m_files_grid->EnableDragColSize( true );
+ m_files_grid->SetColLabelValue( 0, _("Filename") );
+ m_files_grid->SetColLabelValue( 1, _("Internal Reference") );
+ m_files_grid->SetColLabelSize( 22 );
+ m_files_grid->SetColLabelAlignment( wxALIGN_CENTER, wxALIGN_CENTER );
+
+ // Rows
+ m_files_grid->AutoSizeRows();
+ m_files_grid->EnableDragRowSize( false );
+ m_files_grid->SetRowLabelSize( 0 );
+ m_files_grid->SetRowLabelAlignment( wxALIGN_CENTER, wxALIGN_CENTER );
+
+ // Label Appearance
+
+ // Cell Defaults
+ m_files_grid->SetDefaultCellAlignment( wxALIGN_LEFT, wxALIGN_CENTER );
+ m_global_sizer->Add( m_files_grid, 5, wxALL|wxEXPAND, 5 );
+
+
+ bMainSizer->Add( m_global_sizer, 1, wxEXPAND, 5 );
+
+ wxBoxSizer* bButtonsSizer;
+ bButtonsSizer = new wxBoxSizer( wxHORIZONTAL );
+
+ m_browse_button = new STD_BITMAP_BUTTON( this, wxID_ANY, wxNullBitmap, wxDefaultPosition, wxSize( -1,-1 ), wxBU_AUTODRAW|0 );
+ m_browse_button->SetToolTip( _("Add embedded file") );
+
+ bButtonsSizer->Add( m_browse_button, 0, wxTOP|wxBOTTOM|wxRIGHT, 5 );
+
+
+ bButtonsSizer->Add( 20, 0, 0, wxEXPAND, 5 );
+
+ m_delete_button = new STD_BITMAP_BUTTON( this, wxID_ANY, wxNullBitmap, wxDefaultPosition, wxSize( -1,-1 ), wxBU_AUTODRAW|0 );
+ m_delete_button->SetToolTip( _("Remove embedded file") );
+
+ bButtonsSizer->Add( m_delete_button, 0, wxTOP|wxBOTTOM|wxRIGHT, 5 );
+
+
+ bButtonsSizer->Add( 0, 0, 1, wxEXPAND, 5 );
+
+ m_export = new wxButton( this, wxID_ANY, _("&Export"), wxDefaultPosition, wxDefaultSize, 0 );
+ bButtonsSizer->Add( m_export, 0, wxALIGN_CENTER_VERTICAL|wxALL, 5 );
+
+
+ bMainSizer->Add( bButtonsSizer, 0, wxEXPAND|wxALL, 3 );
+
+ m_staticline1 = new wxStaticLine( this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxLI_HORIZONTAL );
+ bMainSizer->Add( m_staticline1, 0, wxEXPAND | wxALL, 5 );
+
+ wxBoxSizer* bSizer4;
+ bSizer4 = new wxBoxSizer( wxVERTICAL );
+
+ m_cbEmbedFonts = new wxCheckBox( this, wxID_ANY, _("Embed Fonts"), wxDefaultPosition, wxDefaultSize, 0 );
+ m_cbEmbedFonts->SetToolTip( _("Store a copy of all fonts used") );
+
+ bSizer4->Add( m_cbEmbedFonts, 0, wxALL, 5 );
+
+
+ bMainSizer->Add( bSizer4, 0, wxEXPAND, 5 );
+
+
+ this->SetSizer( bMainSizer );
+ this->Layout();
+ bMainSizer->Fit( this );
+
+ // Connect Events
+ this->Connect( wxEVT_SIZE, wxSizeEventHandler( PANEL_EMBEDDED_FILES_BASE::onSize ) );
+ m_files_grid->Connect( wxEVT_GRID_CELL_RIGHT_CLICK, wxGridEventHandler( PANEL_EMBEDDED_FILES_BASE::onGridRightClick ), NULL, this );
+ m_browse_button->Connect( wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler( PANEL_EMBEDDED_FILES_BASE::onAddEmbeddedFile ), NULL, this );
+ m_delete_button->Connect( wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler( PANEL_EMBEDDED_FILES_BASE::onDeleteEmbeddedFile ), NULL, this );
+ m_export->Connect( wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler( PANEL_EMBEDDED_FILES_BASE::onExportFiles ), NULL, this );
+}
+
+PANEL_EMBEDDED_FILES_BASE::~PANEL_EMBEDDED_FILES_BASE()
+{
+ // Disconnect Events
+ this->Disconnect( wxEVT_SIZE, wxSizeEventHandler( PANEL_EMBEDDED_FILES_BASE::onSize ) );
+ m_files_grid->Disconnect( wxEVT_GRID_CELL_RIGHT_CLICK, wxGridEventHandler( PANEL_EMBEDDED_FILES_BASE::onGridRightClick ), NULL, this );
+ m_browse_button->Disconnect( wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler( PANEL_EMBEDDED_FILES_BASE::onAddEmbeddedFile ), NULL, this );
+ m_delete_button->Disconnect( wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler( PANEL_EMBEDDED_FILES_BASE::onDeleteEmbeddedFile ), NULL, this );
+ m_export->Disconnect( wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEventHandler( PANEL_EMBEDDED_FILES_BASE::onExportFiles ), NULL, this );
+
+}
diff --git a/common/dialogs/panel_embedded_files_base.fbp b/common/dialogs/panel_embedded_files_base.fbp
new file mode 100644
index 0000000000..caef388d38
--- /dev/null
+++ b/common/dialogs/panel_embedded_files_base.fbp
@@ -0,0 +1,559 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<wxFormBuilder_Project>
+ <FileVersion major="1" minor="18"/>
+ <object class="Project" expanded="true">
+ <property name="code_generation">C++</property>
+ <property name="cpp_class_decoration"></property>
+ <property name="cpp_disconnect_events">1</property>
+ <property name="cpp_event_generation">connect</property>
+ <property name="cpp_help_provider">none</property>
+ <property name="cpp_namespace"></property>
+ <property name="cpp_precompiled_header"></property>
+ <property name="cpp_use_array_enum">0</property>
+ <property name="cpp_use_enum">0</property>
+ <property name="embedded_files_path">res</property>
+ <property name="encoding">UTF-8</property>
+ <property name="file">panel_embedded_files_base</property>
+ <property name="first_id">1000</property>
+ <property name="internationalize">1</property>
+ <property name="lua_skip_events">1</property>
+ <property name="lua_ui_table">UI</property>
+ <property name="name">panel_embedded_files</property>
+ <property name="path">.</property>
+ <property name="php_disconnect_events">0</property>
+ <property name="php_disconnect_mode">source_name</property>
+ <property name="php_skip_events">1</property>
+ <property name="python_disconnect_events">0</property>
+ <property name="python_disconnect_mode">source_name</property>
+ <property name="python_image_path_wrapper_function_name"></property>
+ <property name="python_indent_with_spaces"></property>
+ <property name="python_skip_events">1</property>
+ <property name="relative_path">1</property>
+ <property name="use_microsoft_bom">0</property>
+ <property name="use_native_eol">0</property>
+ <object class="Panel" expanded="true">
+ <property name="aui_managed">0</property>
+ <property name="aui_manager_style">wxAUI_MGR_DEFAULT</property>
+ <property name="bg"></property>
+ <property name="context_help"></property>
+ <property name="context_menu">1</property>
+ <property name="drag_accept_files">0</property>
+ <property name="enabled">1</property>
+ <property name="event_handler">impl_virtual</property>
+ <property name="fg"></property>
+ <property name="font"></property>
+ <property name="hidden">0</property>
+ <property name="id">wxID_ANY</property>
+ <property name="maximum_size"></property>
+ <property name="minimum_size">-1,-1</property>
+ <property name="name">PANEL_EMBEDDED_FILES_BASE</property>
+ <property name="pos"></property>
+ <property name="size">-1,-1</property>
+ <property name="subclass">; forward_declare</property>
+ <property name="tooltip"></property>
+ <property name="two_step_creation">0</property>
+ <property name="window_extra_style"></property>
+ <property name="window_name"></property>
+ <property name="window_style">wxTAB_TRAVERSAL</property>
+ <event name="OnSize">onSize</event>
+ <object class="wxBoxSizer" expanded="true">
+ <property name="minimum_size"></property>
+ <property name="name">bMainSizer</property>
+ <property name="orient">wxVERTICAL</property>
+ <property name="permission">none</property>
+ <object class="sizeritem" expanded="true">
+ <property name="border">5</property>
+ <property name="flag">wxEXPAND</property>
+ <property name="proportion">1</property>
+ <object class="wxBoxSizer" expanded="false">
+ <property name="minimum_size"></property>
+ <property name="name">m_global_sizer</property>
+ <property name="orient">wxVERTICAL</property>
+ <property name="permission">none</property>
+ <object class="sizeritem" expanded="false">
+ <property name="border">5</property>
+ <property name="flag">wxALL|wxEXPAND</property>
+ <property name="proportion">5</property>
+ <object class="wxGrid" expanded="false">
+ <property name="BottomDockable">1</property>
+ <property name="LeftDockable">1</property>
+ <property name="RightDockable">1</property>
+ <property name="TopDockable">1</property>
+ <property name="aui_layer">0</property>
+ <property name="aui_name"></property>
+ <property name="aui_position">0</property>
+ <property name="aui_row">0</property>
+ <property name="autosize_cols">0</property>
+ <property name="autosize_rows">1</property>
+ <property name="best_size"></property>
+ <property name="bg"></property>
+ <property name="caption"></property>
+ <property name="caption_visible">1</property>
+ <property name="cell_bg"></property>
+ <property name="cell_font"></property>
+ <property name="cell_horiz_alignment">wxALIGN_LEFT</property>
+ <property name="cell_text"></property>
+ <property name="cell_vert_alignment">wxALIGN_CENTER</property>
+ <property name="center_pane">0</property>
+ <property name="close_button">1</property>
+ <property name="col_label_horiz_alignment">wxALIGN_CENTER</property>
+ <property name="col_label_size">22</property>
+ <property name="col_label_values">"Filename" "Internal Reference"</property>
+ <property name="col_label_vert_alignment">wxALIGN_CENTER</property>
+ <property name="cols">2</property>
+ <property name="column_sizes">440,180</property>
+ <property name="context_help"></property>
+ <property name="context_menu">1</property>
+ <property name="default_pane">0</property>
+ <property name="dock">Dock</property>
+ <property name="dock_fixed">1</property>
+ <property name="docking">Left</property>
+ <property name="drag_accept_files">0</property>
+ <property name="drag_col_move">0</property>
+ <property name="drag_col_size">1</property>
+ <property name="drag_grid_size">0</property>
+ <property name="drag_row_size">0</property>
+ <property name="editing">0</property>
+ <property name="enabled">1</property>
+ <property name="fg"></property>
+ <property name="floatable">0</property>
+ <property name="font"></property>
+ <property name="grid_line_color"></property>
+ <property name="grid_lines">1</property>
+ <property name="gripper">0</property>
+ <property name="hidden">0</property>
+ <property name="id">wxID_ANY</property>
+ <property name="label_bg"></property>
+ <property name="label_font"></property>
+ <property name="label_text"></property>
+ <property name="margin_height">0</property>
+ <property name="margin_width">0</property>
+ <property name="max_size"></property>
+ <property name="maximize_button">0</property>
+ <property name="maximum_size"></property>
+ <property name="min_size"></property>
+ <property name="minimize_button">0</property>
+ <property name="minimum_size">-1,-1</property>
+ <property name="moveable">0</property>
+ <property name="name">m_files_grid</property>
+ <property name="pane_border">1</property>
+ <property name="pane_position"></property>
+ <property name="pane_size"></property>
+ <property name="permission">protected</property>
+ <property name="pin_button">1</property>
+ <property name="pos"></property>
+ <property name="resize">Fixed</property>
+ <property name="row_label_horiz_alignment">wxALIGN_CENTER</property>
+ <property name="row_label_size">0</property>
+ <property name="row_label_values"></property>
+ <property name="row_label_vert_alignment">wxALIGN_CENTER</property>
+ <property name="row_sizes"></property>
+ <property name="rows">1</property>
+ <property name="show">1</property>
+ <property name="size"></property>
+ <property name="subclass">WX_GRID; widgets/wx_grid.h; forward_declare</property>
+ <property name="toolbar_pane">0</property>
+ <property name="tooltip"></property>
+ <property name="window_extra_style"></property>
+ <property name="window_name"></property>
+ <property name="window_style"></property>
+ <event name="OnGridCellRightClick">onGridRightClick</event>
+ </object>
+ </object>
+ </object>
+ </object>
+ <object class="sizeritem" expanded="true">
+ <property name="border">3</property>
+ <property name="flag">wxEXPAND|wxALL</property>
+ <property name="proportion">0</property>
+ <object class="wxBoxSizer" expanded="false">
+ <property name="minimum_size"></property>
+ <property name="name">bButtonsSizer</property>
+ <property name="orient">wxHORIZONTAL</property>
+ <property name="permission">none</property>
+ <object class="sizeritem" expanded="false">
+ <property name="border">5</property>
+ <property name="flag">wxTOP|wxBOTTOM|wxRIGHT</property>
+ <property name="proportion">0</property>
+ <object class="wxBitmapButton" expanded="false">
+ <property name="BottomDockable">1</property>
+ <property name="LeftDockable">1</property>
+ <property name="RightDockable">1</property>
+ <property name="TopDockable">1</property>
+ <property name="aui_layer">0</property>
+ <property name="aui_name"></property>
+ <property name="aui_position">0</property>
+ <property name="aui_row">0</property>
+ <property name="auth_needed">0</property>
+ <property name="best_size"></property>
+ <property name="bg"></property>
+ <property name="bitmap"></property>
+ <property name="caption"></property>
+ <property name="caption_visible">1</property>
+ <property name="center_pane">0</property>
+ <property name="close_button">1</property>
+ <property name="context_help"></property>
+ <property name="context_menu">1</property>
+ <property name="current"></property>
+ <property name="default">0</property>
+ <property name="default_pane">0</property>
+ <property name="disabled"></property>
+ <property name="dock">Dock</property>
+ <property name="dock_fixed">0</property>
+ <property name="docking">Left</property>
+ <property name="drag_accept_files">0</property>
+ <property name="enabled">1</property>
+ <property name="fg"></property>
+ <property name="floatable">1</property>
+ <property name="focus"></property>
+ <property name="font"></property>
+ <property name="gripper">0</property>
+ <property name="hidden">0</property>
+ <property name="id">wxID_ANY</property>
+ <property name="label">Add Embedded File</property>
+ <property name="margins"></property>
+ <property name="markup">0</property>
+ <property name="max_size"></property>
+ <property name="maximize_button">0</property>
+ <property name="maximum_size"></property>
+ <property name="min_size"></property>
+ <property name="minimize_button">0</property>
+ <property name="minimum_size"></property>
+ <property name="moveable">1</property>
+ <property name="name">m_browse_button</property>
+ <property name="pane_border">1</property>
+ <property name="pane_position"></property>
+ <property name="pane_size"></property>
+ <property name="permission">protected</property>
+ <property name="pin_button">1</property>
+ <property name="pos"></property>
+ <property name="position"></property>
+ <property name="pressed"></property>
+ <property name="resize">Resizable</property>
+ <property name="show">1</property>
+ <property name="size">-1,-1</property>
+ <property name="style"></property>
+ <property name="subclass">STD_BITMAP_BUTTON; widgets/std_bitmap_button.h; forward_declare</property>
+ <property name="toolbar_pane">0</property>
+ <property name="tooltip">Add embedded file</property>
+ <property name="validator_data_type"></property>
+ <property name="validator_style">wxFILTER_NONE</property>
+ <property name="validator_type">wxDefaultValidator</property>
+ <property name="validator_variable"></property>
+ <property name="window_extra_style"></property>
+ <property name="window_name"></property>
+ <property name="window_style"></property>
+ <event name="OnButtonClick">onAddEmbeddedFile</event>
+ </object>
+ </object>
+ <object class="sizeritem" expanded="false">
+ <property name="border">5</property>
+ <property name="flag">wxEXPAND</property>
+ <property name="proportion">0</property>
+ <object class="spacer" expanded="false">
+ <property name="height">0</property>
+ <property name="permission">protected</property>
+ <property name="width">20</property>
+ </object>
+ </object>
+ <object class="sizeritem" expanded="false">
+ <property name="border">5</property>
+ <property name="flag">wxTOP|wxBOTTOM|wxRIGHT</property>
+ <property name="proportion">0</property>
+ <object class="wxBitmapButton" expanded="false">
+ <property name="BottomDockable">1</property>
+ <property name="LeftDockable">1</property>
+ <property name="RightDockable">1</property>
+ <property name="TopDockable">1</property>
+ <property name="aui_layer">0</property>
+ <property name="aui_name"></property>
+ <property name="aui_position">0</property>
+ <property name="aui_row">0</property>
+ <property name="auth_needed">0</property>
+ <property name="best_size"></property>
+ <property name="bg"></property>
+ <property name="bitmap"></property>
+ <property name="caption"></property>
+ <property name="caption_visible">1</property>
+ <property name="center_pane">0</property>
+ <property name="close_button">1</property>
+ <property name="context_help"></property>
+ <property name="context_menu">1</property>
+ <property name="current"></property>
+ <property name="default">0</property>
+ <property name="default_pane">0</property>
+ <property name="disabled"></property>
+ <property name="dock">Dock</property>
+ <property name="dock_fixed">0</property>
+ <property name="docking">Left</property>
+ <property name="drag_accept_files">0</property>
+ <property name="enabled">1</property>
+ <property name="fg"></property>
+ <property name="floatable">1</property>
+ <property name="focus"></property>
+ <property name="font"></property>
+ <property name="gripper">0</property>
+ <property name="hidden">0</property>
+ <property name="id">wxID_ANY</property>
+ <property name="label">Delete SelectedFile</property>
+ <property name="margins"></property>
+ <property name="markup">0</property>
+ <property name="max_size"></property>
+ <property name="maximize_button">0</property>
+ <property name="maximum_size"></property>
+ <property name="min_size"></property>
+ <property name="minimize_button">0</property>
+ <property name="minimum_size"></property>
+ <property name="moveable">1</property>
+ <property name="name">m_delete_button</property>
+ <property name="pane_border">1</property>
+ <property name="pane_position"></property>
+ <property name="pane_size"></property>
+ <property name="permission">protected</property>
+ <property name="pin_button">1</property>
+ <property name="pos"></property>
+ <property name="position"></property>
+ <property name="pressed"></property>
+ <property name="resize">Resizable</property>
+ <property name="show">1</property>
+ <property name="size">-1,-1</property>
+ <property name="style"></property>
+ <property name="subclass">STD_BITMAP_BUTTON; widgets/std_bitmap_button.h; forward_declare</property>
+ <property name="toolbar_pane">0</property>
+ <property name="tooltip">Remove embedded file</property>
+ <property name="validator_data_type"></property>
+ <property name="validator_style">wxFILTER_NONE</property>
+ <property name="validator_type">wxDefaultValidator</property>
+ <property name="validator_variable"></property>
+ <property name="window_extra_style"></property>
+ <property name="window_name"></property>
+ <property name="window_style"></property>
+ <event name="OnButtonClick">onDeleteEmbeddedFile</event>
+ </object>
+ </object>
+ <object class="sizeritem" expanded="false">
+ <property name="border">5</property>
+ <property name="flag">wxEXPAND</property>
+ <property name="proportion">1</property>
+ <object class="spacer" expanded="false">
+ <property name="height">0</property>
+ <property name="permission">protected</property>
+ <property name="width">0</property>
+ </object>
+ </object>
+ <object class="sizeritem" expanded="false">
+ <property name="border">5</property>
+ <property name="flag">wxALIGN_CENTER_VERTICAL|wxALL</property>
+ <property name="proportion">0</property>
+ <object class="wxButton" expanded="false">
+ <property name="BottomDockable">1</property>
+ <property name="LeftDockable">1</property>
+ <property name="RightDockable">1</property>
+ <property name="TopDockable">1</property>
+ <property name="aui_layer">0</property>
+ <property name="aui_name"></property>
+ <property name="aui_position">0</property>
+ <property name="aui_row">0</property>
+ <property name="auth_needed">0</property>
+ <property name="best_size"></property>
+ <property name="bg"></property>
+ <property name="bitmap"></property>
+ <property name="caption"></property>
+ <property name="caption_visible">1</property>
+ <property name="center_pane">0</property>
+ <property name="close_button">1</property>
+ <property name="context_help"></property>
+ <property name="context_menu">1</property>
+ <property name="current"></property>
+ <property name="default">0</property>
+ <property name="default_pane">0</property>
+ <property name="disabled"></property>
+ <property name="dock">Dock</property>
+ <property name="dock_fixed">0</property>
+ <property name="docking">Left</property>
+ <property name="drag_accept_files">0</property>
+ <property name="enabled">1</property>
+ <property name="fg"></property>
+ <property name="floatable">1</property>
+ <property name="focus"></property>
+ <property name="font"></property>
+ <property name="gripper">0</property>
+ <property name="hidden">0</property>
+ <property name="id">wxID_ANY</property>
+ <property name="label">&Export</property>
+ <property name="margins"></property>
+ <property name="markup">0</property>
+ <property name="max_size"></property>
+ <property name="maximize_button">0</property>
+ <property name="maximum_size"></property>
+ <property name="min_size"></property>
+ <property name="minimize_button">0</property>
+ <property name="minimum_size"></property>
+ <property name="moveable">1</property>
+ <property name="name">m_export</property>
+ <property name="pane_border">1</property>
+ <property name="pane_position"></property>
+ <property name="pane_size"></property>
+ <property name="permission">protected</property>
+ <property name="pin_button">1</property>
+ <property name="pos"></property>
+ <property name="position"></property>
+ <property name="pressed"></property>
+ <property name="resize">Resizable</property>
+ <property name="show">1</property>
+ <property name="size"></property>
+ <property name="style"></property>
+ <property name="subclass">; ; forward_declare</property>
+ <property name="toolbar_pane">0</property>
+ <property name="tooltip"></property>
+ <property name="validator_data_type"></property>
+ <property name="validator_style">wxFILTER_NONE</property>
+ <property name="validator_type">wxDefaultValidator</property>
+ <property name="validator_variable"></property>
+ <property name="window_extra_style"></property>
+ <property name="window_name"></property>
+ <property name="window_style"></property>
+ <event name="OnButtonClick">onExportFiles</event>
+ </object>
+ </object>
+ </object>
+ </object>
+ <object class="sizeritem" expanded="true">
+ <property name="border">5</property>
+ <property name="flag">wxEXPAND | wxALL</property>
+ <property name="proportion">0</property>
+ <object class="wxStaticLine" expanded="true">
+ <property name="BottomDockable">1</property>
+ <property name="LeftDockable">1</property>
+ <property name="RightDockable">1</property>
+ <property name="TopDockable">1</property>
+ <property name="aui_layer">0</property>
+ <property name="aui_name"></property>
+ <property name="aui_position">0</property>
+ <property name="aui_row">0</property>
+ <property name="best_size"></property>
+ <property name="bg"></property>
+ <property name="caption"></property>
+ <property name="caption_visible">1</property>
+ <property name="center_pane">0</property>
+ <property name="close_button">1</property>
+ <property name="context_help"></property>
+ <property name="context_menu">1</property>
+ <property name="default_pane">0</property>
+ <property name="dock">Dock</property>
+ <property name="dock_fixed">0</property>
+ <property name="docking">Left</property>
+ <property name="drag_accept_files">0</property>
+ <property name="enabled">1</property>
+ <property name="fg"></property>
+ <property name="floatable">1</property>
+ <property name="font"></property>
+ <property name="gripper">0</property>
+ <property name="hidden">0</property>
+ <property name="id">wxID_ANY</property>
+ <property name="max_size"></property>
+ <property name="maximize_button">0</property>
+ <property name="maximum_size"></property>
+ <property name="min_size"></property>
+ <property name="minimize_button">0</property>
+ <property name="minimum_size"></property>
+ <property name="moveable">1</property>
+ <property name="name">m_staticline1</property>
+ <property name="pane_border">1</property>
+ <property name="pane_position"></property>
+ <property name="pane_size"></property>
+ <property name="permission">protected</property>
+ <property name="pin_button">1</property>
+ <property name="pos"></property>
+ <property name="resize">Resizable</property>
+ <property name="show">1</property>
+ <property name="size"></property>
+ <property name="style">wxLI_HORIZONTAL</property>
+ <property name="subclass">; ; forward_declare</property>
+ <property name="toolbar_pane">0</property>
+ <property name="tooltip"></property>
+ <property name="window_extra_style"></property>
+ <property name="window_name"></property>
+ <property name="window_style"></property>
+ </object>
+ </object>
+ <object class="sizeritem" expanded="true">
+ <property name="border">5</property>
+ <property name="flag">wxEXPAND</property>
+ <property name="proportion">0</property>
+ <object class="wxBoxSizer" expanded="true">
+ <property name="minimum_size"></property>
+ <property name="name">bSizer4</property>
+ <property name="orient">wxVERTICAL</property>
+ <property name="permission">none</property>
+ <object class="sizeritem" expanded="true">
+ <property name="border">5</property>
+ <property name="flag">wxALL</property>
+ <property name="proportion">0</property>
+ <object class="wxCheckBox" expanded="true">
+ <property name="BottomDockable">1</property>
+ <property name="LeftDockable">1</property>
+ <property name="RightDockable">1</property>
+ <property name="TopDockable">1</property>
+ <property name="aui_layer">0</property>
+ <property name="aui_name"></property>
+ <property name="aui_position">0</property>
+ <property name="aui_row">0</property>
+ <property name="best_size"></property>
+ <property name="bg"></property>
+ <property name="caption"></property>
+ <property name="caption_visible">1</property>
+ <property name="center_pane">0</property>
+ <property name="checked">0</property>
+ <property name="close_button">1</property>
+ <property name="context_help"></property>
+ <property name="context_menu">1</property>
+ <property name="default_pane">0</property>
+ <property name="dock">Dock</property>
+ <property name="dock_fixed">0</property>
+ <property name="docking">Left</property>
+ <property name="drag_accept_files">0</property>
+ <property name="enabled">1</property>
+ <property name="fg"></property>
+ <property name="floatable">1</property>
+ <property name="font"></property>
+ <property name="gripper">0</property>
+ <property name="hidden">0</property>
+ <property name="id">wxID_ANY</property>
+ <property name="label">Embed Fonts</property>
+ <property name="max_size"></property>
+ <property name="maximize_button">0</property>
+ <property name="maximum_size"></property>
+ <property name="min_size"></property>
+ <property name="minimize_button">0</property>
+ <property name="minimum_size"></property>
+ <property name="moveable">1</property>
+ <property name="name">m_cbEmbedFonts</property>
+ <property name="pane_border">1</property>
+ <property name="pane_position"></property>
+ <property name="pane_size"></property>
+ <property name="permission">protected</property>
+ <property name="pin_button">1</property>
+ <property name="pos"></property>
+ <property name="resize">Resizable</property>
+ <property name="show">1</property>
+ <property name="size"></property>
+ <property name="style"></property>
+ <property name="subclass">; ; forward_declare</property>
+ <property name="toolbar_pane">0</property>
+ <property name="tooltip">Store a copy of all fonts used</property>
+ <property name="validator_data_type"></property>
+ <property name="validator_style">wxFILTER_NONE</property>
+ <property name="validator_type">wxDefaultValidator</property>
+ <property name="validator_variable"></property>
+ <property name="window_extra_style"></property>
+ <property name="window_name"></property>
+ <property name="window_style"></property>
+ </object>
+ </object>
+ </object>
+ </object>
+ </object>
+ </object>
+ </object>
+</wxFormBuilder_Project>
diff --git a/common/dialogs/panel_embedded_files_base.h b/common/dialogs/panel_embedded_files_base.h
new file mode 100644
index 0000000000..22270be115
--- /dev/null
+++ b/common/dialogs/panel_embedded_files_base.h
@@ -0,0 +1,64 @@
+///////////////////////////////////////////////////////////////////////////
+// C++ code generated with wxFormBuilder (version 4.2.1-0-g80c4cb6a-dirty)
+// http://www.wxformbuilder.org/
+//
+// PLEASE DO *NOT* EDIT THIS FILE!
+///////////////////////////////////////////////////////////////////////////
+
+#pragma once
+
+#include <wx/artprov.h>
+#include <wx/xrc/xmlres.h>
+#include <wx/intl.h>
+class STD_BITMAP_BUTTON;
+class WX_GRID;
+
+#include <wx/colour.h>
+#include <wx/settings.h>
+#include <wx/string.h>
+#include <wx/font.h>
+#include <wx/grid.h>
+#include <wx/gdicmn.h>
+#include <wx/sizer.h>
+#include <wx/bmpbuttn.h>
+#include <wx/bitmap.h>
+#include <wx/image.h>
+#include <wx/icon.h>
+#include <wx/button.h>
+#include <wx/statline.h>
+#include <wx/checkbox.h>
+#include <wx/panel.h>
+
+///////////////////////////////////////////////////////////////////////////
+
+///////////////////////////////////////////////////////////////////////////////
+/// Class PANEL_EMBEDDED_FILES_BASE
+///////////////////////////////////////////////////////////////////////////////
+class PANEL_EMBEDDED_FILES_BASE : public wxPanel
+{
+ private:
+
+ protected:
+ WX_GRID* m_files_grid;
+ STD_BITMAP_BUTTON* m_browse_button;
+ STD_BITMAP_BUTTON* m_delete_button;
+ wxButton* m_export;
+ wxStaticLine* m_staticline1;
+ wxCheckBox* m_cbEmbedFonts;
+
+ // Virtual event handlers, override them in your derived class
+ virtual void onSize( wxSizeEvent& event ) { event.Skip(); }
+ virtual void onGridRightClick( wxGridEvent& event ) { event.Skip(); }
+ virtual void onAddEmbeddedFile( wxCommandEvent& event ) { event.Skip(); }
+ virtual void onDeleteEmbeddedFile( wxCommandEvent& event ) { event.Skip(); }
+ virtual void onExportFiles( wxCommandEvent& event ) { event.Skip(); }
+
+
+ public:
+
+ PANEL_EMBEDDED_FILES_BASE( wxWindow* parent, wxWindowID id = wxID_ANY, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxSize( -1,-1 ), long style = wxTAB_TRAVERSAL, const wxString& name = wxEmptyString );
+
+ ~PANEL_EMBEDDED_FILES_BASE();
+
+};
+
diff --git a/common/drawing_sheet/ds_data_model.cpp b/common/drawing_sheet/ds_data_model.cpp
index 370ba9064b..8dc2f9f27d 100644
--- a/common/drawing_sheet/ds_data_model.cpp
+++ b/common/drawing_sheet/ds_data_model.cpp
@@ -145,33 +145,3 @@ DS_DATA_ITEM* DS_DATA_MODEL::GetItem( unsigned aIdx ) const
return nullptr;
}
-
-const wxString DS_DATA_MODEL::ResolvePath( const wxString& aPath, const wxString& aProjectPath )
-{
- wxString fullFileName = ExpandEnvVarSubstitutions( aPath, nullptr );
-
- if( fullFileName.IsEmpty() )
- return fullFileName;
-
- wxFileName fn = fullFileName;
-
- if( fn.IsAbsolute() )
- return fullFileName;
-
- // the path is not absolute: search it in project path, and then in kicad valid paths
- if( !aProjectPath.IsEmpty() )
- {
- fn.MakeAbsolute( aProjectPath );
-
- if( wxFileExists( fn.GetFullPath() ) )
- return fn.GetFullPath();
- }
-
- fn = fullFileName;
- wxString name = Kiface().KifaceSearch().FindValidPath( fn.GetFullName() );
-
- if( !name.IsEmpty() )
- fullFileName = name;
-
- return fullFileName;
-}
diff --git a/common/dsnlexer.cpp b/common/dsnlexer.cpp
index 89c4d87631..73d0a4cfcb 100644
--- a/common/dsnlexer.cpp
+++ b/common/dsnlexer.cpp
@@ -276,6 +276,9 @@ const char* DSNLEXER::Syntax( int aTok )
case DSN_EOF:
ret = "end of input";
break;
+ case DSN_BAR:
+ ret = "|";
+ break;
default:
ret = "???";
}
@@ -379,6 +382,15 @@ void DSNLEXER::NeedRIGHT()
}
+void DSNLEXER::NeedBAR()
+{
+ int tok = NextTok();
+
+ if( tok != DSN_BAR )
+ Expecting( DSN_BAR );
+}
+
+
int DSNLEXER::NeedSYMBOL()
{
int tok = NextTok();
@@ -452,7 +464,7 @@ inline bool isDigit( char cc )
///< @return true if @a cc is an s-expression separator character.
inline bool isSep( char cc )
{
- return isSpace( cc ) || cc=='(' || cc==')';
+ return isSpace( cc ) || cc == '(' || cc == ')' || cc == '|';
}
@@ -597,6 +609,14 @@ L_read:
goto exit;
}
+ if( *cur == '|' )
+ {
+ curText = *cur;
+ curTok = DSN_BAR;
+ head = cur+1;
+ goto exit;
+ }
+
// Non-specctraMode, understands and deciphers escaped \, \r, \n, and \".
// Strips off leading and trailing double quotes
if( !specctraMode )
diff --git a/common/eda_doc.cpp b/common/eda_doc.cpp
index 88f9c21dbb..78e2504831 100644
--- a/common/eda_doc.cpp
+++ b/common/eda_doc.cpp
@@ -25,6 +25,7 @@
#include <pgm_base.h>
#include <common.h>
#include <confirm.h>
+#include <embedded_files.h>
#include <gestfich.h>
#include <settings/common_settings.h>
@@ -58,7 +59,8 @@ static const wxFileTypeInfo EDAfallbacks[] =
};
-bool GetAssociatedDocument( wxWindow* aParent, const wxString& aDocName, PROJECT* aProject, SEARCH_STACK* aPaths )
+bool GetAssociatedDocument( wxWindow* aParent, const wxString& aDocName, PROJECT* aProject,
+ SEARCH_STACK* aPaths, EMBEDDED_FILES* aFiles )
{
wxString docname;
wxString fullfilename;
@@ -74,8 +76,48 @@ bool GetAssociatedDocument( wxWindow* aParent, const wxString& aDocName, PROJECT
wxURI uri( docname );
wxLogNull logNo; // Disable log messages
- if( uri.HasScheme() && wxLaunchDefaultBrowser( docname ) )
- return true;
+ if( uri.HasScheme() )
+ {
+ wxString scheme = uri.GetScheme().Lower();
+
+ if( scheme != FILEEXT::KiCadUriPrefix )
+ {
+ if( wxLaunchDefaultBrowser( docname ) )
+ return true;
+ }
+ else
+ {
+ if( !aFiles )
+ {
+ wxLogTrace( wxT( "KICAD_EMBED" ),
+ wxT( "No EMBEDDED_FILES object provided for kicad_embed URI" ) );
+ return false;
+ }
+
+ if( !docname.starts_with( FILEEXT::KiCadUriPrefix + "://" ) )
+ {
+ wxLogTrace( wxT( "KICAD_EMBED" ),
+ wxT( "Invalid kicad_embed URI '%s'" ), docname );
+ return false;
+ }
+
+ docname = docname.Mid( 14 );
+
+ wxFileName temp_file = aFiles->GetTempFileName( docname );
+
+ if( !temp_file.IsOk() )
+ {
+ wxLogTrace( wxT( "KICAD_EMBED" ),
+ wxT( "Failed to get temp file '%s' for kicad_embed URI" ), docname );
+ return false;
+ }
+
+ wxLogTrace( wxT( "KICAD_EMBED" ),
+ wxT( "Opening embedded file '%s' as '%s'" ),
+ docname, temp_file.GetFullPath() );
+ docname = temp_file.GetFullPath();
+ }
+ }
}
#ifdef __WINDOWS__
diff --git a/common/embedded_files.cpp b/common/embedded_files.cpp
new file mode 100644
index 0000000000..c7b7aa4727
--- /dev/null
+++ b/common/embedded_files.cpp
@@ -0,0 +1,511 @@
+/*
+ * 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, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <wx/base64.h>
+#include <wx/debug.h>
+#include <wx/file.h>
+#include <wx/filename.h>
+#include <wx/log.h>
+#include <wx/mstream.h>
+#include <wx/wfstream.h>
+
+#include <map>
+#include <memory>
+#include <sstream>
+
+#include <zstd.h>
+
+#include <embedded_files.h>
+#include <kiid.h>
+#include <paths.h>
+
+
+
+EMBEDDED_FILES::EMBEDDED_FILE* EMBEDDED_FILES::AddFile( const wxFileName& aName, bool aOverwrite )
+{
+ if( HasFile( aName.GetFullName() ) )
+ {
+ if( !aOverwrite )
+ return m_files[aName.GetFullName()];
+
+ m_files.erase( aName.GetFullName() );
+ }
+
+ wxFFileInputStream file( aName.GetFullPath() );
+ wxMemoryBuffer buffer;
+
+ if( !file.IsOk() )
+ return nullptr;
+
+ wxFileOffset length = file.GetLength();
+
+ std::unique_ptr<EMBEDDED_FILE> efile = std::make_unique<EMBEDDED_FILE>();
+ efile->name = aName.GetFullName();
+ efile->decompressedData.resize( length );
+
+ wxString ext = aName.GetExt().Upper();
+
+ // Handle some common file extensions
+ if( ext == "STP" || ext == "STPZ" || ext == "STEP" || ext == "WRL" || ext == "WRZ" )
+ {
+ efile->type = EMBEDDED_FILE::FILE_TYPE::MODEL;
+ }
+ else if( ext == "WOFF" || ext == "WOFF2" || ext == "TTF" || ext == "OTF" )
+ {
+ efile->type = EMBEDDED_FILE::FILE_TYPE::FONT;
+ }
+ else if( ext == "PDF" )
+ {
+ efile->type = EMBEDDED_FILE::FILE_TYPE::DATASHEET;
+ }
+ else if( ext == "KICAD_WKS" )
+ {
+ efile->type = EMBEDDED_FILE::FILE_TYPE::WORKSHEET;
+ }
+
+ if( !efile->decompressedData.data() )
+ return nullptr;
+
+ char* data = efile->decompressedData.data();
+ wxFileOffset total_read = 0;
+
+ while( !file.Eof() && total_read < length )
+ {
+ file.Read( data, length - total_read );
+
+ size_t read = file.LastRead();
+ data += read;
+ total_read += read;
+ }
+
+ if( CompressAndEncode( *efile ) != RETURN_CODE::OK )
+ return nullptr;
+
+ efile->is_valid = true;
+
+ m_files[aName.GetFullName()] = efile.release();
+
+ return m_files[aName.GetFullName()];
+}
+
+
+void EMBEDDED_FILES::AddFile( EMBEDDED_FILE* aFile )
+{
+ m_files.insert( { aFile->name, aFile } );
+}
+
+// Remove a file from the collection
+void EMBEDDED_FILES::RemoveFile( const wxString& name, bool aErase )
+{
+ auto it = m_files.find( name );
+
+ if( it != m_files.end() )
+ {
+ m_files.erase( it );
+
+ if( aErase )
+ delete it->second;
+ }
+}
+
+
+void EMBEDDED_FILES::ClearEmbeddedFonts()
+{
+ for( auto it = m_files.begin(); it != m_files.end(); )
+ {
+ if( it->second->type == EMBEDDED_FILE::FILE_TYPE::FONT )
+ {
+ delete it->second;
+ it = m_files.erase( it );
+ }
+ else
+ {
+ ++it;
+ }
+ }
+}
+
+
+// Write the collection of files to a disk file in the specified format
+void EMBEDDED_FILES::WriteEmbeddedFiles( OUTPUTFORMATTER& aOut, int aNestLevel,
+ bool aWriteData ) const
+{
+ ssize_t MIME_BASE64_LENGTH = 76;
+ aOut.Print( aNestLevel, "(embedded_files\n" );
+
+ for( const auto& [name, entry] : m_files )
+ {
+ const EMBEDDED_FILE& file = *entry;
+
+ aOut.Print( aNestLevel + 1, "(file\n" );
+ aOut.Print( aNestLevel + 2, "(name \"%s\")\n", file.name.c_str().AsChar() );
+
+ const char* type = nullptr;
+
+ switch( file.type )
+ {
+ case EMBEDDED_FILE::FILE_TYPE::DATASHEET:
+ type = "datasheet";
+ break;
+ case EMBEDDED_FILE::FILE_TYPE::FONT:
+ type = "font";
+ break;
+ case EMBEDDED_FILE::FILE_TYPE::MODEL:
+ type = "model";
+ break;
+ case EMBEDDED_FILE::FILE_TYPE::WORKSHEET:
+ type = "worksheet";
+ break;
+ default:
+ type = "other";
+ break;
+ }
+
+ aOut.Print( aNestLevel + 2, "(type %s)\n", type );
+
+ if( aWriteData )
+ {
+ aOut.Print( 2, "(data\n" );
+
+ size_t first = 0;
+
+ while( first < file.compressedEncodedData.length() )
+ {
+ ssize_t remaining = file.compressedEncodedData.length() - first;
+ int length = std::min( remaining, MIME_BASE64_LENGTH );
+
+ std::string_view view( file.compressedEncodedData.data() + first, length );
+
+ aOut.Print( aNestLevel + 3, "%1s%.*s%s\n", first ? "" : "|", length, view.data(),
+ remaining == length ? "|" : "" );
+ first += MIME_BASE64_LENGTH;
+ }
+ aOut.Print( aNestLevel + 2, ")\n" ); // Close data
+ }
+
+ aOut.Print( aNestLevel + 2, "(checksum \"%s\")\n", file.data_sha.c_str() );
+ aOut.Print( aNestLevel + 1, ")\n" ); // Close file
+ }
+
+ aOut.Print( aNestLevel, ")\n" ); // Close embedded_files
+}
+
+// Compress and Base64 encode data
+EMBEDDED_FILES::RETURN_CODE EMBEDDED_FILES::CompressAndEncode( EMBEDDED_FILE& aFile )
+{
+ std::vector<char> compressedData;
+ size_t estCompressedSize = ZSTD_compressBound( aFile.decompressedData.size() );
+ compressedData.resize( estCompressedSize );
+ size_t compressedSize = ZSTD_compress( compressedData.data(), estCompressedSize,
+ aFile.decompressedData.data(),
+ aFile.decompressedData.size(), 15 );
+
+ if( ZSTD_isError( compressedSize ) )
+ {
+ compressedData.clear();
+ return RETURN_CODE::OUT_OF_MEMORY;
+ }
+
+ const size_t dstLen = wxBase64EncodedSize( compressedSize );
+ aFile.compressedEncodedData.resize( dstLen );
+ size_t retval = wxBase64Encode( aFile.compressedEncodedData.data(), dstLen,
+ compressedData.data(), compressedSize );
+ if( retval != dstLen )
+ {
+ aFile.compressedEncodedData.clear();
+ return RETURN_CODE::OUT_OF_MEMORY;
+ }
+
+ picosha2::hash256_hex_string( aFile.decompressedData, aFile.data_sha );
+
+ return RETURN_CODE::OK;
+}
+
+// Decompress and Base64 decode data
+EMBEDDED_FILES::RETURN_CODE EMBEDDED_FILES::DecompressAndDecode( EMBEDDED_FILE& aFile )
+{
+ std::vector<char> compressedData;
+ size_t compressedSize = wxBase64DecodedSize( aFile.compressedEncodedData.size() );
+
+ if( compressedSize == 0 )
+ {
+ wxLogTrace( wxT( "KICAD_EMBED" ),
+ wxT( "%s:%s:%d\n * Base64DecodedSize failed for file '%s' with size %zu" ),
+ __FILE__, __FUNCTION__, __LINE__, aFile.name, aFile.compressedEncodedData.size() );
+ return RETURN_CODE::OUT_OF_MEMORY;
+ }
+
+ compressedData.resize( compressedSize );
+ void* compressed = compressedData.data();
+
+ // The return value from wxBase64Decode is the actual size of the decoded data avoiding
+ // the modulo 4 padding of the base64 encoding
+ compressedSize = wxBase64Decode( compressed, compressedSize, aFile.compressedEncodedData );
+
+ unsigned long long estDecompressedSize = ZSTD_getFrameContentSize( compressed, compressedSize );
+
+ if( estDecompressedSize > 1e9 ) // Limit to 1GB
+ return RETURN_CODE::OUT_OF_MEMORY;
+
+ if( estDecompressedSize == ZSTD_CONTENTSIZE_ERROR
+ || estDecompressedSize == ZSTD_CONTENTSIZE_UNKNOWN )
+ {
+ return RETURN_CODE::OUT_OF_MEMORY;
+ }
+
+ aFile.decompressedData.resize( estDecompressedSize );
+ void* decompressed = aFile.decompressedData.data();
+
+ size_t decompressedSize = ZSTD_decompress( decompressed, estDecompressedSize,
+ compressed, compressedSize );
+
+ if( ZSTD_isError( decompressedSize ) )
+ {
+ wxLogTrace( wxT( "KICAD_EMBED" ),
+ wxT( "%s:%s:%d\n * ZSTD_decompress failed with error '%s'" ),
+ __FILE__, __FUNCTION__, __LINE__, ZSTD_getErrorName( decompressedSize ) );
+ aFile.decompressedData.clear();
+ return RETURN_CODE::OUT_OF_MEMORY;
+ }
+
+ aFile.decompressedData.resize( decompressedSize );
+
+ std::string new_sha;
+ picosha2::hash256_hex_string( aFile.decompressedData, new_sha );
+
+ if( new_sha != aFile.data_sha )
+ {
+ wxLogTrace( wxT( "KICAD_EMBED" ),
+ wxT( "%s:%s:%d\n * Checksum error in embedded file '%s'" ),
+ __FILE__, __FUNCTION__, __LINE__, aFile.name );
+ aFile.decompressedData.clear();
+ return RETURN_CODE::CHECKSUM_ERROR;
+ }
+
+ return RETURN_CODE::OK;
+}
+
+// Parsing method
+void EMBEDDED_FILES_PARSER::ParseEmbedded( EMBEDDED_FILES* aFiles )
+{
+ if( !aFiles )
+ THROW_PARSE_ERROR( "No embedded files object provided", CurSource(), CurLine(),
+ CurLineNumber(), CurOffset() );
+
+ using namespace EMBEDDED_FILES_T;
+
+ std::unique_ptr<EMBEDDED_FILES::EMBEDDED_FILE> file( nullptr );
+
+ for( T token = NextTok(); token != T_RIGHT; token = NextTok() )
+ {
+ if( token != T_LEFT )
+ Expecting( T_LEFT );
+
+ token = NextTok();
+
+ if( token != T_file )
+ Expecting( "file" );
+
+ if( file )
+ {
+ if( !file->compressedEncodedData.empty() )
+ {
+ EMBEDDED_FILES::DecompressAndDecode( *file );
+
+ if( !file->Validate() )
+ THROW_PARSE_ERROR( "Checksum error in embedded file " + file->name, CurSource(),
+ CurLine(), CurLineNumber(), CurOffset() );
+ }
+
+ aFiles->AddFile( file.release() );
+ }
+
+ file = std::unique_ptr<EMBEDDED_FILES::EMBEDDED_FILE>( nullptr );
+
+
+ for( token = NextTok(); token != T_RIGHT; token = NextTok() )
+ {
+ if( token != T_LEFT )
+ Expecting( T_LEFT );
+
+ token = NextTok();
+
+ switch( token )
+ {
+
+ case T_checksum:
+ NeedSYMBOLorNUMBER();
+
+ if( !IsSymbol( token ) )
+ Expecting( "checksum data" );
+
+ file->data_sha = CurStr();
+ NeedRIGHT();
+ break;
+
+ case T_data:
+ NeedBAR();
+ token = NextTok();
+
+ file->compressedEncodedData.reserve( 1 << 17 );
+
+ while( token != T_BAR )
+ {
+ if( !IsSymbol( token ) )
+ Expecting( "base64 file data" );
+
+ file->compressedEncodedData += CurStr();
+ token = NextTok();
+ }
+
+ file->compressedEncodedData.shrink_to_fit();
+
+ NeedRIGHT();
+ break;
+
+ case T_name:
+
+ if( file )
+ {
+ wxLogTrace( wxT( "KICAD_EMBED" ),
+ wxT( "Duplicate 'name' tag in embedded file %s" ), file->name );
+ }
+
+ NeedSYMBOLorNUMBER();
+
+ file = std::make_unique<EMBEDDED_FILES::EMBEDDED_FILE>();
+ file->name = CurStr();
+ NeedRIGHT();
+
+ break;
+
+ case T_type:
+
+ token = NextTok();
+
+ switch( token )
+ {
+ case T_datasheet:
+ file->type = EMBEDDED_FILES::EMBEDDED_FILE::FILE_TYPE::DATASHEET;
+ break;
+ case T_font:
+ file->type = EMBEDDED_FILES::EMBEDDED_FILE::FILE_TYPE::FONT;
+ break;
+ case T_model:
+ file->type = EMBEDDED_FILES::EMBEDDED_FILE::FILE_TYPE::MODEL;
+ break;
+ case T_worksheet:
+ file->type = EMBEDDED_FILES::EMBEDDED_FILE::FILE_TYPE::WORKSHEET;
+ break;
+ case T_other:
+ file->type = EMBEDDED_FILES::EMBEDDED_FILE::FILE_TYPE::OTHER;
+ break;
+ default:
+ Expecting( "datasheet, font, model, worksheet or other" );
+ break;
+ }
+ NeedRIGHT();
+ break;
+
+ default:
+ Expecting( "checksum, data or name" );
+ }
+ }
+ }
+
+ // Add the last file in the collection
+ if( file )
+ {
+ if( !file->compressedEncodedData.empty() )
+ {
+ EMBEDDED_FILES::DecompressAndDecode( *file );
+
+ if( !file->Validate() )
+ THROW_PARSE_ERROR( "Checksum error in embedded file " + file->name, CurSource(),
+ CurLine(), CurLineNumber(), CurOffset() );
+ }
+
+ aFiles->AddFile( file.release() );
+ }
+}
+
+
+wxFileName EMBEDDED_FILES::GetTempFileName( const wxString& aName ) const
+{
+ wxFileName cacheFile;
+
+ auto it = m_files.find( aName );
+
+ if( it == m_files.end() )
+ return cacheFile;
+
+ cacheFile.AssignDir( PATHS::GetUserCachePath() );
+ cacheFile.AppendDir( wxT( "embed" ) );
+
+ if( !PATHS::EnsurePathExists( cacheFile.GetFullPath() ) )
+ {
+ wxLogTrace( wxT( "KICAD_EMBED" ),
+ wxT( "%s:%s:%d\n * failed to create embed cache directory '%s'" ),
+ __FILE__, __FUNCTION__, __LINE__, cacheFile.GetPath() );
+
+ cacheFile.SetPath( wxFileName::GetTempDir() );
+ }
+
+ wxFileName inputName( aName );
+
+ // Store the cache file name using the data SHA to allow for shared data between
+ // multiple projects using the same files as well as deconflicting files with the same name
+ cacheFile.SetName( "kicad_embedded_" + it->second->data_sha );
+ cacheFile.SetExt( inputName.GetExt() );
+
+ if( cacheFile.FileExists() && cacheFile.IsFileReadable() )
+ return cacheFile;
+
+ wxFFileOutputStream out( cacheFile.GetFullPath() );
+
+ if( !out.IsOk() )
+ {
+ cacheFile.Clear();
+ return cacheFile;
+ }
+
+ out.Write( it->second->decompressedData.data(), it->second->decompressedData.size() );
+
+ return cacheFile;
+}
+
+
+const std::vector<wxString>* EMBEDDED_FILES::GetFontFiles() const
+{
+ return &m_fontFiles;
+}
+
+
+const std::vector<wxString>* EMBEDDED_FILES::UpdateFontFiles()
+{
+ m_fontFiles.clear();
+
+ for( const auto& [name, entry] : m_files )
+ {
+ if( entry->type == EMBEDDED_FILE::FILE_TYPE::FONT )
+ m_fontFiles.push_back( GetTempFileName( name ).GetFullPath() );
+ }
+
+ return &m_fontFiles;
+}
\ No newline at end of file
diff --git a/common/embedded_files.keywords b/common/embedded_files.keywords
new file mode 100644
index 0000000000..ebc07f6eb2
--- /dev/null
+++ b/common/embedded_files.keywords
@@ -0,0 +1,13 @@
+checksum
+data
+datasheet
+embedded_files
+embedded_fonts
+file
+font
+model
+name
+other
+reference
+type
+worksheet
\ No newline at end of file
diff --git a/common/filename_resolver.cpp b/common/filename_resolver.cpp
index 10f9637d5c..4de8f9910e 100644
--- a/common/filename_resolver.cpp
+++ b/common/filename_resolver.cpp
@@ -27,10 +27,12 @@
#include <sstream>
#include <wx/log.h>
+#include <wx/uri.h>
#include <pgm_base.h>
#include <trace_helpers.h>
#include <common.h>
+#include <embedded_files.h>
#include <env_vars.h>
#include <filename_resolver.h>
#include <confirm.h>
@@ -241,7 +243,8 @@ bool FILENAME_RESOLVER::UpdatePathList( const std::vector< SEARCH_PATH >& aPathL
}
-wxString FILENAME_RESOLVER::ResolvePath( const wxString& aFileName, const wxString& aWorkingPath )
+wxString FILENAME_RESOLVER::ResolvePath( const wxString& aFileName, const wxString& aWorkingPath,
+ const EMBEDDED_FILES* aFiles )
{
std::lock_guard<std::mutex> lock( mutex_resolver );
@@ -260,6 +263,32 @@ wxString FILENAME_RESOLVER::ResolvePath( const wxString& aFileName, const wxStri
// for getenv().
tname = ExpandEnvVarSubstitutions( tname, m_project );
+ // Check to see if the file is a URI for an embedded file.
+ if( tname.StartsWith( FILEEXT::KiCadUriPrefix + "://" ) )
+ {
+ if( !aFiles )
+ {
+ wxLogTrace( wxT( "KICAD_EMBED" ),
+ wxT( "No EMBEDDED_FILES object provided for kicad_embed URI" ) );
+ return wxEmptyString;
+ }
+
+ wxString path = tname.Mid( 14 );
+ wxFileName temp_file = aFiles->GetTempFileName( path );
+
+ if( !temp_file.IsOk() )
+ {
+ wxLogTrace( wxT( "KICAD_EMBED" ),
+ wxT( "Failed to get temp file '%s' for kicad_embed URI" ), path );
+ return wxEmptyString;
+ }
+
+ wxLogTrace( wxT( "KICAD_EMBED" ), wxT( "Opening embedded file '%s' as '%s'" ),
+ tname, temp_file.GetFullPath() );
+
+ return temp_file.GetFullPath();
+ }
+
wxFileName tmpFN( tname );
// this case covers full paths, leading expanded vars, and paths relative to the current
@@ -688,11 +717,23 @@ bool FILENAME_RESOLVER::ValidateFileName( const wxString& aFileName, bool& hasAl
// ALIAS:relative/path
// 2. ALIAS is a UTF string excluding wxT( "{}[]()%~<>\"='`;:.,&?/\\|$" )
// 3. The relative path must be a valid relative path for the platform
+ // 4. We allow a URI for embedded files, but only if it has a name
+
hasAlias = false;
if( aFileName.empty() )
return false;
+ if( aFileName.StartsWith( wxT( "file://" ) )
+ || aFileName.StartsWith( FILEEXT::KiCadUriPrefix + "://" ) )
+ {
+ size_t prefixLength = aFileName.StartsWith( wxT( "file://" ) ) ? 7 : 14;
+ if( aFileName.length() > prefixLength && aFileName[prefixLength] != '/' )
+ return true;
+ else
+ return false;
+ }
+
wxString filename = aFileName;
wxString lpath;
size_t aliasStart = aFileName.StartsWith( ':' ) ? 1 : 0;
diff --git a/common/font/font.cpp b/common/font/font.cpp
index a4012399e0..ad36d7706c 100644
--- a/common/font/font.cpp
+++ b/common/font/font.cpp
@@ -143,7 +143,7 @@ FONT* FONT::getDefaultFont()
}
-FONT* FONT::GetFont( const wxString& aFontName, bool aBold, bool aItalic )
+FONT* FONT::GetFont( const wxString& aFontName, bool aBold, bool aItalic, const std::vector<wxString>* aEmbeddedFiles )
{
if( aFontName.empty() || aFontName.StartsWith( KICAD_FONT_NAME ) )
return getDefaultFont();
@@ -156,7 +156,7 @@ FONT* FONT::GetFont( const wxString& aFontName, bool aBold, bool aItalic )
font = s_fontMap[key];
if( !font )
- font = OUTLINE_FONT::LoadFont( aFontName, aBold, aItalic );
+ font = OUTLINE_FONT::LoadFont( aFontName, aBold, aItalic, aEmbeddedFiles );
if( !font )
font = getDefaultFont();
diff --git a/common/font/fontconfig.cpp b/common/font/fontconfig.cpp
index 8d3a0b6b2b..1e76177f75 100644
--- a/common/font/fontconfig.cpp
+++ b/common/font/fontconfig.cpp
@@ -27,6 +27,7 @@
#include <macros.h>
#include <cstdint>
#include <reporter.h>
+#include <embedded_files.h>
#ifdef __WIN32__
#define WIN32_LEAN_AND_MEAN
@@ -196,14 +197,25 @@ std::string FONTCONFIG::getFamilyStringByLang( FONTCONFIG_PAT& aPat, const wxStr
}
-FONTCONFIG::FF_RESULT FONTCONFIG::FindFont( const wxString &aFontName, wxString &aFontFile,
- int& aFaceIndex, bool aBold, bool aItalic )
+FONTCONFIG::FF_RESULT FONTCONFIG::FindFont( const wxString& aFontName, wxString& aFontFile,
+ int& aFaceIndex, bool aBold, bool aItalic,
+ const std::vector<wxString>* aEmbeddedFiles )
{
FF_RESULT retval = FF_RESULT::FF_ERROR;
if( !g_fcInitSuccess )
return retval;
+ FcConfig* config = FcConfigGetCurrent();
+
+ if( aEmbeddedFiles )
+ {
+ for( const auto& file : *aEmbeddedFiles )
+ {
+ FcConfigAppFontAddFile( config, (const FcChar8*) file.c_str().AsChar() );
+ }
+ }
+
wxString qualifiedFontName = aFontName;
wxScopedCharBuffer const fcBuffer = qualifiedFontName.ToUTF8();
@@ -218,11 +230,11 @@ FONTCONFIG::FF_RESULT FONTCONFIG::FindFont( const wxString &aFontName, wxString
FcPatternAddString( pat, FC_FAMILY, (FcChar8*) fcBuffer.data() );
- FcConfigSubstitute( nullptr, pat, FcMatchPattern );
+ FcConfigSubstitute( config, pat, FcMatchPattern );
FcDefaultSubstitute( pat );
FcResult r = FcResultNoMatch;
- FcPattern* font = FcFontMatch( nullptr, pat, &r );
+ FcPattern* font = FcFontMatch( config, pat, &r );
wxString fontName;
@@ -342,18 +354,29 @@ FONTCONFIG::FF_RESULT FONTCONFIG::FindFont( const wxString &aFontName, wxString
}
-void FONTCONFIG::ListFonts( std::vector<std::string>& aFonts, const std::string& aDesiredLang )
+void FONTCONFIG::ListFonts( std::vector<std::string>& aFonts, const std::string& aDesiredLang,
+ const std::vector<wxString>* aEmbeddedFiles, bool aForce )
{
if( !g_fcInitSuccess )
return;
// be sure to cache bust if the language changed
- if( m_fontInfoCache.empty() || m_fontCacheLastLang != aDesiredLang )
+ if( m_fontInfoCache.empty() || m_fontCacheLastLang != aDesiredLang || aForce )
{
+ FcConfig* config = FcConfigGetCurrent();
+
+ if( aEmbeddedFiles )
+ {
+ for( const auto& file : *aEmbeddedFiles )
+ {
+ FcConfigAppFontAddFile( config, (const FcChar8*) file.c_str().AsChar() );
+ }
+ }
+
FcPattern* pat = FcPatternCreate();
FcObjectSet* os = FcObjectSetBuild( FC_FAMILY, FC_FAMILYLANG, FC_STYLE, FC_LANG, FC_FILE,
FC_OUTLINE, nullptr );
- FcFontSet* fs = FcFontList( nullptr, pat, os );
+ FcFontSet* fs = FcFontList( config, pat, os );
for( int i = 0; fs && i < fs->nfont; ++i )
{
diff --git a/common/font/outline_font.cpp b/common/font/outline_font.cpp
index 85a8337481..eb92518154 100644
--- a/common/font/outline_font.cpp
+++ b/common/font/outline_font.cpp
@@ -29,6 +29,10 @@
#include <geometry/shape_poly_set.h>
#include <font/fontconfig.h>
#include <font/outline_font.h>
+#include <ft2build.h>
+#include FT_FREETYPE_H
+#include FT_SFNT_NAMES_H
+#include FT_TRUETYPE_TABLES_H
#include FT_GLYPH_H
#include FT_BBOX_H
#include <trigo.h>
@@ -53,7 +57,33 @@ OUTLINE_FONT::OUTLINE_FONT() :
}
-OUTLINE_FONT* OUTLINE_FONT::LoadFont( const wxString& aFontName, bool aBold, bool aItalic )
+OUTLINE_FONT::EMBEDDING_PERMISSION OUTLINE_FONT::GetEmbeddingPermission() const
+{
+ TT_OS2* os2 = reinterpret_cast<TT_OS2*>( FT_Get_Sfnt_Table( m_face, FT_SFNT_OS2 ) );
+
+ // If this table isn't present, we can't assume anything
+ if( !os2 )
+ return EMBEDDING_PERMISSION::RESTRICTED;
+
+ if( os2->fsType == FT_FSTYPE_INSTALLABLE_EMBEDDING ) // This allows the font to be exported from KiCad
+ return EMBEDDING_PERMISSION::INSTALLABLE;
+
+ if( os2->fsType & FT_FSTYPE_BITMAP_EMBEDDING_ONLY ) // We don't support bitmap fonts, so this disables embedding
+ return EMBEDDING_PERMISSION::RESTRICTED;
+
+ if( os2->fsType & FT_FSTYPE_EDITABLE_EMBEDDING ) // This allows us to use the font in KiCad but not export
+ return EMBEDDING_PERMISSION::EDITABLE;
+
+ if( os2->fsType & FT_FSTYPE_PREVIEW_AND_PRINT_EMBEDDING ) // This is not actually supported by KiCad ATM(2024)
+ return EMBEDDING_PERMISSION::PRINT_PREVIEW_ONLY;
+
+ // Anything else that is not explicitly enabled we treat as restricted.
+ return EMBEDDING_PERMISSION::RESTRICTED;
+}
+
+
+OUTLINE_FONT* OUTLINE_FONT::LoadFont( const wxString& aFontName, bool aBold, bool aItalic,
+ const std::vector<wxString>* aEmbeddedFiles )
{
std::unique_ptr<OUTLINE_FONT> font = std::make_unique<OUTLINE_FONT>();
@@ -61,7 +91,9 @@ OUTLINE_FONT* OUTLINE_FONT::LoadFont( const wxString& aFontName, bool aBold, boo
int faceIndex;
using fc = fontconfig::FONTCONFIG;
- fc::FF_RESULT retval = Fontconfig()->FindFont( aFontName, fontFile, faceIndex, aBold, aItalic );
+
+ fc::FF_RESULT retval = Fontconfig()->FindFont( aFontName, fontFile, faceIndex, aBold, aItalic,
+ aEmbeddedFiles );
if( retval == fc::FF_RESULT::FF_ERROR )
return nullptr;
diff --git a/common/io/altium/altium_binary_parser.cpp b/common/io/altium/altium_binary_parser.cpp
index 9654c6d1e1..bac282e7eb 100644
--- a/common/io/altium/altium_binary_parser.cpp
+++ b/common/io/altium/altium_binary_parser.cpp
@@ -149,30 +149,6 @@ ALTIUM_COMPOUND_FILE::DecodeIntLibStream( const CFB::COMPOUND_FILE_ENTRY& cfe )
}
-std::map<wxString, wxString> ALTIUM_COMPOUND_FILE::ListLibFootprints()
-{
- if( m_libFootprintDirNameCache.empty() )
- cacheLibFootprintNames();
-
- return m_libFootprintDirNameCache;
-}
-
-
-std::tuple<wxString, const CFB::COMPOUND_FILE_ENTRY*>
-ALTIUM_COMPOUND_FILE::FindLibFootprintDirName( const wxString& aFpUnicodeName )
-{
- if( m_libFootprintNameCache.empty() )
- cacheLibFootprintNames();
-
- auto it = m_libFootprintNameCache.find( aFpUnicodeName );
-
- if( it == m_libFootprintNameCache.end() )
- return { wxEmptyString, nullptr };
-
- return { it->first, it->second };
-}
-
-
const CFB::COMPOUND_FILE_ENTRY*
ALTIUM_COMPOUND_FILE::FindStreamSingleLevel( const CFB::COMPOUND_FILE_ENTRY* aEntry,
const std::string aName, const bool aIsStream ) const
@@ -333,53 +309,6 @@ ALTIUM_COMPOUND_FILE::FindStream( const std::vector<std::string>& aStreamPath )
}
-void ALTIUM_COMPOUND_FILE::cacheLibFootprintNames()
-{
- m_libFootprintDirNameCache.clear();
- m_libFootprintNameCache.clear();
-
- if( !m_reader )
- return;
-
- const CFB::COMPOUND_FILE_ENTRY* root = m_reader->GetRootEntry();
-
- if( !root )
- return;
-
- m_reader->EnumFiles( root, 1,
- [this]( const CFB::COMPOUND_FILE_ENTRY* tentry, const CFB::utf16string& dir,
- int level ) -> int
- {
- if( m_reader->IsStream( tentry ) )
- return 0;
-
- m_reader->EnumFiles( tentry, 1,
- [&]( const CFB::COMPOUND_FILE_ENTRY* entry, const CFB::utf16string&, int ) -> int
- {
- std::wstring fileName = UTF16ToWstring( entry->name, entry->nameLen );
-
- if( m_reader->IsStream( entry ) && fileName == L"Parameters" )
- {
- ALTIUM_BINARY_PARSER parametersReader( *this, entry );
- std::map<wxString, wxString> parameterProperties =
- parametersReader.ReadProperties();
-
- wxString key = ALTIUM_PROPS_UTILS::ReadString(
- parameterProperties, wxT( "PATTERN" ), wxT( "" ) );
- wxString fpName = ALTIUM_PROPS_UTILS::ReadUnicodeString(
- parameterProperties, wxT( "PATTERN" ), wxT( "" ) );
-
- m_libFootprintDirNameCache[key] = fpName;
- m_libFootprintNameCache[fpName] = tentry;
- }
-
- return 0;
- } );
- return 0;
- } );
-}
-
-
ALTIUM_BINARY_PARSER::ALTIUM_BINARY_PARSER( const ALTIUM_COMPOUND_FILE& aFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry )
{
diff --git a/common/io/altium/altium_binary_parser.h b/common/io/altium/altium_binary_parser.h
index 6e2796daaf..a0ed8c693d 100644
--- a/common/io/altium/altium_binary_parser.h
+++ b/common/io/altium/altium_binary_parser.h
@@ -38,6 +38,7 @@
#include <wx/mstream.h>
#include <wx/zstream.h>
#include <math/vector2d.h>
+#include <math/vector3.h>
namespace CFB
{
@@ -63,8 +64,11 @@ public:
const CFB::COMPOUND_FILE_ENTRY* m_pinsSymbolLineWidth;
};
+
class ALTIUM_COMPOUND_FILE
{
+ friend class ALTIUM_PCB_COMPOUND_FILE;
+
public:
/**
* Open a CFB file. Constructor might throw an IO_ERROR.
@@ -90,10 +94,6 @@ public:
std::unique_ptr<ALTIUM_COMPOUND_FILE> DecodeIntLibStream( const CFB::COMPOUND_FILE_ENTRY& cfe );
- std::map<wxString, wxString> ListLibFootprints();
-
- std::tuple<wxString, const CFB::COMPOUND_FILE_ENTRY*> FindLibFootprintDirName( const wxString& aFpUnicodeName );
-
const CFB::COMPOUND_FILE_ENTRY* FindStream( const std::vector<std::string>& aStreamPath ) const;
const CFB::COMPOUND_FILE_ENTRY* FindStream( const CFB::COMPOUND_FILE_ENTRY* aStart, const std::vector<std::string>& aStreamPath ) const;
@@ -108,13 +108,8 @@ public:
private:
- void cacheLibFootprintNames();
-
std::unique_ptr<CFB::CompoundFileReader> m_reader;
std::vector<char> m_buffer;
-
- std::map<wxString, const CFB::COMPOUND_FILE_ENTRY*> m_libFootprintNameCache;
- std::map<wxString, wxString> m_libFootprintDirNameCache;
};
diff --git a/common/pcb.keywords b/common/pcb.keywords
index 204393627b..7088b48926 100644
--- a/common/pcb.keywords
+++ b/common/pcb.keywords
@@ -106,6 +106,8 @@ edge_connector
edge_plating
edge_width
effects
+embedded_fonts
+embedded_files
enabled
end
epsilon_r
diff --git a/common/tool/actions.cpp b/common/tool/actions.cpp
index 0945ac8a91..eee6d9ee2e 100644
--- a/common/tool/actions.cpp
+++ b/common/tool/actions.cpp
@@ -1184,6 +1184,26 @@ TOOL_ACTION ACTIONS::pluginsReload( TOOL_ACTION_ARGS()
.Tooltip( _( "Reload all python plugins and refresh plugin menus" ) )
.Icon( BITMAPS::reload ) );
+// Embedding Files
+
+TOOL_ACTION ACTIONS::embeddedFiles( TOOL_ACTION_ARGS()
+ .Name( "common.Embed.embededFile" )
+ .Scope( AS_GLOBAL )
+ .FriendlyName( _( "Embedded Files" ) )
+ .Tooltip( _( "Manage embedded files" ) ) );
+
+TOOL_ACTION ACTIONS::removeFile( TOOL_ACTION_ARGS()
+ .Name( "common.Embed.removeFile" )
+ .Scope( AS_GLOBAL )
+ .FriendlyName( _( "Remove File" ) )
+ .Tooltip( _( "Remove an embedded file" ) ) );
+
+TOOL_ACTION ACTIONS::extractFile( TOOL_ACTION_ARGS()
+ .Name( "common.Embed.extractFile" )
+ .Scope( AS_GLOBAL )
+ .FriendlyName( _( "Extract File" ) )
+ .Tooltip( _( "Extract an embedded file" ) ) );
+
// System-wide selection Events
const TOOL_EVENT EVENTS::PointSelectedEvent( TC_MESSAGE, TA_ACTION, "common.Interactive.pointSelected" );
diff --git a/common/tool/embed_tool.cpp b/common/tool/embed_tool.cpp
new file mode 100644
index 0000000000..48f7e93582
--- /dev/null
+++ b/common/tool/embed_tool.cpp
@@ -0,0 +1,92 @@
+/*
+ * 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, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <dialogs/dialog_embed_files.h>
+#include <dialogs/panel_embedded_files.h>
+#include <eda_draw_frame.h>
+#include <eda_item.h>
+#include <embedded_files.h>
+#include <tool/actions.h>
+#include <wx/debug.h>
+#include <wx/filedlg.h>
+
+#include <tool/embed_tool.h>
+
+
+EMBED_TOOL::EMBED_TOOL( const std::string& aName ) :
+ TOOL_INTERACTIVE( aName )
+{
+}
+
+
+EMBED_TOOL::EMBED_TOOL() :
+ TOOL_INTERACTIVE( "common.Embed" )
+{
+}
+
+
+bool EMBED_TOOL::Init()
+{
+
+ m_files = getModel<EDA_ITEM>()->GetEmbeddedFiles();
+
+ return true;
+}
+
+
+void EMBED_TOOL::Reset( RESET_REASON aReason )
+{
+ m_files = getModel<EDA_ITEM>()->GetEmbeddedFiles();
+
+}
+
+int EMBED_TOOL::AddFile( const TOOL_EVENT& aEvent )
+{
+ wxString name = aEvent.Parameter<wxString>();
+ m_files->AddFile( name, false );
+
+ return 1;
+}
+
+int EMBED_TOOL::RemoveFile( const TOOL_EVENT& aEvent )
+{
+ wxString name = aEvent.Parameter<wxString>();
+ m_files->RemoveFile( name );
+
+ return 1;
+}
+
+std::vector<wxString> EMBED_TOOL::GetFileList()
+{
+ std::vector<wxString> list;
+
+ for( auto& [name, file] : m_files->EmbeddedFileMap() )
+ {
+ list.push_back( name );
+ }
+
+ return list;
+}
+
+void EMBED_TOOL::setTransitions()
+{
+ Go( &EMBED_TOOL::AddFile, ACTIONS::embeddedFiles.MakeEvent() );
+ Go( &EMBED_TOOL::RemoveFile, ACTIONS::removeFile.MakeEvent() );
+}
+
diff --git a/common/widgets/grid_text_button_helpers.cpp b/common/widgets/grid_text_button_helpers.cpp
index 9fbe221d9a..908885cb0c 100644
--- a/common/widgets/grid_text_button_helpers.cpp
+++ b/common/widgets/grid_text_button_helpers.cpp
@@ -22,12 +22,14 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
+#include <wx/checkbox.h>
#include <wx/combo.h>
#include <wx/filedlg.h>
#include <wx/dirdlg.h>
#include <wx/textctrl.h>
#include <bitmaps.h>
+#include <embedded_files.h>
#include <kiway.h>
#include <kiway_player.h>
#include <kiway_express.h>
@@ -37,6 +39,7 @@
#include <env_paths.h>
#include <pgm_base.h>
#include <widgets/wx_grid.h>
+#include <widgets/filedlg_open_embed_file.h>
#include <widgets/grid_text_button_helpers.h>
#include <eda_doc.h>
@@ -323,16 +326,25 @@ void GRID_CELL_FPID_EDITOR::Create( wxWindow* aParent, wxWindowID aId,
class TEXT_BUTTON_URL : public wxComboCtrl
{
public:
- TEXT_BUTTON_URL( wxWindow* aParent, DIALOG_SHIM* aParentDlg, SEARCH_STACK* aSearchStack ) :
+ TEXT_BUTTON_URL( wxWindow* aParent, DIALOG_SHIM* aParentDlg, SEARCH_STACK* aSearchStack, EMBEDDED_FILES* aFiles ) :
wxComboCtrl( aParent, wxID_ANY, wxEmptyString, wxDefaultPosition, wxDefaultSize,
wxTE_PROCESS_ENTER | wxBORDER_NONE ),
m_dlg( aParentDlg ),
- m_searchStack( aSearchStack )
+ m_searchStack( aSearchStack ),
+ m_files( aFiles )
{
- SetButtonBitmaps( KiBitmapBundle( BITMAPS::www ) );
+ UpdateButtonBitmaps();
// win32 fix, avoids drawing the "native dropdown caret"
Customize( wxCC_IFLAG_HAS_NONSTANDARD_BUTTON );
+
+ // Bind event to handle text changes
+ Bind(wxEVT_TEXT, &TEXT_BUTTON_URL::OnTextChange, this);
+ }
+
+ ~TEXT_BUTTON_URL()
+ {
+ Unbind(wxEVT_TEXT, &TEXT_BUTTON_URL::OnTextChange, this);
}
protected:
@@ -345,19 +357,59 @@ protected:
{
wxString filename = GetValue();
- if( !filename.IsEmpty() && filename != wxT( "~" ) )
- GetAssociatedDocument( m_dlg, GetValue(), &m_dlg->Prj(), m_searchStack );
+ if (filename.IsEmpty() || filename == wxT("~"))
+ {
+ FILEDLG_OPEN_EMBED_FILE customize;
+ wxFileDialog openFileDialog( this, _( "Open file" ), "", "", "All files (*.*)|*.*",
+ wxFD_OPEN | wxFD_FILE_MUST_EXIST );
+ openFileDialog.SetCustomizeHook( customize );
+
+ if( openFileDialog.ShowModal() == wxID_OK )
+ {
+ filename = openFileDialog.GetPath();
+ wxFileName fn( filename );
+
+ if( customize.GetEmbed() )
+ {
+ EMBEDDED_FILES::EMBEDDED_FILE* result = m_files->AddFile( fn, false );
+ SetValue( result->GetLink() );
+ }
+ else
+ {
+ SetValue( "file://" + filename );
+ }
+ }
+ }
+ else
+ {
+ GetAssociatedDocument(m_dlg, GetValue(), &m_dlg->Prj(), m_searchStack, m_files);
+ }
+ }
+
+ void OnTextChange(wxCommandEvent& event)
+ {
+ UpdateButtonBitmaps();
+ event.Skip(); // Ensure that other handlers can process this event too
+ }
+
+ void UpdateButtonBitmaps()
+ {
+ if (GetValue().IsEmpty())
+ SetButtonBitmaps(KiBitmapBundle(BITMAPS::small_folder));
+ else
+ SetButtonBitmaps(KiBitmapBundle(BITMAPS::www));
}
DIALOG_SHIM* m_dlg;
SEARCH_STACK* m_searchStack;
+ EMBEDDED_FILES* m_files;
};
void GRID_CELL_URL_EDITOR::Create( wxWindow* aParent, wxWindowID aId,
wxEvtHandler* aEventHandler )
{
- m_control = new TEXT_BUTTON_URL( aParent, m_dlg, m_searchStack );
+ m_control = new TEXT_BUTTON_URL( aParent, m_dlg, m_searchStack, m_files );
WX_GRID::CellEditorSetMargins( Combo() );
#if wxUSE_VALIDATORS
diff --git a/common/widgets/wx_grid.cpp b/common/widgets/wx_grid.cpp
index 50d4470895..88dbee458e 100644
--- a/common/widgets/wx_grid.cpp
+++ b/common/widgets/wx_grid.cpp
@@ -154,7 +154,7 @@ class WX_GRID_ALT_ROW_COLOR_PROVIDER : public wxGridCellAttrProvider
{
public:
WX_GRID_ALT_ROW_COLOR_PROVIDER( const wxColor& aBaseColor ) : wxGridCellAttrProvider(),
- m_attrOdd( new wxGridCellAttr() )
+ m_attrEven( new wxGridCellAttr() )
{
UpdateColors( aBaseColor );
}
@@ -165,7 +165,7 @@ public:
// Choose the default color, taking into account if the dark mode theme is enabled
wxColor rowColor = aBaseColor.ChangeLightness( KIPLATFORM::UI::IsDarkTheme() ? 105 : 95 );
- m_attrOdd->SetBackgroundColour( rowColor );
+ m_attrEven->SetBackgroundColour( rowColor );
}
@@ -174,20 +174,20 @@ public:
{
wxGridCellAttrPtr cellAttr( wxGridCellAttrProvider::GetAttr( row, col, kind ) );
- // Just pass through the cell attribute on even rows
- if( row % 2 )
+ // Just pass through the cell attribute on odd rows (start normal to allow for the header row)
+ if( !( row % 2 ) )
return cellAttr.release();
if( !cellAttr )
{
- cellAttr = m_attrOdd;
+ cellAttr = m_attrEven;
}
else
{
if( !cellAttr->HasBackgroundColour() )
{
cellAttr = cellAttr->Clone();
- cellAttr->SetBackgroundColour( m_attrOdd->GetBackgroundColour() );
+ cellAttr->SetBackgroundColour( m_attrEven->GetBackgroundColour() );
}
}
@@ -195,7 +195,7 @@ public:
}
private:
- wxGridCellAttrPtr m_attrOdd;
+ wxGridCellAttrPtr m_attrEven;
};
diff --git a/common/wildcards_and_files_ext.cpp b/common/wildcards_and_files_ext.cpp
index 7b261d6e2b..cc6c1cbe46 100644
--- a/common/wildcards_and_files_ext.cpp
+++ b/common/wildcards_and_files_ext.cpp
@@ -202,6 +202,8 @@ const std::string FILEEXT::XaoFileExtension( "xao" );
const wxString FILEEXT::GerberFileExtensionsRegex( "(gbr|gko|pho|(g[tb][alops])|(gm?\\d\\d*)|(gp[tb]))" );
+const std::string FILEEXT::KiCadUriPrefix( "kicad-embed" );
+
bool FILEEXT::IsGerberFileExtension( const wxString& ext )
{
diff --git a/eeschema/dialogs/dialog_eeschema_page_settings.cpp b/eeschema/dialogs/dialog_eeschema_page_settings.cpp
index fa2c13adc9..fa6d32dc4f 100644
--- a/eeschema/dialogs/dialog_eeschema_page_settings.cpp
+++ b/eeschema/dialogs/dialog_eeschema_page_settings.cpp
@@ -26,9 +26,9 @@
#include <schematic.h>
#include <eeschema_settings.h>
-DIALOG_EESCHEMA_PAGE_SETTINGS::DIALOG_EESCHEMA_PAGE_SETTINGS( EDA_DRAW_FRAME* aParent,
+DIALOG_EESCHEMA_PAGE_SETTINGS::DIALOG_EESCHEMA_PAGE_SETTINGS( EDA_DRAW_FRAME* aParent, EMBEDDED_FILES* aEmbeddedFiles,
VECTOR2I aMaxUserSizeMils ) :
- DIALOG_PAGES_SETTINGS( aParent, schIUScale.IU_PER_MILS, aMaxUserSizeMils )
+ DIALOG_PAGES_SETTINGS( aParent, aEmbeddedFiles, schIUScale.IU_PER_MILS, aMaxUserSizeMils )
{
}
diff --git a/eeschema/dialogs/dialog_eeschema_page_settings.h b/eeschema/dialogs/dialog_eeschema_page_settings.h
index c87f85a43b..06f729de77 100644
--- a/eeschema/dialogs/dialog_eeschema_page_settings.h
+++ b/eeschema/dialogs/dialog_eeschema_page_settings.h
@@ -22,11 +22,13 @@
#include <dialogs/dialog_page_settings.h>
+class EMBEDDED_FILES;
+
class DIALOG_EESCHEMA_PAGE_SETTINGS : public DIALOG_PAGES_SETTINGS
{
public:
- DIALOG_EESCHEMA_PAGE_SETTINGS( EDA_DRAW_FRAME* aParent, VECTOR2I aMaxUserSizeMils );
+ DIALOG_EESCHEMA_PAGE_SETTINGS( EDA_DRAW_FRAME* aParent, EMBEDDED_FILES* aEmbeddedFiles, VECTOR2I aMaxUserSizeMils );
virtual ~DIALOG_EESCHEMA_PAGE_SETTINGS();
private:
diff --git a/eeschema/dialogs/dialog_label_properties.cpp b/eeschema/dialogs/dialog_label_properties.cpp
index 725d94f680..262679f39a 100644
--- a/eeschema/dialogs/dialog_label_properties.cpp
+++ b/eeschema/dialogs/dialog_label_properties.cpp
@@ -108,7 +108,7 @@ DIALOG_LABEL_PROPERTIES::DIALOG_LABEL_PROPERTIES( SCH_EDIT_FRAME* aParent, SCH_L
m_grid->SetDefaultRowSize( m_grid->GetDefaultRowSize() + 4 );
m_grid->SetTable( m_fields );
- m_grid->PushEventHandler( new FIELDS_GRID_TRICKS( m_grid, this,
+ m_grid->PushEventHandler( new FIELDS_GRID_TRICKS( m_grid, this, nullptr,
[&]( wxCommandEvent& aEvent )
{
OnAddField( aEvent );
diff --git a/eeschema/dialogs/dialog_lib_symbol_properties.cpp b/eeschema/dialogs/dialog_lib_symbol_properties.cpp
index 16fb0c3cee..73750f43a3 100644
--- a/eeschema/dialogs/dialog_lib_symbol_properties.cpp
+++ b/eeschema/dialogs/dialog_lib_symbol_properties.cpp
@@ -40,6 +40,7 @@
#include <dialog_sim_model.h>
+#include <panel_embedded_files.h>
#include <dialog_lib_symbol_properties.h>
#include <settings/settings_manager.h>
#include <symbol_editor_settings.h>
@@ -63,11 +64,14 @@ DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES( SYMBOL_EDIT_FRAME* a
m_delayedFocusColumn( -1 ),
m_delayedFocusPage( -1 )
{
+ m_embeddedFiles = new PANEL_EMBEDDED_FILES( m_NoteBook, m_libEntry );
+ m_NoteBook->AddPage( m_embeddedFiles, _( "Embedded Files" ) );
+
// Give a bit more room for combobox editors
m_grid->SetDefaultRowSize( m_grid->GetDefaultRowSize() + 4 );
m_fields = new FIELDS_GRID_TABLE( this, aParent, m_grid, m_libEntry );
m_grid->SetTable( m_fields );
- m_grid->PushEventHandler( new FIELDS_GRID_TRICKS( m_grid, this,
+ m_grid->PushEventHandler( new FIELDS_GRID_TRICKS( m_grid, this, aLibEntry,
[&]( wxCommandEvent& aEvent )
{
OnAddField( aEvent );
@@ -79,7 +83,7 @@ DIALOG_LIB_SYMBOL_PROPERTIES::DIALOG_LIB_SYMBOL_PROPERTIES( SYMBOL_EDIT_FRAME* a
m_grid->ShowHideColumns( cfg->m_EditSymbolVisibleColumns );
wxGridCellAttr* attr = new wxGridCellAttr;
- attr->SetEditor( new GRID_CELL_URL_EDITOR( this, PROJECT_SCH::SchSearchS( &Prj() ) ) );
+ attr->SetEditor( new GRID_CELL_URL_EDITOR( this, PROJECT_SCH::SchSearchS( &Prj() ), aLibEntry ) );
m_grid->SetAttr( DATASHEET_FIELD, FDC_VALUE, attr );
m_SymbolNameCtrl->SetValidator( FIELD_VALIDATOR( VALUE_FIELD ) );
@@ -257,6 +261,8 @@ bool DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow()
m_NoteBook->SetSelection( (unsigned) m_lastOpenedPage );
+ m_embeddedFiles->TransferDataToWindow();
+
return true;
}
@@ -469,6 +475,7 @@ bool DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataFromWindow()
// occurs.
m_Parent->SetShowDeMorgan( m_hasAlternateBodyStyles->GetValue() );
+ m_embeddedFiles->TransferDataFromWindow();
return true;
}
diff --git a/eeschema/dialogs/dialog_lib_symbol_properties.h b/eeschema/dialogs/dialog_lib_symbol_properties.h
index 07b6be6978..fb55767d23 100644
--- a/eeschema/dialogs/dialog_lib_symbol_properties.h
+++ b/eeschema/dialogs/dialog_lib_symbol_properties.h
@@ -32,6 +32,7 @@
class SYMBOL_EDIT_FRAME;
class LIB_SYMBOL;
+class PANEL_EMBEDDED_FILES;
class WX_GRID;
@@ -93,6 +94,8 @@ public:
std::bitset<64> m_shownColumns;
wxSize m_size;
+ PANEL_EMBEDDED_FILES* m_embeddedFiles;
+
private:
static int m_lastOpenedPage; // To remember the last notebook selection
diff --git a/eeschema/dialogs/dialog_schematic_setup.cpp b/eeschema/dialogs/dialog_schematic_setup.cpp
index 8834a90e5a..10140d818d 100644
--- a/eeschema/dialogs/dialog_schematic_setup.cpp
+++ b/eeschema/dialogs/dialog_schematic_setup.cpp
@@ -30,6 +30,7 @@
#include <erc/erc_item.h>
#include <panel_text_variables.h>
#include <panel_bom_presets.h>
+#include <panel_embedded_files.h>
#include <project/project_file.h>
#include <project/net_settings.h>
#include <settings/settings_manager.h>
@@ -121,6 +122,16 @@ DIALOG_SCHEMATIC_SETUP::DIALOG_SCHEMATIC_SETUP( SCH_EDIT_FRAME* aFrame ) :
return new PANEL_TEXT_VARIABLES( aParent, &Prj() );
}, _( "Text Variables" ) );
+
+ m_treebook->AddPage( new wxPanel( GetTreebook() ), _( "Schematic Data" ) );
+
+ m_embeddedFilesPage = m_treebook->GetPageCount();
+ m_treebook->AddLazySubPage(
+ [this]( wxWindow* aParent ) -> wxWindow*
+ {
+ return new PANEL_EMBEDDED_FILES( aParent, &m_frame->Schematic() );
+ }, _( "Embedded Files" ) );
+
for( size_t i = 0; i < m_treebook->GetPageCount(); ++i )
m_treebook->ExpandNode( i );
diff --git a/eeschema/dialogs/dialog_schematic_setup.h b/eeschema/dialogs/dialog_schematic_setup.h
index 7e2fe413e0..1f4b5ab84c 100644
--- a/eeschema/dialogs/dialog_schematic_setup.h
+++ b/eeschema/dialogs/dialog_schematic_setup.h
@@ -56,6 +56,7 @@ protected:
size_t m_busesPage;
size_t m_severitiesPage;
size_t m_netclassesPage;
+ size_t m_embeddedFilesPage;
};
diff --git a/eeschema/dialogs/dialog_sheet_properties.cpp b/eeschema/dialogs/dialog_sheet_properties.cpp
index a15ad4d0c4..057ecf33c2 100644
--- a/eeschema/dialogs/dialog_sheet_properties.cpp
+++ b/eeschema/dialogs/dialog_sheet_properties.cpp
@@ -67,7 +67,7 @@ DIALOG_SHEET_PROPERTIES::DIALOG_SHEET_PROPERTIES( SCH_EDIT_FRAME* aParent, SCH_S
m_grid->SetDefaultRowSize( m_grid->GetDefaultRowSize() + 4 );
m_grid->SetTable( m_fields );
- m_grid->PushEventHandler( new FIELDS_GRID_TRICKS( m_grid, this,
+ m_grid->PushEventHandler( new FIELDS_GRID_TRICKS( m_grid, this, &aParent->Schematic(),
[&]( wxCommandEvent& aEvent )
{
OnAddField( aEvent );
diff --git a/eeschema/dialogs/dialog_symbol_fields_table.cpp b/eeschema/dialogs/dialog_symbol_fields_table.cpp
index a7dfe97db7..1e1667d867 100644
--- a/eeschema/dialogs/dialog_symbol_fields_table.cpp
+++ b/eeschema/dialogs/dialog_symbol_fields_table.cpp
@@ -343,7 +343,8 @@ void DIALOG_SYMBOL_FIELDS_TABLE::SetupColumnProperties( int aCol )
else if( m_dataModel->GetColFieldName( aCol ) == GetCanonicalFieldName( DATASHEET_FIELD ) )
{
// set datasheet column viewer button
- attr->SetEditor( new GRID_CELL_URL_EDITOR( this, PROJECT_SCH::SchSearchS( &Prj() ) ) );
+ attr->SetEditor( new GRID_CELL_URL_EDITOR( this, PROJECT_SCH::SchSearchS( &Prj() ),
+ &m_parent->Schematic() ) );
m_grid->SetColAttr( aCol, attr );
}
else if( m_dataModel->ColIsQuantity( aCol ) || m_dataModel->ColIsItemNumber( aCol ) )
diff --git a/eeschema/dialogs/dialog_symbol_properties.cpp b/eeschema/dialogs/dialog_symbol_properties.cpp
index a26d20f3b9..14a17d8ba1 100644
--- a/eeschema/dialogs/dialog_symbol_properties.cpp
+++ b/eeschema/dialogs/dialog_symbol_properties.cpp
@@ -334,7 +334,7 @@ DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES( SCH_EDIT_FRAME* aParent,
m_pinGrid->SetDefaultRowSize( m_pinGrid->GetDefaultRowSize() + 4 );
m_fieldsGrid->SetTable( m_fields );
- m_fieldsGrid->PushEventHandler( new FIELDS_GRID_TRICKS( m_fieldsGrid, this,
+ m_fieldsGrid->PushEventHandler( new FIELDS_GRID_TRICKS( m_fieldsGrid, this, &aParent->Schematic(),
[&]( wxCommandEvent& aEvent )
{
OnAddField( aEvent );
diff --git a/eeschema/eeschema_config.cpp b/eeschema/eeschema_config.cpp
index 6226561554..6e399fc868 100644
--- a/eeschema/eeschema_config.cpp
+++ b/eeschema/eeschema_config.cpp
@@ -26,6 +26,7 @@
#include <kiway.h>
#include <symbol_edit_frame.h>
#include <dialogs/panel_gal_display_options.h>
+#include <filename_resolver.h>
#include <pgm_base.h>
#include <project/project_file.h>
#include <project/project_local_settings.h>
@@ -69,14 +70,6 @@ bool SCH_EDIT_FRAME::LoadProjectSettings()
BASE_SCREEN::m_DrawingSheetFileName = settings.m_SchDrawingSheetFileName;
- // Load the drawing sheet from the filename stored in BASE_SCREEN::m_DrawingSheetFileName.
- // If empty, or not existing, the default drawing sheet is loaded.
- wxString filename = DS_DATA_MODEL::ResolvePath( BASE_SCREEN::m_DrawingSheetFileName,
- Prj().GetProjectPath() );
-
- if( !DS_DATA_MODEL::GetTheInstance().LoadDrawingSheet( filename, nullptr ) )
- ShowInfoBarError( _( "Error loading drawing sheet." ), true );
-
PROJECT_LOCAL_SETTINGS& localSettings = Prj().GetLocalSettings();
EE_SELECTION_TOOL* selTool = GetToolManager()->GetTool<EE_SELECTION_TOOL>();
@@ -87,6 +80,26 @@ bool SCH_EDIT_FRAME::LoadProjectSettings()
}
+void SCH_EDIT_FRAME::LoadDrawingSheet()
+{
+ // Load the drawing sheet from the filename stored in BASE_SCREEN::m_DrawingSheetFileName.
+ // If empty, or not existing, the default drawing sheet is loaded.
+
+ SCHEMATIC_SETTINGS& settings = Schematic().Settings();
+ FILENAME_RESOLVER resolver;
+ resolver.SetProject( &Prj() );
+ resolver.SetProgramBase( &Pgm() );
+
+ wxString filename = resolver.ResolvePath( settings.m_SchDrawingSheetFileName,
+ Prj().GetProjectPath(),
+ Schematic().GetEmbeddedFiles() );
+ wxString msg;
+
+ if( !DS_DATA_MODEL::GetTheInstance().LoadDrawingSheet( filename, &msg ) )
+ ShowInfoBarError( msg, true );
+}
+
+
void SCH_EDIT_FRAME::ShowSchematicSetupDialog( const wxString& aInitialPage )
{
SCH_SCREENS screens( Schematic().Root() );
@@ -177,15 +190,20 @@ void SCH_EDIT_FRAME::saveProjectSettings()
if( !BASE_SCREEN::m_DrawingSheetFileName.IsEmpty() )
{
- wxFileName layoutfn( DS_DATA_MODEL::ResolvePath( BASE_SCREEN::m_DrawingSheetFileName,
- Prj().GetProjectPath() ) );
+ FILENAME_RESOLVER resolve;
+ resolve.SetProject( &Prj() );
+ resolve.SetProgramBase( &Pgm() );
+
+ wxFileName layoutfn( resolve.ResolvePath( BASE_SCREEN::m_DrawingSheetFileName,
+ Prj().GetProjectPath(),
+ Schematic().GetEmbeddedFiles() ) );
bool success = true;
if( !layoutfn.IsAbsolute() )
success = layoutfn.MakeAbsolute( Prj().GetProjectPath() );
- if( success && layoutfn.IsOk() && !layoutfn.FileExists() )
+ if( success && layoutfn.IsOk() && !layoutfn.FileExists() && layoutfn.HasName() )
{
if( layoutfn.DirExists() && layoutfn.IsDirWritable() )
DS_DATA_MODEL::GetTheInstance().Save( layoutfn.GetFullPath() );
diff --git a/eeschema/eeschema_jobs_handler.cpp b/eeschema/eeschema_jobs_handler.cpp
index 0ad6b7beef..5176cf8d3b 100644
--- a/eeschema/eeschema_jobs_handler.cpp
+++ b/eeschema/eeschema_jobs_handler.cpp
@@ -37,6 +37,7 @@
#include <memory>
#include <connection_graph.h>
#include "eeschema_helpers.h"
+#include <filename_resolver.h>
#include <kiway.h>
#include <sch_painter.h>
#include <locale_io.h>
@@ -111,9 +112,14 @@ void EESCHEMA_JOBS_HANDLER::InitRenderSettings( SCH_RENDER_SETTINGS* aRenderSett
auto loadSheet =
[&]( const wxString& path ) -> bool
{
- wxString absolutePath = DS_DATA_MODEL::ResolvePath( path,
- aSch->Prj().GetProjectPath() );
wxString msg;
+ FILENAME_RESOLVER resolve;
+ resolve.SetProject( &aSch->Prj() );
+ resolve.SetProgramBase( &Pgm() );
+
+ wxString absolutePath = resolve.ResolvePath( path,
+ wxGetCwd(),
+ aSch->GetEmbeddedFiles() );
if( !DS_DATA_MODEL::GetTheInstance().LoadDrawingSheet( absolutePath, &msg ) )
{
diff --git a/eeschema/fields_grid_table.cpp b/eeschema/fields_grid_table.cpp
index 17583d1fda..679a2e1ceb 100644
--- a/eeschema/fields_grid_table.cpp
+++ b/eeschema/fields_grid_table.cpp
@@ -21,6 +21,7 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
+#include <embedded_files.h>
#include <kiway.h>
#include <kiway_player.h>
#include <dialog_shim.h>
@@ -238,8 +239,16 @@ void FIELDS_GRID_TABLE::initGrid( WX_GRID* aGrid )
fpIdEditor->SetValidator( m_nonUrlValidator );
m_footprintAttr->SetEditor( fpIdEditor );
+ EMBEDDED_FILES* files = nullptr;
+
+ if( m_frame->GetFrameType() == FRAME_SCH )
+ files = m_frame->GetScreen()->Schematic();
+ else if( m_frame->GetFrameType() == FRAME_SCH_SYMBOL_EDITOR || m_frame->GetFrameType() == FRAME_SCH_VIEWER )
+ files = m_part;
+
m_urlAttr = new wxGridCellAttr;
- GRID_CELL_URL_EDITOR* urlEditor = new GRID_CELL_URL_EDITOR( m_dialog, PROJECT_SCH::SchSearchS( &m_frame->Prj() ) );
+ GRID_CELL_URL_EDITOR* urlEditor =
+ new GRID_CELL_URL_EDITOR( m_dialog, PROJECT_SCH::SchSearchS( &m_frame->Prj() ), files );
urlEditor->SetValidator( m_urlValidator );
m_urlAttr->SetEditor( urlEditor );
@@ -292,6 +301,9 @@ void FIELDS_GRID_TABLE::initGrid( WX_GRID* aGrid )
SCH_EDIT_FRAME* editFrame = dynamic_cast<SCH_EDIT_FRAME*>( m_frame );
wxArrayString existingNetclasses;
+ wxArrayString fonts;
+ std::vector<std::string> fontNames;
+
if( editFrame )
{
// Load the combobox with existing existingNetclassNames
@@ -302,15 +314,30 @@ void FIELDS_GRID_TABLE::initGrid( WX_GRID* aGrid )
for( const auto& [ name, netclass ] : settings->m_NetClasses )
existingNetclasses.push_back( name );
+
+ // We don't need to re-cache the embedded fonts when looking at symbols in the schematic editor
+ // because the fonts are all available in the schematic.
+ const std::vector<wxString>* fontFiles = nullptr;
+
+ if( m_frame->GetScreen() && m_frame->GetScreen()->Schematic() )
+ fontFiles = m_frame->GetScreen()->Schematic()->GetEmbeddedFiles()->GetFontFiles();
+
+ Fontconfig()->ListFonts( fontNames, std::string( Pgm().GetLanguageTag().utf8_str() ),
+ fontFiles, false );
+ }
+ else
+ {
+ const std::vector<wxString>* fontFiles = m_part->GetEmbeddedFiles()->UpdateFontFiles();
+
+ // If there are font files embedded, we want to re-cache our fonts for each symbol that we
+ // are looking at in the symbol editor.
+ Fontconfig()->ListFonts( fontNames, std::string( Pgm().GetLanguageTag().utf8_str() ),
+ fontFiles, !fontFiles->empty() );
}
m_netclassAttr = new wxGridCellAttr;
m_netclassAttr->SetEditor( new GRID_CELL_COMBOBOX( existingNetclasses ) );
- wxArrayString fonts;
- std::vector<std::string> fontNames;
- Fontconfig()->ListFonts( fontNames, std::string( Pgm().GetLanguageTag().utf8_str() ) );
-
for( const std::string& name : fontNames )
fonts.Add( wxString( name ) );
@@ -931,8 +958,9 @@ void FIELDS_GRID_TRICKS::doPopupSelection( wxCommandEvent& event )
else if (event.GetId() == MYID_SHOW_DATASHEET )
{
wxString datasheet_uri = m_grid->GetCellValue( DATASHEET_FIELD, FDC_VALUE );
+
GetAssociatedDocument( m_dlg, datasheet_uri, &m_dlg->Prj(),
- PROJECT_SCH::SchSearchS( &m_dlg->Prj() ) );
+ PROJECT_SCH::SchSearchS( &m_dlg->Prj() ), m_files );
}
else
{
diff --git a/eeschema/fields_grid_table.h b/eeschema/fields_grid_table.h
index 4a0a00661c..1f4fd1a95c 100644
--- a/eeschema/fields_grid_table.h
+++ b/eeschema/fields_grid_table.h
@@ -31,22 +31,25 @@
class SCH_BASE_FRAME;
class DIALOG_SHIM;
+class EMBEDDED_FILES;
class SCH_LABEL_BASE;
class FIELDS_GRID_TRICKS : public GRID_TRICKS
{
public:
- FIELDS_GRID_TRICKS( WX_GRID* aGrid, DIALOG_SHIM* aDialog,
+ FIELDS_GRID_TRICKS( WX_GRID* aGrid, DIALOG_SHIM* aDialog, EMBEDDED_FILES* aFiles,
std::function<void( wxCommandEvent& )> aAddHandler ) :
GRID_TRICKS( aGrid, std::move( aAddHandler ) ),
- m_dlg( aDialog )
+ m_dlg( aDialog ),
+ m_files( aFiles )
{}
protected:
void showPopupMenu( wxMenu& menu, wxGridEvent& aEvent ) override;
void doPopupSelection( wxCommandEvent& event ) override;
DIALOG_SHIM* m_dlg;
+ EMBEDDED_FILES* m_files;
};
diff --git a/eeschema/files-io.cpp b/eeschema/files-io.cpp
index 8565d65058..622ed5cc64 100644
--- a/eeschema/files-io.cpp
+++ b/eeschema/files-io.cpp
@@ -517,6 +517,11 @@ bool SCH_EDIT_FRAME::OpenProjectFiles( const std::vector<wxString>& aFileSet, in
}
}
+ // After the schematic is successfully loaded, we load the drawing sheet.
+ // This allows us to use the drawing sheet embedded in the schematic (if any)
+ // instead of the default one.
+ LoadDrawingSheet();
+
schematic.PruneOrphanedSymbolInstances( Prj().GetProjectName(), sheetList );
schematic.PruneOrphanedSheetInstances( Prj().GetProjectName(), sheetList );
diff --git a/eeschema/lib_symbol.cpp b/eeschema/lib_symbol.cpp
index ec902d139f..0c8311af6e 100644
--- a/eeschema/lib_symbol.cpp
+++ b/eeschema/lib_symbol.cpp
@@ -24,6 +24,7 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
+#include <font/outline_font.h>
#include <sch_draw_panel.h>
#include <plotters/plotter.h>
#include <sch_screen.h>
@@ -1872,3 +1873,50 @@ double LIB_SYMBOL::Similarity( const SCH_ITEM& aOther ) const
return similarity;
}
+
+
+EMBEDDED_FILES* LIB_SYMBOL::GetEmbeddedFiles()
+{
+ return static_cast<EMBEDDED_FILES*>( this );
+}
+
+
+const EMBEDDED_FILES* LIB_SYMBOL::GetEmbeddedFiles() const
+{
+ return static_cast<const EMBEDDED_FILES*>( this );
+}
+
+
+void LIB_SYMBOL::EmbedFonts()
+{
+ using OUTLINE_FONT = KIFONT::OUTLINE_FONT;
+ using EMBEDDING_PERMISSION = OUTLINE_FONT::EMBEDDING_PERMISSION;
+
+ std::set<OUTLINE_FONT*> fonts;
+
+ for( SCH_ITEM& item : m_drawings )
+ {
+ if( item.Type() == SCH_TEXT_T )
+ {
+ auto* text = static_cast<SCH_TEXT*>( &item );
+
+ if( auto* font = text->GetFont(); font && !font->IsStroke() )
+ {
+ auto* outline = static_cast<OUTLINE_FONT*>( font );
+ auto permission = outline->GetEmbeddingPermission();
+
+ if( permission == EMBEDDING_PERMISSION::EDITABLE
+ || permission == EMBEDDING_PERMISSION::INSTALLABLE )
+ {
+ fonts.insert( outline );
+ }
+ }
+ }
+ }
+
+ for( auto* font : fonts )
+ {
+ auto file = GetEmbeddedFiles()->AddFile( font->GetFileName(), false );
+ file->type = EMBEDDED_FILES::EMBEDDED_FILE::FILE_TYPE::FONT;
+ }
+}
\ No newline at end of file
diff --git a/eeschema/lib_symbol.h b/eeschema/lib_symbol.h
index fd1cd6201a..b8036f61c7 100644
--- a/eeschema/lib_symbol.h
+++ b/eeschema/lib_symbol.h
@@ -27,6 +27,7 @@
#ifndef LIB_SYMBOL_H
#define LIB_SYMBOL_H
+#include <embedded_files.h>
#include <symbol.h>
#include <sch_field.h>
#include <sch_pin.h>
@@ -73,7 +74,7 @@ struct LIB_SYMBOL_UNIT
* A library symbol object is typically saved and loaded in a symbol library file (.lib).
* Library symbols are different from schematic symbols.
*/
-class LIB_SYMBOL : public SYMBOL, public LIB_TREE_ITEM
+class LIB_SYMBOL : public SYMBOL, public LIB_TREE_ITEM, public EMBEDDED_FILES
{
public:
LIB_SYMBOL( const wxString& aName, LIB_SYMBOL* aParent = nullptr,
@@ -333,6 +334,11 @@ public:
return GetValueField().GetText();
}
+ EMBEDDED_FILES* GetEmbeddedFiles() override;
+ const EMBEDDED_FILES* GetEmbeddedFiles() const;
+
+ void EmbedFonts() override;
+
void RunOnChildren( const std::function<void( SCH_ITEM* )>& aFunction ) override;
/**
diff --git a/eeschema/sch_edit_frame.cpp b/eeschema/sch_edit_frame.cpp
index e72eb36b7e..c857a2a3a6 100644
--- a/eeschema/sch_edit_frame.cpp
+++ b/eeschema/sch_edit_frame.cpp
@@ -66,6 +66,7 @@
#include <tool/action_toolbar.h>
#include <tool/common_control.h>
#include <tool/common_tools.h>
+#include <tool/embed_tool.h>
#include <tool/picker_tool.h>
#include <tool/properties_tool.h>
#include <tool/selection.h>
@@ -368,6 +369,7 @@ SCH_EDIT_FRAME::SCH_EDIT_FRAME( KIWAY* aKiway, wxWindow* aParent ) :
}
LoadProjectSettings();
+ LoadDrawingSheet();
view->SetLayerVisible( LAYER_ERC_ERR, cfg->m_Appearance.show_erc_errors );
view->SetLayerVisible( LAYER_ERC_WARN, cfg->m_Appearance.show_erc_warnings );
@@ -524,6 +526,7 @@ void SCH_EDIT_FRAME::setupTools()
m_toolManager->RegisterTool( new EE_POINT_EDITOR );
m_toolManager->RegisterTool( new SCH_NAVIGATE_TOOL );
m_toolManager->RegisterTool( new PROPERTIES_TOOL );
+ m_toolManager->RegisterTool( new EMBED_TOOL );
m_toolManager->InitTools();
// Run the selection tool, it is supposed to be always active
diff --git a/eeschema/sch_edit_frame.h b/eeschema/sch_edit_frame.h
index 5632447021..260f4f3679 100644
--- a/eeschema/sch_edit_frame.h
+++ b/eeschema/sch_edit_frame.h
@@ -159,6 +159,11 @@ public:
*/
bool LoadProjectSettings();
+ /**
+ * Load the drawing sheet file.
+ */
+ void LoadDrawingSheet();
+
void ShowSchematicSetupDialog( const wxString& aInitialPage = wxEmptyString );
void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
diff --git a/eeschema/sch_file_versions.h b/eeschema/sch_file_versions.h
index 4c948c328b..d55bc39d98 100644
--- a/eeschema/sch_file_versions.h
+++ b/eeschema/sch_file_versions.h
@@ -49,7 +49,8 @@
//#define SEXPR_SYMBOL_LIB_FILE_VERSION 20220914 // Symbol unit display names.
//#define SEXPR_SYMBOL_LIB_FILE_VERSION 20220914 // Don't save property ID
//#define SEXPR_SYMBOL_LIB_FILE_VERSION 20230620 // ki_description -> Description Field
-#define SEXPR_SYMBOL_LIB_FILE_VERSION 20231120 // generator_version; V8 cleanups
+//#define SEXPR_SYMBOL_LIB_FILE_VERSION 20231120 // generator_version; V8 cleanups
+#define SEXPR_SYMBOL_LIB_FILE_VERSION 20240529 // Embedded Files
/**
* Schematic file version.
@@ -105,4 +106,5 @@
//#define SEXPR_SCHEMATIC_FILE_VERSION 20231120 // generator_version; V8 cleanups
//#define SEXPR_SCHEMATIC_FILE_VERSION 20240101 // Tables.
//#define SEXPR_SCHEMATIC_FILE_VERSION 20240417 // Rule areas
-#define SEXPR_SCHEMATIC_FILE_VERSION 20240602 // Sheet attributes
+//#define SEXPR_SCHEMATIC_FILE_VERSION 20240602 // Sheet attributes
+#define SEXPR_SCHEMATIC_FILE_VERSION 20240620 // Embedded Files
diff --git a/eeschema/sch_io/kicad_sexpr/sch_io_kicad_sexpr.cpp b/eeschema/sch_io/kicad_sexpr/sch_io_kicad_sexpr.cpp
index f8e8251777..9885f7f0cc 100644
--- a/eeschema/sch_io/kicad_sexpr/sch_io_kicad_sexpr.cpp
+++ b/eeschema/sch_io/kicad_sexpr/sch_io_kicad_sexpr.cpp
@@ -372,6 +372,14 @@ void SCH_IO_KICAD_SEXPR::Format( SCH_SHEET* aSheet )
wxCHECK( screen, /* void */ );
+ // If we've requested to embed the fonts in the schematic, do so.
+ // Otherwise, clear the embedded fonts from the schematic. Embedded
+ // fonts will be used if available
+ if( m_schematic->GetAreFontsEmbedded() )
+ m_schematic->EmbedFonts();
+ else
+ m_schematic->GetEmbeddedFiles()->ClearEmbeddedFonts();
+
m_out->Print( 0, "(kicad_sch (version %d) (generator \"eeschema\") (generator_version \"%s\")\n\n",
SEXPR_SCHEMATIC_FILE_VERSION, GetMajorMinorVersion().c_str().AsChar() );
@@ -477,7 +485,7 @@ void SCH_IO_KICAD_SEXPR::Format( SCH_SHEET* aSheet )
case SCH_SHAPE_T:
saveShape( static_cast<SCH_SHAPE*>( item ), 1 );
break;
-
+
case SCH_RULE_AREA_T:
saveRuleArea( static_cast<SCH_RULE_AREA*>( item ), 1 );
break;
@@ -509,6 +517,13 @@ void SCH_IO_KICAD_SEXPR::Format( SCH_SHEET* aSheet )
instances.emplace_back( aSheet->GetRootInstance() );
saveInstances( instances, 1 );
+
+ m_out->Print( 1, "(embedded_fonts %s)\n",
+ m_schematic->GetAreFontsEmbedded() ? "yes" : "no" );
+
+ // Save any embedded files
+ if( !m_schematic->GetEmbeddedFiles()->IsEmpty() )
+ m_schematic->WriteEmbeddedFiles( *m_out, 1, true );
}
m_out->Print( 0, ")\n" );
@@ -527,6 +542,14 @@ void SCH_IO_KICAD_SEXPR::Format( EE_SELECTION* aSelection, SCH_SHEET_PATH* aSele
m_schematic = &aSchematic;
m_out = aFormatter;
+ // If we've requested to embed the fonts in the schematic, do so.
+ // Otherwise, clear the embedded fonts from the schematic. Embedded
+ // fonts will be used if available
+ if( m_schematic->GetAreFontsEmbedded() )
+ m_schematic->EmbedFonts();
+ else
+ m_schematic->GetEmbeddedFiles()->ClearEmbeddedFonts();
+
size_t i;
SCH_ITEM* item;
std::map<wxString, LIB_SYMBOL*> libSymbols;
@@ -564,7 +587,7 @@ void SCH_IO_KICAD_SEXPR::Format( EE_SELECTION* aSelection, SCH_SHEET_PATH* aSele
for( const std::pair<const wxString, LIB_SYMBOL*>& libSymbol : libSymbols )
{
SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol( libSymbol.second, *m_out, 1,
- libSymbol.first );
+ libSymbol.first, false );
}
m_out->Print( 0, ")\n\n" );
diff --git a/eeschema/sch_io/kicad_sexpr/sch_io_kicad_sexpr_lib_cache.cpp b/eeschema/sch_io/kicad_sexpr/sch_io_kicad_sexpr_lib_cache.cpp
index 13d5c10a66..b9e8f8a550 100644
--- a/eeschema/sch_io/kicad_sexpr/sch_io_kicad_sexpr_lib_cache.cpp
+++ b/eeschema/sch_io/kicad_sexpr/sch_io_kicad_sexpr_lib_cache.cpp
@@ -130,7 +130,7 @@ void SCH_IO_KICAD_SEXPR_LIB_CACHE::Save( const std::optional<bool>& aOpt )
void SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol( LIB_SYMBOL* aSymbol, OUTPUTFORMATTER& aFormatter,
- int aNestLevel, const wxString& aLibName )
+ int aNestLevel, const wxString& aLibName, bool aIncludeData )
{
wxCHECK_RET( aSymbol, "Invalid LIB_SYMBOL pointer." );
@@ -138,6 +138,15 @@ void SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol( LIB_SYMBOL* aSymbol, OUTPUTFORMAT
wxCHECK2( wxLocale::GetInfo( wxLOCALE_DECIMAL_POINT, wxLOCALE_CAT_NUMBER ) == ".",
LOCALE_IO toggle );
+
+ // If we've requested to embed the fonts in the symbol, do so.
+ // Otherwise, clear the embedded fonts from the symbol. Embedded
+ // fonts will be used if available
+ if( aSymbol->GetAreFontsEmbedded() )
+ aSymbol->EmbedFonts();
+ else
+ aSymbol->GetEmbeddedFiles()->ClearEmbeddedFonts();
+
int nextFreeFieldId = MANDATORY_FIELDS;
std::vector<SCH_FIELD*> fields;
std::string name = aFormatter.Quotew( aSymbol->GetLibId().GetLibItemName().wx_str() );
@@ -262,6 +271,12 @@ void SCH_IO_KICAD_SEXPR_LIB_CACHE::SaveSymbol( LIB_SYMBOL* aSymbol, OUTPUTFORMAT
aFormatter.Print( aNestLevel + 1, ")\n" );
}
+
+ aFormatter.Print( aNestLevel + 1, "(embedded_fonts %s)\n",
+ aSymbol->GetAreFontsEmbedded() ? "yes" : "no" );
+
+ if( !aSymbol->EmbeddedFileMap().empty() )
+ aSymbol->WriteEmbeddedFiles( aFormatter, aNestLevel + 1, aIncludeData );
}
else
{
diff --git a/eeschema/sch_io/kicad_sexpr/sch_io_kicad_sexpr_lib_cache.h b/eeschema/sch_io/kicad_sexpr/sch_io_kicad_sexpr_lib_cache.h
index 6cc8fe7a32..8f4ef30dec 100644
--- a/eeschema/sch_io/kicad_sexpr/sch_io_kicad_sexpr_lib_cache.h
+++ b/eeschema/sch_io/kicad_sexpr/sch_io_kicad_sexpr_lib_cache.h
@@ -51,8 +51,8 @@ public:
void DeleteSymbol( const wxString& aName ) override;
- static void SaveSymbol( LIB_SYMBOL* aSymbol, OUTPUTFORMATTER& aFormatter,
- int aNestLevel = 0, const wxString& aLibName = wxEmptyString );
+ static void SaveSymbol( LIB_SYMBOL* aSymbol, OUTPUTFORMATTER& aFormatter, int aNestLevel = 0,
+ const wxString& aLibName = wxEmptyString, bool aIncludeData = true );
void SetFileFormatVersionAtLoad( int aVersion ) { m_fileFormatVersionAtLoad = aVersion; }
int GetFileFormatVersionAtLoad() const { return m_fileFormatVersionAtLoad; }
diff --git a/eeschema/sch_io/kicad_sexpr/sch_io_kicad_sexpr_parser.cpp b/eeschema/sch_io/kicad_sexpr/sch_io_kicad_sexpr_parser.cpp
index 5ce1b91a3d..357dae58ff 100644
--- a/eeschema/sch_io/kicad_sexpr/sch_io_kicad_sexpr_parser.cpp
+++ b/eeschema/sch_io/kicad_sexpr/sch_io_kicad_sexpr_parser.cpp
@@ -31,6 +31,7 @@
#include <fmt/format.h>
#define wxUSE_BASE64 1
#include <wx/base64.h>
+#include <wx/log.h>
#include <wx/mstream.h>
#include <wx/tokenzr.h>
@@ -39,6 +40,8 @@
#include <sch_pin.h>
#include <math/util.h> // KiROUND, Clamp
#include <font/font.h>
+#include <font/fontconfig.h>
+#include <pgm_base.h>
#include <string_utils.h>
#include <sch_bitmap.h>
#include <sch_bus_entry.h>
@@ -274,6 +277,13 @@ LIB_SYMBOL* SCH_IO_KICAD_SEXPR_PARSER::ParseSymbol( LIB_SYMBOL_MAP& aSymbolLibMa
}
}
+ for( auto& [text, params] : m_fontTextMap )
+ {
+ text->SetFont( KIFONT::FONT::GetFont( std::get<0>( params ), std::get<1>( params ),
+ std::get<2>( params ),
+ newSymbol->GetEmbeddedFiles()->UpdateFontFiles() ) );
+ }
+
return newSymbol;
}
@@ -534,6 +544,31 @@ LIB_SYMBOL* SCH_IO_KICAD_SEXPR_PARSER::parseLibSymbol( LIB_SYMBOL_MAP& aSymbolLi
symbol->AddDrawItem( item, false );
break;
+ case T_embedded_fonts:
+ {
+ symbol->SetAreFontsEmbedded( parseBool() );
+ NeedRIGHT();
+ break;
+ }
+
+ case T_embedded_files:
+ {
+ EMBEDDED_FILES_PARSER embeddedFilesParser( reader );
+ embeddedFilesParser.SyncLineReaderWith( *this );
+
+ try
+ {
+ embeddedFilesParser.ParseEmbedded( symbol->GetEmbeddedFiles() );
+ }
+ catch( const IO_ERROR& e )
+ {
+ wxLogError( e.What() );
+ }
+
+ SyncLineReaderWith( embeddedFilesParser );
+ break;
+ }
+
default:
Expecting( "pin_names, pin_numbers, arc, bezier, circle, pin, polyline, "
"rectangle, or text" );
@@ -742,7 +777,7 @@ void SCH_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT( EDA_TEXT* aText, bool aConvertOve
}
if( !faceName.IsEmpty() )
- aText->SetFont( KIFONT::FONT::GetFont( faceName, bold, italic ) );
+ m_fontTextMap[aText] = { faceName, bold, italic };
break;
@@ -2755,10 +2790,48 @@ void SCH_IO_KICAD_SEXPR_PARSER::ParseSchematic( SCH_SHEET* aSheet, bool aIsCopya
parseBusAlias( screen );
break;
+ case T_embedded_fonts:
+ {
+ SCHEMATIC* schematic = aSheet->Schematic();
+
+ if( !schematic )
+ THROW_PARSE_ERROR( _( "No schematic object" ), CurSource(), CurLine(),
+ CurLineNumber(), CurOffset() );
+
+ schematic->GetEmbeddedFiles()->SetAreFontsEmbedded( parseBool() );
+ NeedRIGHT();
+ break;
+ }
+
+ case T_embedded_files:
+ {
+ SCHEMATIC* schematic = aSheet->Schematic();
+
+ if( !schematic )
+ THROW_PARSE_ERROR( _( "No schematic object" ), CurSource(), CurLine(),
+ CurLineNumber(), CurOffset() );
+
+ EMBEDDED_FILES_PARSER embeddedFilesParser( reader );
+ embeddedFilesParser.SyncLineReaderWith( *this );
+
+ try
+ {
+ embeddedFilesParser.ParseEmbedded( schematic->GetEmbeddedFiles() );
+ }
+ catch( const PARSE_ERROR& e )
+ {
+ wxLogError( e.What() );
+ }
+
+ SyncLineReaderWith( embeddedFilesParser );
+ break;
+ }
+
+
default:
- Expecting( "symbol, paper, page, title_block, bitmap, sheet, junction, no_connect, "
- "bus_entry, line, bus, text, label, class_label, global_label, "
- "hierarchical_label, symbol_instances, rule_area, or bus_alias" );
+ Expecting( "bitmap, bus, bus_alias, bus_entry, class_label, embedded_files, global_label, "
+ "hierarchical_label, junction, label, line, no_connect, page, paper, rule_area, "
+ "sheet, symbol, symbol_instances, text, title_block" );
}
}
@@ -2771,6 +2844,26 @@ void SCH_IO_KICAD_SEXPR_PARSER::ParseSchematic( SCH_SHEET* aSheet, bool aIsCopya
}
screen->UpdateLocalLibSymbolLinks();
+ screen->FixupEmbeddedData();
+
+ SCHEMATIC* schematic = aSheet->Schematic();
+
+ if( !schematic )
+ THROW_PARSE_ERROR( _( "No schematic object" ), CurSource(), CurLine(),
+ CurLineNumber(), CurOffset() );
+
+ for( auto& [text, params] : m_fontTextMap )
+ {
+ text->SetFont( KIFONT::FONT::GetFont( std::get<0>( params ), std::get<1>( params ),
+ std::get<2>( params ),
+ schematic->GetEmbeddedFiles()->UpdateFontFiles() ) );
+ }
+
+ // When loading the schematic, take a moment to cache the fonts so that the font
+ // picker can show the embedded fonts immediately.
+ std::vector<std::string> fontNames;
+ Fontconfig()->ListFonts( fontNames, std::string( Pgm().GetLanguageTag().utf8_str() ),
+ schematic->GetEmbeddedFiles()->GetFontFiles(), true );
if( m_requiredVersion < 20200828 )
screen->SetLegacySymbolInstanceData();
diff --git a/eeschema/sch_io/kicad_sexpr/sch_io_kicad_sexpr_parser.h b/eeschema/sch_io/kicad_sexpr/sch_io_kicad_sexpr_parser.h
index 2fec010d02..ca26e2b0c1 100644
--- a/eeschema/sch_io/kicad_sexpr/sch_io_kicad_sexpr_parser.h
+++ b/eeschema/sch_io/kicad_sexpr/sch_io_kicad_sexpr_parser.h
@@ -244,6 +244,8 @@ private:
std::set<KIID> m_uuids;
+ std::map<EDA_TEXT*, std::tuple<wxString, bool, bool>> m_fontTextMap;
+
PROGRESS_REPORTER* m_progressReporter; // optional; may be nullptr
const LINE_READER* m_lineReader; // for progress reporting
unsigned m_lastProgressLine;
diff --git a/eeschema/sch_screen.cpp b/eeschema/sch_screen.cpp
index d7cca68758..b2b87eeeb0 100644
--- a/eeschema/sch_screen.cpp
+++ b/eeschema/sch_screen.cpp
@@ -1488,6 +1488,28 @@ void SCH_SCREEN::AddLibSymbol( LIB_SYMBOL* aLibSymbol )
}
+void SCH_SCREEN::FixupEmbeddedData()
+{
+ SCHEMATIC* schematic = Schematic();
+
+ for( auto& [name, libSym] : m_libSymbols )
+ {
+ for( auto& [filename, embeddedFile] : libSym->EmbeddedFileMap() )
+ {
+ EMBEDDED_FILES::EMBEDDED_FILE* file = schematic->GetEmbeddedFile( filename );
+
+ if( file )
+ {
+ embeddedFile->compressedEncodedData = file->compressedEncodedData;
+ embeddedFile->decompressedData = file->decompressedData;
+ embeddedFile->data_sha = file->data_sha;
+ embeddedFile->is_valid = file->is_valid;
+ }
+ }
+ }
+}
+
+
void SCH_SCREEN::AddBusAlias( std::shared_ptr<BUS_ALIAS> aAlias )
{
m_aliases.insert( aAlias );
diff --git a/eeschema/sch_screen.h b/eeschema/sch_screen.h
index cf5bf97257..a54a995837 100644
--- a/eeschema/sch_screen.h
+++ b/eeschema/sch_screen.h
@@ -490,6 +490,13 @@ public:
*/
void AddLibSymbol( LIB_SYMBOL* aLibSymbol );
+ /**
+ * After loading a file from disk, the library symbols do not yet contain the full
+ * data for their embedded files, only a reference. This iterates over all lib symbols
+ * in the schematic and updates the library symbols with the full data.
+ */
+ void FixupEmbeddedData();
+
/**
* Add a bus alias definition (and transfers ownership of the pointer).
*/
diff --git a/eeschema/schematic.cpp b/eeschema/schematic.cpp
index 6f11d39897..2bd422d5fc 100644
--- a/eeschema/schematic.cpp
+++ b/eeschema/schematic.cpp
@@ -24,18 +24,21 @@
#include <core/kicad_algo.h>
#include <ee_collectors.h>
#include <erc/erc_settings.h>
-#include <sch_marker.h>
+#include <font/outline_font.h>
+#include <netlist_exporter_spice.h>
#include <project.h>
-#include <project/project_file.h>
#include <project/net_settings.h>
+#include <project/project_file.h>
#include <schematic.h>
#include <sch_junction.h>
+#include <sch_label.h>
#include <sch_line.h>
+#include <sch_marker.h>
#include <sch_screen.h>
#include <sim/spice_settings.h>
-#include <sch_label.h>
#include <sim/spice_value.h>
-#include <netlist_exporter_spice.h>
+
+#include <wx/log.h>
bool SCHEMATIC::m_IsSchematicExists = false;
@@ -846,3 +849,59 @@ void SCHEMATIC::ResolveERCExclusionsPostUpdate()
RootScreen()->Append( marker );
}
}
+
+
+EMBEDDED_FILES* SCHEMATIC::GetEmbeddedFiles()
+{
+ return static_cast<EMBEDDED_FILES*>( this );
+}
+
+
+const EMBEDDED_FILES* SCHEMATIC::GetEmbeddedFiles() const
+{
+ return static_cast<const EMBEDDED_FILES*>( this );
+}
+
+
+void SCHEMATIC::EmbedFonts()
+{
+ std::set<KIFONT::OUTLINE_FONT*> fonts;
+
+ SCH_SHEET_LIST sheetList = BuildUnorderedSheetList();
+
+ for( const SCH_SHEET_PATH& sheet : sheetList )
+ {
+ for( SCH_ITEM* item : sheet.LastScreen()->Items() )
+ {
+ if( EDA_TEXT* text = dynamic_cast<EDA_TEXT*>( item ) )
+ {
+ KIFONT::FONT* font = text->GetFont();
+
+ if( !font || font->IsStroke() )
+ continue;
+
+ using EMBEDDING_PERMISSION = KIFONT::OUTLINE_FONT::EMBEDDING_PERMISSION;
+ auto* outline = static_cast<KIFONT::OUTLINE_FONT*>( font );
+
+ if( outline->GetEmbeddingPermission() == EMBEDDING_PERMISSION::EDITABLE
+ || outline->GetEmbeddingPermission() == EMBEDDING_PERMISSION::INSTALLABLE )
+ {
+ fonts.insert( outline );
+ }
+ }
+ }
+ }
+
+ for( KIFONT::OUTLINE_FONT* font : fonts )
+ {
+ auto file = GetEmbeddedFiles()->AddFile( font->GetFileName(), false );
+
+ if( !file )
+ {
+ wxLogTrace( "EMBED", "Failed to add font file: %s", font->GetFileName() );
+ continue;
+ }
+
+ file->type = EMBEDDED_FILES::EMBEDDED_FILE::FILE_TYPE::FONT;
+ }
+}
\ No newline at end of file
diff --git a/eeschema/schematic.h b/eeschema/schematic.h
index 004466e3d1..59f5473cce 100644
--- a/eeschema/schematic.h
+++ b/eeschema/schematic.h
@@ -21,6 +21,7 @@
#define KICAD_SCHEMATIC_H
#include <eda_item.h>
+#include <embedded_files.h>
#include <sch_sheet_path.h>
#include <schematic_settings.h>
@@ -71,7 +72,7 @@ public:
* Right now, Eeschema can have only one schematic open at a time, but this could change.
* Please keep this possibility in mind when adding to this object.
*/
-class SCHEMATIC : public SCHEMATIC_IFACE, public EDA_ITEM
+class SCHEMATIC : public SCHEMATIC_IFACE, public EDA_ITEM, public EMBEDDED_FILES
{
public:
SCHEMATIC( PROJECT* aPrj );
@@ -161,6 +162,9 @@ public:
std::vector<SCH_MARKER*> ResolveERCExclusions();
+ EMBEDDED_FILES* GetEmbeddedFiles() override;
+ const EMBEDDED_FILES* GetEmbeddedFiles() const;
+
/**
* Return a pointer to a bus alias object for the given label, or null if one
* doesn't exist.
@@ -305,6 +309,11 @@ public:
*/
void RemoveAllListeners();
+ /**
+ * Embed fonts in the schematic
+ */
+ void EmbedFonts() override;
+
/**
* True if a SCHEMATIC exists, false if not
*/
diff --git a/eeschema/schematic.keywords b/eeschema/schematic.keywords
index fb05e65b46..9ff47e346e 100644
--- a/eeschema/schematic.keywords
+++ b/eeschema/schematic.keywords
@@ -16,6 +16,7 @@ bus_alias
bus_entry
cells
center
+checksum
circle
clock
clock_low
@@ -38,12 +39,15 @@ do_not_autoplace
dot
edge_clock_high
effects
+embedded_fonts
+embedded_files
end
extends
external
exclude_from_sim
face
fields_autoplaced
+file
fill
font
footprint
diff --git a/eeschema/symbol_editor/symbol_edit_frame.cpp b/eeschema/symbol_editor/symbol_edit_frame.cpp
index c9bcf707bc..7787c8461e 100644
--- a/eeschema/symbol_editor/symbol_edit_frame.cpp
+++ b/eeschema/symbol_editor/symbol_edit_frame.cpp
@@ -51,6 +51,7 @@
#include <tool/common_control.h>
#include <tool/common_tools.h>
#include <tool/editor_conditions.h>
+#include <tool/embed_tool.h>
#include <tool/library_editor_control.h>
#include <tool/picker_tool.h>
#include <tool/properties_tool.h>
@@ -395,6 +396,7 @@ void SYMBOL_EDIT_FRAME::setupTools()
m_toolManager->RegisterTool( new LIBRARY_EDITOR_CONTROL );
m_toolManager->RegisterTool( new SYMBOL_EDITOR_CONTROL );
m_toolManager->RegisterTool( new PROPERTIES_TOOL );
+ m_toolManager->RegisterTool( new EMBED_TOOL );
m_toolManager->InitTools();
// Run the selection tool, it is supposed to be always active
diff --git a/eeschema/tools/ee_inspection_tool.cpp b/eeschema/tools/ee_inspection_tool.cpp
index d345e54b9e..0aac98fff3 100644
--- a/eeschema/tools/ee_inspection_tool.cpp
+++ b/eeschema/tools/ee_inspection_tool.cpp
@@ -496,6 +496,7 @@ int EE_INSPECTION_TOOL::RunSimulation( const TOOL_EVENT& aEvent )
int EE_INSPECTION_TOOL::ShowDatasheet( const TOOL_EVENT& aEvent )
{
wxString datasheet;
+ EMBEDDED_FILES* files = nullptr;
if( m_frame->IsType( FRAME_SCH_SYMBOL_EDITOR ) )
{
@@ -505,6 +506,7 @@ int EE_INSPECTION_TOOL::ShowDatasheet( const TOOL_EVENT& aEvent )
return 0;
datasheet = symbol->GetDatasheetField().GetText();
+ files = symbol;
}
else if( m_frame->IsType( FRAME_SCH_VIEWER ) )
{
@@ -514,6 +516,7 @@ int EE_INSPECTION_TOOL::ShowDatasheet( const TOOL_EVENT& aEvent )
return 0;
datasheet = entry->GetDatasheetField().GetText();
+ files = entry;
}
else if( m_frame->IsType( FRAME_SCH ) )
{
@@ -528,6 +531,7 @@ int EE_INSPECTION_TOOL::ShowDatasheet( const TOOL_EVENT& aEvent )
// Use GetShownText() to resolve any text variables, but don't allow adding extra text
// (ie: the field name)
datasheet = field->GetShownText( &symbol->Schematic()->CurrentSheet(), false );
+ files = symbol->Schematic();
}
if( datasheet.IsEmpty() || datasheet == wxS( "~" ) )
@@ -537,7 +541,7 @@ int EE_INSPECTION_TOOL::ShowDatasheet( const TOOL_EVENT& aEvent )
else
{
GetAssociatedDocument( m_frame, datasheet, &m_frame->Prj(),
- PROJECT_SCH::SchSearchS( &m_frame->Prj() ) );
+ PROJECT_SCH::SchSearchS( &m_frame->Prj() ), files );
}
return 0;
diff --git a/eeschema/tools/sch_editor_control.cpp b/eeschema/tools/sch_editor_control.cpp
index b35005294c..c47575242f 100644
--- a/eeschema/tools/sch_editor_control.cpp
+++ b/eeschema/tools/sch_editor_control.cpp
@@ -200,7 +200,7 @@ int SCH_EDITOR_CONTROL::PageSetup( const TOOL_EVENT& aEvent )
undoCmd.SetDescription( _( "Page Settings" ) );
m_frame->SaveCopyInUndoList( undoCmd, UNDO_REDO::PAGESETTINGS, false, false );
- DIALOG_EESCHEMA_PAGE_SETTINGS dlg( m_frame, VECTOR2I( MAX_PAGE_SIZE_EESCHEMA_MILS,
+ DIALOG_EESCHEMA_PAGE_SETTINGS dlg( m_frame, m_frame->Schematic().GetEmbeddedFiles(), VECTOR2I( MAX_PAGE_SIZE_EESCHEMA_MILS,
MAX_PAGE_SIZE_EESCHEMA_MILS ) );
dlg.SetWksFileName( BASE_SCREEN::m_DrawingSheetFileName );
diff --git a/eeschema/tools/sch_navigate_tool.cpp b/eeschema/tools/sch_navigate_tool.cpp
index 545202d8b5..9c792c8c0d 100644
--- a/eeschema/tools/sch_navigate_tool.cpp
+++ b/eeschema/tools/sch_navigate_tool.cpp
@@ -87,7 +87,7 @@ void SCH_NAVIGATE_TOOL::HypertextCommand( const wxString& href )
menu.Append( 1, wxString::Format( _( "Open %s" ), href ) );
if( m_frame->GetPopupMenuSelectionFromUser( menu ) == 1 )
- GetAssociatedDocument( m_frame, href, &m_frame->Prj() );
+ GetAssociatedDocument( m_frame, href, &m_frame->Prj(), nullptr, &m_frame->Schematic() );
}
}
diff --git a/eeschema/widgets/sch_properties_panel.cpp b/eeschema/widgets/sch_properties_panel.cpp
index 260ba62724..eb20395438 100644
--- a/eeschema/widgets/sch_properties_panel.cpp
+++ b/eeschema/widgets/sch_properties_panel.cpp
@@ -30,6 +30,8 @@
#include <properties/property_mgr.h>
#include <sch_commit.h>
#include <sch_edit_frame.h>
+#include <symbol_edit_frame.h>
+#include <symbol_viewer_frame.h>
#include <schematic.h>
#include <settings/color_settings.h>
#include <string_utils.h>
@@ -218,10 +220,31 @@ void SCH_PROPERTIES_PANEL::OnLanguageChanged( wxCommandEvent& aEvent )
void SCH_PROPERTIES_PANEL::updateFontList()
{
wxPGChoices fonts;
+ const std::vector<wxString>* fontFiles = nullptr;
+
+ if( m_frame->GetFrameType() == FRAME_SCH && m_frame->GetScreen() && m_frame->GetScreen()->Schematic() )
+ {
+ fontFiles = m_frame->GetScreen()->Schematic()->GetEmbeddedFiles()->GetFontFiles();
+ }
+ else if( m_frame->GetFrameType() == FRAME_SCH_SYMBOL_EDITOR )
+ {
+ SYMBOL_EDIT_FRAME* symbolFrame = static_cast<SYMBOL_EDIT_FRAME*>( m_frame );
+
+ if( symbolFrame->GetCurSymbol() )
+ fontFiles = symbolFrame->GetCurSymbol()->GetEmbeddedFiles()->UpdateFontFiles();
+ }
+ else if( m_frame->GetFrameType() == FRAME_SCH_VIEWER )
+ {
+ SYMBOL_VIEWER_FRAME* symbolFrame = static_cast<SYMBOL_VIEWER_FRAME*>( m_frame );
+
+ if( symbolFrame->GetSelectedSymbol() )
+ fontFiles = symbolFrame->GetSelectedSymbol()->GetEmbeddedFiles()->UpdateFontFiles();
+ }
// Regnerate font names
std::vector<std::string> fontNames;
- Fontconfig()->ListFonts( fontNames, std::string( Pgm().GetLanguageTag().utf8_str() ) );
+ Fontconfig()->ListFonts( fontNames, std::string( Pgm().GetLanguageTag().utf8_str() ),
+ fontFiles );
fonts.Add( _( "Default Font" ), -1 );
fonts.Add( KICAD_FONT_NAME, -2 );
diff --git a/include/dialogs/dialog_embed_files.h b/include/dialogs/dialog_embed_files.h
new file mode 100644
index 0000000000..95cec29651
--- /dev/null
+++ b/include/dialogs/dialog_embed_files.h
@@ -0,0 +1,43 @@
+/*
+ * 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, see <http://www.gnu.org/licenses/>.
+ */
+
+
+#ifndef DIALOG_EMBED_FILES_H
+#define DIALOG_EMBED_FILES_H
+
+#include <dialog_shim.h>
+#include <wx/panel.h>
+
+
+class DIALOG_EMBED_FILES : public DIALOG_SHIM
+{
+public:
+ DIALOG_EMBED_FILES( wxWindow* aParent, const wxString& aTitle );
+
+ void InstallPanel( wxPanel* aPanel );
+
+ bool TransferDataToWindow() override;
+ bool TransferDataFromWindow() override;
+
+protected:
+ wxPanel* m_contentPanel;
+};
+
+
+#endif //DIALOG_EMBED_FILES_H
\ No newline at end of file
diff --git a/include/dialogs/dialog_page_settings.h b/include/dialogs/dialog_page_settings.h
index d78f5d98b8..ef9328ace9 100644
--- a/include/dialogs/dialog_page_settings.h
+++ b/include/dialogs/dialog_page_settings.h
@@ -29,6 +29,8 @@
class DS_DATA_MODEL;
class EDA_DRAW_FRAME;
class BASE_SCREEN;
+class EMBEDDED_FILES;
+class FILENAME_RESOLVER;
/*!
* DIALOG_PAGES_SETTINGS class declaration
@@ -37,8 +39,8 @@ class BASE_SCREEN;
class DIALOG_PAGES_SETTINGS: public DIALOG_PAGES_SETTINGS_BASE
{
public:
- DIALOG_PAGES_SETTINGS( EDA_DRAW_FRAME* aParent, double aIuPerMils,
- const VECTOR2D& aMaxUserSizeMils );
+ DIALOG_PAGES_SETTINGS( EDA_DRAW_FRAME* aParent, EMBEDDED_FILES* aEmbeddedFiles,
+ double aIuPerMils, const VECTOR2D& aMaxUserSizeMils );
virtual ~DIALOG_PAGES_SETTINGS();
const wxString GetWksFileName()
@@ -130,7 +132,9 @@ protected:
TITLE_BLOCK m_tb; /// Temporary title block (basic inscriptions).
DS_DATA_MODEL* m_drawingSheet; // the alternate and temporary drawing sheet shown by the
// dialog when the initial one is replaced by a new one
- double m_iuPerMils;
+ double m_iuPerMils;
+ EMBEDDED_FILES* m_embeddedFiles; // the embedded files reference from the parent
+ FILENAME_RESOLVER* m_filenameResolver;
private:
UNIT_BINDER m_customSizeX;
diff --git a/include/dsnlexer.h b/include/dsnlexer.h
index 805a996fcc..33df25ccb9 100644
--- a/include/dsnlexer.h
+++ b/include/dsnlexer.h
@@ -57,7 +57,8 @@ struct KICOMMON_API KEYWORD
*/
enum DSN_SYNTAX_T
{
- DSN_NONE = -11,
+ DSN_NONE = -12,
+ DSN_BAR = -11, // Also called pipe '|'
DSN_COMMENT = -10,
DSN_STRING_QUOTE = -9,
DSN_QUOTE_DEF = -8,
@@ -381,6 +382,13 @@ public:
*/
void NeedRIGHT();
+ /**
+ * Call #NextTok() and then verifies that the token read in is a #DSN_BAR.
+ *
+ * @throw IO_ERROR if the next token is not a #DSN_BAR
+ */
+ void NeedBAR();
+
/**
* Return the C string representation of a #DSN_T value.
*/
diff --git a/include/eda_doc.h b/include/eda_doc.h
index 1d986155a3..98c48f1b4c 100644
--- a/include/eda_doc.h
+++ b/include/eda_doc.h
@@ -31,6 +31,8 @@
#ifndef __INCLUDE__EDA_DOC_H__
#define __INCLUDE__EDA_DOC_H__ 1
+class EMBEDDED_FILES;
+
/**
* Open a document (file) with the suitable browser.
*
@@ -43,7 +45,7 @@
* @param aPaths Additional paths to search for local disk datasheet files
*/
bool GetAssociatedDocument( wxWindow* aParent, const wxString& aDocName, PROJECT* aProject,
- SEARCH_STACK* aPaths = nullptr );
+ SEARCH_STACK* aPaths = nullptr, EMBEDDED_FILES* aFiles = nullptr );
#endif /* __INCLUDE__EDA_DOC_H__ */
diff --git a/include/eda_item.h b/include/eda_item.h
index 384fa10976..f9cb57d9cc 100644
--- a/include/eda_item.h
+++ b/include/eda_item.h
@@ -52,6 +52,7 @@ enum class INSPECT_RESULT
class UNITS_PROVIDER;
class EDA_DRAW_FRAME;
class MSG_PANEL_ITEM;
+class EMBEDDED_FILES;
namespace google { namespace protobuf { class Any; } }
@@ -440,6 +441,8 @@ public:
virtual void ViewGetLayers( int aLayers[], int& aCount ) const override;
+ virtual EMBEDDED_FILES* GetEmbeddedFiles() { return nullptr; }
+
#if defined(DEBUG)
/**
diff --git a/include/embedded_files.h b/include/embedded_files.h
new file mode 100644
index 0000000000..6bfac91e95
--- /dev/null
+++ b/include/embedded_files.h
@@ -0,0 +1,243 @@
+/*
+ * 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, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef EMBEDDED_FILES_H
+#define EMBEDDED_FILES_H
+
+#include <map>
+
+#include <wx/string.h>
+#include <wx/filename.h>
+
+#include <embedded_files_lexer.h>
+#include <wildcards_and_files_ext.h>
+#include <richio.h>
+#include <picosha2.h>
+
+class EMBEDDED_FILES
+{
+public:
+ struct EMBEDDED_FILE
+ {
+ enum class FILE_TYPE
+ {
+ FONT,
+ MODEL,
+ WORKSHEET,
+ DATASHEET,
+ OTHER
+ };
+
+ EMBEDDED_FILE() :
+ type( FILE_TYPE::OTHER ),
+ is_valid( false )
+ {}
+
+ bool Validate()
+ {
+ std::string new_sha;
+ picosha2::hash256_hex_string( decompressedData, new_sha );
+
+ is_valid = ( new_sha == data_sha );
+ return is_valid;
+ }
+
+ wxString GetLink() const
+ {
+ return wxString::Format( "%s://%s", FILEEXT::KiCadUriPrefix, name );
+ }
+
+ wxString name;
+ FILE_TYPE type;
+ std::string compressedEncodedData;
+ std::vector<char> decompressedData;
+ std::string data_sha;
+ bool is_valid;
+ };
+
+ enum class RETURN_CODE : int
+ {
+ OK, // Success
+ FILE_NOT_FOUND, // File not found on disk
+ PERMISSIONS_ERROR, // Could not read/write file
+ FILE_ALREADY_EXISTS, // File already exists in the collection
+ OUT_OF_MEMORY, // Could not allocate memory
+ CHECKSUM_ERROR, // Checksum in file does not match data
+ };
+
+ EMBEDDED_FILES() = default;
+
+ ~EMBEDDED_FILES()
+ {
+ for( auto& file : m_files )
+ delete file.second;
+ }
+
+ /**
+ * Loads a file from disk and adds it to the collection.
+ * @param aName is the name of the file to load.
+ * @param aOverwrite is true if the file should be overwritten if it already exists.
+ */
+ EMBEDDED_FILE* AddFile( const wxFileName& aName, bool aOverwrite );
+
+ /**
+ * Appends a file to the collection.
+ */
+ void AddFile( EMBEDDED_FILE* aFile );
+
+ /**
+ * Removes a file from the collection and frees the memory.
+ * @param aName is the name of the file to remove.
+ */
+ void RemoveFile( const wxString& name, bool aErase = true );
+
+ /**
+ * Output formatter for the embedded files.
+ * @param aOut is the output formatter.
+ * @param aNestLevel is the current indentation level.
+ * @param aWriteData is true if the actual data should be written. This is false when writing an element
+ * that is already embedded in a file that itself has embedded files (boards, schematics, etc.)
+ */
+ void WriteEmbeddedFiles( OUTPUTFORMATTER& aOut, int aNestLevel, bool aWriteData ) const;
+
+ /**
+ * Returns the link for an embedded file.
+ * @param aFile is the file to get the link for.
+ * @return the link for the file to be used in a hyperlink.
+ */
+ wxString GetEmbeddedFileLink( const EMBEDDED_FILE& aFile ) const
+ {
+ return aFile.GetLink();
+ }
+
+ bool HasFile( const wxString& name ) const
+ {
+ wxFileName fileName( name );
+
+ return m_files.find( fileName.GetFullName() ) != m_files.end();
+ }
+
+ bool IsEmpty() const
+ {
+ return m_files.empty();
+ }
+
+ /**
+ * Helper function to get a list of fonts for fontconfig to add to the library.
+ *
+ * This is neccesary because EMBEDDED_FILES lives in common at the moment and
+ * fontconfig is in libkicommon. This will create the cache files in the KiCad
+ * cache directory (if they do not already exist) and return the temp files names
+ */
+ const std::vector<wxString>* UpdateFontFiles();
+
+ /**
+ * If we just need the cached version of the font files, we can use this function which
+ * is const and will not update the font files.
+ */
+ const std::vector<wxString>* GetFontFiles() const;
+
+ /**
+ * Removes all embedded fonts from the collection
+ */
+ void ClearEmbeddedFonts();
+
+ /**
+ * Takes data from the #decompressedData buffer and compresses it using ZSTD
+ * into the #compressedEncodedData buffer. The data is then Base64 encoded.
+ *
+ * This call is used when adding a new file to the collection from disk
+ */
+ static RETURN_CODE CompressAndEncode( EMBEDDED_FILE& aFile );
+
+ /**
+ * Takes data from the #compressedEncodedData buffer and Base64 decodes it.
+ * The data is then decompressed using ZSTD and stored in the #decompressedData buffer.
+ *
+ * This call is used when loading the embedded files using the parsers.
+ */
+ static RETURN_CODE DecompressAndDecode( EMBEDDED_FILE& aFile );
+
+ /**
+ * Returns the embedded file with the given name or nullptr if it does not exist.
+ */
+ EMBEDDED_FILE* GetEmbeddedFile( const wxString& aName ) const
+ {
+ auto it = m_files.find( aName );
+
+ return it == m_files.end() ? nullptr : it->second;
+ }
+
+ const std::map<wxString, EMBEDDED_FILE*>& EmbeddedFileMap() const
+ {
+ return m_files;
+ }
+
+ wxFileName GetTempFileName( const wxString& aName ) const;
+
+ wxFileName GetTempFileName( EMBEDDED_FILE* aFile ) const;
+
+ void ClearEmbeddedFiles( bool aDeleteFiles = true )
+ {
+ for( auto& file : m_files )
+ {
+ if( aDeleteFiles )
+ delete file.second;
+ }
+
+ m_files.clear();
+ }
+
+ virtual void EmbedFonts() {};
+
+ void SetAreFontsEmbedded( bool aEmbedFonts )
+ {
+ m_embedFonts = aEmbedFonts;
+ }
+
+ bool GetAreFontsEmbedded() const
+ {
+ return m_embedFonts;
+ }
+
+protected:
+ bool m_embedFonts; // If set, fonts will be embedded in the element on save
+ // Otherwise, font files embedded in the element will be
+ // removed on save
+
+
+private:
+ std::map<wxString, EMBEDDED_FILE*> m_files;
+ std::vector<wxString> m_fontFiles;
+};
+
+
+
+class EMBEDDED_FILES_PARSER : public EMBEDDED_FILES_LEXER
+{
+public:
+ EMBEDDED_FILES_PARSER( LINE_READER* aReader ) :
+ EMBEDDED_FILES_LEXER( aReader )
+ {
+ }
+
+ void ParseEmbedded( EMBEDDED_FILES* aFiles );
+
+};
+#endif // EMBEDDED_FILES_H
\ No newline at end of file
diff --git a/include/filename_resolver.h b/include/filename_resolver.h
index d38a74333e..eb41e18bb0 100644
--- a/include/filename_resolver.h
+++ b/include/filename_resolver.h
@@ -36,6 +36,7 @@
class PROJECT;
class PGM_BASE;
+class EMBEDDED_FILES;
struct SEARCH_PATH
{
@@ -99,8 +100,10 @@ public:
*
* @param aFileName The configured file path to resolve
* @param aWorkingPath The current working path for relative path resolutions
+ * @param aFiles The embedded files object to use for embedded file resolution
*/
- wxString ResolvePath( const wxString& aFileName, const wxString& aWorkingPath );
+ wxString ResolvePath( const wxString& aFileName, const wxString& aWorkingPath,
+ const EMBEDDED_FILES* aFiles );
/**
* Produce a relative path based on the existing search directories or returns the same path
diff --git a/include/font/font.h b/include/font/font.h
index 197375ee1f..0fbab48f32 100644
--- a/include/font/font.h
+++ b/include/font/font.h
@@ -141,7 +141,7 @@ public:
virtual bool IsItalic() const { return false; }
static FONT* GetFont( const wxString& aFontName = wxEmptyString, bool aBold = false,
- bool aItalic = false );
+ bool aItalic = false, const std::vector<wxString>* aEmbeddedFiles = nullptr );
static bool IsStroke( const wxString& aFontName );
const wxString& GetName() const { return m_fontName; };
diff --git a/include/font/fontconfig.h b/include/font/fontconfig.h
index 9ad5514749..cda8d9f48d 100644
--- a/include/font/fontconfig.h
+++ b/include/font/fontconfig.h
@@ -59,14 +59,18 @@ public:
*
* A return value of false indicates a serious error in the font system.
*/
- FF_RESULT FindFont( const wxString& aFontName, wxString& aFontFile, int& aFaceIndex, bool aBold, bool aItalic );
+ FF_RESULT FindFont( const wxString& aFontName, wxString& aFontFile, int& aFaceIndex, bool aBold,
+ bool aItalic, const std::vector<wxString>* aEmbeddedFiles = nullptr );
/**
* List the current available font families.
*
* @param aDesiredLang The desired language of font name to report back if available, otherwise it will fallback
+ * @param aEmbeddedFiles A list of embedded to use for searching fonts, if nullptr, this is not used
+ * @param aForce If true, force rebuilding the font cache
*/
- void ListFonts( std::vector<std::string>& aFonts, const std::string& aDesiredLang );
+ void ListFonts( std::vector<std::string>& aFonts, const std::string& aDesiredLang,
+ const std::vector<wxString>* aEmbeddedFiles = nullptr, bool aForce = false );
/**
* Set the reporter to use for reporting font substitution warnings.
diff --git a/include/font/outline_font.h b/include/font/outline_font.h
index 782aa556d9..9a9e943959 100644
--- a/include/font/outline_font.h
+++ b/include/font/outline_font.h
@@ -36,10 +36,11 @@
#endif
#include FT_FREETYPE_H
#include FT_OUTLINE_H
-//#include <gal/opengl/opengl_freetype.h>
+
#include <font/font.h>
#include <font/glyph.h>
#include <font/outline_decomposer.h>
+#include <embedded_files.h>
#include <mutex>
@@ -51,6 +52,16 @@ namespace KIFONT
class GAL_API OUTLINE_FONT : public FONT
{
public:
+
+ enum class EMBEDDING_PERMISSION
+ {
+ INSTALLABLE,
+ EDITABLE,
+ PRINT_PREVIEW_ONLY,
+ RESTRICTED,
+ INVALID
+ };
+
OUTLINE_FONT();
bool IsOutline() const override { return true; }
@@ -75,11 +86,16 @@ public:
m_fakeItal = true;
}
+ const wxString& GetFileName() const { return m_fontFileName; }
+
+ EMBEDDING_PERMISSION GetEmbeddingPermission() const;
+
/**
* Load an outline font. TrueType (.ttf) and OpenType (.otf) are supported.
* @param aFontFileName is the (platform-specific) fully qualified name of the font file
*/
- static OUTLINE_FONT* LoadFont( const wxString& aFontFileName, bool aBold, bool aItalic );
+ static OUTLINE_FONT* LoadFont( const wxString& aFontFileName, bool aBold, bool aItalic,
+ const std::vector<wxString>* aEmbeddedFiles );
/**
* Compute the distance (interline) between 2 lines of text (for multiline texts). This is
diff --git a/include/tool/actions.h b/include/tool/actions.h
index e83a4f67e1..1d110842a1 100644
--- a/include/tool/actions.h
+++ b/include/tool/actions.h
@@ -228,6 +228,11 @@ public:
// API
static TOOL_ACTION pluginsReload;
+ // Embedding Files
+ static TOOL_ACTION embeddedFiles;
+ static TOOL_ACTION extractFile;
+ static TOOL_ACTION removeFile;
+
///< Cursor control event types
enum CURSOR_EVENT_TYPE
{
diff --git a/include/tool/embed_tool.h b/include/tool/embed_tool.h
new file mode 100644
index 0000000000..6939e4675e
--- /dev/null
+++ b/include/tool/embed_tool.h
@@ -0,0 +1,57 @@
+/*
+ * 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, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef EMBED_TOOL_H
+#define EMBED_TOOL_H
+
+#include <tool/tool_interactive.h>
+
+class wxFileName;
+class EMBEDDED_FILES;
+
+class EMBED_TOOL : public TOOL_INTERACTIVE
+{
+public:
+ EMBED_TOOL();
+
+ EMBED_TOOL( const std::string& aName );
+
+ virtual ~EMBED_TOOL() = default;
+
+ /// @copydoc TOOL_INTERACTIVE::Init()
+ bool Init() override;
+
+ /// @copydoc TOOL_INTERACTIVE::Reset()
+ void Reset( RESET_REASON aReason ) override;
+
+ int AddFile( const TOOL_EVENT& aEvent );
+
+ int RemoveFile( const TOOL_EVENT& aEvent );
+
+ std::vector<wxString> GetFileList();
+protected:
+
+ ///< @copydoc TOOL_INTERACTIVE::setTransitions();
+ void setTransitions() override;
+
+private:
+ EMBEDDED_FILES* m_files;
+};
+
+#endif /* EMBED_TOOL_H */
diff --git a/include/widgets/filedlg_open_embed_file.h b/include/widgets/filedlg_open_embed_file.h
new file mode 100644
index 0000000000..0657815d3b
--- /dev/null
+++ b/include/widgets/filedlg_open_embed_file.h
@@ -0,0 +1,55 @@
+/*
+ * 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, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef KICAD_FILEDLG_OPEN_EMBED_FILE_H
+#define KICAD_FILEDLG_OPEN_EMBED_FILE_H
+
+#include <wx/wx.h>
+#include <wx/filedlgcustomize.h>
+
+
+class FILEDLG_OPEN_EMBED_FILE : public wxFileDialogCustomizeHook
+{
+public:
+ FILEDLG_OPEN_EMBED_FILE( bool aDefaultEmbed = true ) :
+ m_embed( aDefaultEmbed )
+ {};
+
+ virtual void AddCustomControls( wxFileDialogCustomize& customizer ) override
+ {
+ m_cb = customizer.AddCheckBox( _( "Embed File" ) );
+ m_cb->SetValue( m_embed );
+ }
+
+ virtual void TransferDataFromCustomControls() override
+ {
+ m_embed = m_cb->GetValue();
+ }
+
+ bool GetEmbed() const { return m_embed; }
+
+private:
+ bool m_embed;
+
+ wxFileDialogCheckBox* m_cb = nullptr;
+
+ wxDECLARE_NO_COPY_CLASS( FILEDLG_OPEN_EMBED_FILE );
+};
+
+#endif //KICAD_FILEDLG_OPEN_EMBED_FILE_H
diff --git a/include/widgets/grid_text_button_helpers.h b/include/widgets/grid_text_button_helpers.h
index f3d9469f30..0153b82c90 100644
--- a/include/widgets/grid_text_button_helpers.h
+++ b/include/widgets/grid_text_button_helpers.h
@@ -35,6 +35,7 @@
class wxGrid;
class WX_GRID;
class DIALOG_SHIM;
+class EMBEDDED_FILES;
class GRID_CELL_TEXT_BUTTON : public wxGridCellEditor
@@ -118,8 +119,9 @@ protected:
class GRID_CELL_URL_EDITOR : public GRID_CELL_TEXT_BUTTON
{
public:
- GRID_CELL_URL_EDITOR( DIALOG_SHIM* aParent, SEARCH_STACK* aSearchStack = nullptr ) :
- m_dlg( aParent ), m_searchStack( aSearchStack )
+ GRID_CELL_URL_EDITOR( DIALOG_SHIM* aParent, SEARCH_STACK* aSearchStack = nullptr,
+ EMBEDDED_FILES* aFiles = nullptr ) :
+ m_dlg( aParent ), m_searchStack( aSearchStack ), m_files( aFiles )
{ }
wxGridCellEditor* Clone() const override
@@ -132,6 +134,7 @@ public:
protected:
DIALOG_SHIM* m_dlg;
SEARCH_STACK* m_searchStack;
+ EMBEDDED_FILES* m_files;
};
diff --git a/include/wildcards_and_files_ext.h b/include/wildcards_and_files_ext.h
index 6686e8a84e..e7df1c4cc1 100644
--- a/include/wildcards_and_files_ext.h
+++ b/include/wildcards_and_files_ext.h
@@ -192,6 +192,8 @@ public:
static const wxString GerberFileExtensionsRegex;
+ static const std::string KiCadUriPrefix;
+
/**
* @}
*/
diff --git a/pagelayout_editor/tools/pl_editor_control.cpp b/pagelayout_editor/tools/pl_editor_control.cpp
index 00a63ec184..097dd8af70 100644
--- a/pagelayout_editor/tools/pl_editor_control.cpp
+++ b/pagelayout_editor/tools/pl_editor_control.cpp
@@ -90,7 +90,7 @@ int PL_EDITOR_CONTROL::PageSetup( const TOOL_EVENT& aEvent )
{
m_frame->SaveCopyInUndoList();
- DIALOG_PAGES_SETTINGS dlg( m_frame, drawSheetIUScale.IU_PER_MILS,
+ DIALOG_PAGES_SETTINGS dlg( m_frame, nullptr, drawSheetIUScale.IU_PER_MILS,
VECTOR2I( MAX_PAGE_SIZE_EESCHEMA_MILS,
MAX_PAGE_SIZE_EESCHEMA_MILS ) );
dlg.SetWksFileName( m_frame->GetCurrentFileName() );
diff --git a/pcbnew/board.cpp b/pcbnew/board.cpp
index a97bc24d8d..9b08b1330f 100644
--- a/pcbnew/board.cpp
+++ b/pcbnew/board.cpp
@@ -38,6 +38,7 @@
#include <connectivity/connectivity_data.h>
#include <convert_shape_list_to_polygon.h>
#include <footprint.h>
+#include <font/outline_font.h>
#include <lset.h>
#include <pcb_base_frame.h>
#include <pcb_track.h>
@@ -82,7 +83,8 @@ BOARD::BOARD() :
m_project( nullptr ),
m_userUnits( EDA_UNITS::MILLIMETRES ),
m_designSettings( new BOARD_DESIGN_SETTINGS( nullptr, "board.design_settings" ) ),
- m_NetInfo( this )
+ m_NetInfo( this ),
+ m_embedFonts( false )
{
// A too small value do not allow connecting 2 shapes (i.e. segments) not exactly connected
// A too large value do not allow safely connecting 2 shapes like very short segments.
@@ -957,6 +959,26 @@ void BOARD::CacheTriangulation( PROGRESS_REPORTER* aReporter, const std::vector<
}
+void BOARD::FixupEmbeddedData()
+{
+ for( FOOTPRINT* footprint : m_footprints )
+ {
+ for( auto& [filename, embeddedFile] : footprint->EmbeddedFileMap() )
+ {
+ EMBEDDED_FILES::EMBEDDED_FILE* file = GetEmbeddedFile( filename );
+
+ if( file )
+ {
+ embeddedFile->compressedEncodedData = file->compressedEncodedData;
+ embeddedFile->decompressedData = file->decompressedData;
+ embeddedFile->data_sha = file->data_sha;
+ embeddedFile->is_valid = file->is_valid;
+ }
+ }
+ }
+}
+
+
void BOARD::Add( BOARD_ITEM* aBoardItem, ADD_MODE aMode, bool aSkipConnectivity )
{
if( aBoardItem == nullptr )
@@ -2498,6 +2520,56 @@ bool BOARD::GetBoardPolygonOutlines( SHAPE_POLY_SET& aOutlines,
}
+EMBEDDED_FILES* BOARD::GetEmbeddedFiles()
+{
+ if( IsFootprintHolder() )
+ return static_cast<EMBEDDED_FILES*>( GetFirstFootprint() );
+
+ return static_cast<EMBEDDED_FILES*>( this );
+}
+
+
+const EMBEDDED_FILES* BOARD::GetEmbeddedFiles() const
+{
+ if( IsFootprintHolder() )
+ return static_cast<const EMBEDDED_FILES*>( GetFirstFootprint() );
+
+ return static_cast<const EMBEDDED_FILES*>( this );
+}
+
+
+void BOARD::EmbedFonts()
+{
+ std::set<KIFONT::OUTLINE_FONT*> fonts;
+
+ for( BOARD_ITEM* item : Drawings() )
+ {
+ if( EDA_TEXT* text = dynamic_cast<EDA_TEXT*>( item ) )
+ {
+ KIFONT::FONT* font = text->GetFont();
+
+ if( !font || font->IsStroke() )
+ continue;
+
+ using EMBEDDING_PERMISSION = KIFONT::OUTLINE_FONT::EMBEDDING_PERMISSION;
+ auto* outline = static_cast<KIFONT::OUTLINE_FONT*>( font );
+
+ if( outline->GetEmbeddingPermission() == EMBEDDING_PERMISSION::EDITABLE
+ || outline->GetEmbeddingPermission() == EMBEDDING_PERMISSION::INSTALLABLE )
+ {
+ fonts.insert( outline );
+ }
+ }
+ }
+
+ for( KIFONT::OUTLINE_FONT* font : fonts )
+ {
+ auto file = GetEmbeddedFiles()->AddFile( font->GetFileName(), false );
+ file->type = EMBEDDED_FILES::EMBEDDED_FILE::FILE_TYPE::FONT;
+ }
+}
+
+
const std::vector<PAD*> BOARD::GetPads() const
{
std::vector<PAD*> allPads;
diff --git a/pcbnew/board.h b/pcbnew/board.h
index 2d81ab2814..aab89f5335 100644
--- a/pcbnew/board.h
+++ b/pcbnew/board.h
@@ -27,6 +27,7 @@
#include <board_item_container.h>
#include <board_stackup_manager/board_stackup.h>
+#include <embedded_files.h>
#include <common.h> // Needed for stl hash extensions
#include <convert_shape_list_to_polygon.h> // for OUTLINE_ERROR_HANDLER
#include <hash.h>
@@ -284,7 +285,7 @@ enum class BOARD_USE
/**
* Information pertinent to a Pcbnew printed circuit board.
*/
-class BOARD : public BOARD_ITEM_CONTAINER
+class BOARD : public BOARD_ITEM_CONTAINER, public EMBEDDED_FILES
{
public:
static inline bool ClassOf( const EDA_ITEM* aItem )
@@ -426,6 +427,13 @@ public:
*/
void FinalizeBulkRemove( std::vector<BOARD_ITEM*>& aRemovedItems );
+ /**
+ * After loading a file from disk, the footprints do not yet contain the full
+ * data for their embedded files, only a reference. This iterates over all footprints
+ * in the board and updates them with the full embedded data.
+ */
+ void FixupEmbeddedData();
+
void CacheTriangulation( PROGRESS_REPORTER* aReporter = nullptr,
const std::vector<ZONE*>& aZones = {} );
@@ -1246,6 +1254,14 @@ public:
bool LegacyTeardrops() const { return m_legacyTeardrops; }
void SetLegacyTeardrops( bool aFlag ) { m_legacyTeardrops = aFlag; }
+ EMBEDDED_FILES* GetEmbeddedFiles() override;
+ const EMBEDDED_FILES* GetEmbeddedFiles() const;
+
+ /**
+ * Finds all fonts used in the board and embeds them in the file if permissions allow
+ */
+ void EmbedFonts() override;
+
// --------- Item order comparators ---------
struct cmp_items
@@ -1359,6 +1375,8 @@ private:
NETINFO_LIST m_NetInfo; // net info list (name, design constraints...
std::vector<BOARD_LISTENER*> m_listeners;
+
+ bool m_embedFonts;
};
diff --git a/pcbnew/dialogs/dialog_board_setup.cpp b/pcbnew/dialogs/dialog_board_setup.cpp
index b10989b3fb..bc354c02d8 100644
--- a/pcbnew/dialogs/dialog_board_setup.cpp
+++ b/pcbnew/dialogs/dialog_board_setup.cpp
@@ -31,6 +31,7 @@
#include <dialog_import_settings.h>
#include <pcb_io/pcb_io.h>
#include <pcb_io/pcb_io_mgr.h>
+#include <panel_embedded_files.h>
#include <dialogs/panel_setup_severities.h>
#include <dialogs/panel_setup_rules.h>
#include <dialogs/panel_setup_teardrops.h>
@@ -203,6 +204,14 @@ DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP( PCB_EDIT_FRAME* aFrame ) :
board->GetDesignSettings().m_DRCSeverities );
}, _( "Violation Severity" ) );
+ m_treebook->AddPage( new wxPanel( GetTreebook() ), _( "Board Data" ) );
+ m_embeddedFilesPage = m_treebook->GetPageCount();
+ m_treebook->AddLazySubPage(
+ [this]( wxWindow* aParent ) -> wxWindow*
+ {
+ return new PANEL_EMBEDDED_FILES( aParent, m_frame->GetBoard() );
+ }, _( "Embedded Files" ) );
+
for( size_t i = 0; i < m_treebook->GetPageCount(); ++i )
m_treebook->ExpandNode( i );
diff --git a/pcbnew/dialogs/dialog_board_setup.h b/pcbnew/dialogs/dialog_board_setup.h
index ad1c066dd7..c0fa517b2e 100644
--- a/pcbnew/dialogs/dialog_board_setup.h
+++ b/pcbnew/dialogs/dialog_board_setup.h
@@ -73,6 +73,7 @@ private:
size_t m_netclassesPage;
size_t m_customRulesPage;
size_t m_severitiesPage;
+ size_t m_embeddedFilesPage;
};
diff --git a/pcbnew/dialogs/dialog_footprint_properties.cpp b/pcbnew/dialogs/dialog_footprint_properties.cpp
index 89ec820b87..ce79df7c0c 100644
--- a/pcbnew/dialogs/dialog_footprint_properties.cpp
+++ b/pcbnew/dialogs/dialog_footprint_properties.cpp
@@ -42,8 +42,8 @@
#include <widgets/text_ctrl_eval.h>
#include <widgets/std_bitmap_button.h>
#include <settings/settings_manager.h>
+#include <panel_embedded_files.h>
#include <panel_fp_properties_3d_model.h>
-#include <dialogs/3d_cache_dialogs.h>
#include <dialogs/panel_preview_3d_model.h>
#include <dialog_footprint_properties.h>
@@ -75,6 +75,9 @@ DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES( PCB_EDIT_FRAME* aParen
m_3dPanel = new PANEL_FP_PROPERTIES_3D_MODEL( m_frame, m_footprint, this, m_NoteBook );
m_NoteBook->AddPage( m_3dPanel, _("3D Models"), false );
+ m_embeddedFiles = new PANEL_EMBEDDED_FILES( m_NoteBook, m_footprint );
+ m_NoteBook->AddPage( m_embeddedFiles, _( "Embedded Files" ) );
+
// Configure display origin transforms
m_posX.SetCoordType( ORIGIN_TRANSFORMS::ABS_X_COORD );
m_posY.SetCoordType( ORIGIN_TRANSFORMS::ABS_Y_COORD );
@@ -261,6 +264,9 @@ bool DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow()
if( !m_3dPanel->TransferDataToWindow() )
return false;
+ if( !m_embeddedFiles->TransferDataToWindow() )
+ return false;
+
// Footprint Fields
for( PCB_FIELD* srcField : m_footprint->GetFields() )
{
@@ -494,6 +500,9 @@ bool DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow()
if( !m_3dPanel->TransferDataFromWindow() )
return false;
+ if( !m_embeddedFiles->TransferDataFromWindow() )
+ return false;
+
auto view = m_frame->GetCanvas()->GetView();
BOARD_COMMIT commit( m_frame );
commit.Modify( m_footprint );
diff --git a/pcbnew/dialogs/dialog_footprint_properties.h b/pcbnew/dialogs/dialog_footprint_properties.h
index 1d1070a826..d4e2b4421a 100644
--- a/pcbnew/dialogs/dialog_footprint_properties.h
+++ b/pcbnew/dialogs/dialog_footprint_properties.h
@@ -36,6 +36,7 @@
class PCB_EDIT_FRAME;
class PANEL_FP_PROPERTIES_3D_MODEL;
+class PANEL_EMBEDDED_FILES;
class DIALOG_FOOTPRINT_PROPERTIES: public DIALOG_FOOTPRINT_PROPERTIES_BASE
{
@@ -106,6 +107,7 @@ private:
wxSize m_gridSize;
wxSize m_lastRequestedSize;
+ PANEL_EMBEDDED_FILES* m_embeddedFiles;
};
diff --git a/pcbnew/dialogs/dialog_footprint_properties_fp_editor.cpp b/pcbnew/dialogs/dialog_footprint_properties_fp_editor.cpp
index 8361f71319..3b50b05529 100644
--- a/pcbnew/dialogs/dialog_footprint_properties_fp_editor.cpp
+++ b/pcbnew/dialogs/dialog_footprint_properties_fp_editor.cpp
@@ -45,7 +45,6 @@
#include "filename_resolver.h"
#include <pgm_base.h>
#include "dialogs/panel_preview_3d_model.h"
-#include "dialogs/3d_cache_dialogs.h"
#include <settings/settings_manager.h>
#include <tool/tool_manager.h>
#include <tools/pcb_selection_tool.h>
diff --git a/pcbnew/dialogs/dialog_global_edit_text_and_graphics.cpp b/pcbnew/dialogs/dialog_global_edit_text_and_graphics.cpp
index ca79598122..d347c5bc9f 100644
--- a/pcbnew/dialogs/dialog_global_edit_text_and_graphics.cpp
+++ b/pcbnew/dialogs/dialog_global_edit_text_and_graphics.cpp
@@ -397,7 +397,8 @@ void DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem( BOARD_COMMIT& aCommit, B
if( !text->GetFontName().IsEmpty() )
{
text->SetFont( KIFONT::FONT::GetFont( text->GetFontName(), text->IsBold(),
- text->IsItalic() ) );
+ text->IsItalic(),
+ m_parent->GetBoard()->GetEmbeddedFiles()->GetFontFiles() ) );
}
}
diff --git a/pcbnew/dialogs/panel_fp_properties_3d_model.cpp b/pcbnew/dialogs/panel_fp_properties_3d_model.cpp
index 336e3b2e69..c27e1dec1b 100644
--- a/pcbnew/dialogs/panel_fp_properties_3d_model.cpp
+++ b/pcbnew/dialogs/panel_fp_properties_3d_model.cpp
@@ -27,6 +27,7 @@
#include <panel_fp_properties_3d_model.h>
#include <3d_viewer/eda_3d_viewer_frame.h>
+#include <dialogs/dialog_configure_paths.h>
#include <env_vars.h>
#include <bitmaps.h>
#include <widgets/grid_icon_text_helpers.h>
@@ -35,18 +36,21 @@
#include <widgets/std_bitmap_button.h>
#include <footprint.h>
#include <fp_lib_table.h>
+#include <footprint.h>
#include <footprint_edit_frame.h>
#include <footprint_editor_settings.h>
#include <dialog_footprint_properties_fp_editor.h>
#include "filename_resolver.h"
#include <pgm_base.h>
#include <kiplatform/ui.h>
-#include "dialogs/panel_preview_3d_model.h"
-#include "dialogs/3d_cache_dialogs.h"
+#include <dialogs/panel_preview_3d_model.h>
+#include <dialogs/dialog_select_3d_model.h>
#include <settings/settings_manager.h>
-#include <wx/defs.h>
#include <project_pcb.h>
+#include <wx/defs.h>
+#include <wx/msgdlg.h>
+
enum MODELS_TABLE_COLUMNS
{
COL_PROBLEM = 0,
@@ -147,6 +151,13 @@ bool PANEL_FP_PROPERTIES_3D_MODEL::TransferDataFromWindow()
if( !m_modelsGrid->CommitPendingChanges() )
return false;
+ FOOTPRINT* fp = m_previewPane->GetDummyFootprint();
+
+ for( const auto& [name, file] : fp->EmbeddedFileMap() )
+ {
+ if( !m_footprint->HasFile( name ) )
+ m_footprint->AddFile( new EMBEDDED_FILES::EMBEDDED_FILE( *file ) );
+ }
return true;
}
@@ -294,14 +305,16 @@ void PANEL_FP_PROPERTIES_3D_MODEL::OnAdd3DModel( wxCommandEvent& )
int selected = m_modelsGrid->GetGridCursorRow();
- PROJECT& prj = m_frame->Prj();
- FP_3DMODEL model;
+ PROJECT& prj = m_frame->Prj();
+ FP_3DMODEL model;
+ S3D_CACHE* cache = PROJECT_PCB::Get3DCacheManager( &prj );
+ FILENAME_RESOLVER* res = cache->GetResolver();
wxString initialpath = prj.GetRString( PROJECT::VIEWER_3D_PATH );
wxString sidx = prj.GetRString( PROJECT::VIEWER_3D_FILTER_INDEX );
int filter = 0;
- // If the PROJECT::VIEWER_3D_PATH hasn't been set yet, use the KICAD7_3DMODEL_DIR environment
+ // If the PROJECT::VIEWER_3D_PATH hasn't been set yet, use the 3DMODEL_DIR environment
// variable and fall back to the project path if necessary.
if( initialpath.IsEmpty() )
{
@@ -321,8 +334,13 @@ void PANEL_FP_PROPERTIES_3D_MODEL::OnAdd3DModel( wxCommandEvent& )
filter = (int) tmp;
}
- if( !S3D::Select3DModel( m_parentDialog, PROJECT_PCB::Get3DCacheManager( &m_frame->Prj() ), initialpath, filter, &model )
- || model.m_Filename.empty() )
+
+ DIALOG_SELECT_3DMODEL dm( m_parentDialog, cache, &model, initialpath, filter );
+
+ // Use QuasiModal so that Configure3DPaths (and its help window) will work
+ int retval = dm.ShowQuasiModal();
+
+ if( retval != wxID_OK || model.m_Filename.empty() )
{
if( selected >= 0 )
{
@@ -333,10 +351,47 @@ void PANEL_FP_PROPERTIES_3D_MODEL::OnAdd3DModel( wxCommandEvent& )
return;
}
+ if( dm.IsEmbedded3DModel() )
+ {
+ wxString libraryName = m_footprint->GetFPID().GetLibNickname();
+ const FP_LIB_TABLE_ROW* fpRow = nullptr;
+
+ wxString footprintBasePath = wxEmptyString;
+
+ try
+ {
+ fpRow = PROJECT_PCB::PcbFootprintLibs( &m_frame->Prj() )->FindRow( libraryName, false );
+
+ if( fpRow )
+ footprintBasePath = fpRow->GetFullURI( true );
+ }
+ catch( ... )
+ {
+ // if libraryName is not found in table, do nothing
+ }
+
+
+ wxString fullPath = res->ResolvePath( model.m_Filename, footprintBasePath, nullptr );
+ wxFileName fname( fullPath );
+
+ EMBEDDED_FILES::EMBEDDED_FILE* result = m_previewPane->GetDummyFootprint()->AddFile( fname, false );
+
+ if( !result )
+ {
+
+ wxString msg = wxString::Format( _( "Error adding 3D model" ) );
+ wxMessageBox( msg, _( "Error" ), wxICON_ERROR | wxOK, this );
+ return;
+ }
+
+ model.m_Filename = result->GetLink();
+ }
+
+
prj.SetRString( PROJECT::VIEWER_3D_PATH, initialpath );
sidx = wxString::Format( wxT( "%i" ), filter );
prj.SetRString( PROJECT::VIEWER_3D_FILTER_INDEX, sidx );
- FILENAME_RESOLVER* res = PROJECT_PCB::Get3DCacheManager( &m_frame->Prj() )->GetResolver();
+
wxString alias;
wxString shortPath;
wxString filename = model.m_Filename;
@@ -466,7 +521,7 @@ MODEL_VALIDATE_ERRORS PANEL_FP_PROPERTIES_3D_MODEL::validateModelExists( const w
if( fpRow )
footprintBasePath = fpRow->GetFullURI( true );
- wxString fullPath = resolv->ResolvePath( aFilename, footprintBasePath );
+ wxString fullPath = resolv->ResolvePath( aFilename, footprintBasePath, m_footprint );
if( fullPath.IsEmpty() )
return MODEL_VALIDATE_ERRORS::RESOLVE_FAIL;
@@ -480,7 +535,9 @@ MODEL_VALIDATE_ERRORS PANEL_FP_PROPERTIES_3D_MODEL::validateModelExists( const w
void PANEL_FP_PROPERTIES_3D_MODEL::Cfg3DPath( wxCommandEvent& event )
{
- if( S3D::Configure3DPaths( this, PROJECT_PCB::Get3DCacheManager( &m_frame->Prj() )->GetResolver() ) )
+ DIALOG_CONFIGURE_PATHS dlg( this );
+
+ if( dlg.ShowQuasiModal() == wxID_OK )
m_previewPane->UpdateDummyFootprint();
}
diff --git a/pcbnew/exporters/export_idf.cpp b/pcbnew/exporters/export_idf.cpp
index af161c954c..9fb17b3dd6 100644
--- a/pcbnew/exporters/export_idf.cpp
+++ b/pcbnew/exporters/export_idf.cpp
@@ -437,7 +437,7 @@ static void idf_export_footprint( BOARD* aPcb, FOOTPRINT* aFootprint, IDF3_BOARD
continue;
}
- idfFile.Assign( resolver->ResolvePath( sM->m_Filename, footprintBasePath ) );
+ idfFile.Assign( resolver->ResolvePath( sM->m_Filename, footprintBasePath, aFootprint ) );
idfExt = idfFile.GetExt();
if( idfExt.Cmp( wxT( "idf" ) ) && idfExt.Cmp( wxT( "IDF" ) ) )
diff --git a/pcbnew/exporters/exporter_vrml.cpp b/pcbnew/exporters/exporter_vrml.cpp
index 3c6e789fa6..4f70168c02 100644
--- a/pcbnew/exporters/exporter_vrml.cpp
+++ b/pcbnew/exporters/exporter_vrml.cpp
@@ -1046,7 +1046,7 @@ void EXPORTER_PCB_VRML::ExportVrmlFootprint( FOOTPRINT* aFootprint, std::ostream
continue;
}
- SGNODE* mod3d = (SGNODE*) m_Cache3Dmodels->Load( sM->m_Filename, footprintBasePath );
+ SGNODE* mod3d = (SGNODE*) m_Cache3Dmodels->Load( sM->m_Filename, footprintBasePath, aFootprint );
if( nullptr == mod3d )
{
@@ -1112,7 +1112,7 @@ void EXPORTER_PCB_VRML::ExportVrmlFootprint( FOOTPRINT* aFootprint, std::ostream
aOutputFile->precision( m_precision );
wxFileName srcFile =
- m_Cache3Dmodels->GetResolver()->ResolvePath( sM->m_Filename, wxEmptyString );
+ m_Cache3Dmodels->GetResolver()->ResolvePath( sM->m_Filename, wxEmptyString, aFootprint );
wxFileName dstFile;
dstFile.SetPath( m_Subdir3DFpModels );
dstFile.SetName( srcFile.GetName() );
diff --git a/pcbnew/exporters/step/exporter_step.cpp b/pcbnew/exporters/step/exporter_step.cpp
index ed5f1b7af8..6274bc831d 100644
--- a/pcbnew/exporters/step/exporter_step.cpp
+++ b/pcbnew/exporters/step/exporter_step.cpp
@@ -333,7 +333,7 @@ bool EXPORTER_STEP::buildFootprint3DShapes( FOOTPRINT* aFootprint, VECTOR2D aOri
continue;
std::vector<wxString> searchedPaths;
- wxString mname = m_resolver->ResolvePath( fp_model.m_Filename, footprintBasePath );
+ wxString mname = m_resolver->ResolvePath( fp_model.m_Filename, footprintBasePath, aFootprint );
if( mname.empty() || !wxFileName::FileExists( mname ) )
diff --git a/pcbnew/files.cpp b/pcbnew/files.cpp
index ca03b5428f..bd135a35c7 100644
--- a/pcbnew/files.cpp
+++ b/pcbnew/files.cpp
@@ -387,6 +387,7 @@ bool PCB_EDIT_FRAME::Files_io_from_id( int id )
return false;
LoadProjectSettings();
+ LoadDrawingSheet();
onBoardLoaded();
@@ -935,6 +936,7 @@ bool PCB_EDIT_FRAME::OpenProjectFiles( const std::vector<wxString>& aFileSet, in
// Load project settings after setting up board; some of them depend on the nets list
LoadProjectSettings();
+ LoadDrawingSheet();
// Syncs the UI (appearance panel, etc) with the loaded board and project
onBoardLoaded();
diff --git a/pcbnew/footprint.cpp b/pcbnew/footprint.cpp
index 7b457fcf28..8d4f0f17da 100644
--- a/pcbnew/footprint.cpp
+++ b/pcbnew/footprint.cpp
@@ -25,35 +25,39 @@
*/
#include <magic_enum.hpp>
-#include <core/mirror.h>
-#include <confirm.h>
-#include <refdes_utils.h>
-#include <bitmaps.h>
#include <unordered_set>
-#include <string_utils.h>
-#include <pcb_edit_frame.h>
+
+#include <bitmaps.h>
#include <board.h>
#include <board_design_settings.h>
+#include <confirm.h>
+#include <convert_basic_shapes_to_polygon.h>
+#include <convert_shape_list_to_polygon.h>
+#include <core/mirror.h>
+#include <drc/drc_item.h>
+#include <embedded_files.h>
+#include <font/font.h>
+#include <font/outline_font.h>
+#include <footprint.h>
+#include <geometry/convex_hull.h>
+#include <geometry/shape_segment.h>
+#include <geometry/shape_simple.h>
+#include <i18n_utility.h>
#include <lset.h>
#include <macros.h>
#include <pad.h>
-#include <pcb_marker.h>
-#include <pcb_group.h>
-#include <pcb_track.h>
#include <pcb_dimension.h>
+#include <pcb_edit_frame.h>
+#include <pcb_field.h>
+#include <pcb_group.h>
+#include <pcb_marker.h>
#include <pcb_reference_image.h>
#include <pcb_textbox.h>
-#include <pcb_field.h>
-#include <footprint.h>
-#include <zone.h>
+#include <pcb_track.h>
+#include <refdes_utils.h>
+#include <string_utils.h>
#include <view/view.h>
-#include <i18n_utility.h>
-#include <drc/drc_item.h>
-#include <geometry/shape_segment.h>
-#include <geometry/shape_simple.h>
-#include <convert_shape_list_to_polygon.h>
-#include <geometry/convex_hull.h>
-#include "convert_basic_shapes_to_polygon.h"
+#include <zone.h>
#include <google/protobuf/any.pb.h>
#include <api/board/board_types.pb.h>
@@ -79,6 +83,7 @@ FOOTPRINT::FOOTPRINT( BOARD* parent ) :
m_lastEditTime = 0;
m_zoneConnection = ZONE_CONNECTION::INHERITED;
m_fileFormatVersionAtLoad = 0;
+ m_embedFonts = false;
// These are the mandatory fields for the editor to work
for( int i = 0; i < MANDATORY_FIELDS; i++ )
@@ -118,6 +123,7 @@ FOOTPRINT::FOOTPRINT( const FOOTPRINT& aFootprint ) :
m_lastEditTime = aFootprint.m_lastEditTime;
m_link = aFootprint.m_link;
m_path = aFootprint.m_path;
+ m_embedFonts = aFootprint.m_embedFonts;
m_cachedBoundingBox = aFootprint.m_cachedBoundingBox;
m_boundingBoxCacheTimeStamp = aFootprint.m_boundingBoxCacheTimeStamp;
@@ -198,6 +204,9 @@ FOOTPRINT::FOOTPRINT( const FOOTPRINT& aFootprint ) :
}
}
+ for( auto& [ name, file ] : aFootprint.EmbeddedFileMap() )
+ AddFile( new EMBEDDED_FILES::EMBEDDED_FILE( *file ) );
+
// Copy auxiliary data
m_3D_Drawings = aFootprint.m_3D_Drawings;
m_libDescription = aFootprint.m_libDescription;
@@ -3702,6 +3711,39 @@ void FOOTPRINT::TransformFPShapesToPolySet( SHAPE_POLY_SET& aBuffer, PCB_LAYER_I
}
+void FOOTPRINT::EmbedFonts()
+{
+ using OUTLINE_FONT = KIFONT::OUTLINE_FONT;
+ using EMBEDDING_PERMISSION = OUTLINE_FONT::EMBEDDING_PERMISSION;
+
+ std::set<OUTLINE_FONT*> fonts;
+
+ for( BOARD_ITEM* item : GraphicalItems() )
+ {
+ if( auto* text = dynamic_cast<EDA_TEXT*>( item ) )
+ {
+ if( auto* font = text->GetFont(); font && !font->IsStroke() )
+ {
+ auto* outline = static_cast<OUTLINE_FONT*>( font );
+ auto permission = outline->GetEmbeddingPermission();
+
+ if( permission == EMBEDDING_PERMISSION::EDITABLE
+ || permission == EMBEDDING_PERMISSION::INSTALLABLE )
+ {
+ fonts.insert( outline );
+ }
+ }
+ }
+ }
+
+ for( auto* font : fonts )
+ {
+ auto file = GetEmbeddedFiles()->AddFile( font->GetFileName(), false );
+ file->type = EMBEDDED_FILES::EMBEDDED_FILE::FILE_TYPE::FONT;
+ }
+}
+
+
static struct FOOTPRINT_DESC
{
FOOTPRINT_DESC()
diff --git a/pcbnew/footprint.h b/pcbnew/footprint.h
index 6331c90585..197d5c69de 100644
--- a/pcbnew/footprint.h
+++ b/pcbnew/footprint.h
@@ -32,6 +32,7 @@
#include <board_item_container.h>
#include <board_item.h>
#include <collectors.h>
+#include <embedded_files.h>
#include <layer_ids.h> // ALL_LAYERS definition.
#include <lset.h>
#include <lib_id.h>
@@ -103,7 +104,7 @@ public:
};
-class FOOTPRINT : public BOARD_ITEM_CONTAINER
+class FOOTPRINT : public BOARD_ITEM_CONTAINER, public EMBEDDED_FILES
{
public:
FOOTPRINT( BOARD* parent );
@@ -968,6 +969,18 @@ public:
std::shared_ptr<SHAPE> GetEffectiveShape( PCB_LAYER_ID aLayer = UNDEFINED_LAYER,
FLASHING aFlash = FLASHING::DEFAULT ) const override;
+ EMBEDDED_FILES* GetEmbeddedFiles() override
+ {
+ return static_cast<EMBEDDED_FILES*>( this );
+ }
+
+ const EMBEDDED_FILES* GetEmbeddedFiles() const
+ {
+ return static_cast<const EMBEDDED_FILES*>( this );
+ }
+
+ void EmbedFonts() override;
+
double Similarity( const BOARD_ITEM& aOther ) const override;
bool operator==( const BOARD_ITEM& aOther ) const override;
diff --git a/pcbnew/footprint_edit_frame.cpp b/pcbnew/footprint_edit_frame.cpp
index 4eeb28871a..1ce6b5f0b6 100644
--- a/pcbnew/footprint_edit_frame.cpp
+++ b/pcbnew/footprint_edit_frame.cpp
@@ -20,6 +20,7 @@
* with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+#include "tool/embed_tool.h"
#include "tools/convert_tool.h"
#include "tools/drawing_tool.h"
#include "tools/edit_tool.h"
@@ -1117,6 +1118,7 @@ void FOOTPRINT_EDIT_FRAME::setupTools()
m_toolManager->RegisterTool( new CONVERT_TOOL );
m_toolManager->RegisterTool( new SCRIPTING_TOOL );
m_toolManager->RegisterTool( new PROPERTIES_TOOL );
+ m_toolManager->RegisterTool( new EMBED_TOOL );
for( TOOL_BASE* tool : m_toolManager->Tools() )
{
@@ -1281,6 +1283,7 @@ void FOOTPRINT_EDIT_FRAME::setupUIConditions()
CURRENT_EDIT_TOOL( ACTIONS::deleteTool );
CURRENT_EDIT_TOOL( ACTIONS::measureTool );
+ CURRENT_EDIT_TOOL( ACTIONS::embeddedFiles );
CURRENT_EDIT_TOOL( PCB_ACTIONS::placePad );
CURRENT_EDIT_TOOL( PCB_ACTIONS::drawLine );
CURRENT_EDIT_TOOL( PCB_ACTIONS::drawRectangle );
diff --git a/pcbnew/pcb_edit_frame.cpp b/pcbnew/pcb_edit_frame.cpp
index 4ac4a1e04b..e36b8e5915 100644
--- a/pcbnew/pcb_edit_frame.cpp
+++ b/pcbnew/pcb_edit_frame.cpp
@@ -62,6 +62,7 @@
#include <tool/action_toolbar.h>
#include <tool/common_control.h>
#include <tool/common_tools.h>
+#include <tool/embed_tool.h>
#include <tool/properties_tool.h>
#include <tool/selection.h>
#include <tool/zoom_tool.h>
@@ -705,6 +706,7 @@ void PCB_EDIT_FRAME::setupTools()
m_toolManager->RegisterTool( new GENERATOR_TOOL );
m_toolManager->RegisterTool( new SCRIPTING_TOOL );
m_toolManager->RegisterTool( new PROPERTIES_TOOL );
+ m_toolManager->RegisterTool( new EMBED_TOOL );
m_toolManager->InitTools();
for( TOOL_BASE* tool : m_toolManager->Tools() )
@@ -992,6 +994,7 @@ void PCB_EDIT_FRAME::setupUIConditions()
.Enable( isDRCIdle ) )
// These tools edit the board, so they must be disabled during some operations
+ CURRENT_EDIT_TOOL( ACTIONS::embeddedFiles );
CURRENT_EDIT_TOOL( ACTIONS::deleteTool );
CURRENT_EDIT_TOOL( PCB_ACTIONS::placeFootprint );
CURRENT_EDIT_TOOL( PCB_ACTIONS::routeSingleTrack);
diff --git a/pcbnew/pcb_edit_frame.h b/pcbnew/pcb_edit_frame.h
index 48850564f3..1d7a3ffcd5 100644
--- a/pcbnew/pcb_edit_frame.h
+++ b/pcbnew/pcb_edit_frame.h
@@ -219,6 +219,11 @@ public:
void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
+ /**
+ * Load the drawing sheet file.
+ */
+ void LoadDrawingSheet();
+
/**
* Get the last path for a particular type.
*
diff --git a/pcbnew/pcb_fields_grid_table.cpp b/pcbnew/pcb_fields_grid_table.cpp
index e3a8d1615d..0200e3452b 100644
--- a/pcbnew/pcb_fields_grid_table.cpp
+++ b/pcbnew/pcb_fields_grid_table.cpp
@@ -21,13 +21,18 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
-#include <kiway_player.h>
-#include <project.h>
-#include <pcb_fields_grid_table.h>
-#include <widgets/grid_combobox.h>
-#include <trigo.h>
-#include <pcb_base_frame.h>
+#include <board.h>
#include <footprint.h>
+#include <footprint_edit_frame.h>
+#include <kiway.h>
+#include <kiway_player.h>
+#include <pcb_fields_grid_table.h>
+#include <pcb_base_frame.h>
+#include <pcb_edit_frame.h>
+#include <project.h>
+#include <trigo.h>
+#include <widgets/grid_combobox.h>
+
#include "grid_layer_box_helpers.h"
#include <widgets/grid_text_button_helpers.h>
#include <widgets/grid_text_helpers.h>
@@ -95,8 +100,36 @@ PCB_FIELDS_GRID_TABLE::PCB_FIELDS_GRID_TABLE( PCB_BASE_FRAME* aFrame, DIALOG_SHI
fpIdEditor->SetValidator( m_nonUrlValidator );
m_footprintAttr->SetEditor( fpIdEditor );
+ EMBEDDED_FILES* files = nullptr;
+
+ // In the case of the footprint editor, we need to distinguish between the footprint
+ // in the library where the embedded files are stored with the footprint and the footprint
+ // from the board where the embedded files are stored with the board.
+ if( m_frame->GetFrameType() == FRAME_FOOTPRINT_EDITOR )
+ {
+ FOOTPRINT_EDIT_FRAME* fpFrame = static_cast<FOOTPRINT_EDIT_FRAME*>( m_frame );
+
+ if( fpFrame->IsCurrentFPFromBoard() )
+ {
+ PCB_EDIT_FRAME* pcbframe = (PCB_EDIT_FRAME*) m_frame->Kiway().Player( FRAME_PCB_EDITOR, false );
+
+ if( pcbframe != nullptr ) // happens when the board editor is not active (or closed)
+ {
+ files = pcbframe->GetBoard();
+ }
+ }
+ else
+ {
+ files = fpFrame->GetBoard()->GetFirstFootprint();
+ }
+ }
+ else if( m_frame->GetFrameType() == FRAME_PCB_EDITOR )
+ {
+ files = static_cast<PCB_EDIT_FRAME*>( m_frame )->GetBoard();
+ }
+
m_urlAttr = new wxGridCellAttr;
- GRID_CELL_URL_EDITOR* urlEditor = new GRID_CELL_URL_EDITOR( m_dialog );
+ GRID_CELL_URL_EDITOR* urlEditor = new GRID_CELL_URL_EDITOR( m_dialog, nullptr, files );
urlEditor->SetValidator( m_urlValidator );
m_urlAttr->SetEditor( urlEditor );
diff --git a/pcbnew/pcb_io/altium/CMakeLists.txt b/pcbnew/pcb_io/altium/CMakeLists.txt
index 171c6f085b..86aa41d70a 100644
--- a/pcbnew/pcb_io/altium/CMakeLists.txt
+++ b/pcbnew/pcb_io/altium/CMakeLists.txt
@@ -4,6 +4,7 @@
set( ALTIUM2PCBNEW_SRCS
altium_parser_pcb.cpp
altium_pcb.cpp
+ altium_pcb_compound_file.cpp
altium_rule_transformer.cpp
pcb_io_altium_circuit_maker.cpp
pcb_io_altium_circuit_studio.cpp
diff --git a/pcbnew/pcb_io/altium/altium_parser_pcb.cpp b/pcbnew/pcb_io/altium/altium_parser_pcb.cpp
index 4d50d7ad6e..a69e810fbc 100644
--- a/pcbnew/pcb_io/altium/altium_parser_pcb.cpp
+++ b/pcbnew/pcb_io/altium/altium_parser_pcb.cpp
@@ -462,6 +462,9 @@ AMODEL::AMODEL( ALTIUM_BINARY_PARSER& aReader )
rotation.y = ALTIUM_PROPS_UTILS::ReadDouble( properties, wxT( "ROTY" ), 0. );
rotation.z = ALTIUM_PROPS_UTILS::ReadDouble( properties, wxT( "ROTZ" ), 0. );
+ z_offset = ALTIUM_PROPS_UTILS::ReadDouble( properties, wxT( "DZ" ), 0. );
+ checksum = ALTIUM_PROPS_UTILS::ReadInt( properties, wxT( "CHECKSUM" ), 0 );
+
if( aReader.HasParsingError() )
THROW_IO_ERROR( wxT( "Model stream was not parsed correctly" ) );
}
@@ -704,7 +707,7 @@ ACOMPONENTBODY6::ACOMPONENTBODY6( ALTIUM_BINARY_PARSER& aReader )
rotation = ALTIUM_PROPS_UTILS::ReadDouble( properties, wxT( "MODEL.2D.ROTATION" ), 0. );
- bodyOpacity = ALTIUM_PROPS_UTILS::ReadDouble( properties, wxT( "BODYOPACITY3D" ), 1. );
+ body_opacity_3d = ALTIUM_PROPS_UTILS::ReadDouble( properties, wxT( "BODYOPACITY3D" ), 1. );
aReader.SkipSubrecord();
diff --git a/pcbnew/pcb_io/altium/altium_parser_pcb.h b/pcbnew/pcb_io/altium/altium_parser_pcb.h
index e5dcfd4929..5450db753b 100644
--- a/pcbnew/pcb_io/altium/altium_parser_pcb.h
+++ b/pcbnew/pcb_io/altium/altium_parser_pcb.h
@@ -460,6 +460,8 @@ struct AMODEL
bool isEmbedded;
VECTOR3D rotation;
+ double z_offset;
+ int32_t checksum;
explicit AMODEL( ALTIUM_BINARY_PARSER& aReader );
};
@@ -592,14 +594,37 @@ struct ACOMPONENTBODY6
{
uint16_t component;
- wxString modelName;
+ wxString body_name;
+ int kind;
+ int subpolyindex;
+ int unionindex;
+ int arc_resolution;
+ bool is_shape_based;
+ int cavity_height;
+ int standoff_height;
+ int overall_height;
+ int body_projection;
+ int body_color_3d;
+ int body_opacity_3d;
+ wxString identifier;
+ wxString texture;
+ int texture_center_x;
+ int texture_center_y;
+ int texture_size_x;
+ int texture_size_y;
+ int texture_rotation;
+
wxString modelId;
+ wxString modelChecksum;
bool modelIsEmbedded;
+ wxString modelName;
+ int modelType;
+ int modelSource;
+ int modelSnapCount;
VECTOR3D modelPosition;
VECTOR3D modelRotation;
double rotation;
- double bodyOpacity;
explicit ACOMPONENTBODY6( ALTIUM_BINARY_PARSER& aReader );
};
diff --git a/pcbnew/pcb_io/altium/altium_pcb.cpp b/pcbnew/pcb_io/altium/altium_pcb.cpp
index 8c82926774..66dda9f162 100644
--- a/pcbnew/pcb_io/altium/altium_pcb.cpp
+++ b/pcbnew/pcb_io/altium/altium_pcb.cpp
@@ -24,6 +24,7 @@
#include "altium_pcb.h"
#include "altium_parser_pcb.h"
+#include <altium_pcb_compound_file.h>
#include <io/altium/altium_binary_parser.h>
#include <io/altium/altium_parser_utils.h>
@@ -313,114 +314,114 @@ void ALTIUM_PCB::checkpoint()
}
}
-void ALTIUM_PCB::Parse( const ALTIUM_COMPOUND_FILE& altiumPcbFile,
+void ALTIUM_PCB::Parse( const ALTIUM_PCB_COMPOUND_FILE& altiumPcbFile,
const std::map<ALTIUM_PCB_DIR, std::string>& aFileMapping )
{
// this vector simply declares in which order which functions to call.
const std::vector<std::tuple<bool, ALTIUM_PCB_DIR, PARSE_FUNCTION_POINTER_fp>> parserOrder = {
{ true, ALTIUM_PCB_DIR::FILE_HEADER,
- [this]( const ALTIUM_COMPOUND_FILE& aFile, auto fileHeader )
+ [this]( const ALTIUM_PCB_COMPOUND_FILE& aFile, auto fileHeader )
{
this->ParseFileHeader( aFile, fileHeader );
} },
{ true, ALTIUM_PCB_DIR::BOARD6,
- [this]( const ALTIUM_COMPOUND_FILE& aFile, auto fileHeader )
+ [this]( const ALTIUM_PCB_COMPOUND_FILE& aFile, auto fileHeader )
{
this->ParseBoard6Data( aFile, fileHeader );
} },
{ false, ALTIUM_PCB_DIR::EXTENDPRIMITIVEINFORMATION,
- [this]( const ALTIUM_COMPOUND_FILE& aFile, auto fileHeader )
+ [this]( const ALTIUM_PCB_COMPOUND_FILE& aFile, auto fileHeader )
{
this->ParseExtendedPrimitiveInformationData( aFile, fileHeader );
} },
{ true, ALTIUM_PCB_DIR::COMPONENTS6,
- [this]( const ALTIUM_COMPOUND_FILE& aFile, auto fileHeader )
+ [this]( const ALTIUM_PCB_COMPOUND_FILE& aFile, auto fileHeader )
{
this->ParseComponents6Data( aFile, fileHeader );
} },
{ false, ALTIUM_PCB_DIR::MODELS,
- [this, aFileMapping]( const ALTIUM_COMPOUND_FILE& aFile, auto fileHeader )
+ [this, aFileMapping]( const ALTIUM_PCB_COMPOUND_FILE& aFile, auto fileHeader )
{
std::vector<std::string> dir{ aFileMapping.at( ALTIUM_PCB_DIR::MODELS ) };
this->ParseModelsData( aFile, fileHeader, dir );
} },
{ true, ALTIUM_PCB_DIR::COMPONENTBODIES6,
- [this]( const ALTIUM_COMPOUND_FILE& aFile, auto fileHeader )
+ [this]( const ALTIUM_PCB_COMPOUND_FILE& aFile, auto fileHeader )
{
this->ParseComponentsBodies6Data( aFile, fileHeader );
} },
{ true, ALTIUM_PCB_DIR::NETS6,
- [this]( const ALTIUM_COMPOUND_FILE& aFile, auto fileHeader )
+ [this]( const ALTIUM_PCB_COMPOUND_FILE& aFile, auto fileHeader )
{
this->ParseNets6Data( aFile, fileHeader );
} },
{ true, ALTIUM_PCB_DIR::CLASSES6,
- [this]( const ALTIUM_COMPOUND_FILE& aFile, auto fileHeader )
+ [this]( const ALTIUM_PCB_COMPOUND_FILE& aFile, auto fileHeader )
{
this->ParseClasses6Data( aFile, fileHeader );
} },
{ true, ALTIUM_PCB_DIR::RULES6,
- [this]( const ALTIUM_COMPOUND_FILE& aFile, auto fileHeader )
+ [this]( const ALTIUM_PCB_COMPOUND_FILE& aFile, auto fileHeader )
{
this->ParseRules6Data( aFile, fileHeader );
} },
{ true, ALTIUM_PCB_DIR::DIMENSIONS6,
- [this]( const ALTIUM_COMPOUND_FILE& aFile, auto fileHeader )
+ [this]( const ALTIUM_PCB_COMPOUND_FILE& aFile, auto fileHeader )
{
this->ParseDimensions6Data( aFile, fileHeader );
} },
{ true, ALTIUM_PCB_DIR::POLYGONS6,
- [this]( const ALTIUM_COMPOUND_FILE& aFile, auto fileHeader )
+ [this]( const ALTIUM_PCB_COMPOUND_FILE& aFile, auto fileHeader )
{
this->ParsePolygons6Data( aFile, fileHeader );
} },
{ true, ALTIUM_PCB_DIR::ARCS6,
- [this]( const ALTIUM_COMPOUND_FILE& aFile, auto fileHeader )
+ [this]( const ALTIUM_PCB_COMPOUND_FILE& aFile, auto fileHeader )
{
this->ParseArcs6Data( aFile, fileHeader );
} },
{ true, ALTIUM_PCB_DIR::PADS6,
- [this]( const ALTIUM_COMPOUND_FILE& aFile, auto fileHeader )
+ [this]( const ALTIUM_PCB_COMPOUND_FILE& aFile, auto fileHeader )
{
this->ParsePads6Data( aFile, fileHeader );
} },
{ true, ALTIUM_PCB_DIR::VIAS6,
- [this]( const ALTIUM_COMPOUND_FILE& aFile, auto fileHeader )
+ [this]( const ALTIUM_PCB_COMPOUND_FILE& aFile, auto fileHeader )
{
this->ParseVias6Data( aFile, fileHeader );
} },
{ true, ALTIUM_PCB_DIR::TRACKS6,
- [this]( const ALTIUM_COMPOUND_FILE& aFile, auto fileHeader )
+ [this]( const ALTIUM_PCB_COMPOUND_FILE& aFile, auto fileHeader )
{
this->ParseTracks6Data( aFile, fileHeader );
} },
{ false, ALTIUM_PCB_DIR::WIDESTRINGS6,
- [this]( const ALTIUM_COMPOUND_FILE& aFile, auto fileHeader )
+ [this]( const ALTIUM_PCB_COMPOUND_FILE& aFile, auto fileHeader )
{
this->ParseWideStrings6Data( aFile, fileHeader );
} },
{ true, ALTIUM_PCB_DIR::TEXTS6,
- [this]( const ALTIUM_COMPOUND_FILE& aFile, auto fileHeader )
+ [this]( const ALTIUM_PCB_COMPOUND_FILE& aFile, auto fileHeader )
{
this->ParseTexts6Data( aFile, fileHeader );
} },
{ true, ALTIUM_PCB_DIR::FILLS6,
- [this]( const ALTIUM_COMPOUND_FILE& aFile, auto fileHeader )
+ [this]( const ALTIUM_PCB_COMPOUND_FILE& aFile, auto fileHeader )
{
this->ParseFills6Data( aFile, fileHeader );
} },
{ false, ALTIUM_PCB_DIR::BOARDREGIONS,
- [this]( const ALTIUM_COMPOUND_FILE& aFile, auto fileHeader )
+ [this]( const ALTIUM_PCB_COMPOUND_FILE& aFile, auto fileHeader )
{
this->ParseBoardRegionsData( aFile, fileHeader );
} },
{ true, ALTIUM_PCB_DIR::SHAPEBASEDREGIONS6,
- [this]( const ALTIUM_COMPOUND_FILE& aFile, auto fileHeader )
+ [this]( const ALTIUM_PCB_COMPOUND_FILE& aFile, auto fileHeader )
{
this->ParseShapeBasedRegions6Data( aFile, fileHeader );
} },
{ true, ALTIUM_PCB_DIR::REGIONS6,
- [this]( const ALTIUM_COMPOUND_FILE& aFile, auto fileHeader )
+ [this]( const ALTIUM_PCB_COMPOUND_FILE& aFile, auto fileHeader )
{
this->ParseRegions6Data( aFile, fileHeader );
} }
@@ -654,8 +655,8 @@ void ALTIUM_PCB::Parse( const ALTIUM_COMPOUND_FILE& altiumPcbFi
}
-FOOTPRINT* ALTIUM_PCB::ParseFootprint( ALTIUM_COMPOUND_FILE& altiumLibFile,
- const wxString& aFootprintName )
+FOOTPRINT* ALTIUM_PCB::ParseFootprint( ALTIUM_PCB_COMPOUND_FILE& altiumLibFile,
+ const wxString& aFootprintName )
{
std::unique_ptr<FOOTPRINT> footprint = std::make_unique<FOOTPRINT>( m_board );
@@ -675,7 +676,8 @@ FOOTPRINT* ALTIUM_PCB::ParseFootprint( ALTIUM_COMPOUND_FILE& altiumLibFile,
// ParseWideStrings6Data( altiumLibFile, unicodeStringsData );
// }
- std::tuple<wxString, const CFB::COMPOUND_FILE_ENTRY*> ret = altiumLibFile.FindLibFootprintDirName(aFootprintName);
+ std::tuple<wxString, const CFB::COMPOUND_FILE_ENTRY*> ret =
+ altiumLibFile.FindLibFootprintDirName( aFootprintName );
wxString fpDirName = std::get<0>( ret );
const CFB::COMPOUND_FILE_ENTRY* footprintStream = std::get<1>( ret );
@@ -803,7 +805,7 @@ FOOTPRINT* ALTIUM_PCB::ParseFootprint( ALTIUM_COMPOUND_FILE& altiumLibFile,
case ALTIUM_RECORD::MODEL:
{
ACOMPONENTBODY6 componentBody( parser );
- // Won't be supported for now, as we would need to extract the model
+ ConvertComponentBody6ToFootprintItem( altiumLibFile, footprint.get(), componentBody );
break;
}
default:
@@ -909,7 +911,7 @@ const ARULE6* ALTIUM_PCB::GetRuleDefault( ALTIUM_RULE_KIND aKind ) const
return nullptr;
}
-void ALTIUM_PCB::ParseFileHeader( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+void ALTIUM_PCB::ParseFileHeader( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry )
{
ALTIUM_BINARY_PARSER reader( aAltiumPcbFile, aEntry );
@@ -927,7 +929,7 @@ void ALTIUM_PCB::ParseFileHeader( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile
}
-void ALTIUM_PCB::ParseExtendedPrimitiveInformationData( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+void ALTIUM_PCB::ParseExtendedPrimitiveInformationData( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry )
{
if( m_progressReporter )
@@ -949,7 +951,7 @@ void ALTIUM_PCB::ParseExtendedPrimitiveInformationData( const ALTIUM_COMPOUND_FI
}
-void ALTIUM_PCB::ParseBoard6Data( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+void ALTIUM_PCB::ParseBoard6Data( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry )
{
if( m_progressReporter )
@@ -1201,7 +1203,7 @@ void ALTIUM_PCB::HelperCreateBoardOutline( const std::vector<ALTIUM_VERTICE>& aV
}
-void ALTIUM_PCB::ParseClasses6Data( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+void ALTIUM_PCB::ParseClasses6Data( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry )
{
if( m_progressReporter )
@@ -1253,7 +1255,7 @@ void ALTIUM_PCB::ParseClasses6Data( const ALTIUM_COMPOUND_FILE& aAltiumPcbFi
}
-void ALTIUM_PCB::ParseComponents6Data( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+void ALTIUM_PCB::ParseComponents6Data( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry )
{
if( m_progressReporter )
@@ -1315,7 +1317,85 @@ double normalizeAngleDegrees( double Angle, double aMin, double aMax )
}
-void ALTIUM_PCB::ParseComponentsBodies6Data( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+void ALTIUM_PCB::ConvertComponentBody6ToFootprintItem( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
+ FOOTPRINT* aFootprint,
+ const ACOMPONENTBODY6& aElem )
+{
+ if( m_progressReporter )
+ m_progressReporter->Report( _( "Loading component 3D models..." ) );
+
+ if( !aElem.modelIsEmbedded )
+ return;
+
+ auto model = aAltiumPcbFile.GetLibModel( aElem.modelId );
+
+ if( !model )
+ {
+ if( m_reporter )
+ {
+ m_reporter->Report( wxString::Format( wxT( "Model %s not found for footprint %s" ),
+ aElem.modelId, aFootprint->GetReference() ),
+ RPT_SEVERITY_ERROR );
+ }
+
+ return;
+ }
+
+ const VECTOR2I& fpPosition = aFootprint->GetPosition();
+
+ EMBEDDED_FILES::EMBEDDED_FILE* file = new EMBEDDED_FILES::EMBEDDED_FILE();
+ file->name = aElem.modelName;
+ // Decompress the model data before assigning
+ std::vector<char> decompressedData;
+ wxMemoryInputStream compressedStream(model->second.data(), model->second.size());
+ wxZlibInputStream zlibStream(compressedStream);
+
+ decompressedData.reserve(model->second.size() * 2); // Reserve some space, assuming decompressed data is larger
+ while (!zlibStream.Eof()) {
+ size_t currentSize = decompressedData.size();
+ decompressedData.resize(currentSize + 4096); // Increase buffer size
+ zlibStream.Read(decompressedData.data() + currentSize, 4096);
+ size_t bytesRead = zlibStream.LastRead();
+ decompressedData.resize(currentSize + bytesRead); // Resize to actual read size
+ }
+
+ file->decompressedData = std::move( decompressedData );
+ file->type = EMBEDDED_FILES::EMBEDDED_FILE::FILE_TYPE::MODEL;
+
+ EMBEDDED_FILES::CompressAndEncode( *file );
+ aFootprint->GetEmbeddedFiles()->AddFile( file );
+
+ FP_3DMODEL modelSettings;
+
+ modelSettings.m_Filename = aFootprint->GetEmbeddedFiles()->GetEmbeddedFileLink( *file );
+
+ modelSettings.m_Offset.x = pcbIUScale.IUTomm((int) aElem.modelPosition.x - fpPosition.x );
+ modelSettings.m_Offset.y = -pcbIUScale.IUTomm((int) aElem.modelPosition.y - fpPosition.y );
+ modelSettings.m_Offset.z = pcbIUScale.IUTomm( (int) aElem.modelPosition.z + model->first.z_offset );
+
+ EDA_ANGLE orientation = aFootprint->GetOrientation();
+
+ if( aFootprint->IsFlipped() )
+ {
+ modelSettings.m_Offset.y = -modelSettings.m_Offset.y;
+ orientation = -orientation;
+ }
+
+ RotatePoint( &modelSettings.m_Offset.x, &modelSettings.m_Offset.y, orientation );
+
+ modelSettings.m_Rotation.x = normalizeAngleDegrees( -aElem.modelRotation.x + model->first.rotation.x, -180, 180 );
+ modelSettings.m_Rotation.y = normalizeAngleDegrees( -aElem.modelRotation.y + model->first.rotation.y, -180, 180 );
+ modelSettings.m_Rotation.z = normalizeAngleDegrees( -aElem.modelRotation.z + aElem.rotation
+ + orientation.AsDegrees()
+ + model->first.rotation.z,
+ -180, 180 );
+ modelSettings.m_Opacity = aElem.body_opacity_3d;
+
+ aFootprint->Models().push_back( modelSettings );
+}
+
+
+void ALTIUM_PCB::ParseComponentsBodies6Data( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry )
{
if( m_progressReporter )
@@ -1326,7 +1406,7 @@ void ALTIUM_PCB::ParseComponentsBodies6Data( const ALTIUM_COMPOUND_FILE& aAl
while( reader.GetRemainingBytes() >= 4 /* TODO: use Header section of file */ )
{
checkpoint();
- ACOMPONENTBODY6 elem( reader ); // TODO: implement
+ ACOMPONENTBODY6 elem( reader );
if( elem.component == ALTIUM_COMPONENT_NONE )
continue; // TODO: we do not support components for the board yet
@@ -1334,7 +1414,7 @@ void ALTIUM_PCB::ParseComponentsBodies6Data( const ALTIUM_COMPOUND_FILE& aAl
if( m_components.size() <= elem.component )
{
THROW_IO_ERROR( wxString::Format( wxT( "ComponentsBodies6 stream tries to access "
- "component id %d of %d existing components" ),
+ "component id %d of %zu existing components" ),
elem.component,
m_components.size() ) );
}
@@ -1342,9 +1422,9 @@ void ALTIUM_PCB::ParseComponentsBodies6Data( const ALTIUM_COMPOUND_FILE& aAl
if( !elem.modelIsEmbedded )
continue;
- auto modelTuple = m_models.find( elem.modelId );
+ auto modelTuple = m_EmbeddedModels.find( elem.modelId );
- if( modelTuple == m_models.end() )
+ if( modelTuple == m_EmbeddedModels.end() )
{
if( m_reporter )
{
@@ -1357,34 +1437,36 @@ void ALTIUM_PCB::ParseComponentsBodies6Data( const ALTIUM_COMPOUND_FILE& aAl
continue;
}
- FOOTPRINT* footprint = m_components.at( elem.component );
- const VECTOR2I& fpPosition = footprint->GetPosition();
+ FOOTPRINT* footprint = m_components.at( elem.component );
+
+ EMBEDDED_FILES::EMBEDDED_FILE* file = new EMBEDDED_FILES::EMBEDDED_FILE();
+ file->name = modelTuple->second.m_modelname;
+
+ wxMemoryInputStream compressedStream(modelTuple->second.m_data.data(), modelTuple->second.m_data.size());
+ wxZlibInputStream zlibStream(compressedStream);
+ wxMemoryOutputStream decompressedStream;
+ zlibStream.Read(decompressedStream);
+ file->decompressedData.resize(decompressedStream.GetSize());
+ decompressedStream.CopyTo(file->decompressedData.data(), file->decompressedData.size());
+
+ EMBEDDED_FILES::CompressAndEncode( *file );
+ m_board->GetEmbeddedFiles()->AddFile( file );
FP_3DMODEL modelSettings;
- modelSettings.m_Filename = modelTuple->second;
+ modelSettings.m_Filename = footprint->GetEmbeddedFiles()->GetEmbeddedFileLink( *file );
- modelSettings.m_Offset.x = pcbIUScale.IUTomm((int) elem.modelPosition.x - fpPosition.x );
- modelSettings.m_Offset.y = -pcbIUScale.IUTomm((int) elem.modelPosition.y - fpPosition.y );
- modelSettings.m_Offset.z = pcbIUScale.IUTomm( (int) elem.modelPosition.z );
+ modelSettings.m_Offset.x = pcbIUScale.IUTomm((int) elem.modelPosition.x );
+ modelSettings.m_Offset.y = -pcbIUScale.IUTomm((int) elem.modelPosition.y );
+ modelSettings.m_Offset.z = pcbIUScale.IUTomm( (int) elem.modelPosition.z + modelTuple->second.m_z_offset );
- EDA_ANGLE orientation = footprint->GetOrientation();
-
- if( footprint->IsFlipped() )
- {
- modelSettings.m_Offset.y = -modelSettings.m_Offset.y;
- orientation = -orientation;
- }
-
- RotatePoint( &modelSettings.m_Offset.x, &modelSettings.m_Offset.y, orientation );
-
- modelSettings.m_Rotation.x = normalizeAngleDegrees( -elem.modelRotation.x, -180, 180 );
- modelSettings.m_Rotation.y = normalizeAngleDegrees( -elem.modelRotation.y, -180, 180 );
+ modelSettings.m_Rotation.x = normalizeAngleDegrees( -elem.modelRotation.x + modelTuple->second.m_rotation.x, -180, 180 );
+ modelSettings.m_Rotation.y = normalizeAngleDegrees( -elem.modelRotation.y + modelTuple->second.m_rotation.y, -180, 180 );
modelSettings.m_Rotation.z = normalizeAngleDegrees( -elem.modelRotation.z
+ elem.rotation
- + orientation.AsDegrees(),
+ + modelTuple->second.m_rotation.z,
-180, 180 );
- modelSettings.m_Opacity = elem.bodyOpacity;
+ modelSettings.m_Opacity = elem.body_opacity_3d;
footprint->Models().push_back( modelSettings );
}
@@ -1756,7 +1838,7 @@ void ALTIUM_PCB::HelperParseDimensions6Center( const ADIMENSION6& aElem )
}
-void ALTIUM_PCB::ParseDimensions6Data( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+void ALTIUM_PCB::ParseDimensions6Data( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry )
{
if( m_progressReporter )
@@ -1840,7 +1922,7 @@ void ALTIUM_PCB::ParseDimensions6Data( const ALTIUM_COMPOUND_FILE& aAltiumPc
}
-void ALTIUM_PCB::ParseModelsData( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+void ALTIUM_PCB::ParseModelsData( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry,
const std::vector<std::string>& aRootDir )
{
@@ -1852,37 +1934,6 @@ void ALTIUM_PCB::ParseModelsData( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile
if( reader.GetRemainingBytes() == 0 )
return;
- wxString projectPath = wxPathOnly( m_board->GetFileName() );
- // TODO: set KIPRJMOD always after import (not only when loading project)?
- wxSetEnv( PROJECT_VAR_NAME, projectPath );
-
- // TODO: make this path configurable?
- const wxString altiumModelDir = wxT( "ALTIUM_EMBEDDED_MODELS" );
-
- wxFileName altiumModelsPath = wxFileName::DirName( projectPath );
- wxString kicadModelPrefix = wxT( "${KIPRJMOD}/" ) + altiumModelDir + wxT( "/" );
-
- if( !altiumModelsPath.AppendDir( altiumModelDir ) )
- THROW_IO_ERROR( wxT( "Cannot construct directory path for step models" ) );
-
- // Create dir if it does not exist
- if( !altiumModelsPath.DirExists() )
- {
- if( !altiumModelsPath.Mkdir() )
- {
- if( m_reporter )
- {
- wxString msg;
- msg.Printf( _( "Failed to create folder '%s'." ) + wxS( " " )
- + _( "No 3D-models will be imported." ),
- altiumModelsPath.GetFullPath() );
- m_reporter->Report( msg, RPT_SEVERITY_ERROR );
- }
-
- return;
- }
- }
-
int idx = 0;
wxString invalidChars = wxFileName::GetForbiddenChars();
@@ -1898,7 +1949,6 @@ void ALTIUM_PCB::ParseModelsData( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile
wxString::npos == elem.name.find_first_of( invalidChars );
wxString storageName = !validName ? wxString::Format( wxT( "model_%d" ), idx )
: elem.name;
- wxFileName storagePath( altiumModelsPath.GetPath(), storageName );
idx++;
@@ -1924,40 +1974,9 @@ void ALTIUM_PCB::ParseModelsData( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile
aAltiumPcbFile.GetCompoundFileReader().ReadFile( stepEntry, 0, stepContent.data(),
stepSize );
- if( !storagePath.IsDirWritable() )
- {
- if( m_reporter )
- {
- wxString msg;
- msg.Printf( _( "Insufficient permissions to save file '%s'." ),
- storagePath.GetFullPath() );
- m_reporter->Report( msg, RPT_SEVERITY_ERROR );
- }
-
- continue;
- }
-
- wxMemoryInputStream stepStream( stepContent.data(), stepSize );
- wxZlibInputStream zlibInputStream( stepStream );
-
- wxFFileOutputStream outputStream( storagePath.GetFullPath() );
-
- if( !outputStream.IsOk() )
- {
- if( m_reporter )
- {
- wxString msg;
- msg.Printf( _( "Unable to write file '%s'." ), storagePath.GetFullPath() );
- m_reporter->Report( msg, RPT_SEVERITY_ERROR );
- }
-
- continue;
- }
-
- outputStream.Write( zlibInputStream );
- outputStream.Close();
-
- m_models.insert( { elem.id, kicadModelPrefix + storageName } );
+ m_EmbeddedModels.insert( std::make_pair(
+ elem.id, ALTIUM_EMBEDDED_MODEL_DATA( storageName, elem.rotation, elem.z_offset,
+ std::move( stepContent ) ) ) );
}
if( reader.GetRemainingBytes() != 0 )
@@ -1965,7 +1984,7 @@ void ALTIUM_PCB::ParseModelsData( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile
}
-void ALTIUM_PCB::ParseNets6Data( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+void ALTIUM_PCB::ParseNets6Data( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry )
{
if( m_progressReporter )
@@ -1991,7 +2010,7 @@ void ALTIUM_PCB::ParseNets6Data( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
THROW_IO_ERROR( wxT( "Nets6 stream is not fully parsed" ) );
}
-void ALTIUM_PCB::ParsePolygons6Data( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+void ALTIUM_PCB::ParsePolygons6Data( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry )
{
if( m_progressReporter )
@@ -2158,7 +2177,7 @@ void ALTIUM_PCB::ParsePolygons6Data( const ALTIUM_COMPOUND_FILE& aAltiumPcbF
THROW_IO_ERROR( wxT( "Polygons6 stream is not fully parsed" ) );
}
-void ALTIUM_PCB::ParseRules6Data( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+void ALTIUM_PCB::ParseRules6Data( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry )
{
if( m_progressReporter )
@@ -2226,7 +2245,7 @@ void ALTIUM_PCB::ParseRules6Data( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile
THROW_IO_ERROR( wxT( "Rules6 stream is not fully parsed" ) );
}
-void ALTIUM_PCB::ParseBoardRegionsData( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+void ALTIUM_PCB::ParseBoardRegionsData( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry )
{
if( m_progressReporter )
@@ -2246,7 +2265,7 @@ void ALTIUM_PCB::ParseBoardRegionsData( const ALTIUM_COMPOUND_FILE& aAltiumP
THROW_IO_ERROR( wxT( "BoardRegions stream is not fully parsed" ) );
}
-void ALTIUM_PCB::ParseShapeBasedRegions6Data( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+void ALTIUM_PCB::ParseShapeBasedRegions6Data( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry )
{
if( m_progressReporter )
@@ -2680,7 +2699,7 @@ void ALTIUM_PCB::ConvertShapeBasedRegions6ToFootprintItemOnLayer( FOOTPRINT*
}
-void ALTIUM_PCB::ParseRegions6Data( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+void ALTIUM_PCB::ParseRegions6Data( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry )
{
if( m_progressReporter )
@@ -2755,7 +2774,7 @@ void ALTIUM_PCB::ParseRegions6Data( const ALTIUM_COMPOUND_FILE& aAltiumPcbFi
}
-void ALTIUM_PCB::ParseArcs6Data( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+void ALTIUM_PCB::ParseArcs6Data( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry )
{
if( m_progressReporter )
@@ -3001,7 +3020,7 @@ void ALTIUM_PCB::ConvertArcs6ToFootprintItemOnLayer( FOOTPRINT* aFootprint, cons
}
-void ALTIUM_PCB::ParsePads6Data( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+void ALTIUM_PCB::ParsePads6Data( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry )
{
if( m_progressReporter )
@@ -3710,7 +3729,7 @@ void ALTIUM_PCB::HelperParsePad6NonCopper( const APAD6& aElem, PCB_LAYER_ID aLay
}
-void ALTIUM_PCB::ParseVias6Data( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+void ALTIUM_PCB::ParseVias6Data( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry )
{
if( m_progressReporter )
@@ -3785,7 +3804,7 @@ void ALTIUM_PCB::ParseVias6Data( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
THROW_IO_ERROR( wxT( "Vias6 stream is not fully parsed" ) );
}
-void ALTIUM_PCB::ParseTracks6Data( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+void ALTIUM_PCB::ParseTracks6Data( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry )
{
if( m_progressReporter )
@@ -4002,7 +4021,7 @@ void ALTIUM_PCB::ConvertTracks6ToFootprintItemOnLayer( FOOTPRINT* aFootprint, co
}
-void ALTIUM_PCB::ParseWideStrings6Data( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+void ALTIUM_PCB::ParseWideStrings6Data( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry )
{
if( m_progressReporter )
@@ -4016,7 +4035,7 @@ void ALTIUM_PCB::ParseWideStrings6Data( const ALTIUM_COMPOUND_FILE& aAltiumP
THROW_IO_ERROR( wxT( "WideStrings6 stream is not fully parsed" ) );
}
-void ALTIUM_PCB::ParseTexts6Data( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+void ALTIUM_PCB::ParseTexts6Data( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry )
{
if( m_progressReporter )
@@ -4324,7 +4343,7 @@ void ALTIUM_PCB::ConvertTexts6ToEdaTextSettings( const ATEXT6& aElem, EDA_TEXT&
}
-void ALTIUM_PCB::ParseFills6Data( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+void ALTIUM_PCB::ParseFills6Data( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry )
{
if( m_progressReporter )
diff --git a/pcbnew/pcb_io/altium/altium_pcb.h b/pcbnew/pcb_io/altium/altium_pcb.h
index 01077c75b9..69489fa452 100644
--- a/pcbnew/pcb_io/altium/altium_pcb.h
+++ b/pcbnew/pcb_io/altium/altium_pcb.h
@@ -97,11 +97,24 @@ namespace CFB
struct COMPOUND_FILE_ENTRY;
} // namespace CFB
-class ALTIUM_COMPOUND_FILE;
+class ALTIUM_PCB_COMPOUND_FILE;
+
+// Structure for storing embedded model data
+struct ALTIUM_EMBEDDED_MODEL_DATA
+{
+ wxString m_modelname;
+ VECTOR3D m_rotation;
+ double m_z_offset;
+ std::vector<char> m_data;
+
+ // Constructor
+ ALTIUM_EMBEDDED_MODEL_DATA(const wxString& name, const VECTOR3D& rotation, double z_offset, std::vector<char>&& data)
+ : m_modelname(name), m_rotation(rotation), m_z_offset(z_offset), m_data(std::move(data)) {}
+};
// type declaration required for a helper method
class ALTIUM_PCB;
-typedef std::function<void( const ALTIUM_COMPOUND_FILE&, const CFB::COMPOUND_FILE_ENTRY* )>
+typedef std::function<void( const ALTIUM_PCB_COMPOUND_FILE&, const CFB::COMPOUND_FILE_ENTRY* )>
PARSE_FUNCTION_POINTER_fp;
class ALTIUM_PCB
@@ -114,11 +127,11 @@ public:
const wxString& aFootprintName = wxEmptyString);
~ALTIUM_PCB();
- void Parse( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+ void Parse( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const std::map<ALTIUM_PCB_DIR, std::string>& aFileMapping );
- FOOTPRINT* ParseFootprint( ALTIUM_COMPOUND_FILE& altiumLibFile,
- const wxString& aFootprintName );
+ FOOTPRINT* ParseFootprint( ALTIUM_PCB_COMPOUND_FILE& altiumLibFile,
+ const wxString& aFootprintName );
private:
void checkpoint();
@@ -129,30 +142,30 @@ private:
const ARULE6* GetRule( ALTIUM_RULE_KIND aKind, const wxString& aName ) const;
const ARULE6* GetRuleDefault( ALTIUM_RULE_KIND aKind ) const;
- void ParseFileHeader( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+ void ParseFileHeader( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry );
// Text Format
- void ParseBoard6Data( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+ void ParseBoard6Data( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry );
- void ParseClasses6Data( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+ void ParseClasses6Data( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry );
- void ParseComponents6Data( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+ void ParseComponents6Data( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry );
- void ParseDimensions6Data( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+ void ParseDimensions6Data( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry );
- void ParseModelsData( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+ void ParseModelsData( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry,
const std::vector<std::string>& aRootDir );
- void ParseNets6Data( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+ void ParseNets6Data( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry );
- void ParsePolygons6Data( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+ void ParsePolygons6Data( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry );
- void ParseRules6Data( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+ void ParseRules6Data( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry );
// Binary Format
- void ParseArcs6Data( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+ void ParseArcs6Data( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry );
void ConvertArcs6ToPcbShape( const AARC6& aElem, PCB_SHAPE* aShape );
void ConvertArcs6ToBoardItem( const AARC6& aElem, const int aPrimitiveIndex );
@@ -161,19 +174,22 @@ private:
void ConvertArcs6ToBoardItemOnLayer( const AARC6& aElem, PCB_LAYER_ID aLayer );
void ConvertArcs6ToFootprintItemOnLayer( FOOTPRINT* aFootprint, const AARC6& aElem,
PCB_LAYER_ID aLayer );
- void ParseComponentsBodies6Data( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+ void ParseComponentsBodies6Data( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry );
- void ParsePads6Data( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+ void ConvertComponentBody6ToFootprintItem( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
+ FOOTPRINT* aFootprint,
+ const ACOMPONENTBODY6& aElem );
+ void ParsePads6Data( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry );
void ConvertPads6ToBoardItem( const APAD6& aElem );
void ConvertPads6ToFootprintItem( FOOTPRINT* aFootprint, const APAD6& aElem );
void ConvertPads6ToBoardItemOnNonCopper( const APAD6& aElem );
void ConvertPads6ToFootprintItemOnCopper( FOOTPRINT* aFootprint, const APAD6& aElem );
void ConvertPads6ToFootprintItemOnNonCopper( FOOTPRINT* aFootprint, const APAD6& aElem );
- void ParseVias6Data( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+ void ParseVias6Data( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry );
void ConvertVias6ToFootprintItem( FOOTPRINT* aFootprint, const AVIA6& aElem );
- void ParseTracks6Data( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+ void ParseTracks6Data( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry );
void ConvertTracks6ToBoardItem( const ATRACK6& aElem, const int aPrimitiveIndex );
void ConvertTracks6ToFootprintItem( FOOTPRINT* aFootprint, const ATRACK6& aElem,
@@ -181,7 +197,7 @@ private:
void ConvertTracks6ToBoardItemOnLayer( const ATRACK6& aElem, PCB_LAYER_ID aLayer );
void ConvertTracks6ToFootprintItemOnLayer( FOOTPRINT* aFootprint, const ATRACK6& aElem,
PCB_LAYER_ID aLayer );
- void ParseTexts6Data( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+ void ParseTexts6Data( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry );
void ConvertTexts6ToBoardItem( const ATEXT6& aElem );
void ConvertTexts6ToFootprintItem( FOOTPRINT* aFootprint, const ATEXT6& aElem );
@@ -189,7 +205,7 @@ private:
void ConvertTexts6ToFootprintItemOnLayer( FOOTPRINT* aFootprint, const ATEXT6& aElem,
PCB_LAYER_ID aLayer );
void ConvertTexts6ToEdaTextSettings( const ATEXT6& aElem, EDA_TEXT& aEdaText );
- void ParseFills6Data( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+ void ParseFills6Data( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry );
void ConvertFills6ToBoardItem( const AFILL6& aElem );
void ConvertFills6ToFootprintItem( FOOTPRINT* aFootprint, const AFILL6& aElem,
@@ -197,9 +213,9 @@ private:
void ConvertFills6ToBoardItemOnLayer( const AFILL6& aElem, PCB_LAYER_ID aLayer );
void ConvertFills6ToFootprintItemOnLayer( FOOTPRINT* aFootprint, const AFILL6& aElem,
PCB_LAYER_ID aLayer );
- void ParseBoardRegionsData( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+ void ParseBoardRegionsData( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry );
- void ParseShapeBasedRegions6Data( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+ void ParseShapeBasedRegions6Data( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry );
void ConvertShapeBasedRegions6ToBoardItem( const AREGION6& aElem );
void ConvertShapeBasedRegions6ToFootprintItem( FOOTPRINT* aFootprint, const AREGION6& aElem,
@@ -209,11 +225,11 @@ private:
const AREGION6& aElem,
PCB_LAYER_ID aLayer,
const int aPrimitiveIndex );
- void ParseExtendedPrimitiveInformationData( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+ void ParseExtendedPrimitiveInformationData( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry );
- void ParseRegions6Data( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+ void ParseRegions6Data( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry );
- void ParseWideStrings6Data( const ALTIUM_COMPOUND_FILE& aAltiumPcbFile,
+ void ParseWideStrings6Data( const ALTIUM_PCB_COMPOUND_FILE& aAltiumPcbFile,
const CFB::COMPOUND_FILE_ENTRY* aEntry );
// Helper Functions
@@ -248,11 +264,12 @@ private:
std::vector<FOOTPRINT*> m_components;
std::vector<ZONE*> m_polygons;
std::vector<PCB_DIM_RADIAL*> m_radialDimensions;
- std::map<wxString, wxString> m_models;
std::map<uint32_t, wxString> m_unicodeStrings;
std::vector<int> m_altiumToKicadNetcodes;
std::map<ALTIUM_LAYER, PCB_LAYER_ID> m_layermap; // used to correctly map copper layers
std::map<ALTIUM_LAYER, wxString> m_layerNames;
+
+ std::map<wxString, ALTIUM_EMBEDDED_MODEL_DATA> m_EmbeddedModels;
std::map<ALTIUM_RULE_KIND, std::vector<ARULE6>> m_rules;
std::map<ALTIUM_RECORD, std::multimap<int, const AEXTENDED_PRIMITIVE_INFORMATION>>
m_extendedPrimitiveInformationMaps;
diff --git a/pcbnew/pcb_io/altium/altium_pcb_compound_file.cpp b/pcbnew/pcb_io/altium/altium_pcb_compound_file.cpp
new file mode 100644
index 0000000000..9d9ad08323
--- /dev/null
+++ b/pcbnew/pcb_io/altium/altium_pcb_compound_file.cpp
@@ -0,0 +1,187 @@
+#include <altium_pcb_compound_file.h>
+#include <utf.h>
+
+#include <wx/string.h>
+
+#include <compoundfilereader.h>
+#include <map>
+
+ALTIUM_PCB_COMPOUND_FILE::ALTIUM_PCB_COMPOUND_FILE( const wxString& aFilePath )
+ : ALTIUM_COMPOUND_FILE( aFilePath )
+{
+}
+
+ALTIUM_PCB_COMPOUND_FILE::ALTIUM_PCB_COMPOUND_FILE( const void* aBuffer, size_t aLen )
+ : ALTIUM_COMPOUND_FILE( aBuffer, aLen )
+{
+}
+
+
+ALTIUM_PCB_COMPOUND_FILE::~ALTIUM_PCB_COMPOUND_FILE()
+{
+}
+
+std::map<wxString, wxString> ALTIUM_PCB_COMPOUND_FILE::ListLibFootprints()
+{
+ if( m_libFootprintDirNameCache.empty() )
+ cacheLibFootprintNames();
+
+ return m_libFootprintDirNameCache;
+}
+
+
+std::tuple<wxString, const CFB::COMPOUND_FILE_ENTRY*>
+ALTIUM_PCB_COMPOUND_FILE::FindLibFootprintDirName( const wxString& aFpUnicodeName )
+{
+ if( m_libFootprintNameCache.empty() )
+ cacheLibFootprintNames();
+
+ auto it = m_libFootprintNameCache.find( aFpUnicodeName );
+
+ if( it == m_libFootprintNameCache.end() )
+ return { wxEmptyString, nullptr };
+
+ return { it->first, it->second };
+}
+
+
+const std::pair<AMODEL, std::vector<char>>* ALTIUM_PCB_COMPOUND_FILE::GetLibModel( const wxString& aModelName ) const
+{
+ auto it = m_libModelsCache.find( aModelName );
+
+ if( it == m_libModelsCache.end() )
+ return nullptr;
+
+ return &it->second;
+}
+
+
+void ALTIUM_PCB_COMPOUND_FILE::cacheLibFootprintNames()
+{
+ m_libFootprintDirNameCache.clear();
+ m_libFootprintNameCache.clear();
+
+ if( !m_reader )
+ return;
+
+ const CFB::COMPOUND_FILE_ENTRY* root = m_reader->GetRootEntry();
+
+ if( !root )
+ return;
+
+ m_reader->EnumFiles( root, 1,
+ [this]( const CFB::COMPOUND_FILE_ENTRY* tentry, const CFB::utf16string& dir, int level ) -> int
+ {
+ if( m_reader->IsStream( tentry ) )
+ return 0;
+
+ m_reader->EnumFiles( tentry, 1,
+ [&]( const CFB::COMPOUND_FILE_ENTRY* entry, const CFB::utf16string&, int ) -> int
+ {
+ std::wstring fileName = UTF16ToWstring( entry->name, entry->nameLen );
+
+ if( m_reader->IsStream( entry ) && fileName == L"Parameters" )
+ {
+ ALTIUM_BINARY_PARSER parametersReader( *this, entry );
+ std::map<wxString, wxString> parameterProperties =
+ parametersReader.ReadProperties();
+
+ wxString key = ALTIUM_PROPS_UTILS::ReadString(
+ parameterProperties, wxT( "PATTERN" ), wxT( "" ) );
+ wxString fpName = ALTIUM_PROPS_UTILS::ReadUnicodeString(
+ parameterProperties, wxT( "PATTERN" ), wxT( "" ) );
+
+ m_libFootprintDirNameCache[key] = fpName;
+ m_libFootprintNameCache[fpName] = tentry;
+ }
+
+ return 0;
+ } );
+ return 0;
+ } );
+}
+
+
+bool ALTIUM_PCB_COMPOUND_FILE::CacheLibModels()
+{
+ const CFB::COMPOUND_FILE_ENTRY* models_root = nullptr;
+ const CFB::COMPOUND_FILE_ENTRY* models_data = nullptr;
+ bool found = false;
+
+ if( !m_reader || !m_libModelsCache.empty() )
+ return false;
+
+ models_data = FindStream( { "Library", "Models", "Data" } );
+
+ if( !models_data )
+ return false;
+
+ ALTIUM_BINARY_PARSER parser( *this, models_data );
+
+ if( parser.GetRemainingBytes() == 0 )
+ return false;
+
+ std::vector<AMODEL> models;
+
+ // First, we parse and extract the model data from the Data stream
+ while( parser.GetRemainingBytes() >= 4 )
+ {
+ AMODEL elem( parser );
+ models.push_back( elem );
+ }
+
+ // Next, we need the model directory entry to read the compressed model streams
+ m_reader->EnumFiles( m_reader->GetRootEntry(), 2, [&]( const CFB::COMPOUND_FILE_ENTRY* entry, const CFB::utf16string& dir, int ) -> int
+ {
+ if( found )
+ return 1;
+
+ if( m_reader->IsStream( entry ) )
+ return 0;
+
+ std::string dir_str = UTF16ToUTF8( dir.c_str() );
+ std::string entry_str = UTF16ToUTF8( entry->name );
+
+ if( dir_str.compare( "Library" ) == 0 && entry_str.compare( "Models" ) == 0 )
+ {
+ models_root = entry;
+ found = true;
+ return 1;
+ }
+
+ return 0;
+ });
+
+ if( !models_root )
+ return false;
+
+ int idx = 0;
+
+ m_reader->EnumFiles( models_root, 1, [&]( const CFB::COMPOUND_FILE_ENTRY* stepEntry, const CFB::utf16string&, int ) -> int
+ {
+ wxString fileName = UTF16ToUTF8( stepEntry->name, stepEntry->nameLen );
+
+ if( !m_reader->IsStream( stepEntry ) || idx >= models.size() )
+ return 0;
+
+ size_t stepSize = static_cast<size_t>( stepEntry->size );
+ std::vector<char> stepContent( stepSize );
+
+ // read file into buffer
+ m_reader->ReadFile( stepEntry, 0, stepContent.data(), stepSize );
+
+ if( stepContent.empty() )
+ return 0;
+
+ // We store the models in their original compressed form so as to speed the caching process
+ // When we parse an individual footprint, we decompress and recompress the model data into
+ // our format
+ m_libModelsCache.emplace( models[idx].id, std::make_pair( std::move( models[idx] ),
+ std::move( stepContent ) ) );
+ idx++;
+
+ return 0;
+ } );
+
+ return true;
+}
\ No newline at end of file
diff --git a/pcbnew/pcb_io/altium/altium_pcb_compound_file.h b/pcbnew/pcb_io/altium/altium_pcb_compound_file.h
new file mode 100644
index 0000000000..e41cfa14fb
--- /dev/null
+++ b/pcbnew/pcb_io/altium/altium_pcb_compound_file.h
@@ -0,0 +1,55 @@
+/*
+ * 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
diff --git a/pcbnew/pcb_io/altium/pcb_io_altium_circuit_maker.cpp b/pcbnew/pcb_io/altium/pcb_io_altium_circuit_maker.cpp
index 5be1bb7b6a..dc9cd55c17 100644
--- a/pcbnew/pcb_io/altium/pcb_io_altium_circuit_maker.cpp
+++ b/pcbnew/pcb_io/altium/pcb_io_altium_circuit_maker.cpp
@@ -32,6 +32,7 @@
#include <pcb_io_altium_circuit_maker.h>
#include <pcb_io_altium_designer.h>
#include <altium_pcb.h>
+#include <altium_pcb_compound_file.h>
#include <io/altium/altium_binary_parser.h>
#include <pcb_io/pcb_io.h>
#include <reporter.h>
@@ -101,7 +102,7 @@ BOARD* PCB_IO_ALTIUM_CIRCUIT_MAKER::LoadBoard( const wxString& aFileName, BOARD*
};
// clang-format on
- ALTIUM_COMPOUND_FILE altiumPcbFile( aFileName );
+ ALTIUM_PCB_COMPOUND_FILE altiumPcbFile( aFileName );
try
{
diff --git a/pcbnew/pcb_io/altium/pcb_io_altium_circuit_studio.cpp b/pcbnew/pcb_io/altium/pcb_io_altium_circuit_studio.cpp
index 45f2855480..80a836e404 100644
--- a/pcbnew/pcb_io/altium/pcb_io_altium_circuit_studio.cpp
+++ b/pcbnew/pcb_io/altium/pcb_io_altium_circuit_studio.cpp
@@ -33,6 +33,7 @@
#include <pcb_io_altium_circuit_studio.h>
#include <pcb_io_altium_designer.h>
#include <altium_pcb.h>
+#include <altium_pcb_compound_file.h>
#include <io/altium/altium_binary_parser.h>
#include <pcb_io/pcb_io.h>
#include <reporter.h>
@@ -102,7 +103,7 @@ BOARD* PCB_IO_ALTIUM_CIRCUIT_STUDIO::LoadBoard( const wxString& aFileName, BOARD
};
// clang-format on
- ALTIUM_COMPOUND_FILE altiumPcbFile( aFileName );
+ ALTIUM_PCB_COMPOUND_FILE altiumPcbFile( aFileName );
try
{
diff --git a/pcbnew/pcb_io/altium/pcb_io_altium_designer.cpp b/pcbnew/pcb_io/altium/pcb_io_altium_designer.cpp
index f387c24942..d1ef5fdea4 100644
--- a/pcbnew/pcb_io/altium/pcb_io_altium_designer.cpp
+++ b/pcbnew/pcb_io/altium/pcb_io_altium_designer.cpp
@@ -31,6 +31,7 @@
#include <font/fontconfig.h>
#include <pcb_io_altium_designer.h>
#include <altium_pcb.h>
+#include <altium_pcb_compound_file.h>
#include <io/io_utils.h>
#include <io/altium/altium_binary_parser.h>
#include <pcb_io/pcb_io.h>
@@ -135,7 +136,7 @@ BOARD* PCB_IO_ALTIUM_DESIGNER::LoadBoard( const wxString& aFileName, BOARD* aApp
};
// clang-format on
- ALTIUM_COMPOUND_FILE altiumPcbFile( aFileName );
+ ALTIUM_PCB_COMPOUND_FILE altiumPcbFile( aFileName );
try
{
@@ -187,18 +188,24 @@ void PCB_IO_ALTIUM_DESIGNER::loadAltiumLibrary( const wxString& aLibraryPath )
if( aLibraryPath.Lower().EndsWith( wxS( ".pcblib" ) ) )
{
m_fplibFiles[aLibraryPath].emplace_back(
- std::make_unique<ALTIUM_COMPOUND_FILE>( aLibraryPath ) );
+ std::make_unique<ALTIUM_PCB_COMPOUND_FILE>( aLibraryPath ) );
}
else if( aLibraryPath.Lower().EndsWith( wxS( ".intlib" ) ) )
{
- std::unique_ptr<ALTIUM_COMPOUND_FILE> intCom =
- std::make_unique<ALTIUM_COMPOUND_FILE>( aLibraryPath );
+ std::unique_ptr<ALTIUM_PCB_COMPOUND_FILE> intCom =
+ std::make_unique<ALTIUM_PCB_COMPOUND_FILE>( aLibraryPath );
std::map<wxString, const CFB::COMPOUND_FILE_ENTRY*> pcbLibFiles =
intCom->EnumDir( L"PCBLib" );
-
for( const auto& [pcbLibName, pcbCfe] : pcbLibFiles )
- m_fplibFiles[aLibraryPath].push_back( intCom->DecodeIntLibStream( *pcbCfe ) );
+ {
+ auto decodedStream = intCom->DecodeIntLibStream( *pcbCfe );
+ m_fplibFiles[aLibraryPath].push_back(
+ std::unique_ptr<ALTIUM_PCB_COMPOUND_FILE>(
+ static_cast<ALTIUM_PCB_COMPOUND_FILE*>(decodedStream.release())
+ )
+ );
+ }
}
}
catch( CFB::CFBException& exception )
@@ -296,8 +303,9 @@ FOOTPRINT* PCB_IO_ALTIUM_DESIGNER::FootprintLoad( const wxString& aLibraryPath,
try
{
- for( std::unique_ptr<ALTIUM_COMPOUND_FILE>& altiumLibFile : it->second )
+ for( std::unique_ptr<ALTIUM_PCB_COMPOUND_FILE>& altiumLibFile : it->second )
{
+ altiumLibFile->CacheLibModels();
auto [dirName, fpCfe] = altiumLibFile->FindLibFootprintDirName( aFootprintName );
if( dirName.IsEmpty() )
diff --git a/pcbnew/pcb_io/altium/pcb_io_altium_designer.h b/pcbnew/pcb_io/altium/pcb_io_altium_designer.h
index e9f6a049bc..c51897750a 100644
--- a/pcbnew/pcb_io/altium/pcb_io_altium_designer.h
+++ b/pcbnew/pcb_io/altium/pcb_io_altium_designer.h
@@ -32,7 +32,7 @@
#include <map>
#include <memory>
-class ALTIUM_COMPOUND_FILE;
+class ALTIUM_PCB_COMPOUND_FILE;
class PCB_IO_ALTIUM_DESIGNER : public PCB_IO, public LAYER_MAPPABLE_PLUGIN
{
@@ -85,7 +85,8 @@ public:
const std::vector<INPUT_LAYER_DESC>& aInputLayerDescriptionVector );
private:
- std::map<wxString, std::vector<std::unique_ptr<ALTIUM_COMPOUND_FILE>>> m_fplibFiles;
+ std::map<wxString, std::vector<std::unique_ptr<ALTIUM_PCB_COMPOUND_FILE>>> m_fplibFiles;
+
void loadAltiumLibrary( const wxString& aLibraryPath );
};
diff --git a/pcbnew/pcb_io/altium/pcb_io_solidworks.cpp b/pcbnew/pcb_io/altium/pcb_io_solidworks.cpp
index 129521ed95..d473ceab21 100644
--- a/pcbnew/pcb_io/altium/pcb_io_solidworks.cpp
+++ b/pcbnew/pcb_io/altium/pcb_io_solidworks.cpp
@@ -23,6 +23,7 @@
#include <pcb_io_solidworks.h>
#include <pcb_io_altium_designer.h>
#include <altium_pcb.h>
+#include <altium_pcb_compound_file.h>
#include <io/altium/altium_binary_parser.h>
#include <pcb_io/pcb_io.h>
#include <reporter.h>
@@ -121,7 +122,7 @@ BOARD* PCB_IO_SOLIDWORKS::LoadBoard( const wxString& aFileName, BOARD* aAppendTo
};
// clang-format on
- ALTIUM_COMPOUND_FILE altiumPcbFile( aFileName );
+ ALTIUM_PCB_COMPOUND_FILE altiumPcbFile( aFileName );
try
{
diff --git a/pcbnew/pcb_io/kicad_sexpr/pcb_io_kicad_sexpr.cpp b/pcbnew/pcb_io/kicad_sexpr/pcb_io_kicad_sexpr.cpp
index ed13c61302..0dc58e8cd4 100644
--- a/pcbnew/pcb_io/kicad_sexpr/pcb_io_kicad_sexpr.cpp
+++ b/pcbnew/pcb_io/kicad_sexpr/pcb_io_kicad_sexpr.cpp
@@ -112,6 +112,14 @@ void FP_CACHE::Save( FOOTPRINT* aFootprint )
if( aFootprint && aFootprint != it->second->GetFootprint() )
continue;
+ // If we've requested to embed the fonts in the footprint, do so.
+ // Otherwise, clear the embedded fonts from the footprint. Embedded
+ // fonts will be used if available
+ if( aFootprint->GetAreFontsEmbedded() )
+ aFootprint->EmbedFonts();
+ else
+ aFootprint->GetEmbeddedFiles()->ClearEmbeddedFonts();
+
WX_FILENAME fn = it->second->GetFileName();
wxString tempFileName =
@@ -321,6 +329,13 @@ void PCB_IO_KICAD_SEXPR::SaveBoard( const wxString& aFileName, BOARD* aBoard,
m_board = aBoard; // after init()
+ // If the user wants fonts embedded, make sure that they are added to the board. Otherwise,
+ // remove any fonts that were previously embedded.
+ if( m_board->GetAreFontsEmbedded() )
+ m_board->EmbedFonts();
+ else
+ m_board->GetEmbeddedFiles()->ClearEmbeddedFonts();
+
// Prepare net mapping that assures that net codes saved in a file are consecutive integers
m_mapping->SetBoard( aBoard );
@@ -860,6 +875,31 @@ void PCB_IO_KICAD_SEXPR::format( const BOARD* aBoard, int aNestLevel ) const
// Save the generators
for( BOARD_ITEM* gen : sorted_generators )
Format( gen, aNestLevel );
+
+ // Save any embedded files
+ // Consolidate the embedded models in footprints into a single map
+ // to avoid duplicating the same model in the board file.
+ EMBEDDED_FILES files_to_write;
+
+ for( auto& file : aBoard->GetEmbeddedFiles()->EmbeddedFileMap() )
+ files_to_write.AddFile( file.second );
+
+ for( BOARD_ITEM* item : sorted_footprints )
+ {
+ FOOTPRINT* fp = static_cast<FOOTPRINT*>( item );
+
+ for( auto& file : fp->GetEmbeddedFiles()->EmbeddedFileMap() )
+ files_to_write.AddFile( file.second );
+ }
+
+ m_out->Print( aNestLevel + 1, "(embedded_fonts %s)\n",
+ aBoard->GetEmbeddedFiles()->GetAreFontsEmbedded() ? "yes" : "no" );
+
+ if( !files_to_write.IsEmpty() )
+ files_to_write.WriteEmbeddedFiles( *m_out, aNestLevel + 1, ( m_ctl & CTL_FOR_BOARD ) );
+
+ // Remove the files so that they are not freed in the DTOR
+ files_to_write.ClearEmbeddedFiles( false );
}
@@ -1341,6 +1381,14 @@ void PCB_IO_KICAD_SEXPR::format( const FOOTPRINT* aFootprint, int aNestLevel ) c
for( BOARD_ITEM* group : sorted_groups )
Format( group, aNestLevel + 1 );
+ m_out->Print( aNestLevel + 1, "(embedded_fonts %s)\n",
+ aFootprint->GetEmbeddedFiles()->GetAreFontsEmbedded() ? "yes" : "no" );
+
+ if( !aFootprint->GetEmbeddedFiles()->IsEmpty() )
+ {
+ aFootprint->WriteEmbeddedFiles( *m_out, aNestLevel + 1, !( m_ctl & CTL_FOR_BOARD ) );
+ }
+
// Save 3D info.
auto bs3D = aFootprint->Models().begin();
auto es3D = aFootprint->Models().end();
diff --git a/pcbnew/pcb_io/kicad_sexpr/pcb_io_kicad_sexpr.h b/pcbnew/pcb_io/kicad_sexpr/pcb_io_kicad_sexpr.h
index dbde711094..089b306de4 100644
--- a/pcbnew/pcb_io/kicad_sexpr/pcb_io_kicad_sexpr.h
+++ b/pcbnew/pcb_io/kicad_sexpr/pcb_io_kicad_sexpr.h
@@ -158,7 +158,8 @@ class PCB_IO_KICAD_SEXPR; // forward decl
//#define SEXPR_BOARD_FILE_VERSION 20240225 // Rationalization of solder_paste_margin
//#define SEXPR_BOARD_FILE_VERSION 20240609 // Add 'tenting' keyword
//#define SEXPR_BOARD_FILE_VERSION 20240617 // Table angles
-#define SEXPR_BOARD_FILE_VERSION 20240703 // User layer types
+//#define SEXPR_BOARD_FILE_VERSION 20240703 // User layer types
+#define SEXPR_BOARD_FILE_VERSION 20240706 // Embedded Files
#define BOARD_FILE_HOST_VERSION 20200825 ///< Earlier files than this include the host tag
#define LEGACY_ARC_FORMATTING 20210925 ///< These were the last to use old arc formatting
diff --git a/pcbnew/pcb_io/kicad_sexpr/pcb_io_kicad_sexpr_parser.cpp b/pcbnew/pcb_io/kicad_sexpr/pcb_io_kicad_sexpr_parser.cpp
index 8835147b1f..8b2614eae3 100644
--- a/pcbnew/pcb_io/kicad_sexpr/pcb_io_kicad_sexpr_parser.cpp
+++ b/pcbnew/pcb_io/kicad_sexpr/pcb_io_kicad_sexpr_parser.cpp
@@ -37,6 +37,8 @@
#include <board.h>
#include <board_design_settings.h>
+#include <embedded_files.h>
+#include <font/fontconfig.h>
#include <pcb_dimension.h>
#include <pcb_shape.h>
#include <pcb_reference_image.h>
@@ -72,6 +74,7 @@
// base64 code. Needed for PCB_REFERENCE_IMAGE
#define wxUSE_BASE64 1
#include <wx/base64.h>
+#include <wx/log.h>
#include <wx/mstream.h>
// We currently represent board units as integers. Any values that are
@@ -580,8 +583,7 @@ void PCB_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT( EDA_TEXT* aText )
if( !faceName.IsEmpty() )
{
- aText->SetFont( KIFONT::FONT::GetFont( faceName, aText->IsBold(),
- aText->IsItalic() ) );
+ m_fontTextMap[aText] = { faceName, aText->IsBold(), aText->IsItalic() };
}
break;
@@ -865,6 +867,17 @@ BOARD_ITEM* PCB_IO_KICAD_SEXPR_PARSER::Parse()
THROW_PARSE_ERROR( err, CurSource(), CurLine(), CurLineNumber(), CurOffset() );
}
+ // Assign the fonts after we have parsed any potential embedded fonts from the board
+ // or footprint. This also ensures that the embedded fonts are cached
+ for( auto& [text, params] : m_fontTextMap )
+ {
+ const std::vector<wxString>* embeddedFonts = item->GetEmbeddedFiles()->UpdateFontFiles();
+
+ text->SetFont( KIFONT::FONT::GetFont( std::get<0>( params ), std::get<1>( params ),
+ std::get<2>( params ),
+ embeddedFonts ) );
+ }
+
resolveGroups( item );
return item;
@@ -1073,6 +1086,31 @@ BOARD* PCB_IO_KICAD_SEXPR_PARSER::parseBOARD_unchecked()
bulkAddedItems.push_back( item );
break;
+ case T_embedded_fonts:
+ {
+ m_board->GetEmbeddedFiles()->SetAreFontsEmbedded( parseBool() );
+ NeedRIGHT();
+ break;
+ }
+
+ case T_embedded_files:
+ {
+ EMBEDDED_FILES_PARSER embeddedFilesParser( reader );
+ embeddedFilesParser.SyncLineReaderWith( *this );
+
+ try
+ {
+ embeddedFilesParser.ParseEmbedded( m_board->GetEmbeddedFiles() );
+ }
+ catch( const PARSE_ERROR& e )
+ {
+ wxLogError( e.What() );
+ }
+
+ SyncLineReaderWith( embeddedFilesParser );
+ break;
+ }
+
default:
wxString err;
err.Printf( _( "Unknown token '%s'" ), FromUTF8() );
@@ -1184,6 +1222,9 @@ BOARD* PCB_IO_KICAD_SEXPR_PARSER::parseBOARD_unchecked()
}
}
+ // Ensure all footprints have their embedded data from the board
+ m_board->FixupEmbeddedData();
+
return m_board;
}
@@ -4675,13 +4716,38 @@ FOOTPRINT* PCB_IO_KICAD_SEXPR_PARSER::parseFOOTPRINT_unchecked( wxArrayString* a
parseGROUP( footprint.get() );
break;
+ case T_embedded_fonts:
+ {
+ footprint->GetEmbeddedFiles()->SetAreFontsEmbedded( parseBool() );
+ NeedRIGHT();
+ break;
+ }
+
+ case T_embedded_files:
+ {
+ EMBEDDED_FILES_PARSER embeddedFilesParser( reader );
+ embeddedFilesParser.SyncLineReaderWith( *this );
+
+ try
+ {
+ embeddedFilesParser.ParseEmbedded( footprint->GetEmbeddedFiles() );
+ }
+ catch( const PARSE_ERROR& e )
+ {
+ wxLogError( e.What() );
+ }
+
+ SyncLineReaderWith( embeddedFilesParser );
+ break;
+ }
+
default:
- Expecting( "locked, placed, tedit, tstamp, uuid, at, descr, tags, path, "
- "autoplace_cost90, autoplace_cost180, solder_mask_margin, "
- "solder_paste_margin, solder_paste_margin_ratio, clearance, "
- "zone_connect, thermal_gap, attr, fp_text, "
- "fp_arc, fp_circle, fp_curve, fp_line, fp_poly, fp_rect, pad, "
- "zone, group, generator, version or model" );
+ Expecting( "at, descr, locked, placed, tedit, tstamp, uuid, "
+ "autoplace_cost90, autoplace_cost180, attr, clearance, "
+ "embedded_files, fp_arc, fp_circle, fp_curve, fp_line, fp_poly, "
+ "fp_rect, fp_text, pad, group, generator, model, path, solder_mask_margin, "
+ "solder_paste_margin, solder_paste_margin_ratio, tags, thermal_gap, "
+ "version, zone, or zone_connect" );
}
}
diff --git a/pcbnew/pcb_io/kicad_sexpr/pcb_io_kicad_sexpr_parser.h b/pcbnew/pcb_io/kicad_sexpr/pcb_io_kicad_sexpr_parser.h
index 63ea7984bc..b4ad365397 100644
--- a/pcbnew/pcb_io/kicad_sexpr/pcb_io_kicad_sexpr_parser.h
+++ b/pcbnew/pcb_io/kicad_sexpr/pcb_io_kicad_sexpr_parser.h
@@ -406,6 +406,8 @@ private:
TIME_PT m_lastProgressTime; ///< for progress reporting
unsigned m_lineCount; ///< for progress reporting
+ std::map<EDA_TEXT*, std::tuple<wxString, bool, bool>> m_fontTextMap;
+
std::vector<GROUP_INFO> m_groupInfos;
std::vector<GENERATOR_INFO> m_generatorInfos;
diff --git a/pcbnew/pcbnew_config.cpp b/pcbnew/pcbnew_config.cpp
index b2b3e0af70..8507d7b937 100644
--- a/pcbnew/pcbnew_config.cpp
+++ b/pcbnew/pcbnew_config.cpp
@@ -29,8 +29,10 @@
#include <tools/pcb_selection_tool.h>
#include <board_design_settings.h>
#include <drawing_sheet/ds_data_model.h>
+#include <filename_resolver.h>
#include <pcbplot.h>
#include <pcb_painter.h>
+#include <pgm_base.h>
#include <project.h>
#include <widgets/appearance_controls.h>
#include <widgets/panel_selection_filter.h>
@@ -39,6 +41,27 @@
#include <project/project_local_settings.h>
+void PCB_EDIT_FRAME::LoadDrawingSheet()
+{
+ PROJECT_FILE& project = Prj().GetProjectFile();
+
+ // Load the drawing sheet from the filename stored in the project
+ // If empty, or not existing, the default drawing sheet is loaded.
+ FILENAME_RESOLVER resolver;
+ resolver.SetProject( &Prj() );
+ resolver.SetProgramBase( &Pgm() );
+
+ wxString filename = resolver.ResolvePath( project.m_BoardDrawingSheetFile,
+ Prj().GetProjectPath(),
+ GetBoard()->GetEmbeddedFiles() );
+
+ wxString msg;
+
+ if( !DS_DATA_MODEL::GetTheInstance().LoadDrawingSheet( filename, &msg ) )
+ ShowInfoBarError( msg, true );
+
+}
+
bool PCB_EDIT_FRAME::LoadProjectSettings()
{
PROJECT_FILE& project = Prj().GetProjectFile();
@@ -46,14 +69,6 @@ bool PCB_EDIT_FRAME::LoadProjectSettings()
BASE_SCREEN::m_DrawingSheetFileName = project.m_BoardDrawingSheetFile;
- // Load the drawing sheet from the filename stored in BASE_SCREEN::m_DrawingSheetFileName.
- // If empty, or not existing, the default drawing sheet is loaded.
- wxString filename = DS_DATA_MODEL::ResolvePath( BASE_SCREEN::m_DrawingSheetFileName,
- Prj().GetProjectPath());
-
- if( !DS_DATA_MODEL::GetTheInstance().LoadDrawingSheet( filename, nullptr ) )
- ShowInfoBarError( _( "Error loading drawing sheet." ), true );
-
// Load render settings that aren't stored in PCB_DISPLAY_OPTIONS
std::shared_ptr<NET_SETTINGS>& netSettings = project.NetSettings();
diff --git a/pcbnew/pcbnew_jobs_handler.cpp b/pcbnew/pcbnew_jobs_handler.cpp
index 39861f77f2..c6fd922b04 100644
--- a/pcbnew/pcbnew_jobs_handler.cpp
+++ b/pcbnew/pcbnew_jobs_handler.cpp
@@ -48,6 +48,7 @@
#include <plotters/plotters_pslike.h>
#include <tool/tool_manager.h>
#include <tools/drc_tool.h>
+#include <filename_resolver.h>
#include <gerber_jobfile_writer.h>
#include "gerber_placefile_writer.h"
#include <gendrill_Excellon_writer.h>
@@ -1552,8 +1553,13 @@ void PCBNEW_JOBS_HANDLER::loadOverrideDrawingSheet( BOARD* aBrd, const wxString&
[&]( const wxString& path ) -> bool
{
BASE_SCREEN::m_DrawingSheetFileName = path;
- wxString filename = DS_DATA_MODEL::ResolvePath( BASE_SCREEN::m_DrawingSheetFileName,
- aBrd->GetProject()->GetProjectPath() );
+ FILENAME_RESOLVER resolver;
+ resolver.SetProject( aBrd->GetProject() );
+ resolver.SetProgramBase( &Pgm() );
+
+ wxString filename = resolver.ResolvePath( BASE_SCREEN::m_DrawingSheetFileName,
+ aBrd->GetProject()->GetProjectPath(),
+ aBrd->GetEmbeddedFiles() );
wxString msg;
if( !DS_DATA_MODEL::GetTheInstance().LoadDrawingSheet( filename, &msg ) )
diff --git a/pcbnew/python/scripting/pcbnew_scripting_helpers.cpp b/pcbnew/python/scripting/pcbnew_scripting_helpers.cpp
index ab337e5694..2485706660 100644
--- a/pcbnew/python/scripting/pcbnew_scripting_helpers.cpp
+++ b/pcbnew/python/scripting/pcbnew_scripting_helpers.cpp
@@ -44,8 +44,10 @@
#include <core/ignore.h>
#include <pcb_io/pcb_io_mgr.h>
#include <string_utils.h>
+#include <filename_resolver.h>
#include <macros.h>
#include <pcbnew_scripting_helpers.h>
+#include <pgm_base.h>
#include <project.h>
#include <project_pcb.h>
#include <project/net_settings.h>
@@ -179,18 +181,28 @@ BOARD* LoadBoard( wxString& aFileName, PCB_IO_MGR::PCB_FILE_T aFormat, bool aSet
BASE_SCREEN::m_DrawingSheetFileName = project->GetProjectFile().m_BoardDrawingSheetFile;
- // Load the drawing sheet from the filename stored in BASE_SCREEN::m_DrawingSheetFileName.
- // If empty, or not existing, the default drawing sheet is loaded.
- wxString filename = DS_DATA_MODEL::ResolvePath( BASE_SCREEN::m_DrawingSheetFileName,
- project->GetProjectPath() );
-
- if( !DS_DATA_MODEL::GetTheInstance().LoadDrawingSheet( filename, nullptr ) )
- wxFprintf( stderr, _( "Error loading drawing sheet." ) );
-
BOARD* brd = PCB_IO_MGR::Load( aFormat, aFileName );
if( brd )
{
+ // Load the drawing sheet from the filename stored in BASE_SCREEN::m_DrawingSheetFileName.
+ // If empty, or not existing, the default drawing sheet is loaded.
+ FILENAME_RESOLVER resolver;
+ resolver.SetProject( project );
+ resolver.SetProgramBase( &Pgm() );
+
+ wxString filename = resolver.ResolvePath( BASE_SCREEN::m_DrawingSheetFileName,
+ project->GetProjectPath(),
+ brd->GetEmbeddedFiles() );
+
+ wxString msg;
+
+ if( !DS_DATA_MODEL::GetTheInstance().LoadDrawingSheet( filename, &msg ) )
+ {
+ wxFprintf( stderr, _( "Error loading drawing sheet '%s': %s" ),
+ BASE_SCREEN::m_DrawingSheetFileName, msg );
+ }
+
// JEY TODO: move this global to the board
ENUM_MAP<PCB_LAYER_ID>& layerEnum = ENUM_MAP<PCB_LAYER_ID>::Instance();
diff --git a/pcbnew/tools/board_editor_control.cpp b/pcbnew/tools/board_editor_control.cpp
index 8d9aec7489..7da38de694 100644
--- a/pcbnew/tools/board_editor_control.cpp
+++ b/pcbnew/tools/board_editor_control.cpp
@@ -298,8 +298,8 @@ int BOARD_EDITOR_CONTROL::PageSettings( const TOOL_EVENT& aEvent )
undoCmd.SetDescription( _( "Page Settings" ) );
m_frame->SaveCopyInUndoList( undoCmd, UNDO_REDO::PAGESETTINGS );
- DIALOG_PAGES_SETTINGS dlg( m_frame, pcbIUScale.IU_PER_MILS, VECTOR2I( MAX_PAGE_SIZE_PCBNEW_MILS,
- MAX_PAGE_SIZE_PCBNEW_MILS ) );
+ DIALOG_PAGES_SETTINGS dlg( m_frame, m_frame->GetBoard()->GetEmbeddedFiles(), pcbIUScale.IU_PER_MILS,
+ VECTOR2I( MAX_PAGE_SIZE_PCBNEW_MILS, MAX_PAGE_SIZE_PCBNEW_MILS ) );
dlg.SetWksFileName( BASE_SCREEN::m_DrawingSheetFileName );
if( dlg.ShowModal() == wxID_OK )
diff --git a/pcbnew/widgets/pcb_properties_panel.cpp b/pcbnew/widgets/pcb_properties_panel.cpp
index 2c374c159b..c716cef98c 100644
--- a/pcbnew/widgets/pcb_properties_panel.cpp
+++ b/pcbnew/widgets/pcb_properties_panel.cpp
@@ -275,7 +275,8 @@ void PCB_PROPERTIES_PANEL::updateLists( const BOARD* aBoard )
// Regnerate font names
std::vector<std::string> fontNames;
- Fontconfig()->ListFonts( fontNames, std::string( Pgm().GetLanguageTag().utf8_str() ) );
+ Fontconfig()->ListFonts( fontNames, std::string( Pgm().GetLanguageTag().utf8_str() ),
+ aBoard->GetFontFiles() );
fonts.Add( KICAD_FONT_NAME, -1 );
diff --git a/qa/tests/common/CMakeLists.txt b/qa/tests/common/CMakeLists.txt
index b7a6da566c..e41699e68c 100644
--- a/qa/tests/common/CMakeLists.txt
+++ b/qa/tests/common/CMakeLists.txt
@@ -36,6 +36,7 @@ set( QA_COMMON_SRCS
test_coroutine.cpp
test_eda_shape.cpp
test_eda_text.cpp
+ test_embedded_file_compress.cpp
test_lib_table.cpp
test_markup_parser.cpp
test_kicad_string.cpp
diff --git a/qa/tests/common/test_embedded_file_compress.cpp b/qa/tests/common/test_embedded_file_compress.cpp
new file mode 100644
index 0000000000..56a1731bb1
--- /dev/null
+++ b/qa/tests/common/test_embedded_file_compress.cpp
@@ -0,0 +1,129 @@
+/*
+ * This program source code file is part of KiCad, a free EDA CAD application.
+ *
+ * Copyright (C) 1992-2021 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/>.
+ */
+
+#include <magic_enum.hpp>
+#include <boost/test/unit_test.hpp>
+#include <picosha2.h>
+#include <embedded_files.h>
+
+#include <random>
+using magic_enum::iostream_operators::operator<<;
+
+BOOST_AUTO_TEST_SUITE( EmbeddedFiles )
+
+BOOST_AUTO_TEST_CASE( CompressAndEncode_OK )
+{
+ EMBEDDED_FILES::EMBEDDED_FILE file;
+ file.name = "test_file";
+ std::string data = "Hello, World!";
+ file.decompressedData.assign(data.begin(), data.end());
+
+ picosha2::hash256_hex_string(file.decompressedData, file.data_sha);
+
+ EMBEDDED_FILES::RETURN_CODE result = EMBEDDED_FILES::CompressAndEncode(file);
+ BOOST_CHECK_EQUAL(result, EMBEDDED_FILES::RETURN_CODE::OK);
+}
+
+BOOST_AUTO_TEST_CASE( DecompressAndDecode_OK )
+{
+ EMBEDDED_FILES::EMBEDDED_FILE file;
+ file.name = "test_file";
+ std::string data = "Hello, World!";
+ file.decompressedData.assign( data.begin(), data.end() );
+
+ picosha2::hash256_hex_string( file.decompressedData, file.data_sha );
+
+ EMBEDDED_FILES::RETURN_CODE result = EMBEDDED_FILES::CompressAndEncode( file );
+ BOOST_CHECK_EQUAL( result, EMBEDDED_FILES::RETURN_CODE::OK );
+
+ result = EMBEDDED_FILES::DecompressAndDecode( file );
+ BOOST_CHECK_EQUAL( result, EMBEDDED_FILES::RETURN_CODE::OK );
+
+ // Create a large test data
+ data.clear();
+ data.reserve( 13 * 100000 + 1 );
+
+ for( int i = 0; i < 100000; ++i )
+ data += "Hello, World!";
+
+ file.decompressedData.assign( data.begin(), data.end() );
+
+ picosha2::hash256_hex_string( file.decompressedData, file.data_sha );
+
+ result = EMBEDDED_FILES::CompressAndEncode( file );
+ BOOST_CHECK_EQUAL( result, EMBEDDED_FILES::RETURN_CODE::OK );
+
+ result = EMBEDDED_FILES::DecompressAndDecode( file );
+ BOOST_CHECK_EQUAL( result, EMBEDDED_FILES::RETURN_CODE::OK );
+
+ // Create a sequential test dataset
+ data.clear();
+ data.reserve( 100000 );
+
+ for( int i = 0; i < 100000; ++i )
+ data += static_cast<char>( i % 256 );
+
+ file.decompressedData.assign( data.begin(), data.end() );
+ picosha2::hash256_hex_string( file.decompressedData, file.data_sha );
+
+ result = EMBEDDED_FILES::CompressAndEncode( file );
+ BOOST_CHECK_EQUAL( result, EMBEDDED_FILES::RETURN_CODE::OK );
+
+ result = EMBEDDED_FILES::DecompressAndDecode( file );
+ BOOST_CHECK_EQUAL( result, EMBEDDED_FILES::RETURN_CODE::OK );
+
+ // Create a random test dataset with a known seed
+ data.clear();
+ data.reserve( 100000 );
+
+ std::mt19937 rng;
+ rng.seed( 0 );
+
+ for( int i = 0; i < 100000; ++i )
+ data += static_cast<char>( rng() % 256 );
+
+ file.decompressedData.assign( data.begin(), data.end() );
+ picosha2::hash256_hex_string( file.decompressedData, file.data_sha );
+
+ result = EMBEDDED_FILES::CompressAndEncode( file );
+ BOOST_CHECK_EQUAL( result, EMBEDDED_FILES::RETURN_CODE::OK );
+
+ result = EMBEDDED_FILES::DecompressAndDecode( file );
+ BOOST_CHECK_EQUAL( result, EMBEDDED_FILES::RETURN_CODE::OK );
+
+}
+
+BOOST_AUTO_TEST_CASE( DecompressAndDecode_ChecksumError )
+{
+ EMBEDDED_FILES::EMBEDDED_FILE file;
+ file.name = "test_file";
+ std::string data = "Hello, World!";
+ file.decompressedData.assign(data.begin(), data.end());
+
+ EMBEDDED_FILES::RETURN_CODE result = EMBEDDED_FILES::CompressAndEncode(file);
+ BOOST_CHECK_EQUAL(result, EMBEDDED_FILES::RETURN_CODE::OK);
+
+ // Modify the checksum
+ file.data_sha[0] = 'x';
+
+ result = EMBEDDED_FILES::DecompressAndDecode(file);
+ BOOST_CHECK_EQUAL(result, EMBEDDED_FILES::RETURN_CODE::CHECKSUM_ERROR);
+}
+
+BOOST_AUTO_TEST_SUITE_END()