wx_filename.h

Go to the documentation of this file.

/*
 * 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, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef WX_FILENAME_H
#define WX_FILENAME_H
 
#include <kicommon.h>
#include <wx/filename.h>

#define FN_NORMALIZE_FLAGS ( wxPATH_NORM_DOTS | wxPATH_NORM_TILDE | wxPATH_NORM_ABSOLUTE | \
                             wxPATH_NORM_LONG | wxPATH_NORM_SHORTCUT )

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 );

    static bool SplitArchiveEntryName( const wxString& aEntryName, wxArrayString& aParts );

    [[nodiscard]] static bool IsSafeChildPath( const wxString& aChild );

    static bool ResolveArchiveEntryPath( const wxString& aDestDir, const wxString& aEntryName,
                                         wxFileName& aResult );
 
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