gestfich.h File Reference

#include <wx/filename.h>
#include <wx/process.h>

Go to the source code of this file.

Macros
#define	UNIX_STRING_DIR_SEP   wxT( "/" )
#define	WIN_STRING_DIR_SEP   wxT( "\\" )

Functions
bool	OpenPDF (const wxString &file)
	Run the PDF viewer and display a PDF file. More...
void	OpenFile (const wxString &file)
void	KiCopyFile (const wxString &aSrcPath, const wxString &aDestPath, wxString &aErrors)
int	ExecuteFile (const wxString &aEditorName, const wxString &aFileName=wxEmptyString, wxProcess *aCallback=nullptr)
	Call the executable file aEditorName with the parameter aFileName. More...
void	QuoteString (wxString &string)
	Add un " to the start and the end of string (if not already done). More...
wxString	FindKicadFile (const wxString &shortname)
	Search the executable file shortname in KiCad binary path and return full file name if found or shortname if the kicad binary path is kicad/bin. More...
wxString	QuoteFullPath (wxFileName &fn, wxPathFormat format=wxPATH_NATIVE)
	Quote return value of wxFileName::GetFullPath(). More...

Macro Definition Documentation

UNIX_STRING_DIR_SEP

#define UNIX_STRING_DIR_SEP   wxT( "/" )

Note

Do we really need these defined?

Definition at line 35 of file gestfich.h.

WIN_STRING_DIR_SEP

#define WIN_STRING_DIR_SEP   wxT( "\\" )

Definition at line 36 of file gestfich.h.

Function Documentation

ExecuteFile()

int ExecuteFile	(	const wxString &	aEditorName,
		const wxString &	aFileName = wxEmptyString,
		wxProcess *	aCallback = nullptr
	)

Call the executable file aEditorName with the parameter aFileName.

Definition at line 115 of file gestfich.cpp.

{
 wxString fullEditorName;
 wxString param;

#ifdef __UNIX__
 int space = aEditorName.Find( ' ' );

 if( space > 0 && !aEditorName.Contains( "\"" ) && !aEditorName.Contains( "\'" ) )
 {
 fullEditorName = FindKicadFile( aEditorName.Mid( 0, space ) );
 param = aEditorName.Mid( space + 1 );
 }
 else
#endif
 {
 fullEditorName = FindKicadFile( aEditorName );
 }

 if( wxFileExists( fullEditorName ) )
 {
 int i = 0;
 const wchar_t* args[4];

 args[i++] = fullEditorName.wc_str();

 if( !param.IsEmpty() )
 args[i++] = param.wc_str();

 if( !aFileName.IsEmpty() )
 args[i++] = aFileName.wc_str();

 args[i] = nullptr;

 return wxExecute( const_cast<wchar_t**>( args ), wxEXEC_ASYNC, aCallback );
 }

 wxString msg;
 msg.Printf( _( "Command '%s' could not be found." ), fullEditorName );
 DisplayError( nullptr, msg, 20 );
 return -1;
}

References _, DisplayError(), and FindKicadFile().

Referenced by KICAD_MANAGER_CONTROL::Execute(), DIALOG_CONFIG_EQUFILES::OnEditEquFile(), DIALOG_BOM::OnEditGenerator(), SCH_EDIT_FRAME::OnOpenPcbnew(), PROJECT_TREE_PANE::onOpenSelectedFileWithTextEditor(), PCB_EDIT_FRAME::RunEeschema(), and GERBVIEW_INSPECTION_TOOL::ShowSource().

FindKicadFile()

wxString FindKicadFile

(

const wxString &

shortname

)

Search the executable file shortname in KiCad binary path and return full file name if found or shortname if the kicad binary path is kicad/bin.

The binary path is found from:

• binary path.
• KICAD environment variable.
• c:\kicad or /usr/local/kicad (the default).
• default binary path.

Definition at line 52 of file gestfich.cpp.

{
 // Test the presence of the file in the directory shortname of
 // the KiCad binary path.
#ifndef __WXMAC__
 wxString fullFileName = Pgm().GetExecutablePath() + shortname;
#else
 wxString fullFileName = Pgm().GetExecutablePath() + wxT( "Contents/MacOS/" ) + shortname;
#endif
 if( wxFileExists( fullFileName ) )
 return fullFileName;

 // Test the presence of the file in the directory shortname
 // defined by the environment variable KiCad.
 if( Pgm().IsKicadEnvVariableDefined() )
 {
 fullFileName = Pgm().GetKicadEnvVariable() + shortname;

 if( wxFileExists( fullFileName ) )
 return fullFileName;
 }

#if defined( __WINDOWS__ )
 // kicad can be installed highly portably on Windows, anywhere and concurrently
 // either the "kicad file" is immediately adjacent to the exe or it's not a valid install
 return shortname;
#endif

 // Path list for KiCad binary files
 const static wxChar* possibilities[] = {
#if defined( __WXMAC__ )
 // all internal paths are relative to main bundle kicad.app
 wxT( "Contents/Applications/pcbnew.app/Contents/MacOS/" ),
 wxT( "Contents/Applications/eeschema.app/Contents/MacOS/" ),
 wxT( "Contents/Applications/gerbview.app/Contents/MacOS/" ),
 wxT( "Contents/Applications/bitmap2component.app/Contents/MacOS/" ),
 wxT( "Contents/Applications/pcb_calculator.app/Contents/MacOS/" ),
 wxT( "Contents/Applications/pl_editor.app/Contents/MacOS/" ),
#else
 wxT( "/usr/bin/" ),
 wxT( "/usr/local/bin/" ),
 wxT( "/usr/local/kicad/bin/" ),
#endif
 };

 // find binary file from possibilities list:
 for( unsigned i=0; i<arrayDim(possibilities); ++i )
 {
#ifndef __WXMAC__
 fullFileName = possibilities[i] + shortname;
#else
 // make relative paths absolute
 fullFileName = Pgm().GetExecutablePath() + possibilities[i] + shortname;
#endif

 if( wxFileExists( fullFileName ) )
 return fullFileName;
 }

 return shortname;
}

References arrayDim(), and Pgm().

Referenced by ExecuteFile().

KiCopyFile()

void KiCopyFile	(	const wxString &	aSrcPath,
		const wxString &	aDestPath,
		wxString &	aErrors
	)

Parameters

aSrcPath	is the full filename of the source.
aDestPath	is the full filename of the target
aErrors	a wxString to append any errors to

Definition at line 214 of file gestfich.cpp.

{
 if( !wxCopyFile( aSrcPath, aDestPath ) )
 {
 wxString msg;

 if( !aErrors.IsEmpty() )
 aErrors += "\n";

 msg.Printf( _( "Cannot copy file '%s'." ), aDestPath );
 aErrors += msg;
 }
}

References _.

Referenced by CreateWindow(), IfaceOrAddress(), SAVE_AS_TRAVERSER::OnFile(), MIGRATION_TRAVERSER::OnFile(), SCH::IFACE::SaveFileAs(), PCB_EDIT_FRAME::SavePcbCopy(), and PCB_EDIT_FRAME::SavePcbFile().

OpenFile()

void OpenFile

(

const wxString &

file

)

Definition at line 195 of file gestfich.cpp.

{
 wxFileName fileName( file );
 wxFileType* filetype = wxTheMimeTypesManager->GetFileTypeFromExtension( fileName.GetExt() );

 if( !filetype )
 return;

 wxString command;
 wxFileType::MessageParameters params( file );

 filetype->GetOpenCommand( &command, params );
 delete filetype;

 if( !command.IsEmpty() )
 wxExecute( command );
}

Referenced by PROJECT_TREE_ITEM::Activate().

OpenPDF()

bool OpenPDF

(

const wxString &

file

)

Run the PDF viewer and display a PDF file.

Parameters

file	the PDF file to open.

Returns

true is success or false if no PDF viewer found.

Definition at line 159 of file gestfich.cpp.

{
 wxString msg;
 wxString filename = file;

 Pgm().ReadPdfBrowserInfos();

 if( Pgm().UseSystemPdfBrowser() )
 {
 if( !LaunchExternal( filename ) )
 {
 msg.Printf( _( "Unable to find a PDF viewer for '%s'." ), filename );
 DisplayError( nullptr, msg );
 return false;
 }
 }
 else
 {
 const wchar_t* args[3];

 args[0] = Pgm().GetPdfBrowserName().wc_str();
 args[1] = filename.wc_str();
 args[2] = nullptr;

 if( wxExecute( const_cast<wchar_t**>( args ) ) == -1 )
 {
 msg.Printf( _( "Problem while running the PDF viewer '%s'." ), args[0] );
 DisplayError( nullptr, msg );
 return false;
 }
 }

 return true;
}

References _, DisplayError(), LaunchExternal(), and Pgm().

Referenced by PROJECT_TREE_ITEM::Activate(), and GetAssociatedDocument().

QuoteFullPath()

wxString QuoteFullPath	(	wxFileName &	fn,
		wxPathFormat	format = wxPATH_NATIVE
	)

Quote return value of wxFileName::GetFullPath().

This allows file name paths with spaces to be used as parameters to ProcessExecute function calls.

Parameters

fn	is the filename to wrap.
format	if provided, can be used to transform the nature of the wrapped filename to another platform.

Definition at line 229 of file gestfich.cpp.

{
 return wxT( "\"" ) + fn.GetFullPath( format ) + wxT( "\"" );
}

QuoteString()

void QuoteString

(

wxString &

string

)

Add un " to the start and the end of string (if not already done).

Parameters

string

string to modify.

Definition at line 42 of file gestfich.cpp.

{
 if( !string.StartsWith( wxT( "\"" ) ) )
 {
 string.Prepend ( wxT( "\"" ) );
 string.Append ( wxT( "\"" ) );
 }
}