37#include <wx/stdpaths.h>
52 Bracket_Windows =
'%',
60 std::function<bool( wxString* )> projectResolver =
61 [&]( wxString* token ) ->
bool
71 const std::function<
bool( wxString* )>* aResolver )
74 size_t sourceLen = aSource.length();
76 newbuf.Alloc( sourceLen );
78 for(
size_t i = 0; i < sourceLen; ++i )
80 if( aSource[i] ==
'$' && i + 1 < sourceLen && aSource[i+1] ==
'{' )
84 for( i = i + 2; i < sourceLen; ++i )
86 if( aSource[i] ==
'}' )
89 token.append( aSource[i] );
95 if( aResolver && (*aResolver)( &token ) )
97 newbuf.append( token );
102 newbuf.append(
"${" + token +
"}" );
107 newbuf.append( aSource[i] );
117 std::function<bool( wxString* )> tokenExtractor =
118 [&]( wxString* token ) ->
bool
129 return aSource.StartsWith( wxS(
"${" ) );
141 if(
auto [
_, result ] = aSet->insert( str ); !result )
145 size_t strlen = str.length();
148 strResult.Alloc( strlen );
150 auto getVersionedEnvVar = [](
const wxString& aMatch, wxString& aResult ) ->
bool
154 if( var.Matches( aMatch ) )
156 const auto value = ENV_VAR::GetEnvVar<wxString>( var );
169 for(
size_t n = 0; n < strlen; n++ )
171 wxUniChar str_n = str[n];
173 switch( str_n.GetValue() )
182 if( str_n == wxT(
'%' ) )
183 bracket = Bracket_Windows;
186 if( n == strlen - 1 )
192 switch( str[n + 1].GetValue() )
214 wxUniChar str_m = str[m];
216 while( wxIsalnum( str_m ) || str_m == wxT(
'_' ) || str_m == wxT(
':' ) )
227 wxString strVarName( str.c_str() + n + 1, m - n - 1 );
231 bool expanded =
false;
232 wxString tmp = strVarName;
239 else if( wxGetEnv( strVarName, &tmp ) )
248 else if( strVarName.Contains(
"KISYS3DMOD") || strVarName.Matches(
"KICAD*_3DMODEL_DIR" ) )
250 if( getVersionedEnvVar(
"KICAD*_3DMODEL_DIR", strResult ) )
253 else if( strVarName.Matches(
"KICAD*_SYMBOL_DIR" ) )
255 if( getVersionedEnvVar(
"KICAD*_SYMBOL_DIR", strResult ) )
258 else if( strVarName.Matches(
"KICAD*_FOOTPRINT_DIR" ) )
260 if( getVersionedEnvVar(
"KICAD*_FOOTPRINT_DIR", strResult ) )
267 if ( bracket != Bracket_Windows )
270 strResult << str[n - 1];
272 strResult << str_n << strVarName;
278 if( m == strlen || str_m != (wxChar)bracket )
287 wxLogWarning(
_(
"Environment variables expansion failed: missing '%c' "
288 "at position %u in '%s'." ),
289 (
char)bracket, (
unsigned int) (m + 1), str.c_str() );
296 strResult << (wxChar)bracket;
309 if( n < strlen - 1 && (str[n + 1] == wxT(
'%' ) || str[n + 1] == wxT(
'$' )) )
323 std::set<wxString> loop_check;
324 auto first_pos = strResult.find_first_of( wxS(
"{(%" ) );
325 auto last_pos = strResult.find_last_of( wxS(
"})%" ) );
327 if( first_pos != strResult.npos && last_pos != strResult.npos && first_pos != last_pos )
338 static std::mutex getenv_mutex;
340 std::lock_guard<std::mutex> lock( getenv_mutex );
354 if( url.GetError() == wxURL_NOERR )
363 const wxString& aBaseFilename,
367 wxString baseFilePath = wxFileName( aBaseFilename ).GetPath();
371 if( !aTargetFullFileName->MakeAbsolute( baseFilePath ) )
375 msg.Printf(
_(
"Cannot make path '%s' absolute with respect to '%s'." ),
376 aTargetFullFileName->GetPath(),
385 wxString outputPath( aTargetFullFileName->GetPath() );
387 if( !wxFileName::DirExists( outputPath ) )
390 if( wxFileName::Mkdir( outputPath, wxS_DIR_DEFAULT, wxPATH_MKDIR_FULL ) )
394 msg.Printf(
_(
"Output directory '%s' created." ), outputPath );
403 msg.Printf(
_(
"Cannot create output directory '%s'." ), outputPath );
417 wxString newFilename( aFilename );
422 if( newFilename.Lower().AfterLast(
'.' ) != aExtension )
424 if( newFilename.Last() !=
'.' )
425 newFilename.Append(
'.' );
427 newFilename.Append( aExtension );
464 if( dot_special && (*n ==
'.') )
561#if wxUSE_DATETIME && defined(__WIN32__) && !defined(__WXMICROWIN__)
567static wxInt64 EPOCH_OFFSET_IN_MSEC = wxLL(11644473600000);
570static void ConvertFileTimeToWx( wxDateTime* dt,
const FILETIME& ft )
572 wxLongLong t( ft.dwHighDateTime, ft.dwLowDateTime );
574 t -= EPOCH_OFFSET_IN_MSEC;
576 *dt = wxDateTime( t );
590long long TimestampDir(
const wxString& aDirPath,
const wxString& aFilespec )
592 long long timestamp = 0;
594#if defined( __WIN32__ )
599 std::wstring filespec( aDirPath.t_str() );
601 filespec += aFilespec.t_str();
603 WIN32_FIND_DATA findData;
604 wxDateTime lastModDate;
606 HANDLE fileHandle = ::FindFirstFile( filespec.data(), &findData );
608 if( fileHandle != INVALID_HANDLE_VALUE )
612 ConvertFileTimeToWx( &lastModDate, findData.ftLastWriteTime );
613 timestamp += lastModDate.GetValue().GetValue();
616 timestamp += findData.nFileSizeLow;
618 while ( FindNextFile( fileHandle, &findData ) != 0 );
621 FindClose( fileHandle );
625 std::string filespec( aFilespec.fn_str() );
626 std::string dir_path( aDirPath.fn_str() );
628 DIR* dir = opendir( dir_path.c_str() );
632 for( dirent* dir_entry = readdir( dir ); dir_entry; dir_entry = readdir( dir ) )
634 if( !
matchWild( filespec.c_str(), dir_entry->d_name,
true ) )
637 std::string entry_path = dir_path +
'/' + dir_entry->d_name;
638 struct stat entry_stat;
640 if( wxCRT_Lstat( entry_path.c_str(), &entry_stat ) == 0 )
643 if( S_ISLNK( entry_stat.st_mode ) )
645 char buffer[ PATH_MAX + 1 ];
646 ssize_t pathLen = readlink( entry_path.c_str(), buffer, PATH_MAX );
650 struct stat linked_stat;
651 buffer[ pathLen ] =
'\0';
652 entry_path = dir_path + buffer;
654 if( wxCRT_Lstat( entry_path.c_str(), &linked_stat ) == 0 )
656 entry_stat = linked_stat;
666 if( S_ISREG( entry_stat.st_mode ) )
668 timestamp += entry_stat.st_mtime * 1000;
671 timestamp += entry_stat.st_size;
677 timestamp += (signed) std::hash<std::string>{}( std::string( dir_entry->d_name ) );
694 wxMessageDialog dialog(
nullptr,
_(
"This operating system is not supported "
695 "by KiCad and its dependencies." ),
696 _(
"Unsupported Operating System" ),
697 wxOK | wxICON_EXCLAMATION );
699 dialog.SetExtendedMessage(
_(
"Any issues with KiCad on this system cannot "
700 "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)=0
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 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.
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 IsTextVar(const wxString &aSource)
Returns true if the string is a text var, e.g starts with ${.
wxString ExpandTextVars(const wxString &aSource, const PROJECT *aProject)
const wxString ResolveUriByEnvVars(const wxString &aUri, PROJECT *aProject)
Replace any environment and/or text variables in file-path uris (leaving network-path URIs alone).
wxString GetTextVars(const wxString &aSource)
Returns any variables unexpanded, e.g.
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/...
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 ENV_VAR_LIST & GetPredefinedEnvVars()
Get the list of pre-defined environment variables.