haskal
/
kicad
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix wxWidgets 3.1 and later deprecated build warnings. 

wxWidgets 3.1 has deprecated wxPATH_NORM_ALL when normalizing file
paths when calling wxFileName::Normalize().  This change keeps the
existing behavior except in places where our own internal
ExpandEnvVarSubstitutions() to expand environment variables.
This commit is contained in:
Wayne Stambaugh 2022-08-14 13:36:40 -04:00
parent 6bc2f0eece
commit 898ec0d094
20 changed files with 89 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
3d-viewer/3d_cache/3d_cache.cpp
View File

@ -2,7 +2,7 @@
* This program source code file is part of KiCad, a free EDA CAD application. * This program source code file is part of KiCad, a free EDA CAD application.
* *
* Copyright (C) 2015-2016 Cirilo Bernardo <cirilo.bernardo@gmail.com> * Copyright (C) 2015-2016 Cirilo Bernardo <cirilo.bernardo@gmail.com>
* Copyright (C) 2018-2020 KiCad Developers, see AUTHORS.txt for contributors. * Copyright (C) 2018-2022 KiCad Developers, see AUTHORS.txt for contributors.
* *
* This program is free software; you can redistribute it and/or * This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License * modify it under the terms of the GNU General Public License
@ -29,7 +29,6 @@
#include <wx/datetime.h> #include <wx/datetime.h>
#include <wx/dir.h> #include <wx/dir.h>
#include <wx/filename.h>
#include <wx/log.h> #include <wx/log.h>
#include <wx/stdpaths.h> #include <wx/stdpaths.h>
@ -55,6 +54,7 @@
#include <project.h> #include <project.h>
#include <settings/common_settings.h> #include <settings/common_settings.h>
#include <settings/settings_manager.h> #include <settings/settings_manager.h>
#include <wx_filename.h>
#define MASK_3D_CACHE "3D_CACHE" #define MASK_3D_CACHE "3D_CACHE"
@ -512,7 +512,7 @@ bool S3D_CACHE::Set3DConfigDir( const wxString& aConfigDir )
wxFileName cfgdir( ExpandEnvVarSubstitutions( aConfigDir, m_project ), wxEmptyString ); wxFileName cfgdir( ExpandEnvVarSubstitutions( aConfigDir, m_project ), wxEmptyString );
cfgdir.Normalize(); cfgdir.Normalize( FN_NORMALIZE_FLAGS );
if( !cfgdir.DirExists() ) if( !cfgdir.DirExists() )
{ {

8
3d-viewer/3d_cache/3d_plugin_manager.cpp
View File

@ -2,7 +2,7 @@
* This program source code file is part of KiCad, a free EDA CAD application. * This program source code file is part of KiCad, a free EDA CAD application.
* *
* Copyright (C) 2015-2016 Cirilo Bernardo <cirilo.bernardo@gmail.com> * Copyright (C) 2015-2016 Cirilo Bernardo <cirilo.bernardo@gmail.com>
* Copyright (C) 2020 KiCad Developers, see AUTHORS.txt for contributors. * Copyright (C) 2020-2022 KiCad Developers, see AUTHORS.txt for contributors.
* *
* This program is free software; you can redistribute it and/or * This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License * modify it under the terms of the GNU General Public License
@ -29,13 +29,13 @@
#include <wx/dir.h> #include <wx/dir.h>
#include <wx/dynlib.h> #include <wx/dynlib.h>
#include <wx/filename.h>
#include <wx/log.h> #include <wx/log.h>
#include <wx/stdpaths.h> #include <wx/stdpaths.h>
#include <wx/string.h> #include <wx/string.h>
#include <common.h> #include <common.h>
#include <paths.h> #include <paths.h>
#include <wx_filename.h>
#include "3d_plugin_manager.h" #include "3d_plugin_manager.h"
#include "plugins/3d/3d_plugin.h" #include "plugins/3d/3d_plugin.h"
#include "3d_cache/sg/scenegraph.h" #include "3d_cache/sg/scenegraph.h"
@ -288,7 +288,7 @@ void S3D_PLUGIN_MANAGER::checkPluginName( const wxString& aPath,
wxFileName path( ExpandEnvVarSubstitutions( aPath, nullptr ) ); wxFileName path( ExpandEnvVarSubstitutions( aPath, nullptr ) );
path.Normalize(); path.Normalize( FN_NORMALIZE_FLAGS );
// determine if the path is already in the list // determine if the path is already in the list
wxString wxpath = path.GetFullPath(); wxString wxpath = path.GetFullPath();
@ -326,7 +326,7 @@ void S3D_PLUGIN_MANAGER::checkPluginPath( const wxString& aPath,
else else
path.Assign( aPath, wxT( "" ) ); path.Assign( aPath, wxT( "" ) );
path.Normalize(); path.Normalize( FN_NORMALIZE_FLAGS );
if( !wxFileName::DirExists( path.GetFullPath() ) ) if( !wxFileName::DirExists( path.GetFullPath() ) )
return; return;

5
3d-viewer/dialogs/dialog_select_3d_model.cpp
View File

@ -3,7 +3,7 @@
* *
* Copyright (C) 2016 Mario Luzeiro <mrluzeiro@ua.pt> * Copyright (C) 2016 Mario Luzeiro <mrluzeiro@ua.pt>
* Copyright (C) 2016 Cirilo Bernardo <cirilo.bernardo@gmail.com> * Copyright (C) 2016 Cirilo Bernardo <cirilo.bernardo@gmail.com>
* Copyright (C) 2017-2021 KiCad Developers, see AUTHORS.txt for contributors. * Copyright (C) 2017-2022 KiCad Developers, see AUTHORS.txt for contributors.
* *
* This program is free software; you can redistribute it and/or * This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License * modify it under the terms of the GNU General Public License
@ -34,6 +34,7 @@
#include <common_ogl/ogl_attr_list.h> #include <common_ogl/ogl_attr_list.h>
#include <filename_resolver.h> #include <filename_resolver.h>
#include <pcbnew/footprint.h> #include <pcbnew/footprint.h>
#include <wx_filename.h>
#include <wx/filedlg.h> #include <wx/filedlg.h>
@ -164,7 +165,7 @@ bool DIALOG_SELECT_3DMODEL::TransferDataFromWindow()
// file selection mode: retrieve the filename and specify a // file selection mode: retrieve the filename and specify a
// path relative to one of the config paths // path relative to one of the config paths
wxFileName fname = m_FileTree->GetFilePath(); wxFileName fname = m_FileTree->GetFilePath();
fname.Normalize(); fname.Normalize( FN_NORMALIZE_FLAGS | wxPATH_NORM_ENV_VARS );
m_model->m_Filename = m_resolver->ShortenPath( fname.GetFullPath() ); m_model->m_Filename = m_resolver->ShortenPath( fname.GetFullPath() );
return true; return true;

26
common/filename_resolver.cpp
View File

@ -26,7 +26,6 @@
#include <mutex> #include <mutex>
#include <sstream> #include <sstream>
#include <wx/filename.h>
#include <wx/log.h> #include <wx/log.h>
#include <wx/msgdlg.h> #include <wx/msgdlg.h>
#include <pgm_base.h> #include <pgm_base.h>
@ -34,6 +33,7 @@
#include "common.h" #include "common.h"
#include "filename_resolver.h" #include "filename_resolver.h"
#include <wx_filename.h>
// configuration file version // configuration file version
#define CFGFILE_VERSION 1 #define CFGFILE_VERSION 1
@ -66,7 +66,7 @@ bool FILENAME_RESOLVER::Set3DConfigDir( const wxString& aConfigDir )
wxFileName cfgdir( ExpandEnvVarSubstitutions( aConfigDir, m_project ), "" ); wxFileName cfgdir( ExpandEnvVarSubstitutions( aConfigDir, m_project ), "" );
cfgdir.Normalize(); cfgdir.Normalize( FN_NORMALIZE_FLAGS );
if( !cfgdir.DirExists() ) if( !cfgdir.DirExists() )
return false; return false;
@ -87,7 +87,7 @@ bool FILENAME_RESOLVER::SetProject( PROJECT* aProject, bool* flgChanged )
wxFileName projdir( ExpandEnvVarSubstitutions( aProject->GetProjectPath(), aProject ), "" ); wxFileName projdir( ExpandEnvVarSubstitutions( aProject->GetProjectPath(), aProject ), "" );
projdir.Normalize(); projdir.Normalize( FN_NORMALIZE_FLAGS );
if( !projdir.DirExists() ) if( !projdir.DirExists() )
return false; return false;
@ -187,7 +187,7 @@ bool FILENAME_RESOLVER::createPathList()
else else
{ {
fndummy.Assign( pathVal, "" ); fndummy.Assign( pathVal, "" );
fndummy.Normalize(); fndummy.Normalize( FN_NORMALIZE_FLAGS );
lpath.m_Pathexp = fndummy.GetFullPath(); lpath.m_Pathexp = fndummy.GetFullPath();
} }
@ -267,7 +267,7 @@ wxString FILENAME_RESOLVER::ResolvePath( const wxString& aFileName )
// working directory (which is not necessarily the current project directory) // working directory (which is not necessarily the current project directory)
if( tmpFN.FileExists() ) if( tmpFN.FileExists() )
{ {
tmpFN.Normalize(); tmpFN.Normalize( FN_NORMALIZE_FLAGS );
tname = tmpFN.GetFullPath(); tname = tmpFN.GetFullPath();
// special case: if a path begins with ${ENV_VAR} but is not in the resolver's path list // special case: if a path begins with ${ENV_VAR} but is not in the resolver's path list
@ -314,7 +314,7 @@ wxString FILENAME_RESOLVER::ResolvePath( const wxString& aFileName )
if( wxFileName::FileExists( fullPath ) ) if( wxFileName::FileExists( fullPath ) )
{ {
tmpFN.Assign( fullPath ); tmpFN.Assign( fullPath );
tmpFN.Normalize(); tmpFN.Normalize( FN_NORMALIZE_FLAGS );
tname = tmpFN.GetFullPath(); tname = tmpFN.GetFullPath();
return tname; return tname;
} }
@ -331,7 +331,7 @@ wxString FILENAME_RESOLVER::ResolvePath( const wxString& aFileName )
fullPath = ExpandEnvVarSubstitutions( fullPath, m_project ); fullPath = ExpandEnvVarSubstitutions( fullPath, m_project );
fpath.Assign( fullPath ); fpath.Assign( fullPath );
if( fpath.Normalize() && fpath.FileExists() ) if( fpath.Normalize( FN_NORMALIZE_FLAGS ) && fpath.FileExists() )
{ {
tname = fpath.GetFullPath(); tname = fpath.GetFullPath();
return tname; return tname;
@ -379,7 +379,7 @@ wxString FILENAME_RESOLVER::ResolvePath( const wxString& aFileName )
wxFileName tmp( fullPath ); wxFileName tmp( fullPath );
if( tmp.Normalize() ) if( tmp.Normalize( FN_NORMALIZE_FLAGS ) )
tname = tmp.GetFullPath(); tname = tmp.GetFullPath();
return tname; return tname;
@ -420,7 +420,7 @@ bool FILENAME_RESOLVER::addPath( const SEARCH_PATH& aPath )
wxFileName path( ExpandEnvVarSubstitutions( tpath.m_Pathvar, m_project ), "" ); wxFileName path( ExpandEnvVarSubstitutions( tpath.m_Pathvar, m_project ), "" );
path.Normalize(); path.Normalize( FN_NORMALIZE_FLAGS );
if( !path.DirExists() ) if( !path.DirExists() )
{ {
@ -494,7 +494,11 @@ bool FILENAME_RESOLVER::readPathList()
} }
wxFileName cfgpath( m_configDir, RESOLVER_CONFIG ); wxFileName cfgpath( m_configDir, RESOLVER_CONFIG );
cfgpath.Normalize();
// This should be the same as wxWidgets 3.0 wxPATH_NORM_ALL which is deprecated in 3.1.
// There are known issues with environment variable expansion so maybe we should be using
// our own ExpandEnvVarSubstitutions() here instead.
cfgpath.Normalize( FN_NORMALIZE_FLAGS | wxPATH_NORM_ENV_VARS );
wxString cfgname = cfgpath.GetFullPath(); wxString cfgname = cfgpath.GetFullPath();
size_t nitems = m_paths.size(); size_t nitems = m_paths.size();
@ -714,7 +718,7 @@ void FILENAME_RESOLVER::checkEnvVarPath( const wxString& aPath )
wxFileName tmpFN( ExpandEnvVarSubstitutions( lpath.m_Alias, m_project ), "" ); wxFileName tmpFN( ExpandEnvVarSubstitutions( lpath.m_Alias, m_project ), "" );
wxUniChar psep = tmpFN.GetPathSeparator(); wxUniChar psep = tmpFN.GetPathSeparator();
tmpFN.Normalize(); tmpFN.Normalize( FN_NORMALIZE_FLAGS );
if( !tmpFN.DirExists() ) if( !tmpFN.DirExists() )
return; return;

4
common/project.cpp
View File

@ -1,7 +1,7 @@
/* /*
* This program source code file is part of KiCad, a free EDA CAD application. * This program source code file is part of KiCad, a free EDA CAD application.
* *
* Copyright (C) 2014-2021 KiCad Developers, see AUTHORS.txt for contributors. * Copyright (C) 2014-2022 KiCad Developers, see AUTHORS.txt for contributors.
* *
* This program is free software; you can redistribute it and/or * This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License * modify it under the terms of the GNU General Public License
@ -267,7 +267,7 @@ const wxString PROJECT::AbsolutePath( const wxString& aFileName ) const
if( !fn.IsAbsolute() ) if( !fn.IsAbsolute() )
{ {
wxString pro_dir = wxPathOnly( GetProjectFullName() ); wxString pro_dir = wxPathOnly( GetProjectFullName() );
fn.Normalize( wxPATH_NORM_ALL, pro_dir ); fn.Normalize( FN_NORMALIZE_FLAGS | wxPATH_NORM_ENV_VARS, pro_dir );
} }
return fn.GetFullPath(); return fn.GetFullPath();

7
eeschema/dialogs/dialog_plot_schematic.cpp
View File

@ -4,7 +4,7 @@
* Copyright (C) 1992-2018 Jean-Pierre Charras jp.charras at wanadoo.fr * Copyright (C) 1992-2018 Jean-Pierre Charras jp.charras at wanadoo.fr
* Copyright (C) 1992-2010 Lorenzo Marcantonio * Copyright (C) 1992-2010 Lorenzo Marcantonio
* Copyright (C) 2011 Wayne Stambaugh <stambaughw@gmail.com> * Copyright (C) 2011 Wayne Stambaugh <stambaughw@gmail.com>
* Copyright (C) 1992-2021 KiCad Developers, see AUTHORS.txt for contributors. * Copyright (C) 1992-2022 KiCad Developers, see AUTHORS.txt for contributors.
* *
* This program is free software; you can redistribute it and/or * This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License * modify it under the terms of the GNU General Public License
@ -38,6 +38,7 @@
#include <trace_helpers.h> #include <trace_helpers.h>
#include <settings/settings_manager.h> #include <settings/settings_manager.h>
#include <drawing_sheet/ds_painter.h> #include <drawing_sheet/ds_painter.h>
#include <wx_filename.h>
#include <sch_edit_frame.h> #include <sch_edit_frame.h>
#include <sch_painter.h> #include <sch_painter.h>
@ -1294,7 +1295,7 @@ wxString DIALOG_PLOT_SCHEMATIC::getOutputPath()
fn.SetName( wxEmptyString ); fn.SetName( wxEmptyString );
fn.SetExt( wxEmptyString ); fn.SetExt( wxEmptyString );
if( fn.Normalize() ) if( fn.Normalize( FN_NORMALIZE_FLAGS | wxPATH_NORM_ENV_VARS ) )
{ {
path = fn.GetPath(); path = fn.GetPath();
} }
@ -1329,7 +1330,7 @@ wxString DIALOG_PLOT_SCHEMATIC::getOutputPath()
// Build the absolute path of current output directory and the project path. // Build the absolute path of current output directory and the project path.
fn.SetPath( Prj().GetProjectPath() + path ); fn.SetPath( Prj().GetProjectPath() + path );
if( fn.Normalize() ) if( fn.Normalize( FN_NORMALIZE_FLAGS | wxPATH_NORM_ENV_VARS ) )
{ {
path = fn.GetPath(); path = fn.GetPath();
} }

4
eeschema/dialogs/dialog_sheet_properties.cpp
View File

@ -29,6 +29,7 @@
#include <wx/tooltip.h> #include <wx/tooltip.h>
#include <confirm.h> #include <confirm.h>
#include <validators.h> #include <validators.h>
#include <wx_filename.h>
#include <wildcards_and_files_ext.h> #include <wildcards_and_files_ext.h>
#include <widgets/tab_traversal.h> #include <widgets/tab_traversal.h>
#include <kiplatform/ui.h> #include <kiplatform/ui.h>
@ -445,7 +446,8 @@ bool DIALOG_SHEET_PROPERTIES::onSheetFilenameChanged( const wxString& aNewFilena
// SCH_SCREEN file names are always absolute. // SCH_SCREEN file names are always absolute.
wxFileName currentScreenFileName = currentScreen->GetFileName(); wxFileName currentScreenFileName = currentScreen->GetFileName();
if( !screenFileName.Normalize( wxPATH_NORM_ALL, currentScreenFileName.GetPath() ) ) if( !screenFileName.Normalize( FN_NORMALIZE_FLAGS | wxPATH_NORM_ENV_VARS,
currentScreenFileName.GetPath() ) )
{ {
msg = wxString::Format( _( "Cannot normalize new sheet schematic file path:\n" msg = wxString::Format( _( "Cannot normalize new sheet schematic file path:\n"
"'%s'\n" "'%s'\n"

5
eeschema/dialogs/dialog_symbol_remap.cpp
View File

@ -6,7 +6,7 @@
* This program source code file is part of KiCad, a free EDA CAD application. * This program source code file is part of KiCad, a free EDA CAD application.
* *
* Copyright (C) 2017 Wayne Stambaugh <stambaughw@gmail.com> * Copyright (C) 2017 Wayne Stambaugh <stambaughw@gmail.com>
* Copyright (C) 2017-2021 KiCad Developers, see AUTHORS.txt for contributors. * Copyright (C) 2017-2022 KiCad Developers, see AUTHORS.txt for contributors.
* *
* This program is free software: you can redistribute it and/or modify it * 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 * under the terms of the GNU General Public License as published by the
@ -29,6 +29,7 @@
#include <confirm.h> #include <confirm.h>
#include <reporter.h> #include <reporter.h>
#include <wildcards_and_files_ext.h> #include <wildcards_and_files_ext.h>
#include <wx_filename.h>
#include <wx_html_report_panel.h> #include <wx_html_report_panel.h>
#include <symbol_library.h> #include <symbol_library.h>
@ -201,7 +202,7 @@ void DIALOG_SYMBOL_REMAP::createProjectSymbolLibTable( REPORTER& aReporter )
wxFileName tmpFn = fullFileName; wxFileName tmpFn = fullFileName;
// Don't add symbol libraries that do not exist. // Don't add symbol libraries that do not exist.
if( tmpFn.Normalize() && tmpFn.FileExists() ) if( tmpFn.Normalize( FN_NORMALIZE_FLAGS | wxPATH_NORM_ENV_VARS ) && tmpFn.FileExists() )
{ {
msg.Printf( _( "Adding library '%s', file '%s' to project symbol library table." ), msg.Printf( _( "Adding library '%s', file '%s' to project symbol library table." ),
libName, libName,

5
eeschema/sim/sim_plot_frame.cpp
View File

@ -2,7 +2,7 @@
* This program source code file is part of KiCad, a free EDA CAD application. * This program source code file is part of KiCad, a free EDA CAD application.
* *
* Copyright (C) 2016 CERN * Copyright (C) 2016 CERN
* Copyright (C) 2016-2021 KiCad Developers, see AUTHORS.txt for contributors. * Copyright (C) 2016-2022 KiCad Developers, see AUTHORS.txt for contributors.
* @author Tomasz Wlostowski <tomasz.wlostowski@cern.ch> * @author Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
* @author Maciej Suminski <maciej.suminski@cern.ch> * @author Maciej Suminski <maciej.suminski@cern.ch>
* *
@ -52,6 +52,7 @@
#include <wx/ffile.h> #include <wx/ffile.h>
#include <wx/filedlg.h> #include <wx/filedlg.h>
#include <dialog_shim.h> #include <dialog_shim.h>
#include <wx_filename.h>
SIM_PLOT_TYPE operator|( SIM_PLOT_TYPE aFirst, SIM_PLOT_TYPE aSecond ) SIM_PLOT_TYPE operator|( SIM_PLOT_TYPE aFirst, SIM_PLOT_TYPE aSecond )
@ -1126,7 +1127,7 @@ wxString SIM_PLOT_FRAME::getDefaultPath()
{ {
wxFileName path = m_simulator->Settings()->GetWorkbookFilename(); wxFileName path = m_simulator->Settings()->GetWorkbookFilename();
path.Normalize( wxPATH_NORM_ALL, Prj().GetProjectPath() ); path.Normalize( FN_NORMALIZE_FLAGS | wxPATH_NORM_ENV_VARS, Prj().GetProjectPath() );
return path.GetPath(); return path.GetPath();
} }

5
eeschema/symbol_editor/symbol_library_manager.cpp
View File

@ -31,6 +31,7 @@
#include <pgm_base.h> #include <pgm_base.h>
#include <kiway.h> #include <kiway.h>
#include <profile.h> #include <profile.h>
#include <wx_filename.h>
#include <sch_io_mgr.h> #include <sch_io_mgr.h>
#include <sch_plugins/legacy/sch_legacy_plugin.h> #include <sch_plugins/legacy/sch_legacy_plugin.h>
#include <symbol_lib_table.h> #include <symbol_lib_table.h>
@ -210,10 +211,10 @@ bool SYMBOL_LIBRARY_MANAGER::SaveLibrary( const wxString& aLibrary, const wxStri
if( row ) if( row )
{ {
original = row->GetFullURI( true ); original = row->GetFullURI( true );
original.Normalize(); original.Normalize( FN_NORMALIZE_FLAGS | wxPATH_NORM_ENV_VARS );
} }
destination.Normalize(); destination.Normalize( FN_NORMALIZE_FLAGS | wxPATH_NORM_ENV_VARS );
if( res && original == destination ) if( res && original == destination )
libBuf.ClearDeletedBuffer(); libBuf.ClearDeletedBuffer();

4
eeschema/tools/sch_editor_control.cpp
View File

@ -65,6 +65,7 @@
#include <locale_io.h> #include <locale_io.h>
#include <wildcards_and_files_ext.h> #include <wildcards_and_files_ext.h>
#include <wx_filename.h>
#include <sch_sheet_path.h> #include <sch_sheet_path.h>
#include <wx/filedlg.h> #include <wx/filedlg.h>
@ -1843,7 +1844,8 @@ int SCH_EDITOR_CONTROL::Paste( const TOOL_EVENT& aEvent )
if( !fn.IsAbsolute() ) if( !fn.IsAbsolute() )
{ {
wxFileName currentSheetFileName = pasteRoot.LastScreen()->GetFileName(); wxFileName currentSheetFileName = pasteRoot.LastScreen()->GetFileName();
fn.Normalize( wxPATH_NORM_ALL, currentSheetFileName.GetPath() ); fn.Normalize( FN_NORMALIZE_FLAGS | wxPATH_NORM_ENV_VARS,
currentSheetFileName.GetPath() );
} }
// Try to find the screen for the pasted sheet by several means // Try to find the screen for the pasted sheet by several means

4
include/project.h
View File

@ -1,7 +1,7 @@
/* /*
* This program source code file is part of KiCad, a free EDA CAD application. * This program source code file is part of KiCad, a free EDA CAD application.
* *
* Copyright (C) 2014-2021 KiCad Developers, see AUTHORS.txt for contributors. * Copyright (C) 2014-2022 KiCad Developers, see AUTHORS.txt for contributors.
* *
* This program is free software; you can redistribute it and/or * This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License * modify it under the terms of the GNU General Public License
@ -29,8 +29,8 @@
#include <map> #include <map>
#include <vector> #include <vector>
#include <kiid.h> #include <kiid.h>
#include <wx_filename.h>
#include <wx/string.h> #include <wx/string.h>
#include <wx/filename.h>
#include <core/typeinfo.h> #include <core/typeinfo.h>
/// A variable name whose value holds the current project directory. /// A variable name whose value holds the current project directory.

14
include/wx_filename.h
View File

@ -1,7 +1,7 @@
/* /*
* This program source code file is part of KiCad, a free EDA CAD application. * This program source code file is part of KiCad, a free EDA CAD application.
* *
* Copyright (C) 1992-2020 KiCad Developers, see AUTHORS.txt for contributors. * Copyright (C) 1992-2022 KiCad Developers, see AUTHORS.txt for contributors.
* *
* This program is free software; you can redistribute it and/or * This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License * modify it under the terms of the GNU General Public License
@ -26,6 +26,18 @@
#include <wx/filename.h> #include <wx/filename.h>
/**
* Default flags to pass to wxFileName::Normalize().
*
* @note wxPATH_NORM_ALL is deprecated in wxWidgets 3.1 and later. wxPATH_NORM_ENV_VARS
* is not included because it has some known issues and we typically use our own
* ExpandEnvVarSubstitutions() for handling environment variable expansion. If
* ExpandEnvVarSubstitutions() is not used, logically or wxPATH_NORM_ENV_VARS to
* this.
*/
#define FN_NORMALIZE_FLAGS ( wxPATH_NORM_DOTS | wxPATH_NORM_TILDE | wxPATH_NORM_ABSOLUTE | \
wxPATH_NORM_LONG | wxPATH_NORM_SHORTCUT )
/** /**
* A wrapper around a wxFileName which is much more performant with a subset of the API. * A wrapper around a wxFileName which is much more performant with a subset of the API.
* *

7
kicad/dialogs/dialog_template_selector.cpp
View File

@ -24,6 +24,7 @@
#include "dialog_template_selector.h" #include "dialog_template_selector.h"
#include <bitmaps.h> #include <bitmaps.h>
#include <wx_filename.h>
#include <wx/dir.h> #include <wx/dir.h>
#include <wx/dirdlg.h> #include <wx/dirdlg.h>
#include <wx/settings.h> #include <wx/settings.h>
@ -182,7 +183,7 @@ void DIALOG_TEMPLATE_SELECTOR::AddTemplatesPage( const wxString& aTitle, wxFileN
{ {
wxNotebookPage* newPage = new wxNotebookPage( m_notebook, wxID_ANY ); wxNotebookPage* newPage = new wxNotebookPage( m_notebook, wxID_ANY );
aPath.Normalize(); aPath.Normalize( FN_NORMALIZE_FLAGS | wxPATH_NORM_ENV_VARS );
wxString path = aPath.GetFullPath(); // caller ensures this ends with file separator. wxString path = aPath.GetFullPath(); // caller ensures this ends with file separator.
TEMPLATE_SELECTION_PANEL* tpanel = new TEMPLATE_SELECTION_PANEL( newPage, path ); TEMPLATE_SELECTION_PANEL* tpanel = new TEMPLATE_SELECTION_PANEL( newPage, path );
@ -246,7 +247,7 @@ void DIALOG_TEMPLATE_SELECTOR::onDirectoryBrowseClicked( wxCommandEvent& event )
{ {
wxFileName fn; wxFileName fn;
fn.AssignDir( m_tcTemplatePath->GetValue() ); fn.AssignDir( m_tcTemplatePath->GetValue() );
fn.Normalize(); fn.Normalize( FN_NORMALIZE_FLAGS | wxPATH_NORM_ENV_VARS );
wxString currPath = fn.GetFullPath(); wxString currPath = fn.GetFullPath();
wxDirDialog dirDialog( this, _( "Select Templates Directory" ), currPath, wxDirDialog dirDialog( this, _( "Select Templates Directory" ), currPath,
@ -275,7 +276,7 @@ void DIALOG_TEMPLATE_SELECTOR::onReload( wxCommandEvent& event )
wxFileName fn; wxFileName fn;
fn.AssignDir( m_tcTemplatePath->GetValue() ); fn.AssignDir( m_tcTemplatePath->GetValue() );
fn.Normalize(); fn.Normalize( FN_NORMALIZE_FLAGS | wxPATH_NORM_ENV_VARS );
currPath = fn.GetFullPath(); currPath = fn.GetFullPath();
m_tcTemplatePath->SetValue( currPath ); m_tcTemplatePath->SetValue( currPath );

3
kicad/pcm/pcm.cpp
View File

@ -30,6 +30,7 @@
#include "pgm_base.h" #include "pgm_base.h"
#include "picosha2.h" #include "picosha2.h"
#include "settings/settings_manager.h" #include "settings/settings_manager.h"
#include <wx_filename.h>
#include <fstream> #include <fstream>
#include <iomanip> #include <iomanip>
@ -73,7 +74,7 @@ PLUGIN_CONTENT_MANAGER::PLUGIN_CONTENT_MANAGER( wxWindow* aParent ) : m_dialog(
// Read and store pcm schema // Read and store pcm schema
wxFileName schema_file( PATHS::GetStockDataPath( true ), "pcm.v1.schema.json" ); wxFileName schema_file( PATHS::GetStockDataPath( true ), "pcm.v1.schema.json" );
schema_file.Normalize(); schema_file.Normalize( FN_NORMALIZE_FLAGS | wxPATH_NORM_ENV_VARS );
schema_file.AppendDir( "schemas" ); schema_file.AppendDir( "schemas" );
std::ifstream schema_stream( schema_file.GetFullPath().ToUTF8() ); std::ifstream schema_stream( schema_file.GetFullPath().ToUTF8() );

5
plugins/3d/vrml/v2/vrml2_base.cpp
View File

@ -26,9 +26,10 @@
#include <sstream> #include <sstream>
#include <utility> #include <utility>
#include <wx/string.h> #include <wx/string.h>
#include <wx/filename.h>
#include <wx/log.h> #include <wx/log.h>
#include <wx_filename.h>
#include "vrml2_base.h" #include "vrml2_base.h"
#include "vrml2_transform.h" #include "vrml2_transform.h"
#include "vrml2_shape.h" #include "vrml2_shape.h"
@ -128,7 +129,7 @@ SGNODE* WRL2BASE::GetInlineData( const std::string& aName )
fn.Assign( fname ); fn.Assign( fname );
} }
if( !fn.Normalize() ) if( !fn.Normalize( FN_NORMALIZE_FLAGS | wxPATH_NORM_ENV_VARS ) )
{ {
m_inlineModels.emplace( aName, nullptr ); m_inlineModels.emplace( aName, nullptr );
return nullptr; return nullptr;

4
plugins/3d/vrml/wrlproc.cpp
View File

@ -24,10 +24,10 @@
#include <iostream> #include <iostream>
#include <sstream> #include <sstream>
#include <wx/filename.h>
#include <wx/string.h> #include <wx/string.h>
#include <wx/log.h> #include <wx/log.h>
#include "wrlproc.h" #include "wrlproc.h"
#include <wx_filename.h>
#define GETLINE \ #define GETLINE \
do \ do \
@ -78,7 +78,7 @@ WRLPROC::WRLPROC( LINE_READER* aLineReader )
wxFileName fn( tname ); wxFileName fn( tname );
if( fn.IsRelative() ) if( fn.IsRelative() )
fn.Normalize(); fn.Normalize( FN_NORMALIZE_FLAGS | wxPATH_NORM_ENV_VARS );
m_filedir = fn.GetPathWithSep().ToUTF8(); m_filedir = fn.GetPathWithSep().ToUTF8();

8
utils/idftools/idf2vrml.cpp
View File

@ -1,7 +1,8 @@
/* /*
* This program source code file is part of KiCad, a free EDA CAD application. * This program source code file is part of KiCad, a free EDA CAD application.
* *
* Copyright (C) 2014-2017 Cirilo Bernardo * Copyright (C) 2014-2017 Cirilo Bernardo
* Copyright (C) 2022 KiCad Developers, see AUTHORS.txt for contributors.
* *
* This program is free software; you can redistribute it and/or * This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License * modify it under the terms of the GNU General Public License
@ -35,7 +36,6 @@
#include <wx/cmdline.h> #include <wx/cmdline.h>
#include <wx/log.h> #include <wx/log.h>
#include <wx/string.h> #include <wx/string.h>
#include <wx/filename.h>
#include <iostream> #include <iostream>
#include <iomanip> #include <iomanip>
@ -53,6 +53,8 @@
#include <algorithm> #include <algorithm>
#include <boost/ptr_container/ptr_map.hpp> #include <boost/ptr_container/ptr_map.hpp>
#include <wx_filename.h>
#include "idf_helpers.h" #include "idf_helpers.h"
#include "idf_common.h" #include "idf_common.h"
#include "idf_parser.h" #include "idf_parser.h"
@ -259,7 +261,7 @@ int IDF2VRML::OnRun()
// Create the VRML file and write the header // Create the VRML file and write the header
wxFileName fname( m_filename ); wxFileName fname( m_filename );
fname.SetExt( wxT( "wrl" ) ); fname.SetExt( wxT( "wrl" ) );
fname.Normalize(); fname.Normalize( FN_NORMALIZE_FLAGS | wxPATH_NORM_ENV_VARS );
wxLogMessage( wxT( "Writing file: '%s'" ), fname.GetFullName() ); wxLogMessage( wxT( "Writing file: '%s'" ), fname.GetFullName() );
OPEN_OSTREAM( ofile, fname.GetFullPath().ToUTF8() ); OPEN_OSTREAM( ofile, fname.GetFullPath().ToUTF8() );

19
utils/kicad2step/pcb/3d_resolver.cpp
View File

@ -30,12 +30,13 @@
#include <sstream> #include <sstream>
#include <wx/fileconf.h> #include <wx/fileconf.h>
#include <wx/filename.h>
#include <wx/log.h> #include <wx/log.h>
#include <wx/thread.h> #include <wx/thread.h>
#include <wx/msgdlg.h> #include <wx/msgdlg.h>
#include <wx/stdpaths.h> #include <wx/stdpaths.h>
#include <wx_filename.h>
#include "3d_resolver.h" #include "3d_resolver.h"
// configuration file version // configuration file version
@ -138,7 +139,7 @@ wxString S3D_RESOLVER::ResolvePath( const wxString& aFileName,
{ {
if( tmpFN.FileExists() ) if( tmpFN.FileExists() )
{ {
tmpFN.Normalize(); tmpFN.Normalize( FN_NORMALIZE_FLAGS );
return tmpFN.GetFullPath(); return tmpFN.GetFullPath();
} }
else else
@ -149,7 +150,7 @@ wxString S3D_RESOLVER::ResolvePath( const wxString& aFileName,
// this case covers full paths, leading expanded vars, and paths relative to the current // this case covers full paths, leading expanded vars, and paths relative to the current
// working directory (which is not necessarily the current project directory) // working directory (which is not necessarily the current project directory)
tmpFN.Normalize(); tmpFN.Normalize( FN_NORMALIZE_FLAGS );
if( tmpFN.FileExists() ) if( tmpFN.FileExists() )
{ {
@ -194,7 +195,7 @@ wxString S3D_RESOLVER::ResolvePath( const wxString& aFileName,
fullPath = expandVars( fullPath ); fullPath = expandVars( fullPath );
tmpFN.Assign( fullPath ); tmpFN.Assign( fullPath );
tmpFN.Normalize(); tmpFN.Normalize( FN_NORMALIZE_FLAGS );
if( tmpFN.FileExists() ) if( tmpFN.FileExists() )
{ {
@ -217,7 +218,7 @@ wxString S3D_RESOLVER::ResolvePath( const wxString& aFileName,
fullPath.Append( tname ); fullPath.Append( tname );
fullPath = expandVars( fullPath ); fullPath = expandVars( fullPath );
fpath.Assign( fullPath ); fpath.Assign( fullPath );
fpath.Normalize(); fpath.Normalize( FN_NORMALIZE_FLAGS );
if( fpath.FileExists() ) if( fpath.FileExists() )
{ {
@ -258,7 +259,7 @@ wxString S3D_RESOLVER::ResolvePath( const wxString& aFileName,
fullPath = expandVars( fullPath ); fullPath = expandVars( fullPath );
wxFileName tmp( fullPath ); wxFileName tmp( fullPath );
tmp.Normalize(); tmp.Normalize( FN_NORMALIZE_FLAGS );
if( tmp.FileExists() ) if( tmp.FileExists() )
{ {
@ -296,7 +297,7 @@ bool S3D_RESOLVER::addPath( const SEARCH_PATH& aPath )
#endif #endif
wxFileName path( tpath.m_Pathvar, wxT( "" ) ); wxFileName path( tpath.m_Pathvar, wxT( "" ) );
path.Normalize(); path.Normalize( FN_NORMALIZE_FLAGS | wxPATH_NORM_ENV_VARS );
if( !path.DirExists() ) if( !path.DirExists() )
{ {
@ -363,7 +364,7 @@ bool S3D_RESOLVER::addPath( const SEARCH_PATH& aPath )
bool S3D_RESOLVER::readPathList( void ) bool S3D_RESOLVER::readPathList( void )
{ {
wxFileName cfgpath( wxStandardPaths::Get().GetTempDir(), S3D_RESOLVER_CONFIG ); wxFileName cfgpath( wxStandardPaths::Get().GetTempDir(), S3D_RESOLVER_CONFIG );
cfgpath.Normalize(); cfgpath.Normalize( FN_NORMALIZE_FLAGS | wxPATH_NORM_ENV_VARS );
wxString cfgname = cfgpath.GetFullPath(); wxString cfgname = cfgpath.GetFullPath();
size_t nitems = m_Paths.size(); size_t nitems = m_Paths.size();
@ -486,7 +487,7 @@ void S3D_RESOLVER::checkEnvVarPath( const wxString& aPath )
lpath.m_Pathvar = lpath.m_Alias; lpath.m_Pathvar = lpath.m_Alias;
wxFileName tmpFN( lpath.m_Alias, wxT( "" ) ); wxFileName tmpFN( lpath.m_Alias, wxT( "" ) );
wxUniChar psep = tmpFN.GetPathSeparator(); wxUniChar psep = tmpFN.GetPathSeparator();
tmpFN.Normalize(); tmpFN.Normalize( FN_NORMALIZE_FLAGS | wxPATH_NORM_ENV_VARS );
if( !tmpFN.DirExists() ) if( !tmpFN.DirExists() )
return; return;

5
utils/kicad2step/pcb/kicadpcb.cpp
View File

@ -31,13 +31,12 @@
#include <sexpr/sexpr.h> #include <sexpr/sexpr.h>
#include <sexpr/sexpr_parser.h> #include <sexpr/sexpr_parser.h>
#include <wx/filename.h>
#include <wx/wxcrtvararg.h> #include <wx/wxcrtvararg.h>
#include <memory> #include <memory>
#include <string> #include <string>
#include <wx_filename.h>
KICADPCB::KICADPCB( const wxString& aPcbName ) KICADPCB::KICADPCB( const wxString& aPcbName )
@ -92,7 +91,7 @@ bool KICADPCB::ReadFile( const wxString& aFileName )
return false; return false;
} }
fname.Normalize(); fname.Normalize( FN_NORMALIZE_FLAGS | wxPATH_NORM_ENV_VARS );
m_filename = fname.GetFullPath(); m_filename = fname.GetFullPath();
try try