A helper class to import non Kicad project. More...

#include <import_proj.h>

Public Member Functions
	IMPORT_PROJ_HELPER (KICAD_MANAGER_FRAME *aframe, const wxString &aFile, const wxString &aSchFileExtension, const wxString &aPcbFileExtension)

const wxFileName &	GetProj ()

wxString	GetProjPath ()

void	SetProjPath (const wxString aPath)

wxString	GetProjFullPath ()

wxString	GetProjName ()

void	CreateEmptyDirForProject ()
	Appends a new directory with the name of the project file Keep iterating until an empty directory is found. More...

void	SetProjAbsolutePath ()

bool	CopyImportedFiles (bool displayError=true)
	Copies project files to the destination directory. More...

void	AssociateFilesWithProj (int aImportedSchFileType, int aImportedPcbFileType)
	Converts imported files to kicad type files. More...

Private Member Functions
bool	CopyImportedFile (KICAD_T aKicad_T, bool displayError=true)

void	OutputCopyError (const wxFileName &aSrc, const wxFileName &aFileCopy)

void	AssociateFileWithProj (KICAD_T aKicad_T, int aImportedFileType)

Private Attributes
KICAD_MANAGER_FRAME *	m_frame

wxFileName	m_sch

wxFileName	m_shCopy

wxFileName	m_pcb

wxFileName	m_pcbCopy

wxFileName	m_pro

Detailed Description

A helper class to import non Kicad project.

Definition at line 11 of file import_proj.h.

Constructor & Destructor Documentation

◆ IMPORT_PROJ_HELPER()

IMPORT_PROJ_HELPER::IMPORT_PROJ_HELPER	(	KICAD_MANAGER_FRAME *	aframe,
		const wxString &	aFile,
		const wxString &	aSchFileExtension,
		const wxString &	aPcbFileExtension
	)

Definition at line 31 of file import_proj.cpp.

 :
 m_frame( aFrame ),
 m_sch( aFile ), m_pcb( m_sch ), m_pro( m_sch )
{
 m_sch.SetExt( aSchFileExtension );
 m_pcb.SetExt( aPcbFileExtension );
 m_pro.SetExt( ProjectFileExtension );
}

References m_pcb, m_pro, m_sch, and ProjectFileExtension.

Member Function Documentation

◆ AssociateFilesWithProj()

void IMPORT_PROJ_HELPER::AssociateFilesWithProj	(	int	aImportedSchFileType,
		int	aImportedPcbFileType
	)

Converts imported files to kicad type files.

Types of imported files are needed for conversion

Parameters

aImportedSchFileType	type of the imported schematic
aImportedPcbFileType	type of the imported PCB

Definition at line 202 of file import_proj.cpp.

{
 AssociateFileWithProj( SCHEMATIC_T, aImportedSchFileType );
 AssociateFileWithProj( PCB_T, aImportedPcbFileType );
}

References AssociateFileWithProj(), PCB_T, and SCHEMATIC_T.

Referenced by KICAD_MANAGER_CONTROL::ImportNonKicadProj(), and KICAD_MANAGER_FRAME::ImportNonKiCadProject().

◆ AssociateFileWithProj()

void IMPORT_PROJ_HELPER::AssociateFileWithProj	(	KICAD_T	aKicad_T,
		int	aImportedFileType
	)

private

Definition at line 158 of file import_proj.cpp.

{
 wxFileName fileCopy, importedFile;
 FRAME_T frame_type;
 switch( aFT )
 {
 case SCHEMATIC_T:
 importedFile = m_sch;
 fileCopy = m_shCopy;
 frame_type = FRAME_SCH;
 break;
 
 case PCB_T:
 importedFile = m_pcb;
 fileCopy = m_pcbCopy;
 frame_type = FRAME_PCB_EDITOR;
 break;
 
 default: return;
 }
 
 if( fileCopy.FileExists() )
 {
 KIWAY_PLAYER* frame = m_frame->Kiway().Player( frame_type, true );
 
 std::string packet =
 StrPrintf( "%d\n%s", aImportedFileType, TO_UTF8( fileCopy.GetFullPath() ) );
 frame->Kiway().ExpressMail( frame_type, MAIL_IMPORT_FILE, packet, m_frame );
 
 if( !frame->IsShown() )
 frame->Show( true );
 
 // On Windows, Raise() does not bring the window on screen, when iconized
 if( frame->IsIconized() )
 frame->Iconize( false );
 
 frame->Raise();
 
 if( !fileCopy.SameAs( importedFile ) ) // Do not delete the original file!
 wxRemoveFile( fileCopy.GetFullPath() );
 }
}

References KIWAY::ExpressMail(), FRAME_PCB_EDITOR, FRAME_SCH, KIWAY_HOLDER::Kiway(), m_frame, m_pcb, m_pcbCopy, m_sch, m_shCopy, MAIL_IMPORT_FILE, PCB_T, KIWAY::Player(), SCHEMATIC_T, StrPrintf(), and TO_UTF8.

Referenced by AssociateFilesWithProj().

◆ CopyImportedFile()

bool IMPORT_PROJ_HELPER::CopyImportedFile	(	KICAD_T	aKicad_T,
		bool	displayError = `true`
	)

private

Definition at line 100 of file import_proj.cpp.

{
 wxASSERT( m_pro.GetExt() == ProjectFileExtension );
 
 wxFileName fileCopy( m_pro );
 
 wxFileName src, dest;
 switch( aFT )
 {
 case SCHEMATIC_T: src = m_sch; break;
 
 case PCB_T: src = m_pcb; break;
 
 default: break;
 }
 
 fileCopy.SetExt( src.GetExt() );
 
 if( src.Exists() && !fileCopy.SameAs( src ) )
 {
 if( !wxCopyFile( src.GetFullPath(), fileCopy.GetFullPath(), true ) )
 {
 if( displayError )
 OutputCopyError( src, fileCopy );
 return false;
 }
 }
 
 switch( aFT )
 {
 case SCHEMATIC_T: m_shCopy = fileCopy; break;
 
 case PCB_T: m_pcbCopy = fileCopy; break;
 
 default: break;
 }
 
 return true;
}

References m_pcb, m_pcbCopy, m_pro, m_sch, m_shCopy, OutputCopyError(), PCB_T, ProjectFileExtension, and SCHEMATIC_T.

Referenced by CopyImportedFiles().

◆ CopyImportedFiles()

bool IMPORT_PROJ_HELPER::CopyImportedFiles ( bool displayError = true )

Copies project files to the destination directory.

Parameters

displayError calls OutputCopyError() if true

Definition at line 140 of file import_proj.cpp.

{
 return CopyImportedFile( SCHEMATIC_T, displayError ) && CopyImportedFile( PCB_T, displayError );
}

References CopyImportedFile(), PCB_T, and SCHEMATIC_T.

Referenced by KICAD_MANAGER_CONTROL::ImportNonKicadProj(), and KICAD_MANAGER_FRAME::ImportNonKiCadProject().

◆ CreateEmptyDirForProject()

void IMPORT_PROJ_HELPER::CreateEmptyDirForProject ( )

Appends a new directory with the name of the project file Keep iterating until an empty directory is found.

Definition at line 74 of file import_proj.cpp.

{
 // Append a new directory with the same name of the project file
 // Keep iterating until we find an empty directory
 wxString newDir = m_pro.GetName();
 int attempt = 0;
 
 m_pro.AppendDir( newDir );
 
 while( m_pro.DirExists() )
 {
 m_pro.RemoveLastDir();
 wxString suffix = wxString::Format( "_%d", ++attempt );
 m_pro.AppendDir( newDir + suffix );
 }
}

References Format(), and m_pro.

Referenced by KICAD_MANAGER_CONTROL::ImportNonKicadProj(), and KICAD_MANAGER_FRAME::ImportNonKiCadProject().

◆ GetProj()

const wxFileName & IMPORT_PROJ_HELPER::GetProj ( )

Definition at line 44 of file import_proj.cpp.

{
 return m_pro;
}

References m_pro.

Referenced by KICAD_MANAGER_CONTROL::ImportNonKicadProj(), and KICAD_MANAGER_FRAME::ImportNonKiCadProject().

◆ GetProjFullPath()

wxString IMPORT_PROJ_HELPER::GetProjFullPath ( )

Definition at line 62 of file import_proj.cpp.

{
 return m_pro.GetFullPath();
}

References m_pro.

Referenced by KICAD_MANAGER_CONTROL::ImportNonKicadProj(), and KICAD_MANAGER_FRAME::ImportNonKiCadProject().

◆ GetProjName()

wxString IMPORT_PROJ_HELPER::GetProjName ( )

Definition at line 68 of file import_proj.cpp.

{
 return m_pro.GetName();
}

References m_pro.

◆ GetProjPath()

wxString IMPORT_PROJ_HELPER::GetProjPath ( )

Definition at line 50 of file import_proj.cpp.

{
 return m_pro.GetPath();
}

References m_pro.

Referenced by KICAD_MANAGER_CONTROL::ImportNonKicadProj(), and KICAD_MANAGER_FRAME::ImportNonKiCadProject().

◆ OutputCopyError()

void IMPORT_PROJ_HELPER::OutputCopyError	(	const wxFileName &	aSrc,
		const wxFileName &	aFileCopy
	)

private

Definition at line 145 of file import_proj.cpp.

{
 wxString msg;
 msg.Printf( _( "Cannot copy file '%s'\n"
 "to '%s'\n"
 "The project cannot be imported." ),
 aSrc.GetFullPath(), aFileCopy.GetFullPath() );
 
 wxMessageDialog fileCopyErrorDlg( m_frame, msg, _( "Error" ), wxOK_DEFAULT | wxICON_ERROR );
 fileCopyErrorDlg.ShowModal();
}

References _, and m_frame.

Referenced by CopyImportedFile().

◆ SetProjAbsolutePath()

void IMPORT_PROJ_HELPER::SetProjAbsolutePath ( )

Definition at line 92 of file import_proj.cpp.

{
 m_pro.SetExt( ProjectFileExtension );
 if( !m_pro.IsAbsolute() )
 m_pro.MakeAbsolute();
}

References m_pro, and ProjectFileExtension.

Referenced by KICAD_MANAGER_CONTROL::ImportNonKicadProj(), and KICAD_MANAGER_FRAME::ImportNonKiCadProject().

◆ SetProjPath()

void IMPORT_PROJ_HELPER::SetProjPath ( const wxString aPath )

Definition at line 56 of file import_proj.cpp.

{
 m_pro.SetPath( aPath );
}

References m_pro.

Referenced by KICAD_MANAGER_FRAME::ImportNonKiCadProject().

Member Data Documentation

◆ m_frame

KICAD_MANAGER_FRAME* IMPORT_PROJ_HELPER::m_frame

private

Definition at line 45 of file import_proj.h.

Referenced by AssociateFileWithProj(), and OutputCopyError().

◆ m_pcb

wxFileName IMPORT_PROJ_HELPER::m_pcb

private

Definition at line 48 of file import_proj.h.

Referenced by AssociateFileWithProj(), CopyImportedFile(), and IMPORT_PROJ_HELPER().

◆ m_pcbCopy

wxFileName IMPORT_PROJ_HELPER::m_pcbCopy

private

Definition at line 49 of file import_proj.h.

Referenced by AssociateFileWithProj(), and CopyImportedFile().

◆ m_pro

wxFileName IMPORT_PROJ_HELPER::m_pro

private

Definition at line 50 of file import_proj.h.

Referenced by CopyImportedFile(), CreateEmptyDirForProject(), GetProj(), GetProjFullPath(), GetProjName(), GetProjPath(), IMPORT_PROJ_HELPER(), SetProjAbsolutePath(), and SetProjPath().

◆ m_sch

wxFileName IMPORT_PROJ_HELPER::m_sch

private

Definition at line 46 of file import_proj.h.

Referenced by AssociateFileWithProj(), CopyImportedFile(), and IMPORT_PROJ_HELPER().

◆ m_shCopy

wxFileName IMPORT_PROJ_HELPER::m_shCopy

private

Definition at line 47 of file import_proj.h.

Referenced by AssociateFileWithProj(), and CopyImportedFile().

The documentation for this class was generated from the following files:

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ IMPORT_PROJ_HELPER()

Member Function Documentation

◆ AssociateFilesWithProj()

◆ AssociateFileWithProj()

◆ CopyImportedFile()

◆ CopyImportedFiles()

◆ CreateEmptyDirForProject()

◆ GetProj()

◆ GetProjFullPath()

◆ GetProjName()

◆ GetProjPath()

◆ OutputCopyError()

◆ SetProjAbsolutePath()

◆ SetProjPath()

Member Data Documentation

◆ m_frame

◆ m_pcb

◆ m_pcbCopy

◆ m_pro

◆ m_sch

◆ m_shCopy