-
-
Notifications
You must be signed in to change notification settings - Fork 484
/
kicad.cpp
599 lines (485 loc) · 17.1 KB
/
kicad.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2004-2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
* Copyright (C) 2004-2021 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 kicad.cpp
* Main KiCad project manager file.
*/
#include <wx/filename.h>
#include <wx/log.h>
#include <wx/app.h>
#include <wx/stdpaths.h>
#include <wx/msgdlg.h>
#include <wx/cmdline.h>
#include <env_vars.h>
#include <file_history.h>
#include <hotkeys_basic.h>
#include <kiway.h>
#include <macros.h>
#include <paths.h>
#include <richio.h>
#include <settings/settings_manager.h>
#include <settings/kicad_settings.h>
#include <systemdirsappend.h>
#include <trace_helpers.h>
#include <wildcards_and_files_ext.h>
#include <confirm.h>
#include <git2.h>
#include <stdexcept>
#include "pgm_kicad.h"
#include "kicad_manager_frame.h"
#include <kiplatform/app.h>
#include <kiplatform/environment.h>
#ifdef KICAD_IPC_API
#include <api/api_server.h>
#endif
// a dummy to quiet linking with EDA_BASE_FRAME::config();
#include <kiface_base.h>
KIFACE_BASE& Kiface()
{
// This function should never be called. It is only referenced from
// EDA_BASE_FRAME::config() and this is only provided to satisfy the linker,
// not to be actually called.
wxLogFatalError( wxT( "Unexpected call to Kiface() in kicad/kicad.cpp" ) );
throw std::logic_error( "Unexpected call to Kiface() in kicad/kicad.cpp" );
}
static PGM_KICAD program;
PGM_KICAD& PgmTop()
{
return program;
}
bool PGM_KICAD::OnPgmInit()
{
App().SetAppDisplayName( wxT( "KiCad" ) );
#if defined(DEBUG)
wxString absoluteArgv0 = wxStandardPaths::Get().GetExecutablePath();
if( !wxIsAbsolutePath( absoluteArgv0 ) )
{
wxLogError( wxT( "No meaningful argv[0]" ) );
return false;
}
#endif
// Initialize the git library before trying to initialize individual programs
git_libgit2_init();
static const wxCmdLineEntryDesc desc[] = {
{ wxCMD_LINE_OPTION, "f", "frame", "Frame to load", wxCMD_LINE_VAL_STRING, 0 },
{ wxCMD_LINE_PARAM, nullptr, nullptr, "File to load", wxCMD_LINE_VAL_STRING,
wxCMD_LINE_PARAM_MULTIPLE | wxCMD_LINE_PARAM_OPTIONAL },
{ wxCMD_LINE_NONE, nullptr, nullptr, nullptr, wxCMD_LINE_VAL_NONE, 0 }
};
wxCmdLineParser parser( App().argc, App().argv );
parser.SetDesc( desc );
parser.Parse( false );
FRAME_T appType = KICAD_MAIN_FRAME_T;
const struct
{
wxString name;
FRAME_T type;
} frameTypes[] = { { wxT( "pcb" ), FRAME_PCB_EDITOR },
{ wxT( "fpedit" ), FRAME_FOOTPRINT_EDITOR },
{ wxT( "sch" ), FRAME_SCH },
{ wxT( "calc" ), FRAME_CALC },
{ wxT( "bm2cmp" ), FRAME_BM2CMP },
{ wxT( "ds" ), FRAME_PL_EDITOR },
{ wxT( "gerb" ), FRAME_GERBER },
{ wxT( "" ), FRAME_T_COUNT } };
wxString frameName;
if( parser.Found( "frame", &frameName ) )
{
appType = FRAME_T_COUNT;
for( const auto& it : frameTypes )
{
if( it.name == frameName )
appType = it.type;
}
if( appType == FRAME_T_COUNT )
{
wxLogError( wxT( "Unknown frame: %s" ), frameName );
// Clean up
OnPgmExit();
return false;
}
}
if( appType == KICAD_MAIN_FRAME_T )
{
Kiway.SetCtlBits( KFCTL_CPP_PROJECT_SUITE );
}
else
{
Kiway.SetCtlBits( KFCTL_STANDALONE );
}
bool skipPythonInit = false;
if( appType == FRAME_BM2CMP || appType == FRAME_PL_EDITOR || appType == FRAME_GERBER
|| appType == FRAME_CALC )
skipPythonInit = true;
if( !InitPgm( false, skipPythonInit ) )
return false;
m_bm.InitSettings( new KICAD_SETTINGS );
GetSettingsManager().RegisterSettings( PgmSettings() );
GetSettingsManager().SetKiway( &Kiway );
m_bm.Init();
// Add search paths to feed the PGM_KICAD::SysSearch() function,
// currently limited in support to only look for project templates
{
SEARCH_STACK bases;
SystemDirsAppend( &bases );
for( unsigned i = 0; i < bases.GetCount(); ++i )
{
wxFileName fn( bases[i], wxEmptyString );
// Add KiCad template file path to search path list.
fn.AppendDir( wxT( "template" ) );
// Only add path if exists and can be read by the user.
if( fn.DirExists() && fn.IsDirReadable() )
m_bm.m_search.AddPaths( fn.GetPath() );
}
// The versioned TEMPLATE_DIR takes precedence over the search stack template path.
if( std::optional<wxString> v = ENV_VAR::GetVersionedEnvVarValue( GetLocalEnvVariables(),
wxT( "TEMPLATE_DIR" ) ) )
{
if( !v->IsEmpty() )
m_bm.m_search.Insert( *v, 0 );
}
// We've been adding system (installed default) search paths so far, now for user paths
// The default user search path is inside KIPLATFORM::ENV::GetDocumentsPath()
m_bm.m_search.Insert( PATHS::GetUserTemplatesPath(), 0 );
// ...but the user can override that default with the KICAD_USER_TEMPLATE_DIR env var
ENV_VAR_MAP_CITER it = GetLocalEnvVariables().find( "KICAD_USER_TEMPLATE_DIR" );
if( it != GetLocalEnvVariables().end() && it->second.GetValue() != wxEmptyString )
m_bm.m_search.Insert( it->second.GetValue(), 0 );
}
wxFrame* frame = nullptr;
KIWAY_PLAYER* playerFrame = nullptr;
KICAD_MANAGER_FRAME* managerFrame = nullptr;
if( appType == KICAD_MAIN_FRAME_T )
{
managerFrame = new KICAD_MANAGER_FRAME( nullptr, wxT( "KiCad" ), wxDefaultPosition,
wxWindow::FromDIP( wxSize( 775, -1 ), NULL ) );
frame = managerFrame;
}
else
{
// Use KIWAY to create a top window, which registers its existence also.
// "TOP_FRAME" is a macro that is passed on compiler command line from CMake,
// and is one of the types in FRAME_T.
playerFrame = Kiway.Player( appType, true );
frame = playerFrame;
if( frame == nullptr )
{
return false;
}
}
App().SetTopWindow( frame );
if( playerFrame )
App().SetAppDisplayName( playerFrame->GetAboutTitle() );
Kiway.SetTop( frame );
KICAD_SETTINGS* settings = static_cast<KICAD_SETTINGS*>( PgmSettings() );
#ifdef KICAD_IPC_API
m_api_server = std::make_unique<KICAD_API_SERVER>();
#endif
wxString projToLoad;
HideSplash();
if( playerFrame && parser.GetParamCount() )
{
// Now after the frame processing, the rest of the positional args are files
std::vector<wxString> fileArgs;
/*
gerbview handles multiple project data files, i.e. gerber files on
cmd line. Others currently do not, they handle only one. For common
code simplicity we simply pass all the arguments in however, each
program module can do with them what they want, ignore, complain
whatever. We don't establish policy here, as this is a multi-purpose
launcher.
*/
for( size_t i = 0; i < parser.GetParamCount(); i++ )
fileArgs.push_back( parser.GetParam( i ) );
// special attention to a single argument: argv[1] (==argSet[0])
if( fileArgs.size() == 1 )
{
wxFileName argv1( fileArgs[0] );
#if defined( PGM_DATA_FILE_EXT )
// PGM_DATA_FILE_EXT, if present, may be different for each compile,
// it may come from CMake on the compiler command line, but often does not.
// This facility is mostly useful for those program footprints
// supporting a single argv[1].
if( !argv1.GetExt() )
argv1.SetExt( wxT( PGM_DATA_FILE_EXT ) );
#endif
argv1.MakeAbsolute();
fileArgs[0] = argv1.GetFullPath();
}
// Use the KIWAY_PLAYER::OpenProjectFiles() API function:
if( !playerFrame->OpenProjectFiles( fileArgs ) )
{
// OpenProjectFiles() API asks that it report failure to the UI.
// Nothing further to say here.
// We've already initialized things at this point, but wx won't call OnExit if
// we fail out. Call our own cleanup routine here to ensure the relevant resources
// are freed at the right time (if they aren't, segfaults will occur).
OnPgmExit();
// Fail the process startup if the file could not be opened,
// although this is an optional choice, one that can be reversed
// also in the KIFACE specific OpenProjectFiles() return value.
return false;
}
}
else if( managerFrame )
{
if( App().argc > 1 )
{
wxFileName tmp = App().argv[1];
if( tmp.GetExt() != FILEEXT::ProjectFileExtension
&& tmp.GetExt() != FILEEXT::LegacyProjectFileExtension )
{
wxString msg;
msg.Printf( _( "File '%s'\ndoes not appear to be a valid KiCad project file." ),
tmp.GetFullPath() );
wxMessageDialog dlg( nullptr, msg, _( "Error" ), wxOK | wxICON_EXCLAMATION );
dlg.ShowModal();
}
else
{
projToLoad = tmp.GetFullPath();
}
}
// If no file was given as an argument, check that there was a file open.
if( projToLoad.IsEmpty() && settings->m_OpenProjects.size() )
{
wxString last_pro = settings->m_OpenProjects.front();
settings->m_OpenProjects.erase( settings->m_OpenProjects.begin() );
if( wxFileExists( last_pro ) )
{
// Try to open the last opened project,
// if a project name is not given when starting Kicad
projToLoad = last_pro;
}
}
// Do not attempt to load a non-existent project file.
if( !projToLoad.empty() )
{
wxFileName fn( projToLoad );
if( fn.Exists() )
{
fn.MakeAbsolute();
if( appType == KICAD_MAIN_FRAME_T )
{
managerFrame->LoadProject( fn );
}
}
}
}
frame->Show( true );
frame->Raise();
#ifdef KICAD_IPC_API
m_api_server->SetReadyToReply();
#endif
return true;
}
int PGM_KICAD::OnPgmRun()
{
return 0;
}
void PGM_KICAD::OnPgmExit()
{
Kiway.OnKiwayEnd();
#ifdef KICAD_IPC_API
m_api_server.reset();
#endif
if( m_settings_manager && m_settings_manager->IsOK() )
{
SaveCommonSettings();
m_settings_manager->Save();
}
// Destroy everything in PGM_KICAD,
// especially wxSingleInstanceCheckerImpl earlier than wxApp and earlier
// than static destruction would.
Destroy();
git_libgit2_shutdown();
}
void PGM_KICAD::MacOpenFile( const wxString& aFileName )
{
#if defined(__WXMAC__)
KICAD_MANAGER_FRAME* frame = (KICAD_MANAGER_FRAME*) App().GetTopWindow();
if( !aFileName.empty() && wxFileExists( aFileName ) )
frame->LoadProject( wxFileName( aFileName ) );
#endif
}
void PGM_KICAD::Destroy()
{
// unlike a normal destructor, this is designed to be called more
// than once safely:
m_bm.End();
PGM_BASE::Destroy();
}
KIWAY Kiway( KFCTL_CPP_PROJECT_SUITE );
#ifdef NDEBUG
// Define a custom assertion handler
void CustomAssertHandler(const wxString& file,
int line,
const wxString& func,
const wxString& cond,
const wxString& msg)
{
Pgm().HandleAssert( file, line, func, cond, msg );
}
#endif
/**
* Not publicly visible because most of the action is in #PGM_KICAD these days.
*/
struct APP_KICAD : public wxApp
{
APP_KICAD() : wxApp()
{
SetPgm( &program );
// Init the environment each platform wants
KIPLATFORM::ENV::Init();
}
bool OnInit() override
{
#ifdef NDEBUG
// These checks generate extra assert noise
wxSizerFlags::DisableConsistencyChecks();
wxDISABLE_DEBUG_SUPPORT();
wxSetAssertHandler( CustomAssertHandler );
#endif
// Perform platform-specific init tasks
if( !KIPLATFORM::APP::Init() )
return false;
#ifndef DEBUG
// Enable logging traces to the console in release build.
// This is usually disabled, but it can be useful for users to run to help
// debug issues and other problems.
if( wxGetEnv( wxS( "KICAD_ENABLE_WXTRACE" ), nullptr ) )
{
wxLog::EnableLogging( true );
wxLog::SetLogLevel( wxLOG_Trace );
}
#endif
if( !program.OnPgmInit() )
{
program.OnPgmExit();
return false;
}
return true;
}
int OnExit() override
{
program.OnPgmExit();
// Avoid wxLog crashing when used in destructors.
wxLog::EnableLogging( false );
return wxApp::OnExit();
}
int OnRun() override
{
try
{
return wxApp::OnRun();
}
catch(...)
{
Pgm().HandleException( std::current_exception() );
}
return -1;
}
int FilterEvent( wxEvent& aEvent ) override
{
if( aEvent.GetEventType() == wxEVT_SHOW )
{
wxShowEvent& event = static_cast<wxShowEvent&>( aEvent );
wxDialog* dialog = dynamic_cast<wxDialog*>( event.GetEventObject() );
std::vector<void*>& dlgs = Pgm().m_ModalDialogs;
if( dialog )
{
if( event.IsShown() && dialog->IsModal() )
{
dlgs.push_back( dialog );
}
// Under GTK, sometimes the modal flag is cleared before hiding
else if( !event.IsShown() && !dlgs.empty() )
{
// If we close the expected dialog, remove it from our stack
if( dlgs.back() == dialog )
dlgs.pop_back();
// If an out-of-order, remove all dialogs added after the closed one
else if( auto it = std::find( dlgs.begin(), dlgs.end(), dialog ) ; it != dlgs.end() )
dlgs.erase( it, dlgs.end() );
}
}
}
return Event_Skip;
}
#if defined( DEBUG )
/**
* Process any unhandled events at the application level.
*/
bool ProcessEvent( wxEvent& aEvent ) override
{
if( aEvent.GetEventType() == wxEVT_CHAR || aEvent.GetEventType() == wxEVT_CHAR_HOOK )
{
wxKeyEvent* keyEvent = static_cast<wxKeyEvent*>( &aEvent );
if( keyEvent )
{
wxLogTrace( kicadTraceKeyEvent, "APP_KICAD::ProcessEvent %s", dump( *keyEvent ) );
}
}
aEvent.Skip();
return false;
}
/**
* Override main loop exception handling on debug builds.
*
* It can be painfully difficult to debug exceptions that happen in wxUpdateUIEvent
* handlers. The override provides a bit more useful information about the exception
* and a breakpoint can be set to pin point the event where the exception was thrown.
*/
bool OnExceptionInMainLoop() override
{
try
{
throw;
}
catch(...)
{
Pgm().HandleException( std::current_exception() );
}
return false; // continue on. Return false to abort program
}
#endif
/**
* Set MacOS file associations.
*
* @see http://wiki.wxwidgets.org/WxMac-specific_topics
*/
#if defined( __WXMAC__ )
void MacOpenFile( const wxString& aFileName ) override
{
Pgm().MacOpenFile( aFileName );
}
#endif
};
IMPLEMENT_APP( APP_KICAD )
// The C++ project manager supports one open PROJECT, so Prj() calls within
// this link image need this function.
PROJECT& Prj()
{
return Kiway.Prj();
}