37#include <wx/stdpaths.h>
53 Bracket_Windows =
'%',
61 std::function<bool( wxString* )> projectResolver =
62 [&]( wxString* token ) ->
bool
72 const std::function<
bool( wxString* )>* aResolver,
int aFlags )
74 static wxRegEx userDefinedWarningError( wxS(
"^(ERC|DRC)_(WARNING|ERROR).*$" ) );
76 size_t sourceLen = aSource.length();
78 newbuf.Alloc( sourceLen );
80 for(
size_t i = 0; i < sourceLen; ++i )
82 if( aSource[i] ==
'$' && i + 1 < sourceLen && aSource[i+1] ==
'{' )
86 for( i = i + 2; i < sourceLen; ++i )
88 if( aSource[i] ==
'}' )
91 token.append( aSource[i] );
97 if( ( aFlags &
FOR_ERC_DRC ) == 0 && userDefinedWarningError.Matches( token ) )
101 else if( aResolver && (*aResolver)( &token ) )
103 newbuf.append( token );
108 newbuf.append(
"${" + token +
"}" );
113 newbuf.append( aSource[i] );
123 std::function<bool( wxString* )> tokenExtractor =
124 [&]( wxString* token ) ->
bool
136 static wxRegEx expr( wxS(
"^\\$\\{\\w*\\}$" ) );
137 return expr.Matches( aSource );
145 std::set<wxString>* aSet =
nullptr )
150 if(
auto [
_, result ] = aSet->insert( str ); !result )
154 size_t strlen = str.length();
157 strResult.Alloc( strlen );
159 auto getVersionedEnvVar =
160 [](
const wxString& aMatch, wxString& aResult ) ->
bool
164 if( var.Matches( aMatch ) )
166 const auto value = ENV_VAR::GetEnvVar<wxString>( var );
179 for(
size_t n = 0; n < strlen; n++ )
181 wxUniChar str_n = str[n];
183 switch( str_n.GetValue() )
192 if( str_n == wxT(
'%' ) )
194 bracket = Bracket_Windows;
198 if( n == strlen - 1 )
204 switch( str[n + 1].GetValue() )
226 wxUniChar str_m = str[m];
228 while( wxIsalnum( str_m ) || str_m == wxT(
'_' ) || str_m == wxT(
':' ) )
239 wxString strVarName( str.c_str() + n + 1, m - n - 1 );
243 bool expanded =
false;
244 wxString tmp = strVarName;
251 else if( wxGetEnv( strVarName, &tmp ) )
260 else if( strVarName.Contains(
"KISYS3DMOD")
261 || strVarName.Matches(
"KICAD*_3DMODEL_DIR" ) )
263 if( getVersionedEnvVar(
"KICAD*_3DMODEL_DIR", strResult ) )
266 else if( strVarName.Matches(
"KICAD*_SYMBOL_DIR" ) )
268 if( getVersionedEnvVar(
"KICAD*_SYMBOL_DIR", strResult ) )
271 else if( strVarName.Matches(
"KICAD*_FOOTPRINT_DIR" ) )
273 if( getVersionedEnvVar(
"KICAD*_FOOTPRINT_DIR", strResult ) )
276 else if( strVarName.Matches(
"KICAD*_3RD_PARTY" ) )
278 if( getVersionedEnvVar(
"KICAD*_3RD_PARTY", strResult ) )
285 if ( bracket != Bracket_Windows )
288 strResult << str[n - 1];
290 strResult << str_n << strVarName;
296 if( m == strlen || str_m != (wxChar)bracket )
305 wxLogWarning(
_(
"Environment variables expansion failed: missing '%c' "
306 "at position %u in '%s'." ),
307 (
char)bracket, (
unsigned int) (m + 1), str.c_str() );
314 strResult << (wxChar)bracket;
327 if( n < strlen - 1 && (str[n + 1] == wxT(
'%' ) || str[n + 1] == wxT(
'$' ) ) )
342 std::set<wxString> loop_check;
343 auto first_pos = strResult.find_first_of( wxS(
"{(%" ) );
344 auto last_pos = strResult.find_last_of( wxS(
"})%" ) );
346 if( first_pos != strResult.npos && last_pos != strResult.npos && first_pos != last_pos )
357 static std::mutex getenv_mutex;
359 std::lock_guard<std::mutex> lock( getenv_mutex );
375 const wxString& aBaseFilename,
379 wxString baseFilePath = wxFileName( aBaseFilename ).GetPath();
383 if( !aTargetFullFileName->MakeAbsolute( baseFilePath ) )
387 msg.Printf(
_(
"Cannot make path '%s' absolute with respect to '%s'." ),
388 aTargetFullFileName->GetPath(),
397 wxString outputPath( aTargetFullFileName->GetPath() );
399 if( !wxFileName::DirExists( outputPath ) )
402 if( wxFileName::Mkdir( outputPath, wxS_DIR_DEFAULT, wxPATH_MKDIR_FULL ) )
406 msg.Printf(
_(
"Output directory '%s' created." ), outputPath );
415 msg.Printf(
_(
"Cannot create output directory '%s'." ), outputPath );
429 wxString newFilename( aFilename );
434 if( newFilename.Lower().AfterLast(
'.' ) != aExtension )
436 if( newFilename.Last() !=
'.' )
437 newFilename.Append(
'.' );
439 newFilename.Append( aExtension );
476 if( dot_special && (*n ==
'.') )
573#if wxUSE_DATETIME && defined( __WIN32__ ) && !defined( __WXMICROWIN__ )
579static wxInt64 EPOCH_OFFSET_IN_MSEC = wxLL( 11644473600000 );
582static void ConvertFileTimeToWx( wxDateTime* dt,
const FILETIME& ft )
584 wxLongLong t( ft.dwHighDateTime, ft.dwLowDateTime );
586 t -= EPOCH_OFFSET_IN_MSEC;
588 *dt = wxDateTime( t );
602long long TimestampDir(
const wxString& aDirPath,
const wxString& aFilespec )
604 long long timestamp = 0;
606#if defined( __WIN32__ )
611 std::wstring filespec( aDirPath.t_str() );
613 filespec += aFilespec.t_str();
615 WIN32_FIND_DATA findData;
616 wxDateTime lastModDate;
618 HANDLE fileHandle = ::FindFirstFile( filespec.data(), &findData );
620 if( fileHandle != INVALID_HANDLE_VALUE )
624 ConvertFileTimeToWx( &lastModDate, findData.ftLastWriteTime );
625 timestamp += lastModDate.GetValue().GetValue();
628 timestamp += findData.nFileSizeLow;
630 while ( FindNextFile( fileHandle, &findData ) != 0 );
633 FindClose( fileHandle );
637 std::string filespec( aFilespec.fn_str() );
638 std::string dir_path( aDirPath.fn_str() );
640 DIR* dir = opendir( dir_path.c_str() );
644 for( dirent* dir_entry = readdir( dir ); dir_entry; dir_entry = readdir( dir ) )
646 if( !
matchWild( filespec.c_str(), dir_entry->d_name,
true ) )
649 std::string entry_path = dir_path +
'/' + dir_entry->d_name;
650 struct stat entry_stat;
652 if( wxCRT_Lstat( entry_path.c_str(), &entry_stat ) == 0 )
655 if( S_ISLNK( entry_stat.st_mode ) )
657 char buffer[ PATH_MAX + 1 ];
658 ssize_t pathLen = readlink( entry_path.c_str(), buffer, PATH_MAX );
662 struct stat linked_stat;
663 buffer[ pathLen ] =
'\0';
664 entry_path = dir_path + buffer;
666 if( wxCRT_Lstat( entry_path.c_str(), &linked_stat ) == 0 )
668 entry_stat = linked_stat;
678 if( S_ISREG( entry_stat.st_mode ) )
680 timestamp += entry_stat.st_mtime * 1000;
683 timestamp += entry_stat.st_size;
689 timestamp += (signed) std::hash<std::string>{}( std::string( dir_entry->d_name ) );
706 wxMessageDialog dialog(
nullptr,
_(
"This operating system is not supported "
707 "by KiCad and its dependencies." ),
708 _(
"Unsupported Operating System" ),
709 wxOK | wxICON_EXCLAMATION );
711 dialog.SetExtendedMessage(
_(
"Any issues with KiCad on this system cannot "
712 "be reported to the official bugtracker." ) );
Container for project specific data.
virtual bool TextVarResolver(wxString *aToken) const
A pure virtual class used to derive REPORTER objects from.
virtual REPORTER & Report(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)
Report a string with a given severity.
const wxString ExpandEnvVarSubstitutions(const wxString &aString, const PROJECT *aProject)
Replace any environment variable & text variable references with their values.
wxString GetGeneratedFieldDisplayName(const wxString &aSource)
Returns any variables unexpanded, e.g.
const wxString ResolveUriByEnvVars(const wxString &aUri, const PROJECT *aProject)
Replace any environment and/or text variables in URIs.
wxString EnsureFileExtension(const wxString &aFilename, const wxString &aExtension)
It's annoying to throw up nag dialogs when the extension isn't right.
bool WarnUserIfOperatingSystemUnsupported()
Checks if the operating system is explicitly unsupported and displays a disclaimer message box.
wxString ExpandTextVars(const wxString &aSource, const PROJECT *aProject, int aFlags)
bool matchWild(const char *pat, const char *text, bool dot_special)
Performance enhancements to file and directory operations.
bool EnsureFileDirectoryExists(wxFileName *aTargetFullFileName, const wxString &aBaseFilename, REPORTER *aReporter)
Make aTargetFullFileName absolute and create the path of this file if it doesn't yet exist.
wxString KIwxExpandEnvVars(const wxString &str, const PROJECT *aProject, std::set< wxString > *aSet=nullptr)
bool IsGeneratedField(const wxString &aSource)
Returns true if the string is generated, e.g contains a single text var reference.
long long TimestampDir(const wxString &aDirPath, const wxString &aFilespec)
A copy of ConvertFileTimeToWx() because wxWidgets left it as a static function private to src/common/...
#define FOR_ERC_DRC
Expand '${var-name}' templates in text.
Base window classes and related definitions.
Functions related to environment variables, including help functions.
This file contains miscellaneous commonly used macros and functions.
#define KI_FALLTHROUGH
The KI_FALLTHROUGH macro is to be used when switch statement cases should purposely fallthrough from ...
KICOMMON_API const std::vector< wxString > & GetPredefinedEnvVars()
Get the list of pre-defined environment variables.