1055 lines
28 KiB
C++
1055 lines
28 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2015-2016 Cirilo Bernardo <cirilo.bernardo@gmail.com>
|
|
*
|
|
* 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
|
|
*/
|
|
|
|
#include <fstream>
|
|
#include <mutex>
|
|
#include <sstream>
|
|
|
|
#include <wx/filename.h>
|
|
#include <wx/log.h>
|
|
#include <wx/msgdlg.h>
|
|
#include <pgm_base.h>
|
|
#include <trace_helpers.h>
|
|
|
|
#include "common.h"
|
|
#include "filename_resolver.h"
|
|
|
|
// configuration file version
|
|
#define CFGFILE_VERSION 1
|
|
#define RESOLVER_CONFIG wxT( "3Dresolver.cfg" )
|
|
|
|
// flag bits used to track different one-off messages to users
|
|
#define ERRFLG_ALIAS (1)
|
|
#define ERRFLG_RELPATH (2)
|
|
#define ERRFLG_ENVPATH (4)
|
|
|
|
#define MASK_3D_RESOLVER "3D_RESOLVER"
|
|
|
|
static std::mutex mutex_resolver;
|
|
|
|
static bool getHollerith( const std::string& aString, size_t& aIndex, wxString& aResult );
|
|
|
|
|
|
FILENAME_RESOLVER::FILENAME_RESOLVER() :
|
|
m_pgm( nullptr ),
|
|
m_project( nullptr )
|
|
{
|
|
m_errflags = 0;
|
|
}
|
|
|
|
|
|
bool FILENAME_RESOLVER::Set3DConfigDir( const wxString& aConfigDir )
|
|
{
|
|
if( aConfigDir.empty() )
|
|
return false;
|
|
|
|
wxFileName cfgdir( ExpandEnvVarSubstitutions( aConfigDir, m_project ), "" );
|
|
|
|
cfgdir.Normalize();
|
|
|
|
if( !cfgdir.DirExists() )
|
|
return false;
|
|
|
|
m_ConfigDir = cfgdir.GetPath();
|
|
createPathList();
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
bool FILENAME_RESOLVER::SetProject( PROJECT* aProject, bool* flgChanged )
|
|
{
|
|
m_project = aProject;
|
|
|
|
if( !aProject )
|
|
return false;
|
|
|
|
wxFileName projdir( ExpandEnvVarSubstitutions( aProject->GetProjectPath(), aProject ), "" );
|
|
|
|
projdir.Normalize();
|
|
|
|
if( !projdir.DirExists() )
|
|
return false;
|
|
|
|
m_curProjDir = projdir.GetPath();
|
|
|
|
if( flgChanged )
|
|
*flgChanged = false;
|
|
|
|
if( m_Paths.empty() )
|
|
{
|
|
SEARCH_PATH al;
|
|
al.m_alias = "${KIPRJMOD}";
|
|
al.m_pathvar = "${KIPRJMOD}";
|
|
al.m_pathexp = m_curProjDir;
|
|
m_Paths.push_back( al );
|
|
|
|
if( flgChanged )
|
|
*flgChanged = true;
|
|
}
|
|
else
|
|
{
|
|
if( m_Paths.front().m_pathexp.Cmp( m_curProjDir ) )
|
|
{
|
|
m_Paths.front().m_pathexp = m_curProjDir;
|
|
|
|
if( flgChanged )
|
|
*flgChanged = true;
|
|
}
|
|
else
|
|
{
|
|
return true;
|
|
}
|
|
}
|
|
|
|
#ifdef DEBUG
|
|
{
|
|
std::ostringstream ostr;
|
|
ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
|
|
ostr << " * [INFO] changed project dir to ";
|
|
ostr << m_Paths.front().m_pathexp.ToUTF8();
|
|
wxLogTrace( MASK_3D_RESOLVER, "%s\n", ostr.str().c_str() );
|
|
}
|
|
#endif
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
wxString FILENAME_RESOLVER::GetProjectDir()
|
|
{
|
|
return m_curProjDir;
|
|
}
|
|
|
|
|
|
void FILENAME_RESOLVER::SetProgramBase( PGM_BASE* aBase )
|
|
{
|
|
m_pgm = aBase;
|
|
|
|
if( !m_pgm || m_Paths.empty() )
|
|
return;
|
|
|
|
// recreate the path list
|
|
m_Paths.clear();
|
|
createPathList();
|
|
}
|
|
|
|
|
|
bool FILENAME_RESOLVER::createPathList()
|
|
{
|
|
if( !m_Paths.empty() )
|
|
return true;
|
|
|
|
wxString kmod;
|
|
|
|
// add an entry for the default search path; at this point
|
|
// we cannot set a sensible default so we use an empty string.
|
|
// the user may change this later with a call to SetProjectDir()
|
|
|
|
SEARCH_PATH lpath;
|
|
lpath.m_alias = "${KIPRJMOD}";
|
|
lpath.m_pathvar = "${KIPRJMOD}";
|
|
lpath.m_pathexp = m_curProjDir;
|
|
m_Paths.push_back( lpath );
|
|
wxFileName fndummy;
|
|
wxUniChar psep = fndummy.GetPathSeparator();
|
|
std::list< wxString > epaths;
|
|
|
|
if( GetKicadPaths( epaths ) )
|
|
{
|
|
for( const wxString& curr_path : epaths )
|
|
{
|
|
wxString pathVal = ExpandEnvVarSubstitutions( curr_path, m_project );
|
|
|
|
if( pathVal.empty() )
|
|
{
|
|
lpath.m_pathexp.clear();
|
|
}
|
|
else
|
|
{
|
|
fndummy.Assign( pathVal, "" );
|
|
fndummy.Normalize();
|
|
lpath.m_pathexp = fndummy.GetFullPath();
|
|
}
|
|
|
|
lpath.m_alias = curr_path;
|
|
lpath.m_pathvar = curr_path;
|
|
|
|
if( !lpath.m_pathexp.empty() && psep == *lpath.m_pathexp.rbegin() )
|
|
lpath.m_pathexp.erase( --lpath.m_pathexp.end() );
|
|
|
|
m_Paths.push_back( lpath );
|
|
}
|
|
}
|
|
|
|
if( !m_ConfigDir.empty() )
|
|
readPathList();
|
|
|
|
if( m_Paths.empty() )
|
|
return false;
|
|
|
|
#ifdef DEBUG
|
|
wxLogTrace( MASK_3D_RESOLVER, " * [3D model] search paths:\n" );
|
|
std::list< SEARCH_PATH >::const_iterator sPL = m_Paths.begin();
|
|
|
|
while( sPL != m_Paths.end() )
|
|
{
|
|
wxLogTrace( MASK_3D_RESOLVER, " + %s : '%s'\n", (*sPL).m_alias.GetData(),
|
|
(*sPL).m_pathexp.GetData() );
|
|
++sPL;
|
|
}
|
|
#endif
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
bool FILENAME_RESOLVER::UpdatePathList( std::vector< SEARCH_PATH >& aPathList )
|
|
{
|
|
wxUniChar envMarker( '$' );
|
|
|
|
while( !m_Paths.empty() && envMarker != *m_Paths.back().m_alias.rbegin() )
|
|
m_Paths.pop_back();
|
|
|
|
size_t nI = aPathList.size();
|
|
|
|
for( size_t i = 0; i < nI; ++i )
|
|
addPath( aPathList[i] );
|
|
|
|
return writePathList();
|
|
}
|
|
|
|
|
|
wxString FILENAME_RESOLVER::ResolvePath( const wxString& aFileName )
|
|
{
|
|
std::lock_guard<std::mutex> lock( mutex_resolver );
|
|
|
|
if( aFileName.empty() )
|
|
return wxEmptyString;
|
|
|
|
if( m_Paths.empty() )
|
|
createPathList();
|
|
|
|
// first attempt to use the name as specified:
|
|
wxString tname = aFileName;
|
|
|
|
#ifdef _WIN32
|
|
// translate from KiCad's internal UNIX-like path to MSWin paths
|
|
tname.Replace( wxT( "/" ), wxT( "\\" ) );
|
|
#endif
|
|
|
|
// Note: variable expansion must be performed using a threadsafe
|
|
// wrapper for the getenv() system call. If we allow the
|
|
// wxFileName::Normalize() routine to perform expansion then
|
|
// we will have a race condition since wxWidgets does not assure
|
|
// a threadsafe wrapper for getenv().
|
|
tname = ExpandEnvVarSubstitutions( tname, m_project );
|
|
|
|
wxFileName tmpFN( tname );
|
|
|
|
// in the case of absolute filenames we don't store a map item
|
|
if( !aFileName.StartsWith( "${" ) && !aFileName.StartsWith( "$(" )
|
|
&& !aFileName.StartsWith( ":" ) && tmpFN.IsAbsolute() )
|
|
{
|
|
tmpFN.Normalize();
|
|
|
|
if( tmpFN.FileExists() )
|
|
return tmpFN.GetFullPath();
|
|
|
|
return wxEmptyString;
|
|
}
|
|
|
|
// this case covers full paths, leading expanded vars, and paths
|
|
// relative to the current working directory (which is not necessarily
|
|
// the current project directory)
|
|
if( tmpFN.FileExists() )
|
|
{
|
|
tmpFN.Normalize();
|
|
tname = tmpFN.GetFullPath();
|
|
|
|
// special case: if a path begins with ${ENV_VAR} but is not in the
|
|
// resolver's path list then add it.
|
|
if( aFileName.StartsWith( "${" ) || aFileName.StartsWith( "$(" ) )
|
|
checkEnvVarPath( aFileName );
|
|
|
|
return tname;
|
|
}
|
|
|
|
// if a path begins with ${ENV_VAR}/$(ENV_VAR) and is not resolved then the
|
|
// file either does not exist or the ENV_VAR is not defined
|
|
if( aFileName.StartsWith( "${" ) || aFileName.StartsWith( "$(" ) )
|
|
{
|
|
if( !( m_errflags & ERRFLG_ENVPATH ) )
|
|
{
|
|
m_errflags |= ERRFLG_ENVPATH;
|
|
wxString errmsg = "[3D File Resolver] No such path; ensure the environment var is defined";
|
|
errmsg.append( "\n" );
|
|
errmsg.append( tname );
|
|
errmsg.append( "\n" );
|
|
wxLogTrace( tracePathsAndFiles, errmsg );
|
|
}
|
|
|
|
return wxEmptyString;
|
|
}
|
|
|
|
// at this point aFileName is:
|
|
// a. an aliased shortened name or
|
|
// b. cannot be determined
|
|
|
|
std::list< SEARCH_PATH >::const_iterator sPL = m_Paths.begin();
|
|
std::list< SEARCH_PATH >::const_iterator ePL = m_Paths.end();
|
|
|
|
// check the path relative to the current project directory;
|
|
// note: this is not necessarily the same as the current working
|
|
// directory, which has already been checked. This case accounts
|
|
// for partial paths which do not contain ${KIPRJMOD}.
|
|
// This check is performed before checking the path relative to
|
|
// ${KISYS3DMOD} so that users can potentially override a model
|
|
// within ${KISYS3DMOD}
|
|
if( !sPL->m_pathexp.empty() && !tname.StartsWith( ":" ) )
|
|
{
|
|
tmpFN.Assign( sPL->m_pathexp, "" );
|
|
wxString fullPath = tmpFN.GetPathWithSep() + tname;
|
|
|
|
fullPath = ExpandEnvVarSubstitutions( fullPath, m_project );
|
|
|
|
if( wxFileName::FileExists( fullPath ) )
|
|
{
|
|
tmpFN.Assign( fullPath );
|
|
tmpFN.Normalize();
|
|
tname = tmpFN.GetFullPath();
|
|
return tname;
|
|
}
|
|
|
|
}
|
|
|
|
// check the partial path relative to ${KISYS3DMOD} (legacy behavior)
|
|
if( !tname.StartsWith( ":" ) )
|
|
{
|
|
wxFileName fpath;
|
|
wxString fullPath( "${KISYS3DMOD}" );
|
|
fullPath.Append( fpath.GetPathSeparator() );
|
|
fullPath.Append( tname );
|
|
fullPath = ExpandEnvVarSubstitutions( fullPath, m_project );
|
|
fpath.Assign( fullPath );
|
|
|
|
if( fpath.Normalize() && fpath.FileExists() )
|
|
{
|
|
tname = fpath.GetFullPath();
|
|
return tname;
|
|
}
|
|
|
|
}
|
|
|
|
// ${ENV_VAR} paths have already been checked; skip them
|
|
while( sPL != ePL && ( sPL->m_alias.StartsWith( "${" ) || sPL->m_alias.StartsWith( "$(" ) ) )
|
|
++sPL;
|
|
|
|
// at this point the filename must contain an alias or else it is invalid
|
|
wxString alias; // the alias portion of the short filename
|
|
wxString relpath; // the path relative to the alias
|
|
|
|
if( !SplitAlias( tname, alias, relpath ) )
|
|
{
|
|
if( !( m_errflags & ERRFLG_RELPATH ) )
|
|
{
|
|
// this can happen if the file was intended to be relative to
|
|
// ${KISYS3DMOD} but ${KISYS3DMOD} not set or incorrect.
|
|
m_errflags |= ERRFLG_RELPATH;
|
|
wxString errmsg = "[3D File Resolver] No such path";
|
|
errmsg.append( "\n" );
|
|
errmsg.append( tname );
|
|
errmsg.append( "\n" );
|
|
wxLogTrace( tracePathsAndFiles, errmsg );
|
|
}
|
|
|
|
return wxEmptyString;
|
|
}
|
|
|
|
while( sPL != ePL )
|
|
{
|
|
if( !sPL->m_alias.Cmp( alias ) && !sPL->m_pathexp.empty() )
|
|
{
|
|
wxFileName fpath( wxFileName::DirName( sPL->m_pathexp ) );
|
|
wxString fullPath = fpath.GetPathWithSep() + relpath;
|
|
|
|
fullPath = ExpandEnvVarSubstitutions( fullPath, m_project );
|
|
|
|
if( wxFileName::FileExists( fullPath ) )
|
|
{
|
|
wxFileName tmp( fullPath );
|
|
|
|
if( tmp.Normalize() )
|
|
tname = tmp.GetFullPath();
|
|
|
|
return tname;
|
|
}
|
|
}
|
|
|
|
++sPL;
|
|
}
|
|
|
|
if( !( m_errflags & ERRFLG_ALIAS ) )
|
|
{
|
|
m_errflags |= ERRFLG_ALIAS;
|
|
wxString errmsg = "[3D File Resolver] No such path; ensure the path alias is defined";
|
|
errmsg.append( "\n" );
|
|
errmsg.append( tname.substr( 1 ) );
|
|
errmsg.append( "\n" );
|
|
wxLogTrace( tracePathsAndFiles, errmsg );
|
|
}
|
|
|
|
return wxEmptyString;
|
|
}
|
|
|
|
|
|
bool FILENAME_RESOLVER::addPath( const SEARCH_PATH& aPath )
|
|
{
|
|
if( aPath.m_alias.empty() || aPath.m_pathvar.empty() )
|
|
return false;
|
|
|
|
std::lock_guard<std::mutex> lock( mutex_resolver );
|
|
|
|
SEARCH_PATH tpath = aPath;
|
|
|
|
#ifdef _WIN32
|
|
while( tpath.m_pathvar.EndsWith( wxT( "\\" ) ) )
|
|
tpath.m_pathvar.erase( tpath.m_pathvar.length() - 1 );
|
|
#else
|
|
while( tpath.m_pathvar.EndsWith( wxT( "/" ) ) && tpath.m_pathvar.length() > 1 )
|
|
tpath.m_pathvar.erase( tpath.m_pathvar.length() - 1 );
|
|
#endif
|
|
|
|
wxFileName path( ExpandEnvVarSubstitutions( tpath.m_pathvar, m_project ), "" );
|
|
|
|
path.Normalize();
|
|
|
|
if( !path.DirExists() )
|
|
{
|
|
// suppress the message if the missing pathvar is the
|
|
// legacy KISYS3DMOD variable
|
|
if( aPath.m_pathvar.compare( wxT( "${KISYS3DMOD}" ) ) )
|
|
{
|
|
wxString msg = _( "The given path does not exist" );
|
|
msg.append( wxT( "\n" ) );
|
|
msg.append( tpath.m_pathvar );
|
|
wxMessageBox( msg, _( "3D model search path" ) );
|
|
}
|
|
|
|
tpath.m_pathexp.clear();
|
|
}
|
|
else
|
|
{
|
|
tpath.m_pathexp = path.GetFullPath();
|
|
|
|
#ifdef _WIN32
|
|
while( tpath.m_pathexp.EndsWith( wxT( "\\" ) ) )
|
|
tpath.m_pathexp.erase( tpath.m_pathexp.length() - 1 );
|
|
#else
|
|
while( tpath.m_pathexp.EndsWith( wxT( "/" ) ) && tpath.m_pathexp.length() > 1 )
|
|
tpath.m_pathexp.erase( tpath.m_pathexp.length() - 1 );
|
|
#endif
|
|
}
|
|
|
|
wxString pname = path.GetPath();
|
|
std::list< SEARCH_PATH >::iterator sPL = m_Paths.begin();
|
|
std::list< SEARCH_PATH >::iterator ePL = m_Paths.end();
|
|
|
|
while( sPL != ePL )
|
|
{
|
|
if( !tpath.m_alias.Cmp( sPL->m_alias ) )
|
|
{
|
|
wxString msg = _( "Alias: " );
|
|
msg.append( tpath.m_alias );
|
|
msg.append( wxT( "\n" ) );
|
|
msg.append( _( "This path:" ) + wxS( " " ) );
|
|
msg.append( tpath.m_pathvar );
|
|
msg.append( wxT( "\n" ) );
|
|
msg.append( _( "Existing path:" ) + wxS( " " ) );
|
|
msg.append( sPL->m_pathvar );
|
|
wxMessageBox( msg, _( "Bad alias (duplicate name)" ) );
|
|
|
|
return false;
|
|
}
|
|
|
|
++sPL;
|
|
}
|
|
|
|
m_Paths.push_back( tpath );
|
|
return true;
|
|
}
|
|
|
|
|
|
bool FILENAME_RESOLVER::readPathList()
|
|
{
|
|
if( m_ConfigDir.empty() )
|
|
{
|
|
std::ostringstream ostr;
|
|
ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
|
|
wxString errmsg = "3D configuration directory is unknown";
|
|
ostr << " * " << errmsg.ToUTF8();
|
|
wxLogTrace( MASK_3D_RESOLVER, "%s\n", ostr.str().c_str() );
|
|
return false;
|
|
}
|
|
|
|
wxFileName cfgpath( m_ConfigDir, RESOLVER_CONFIG );
|
|
cfgpath.Normalize();
|
|
wxString cfgname = cfgpath.GetFullPath();
|
|
|
|
size_t nitems = m_Paths.size();
|
|
|
|
std::ifstream cfgFile;
|
|
std::string cfgLine;
|
|
|
|
if( !wxFileName::Exists( cfgname ) )
|
|
{
|
|
std::ostringstream ostr;
|
|
ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
|
|
wxString errmsg = "no 3D configuration file";
|
|
ostr << " * " << errmsg.ToUTF8() << " '";
|
|
ostr << cfgname.ToUTF8() << "'";
|
|
wxLogTrace( MASK_3D_RESOLVER, "%s\n", ostr.str().c_str() );
|
|
return false;
|
|
}
|
|
|
|
cfgFile.open( cfgname.ToUTF8() );
|
|
|
|
if( !cfgFile.is_open() )
|
|
{
|
|
std::ostringstream ostr;
|
|
ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
|
|
wxString errmsg = "Could not open configuration file";
|
|
ostr << " * " << errmsg.ToUTF8() << " '" << cfgname.ToUTF8() << "'";
|
|
wxLogTrace( MASK_3D_RESOLVER, "%s\n", ostr.str().c_str() );
|
|
return false;
|
|
}
|
|
|
|
int lineno = 0;
|
|
SEARCH_PATH al;
|
|
size_t idx;
|
|
int vnum = 0; // version number
|
|
|
|
while( cfgFile.good() )
|
|
{
|
|
cfgLine.clear();
|
|
std::getline( cfgFile, cfgLine );
|
|
++lineno;
|
|
|
|
if( cfgLine.empty() )
|
|
{
|
|
if( cfgFile.eof() )
|
|
break;
|
|
|
|
continue;
|
|
}
|
|
|
|
if( 1 == lineno && cfgLine.compare( 0, 2, "#V" ) == 0 )
|
|
{
|
|
// extract the version number and parse accordingly
|
|
if( cfgLine.size() > 2 )
|
|
{
|
|
std::istringstream istr;
|
|
istr.str( cfgLine.substr( 2 ) );
|
|
istr >> vnum;
|
|
}
|
|
|
|
continue;
|
|
}
|
|
|
|
idx = 0;
|
|
|
|
if( !getHollerith( cfgLine, idx, al.m_alias ) )
|
|
continue;
|
|
|
|
// never add on KISYS3DMOD from a config file
|
|
if( !al.m_alias.Cmp( wxT( "KISYS3DMOD" ) ) )
|
|
continue;
|
|
|
|
if( !getHollerith( cfgLine, idx, al.m_pathvar ) )
|
|
continue;
|
|
|
|
if( !getHollerith( cfgLine, idx, al.m_description ) )
|
|
continue;
|
|
|
|
addPath( al );
|
|
}
|
|
|
|
cfgFile.close();
|
|
|
|
if( vnum < CFGFILE_VERSION )
|
|
writePathList();
|
|
|
|
return( m_Paths.size() != nitems );
|
|
}
|
|
|
|
|
|
bool FILENAME_RESOLVER::writePathList()
|
|
{
|
|
if( m_ConfigDir.empty() )
|
|
{
|
|
std::ostringstream ostr;
|
|
ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
|
|
wxString errmsg = _( "3D configuration directory is unknown" );
|
|
ostr << " * " << errmsg.ToUTF8();
|
|
wxLogTrace( MASK_3D_RESOLVER, "%s\n", ostr.str().c_str() );
|
|
wxMessageBox( errmsg, _( "Write 3D search path list" ) );
|
|
|
|
return false;
|
|
}
|
|
|
|
// skip all ${ENV_VAR} alias names
|
|
std::list< SEARCH_PATH >::const_iterator sPL = m_Paths.begin();
|
|
|
|
while( sPL != m_Paths.end() &&
|
|
( sPL->m_alias.StartsWith( "${" ) || sPL->m_alias.StartsWith( "$(" ) ) )
|
|
++sPL;
|
|
|
|
wxFileName cfgpath( m_ConfigDir, RESOLVER_CONFIG );
|
|
wxString cfgname = cfgpath.GetFullPath();
|
|
std::ofstream cfgFile;
|
|
|
|
cfgFile.open( cfgname.ToUTF8(), std::ios_base::trunc );
|
|
|
|
if( !cfgFile.is_open() )
|
|
{
|
|
std::ostringstream ostr;
|
|
ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
|
|
wxString errmsg = _( "Could not open configuration file" );
|
|
ostr << " * " << errmsg.ToUTF8() << " '" << cfgname.ToUTF8() << "'";
|
|
wxLogTrace( MASK_3D_RESOLVER, "%s\n", ostr.str().c_str() );
|
|
wxMessageBox( errmsg, _( "Write 3D search path list" ) );
|
|
|
|
return false;
|
|
}
|
|
|
|
cfgFile << "#V" << CFGFILE_VERSION << "\n";
|
|
std::string tstr;
|
|
|
|
while( sPL != m_Paths.end() )
|
|
{
|
|
tstr = sPL->m_alias.ToUTF8();
|
|
cfgFile << "\"" << tstr.size() << ":" << tstr << "\",";
|
|
tstr = sPL->m_pathvar.ToUTF8();
|
|
cfgFile << "\"" << tstr.size() << ":" << tstr << "\",";
|
|
tstr = sPL->m_description.ToUTF8();
|
|
cfgFile << "\"" << tstr.size() << ":" << tstr << "\"\n";
|
|
++sPL;
|
|
}
|
|
|
|
bool bad = cfgFile.bad();
|
|
cfgFile.close();
|
|
|
|
if( bad )
|
|
{
|
|
wxMessageBox( _( "Problems writing configuration file" ),
|
|
_( "Write 3D search path list" ) );
|
|
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
void FILENAME_RESOLVER::checkEnvVarPath( const wxString& aPath )
|
|
{
|
|
bool useParen = false;
|
|
|
|
if( aPath.StartsWith( "$(" ) )
|
|
useParen = true;
|
|
else if( !aPath.StartsWith( "${" ) )
|
|
return;
|
|
|
|
size_t pEnd;
|
|
|
|
if( useParen )
|
|
pEnd = aPath.find( ")" );
|
|
else
|
|
pEnd = aPath.find( "}" );
|
|
|
|
if( pEnd == wxString::npos )
|
|
return;
|
|
|
|
wxString envar = aPath.substr( 0, pEnd + 1 );
|
|
|
|
// check if the alias exists; if not then add it to the end of the
|
|
// env var section of the path list
|
|
auto sPL = m_Paths.begin();
|
|
auto ePL = m_Paths.end();
|
|
|
|
while( sPL != ePL )
|
|
{
|
|
if( sPL->m_alias == envar )
|
|
return;
|
|
|
|
if( !sPL->m_alias.StartsWith( "${" ) )
|
|
break;
|
|
|
|
++sPL;
|
|
}
|
|
|
|
SEARCH_PATH lpath;
|
|
lpath.m_alias = envar;
|
|
lpath.m_pathvar = lpath.m_alias;
|
|
wxFileName tmpFN( ExpandEnvVarSubstitutions( lpath.m_alias, m_project ), "" );
|
|
|
|
wxUniChar psep = tmpFN.GetPathSeparator();
|
|
tmpFN.Normalize();
|
|
|
|
if( !tmpFN.DirExists() )
|
|
return;
|
|
|
|
lpath.m_pathexp = tmpFN.GetFullPath();
|
|
|
|
if( !lpath.m_pathexp.empty() && psep == *lpath.m_pathexp.rbegin() )
|
|
lpath.m_pathexp.erase( --lpath.m_pathexp.end() );
|
|
|
|
if( lpath.m_pathexp.empty() )
|
|
return;
|
|
|
|
m_Paths.insert( sPL, lpath );
|
|
}
|
|
|
|
|
|
wxString FILENAME_RESOLVER::ShortenPath( const wxString& aFullPathName )
|
|
{
|
|
wxString fname = aFullPathName;
|
|
|
|
if( m_Paths.empty() )
|
|
createPathList();
|
|
|
|
std::lock_guard<std::mutex> lock( mutex_resolver );
|
|
|
|
std::list< SEARCH_PATH >::const_iterator sL = m_Paths.begin();
|
|
size_t idx;
|
|
|
|
while( sL != m_Paths.end() )
|
|
{
|
|
// undefined paths do not participate in the
|
|
// file name shortening procedure
|
|
if( sL->m_pathexp.empty() )
|
|
{
|
|
++sL;
|
|
continue;
|
|
}
|
|
|
|
wxFileName fpath;
|
|
|
|
// in the case of aliases, ensure that we use the most recent definition
|
|
if( sL->m_alias.StartsWith( "${" ) || sL->m_alias.StartsWith( "$(" ) )
|
|
{
|
|
wxString tpath = ExpandEnvVarSubstitutions( sL->m_alias, m_project );
|
|
|
|
if( tpath.empty() )
|
|
{
|
|
++sL;
|
|
continue;
|
|
}
|
|
|
|
fpath.Assign( tpath, wxT( "" ) );
|
|
}
|
|
else
|
|
{
|
|
fpath.Assign( sL->m_pathexp, wxT( "" ) );
|
|
}
|
|
|
|
wxString fps = fpath.GetPathWithSep();
|
|
wxString tname;
|
|
|
|
idx = fname.find( fps );
|
|
|
|
if( idx == 0 )
|
|
{
|
|
fname = fname.substr( fps.size() );
|
|
|
|
#ifdef _WIN32
|
|
// ensure only the '/' separator is used in the internal name
|
|
fname.Replace( wxT( "\\" ), wxT( "/" ) );
|
|
#endif
|
|
|
|
if( sL->m_alias.StartsWith( "${" ) || sL->m_alias.StartsWith( "$(" ) )
|
|
{
|
|
// old style ENV_VAR
|
|
tname = sL->m_alias;
|
|
tname.Append( "/" );
|
|
tname.append( fname );
|
|
}
|
|
else
|
|
{
|
|
// new style alias
|
|
tname = ":";
|
|
tname.append( sL->m_alias );
|
|
tname.append( ":" );
|
|
tname.append( fname );
|
|
}
|
|
|
|
return tname;
|
|
}
|
|
|
|
++sL;
|
|
}
|
|
|
|
#ifdef _WIN32
|
|
// it is strange to convert an MSWin full path to use the
|
|
// UNIX separator but this is done for consistency and can
|
|
// be helpful even when transferring project files from
|
|
// MSWin to *NIX.
|
|
fname.Replace( wxT( "\\" ), wxT( "/" ) );
|
|
#endif
|
|
|
|
return fname;
|
|
}
|
|
|
|
|
|
|
|
const std::list< SEARCH_PATH >* FILENAME_RESOLVER::GetPaths()
|
|
{
|
|
return &m_Paths;
|
|
}
|
|
|
|
|
|
bool FILENAME_RESOLVER::SplitAlias( const wxString& aFileName,
|
|
wxString& anAlias, wxString& aRelPath )
|
|
{
|
|
anAlias.clear();
|
|
aRelPath.clear();
|
|
|
|
if( !aFileName.StartsWith( wxT( ":" ) ) )
|
|
return false;
|
|
|
|
size_t tagpos = aFileName.find( wxT( ":" ), 1 );
|
|
|
|
if( wxString::npos == tagpos || 1 == tagpos )
|
|
return false;
|
|
|
|
if( tagpos + 1 >= aFileName.length() )
|
|
return false;
|
|
|
|
anAlias = aFileName.substr( 1, tagpos - 1 );
|
|
aRelPath = aFileName.substr( tagpos + 1 );
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
static bool getHollerith( const std::string& aString, size_t& aIndex, wxString& aResult )
|
|
{
|
|
aResult.clear();
|
|
|
|
if( aIndex >= aString.size() )
|
|
{
|
|
std::ostringstream ostr;
|
|
ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
|
|
wxString errmsg = "bad Hollerith string on line";
|
|
ostr << " * " << errmsg.ToUTF8() << "\n'" << aString << "'";
|
|
wxLogTrace( MASK_3D_RESOLVER, "%s\n", ostr.str().c_str() );
|
|
|
|
return false;
|
|
}
|
|
|
|
size_t i2 = aString.find( '"', aIndex );
|
|
|
|
if( std::string::npos == i2 )
|
|
{
|
|
std::ostringstream ostr;
|
|
ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
|
|
wxString errmsg = "missing opening quote mark in config file";
|
|
ostr << " * " << errmsg.ToUTF8() << "\n'" << aString << "'";
|
|
wxLogTrace( MASK_3D_RESOLVER, "%s\n", ostr.str().c_str() );
|
|
|
|
return false;
|
|
}
|
|
|
|
++i2;
|
|
|
|
if( i2 >= aString.size() )
|
|
{
|
|
std::ostringstream ostr;
|
|
ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
|
|
wxString errmsg = "invalid entry (unexpected end of line)";
|
|
ostr << " * " << errmsg.ToUTF8() << "\n'" << aString << "'";
|
|
wxLogTrace( MASK_3D_RESOLVER, "%s\n", ostr.str().c_str() );
|
|
|
|
return false;
|
|
}
|
|
|
|
std::string tnum;
|
|
|
|
while( aString[i2] >= '0' && aString[i2] <= '9' )
|
|
tnum.append( 1, aString[i2++] );
|
|
|
|
if( tnum.empty() || aString[i2++] != ':' )
|
|
{
|
|
std::ostringstream ostr;
|
|
ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
|
|
wxString errmsg = "bad Hollerith string on line";
|
|
ostr << " * " << errmsg.ToUTF8() << "\n'" << aString << "'";
|
|
wxLogTrace( MASK_3D_RESOLVER, "%s\n", ostr.str().c_str() );
|
|
|
|
return false;
|
|
}
|
|
|
|
std::istringstream istr;
|
|
istr.str( tnum );
|
|
size_t nchars;
|
|
istr >> nchars;
|
|
|
|
if( (i2 + nchars) >= aString.size() )
|
|
{
|
|
std::ostringstream ostr;
|
|
ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
|
|
wxString errmsg = "invalid entry (unexpected end of line)";
|
|
ostr << " * " << errmsg.ToUTF8() << "\n'" << aString << "'";
|
|
wxLogTrace( MASK_3D_RESOLVER, "%s\n", ostr.str().c_str() );
|
|
|
|
return false;
|
|
}
|
|
|
|
if( nchars > 0 )
|
|
{
|
|
aResult = wxString::FromUTF8( aString.substr( i2, nchars ).c_str() );
|
|
i2 += nchars;
|
|
}
|
|
|
|
if( aString[i2] != '"' )
|
|
{
|
|
std::ostringstream ostr;
|
|
ostr << __FILE__ << ": " << __FUNCTION__ << ": " << __LINE__ << "\n";
|
|
wxString errmsg = "missing closing quote mark in config file";
|
|
ostr << " * " << errmsg.ToUTF8() << "\n'" << aString << "'";
|
|
wxLogTrace( MASK_3D_RESOLVER, "%s\n", ostr.str().c_str() );
|
|
|
|
return false;
|
|
}
|
|
|
|
aIndex = i2 + 1;
|
|
return true;
|
|
}
|
|
|
|
|
|
bool FILENAME_RESOLVER::ValidateFileName( const wxString& aFileName, bool& hasAlias )
|
|
{
|
|
// Rules:
|
|
// 1. The generic form of an aliased 3D relative path is:
|
|
// ALIAS:relative/path
|
|
// 2. ALIAS is a UTF string excluding wxT( "{}[]()%~<>\"='`;:.,&?/\\|$" )
|
|
// 3. The relative path must be a valid relative path for the platform
|
|
hasAlias = false;
|
|
|
|
if( aFileName.empty() )
|
|
return false;
|
|
|
|
wxString filename = aFileName;
|
|
size_t pos0 = aFileName.find( ':' );
|
|
|
|
// ensure that the file separators suit the current platform
|
|
#ifdef __WINDOWS__
|
|
filename.Replace( wxT( "/" ), wxT( "\\" ) );
|
|
|
|
// if we see the :\ pattern then it must be a drive designator
|
|
if( pos0 != wxString::npos )
|
|
{
|
|
size_t pos1 = filename.find( wxT( ":\\" ) );
|
|
|
|
if( pos1 != wxString::npos && ( pos1 != pos0 || pos1 != 1 ) )
|
|
return false;
|
|
|
|
// if we have a drive designator then we have no alias
|
|
if( pos1 != wxString::npos )
|
|
pos0 = wxString::npos;
|
|
}
|
|
#else
|
|
filename.Replace( wxT( "\\" ), wxT( "/" ) );
|
|
#endif
|
|
|
|
// names may not end with ':'
|
|
if( pos0 == aFileName.length() -1 )
|
|
return false;
|
|
|
|
if( pos0 != wxString::npos )
|
|
{
|
|
// ensure the alias component is not empty
|
|
if( pos0 == 0 )
|
|
return false;
|
|
|
|
wxString lpath = filename.substr( 0, pos0 );
|
|
|
|
// check the alias for restricted characters
|
|
if( wxString::npos != lpath.find_first_of( wxT( "{}[]()%~<>\"='`;:.,&?/\\|$" ) ) )
|
|
return false;
|
|
|
|
hasAlias = true;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
bool FILENAME_RESOLVER::GetKicadPaths( std::list< wxString >& paths )
|
|
{
|
|
paths.clear();
|
|
|
|
if( !m_pgm )
|
|
return false;
|
|
|
|
bool hasKisys3D = false;
|
|
|
|
|
|
// iterate over the list of internally defined ENV VARs
|
|
// and add them to the paths list
|
|
ENV_VAR_MAP_CITER mS = m_pgm->GetLocalEnvVariables().begin();
|
|
ENV_VAR_MAP_CITER mE = m_pgm->GetLocalEnvVariables().end();
|
|
|
|
while( mS != mE )
|
|
{
|
|
// filter out URLs, template directories, and known system paths
|
|
if( mS->first == wxString( "KICAD_PTEMPLATES" )
|
|
|| mS->first == wxString( "KISYSMOD" ) )
|
|
{
|
|
++mS;
|
|
continue;
|
|
}
|
|
|
|
if( wxString::npos != mS->second.GetValue().find( wxString( "://" ) ) )
|
|
{
|
|
++mS;
|
|
continue;
|
|
}
|
|
|
|
wxString tmp( "${" );
|
|
tmp.Append( mS->first );
|
|
tmp.Append( "}" );
|
|
paths.push_back( tmp );
|
|
|
|
if( tmp == "${KISYS3DMOD}" )
|
|
hasKisys3D = true;
|
|
|
|
++mS;
|
|
}
|
|
|
|
if( !hasKisys3D )
|
|
paths.emplace_back("${KISYS3DMOD}" );
|
|
|
|
return true;
|
|
}
|