kicad-source/include/wx_filename.h
Seth Hillbrand 0b2d4d4879 Revise Copyright statement to align with TLF
Recommendation is to avoid using the year nomenclature as this
information is already encoded in the git repo.  Avoids needing to
repeatly update.

Also updates AUTHORS.txt from current repo with contributor names
2025-01-01 14:12:04 -08:00

78 lines
2.8 KiB
C++

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright The KiCad Developers, see AUTHORS.txt for contributors.
*
* 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
*/
#ifndef WX_FILENAME_H
#define WX_FILENAME_H
#include <kicommon.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 avoids expensive calls to wxFileName::SplitPath()
* and string concatenations by caching the path and filename locally and only resolving
* the wxFileName when it has to.
*/
class KICOMMON_API WX_FILENAME
{
public:
WX_FILENAME( const wxString& aPath, const wxString& aFilename );
void SetFullName( const wxString& aFileNameAndExtension );
void SetPath( const wxString& aPath );
wxString GetName() const;
wxString GetFullName() const;
wxString GetPath() const;
wxString GetFullPath() const;
// Avoid multiple calls to stat() on POSIX kernels.
long long GetTimestamp();
// Resolve possible symlink(s) to absolute path
static void ResolvePossibleSymlinks( wxFileName& aFilename );
private:
// Write cached values to the wrapped wxFileName. MUST be called before using m_fn.
void resolve();
wxFileName m_fn;
wxString m_path;
wxString m_fullName;
};
#endif // WX_FILENAME_H