mirror of
https://gitlab.com/kicad/code/kicad.git
synced 2025-09-14 18:23:15 +02:00
1e5ba6f1b1
The standard DIM() macro was not typesafe as it happily deferred errors to runtime that can be caught at compile time. Replacing it with a generic C++11 constexpr allows for typecasting, comparison and compile time error checking.
421 lines
12 KiB
C++
421 lines
12 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2004 Jean-Pierre Charras, jaen-pierre.charras@gipsa-lab.inpg.com
|
|
* Copyright (C) 2008-2017 Wayne Stambaugh <stambaughw@verizon.net>
|
|
* Copyright (C) 1992-2017 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
|
|
*/
|
|
|
|
/**
|
|
* @file gestfich.cpp
|
|
* @brief Functions for file management
|
|
*/
|
|
|
|
#include <wx/mimetype.h>
|
|
#include <wx/filename.h>
|
|
#include <wx/dir.h>
|
|
|
|
// For compilers that support precompilation, includes "wx.h".
|
|
#include <fctsys.h>
|
|
#include <pgm_base.h>
|
|
#include <confirm.h>
|
|
#include <common.h>
|
|
#include <macros.h>
|
|
|
|
#include <gestfich.h>
|
|
|
|
void AddDelimiterString( wxString& string )
|
|
{
|
|
if( !string.StartsWith( wxT( "\"" ) ) )
|
|
{
|
|
string.Prepend ( wxT( "\"" ) );
|
|
string.Append ( wxT( "\"" ) );
|
|
}
|
|
}
|
|
|
|
|
|
bool EDA_PATH_SELECTOR( const wxString& aTitle,
|
|
wxString& aPath,
|
|
int aFlags,
|
|
wxWindow* aParent,
|
|
const wxPoint& aPosition )
|
|
{
|
|
int ii;
|
|
bool selected = false;
|
|
|
|
wxDirDialog* DirFrame = new wxDirDialog( aParent,
|
|
aTitle,
|
|
aPath,
|
|
aFlags,
|
|
aPosition );
|
|
|
|
ii = DirFrame->ShowModal();
|
|
|
|
if( ii == wxID_OK )
|
|
{
|
|
aPath = DirFrame->GetPath();
|
|
selected = true;
|
|
}
|
|
|
|
DirFrame->Destroy();
|
|
return selected;
|
|
}
|
|
|
|
|
|
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,
|
|
wxString* aMruPath )
|
|
{
|
|
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 );
|
|
|
|
#if 0 && defined (DEBUG)
|
|
printf( "defaultpath=\"%s\" defaultname=\"%s\" Ext=\"%s\" Mask=\"%s\" flag=%d keep_working_directory=%d\n",
|
|
TO_UTF8( defaultpath ),
|
|
TO_UTF8( defaultname ),
|
|
TO_UTF8( aExtension ),
|
|
TO_UTF8( aWildcard ),
|
|
aStyle,
|
|
aKeepWorkingDirectory );
|
|
#endif
|
|
|
|
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;
|
|
}
|
|
|
|
|
|
wxString FindKicadFile( const wxString& shortname )
|
|
{
|
|
// 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;
|
|
}
|
|
|
|
// Path list for KiCad binary files
|
|
const static wxChar* possibilities[] = {
|
|
#if defined( __WINDOWS__ )
|
|
wxT( "c:/kicad/bin/" ),
|
|
wxT( "d:/kicad/bin/" ),
|
|
wxT( "c:/Program Files/kicad/bin/" ),
|
|
wxT( "d:/Program Files/kicad/bin/" ),
|
|
#elif 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;
|
|
}
|
|
|
|
|
|
int ExecuteFile( wxWindow* frame, const wxString& ExecFile, const wxString& param,
|
|
wxProcess *callback )
|
|
{
|
|
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" ), GetChars( fullFileName ) );
|
|
DisplayError( frame, msg, 20 );
|
|
return -1;
|
|
}
|
|
|
|
|
|
wxString KicadDatasPath()
|
|
{
|
|
bool found = false;
|
|
wxString data_path;
|
|
|
|
if( Pgm().IsKicadEnvVariableDefined() ) // Path defined by the KICAD environment variable.
|
|
{
|
|
data_path = Pgm().GetKicadEnvVariable();
|
|
found = true;
|
|
}
|
|
else // Path of executables.
|
|
{
|
|
#ifndef __WXMAC__
|
|
wxString tmp = Pgm().GetExecutablePath();
|
|
#ifdef __WINDOWS__
|
|
tmp.MakeLower();
|
|
#endif
|
|
if( tmp.Contains( wxT( "kicad" ) ) )
|
|
{
|
|
#ifdef __WINDOWS__
|
|
tmp = Pgm().GetExecutablePath();
|
|
#endif
|
|
if( tmp.Last() == '/' )
|
|
tmp.RemoveLast();
|
|
|
|
data_path = tmp.BeforeLast( '/' ); // id cd ../
|
|
data_path += UNIX_STRING_DIR_SEP;
|
|
|
|
// Old versions of KiCad use kicad/ as default for data
|
|
// and last versions kicad/share/
|
|
// So we search for kicad/share/ first
|
|
wxString old_path = data_path;
|
|
data_path += wxT( "share/" );
|
|
|
|
if( wxDirExists( data_path ) )
|
|
{
|
|
found = true;
|
|
}
|
|
else if( wxDirExists( old_path ) )
|
|
{
|
|
data_path = old_path;
|
|
found = true;
|
|
}
|
|
}
|
|
}
|
|
|
|
if( !found )
|
|
{
|
|
// find KiCad from possibilities list:
|
|
// /usr/local/kicad/ or c:/kicad/
|
|
|
|
const static wxChar* possibilities[] = {
|
|
#ifdef __WINDOWS__
|
|
wxT( "c:/kicad/share/" ),
|
|
wxT( "d:/kicad/share/" ),
|
|
wxT( "c:/kicad/" ),
|
|
wxT( "d:/kicad/" ),
|
|
wxT( "c:/Program Files/kicad/share/" ),
|
|
wxT( "d:/Program Files/kicad/share/" ),
|
|
wxT( "c:/Program Files/kicad/" ),
|
|
wxT( "d:/Program Files/kicad/" ),
|
|
#else
|
|
wxT( "/usr/share/kicad/" ),
|
|
wxT( "/usr/local/share/kicad/" ),
|
|
wxT( "/usr/local/kicad/share/" ), // default data path for "universal
|
|
// tarballs" and build for a server
|
|
// (new)
|
|
wxT( "/usr/local/kicad/" ), // default data path for "universal
|
|
// tarballs" and build for a server
|
|
// (old)
|
|
#endif
|
|
};
|
|
|
|
for( unsigned i=0; i<arrayDim(possibilities); ++i )
|
|
{
|
|
data_path = possibilities[i];
|
|
|
|
if( wxDirExists( data_path ) )
|
|
{
|
|
found = true;
|
|
break;
|
|
}
|
|
}
|
|
#else
|
|
// On OSX point to Contents/SharedSupport folder of main bundle
|
|
data_path = GetOSXKicadDataDir();
|
|
found = true;
|
|
#endif
|
|
}
|
|
|
|
if( found )
|
|
{
|
|
data_path.Replace( WIN_STRING_DIR_SEP, UNIX_STRING_DIR_SEP );
|
|
|
|
if( data_path.Last() != '/' )
|
|
data_path += UNIX_STRING_DIR_SEP;
|
|
}
|
|
else
|
|
{
|
|
data_path.Empty();
|
|
}
|
|
|
|
return data_path;
|
|
}
|
|
|
|
|
|
bool OpenPDF( const wxString& file )
|
|
{
|
|
wxString command;
|
|
wxString filename = file;
|
|
|
|
// Quote in case there are spaces in the file name.
|
|
AddDelimiterString( filename );
|
|
|
|
Pgm().ReadPdfBrowserInfos();
|
|
|
|
if( !Pgm().UseSystemPdfBrowser() ) // Run the preferred PDF Browser
|
|
{
|
|
command = Pgm().GetPdfBrowserName() + wxT( " " ) + filename;
|
|
}
|
|
else
|
|
{
|
|
if( wxLaunchDefaultApplication( filename ) )
|
|
return true;
|
|
|
|
// 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 ) )
|
|
{
|
|
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;
|
|
}
|
|
|
|
|
|
void OpenFile( const wxString& file )
|
|
{
|
|
wxString command;
|
|
|
|
wxFileName currentFileName( file );
|
|
wxString ext;
|
|
wxString type;
|
|
|
|
ext = currentFileName.GetExt();
|
|
wxFileType* filetype = wxTheMimeTypesManager->GetFileTypeFromExtension( ext );
|
|
|
|
bool success = false;
|
|
|
|
wxFileType::MessageParameters params( file, type );
|
|
|
|
if( filetype )
|
|
success = filetype->GetOpenCommand( &command, params );
|
|
|
|
delete filetype;
|
|
|
|
if( success && !command.IsEmpty() )
|
|
ProcessExecute( command );
|
|
}
|
|
|
|
|
|
wxString QuoteFullPath( wxFileName& fn, wxPathFormat format )
|
|
{
|
|
return wxT( "\"" ) + fn.GetFullPath( format ) + wxT( "\"" );
|
|
}
|