KiCad PCB EDA Suite
gestfich.cpp
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2004 Jean-Pierre Charras, jaen-pierre.charras@gipsa-lab.inpg.com
5  * Copyright (C) 2008 Wayne Stambaugh <stambaughw@gmail.com>
6  * Copyright (C) 1992-2020 KiCad Developers, see AUTHORS.txt for contributors.
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, you may find one here:
20  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21  * or you may search the http://www.gnu.org website for the version 2 license,
22  * or you may write to the Free Software Foundation, Inc.,
23  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24  */
25 
31 #include <wx/mimetype.h>
32 #include <wx/filename.h>
33 #include <wx/dir.h>
34 #include <wx/filedlg.h>
35 
36 #include <pgm_base.h>
37 #include <common.h>
38 #include <confirm.h>
39 #include <core/arraydim.h>
40 #include <gestfich.h>
41 
42 void AddDelimiterString( wxString& string )
43 {
44  if( !string.StartsWith( wxT( "\"" ) ) )
45  {
46  string.Prepend ( wxT( "\"" ) );
47  string.Append ( wxT( "\"" ) );
48  }
49 }
50 
51 
52 wxString EDA_FILE_SELECTOR( const wxString& aTitle,
53  const wxString& aPath,
54  const wxString& aFileName,
55  const wxString& aExtension,
56  const wxString& aWildcard,
57  wxWindow* aParent,
58  int aStyle,
59  const bool aKeepWorkingDirectory,
60  const wxPoint& aPosition,
61  wxString* aMruPath )
62 {
63  wxString fullfilename;
64  wxString curr_cwd = wxGetCwd();
65  wxString defaultname = aFileName;
66  wxString defaultpath = aPath;
67  wxString dotted_Ext = wxT(".") + aExtension;
68 
69 #ifdef __WINDOWS__
70  defaultname.Replace( wxT( "/" ), wxT( "\\" ) );
71  defaultpath.Replace( wxT( "/" ), wxT( "\\" ) );
72 #endif
73 
74  if( defaultpath.IsEmpty() )
75  {
76  if( aMruPath == NULL )
77  defaultpath = wxGetCwd();
78  else
79  defaultpath = *aMruPath;
80  }
81 
82  wxSetWorkingDirectory( defaultpath );
83 
84  fullfilename = wxFileSelector( aTitle, defaultpath, defaultname,
85  dotted_Ext, aWildcard,
86  aStyle, // open mode wxFD_OPEN, wxFD_SAVE ..
87  aParent, aPosition.x, aPosition.y );
88 
89  if( aKeepWorkingDirectory )
90  wxSetWorkingDirectory( curr_cwd );
91 
92  if( !fullfilename.IsEmpty() && aMruPath )
93  {
94  wxFileName fn = fullfilename;
95  *aMruPath = fn.GetPath();
96  }
97 
98  return fullfilename;
99 }
100 
101 
102 wxString FindKicadFile( const wxString& shortname )
103 {
104  // Test the presence of the file in the directory shortname of
105  // the KiCad binary path.
106 #ifndef __WXMAC__
107  wxString fullFileName = Pgm().GetExecutablePath() + shortname;
108 #else
109  wxString fullFileName = Pgm().GetExecutablePath() + wxT( "Contents/MacOS/" ) + shortname;
110 #endif
111  if( wxFileExists( fullFileName ) )
112  return fullFileName;
113 
114  // Test the presence of the file in the directory shortname
115  // defined by the environment variable KiCad.
116  if( Pgm().IsKicadEnvVariableDefined() )
117  {
118  fullFileName = Pgm().GetKicadEnvVariable() + shortname;
119 
120  if( wxFileExists( fullFileName ) )
121  return fullFileName;
122  }
123 
124 #if defined( __WINDOWS__ )
125  // kicad can be installed highly portably on Windows, anywhere and concurrently
126  // either the "kicad file" is immediately adjacent to the exe or it's not a valid install
127  return shortname;
128 #endif
129 
130  // Path list for KiCad binary files
131  const static wxChar* possibilities[] = {
132 #if defined( __WXMAC__ )
133  // all internal paths are relative to main bundle kicad.app
134  wxT( "Contents/Applications/pcbnew.app/Contents/MacOS/" ),
135  wxT( "Contents/Applications/eeschema.app/Contents/MacOS/" ),
136  wxT( "Contents/Applications/gerbview.app/Contents/MacOS/" ),
137  wxT( "Contents/Applications/bitmap2component.app/Contents/MacOS/" ),
138  wxT( "Contents/Applications/pcb_calculator.app/Contents/MacOS/" ),
139  wxT( "Contents/Applications/pl_editor.app/Contents/MacOS/" ),
140 #else
141  wxT( "/usr/bin/" ),
142  wxT( "/usr/local/bin/" ),
143  wxT( "/usr/local/kicad/bin/" ),
144 #endif
145  };
146 
147  // find binary file from possibilities list:
148  for( unsigned i=0; i<arrayDim(possibilities); ++i )
149  {
150 #ifndef __WXMAC__
151  fullFileName = possibilities[i] + shortname;
152 #else
153  // make relative paths absolute
154  fullFileName = Pgm().GetExecutablePath() + possibilities[i] + shortname;
155 #endif
156 
157  if( wxFileExists( fullFileName ) )
158  return fullFileName;
159  }
160 
161  return shortname;
162 }
163 
164 
165 int ExecuteFile( wxWindow* frame, const wxString& ExecFile, const wxString& param,
166  wxProcess *callback )
167 {
168  wxString fullFileName = FindKicadFile( ExecFile );
169 
170  if( wxFileExists( fullFileName ) )
171  {
172  if( !param.IsEmpty() )
173  fullFileName += wxT( " " ) + param;
174 
175  return ProcessExecute( fullFileName, wxEXEC_ASYNC, callback );
176  }
177 #ifdef __WXMAC__
178  else
179  {
180  AddDelimiterString( fullFileName );
181 
182  if( !param.IsEmpty() )
183  fullFileName += wxT( " " ) + param;
184 
185  return ProcessExecute( wxT( "/usr/bin/open -a " ) + fullFileName, wxEXEC_ASYNC, callback );
186  }
187 #endif
188 
189  wxString msg;
190  msg.Printf( _( "Command \"%s\" could not found" ), fullFileName );
191  DisplayError( frame, msg, 20 );
192  return -1;
193 }
194 
195 
196 bool OpenPDF( const wxString& file )
197 {
198  wxString command;
199  wxString filename = file;
200 
201  Pgm().ReadPdfBrowserInfos();
202 
203  if( !Pgm().UseSystemPdfBrowser() ) // Run the preferred PDF Browser
204  {
205 #ifdef __WXMSW__
206  // Windows requires double quotes around the filename to handle spaces
207  command = Pgm().GetPdfBrowserName() + wxT( " \"" ) + filename + wxT( "\"" );
208 #else
209  command = Pgm().GetPdfBrowserName() + wxT( " '" ) + filename + wxT( "'" );
210 #endif
211  }
212  else
213  {
214  // wxLaunchDefaultApplication on Unix systems is run as an external process passing
215  // the filename to the appropriate application as a command argument. Spaces in the
216  // path and/or file name will cause argument parsing issues so always quote the file
217  // name and path. This is applicable to all Unix platforms.
218  // See https://github.com/wxWidgets/wxWidgets/blob/master/src/unix/utilsx11.cpp#L2654
219 #ifdef __WXGTK__
220  filename = wxT( "\"" ) + filename + wxT( "\"" );
221 #endif
222 
223  if( wxLaunchDefaultApplication( filename ) )
224  return true;
225 
226 #ifdef __WXMAC__
227  command = wxT( "/usr/bin/open -a '" ) + file + wxT( "'" );
228 #endif
229  // If launching the system default PDF viewer fails, fall through with empty command
230  // string so the error message is displayed.
231  }
232 
233  if( !command.IsEmpty() )
234  {
235  if( ProcessExecute( command ) != -1 )
236  {
237  return true;
238  }
239  else
240  {
241  wxString msg;
242  msg.Printf( _( "Problem while running the PDF viewer\nCommand is \"%s\"" ), command );
243  DisplayError( NULL, msg );
244  }
245  }
246  else
247  {
248  wxString msg;
249  msg.Printf( _( "Unable to find a PDF viewer for \"%s\"" ), file );
250  DisplayError( NULL, msg );
251  }
252 
253  return false;
254 }
255 
256 
257 void OpenFile( const wxString& file )
258 {
259  wxFileName fileName( file );
260  wxFileType* filetype = wxTheMimeTypesManager->GetFileTypeFromExtension( fileName.GetExt() );
261 
262  if( !filetype )
263  return;
264 
265  wxString command;
266  wxFileType::MessageParameters params( file );
267 
268  filetype->GetOpenCommand( &command, params );
269  delete filetype;
270 
271  if( !command.IsEmpty() )
272  ProcessExecute( command );
273 }
274 
275 
276 bool doPrintFile( const wxString& file, bool aDryRun )
277 {
278  wxFileName fileName( file );
279  wxString ext = fileName.GetExt();
280  wxFileType* filetype = wxTheMimeTypesManager->GetFileTypeFromExtension( ext );
281 
282  if( !filetype )
283  return false;
284 
285  wxString printCommand;
286  wxString openCommand;
287  wxString application;
288 
289  wxFileType::MessageParameters params( file );
290  filetype->GetPrintCommand( &printCommand, params );
291  filetype->GetOpenCommand( &openCommand, params );
292  delete filetype;
293 
294  if( !printCommand.IsEmpty() )
295  {
296  if( !aDryRun )
297  ProcessExecute( printCommand );
298 
299  return true;
300  }
301 
302 #ifdef __WXMAC__
303  if( ext == "ps" || ext == "pdf" )
304  application = "Preview";
305  else if( ext == "csv" )
306  application = "Numbers";
307  else if( ext == "txt" || ext == "rpt" || ext == "pos" || ext == "cmp" || ext == "net" )
308  application = "TextEdit";
309 
310  if( !application.IsEmpty() )
311  {
312  printCommand.Printf( "osascript -e 'tell application \"%s\"' "
313  "-e ' set srcFileRef to (open POSIX file \"%s\")' "
314  "-e ' activate' "
315  "-e ' print srcFileRef print dialog true' "
316  "-e 'end tell' ",
317  application,
318  file );
319 
320  if( !aDryRun )
321  system( printCommand.c_str() );
322 
323  return true;
324  }
325 #endif
326 
327 #ifdef __WXGTK__
328  if( ext == "ps" || ext == "pdf"
329  || ext == "csv"
330  || ext == "txt" || ext == "rpt" || ext == "pos" || ext == "cmp" || ext == "net" )
331  {
332  printCommand.Printf( "lp \"%s\"", file );
333 
334  if( !aDryRun )
335  ProcessExecute( printCommand );
336 
337  return true;
338  }
339 #endif
340 
341  if( !aDryRun )
342  {
343  DisplayError( nullptr, wxString::Format( _( "Cannot print '%s'.\n\nUnknown file type." ),
344  file ) );
345  }
346 
347  return false;
348 }
349 
350 
351 void PrintFile( const wxString& file )
352 {
353  doPrintFile( file, false );
354 }
355 
356 
357 bool CanPrintFile( const wxString& file )
358 {
359  return doPrintFile( file, true );
360 }
361 
362 
363 void KiCopyFile( const wxString& aSrcPath, const wxString& aDestPath, wxString& aErrors )
364 {
365  if( !wxCopyFile( aSrcPath, aDestPath ) )
366  {
367  wxString msg;
368 
369  if( !aErrors.IsEmpty() )
370  aErrors += "\n";
371 
372  msg.Printf( _( "Cannot copy file \"%s\"." ), aDestPath );
373  aErrors += msg;
374  }
375 }
376 
377 
378 wxString QuoteFullPath( wxFileName& fn, wxPathFormat format )
379 {
380  return wxT( "\"" ) + fn.GetFullPath( format ) + wxT( "\"" );
381 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:240
int ProcessExecute(const wxString &aCommandLine, int aFlags, wxProcess *callback)
Run a command in a child process.
Definition: common.cpp:40
bool doPrintFile(const wxString &file, bool aDryRun)
Definition: gestfich.cpp:276
This file is part of the common library TODO brief description.
This file is part of the common library.
void KiCopyFile(const wxString &aSrcPath, const wxString &aDestPath, wxString &aErrors)
Function CopyFile.
Definition: gestfich.cpp:363
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:102
#define NULL
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)
Function EDA_FILE_SELECTOR.
Definition: gestfich.cpp:52
constexpr std::size_t arrayDim(T const (&)[N]) noexcept
Returns # of elements in an array.
Definition: arraydim.h:31
void AddDelimiterString(wxString &string)
Function AddDelimiterString Add un " to the start and the end of string (if not already done).
Definition: gestfich.cpp:42
wxString FindKicadFile(const wxString &shortname)
Function FindKicadFile searches the executable file shortname in KiCad binary path and return full fi...
Definition: gestfich.cpp:102
void PrintFile(const wxString &file)
Definition: gestfich.cpp:351
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
see class PGM_BASE
wxString QuoteFullPath(wxFileName &fn, wxPathFormat format)
Quote return value of wxFileName::GetFullPath().
Definition: gestfich.cpp:378
#define _(s)
Definition: 3d_actions.cpp:33
The common library.
void OpenFile(const wxString &file)
Definition: gestfich.cpp:257
int ExecuteFile(wxWindow *frame, const wxString &ExecFile, const wxString &param, wxProcess *callback)
Function ExecuteFile calls the executable file ExecFile with the command line parameters param.
Definition: gestfich.cpp:165
bool CanPrintFile(const wxString &file)
Definition: gestfich.cpp:357
bool OpenPDF(const wxString &file)
Function OpenPDF run the PDF viewer and display a PDF file.
Definition: gestfich.cpp:196