gestfich.h File Reference

This file is part of the common library TODO brief description. More...

#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	PrintFile (const wxString &file)
bool	CanPrintFile (const wxString &file)
void	KiCopyFile (const wxString &aSrcPath, const wxString &aDestPath, wxString &aErrors)
wxString	EDA_FILE_SELECTOR (const wxString &aTitle, const wxString &aPath, const wxString &aFileName, const wxString &aExtension, const wxString &aWildcard, wxWindow *aParent, int aStyle, const bool aKeepWorkingDirectory, const wxPoint &aPosition=wxDefaultPosition, wxString *aMruPath=nullptr)
	A helper function that wraps a call to wxFileSelector. More...
int	ExecuteFile (wxWindow *frame, const wxString &ExecFile, const wxString &param=wxEmptyString, wxProcess *callback=nullptr)
	Call the executable file ExecFile with the command line parameters param. More...
void	AddDelimiterString (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...

Detailed Description

This file is part of the common library TODO brief description.

See also

common.h

Definition in file gestfich.h.

Macro Definition Documentation

UNIX_STRING_DIR_SEP

#define UNIX_STRING_DIR_SEP   wxT( "/" )

Note

Do we really need these defined?

Definition at line 43 of file gestfich.h.

WIN_STRING_DIR_SEP

#define WIN_STRING_DIR_SEP   wxT( "\\" )

Definition at line 44 of file gestfich.h.

Function Documentation

AddDelimiterString()

void AddDelimiterString

(

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( "\"" ) );
    }
}

Referenced by KICAD_MANAGER_CONTROL::Execute(), ExecuteFile(), LaunchExternal(), DIALOG_BOM::OnEditGenerator(), PROJECT_TREE_PANE::onOpenDirectory(), PROJECT_TREE_PANE::onOpenSelectedFileWithTextEditor(), and PCB_EDIT_FRAME::PythonPluginsShowFolder().

CanPrintFile()

bool CanPrintFile

(

const wxString &

file

)

Definition at line 357 of file gestfich.cpp.

{
    return doPrintFile( file, true );
}

References doPrintFile().

Referenced by PROJECT_TREE_PANE::onRight().

EDA_FILE_SELECTOR()

wxString EDA_FILE_SELECTOR	(	const wxString &	aTitle,
		const wxString &	aPath,
		const wxString &	aFileName,
		const wxString &	aExtension,
		const wxString &	aWildcard,
		wxWindow *	aParent,
		int	aStyle,
		const bool	aKeepWorkingDirectory,
		const wxPoint &	aPosition = wxDefaultPosition,
		wxString *	aMruPath = nullptr
	)

A helper function that wraps a call to wxFileSelector.

Parameters

aTitle	is a string to display in the dialog title bar.
aPath	is a string contain the default path for the path dialog.
aFileName	is a string containing the default file name.
aExtension	is a string containing the default file extension.
aWildcard	is a string containing the default wildcard.
aParent	is the parent window of the dialog.
aStyle	is the style of the path dialog, wxFD_???.
aKeepWorkingDirectory	determines if current working directory should be set to the user selected path.
aPosition	is the position of the dialog.
aMruPath	is a pointer to a string to copy the path selected by the user when the OK button is pressed to dismiss the dialog. This can be NULL.

Returns

the full path and file name of the selected file or wxEmptyString if the user pressed the cancel button to dismiss the dialog.

Definition at line 52 of file gestfich.cpp.

{
    wxString fullfilename;
    wxString curr_cwd    = wxGetCwd();
    wxString defaultname = aFileName;
    wxString defaultpath = aPath;
    wxString dotted_Ext = wxT(".") + aExtension;

#ifdef __WINDOWS__
    defaultname.Replace( wxT( "/" ), wxT( "\\" ) );
    defaultpath.Replace( wxT( "/" ), wxT( "\\" ) );
#endif

    if( defaultpath.IsEmpty() )
    {
        if( aMruPath == NULL )
            defaultpath = wxGetCwd();
        else
            defaultpath = *aMruPath;
    }

    wxSetWorkingDirectory( defaultpath );

    fullfilename = wxFileSelector( aTitle, defaultpath, defaultname,
                                   dotted_Ext, aWildcard,
                                   aStyle,         // open mode wxFD_OPEN, wxFD_SAVE ..
                                   aParent, aPosition.x, aPosition.y );

    if( aKeepWorkingDirectory )
        wxSetWorkingDirectory( curr_cwd );

    if( !fullfilename.IsEmpty() && aMruPath )
    {
        wxFileName fn = fullfilename;
        *aMruPath = fn.GetPath();
    }

    return fullfilename;
}

References NULL.

Referenced by PGM_BASE::AskUserForPreferredEditor(), DIALOG_BOM::chooseGenerator(), PANEL_HOTKEYS_EDITOR::dumpHotkeys(), BOARD_EDITOR_CONTROL::ExportSpecctraDSN(), SYMBOL_EDITOR_CONTROL::ExportSymbolAsSVG(), GetAssociatedDocument(), PANEL_HOTKEYS_EDITOR::ImportHotKeys(), BOARD_EDITOR_CONTROL::ImportSpecctraSession(), NETLIST_DIALOG_ADD_GENERATOR::OnBrowseGenerators(), and MWAVE_POLYGONAL_SHAPE_DLG::ReadDataShapeDescr().

ExecuteFile()

int ExecuteFile	(	wxWindow *	frame,
		const wxString &	ExecFile,
		const wxString &	param = wxEmptyString,
		wxProcess *	callback = nullptr
	)

Call the executable file ExecFile with the command line parameters param.

Definition at line 165 of file gestfich.cpp.

{
    wxString fullFileName = FindKicadFile( ExecFile );

    if( wxFileExists( fullFileName ) )
    {
        if( !param.IsEmpty() )
            fullFileName += wxT( " " ) + param;

        return ProcessExecute( fullFileName, wxEXEC_ASYNC, callback );
    }
#ifdef __WXMAC__
    else
    {
        AddDelimiterString( fullFileName );

        if( !param.IsEmpty() )
            fullFileName += wxT( " " ) + param;

        return ProcessExecute( wxT( "/usr/bin/open -a " ) + fullFileName, wxEXEC_ASYNC, callback );
    }
#endif

    wxString msg;
    msg.Printf( _( "Command \"%s\" could not found" ), fullFileName );
    DisplayError( frame, msg, 20 );
    return -1;
}

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

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 102 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 363 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(), and SCH::IFACE::SaveFileAs().

OpenFile()

void OpenFile

(

const wxString &

file

)

Definition at line 257 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() )
        ProcessExecute( command );
}

References ProcessExecute().

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 196 of file gestfich.cpp.

{
    wxString command;
    wxString filename = file;

    Pgm().ReadPdfBrowserInfos();

    if( !Pgm().UseSystemPdfBrowser() )    //  Run the preferred PDF Browser
    {
#ifdef __WXMSW__
        // Windows requires double quotes around the filename to handle spaces
        command = Pgm().GetPdfBrowserName() + wxT( " \"" ) + filename + wxT( "\"" );
#else
        command = Pgm().GetPdfBrowserName() + wxT( " '" ) + filename + wxT( "'" );
#endif
    }
    else
    {
        // wxLaunchDefaultApplication on Unix systems is run as an external process passing
        // the filename to the appropriate application as a command argument.  Spaces in the
        // path and/or file name will cause argument parsing issues so always quote the file
        // name and path.  This is applicable to all Unix platforms.
        // See https://github.com/wxWidgets/wxWidgets/blob/master/src/unix/utilsx11.cpp#L2654
#ifdef __WXGTK__
        filename = wxT( "\"" ) + filename + wxT( "\"" );
#endif

        if( wxLaunchDefaultApplication( filename ) )
            return true;

#ifdef __WXMAC__
        command = wxT( "/usr/bin/open -a '" ) + file + wxT( "'" );
#endif
        // If launching the system default PDF viewer fails, fall through with empty command
        // string so the error message is displayed.
    }

    if( !command.IsEmpty() )
    {
        if( ProcessExecute( command ) != -1 )
        {
            return true;
        }
        else
        {
            wxString msg;
            msg.Printf( _( "Problem while running the PDF viewer\nCommand is \"%s\"" ), command );
            DisplayError( NULL, msg );
        }
    }
    else
    {
        wxString msg;
        msg.Printf( _( "Unable to find a PDF viewer for \"%s\"" ), file );
        DisplayError( NULL, msg );
    }

    return false;
}

References _, DisplayError(), NULL, Pgm(), and ProcessExecute().

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

PrintFile()

void PrintFile

(

const wxString &

file

)

Definition at line 351 of file gestfich.cpp.

{
    doPrintFile( file, false );
}

References doPrintFile().

Referenced by PROJECT_TREE_ITEM::Print().

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 378 of file gestfich.cpp.

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

Referenced by SCH_EDIT_FRAME::OnOpenPcbnew(), and GERBVIEW_INSPECTION_TOOL::ShowSource().