PROJECT_TEMPLATE Class Reference

A class which provides project template functionality. More...

#include <project_template.h>

Public Member Functions
	PROJECT_TEMPLATE (const wxString &aPath)
	Create a new project instance from aPath. More...
	~PROJECT_TEMPLATE ()
	Non-virtual destructor (so no derived classes) More...
wxString	GetPrjDirName ()
	Get the dir name of the project template (i.e. More...
wxFileName	GetHtmlFile ()
	Get the full Html filename for the project template. More...
bool	CreateProject (wxFileName &aNewProjectPath, wxString *aErrorMsg=nullptr)
	Copies and renames all template files to create a new project. More...
wxBitmap *	GetIcon ()
	Get the 64px^2 icon for the project template. More...
wxString *	GetTitle ()
	Get the title of the project (extracted from the html title tag) More...
std::vector< wxFileName >	GetFileList ()
	Get a vector list of filenames for the template. More...
size_t	GetDestinationFiles (const wxFileName &aNewProjectPath, std::vector< wxFileName > &aDestFiles)
	Fetch the list of destination files to be copied when the new project is created. More...

Protected Attributes
wxFileName	m_basePath
wxFileName	m_metaPath
wxFileName	m_metaHtmlFile
wxFileName	m_metaIconFile
wxBitmap *	m_metaIcon
wxString	m_title

Detailed Description

A class which provides project template functionality.

Definition at line 143 of file project_template.h.

Constructor & Destructor Documentation

PROJECT_TEMPLATE()

PROJECT_TEMPLATE::PROJECT_TEMPLATE

(

const wxString &

aPath

)

Create a new project instance from aPath.

aPath should be a directory that conforms to the project template requirements

Parameters

aPath

Should be a directory containing the template

Definition at line 39 of file project_template.cpp.

{
 m_basePath = wxFileName::DirName( aPath );
 m_metaPath = wxFileName::DirName( aPath + SEP + METADIR );
 m_metaHtmlFile = wxFileName::FileName( aPath + SEP + METADIR + SEP + METAFILE_INFO_HTML );
 m_metaIconFile = wxFileName::FileName( aPath + SEP + METADIR + SEP + METAFILE_ICON );
 
 m_title = wxEmptyString;
 
 // Test the project template requirements to make sure aPath is a valid template structure.
 if( !wxFileName::DirExists( m_basePath.GetPath() ) )
 {
 // Error, the path doesn't exist!
 m_title = _( "Could open the template path!" ) + wxS( " " ) + aPath;
 }
 else if( !wxFileName::DirExists( m_metaPath.GetPath() ) )
 {
 // Error, the meta information directory doesn't exist!
 m_title = _( "Couldn't open the meta information directory for this template!" ) + wxS( " " ) +
 m_metaPath.GetPath();
 }
 else if( !wxFileName::FileExists( m_metaHtmlFile.GetFullPath() ) )
 {
 // Error, the meta information directory doesn't contain the informational html file!
 m_title = _( "Couldn't find the meta HTML information file for this template!" );
 }
 
 // Try to load an icon
 if( !wxFileName::FileExists( m_metaIconFile.GetFullPath() ) )
 m_metaIcon = &wxNullBitmap;
 else
 m_metaIcon = new wxBitmap( m_metaIconFile.GetFullPath(), wxBITMAP_TYPE_PNG );
}

References _, m_basePath, m_metaHtmlFile, m_metaIcon, m_metaIconFile, m_metaPath, m_title, METADIR, METAFILE_ICON, METAFILE_INFO_HTML, and SEP.

~PROJECT_TEMPLATE()

PROJECT_TEMPLATE::~PROJECT_TEMPLATE

(

)

Non-virtual destructor (so no derived classes)

Definition at line 121 of file project_template.cpp.

{
 
}

Member Function Documentation

CreateProject()

bool PROJECT_TEMPLATE::CreateProject	(	wxFileName &	aNewProjectPath,
		wxString *	aErrorMsg = nullptr
	)

Copies and renames all template files to create a new project.

Parameters

aNewProjectPath	The full path of the new project file to create
aErrorMsg	is an optional string to place project creation error messages.

Returns

true if the project creation was successful otherwise false.

Definition at line 184 of file project_template.cpp.

{
 // CreateProject copy the files from template to the new project folder and renames files
 // which have the same name as the template .kicad_pro file
 bool result = true;
 
 std::vector<wxFileName> srcFiles = GetFileList();
 
 // Find the template file name base. this is the name of the .kicad_pro (or .pro) template
 // file
 wxString basename;
 bool multipleProjectFilesFound = false;
 
 for( wxFileName& file : srcFiles )
 {
 if( file.GetExt() == ProjectFileExtension || file.GetExt() == LegacyProjectFileExtension )
 {
 if( !basename.IsEmpty() && basename != file.GetName() )
 multipleProjectFilesFound = true;
 
 basename = file.GetName();
 }
 }
 
 if( multipleProjectFilesFound )
 basename = GetPrjDirName();
 
 for( wxFileName& srcFile : srcFiles )
 {
 // Replace the template path
 wxFileName destFile = srcFile;
 
 // Replace the template filename with the project filename for the new project creation
 wxString currname = destFile.GetName();
 
 if( destFile.GetExt() == DrawingSheetFileExtension )
 {
 // Don't rename drawing sheet definitions; they're often shared
 }
 else if( destFile.GetName().EndsWith( "-cache" )
 || destFile.GetName().EndsWith( "-rescue" ) )
 {
 currname.Replace( basename, aNewProjectPath.GetName() );
 }
 else if( destFile.GetExt() == "dcm"
 || destFile.GetExt() == "lib"
 // Footprint libraries are directories not files, so GetExt() won't work
 || destFile.GetPath().EndsWith( ".pretty" ) )
 {
 // Don't rename project-specific libraries. This will break the library tables and
 // cause broken links in the schematic/pcb.
 }
 else
 {
 currname.Replace( basename, aNewProjectPath.GetName() );
 }
 
 destFile.SetName( currname );
 
 // Replace the template path with the project path for the new project creation
 // but keep the sub directory name, if exists
 wxString destpath = destFile.GetPathWithSep();
 destpath.Replace( m_basePath.GetPathWithSep(), aNewProjectPath.GetPathWithSep() );
 
 // Check to see if the path already exists, if not attempt to create it here.
 if( !wxFileName::DirExists( destpath ) )
 {
 if( !wxFileName::Mkdir( destpath, 0777, wxPATH_MKDIR_FULL ) )
 {
 if( aErrorMsg )
 {
 if( !aErrorMsg->empty() )
 *aErrorMsg += "\n";
 
 wxString msg;
 
 msg.Printf( _( "Cannot create folder '%s'." ), destpath );
 *aErrorMsg += msg;
 }
 
 continue;
 }
 }
 
 destFile.SetPath( destpath );
 
 if( srcFile.FileExists() && !wxCopyFile( srcFile.GetFullPath(), destFile.GetFullPath() ) )
 {
 if( aErrorMsg )
 {
 if( !aErrorMsg->empty() )
 *aErrorMsg += "\n";
 
 wxString msg;
 
 msg.Printf( _( "Cannot copy file '%s'." ), destFile.GetFullPath() );
 *aErrorMsg += msg;
 }
 
 result = false;
 }
 }
 
 return result;
}

References _, DrawingSheetFileExtension, GetFileList(), GetPrjDirName(), LegacyProjectFileExtension, m_basePath, and ProjectFileExtension.

Referenced by KICAD_MANAGER_CONTROL::NewFromTemplate().

GetDestinationFiles()

size_t PROJECT_TEMPLATE::GetDestinationFiles	(	const wxFileName &	aNewProjectPath,
		std::vector< wxFileName > &	aDestFiles
	)

Fetch the list of destination files to be copied when the new project is created.

Parameters

aNewProjectPath	is the path to the project to be created.
aDestFiles	is a container to place the list of destination files to be created.

Returns

the number of destination files added to the container.

Definition at line 139 of file project_template.cpp.

{
 std::vector< wxFileName > srcFiles = GetFileList();
 
 // Find the template file name base. this is the name of the .pro template file
 wxString basename;
 bool multipleProjectFilesFound = false;
 
 for( wxFileName& file : srcFiles )
 {
 if( file.GetExt() == ProjectFileExtension || file.GetExt() == LegacyProjectFileExtension )
 {
 if( !basename.IsEmpty() && basename != file.GetName() )
 multipleProjectFilesFound = true;
 
 basename = file.GetName();
 }
 }
 
 if( multipleProjectFilesFound )
 basename = GetPrjDirName();
 
 for( wxFileName& srcFile : srcFiles )
 {
 // Replace the template path
 wxFileName destFile = srcFile;
 
 // Replace the template filename with the project filename for the new project creation
 wxString name = destFile.GetName();
 name.Replace( basename, aNewProjectPath.GetName() );
 destFile.SetName( name );
 
 // Replace the template path with the project path.
 wxString path = destFile.GetPathWithSep();
 path.Replace( m_basePath.GetPathWithSep(), aNewProjectPath.GetPathWithSep() );
 destFile.SetPath( path );
 
 aDestFiles.push_back( destFile );
 }
 
 return aDestFiles.size();
}

References GetFileList(), GetPrjDirName(), LegacyProjectFileExtension, m_basePath, name, path, and ProjectFileExtension.

Referenced by KICAD_MANAGER_CONTROL::NewFromTemplate().

GetFileList()

std::vector< wxFileName > PROJECT_TEMPLATE::GetFileList

(

)

Get a vector list of filenames for the template.

The files are the source files, and have not yet been through any renaming

Definition at line 104 of file project_template.cpp.

{
 std::vector<wxFileName> files;
 FILE_TRAVERSER sink( files, m_metaPath.GetPath() );
 wxDir dir( m_basePath.GetPath() );
 
 dir.Traverse( sink );
 return files;
}

References m_basePath, and m_metaPath.

Referenced by CreateProject(), and GetDestinationFiles().

GetHtmlFile()

wxFileName PROJECT_TEMPLATE::GetHtmlFile

(

)

Get the full Html filename for the project template.

Returns

the html meta information file for this template

Definition at line 127 of file project_template.cpp.

{
 return m_metaHtmlFile;
}

References m_metaHtmlFile.

Referenced by GetTitle(), and DIALOG_TEMPLATE_SELECTOR::SetWidget().

GetIcon()

wxBitmap * PROJECT_TEMPLATE::GetIcon

(

)

Get the 64px^2 icon for the project template.

Returns

an image file of 64px x 64px which is the templates icon

Definition at line 133 of file project_template.cpp.

{
 return m_metaIcon;
}

References m_metaIcon.

Referenced by TEMPLATE_WIDGET::SetTemplate().

GetPrjDirName()

wxString PROJECT_TEMPLATE::GetPrjDirName

(

)

Get the dir name of the project template (i.e.

the name of the last folder containing the template files)

Returns

the dir name of the template

Definition at line 115 of file project_template.cpp.

{
 return m_basePath.GetDirs()[ m_basePath.GetDirCount() - 1 ];
}

References m_basePath.

Referenced by CreateProject(), and GetDestinationFiles().

GetTitle()

wxString * PROJECT_TEMPLATE::GetTitle

(

)

Get the title of the project (extracted from the html title tag)

Definition at line 291 of file project_template.cpp.

{
 wxFFileInputStream input( GetHtmlFile().GetFullPath() );
 wxString separator( wxT( "\x9" ) );
 wxTextInputStream text( input, separator, wxConvUTF8 );
 
 /* Open HTML file and get the text between the title tags */
 if( m_title == wxEmptyString )
 {
 int start = 0;
 int finish = 0;
 bool done = false;
 
 while( input.IsOk() && !input.Eof() && !done )
 {
 wxString line = text.ReadLine();
 wxString upperline = line.Clone().Upper();
 
 start = upperline.Find( wxT( "<TITLE>" ) );
 finish = upperline.Find( wxT( "</TITLE>" ) );
 int length = finish - start - 7;
 
 // find the opening tag
 if( start != wxNOT_FOUND )
 {
 if( finish != wxNOT_FOUND )
 {
 m_title = line( start + 7, length );
 }
 else
 {
 m_title = line.Mid( start + 7 );
 }
 
 done = true;
 }
 else
 {
 if( finish != wxNOT_FOUND )
 {
 m_title += line.SubString( 0, finish );
 done = true;
 }
 }
 
 // Remove line endings
 m_title.Replace( wxT( "\r" ), wxT( " " ) );
 m_title.Replace( wxT( "\n" ), wxT( " " ) );
 }
 }
 
 return &m_title;
}

References GetHtmlFile(), m_title, and text.

Referenced by TEMPLATE_WIDGET::SetTemplate().

Member Data Documentation

m_basePath

wxFileName PROJECT_TEMPLATE::m_basePath

protected

Definition at line 146 of file project_template.h.

Referenced by CreateProject(), GetDestinationFiles(), GetFileList(), GetPrjDirName(), and PROJECT_TEMPLATE().

m_metaHtmlFile

wxFileName PROJECT_TEMPLATE::m_metaHtmlFile

protected

Definition at line 148 of file project_template.h.

Referenced by GetHtmlFile(), and PROJECT_TEMPLATE().

m_metaIcon

wxBitmap* PROJECT_TEMPLATE::m_metaIcon

protected

Definition at line 150 of file project_template.h.

Referenced by GetIcon(), and PROJECT_TEMPLATE().

m_metaIconFile

wxFileName PROJECT_TEMPLATE::m_metaIconFile

protected

Definition at line 149 of file project_template.h.

Referenced by PROJECT_TEMPLATE().

m_metaPath

wxFileName PROJECT_TEMPLATE::m_metaPath

protected

Definition at line 147 of file project_template.h.

Referenced by GetFileList(), and PROJECT_TEMPLATE().

m_title

wxString PROJECT_TEMPLATE::m_title

protected

Definition at line 151 of file project_template.h.

Referenced by GetTitle(), and PROJECT_TEMPLATE().

---

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

• project_template.h
• project_template.cpp