common.cpp File Reference

#include <eda_base_frame.h>
#include <kiplatform/app.h>
#include <project.h>
#include <common.h>
#include <env_vars.h>
#include <reporter.h>
#include <macros.h>
#include <mutex>
#include <wx/config.h>
#include <wx/log.h>
#include <wx/msgdlg.h>
#include <wx/stdpaths.h>
#include <wx/url.h>
#include <wx/utils.h>

Go to the source code of this file.

Enumerations
enum	Bracket { Bracket_None , Bracket_Normal = ')' , Bracket_Curly = '}' , Bracket_Max }

Functions
wxString	ExpandTextVars (const wxString &aSource, const PROJECT *aProject)
wxString	ExpandTextVars (const wxString &aSource, const std::function< bool(wxString *)> *aResolver)
	Expand '${var-name}' templates in text. More...
wxString	KIwxExpandEnvVars (const wxString &str, const PROJECT *aProject, std::set< wxString > *aSet=nullptr)
const wxString	ExpandEnvVarSubstitutions (const wxString &aString, const PROJECT *aProject)
	Replace any environment variable & text variable references with their values. More...
const wxString	ResolveUriByEnvVars (const wxString &aUri, PROJECT *aProject)
	Replace any environment and/or text variables in file-path uris (leaving network-path URIs alone). More...
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. More...
bool	matchWild (const char *pat, const char *text, bool dot_special)
	Performance enhancements to file and directory operations. More...
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/filename.cpp. More...
bool	WarnUserIfOperatingSystemUnsupported ()
	Checks if the operating system is explicitly unsupported and displays a disclaimer message box. More...

Enumeration Type Documentation

Bracket

enum Bracket

Enumerator
Bracket_None
Bracket_Normal
Bracket_Curly
Bracket_Max

Definition at line 46 of file common.cpp.

{
 Bracket_None,
 Bracket_Normal = ')',
 Bracket_Curly = '}',
#ifdef __WINDOWS__
 Bracket_Windows = '%', // yeah, Windows people are a bit strange ;-)
#endif
 Bracket_Max
};

Function Documentation

EnsureFileDirectoryExists()

bool EnsureFileDirectoryExists	(	wxFileName *	aTargetFullFileName,
		const wxString &	aBaseFilename,
		REPORTER *	aReporter = nullptr
	)

Make aTargetFullFileName absolute and create the path of this file if it doesn't yet exist.

Parameters

aTargetFullFileName	the wxFileName containing the full path and file name to modify. The path may be absolute or relative to aBaseFilename .
aBaseFilename	a full filename. Only its path is used to set the aTargetFullFileName path.
aReporter	a point to a REPORTER object use to show messages (can be NULL)

Returns

true if aOutputDir already exists or was successfully created.

Definition at line 327 of file common.cpp.

{
 wxString msg;
 wxString baseFilePath = wxFileName( aBaseFilename ).GetPath();
 
 // make aTargetFullFileName path, which is relative to aBaseFilename path (if it is not
 // already an absolute path) absolute:
 if( !aTargetFullFileName->MakeAbsolute( baseFilePath ) )
 {
 if( aReporter )
 {
 msg.Printf( _( "Cannot make path '%s' absolute with respect to '%s'." ),
 aTargetFullFileName->GetPath(),
 baseFilePath );
 aReporter->Report( msg, RPT_SEVERITY_ERROR );
 }
 
 return false;
 }
 
 // Ensure the path of aTargetFullFileName exists, and create it if needed:
 wxString outputPath( aTargetFullFileName->GetPath() );
 
 if( !wxFileName::DirExists( outputPath ) )
 {
 // Make every directory provided when the provided path doesn't exist
 if( wxFileName::Mkdir( outputPath, wxS_DIR_DEFAULT, wxPATH_MKDIR_FULL ) )
 {
 if( aReporter )
 {
 msg.Printf( _( "Output directory '%s' created." ), outputPath );
 aReporter->Report( msg, RPT_SEVERITY_INFO );
 return true;
 }
 }
 else
 {
 if( aReporter )
 {
 msg.Printf( _( "Cannot create output directory '%s'." ), outputPath );
 aReporter->Report( msg, RPT_SEVERITY_ERROR );
 }
 
 return false;
 }
 }
 
 return true;
}

References _, REPORTER::Report(), RPT_SEVERITY_ERROR, and RPT_SEVERITY_INFO.

Referenced by DIALOG_GEN_FOOTPRINT_POSITION::CreateAsciiFiles(), DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), SCH_PLOTTER::createPlotFileName(), DIALOG_EXPORT_SVG::ExportSVGFile(), DIALOG_GENDRILL::GenDrillAndMapFiles(), PLOT_CONTROLLER::OpenPlotfile(), and DIALOG_PLOT::Plot().

ExpandEnvVarSubstitutions()

const wxString ExpandEnvVarSubstitutions	(	const wxString &	aString,
		const PROJECT *	aProject
	)

Replace any environment variable & text variable references with their values.

Parameters

aString

a string containing (perhaps) references to env var

Returns

the expanded environment variable.

Definition at line 299 of file common.cpp.

{
 // wxGetenv( wchar_t* ) is not re-entrant on linux.
 // Put a lock on multithreaded use of wxGetenv( wchar_t* ), called from wxEpandEnvVars(),
 static std::mutex getenv_mutex;
 
 std::lock_guard<std::mutex> lock( getenv_mutex );
 
 // We reserve the right to do this another way, by providing our own member function.
 return KIwxExpandEnvVars( aString, aProject );
}

References KIwxExpandEnvVars().

Referenced by FILENAME_RESOLVER::addPath(), FILENAME_RESOLVER::checkEnvVarPath(), S3D_PLUGIN_MANAGER::checkPluginName(), DIALOG_GEN_FOOTPRINT_POSITION::CreateAsciiFiles(), DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), FILENAME_RESOLVER::createPathList(), DIALOG_EXPORT_SVG::ExportSVGFile(), DIALOG_GENDRILL::GenDrillAndMapFiles(), LIB_TABLE_ROW::GetFullURI(), DIALOG_PLOT_SCHEMATIC::getOutputPath(), TEXT_BUTTON_FILE_BROWSER::OnButtonClick(), PANEL_SYM_LIB_TABLE::onConvertLegacyLibraries(), DIALOG_GENDRILL::OnGenReportFile(), DIALOG_PLOT_SCHEMATIC::OnOutputDirectoryBrowseClicked(), DIALOG_EXPORT_SVG::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), DIALOG_GENDRILL::OnOutputDirectoryBrowseClicked(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_PAGES_SETTINGS::OnWksFileSelection(), PLOT_CONTROLLER::OpenPlotfile(), DIALOG_PLOT::Plot(), SIM_LIB_MGR::ResolveLibraryPath(), FILENAME_RESOLVER::ResolvePath(), DS_DATA_MODEL::ResolvePath(), ResolveUriByEnvVars(), S3D_CACHE::Set3DConfigDir(), FILENAME_RESOLVER::Set3DConfigDir(), FILENAME_RESOLVER::SetProject(), FILENAME_RESOLVER::ShortenPath(), ERC_TESTER::TestTextVars(), and NETLIST_EXPORTER_SPICE::writeInclude().

ExpandTextVars() [1/2]

wxString ExpandTextVars	(	const wxString &	aSource,
		const PROJECT *	aProject
	)

Definition at line 58 of file common.cpp.

{
 std::function<bool( wxString* )> projectResolver =
 [&]( wxString* token ) -> bool
 {
 return aProject->TextVarResolver( token );
 };
 
 return ExpandTextVars( aSource, &projectResolver );
}

References ExpandTextVars(), and PROJECT::TextVarResolver().

Referenced by AddGerberX2Header(), GERBER_JOBFILE_WRITER::addJSONGeneralSpecs(), DS_DRAW_ITEM_LIST::BuildFullText(), DIALOG_GEN_FOOTPRINT_POSITION::CreateAsciiFiles(), DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), CreateHeaderInfoData(), SCH_PLOTTER::createPDFFile(), KIGFX::expandLibItemTextVars(), ExpandTextVars(), DIALOG_EXPORT_SVG::ExportSVGFile(), DIALOG_GENDRILL::GenDrillAndMapFiles(), DIALOG_PLOT_SCHEMATIC::getOutputPath(), SCH_FIELD::GetShownText(), SCH_LABEL_BASE::GetShownText(), SCH_TEXT::GetShownText(), SCH_TEXTBOX::GetShownText(), FP_TEXT::GetShownText(), FP_TEXTBOX::GetShownText(), PCB_TEXT::GetShownText(), PCB_TEXTBOX::GetShownText(), NETLIST_EXPORTER_XML::makeDesignHeader(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), PLOT_CONTROLLER::OpenPlotfile(), DIALOG_PLOT::Plot(), ResolveUriByEnvVars(), and TITLE_BLOCK::TextVarResolver().

ExpandTextVars() [2/2]

wxString ExpandTextVars	(	const wxString &	aSource,
		const std::function< bool(wxString *)> *	aResolver
	)

Expand '${var-name}' templates in text.

Definition at line 70 of file common.cpp.

{
 wxString newbuf;
 size_t sourceLen = aSource.length();
 
 newbuf.Alloc( sourceLen ); // best guess (improves performance)
 
 for( size_t i = 0; i < sourceLen; ++i )
 {
 if( aSource[i] == '$' && i + 1 < sourceLen && aSource[i+1] == '{' )
 {
 wxString token;
 
 for( i = i + 2; i < sourceLen; ++i )
 {
 if( aSource[i] == '}' )
 break;
 else
 token.append( aSource[i] );
 }
 
 if( token.IsEmpty() )
 continue;
 
 if( aResolver && (*aResolver)( &token ) )
 {
 newbuf.append( token );
 }
 else
 {
 // Token not resolved: leave the reference unchanged
 newbuf.append( "${" + token + "}" );
 }
 }
 else
 {
 newbuf.append( aSource[i] );
 }
 }
 
 return newbuf;
}

KIwxExpandEnvVars()

wxString KIwxExpandEnvVars	(	const wxString &	str,
		const PROJECT *	aProject,
		std::set< wxString > *	aSet = nullptr
	)

Definition at line 118 of file common.cpp.

{
 // If the same string is inserted twice, we have a loop
 if( aSet )
 {
 if( auto [ _, result ] = aSet->insert( str ); !result )
 return str;
 }
 
 size_t strlen = str.length();
 
 wxString strResult;
 strResult.Alloc( strlen ); // best guess (improves performance)
 
 for( size_t n = 0; n < strlen; n++ )
 {
 wxUniChar str_n = str[n];
 
 switch( str_n.GetValue() )
 {
#ifdef __WINDOWS__
 case wxT( '%' ):
#endif // __WINDOWS__
 case wxT( '$' ):
 {
 Bracket bracket;
#ifdef __WINDOWS__
 if( str_n == wxT( '%' ) )
 bracket = Bracket_Windows;
 else
#endif // __WINDOWS__
 if( n == strlen - 1 )
 {
 bracket = Bracket_None;
 }
 else
 {
 switch( str[n + 1].GetValue() )
 {
 case wxT( '(' ):
 bracket = Bracket_Normal;
 str_n = str[++n]; // skip the bracket
 break;
 
 case wxT( '{' ):
 bracket = Bracket_Curly;
 str_n = str[++n]; // skip the bracket
 break;
 
 default:
 bracket = Bracket_None;
 }
 }
 
 size_t m = n + 1;
 
 if( m >= strlen )
 break;
 
 wxUniChar str_m = str[m];
 
 while( wxIsalnum( str_m ) || str_m == wxT( '_' ) || str_m == wxT( ':' ) )
 {
 if( ++m == strlen )
 {
 str_m = 0;
 break;
 }
 
 str_m = str[m];
 }
 
 wxString strVarName( str.c_str() + n + 1, m - n - 1 );
 
 // NB: use wxGetEnv instead of wxGetenv as otherwise variables
 // set through wxSetEnv may not be read correctly!
 bool expanded = false;
 wxString tmp = strVarName;
 
 if( aProject && aProject->TextVarResolver( &tmp ) )
 {
 strResult += tmp;
 expanded = true;
 }
 else if( wxGetEnv( strVarName, &tmp ) )
 {
 strResult += tmp;
 expanded = true;
 }
 // Replace unmatched older variables with current 3d model locations
 // If the user has the older model location defined, that will be matched
 // first above. But if they do not, this will ensure that their board still
 // displays correctly
 else if( strVarName.Contains( "KISYS3DMOD") || strVarName.Matches( "KICAD*_3DMODEL_DIR" ) )
 {
 for( auto& var : ENV_VAR::GetPredefinedEnvVars() )
 {
 if( var.Matches( "KICAD*_3DMODEL_DIR" ) )
 {
 const auto value = ENV_VAR::GetEnvVar<wxString>( var );
 
 if( !value )
 continue;
 
 strResult += *value;
 expanded = true;
 break;
 }
 }
 }
 else
 {
 // variable doesn't exist => don't change anything
#ifdef __WINDOWS__
 if ( bracket != Bracket_Windows )
#endif
 if ( bracket != Bracket_None )
 strResult << str[n - 1];
 
 strResult << str_n << strVarName;
 }
 
 // check the closing bracket
 if( bracket != Bracket_None )
 {
 if( m == strlen || str_m != (wxChar)bracket )
 {
 // under MSW it's common to have '%' characters in the registry
 // and it's annoying to have warnings about them each time, so
 // ignore them silently if they are not used for env vars
 //
 // under Unix, OTOH, this warning could be useful for the user to
 // understand why isn't the variable expanded as intended
#ifndef __WINDOWS__
 wxLogWarning( _( "Environment variables expansion failed: missing '%c' "
 "at position %u in '%s'." ),
 (char)bracket, (unsigned int) (m + 1), str.c_str() );
#endif // __WINDOWS__
 }
 else
 {
 // skip closing bracket unless the variables wasn't expanded
 if( !expanded )
 strResult << (wxChar)bracket;
 
 m++;
 }
 }
 
 n = m - 1; // skip variable name
 str_n = str[n];
 }
 break;
 
 case wxT( '\\' ):
 // backslash can be used to suppress special meaning of % and $
 if( n < strlen - 1 && (str[n + 1] == wxT( '%' ) || str[n + 1] == wxT( '$' )) )
 {
 str_n = str[++n];
 strResult += str_n;
 
 break;
 }
 KI_FALLTHROUGH;
 
 default:
 strResult += str_n;
 }
 }
 
 std::set<wxString> loop_check;
 auto first_pos = strResult.find_first_of( wxS( "{(%" ) );
 auto last_pos = strResult.find_last_of( wxS( "})%" ) );
 
 if( first_pos != strResult.npos && last_pos != strResult.npos && first_pos != last_pos )
 strResult = KIwxExpandEnvVars( strResult, aProject, aSet ? aSet : &loop_check );
 
 return strResult;
}

References _, Bracket_Curly, Bracket_None, Bracket_Normal, ENV_VAR::GetPredefinedEnvVars(), KI_FALLTHROUGH, KIwxExpandEnvVars(), and PROJECT::TextVarResolver().

Referenced by ExpandEnvVarSubstitutions(), and KIwxExpandEnvVars().

matchWild()

bool matchWild	(	const char *	pat,
		const char *	text,
		bool	dot_special
	)

Performance enhancements to file and directory operations.

Note: while it's annoying to have to make copies of wxWidgets stuff and then add platform-specific performance optimizations, the following routines offer SIGNIFICANT performance benefits. A copy of wxMatchWild(), which wxWidgets attributes to Douglas A. Lewis dalew[email protected][email protected][email protected]s.Buf[email protected]falo[email protected].EDU and ircII's reg.c.

This version is modified to skip any encoding conversions (for performance).

Definition at line 394 of file common.cpp.

{
 if( !*text )
 {
 /* Match if both are empty. */
 return !*pat;
 }
 
 const char *m = pat,
 *n = text,
 *ma = nullptr,
 *na = nullptr;
 int just = 0,
 acount = 0,
 count = 0;
 
 if( dot_special && (*n == '.') )
 {
 /* Never match so that hidden Unix files
 * are never found. */
 return false;
 }
 
 for(;;)
 {
 if( *m == '*' )
 {
 ma = ++m;
 na = n;
 just = 1;
 acount = count;
 }
 else if( *m == '?' )
 {
 m++;
 
 if( !*n++ )
 return false;
 }
 else
 {
 if( *m == '\\' )
 {
 m++;
 
 /* Quoting "nothing" is a bad thing */
 if( !*m )
 return false;
 }
 
 if( !*m )
 {
 /*
 * If we are out of both strings or we just
  * saw a wildcard, then we can say we have a
 * match
 */
 if( !*n )
 return true;
 
 if( just )
 return true;
 
 just = 0;
 goto not_matched;
 }
 
 /*
 * We could check for *n == NULL at this point, but
 * since it's more common to have a character there,
 * check to see if they match first (m and n) and
 * then if they don't match, THEN we can check for
 * the NULL of n
 */
 just = 0;
 
 if( *m == *n )
 {
 m++;
 count++;
 n++;
 }
 else
 {
 not_matched:
 
 /*
 * If there are no more characters in the
 * string, but we still need to find another
 * character (*m != NULL), then it will be
 * impossible to match it
 */
 if( !*n )
  return false;
 
 if( ma )
 {
 m = ma;
 n = ++na;
 count = acount;
 }
 else
 return false;
 }
 }
 }
}

References text.

Referenced by TimestampDir().

ResolveUriByEnvVars()

const wxString ResolveUriByEnvVars	(	const wxString &	aUri,
		PROJECT *	aProject
	)

Replace any environment and/or text variables in file-path uris (leaving network-path URIs alone).

Definition at line 312 of file common.cpp.

{
 wxString uri = ExpandTextVars( aUri, aProject );
 
 // URL-like URI: return as is.
 wxURL url( uri );
 
 if( url.GetError() == wxURL_NOERR )
 return uri;
 
 // Otherwise, the path points to a local file. Resolve environment variables if any.
 return ExpandEnvVarSubstitutions( aUri, aProject );
}

References ExpandEnvVarSubstitutions(), and ExpandTextVars().

Referenced by GetAssociatedDocument().

TimestampDir()

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/filename.cpp.

This routine offers SIGNIFICANT performance benefits over using wxWidgets to gather timestamps from matching files in a directory.

Parameters

aDirPath	is the directory to search.
aFilespec	is a (wildcarded) file spec to match against.

Returns

a hash of the last-mod-dates of all matching files in the directory.

Definition at line 536 of file common.cpp.

{
 long long timestamp = 0;
 
#if defined( __WIN32__ )
 // Win32 version.
 // Save time by not searching for each path twice: once in wxDir.GetNext() and once in
 // wxFileName.GetModificationTime(). Also cuts out wxWidgets' string-matching and case
 // conversion by staying on the MSW side of things.
 std::wstring filespec( aDirPath.t_str() );
 filespec += '\\';
 filespec += aFilespec.t_str();
 
 WIN32_FIND_DATA findData;
 wxDateTime lastModDate;
 
 HANDLE fileHandle = ::FindFirstFile( filespec.data(), &findData );
 
 if( fileHandle != INVALID_HANDLE_VALUE )
 {
 do
 {
 ConvertFileTimeToWx( &lastModDate, findData.ftLastWriteTime );
 timestamp += lastModDate.GetValue().GetValue();
 
 // Get the file size (partial) as well to check for sneaky changes.
 timestamp += findData.nFileSizeLow;
 }
 while ( FindNextFile( fileHandle, &findData ) != 0 );
 }
 
 FindClose( fileHandle );
#else
 // POSIX version.
 // Save time by not converting between encodings -- do everything on the file-system side.
 std::string filespec( aFilespec.fn_str() );
 std::string dir_path( aDirPath.fn_str() );
 
 DIR* dir = opendir( dir_path.c_str() );
 
 if( dir )
 {
 for( dirent* dir_entry = readdir( dir ); dir_entry; dir_entry = readdir( dir ) )
 {
 if( !matchWild( filespec.c_str(), dir_entry->d_name, true ) )
 continue;
 
 std::string entry_path = dir_path + '/' + dir_entry->d_name;
 struct stat entry_stat;
 
 if( wxCRT_Lstat( entry_path.c_str(), &entry_stat ) == 0 )
 {
 // Timestamp the source file, not the symlink
 if( S_ISLNK( entry_stat.st_mode ) ) // wxFILE_EXISTS_SYMLINK
 {
 char buffer[ PATH_MAX + 1 ];
 ssize_t pathLen = readlink( entry_path.c_str(), buffer, PATH_MAX );
 
 if( pathLen > 0 )
 {
 struct stat linked_stat;
 buffer[ pathLen ] = '\0';
 entry_path = dir_path + buffer;
 
 if( wxCRT_Lstat( entry_path.c_str(), &linked_stat ) == 0 )
 {
 entry_stat = linked_stat;
 }
 else
 {
 // if we couldn't lstat the linked file we'll have to just use
 // the symbolic link info
 }
 }
 }
 
 if( S_ISREG( entry_stat.st_mode ) ) // wxFileExists()
 {
 timestamp += entry_stat.st_mtime * 1000;
 
 // Get the file size as well to check for sneaky changes.
 timestamp += entry_stat.st_size;
 }
 }
 else
 {
 // if we couldn't lstat the file itself all we can do is use the name
 timestamp += (signed) std::hash<std::string>{}( std::string( dir_entry->d_name ) );
 }
 }
 
 closedir( dir );
 }
#endif
 
 return timestamp;
}

References matchWild().

Referenced by GPCB_FPL_CACHE::GetTimestamp(), and FP_CACHE::GetTimestamp().

WarnUserIfOperatingSystemUnsupported()

bool WarnUserIfOperatingSystemUnsupported

(

)

Checks if the operating system is explicitly unsupported and displays a disclaimer message box.

Returns

true if the operating system is unsupported

Definition at line 635 of file common.cpp.

{
 if( !KIPLATFORM::APP::IsOperatingSystemUnsupported() )
 return false;
 
 wxMessageDialog dialog( nullptr, _( "This operating system is not supported "
 "by KiCad and its dependencies." ),
 _( "Unsupported Operating System" ),
 wxOK | wxICON_EXCLAMATION );
 
 dialog.SetExtendedMessage( _( "Any issues with KiCad on this system cannot "
 "be reported to the official bugtracker." ) );
 dialog.ShowModal();
 
 return true;
}

References _, and KIPLATFORM::APP::IsOperatingSystemUnsupported().

Referenced by PGM_BASE::InitPgm(), and COMMON_CONTROL::ReportBug().