KiCad PCB EDA Suite
wx_filename.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 1992-2022 KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, you may find one here:
18 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19 * or you may search the http://www.gnu.org website for the version 2 license,
20 * or you may write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22 */
23
24#ifndef WX_FILENAME_H
25#define WX_FILENAME_H
26
27#include <wx/filename.h>
28
38#define FN_NORMALIZE_FLAGS ( wxPATH_NORM_DOTS | wxPATH_NORM_TILDE | wxPATH_NORM_ABSOLUTE | \
39 wxPATH_NORM_LONG | wxPATH_NORM_SHORTCUT )
40
49{
50public:
51 WX_FILENAME( const wxString& aPath, const wxString& aFilename );
52
53 void SetFullName( const wxString& aFileNameAndExtension );
54 void SetPath( const wxString& aPath );
55
56 wxString GetName() const;
57 wxString GetFullName() const;
58 wxString GetPath() const;
59 wxString GetFullPath() const;
60
61 // Avoid multiple calls to stat() on POSIX kernels.
62 long long GetTimestamp();
63
64 // Resolve possible symlink(s) to absolute path
65 static void ResolvePossibleSymlinks( wxFileName& aFilename );
66
67private:
68 // Write cached values to the wrapped wxFileName. MUST be called before using m_fn.
69 void resolve();
70
71 wxFileName m_fn;
72 wxString m_path;
73 wxString m_fullName;
74};
75
76#endif // WX_FILENAME_H
A wrapper around a wxFileName which is much more performant with a subset of the API.
Definition: wx_filename.h:49
WX_FILENAME(const wxString &aPath, const wxString &aFilename)
Definition: wx_filename.cpp:28
void SetFullName(const wxString &aFileNameAndExtension)
Definition: wx_filename.cpp:34
static void ResolvePossibleSymlinks(wxFileName &aFilename)
Definition: wx_filename.cpp:92
void resolve()
Definition: wx_filename.cpp:73
wxString GetPath() const
Definition: wx_filename.cpp:60
void SetPath(const wxString &aPath)
Definition: wx_filename.cpp:40
wxString m_path
Definition: wx_filename.h:72
wxFileName m_fn
Definition: wx_filename.h:71
wxString GetName() const
Definition: wx_filename.cpp:47
wxString GetFullPath() const
Definition: wx_filename.cpp:66
long long GetTimestamp()
Definition: wx_filename.cpp:81
wxString GetFullName() const
Definition: wx_filename.cpp:54
wxString m_fullName
Definition: wx_filename.h:73