KiCad PCB EDA Suite
Loading...
Searching...
No Matches
kicad_cli.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-2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
5 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, you may find one here:
19 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20 * or you may search the http://www.gnu.org website for the version 2 license,
21 * or you may write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23 */
24
25
26#include <wx/filename.h>
27#include <wx/log.h>
28#include <wx/stdpaths.h>
29#include <wx/wxcrtvararg.h> //for wxPrintf
30
31#include <kiway.h>
33#include <string_utils.h>
34#include <paths.h>
37#include <systemdirsappend.h>
38#include <trace_helpers.h>
39
40#include <cctype>
41#include <set>
42#include <stdexcept>
43
44#include "pgm_kicad.h"
45#include "kicad_manager_frame.h"
46
47#include <build_version.h>
48#include <kiplatform/app.h>
50#include <locale_io.h>
51
52#include "cli/command_jobset.h"
54#include "cli/command_pcb.h"
56#include "cli/command_pcb_drc.h"
78#include "cli/command_fp.h"
82#include "cli/command_sch.h"
83#include "cli/command_sch_erc.h"
86#include "cli/command_sym.h"
90#include "cli/command_gerber.h"
95#include "cli/command_version.h"
96#include "cli/exit_codes.h"
97
98#ifdef KICAD_IPC_API
100#endif
101
102// Add this header after all others, to avoid a collision name in a Windows header
103// on mingw.
104#include <wx/app.h>
105
106// a dummy to quiet linking with EDA_BASE_FRAME::config();
107#include <kiface_base.h>
108#include <thread_pool.h>
109
110
112{
113 // This function should never be called. It is only referenced from
114 // EDA_BASE_FRAME::config() and this is only provided to satisfy the linker,
115 // not to be actually called.
116 wxLogFatalError( wxT( "Unexpected call to Kiface() in kicad/kicad.cpp" ) );
117
118 throw std::logic_error( "Unexpected call to Kiface() in kicad/kicad.cpp" );
119}
120
121
123{
125
126 std::vector<COMMAND_ENTRY> subCommands;
127
129 handler( aHandler ) {};
130 COMMAND_ENTRY( CLI::COMMAND* aHandler, std::vector<COMMAND_ENTRY> aSub ) :
131 handler( aHandler ),
132 subCommands( aSub ) {};
133};
134
144static CLI::PCB_EXPORT_3D_COMMAND exportPcbGlbCmd{ "glb", UTF8STDSTR( _( "Export GLB (binary GLTF)" ) ),
207
208#ifdef KICAD_IPC_API
209static CLI::API_SERVER_COMMAND apiServerCmd{};
210#endif
211
212// clang-format off
213static std::vector<COMMAND_ENTRY> commandStack = {
214 {
215 &jobsetCmd,
216 {
217 {
219 }
220 }
221 },
222 {
223 &fpCmd,
224 {
225 {
227 {
229 }
230 },
231 {
233 }
234 }
235 },
236 {
237 &pcbCmd,
238 {
239 {
240 &pcbDrcCmd
241 },
242 {
244 },
245 {
247 },
248 {
250 {
274 }
275 },
276 {
278 }
279 }
280 },
281 {
282 &schCmd,
283 {
284 {
285 &schErcCmd
286 },
287 {
289 {
298 }
299 },
300 {
302 }
303 }
304 },
305 {
306 &symCmd,
307 {
308 {
310 {
312 }
313 },
314 {
316 }
317 }
318 },
319 {
320 &gerberCmd,
321 {
322 {
324 {
325 {
327 }
328 }
329 },
330 {
332 },
333 {
335 }
336 }
337 },
338 {
339 &versionCmd,
340 }
341#ifdef KICAD_IPC_API
342 ,
343 {
344 &apiServerCmd,
345 }
346#endif
347};
348// clang-format on
349
350
351static void recurseArgParserBuild( argparse::ArgumentParser& aArgParser, COMMAND_ENTRY& aEntry )
352{
353 aArgParser.add_subparser( aEntry.handler->GetArgParser() );
354
355 for( COMMAND_ENTRY& subEntry : aEntry.subCommands )
356 {
357 recurseArgParserBuild( aEntry.handler->GetArgParser(), subEntry );
358 }
359}
360
361
362static COMMAND_ENTRY* recurseArgParserSubCommandUsed( argparse::ArgumentParser& aArgParser, COMMAND_ENTRY& aEntry )
363{
364 COMMAND_ENTRY* cliCmd = nullptr;
365
366 if( aArgParser.is_subcommand_used( aEntry.handler->GetName() ) )
367 {
368 for( COMMAND_ENTRY& subentry : aEntry.subCommands )
369 {
370 cliCmd = recurseArgParserSubCommandUsed( aEntry.handler->GetArgParser(), subentry );
371 if( cliCmd )
372 break;
373 }
374
375 if( !cliCmd )
376 cliCmd = &aEntry;
377 }
378
379 return cliCmd;
380}
381
382
383static void printHelp( argparse::ArgumentParser& argParser )
384{
385 std::stringstream ss;
386 ss << argParser;
387 wxPrintf( From_UTF8( ss.str().c_str() ) );
388}
389
390
397static bool looksLikeNegativeVectorValue( const std::string& aValue )
398{
399 if( aValue.empty() || aValue[0] != '-' )
400 return false;
401
402 if( aValue.find( ',' ) == std::string::npos )
403 return false;
404
405 for( size_t i = 1; i < aValue.size(); ++i )
406 {
407 char c = aValue[i];
408
409 if( !std::isdigit( c ) && c != '.' && c != ',' && c != '-' && c != '+' )
410 return false;
411 }
412
413 return true;
414}
415
416
428static std::vector<std::string> preprocessArgs( int argc, char** argv )
429{
430 std::vector<std::string> result;
431
432 static const std::set<std::string> vectorArgs = { "--rotate", "--pan", "--pivot" };
433
434 for( int i = 0; i < argc; ++i )
435 {
436 std::string current( argv[i] );
437
438 if( vectorArgs.count( current ) && i + 1 < argc )
439 {
440 std::string next( argv[i + 1] );
441
443 {
444 result.push_back( current + "='" + next + "'" );
445 ++i;
446 continue;
447 }
448 }
449
450 result.push_back( current );
451 }
452
453 return result;
454}
455
456
458{
460 App().SetAppDisplayName( wxT( "kicad-cli" ) );
461
462#if defined( DEBUG )
463 wxString absoluteArgv0 = wxStandardPaths::Get().GetExecutablePath();
464
465 if( !wxIsAbsolutePath( absoluteArgv0 ) )
466 {
467 wxLogError( wxT( "No meaningful argv[0]" ) );
468 return false;
469 }
470#endif
471
472 if( !InitPgm( true ) )
473 return false;
474
475 m_bm.InitSettings( new KICAD_SETTINGS );
478 m_bm.Init();
479
481
482 return true;
483}
484
485
487{
488 argparse::ArgumentParser argParser( std::string( "kicad-cli" ), GetMajorMinorVersion().ToStdString(),
489 argparse::default_arguments::none );
490
491 argParser.add_argument( "-v", ARG_VERSION )
492 .help( UTF8STDSTR( _( "prints version information and exits" ) ) )
493 .flag()
494 .nargs( 0 );
495
496 argParser.add_argument( ARG_HELP_SHORT, ARG_HELP ).help( UTF8STDSTR( ARG_HELP_DESC ) ).flag().nargs( 0 );
497
498 for( COMMAND_ENTRY& entry : commandStack )
499 {
500 recurseArgParserBuild( argParser, entry );
501 }
502
503 try
504 {
505 // Use the C locale to parse arguments
506 // Otherwise the decimal separator for the locale will be applied
507 LOCALE_IO dummy;
508
509 // Pre-process arguments to handle negative vector values (e.g., --rotate -45,0,45)
510 // which argparse would otherwise interpret as unknown options
511 std::vector<std::string> args = preprocessArgs( m_argcUtf8, m_argvUtf8 );
512 argParser.parse_args( args );
513 }
514 // std::runtime_error doesn't seem to be enough for the scan<>()
515 catch( const std::exception& err )
516 {
517 bool requestedHelp = false;
518
519 for( int i = 0; i < m_argcUtf8; ++i )
520 {
521 if( std::string arg( m_argvUtf8[i] ); arg == ARG_HELP_SHORT || arg == ARG_HELP )
522 {
523 requestedHelp = true;
524 break;
525 }
526 }
527
528 if( !requestedHelp )
529 wxPrintf( "%s\n", err.what() );
530
531 // find the correct argparser object to output the command usage info
532 COMMAND_ENTRY* cliCmd = nullptr;
533 for( COMMAND_ENTRY& entry : commandStack )
534 {
535 if( argParser.is_subcommand_used( entry.handler->GetName() ) )
536 {
537 cliCmd = recurseArgParserSubCommandUsed( argParser, entry );
538 }
539 }
540
541 // arg parser uses a stream overload for printing the help
542 // we want to intercept so we can wxString the utf8 contents
543 // because on windows our terminal codepage might not be utf8
544 if( cliCmd )
545 cliCmd->handler->PrintHelp();
546 else
547 {
548 printHelp( argParser );
549 }
550
551 return requestedHelp ? 0 : CLI::EXIT_CODES::ERR_ARGS;
552 }
553
554 if( argParser[ARG_HELP] == true )
555 {
556 std::stringstream ss;
557 ss << argParser;
558 wxPrintf( From_UTF8( ss.str().c_str() ) );
559
560 return 0;
561 }
562
563 CLI::COMMAND* cliCmd = nullptr;
564
565 // the version arg gets redirected to the version subcommand
566 if( argParser[ARG_VERSION] == true )
567 {
568 cliCmd = &versionCmd;
569 }
570
571 if( !cliCmd )
572 {
573 for( COMMAND_ENTRY& entry : commandStack )
574 {
575 if( argParser.is_subcommand_used( entry.handler->GetName() ) )
576 {
577 COMMAND_ENTRY* cmdSubEntry = recurseArgParserSubCommandUsed( argParser, entry );
578 if( cmdSubEntry != nullptr )
579 {
580 cliCmd = cmdSubEntry->handler;
581 break;
582 }
583 }
584 }
585 }
586
587 if( cliCmd )
588 {
589 int exitCode = cliCmd->Perform( Kiway );
590
591 if( exitCode != CLI::EXIT_CODES::AVOID_CLOSING )
592 {
593 return exitCode;
594 }
595 else
596 {
597 return 0;
598 }
599 }
600 else
601 {
602 printHelp( argParser );
603
605 }
606}
607
608
610{
611 // Abort and wait on any background jobs
612 GetKiCadThreadPool().purge();
613 GetKiCadThreadPool().wait();
614
616
618 {
620 m_settings_manager->Save();
621 }
622
623 // Destroy everything in PGM_KICAD,
624 // especially wxSingleInstanceCheckerImpl earlier than wxApp and earlier
625 // than static destruction would.
626 Destroy();
627}
628
629
630void PGM_KICAD::MacOpenFile( const wxString& aFileName )
631{
632#if defined( __WXMAC__ )
633 wxFAIL_MSG( "kicad-cli should not call MacOpenFile" );
634#endif
635}
636
637
639{
640 // unlike a normal destructor, this is designed to be called more
641 // than once safely:
642
643 m_bm.End();
644
646}
647
648
650
652
656struct APP_KICAD_CLI : public wxAppConsole
657{
659 wxAppConsole()
660 {
661 SetPgm( &program );
662
663 // Init the environment each platform wants
665 }
666
667
668 bool OnInit() override
669 {
670 // Perform platform-specific init tasks
671 if( !KIPLATFORM::APP::Init() )
672 return false;
673
674#ifndef DEBUG
675 // Enable logging traces to the console in release build.
676 // This is usually disabled, but it can be useful for users to run to help
677 // debug issues and other problems.
678 if( wxGetEnv( wxS( "KICAD_ENABLE_WXTRACE" ), nullptr ) )
679 {
680 wxLog::EnableLogging( true );
681 wxLog::SetLogLevel( wxLOG_Trace );
682 }
683#endif
684
685 if( !program.OnPgmInit() )
686 {
687 program.OnPgmExit();
688 return false;
689 }
690
691 return true;
692 }
693
694 int OnExit() override
695 {
696 program.OnPgmExit();
697
698#if defined( __FreeBSD__ )
699 // Avoid wxLog crashing when used in destructors.
700 wxLog::EnableLogging( false );
701#endif
702
703 return wxAppConsole::OnExit();
704 }
705
706 int OnRun() override
707 {
708 try
709 {
710 return program.OnPgmRun();
711 }
712 catch( ... )
713 {
714 Pgm().HandleException( std::current_exception() );
715 }
716
717 return -1;
718 }
719
720 int FilterEvent( wxEvent& aEvent ) override { return Event_Skip; }
721
722#if defined( DEBUG )
726 bool ProcessEvent( wxEvent& aEvent ) override
727 {
728 if( aEvent.GetEventType() == wxEVT_CHAR || aEvent.GetEventType() == wxEVT_CHAR_HOOK )
729 {
730 wxKeyEvent* keyEvent = static_cast<wxKeyEvent*>( &aEvent );
731
732 if( keyEvent )
733 {
734 wxLogTrace( kicadTraceKeyEvent, "APP_KICAD::ProcessEvent %s", dump( *keyEvent ) );
735 }
736 }
737
738 aEvent.Skip();
739 return false;
740 }
741
749 bool OnExceptionInMainLoop() override
750 {
751 try
752 {
753 throw;
754 }
755 catch( ... )
756 {
757 Pgm().HandleException( std::current_exception() );
758 }
759
760 return false; // continue on. Return false to abort program
761 }
762#endif
763};
764
765IMPLEMENT_APP_CONSOLE( APP_KICAD_CLI )
766
767
768// The C++ project manager supports one open PROJECT, so Prj() calls within
769// this link image need this function.
771{
772 return Kiway.Prj();
773}
wxString GetMajorMinorVersion()
Get only the major and minor version in a string major.minor.
argparse::ArgumentParser & GetArgParser()
Definition command.h:60
const std::string & GetName() const
Definition command.h:61
void PrintHelp()
Definition command.cpp:47
int Perform(KIWAY &aKiway)
Entry point to processing commands from args and doing work.
Definition command.cpp:55
A KIFACE implementation.
Definition kiface_base.h:39
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
Definition kiway.h:315
void OnKiwayEnd()
Definition kiway.cpp:815
void LoadGlobalTables(std::initializer_list< LIBRARY_TABLE_TYPE > aTablesToLoad={})
(Re)loads the global library tables in the given list, or all tables if no list is given
virtual wxApp & App()
Return a bare naked wxApp which may come from wxPython, SINGLE_TOP, or kicad.exe.
Definition pgm_base.cpp:211
int m_argcUtf8
Definition pgm_base.h:449
std::unique_ptr< SETTINGS_MANAGER > m_settings_manager
Definition pgm_base.h:411
void Destroy()
Definition pgm_base.cpp:190
char ** m_argvUtf8
argv parameters converted to utf8 form because wxWidgets has opinions.
Definition pgm_base.h:447
void HandleException(std::exception_ptr aPtr, bool aUnhandled=false)
A exception handler to be used at the top level if exceptions bubble up that for.
Definition pgm_base.cpp:802
void BuildArgvUtf8()
Builds the UTF8 based argv variable.
Definition pgm_base.cpp:282
bool InitPgm(bool aHeadless=false, bool aIsUnitTest=false)
Initialize this program.
Definition pgm_base.cpp:327
virtual SETTINGS_MANAGER & GetSettingsManager() const
Definition pgm_base.h:130
virtual LIBRARY_MANAGER & GetLibraryManager() const
Definition pgm_base.h:132
void SaveCommonSettings()
Save the program (process) settings subset which are stored .kicad_common.
Definition pgm_base.cpp:532
PGM_KICAD extends PGM_BASE to bring in FileHistory() and PdfBrowser() which were moved from EDA_APP i...
Definition pgm_kicad.h:42
bool OnPgmInit()
Definition kicad.cpp:94
void Destroy()
Definition kicad.cpp:449
void MacOpenFile(const wxString &aFileName) override
Specific to MacOSX (not used under Linux or Windows).
Definition kicad.cpp:436
void OnPgmExit()
Definition kicad.cpp:408
APP_SETTINGS_BASE * PgmSettings()
Definition pgm_kicad.h:59
int OnPgmRun()
Definition kicad.cpp:402
BIN_MOD m_bm
Definition pgm_kicad.h:72
Container for project specific data.
Definition project.h:66
T * RegisterSettings(T *aSettings, bool aLoadNow=true)
Take ownership of the pointer passed in.
void SetKiway(KIWAY *aKiway)
Associate this setting manager with the given Kiway.
#define ARG_HELP
Definition command.h:30
#define UTF8STDSTR(s)
Definition command.h:27
#define ARG_HELP_DESC
Definition command.h:32
#define ARG_VERSION
Definition command.h:29
#define ARG_HELP_SHORT
Definition command.h:31
#define _(s)
const wxChar *const kicadTraceKeyEvent
Flag to enable wxKeyEvent debug tracing.
PROJECT & Prj()
Definition kicad.cpp:644
static CLI::PCB_EXPORT_SVG_COMMAND exportPcbSvgCmd
static CLI::SCH_EXPORT_PLOT_COMMAND exportSchHpglCmd
static CLI::SCH_EXPORT_PLOT_COMMAND exportSchSvgCmd
static CLI::PCB_EXPORT_3D_COMMAND exportPcbVrmlCmd
static CLI::GERBER_INFO_COMMAND gerberInfoCmd
static CLI::PCB_EXPORT_STATS_COMMAND exportPcbStatsCmd
static CLI::PCB_EXPORT_DXF_COMMAND exportPcbDxfCmd
static CLI::SCH_ERC_COMMAND schErcCmd
static CLI::PCB_EXPORT_HPGL_COMMAND exportPcbHpglCmd
static CLI::PCB_DRC_COMMAND pcbDrcCmd
static std::vector< std::string > preprocessArgs(int argc, char **argv)
Pre-process command line arguments to handle negative numeric values.
static CLI::PCB_IMPORT_COMMAND pcbImportCmd
static CLI::FP_EXPORT_SVG_COMMAND fpExportSvgCmd
static CLI::PCB_EXPORT_COMMAND exportPcbCmd
static CLI::PCB_RENDER_COMMAND pcbRenderCmd
static bool looksLikeNegativeVectorValue(const std::string &aValue)
Check if a string looks like a numeric vector value that happens to start with a minus sign.
static CLI::SYM_UPGRADE_COMMAND symUpgradeCmd
static CLI::FP_EXPORT_COMMAND fpExportCmd
static CLI::SCH_EXPORT_PYTHONBOM_COMMAND exportSchPythonBomCmd
static CLI::FP_UPGRADE_COMMAND fpUpgradeCmd
static CLI::SCH_EXPORT_PLOT_COMMAND exportSchPdfCmd
static void printHelp(argparse::ArgumentParser &argParser)
static CLI::JOBSET_RUN_COMMAND jobsetRunCmd
static CLI::PCB_UPGRADE_COMMAND pcbUpgradeCmd
static CLI::PCB_EXPORT_POS_COMMAND exportPcbPosCmd
static CLI::GERBER_DIFF_COMMAND gerberDiffCmd
static CLI::PCB_EXPORT_PS_COMMAND exportPcbPsCmd
static CLI::GERBER_COMMAND gerberCmd
static CLI::SYM_COMMAND symCmd
static CLI::PCB_EXPORT_3D_COMMAND exportPcbStepCmd
static CLI::PCB_EXPORT_3D_COMMAND exportPcbPlyCmd
static CLI::PCB_EXPORT_GERBERS_COMMAND exportPcbGerbersCmd
static PGM_KICAD program
static CLI::SCH_EXPORT_BOM_COMMAND exportSchBomCmd
static CLI::GERBER_CONVERT_PNG_COMMAND gerberConvertPngCmd
static CLI::PCB_EXPORT_IPCD356_COMMAND exportPcbIpcD356Cmd
static CLI::SCH_COMMAND schCmd
static CLI::PCB_COMMAND pcbCmd
static CLI::PCB_EXPORT_3D_COMMAND exportPcb3DPDFCmd
static std::vector< COMMAND_ENTRY > commandStack
static CLI::PCB_EXPORT_DRILL_COMMAND exportPcbDrillCmd
static CLI::PCB_EXPORT_IPC2581_COMMAND exportPcbIpc2581Cmd
static CLI::SCH_EXPORT_PLOT_COMMAND exportSchDxfCmd
static CLI::JOBSET_COMMAND jobsetCmd
static CLI::SYM_EXPORT_COMMAND symExportCmd
static CLI::SYM_EXPORT_SVG_COMMAND symExportSvgCmd
static COMMAND_ENTRY * recurseArgParserSubCommandUsed(argparse::ArgumentParser &aArgParser, COMMAND_ENTRY &aEntry)
static CLI::PCB_EXPORT_3D_COMMAND exportPcbU3DCmd
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
static CLI::PCB_EXPORT_ODB_COMMAND exportPcbOdbCmd
static CLI::VERSION_COMMAND versionCmd
static CLI::PCB_EXPORT_3D_COMMAND exportPcbStlCmd
static CLI::PCB_EXPORT_PDF_COMMAND exportPcbPdfCmd
static CLI::SCH_UPGRADE_COMMAND schUpgradeCmd
static CLI::PCB_EXPORT_3D_COMMAND exportPcbXaoCmd
static void recurseArgParserBuild(argparse::ArgumentParser &aArgParser, COMMAND_ENTRY &aEntry)
static CLI::SCH_EXPORT_NETLIST_COMMAND exportSchNetlistCmd
static CLI::SCH_EXPORT_PLOT_COMMAND exportSchPostscriptCmd
static CLI::PCB_EXPORT_GENCAD_COMMAND exportPcbGencadCmd
static CLI::GERBER_CONVERT_COMMAND gerberConvertCmd
static CLI::PCB_EXPORT_3D_COMMAND exportPcbStepzCmd
static CLI::FP_COMMAND fpCmd
static CLI::PCB_EXPORT_3D_COMMAND exportPcbGlbCmd
static CLI::SCH_EXPORT_COMMAND exportSchCmd
static CLI::PCB_EXPORT_3D_COMMAND exportPcbBrepCmd
#define KFCTL_CPP_PROJECT_SUITE
Running under C++ project mgr, possibly with others.
Definition kiway.h:164
#define KFCTL_CLI
Running as CLI app.
Definition kiway.h:165
static const int ERR_ARGS
Definition exit_codes.h:31
static const int AVOID_CLOSING
Definition exit_codes.h:28
bool Init()
Perform application-specific initialization tasks.
Definition unix/app.cpp:40
void Init()
Perform environment initialization tasks.
void SetPgm(PGM_BASE *pgm)
PGM_BASE & Pgm()
The global program "get" accessor.
CITER next(CITER it)
Definition ptree.cpp:124
PGM_SINGLE_TOP program
KIWAY Kiway(KFCTL_STANDALONE)
std::vector< FAB_LAYER_COLOR > dummy
wxString From_UTF8(const char *cstring)
Not publicly visible because most of the action is in PGM_KICAD these days.
int OnExit() override
bool OnInit() override
int FilterEvent(wxEvent &aEvent) override
int OnRun() override
COMMAND_ENTRY(CLI::COMMAND *aHandler)
COMMAND_ENTRY(CLI::COMMAND *aHandler, std::vector< COMMAND_ENTRY > aSub)
CLI::COMMAND * handler
std::vector< COMMAND_ENTRY > subCommands
System directories search utilities.
wxString result
Test unit parsing edge cases and error handling.
thread_pool & GetKiCadThreadPool()
Get a reference to the current thread pool.
wxString dump(const wxArrayString &aArray)
Debug helper for printing wxArrayString contents.
wxLogTrace helper definitions.