KiCad PCB EDA Suite
Loading...
Searching...
No Matches
gestfich.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) 2009-2014 Jerry Jacobs
5 * Copyright The KiCad Developers, see AUTHORS.TXT for contributors.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
19 */
20
21#pragma once
22
23#include <map>
24#include <filesystem>
25#include <functional>
26#include <memory>
27#include <string>
28#include <unordered_set>
29#include <vector>
30#include <kicommon.h>
31#include <wx/arrstr.h>
32#include <wx/dir.h>
33#include <wx/filename.h>
34#include <wx/process.h>
35#include <wx/zipstrm.h>
36
37
41#define UNIX_STRING_DIR_SEP wxT( "/" )
42#define WIN_STRING_DIR_SEP wxT( "\\" )
43
44/* Forward class declarations. */
45class EDA_LIST_DIALOG;
46class wxFFile;
47class wxOutputStream;
48
49
51{
54};
55
57KICOMMON_API std::filesystem::path ToFsPath( const wxString& aPath );
58
59KICOMMON_API wxString FromFsPath( const std::filesystem::path& aPath );
60
63{
64public:
65 SCOPED_TEMP_PATH() = default;
69
71 bool MakeFile( const wxString& aPrefix );
72
75 bool MakeDirectory( const wxString& aPrefix, int aPermissions = wxS_DIR_DEFAULT );
76
77 const wxString& Path() const { return m_path; }
78
79private:
80 wxString m_path;
81};
82
83using ARCHIVE_STREAM_FACTORY = std::function<std::unique_ptr<wxOutputStream>( wxFFile& )>;
84
86KICOMMON_API bool WriteDirectoryArchive( const wxString& aSourceDir, wxOutputStream& aOut,
87 ARCHIVE_FORMAT aFormat, const wxString& aTopDir );
88
90KICOMMON_API bool WriteDirectoryArchive( const wxString& aSourceDir, const wxString& aArchive,
91 ARCHIVE_FORMAT aFormat, const wxString& aTopDir,
92 wxString* aError = nullptr,
93 const ARCHIVE_STREAM_FACTORY& aOpen = {} );
94
95
103KICOMMON_API bool OpenPDF( const wxString& file );
104
110KICOMMON_API void KiCopyFile( const wxString& aSrcPath, const wxString& aDestPath,
111 wxString& aErrors );
112
120KICOMMON_API void CopySexprFile( const wxString& aSrcPath, const wxString& aDestPath,
121 std::function<bool( const std::string& token, wxString& value )> aCallback,
122 wxString& aErrors );
123
134KICOMMON_API int ExecuteFile( const wxString& aEditorName,
135 const wxString& aFileName = wxEmptyString,
136 wxProcess* aCallback = nullptr, bool aFileForKicad = true );
137
150KICOMMON_API int ExecuteCommandThroughShell( const wxString& aCommand, wxProcess* aProcess = nullptr );
151
157KICOMMON_API void QuoteString( wxString& string );
158
169KICOMMON_API wxString FindKicadFile( const wxString& shortname );
170
181KICOMMON_API extern wxString QuoteFullPath( wxFileName& fn, wxPathFormat format = wxPATH_NATIVE );
182
183
188KICOMMON_API bool RmDirRecursive( const wxString& aDirName, wxString* aErrors = nullptr );
189
198KICOMMON_API bool CopyDirectory( const wxString& aSourceDir, const wxString& aDestDir,
199 const std::vector<wxString>& aOverwriteExclusions, wxString& aErrors );
200
201KICOMMON_API bool CopyFilesOrDirectory( const wxString& aSourceDir, const wxString& aDestDir, bool aAllowOverwrite,
202 wxString& aErrors, std::vector<wxString>& aPathsWritten );
203
212KICOMMON_API bool AddDirectoryToZip( wxZipOutputStream& aZip, const wxString& aSourceDir, wxString& aErrors,
213 const wxString& aParentDir = "" );
214
231KICOMMON_API void CollectFilesLoopSafe( const wxString& aRoot, wxArrayString& aFiles,
232 const wxString& aFileSpec = wxEmptyString,
233 int aFlags = wxDIR_DEFAULT );
234
246KICOMMON_API void CollectSubdirsLoopSafe( const wxString& aRoot, wxArrayString& aDirs,
247 int aFlags = wxDIR_DIRS );
248
249
250// how a symlink that resolves outside the scan root is treated
252{
253 CONFINE_TO_ROOT, // descend only into targets that stay inside the root subtree
254 BLOCK_ROOT_ESCAPE // descend anywhere except a link resolving to an ancestor of the root
255};
256
257
258// bounds a hand-rolled recursive dir walk against symlink cycles and root escapes
259// query ShouldDescend before recursing real dirs keyed by name links canonicalized
261{
262public:
263 explicit DIR_LOOP_GUARD( const wxString& aRoot,
265
266 // false when the root itself would not resolve caller must not walk
267 bool IsRooted() const { return !m_root.empty(); }
268
269 bool ShouldDescend( const wxString& aDir );
270
271private:
272 std::filesystem::path m_root;
274 std::unordered_set<std::string> m_visited;
275};
DIR_LOOP_POLICY m_policy
Definition gestfich.h:273
std::unordered_set< std::string > m_visited
Definition gestfich.h:274
bool IsRooted() const
Definition gestfich.h:267
DIR_LOOP_GUARD(const wxString &aRoot, DIR_LOOP_POLICY aPolicy=DIR_LOOP_POLICY::CONFINE_TO_ROOT)
std::filesystem::path m_root
Definition gestfich.h:272
A dialog which shows:
SCOPED_TEMP_PATH(const SCOPED_TEMP_PATH &)=delete
bool MakeDirectory(const wxString &aPrefix, int aPermissions=wxS_DIR_DEFAULT)
Create an empty directory with a unique name after aPrefix.
bool MakeFile(const wxString &aPrefix)
Create an empty file with a unique name after aPrefix.
SCOPED_TEMP_PATH & operator=(const SCOPED_TEMP_PATH &)=delete
SCOPED_TEMP_PATH()=default
wxString m_path
Definition gestfich.h:80
const wxString & Path() const
Definition gestfich.h:77
KICOMMON_API bool CopyFilesOrDirectory(const wxString &aSourceDir, const wxString &aDestDir, bool aAllowOverwrite, wxString &aErrors, std::vector< wxString > &aPathsWritten)
Definition gestfich.cpp:614
KICOMMON_API wxString QuoteFullPath(wxFileName &fn, wxPathFormat format=wxPATH_NATIVE)
Quote return value of wxFileName::GetFullPath().
Definition gestfich.cpp:506
KICOMMON_API bool WriteDirectoryArchive(const wxString &aSourceDir, wxOutputStream &aOut, ARCHIVE_FORMAT aFormat, const wxString &aTopDir)
Write directory entries in sorted archive path order, using the archive root when aTopDir is empty.
Definition gestfich.cpp:861
KICOMMON_API bool CopyDirectory(const wxString &aSourceDir, const wxString &aDestDir, const std::vector< wxString > &aOverwriteExclusions, wxString &aErrors)
Copy a directory and its contents to another directory.
Definition gestfich.cpp:560
KICOMMON_API void KiCopyFile(const wxString &aSrcPath, const wxString &aDestPath, wxString &aErrors)
Definition gestfich.cpp:416
KICOMMON_API int ExecuteCommandThroughShell(const wxString &aCommand, wxProcess *aProcess=nullptr)
Run a user-supplied command line through the platform shell so glob expansion, pipes,...
Definition gestfich.cpp:334
KICOMMON_API bool OpenPDF(const wxString &file)
Run the PDF viewer and display a PDF file.
Definition gestfich.cpp:380
KICOMMON_API void QuoteString(wxString &string)
Add un " to the start and the end of string (if not already done).
Definition gestfich.cpp:62
KICOMMON_API wxString FindKicadFile(const wxString &shortname)
Search the executable file shortname in KiCad binary path and return full file name if found or short...
Definition gestfich.cpp:72
KICOMMON_API void CollectSubdirsLoopSafe(const wxString &aRoot, wxArrayString &aDirs, int aFlags=wxDIR_DIRS)
Recursively collect every subdirectory under aRoot using the same loop detection as CollectFilesLoopS...
KICOMMON_API void CollectFilesLoopSafe(const wxString &aRoot, wxArrayString &aFiles, const wxString &aFileSpec=wxEmptyString, int aFlags=wxDIR_DEFAULT)
Recursively collect every file under aRoot, deduplicating subdirectories by their resolved path.
ARCHIVE_FORMAT
Definition gestfich.h:51
std::function< std::unique_ptr< wxOutputStream >(wxFFile &)> ARCHIVE_STREAM_FACTORY
Definition gestfich.h:83
KICOMMON_API wxString FromFsPath(const std::filesystem::path &aPath)
Definition gestfich.cpp:987
KICOMMON_API bool RmDirRecursive(const wxString &aDirName, wxString *aErrors=nullptr)
Remove the directory aDirName and all its contents including subdirectories and their files.
Definition gestfich.cpp:512
KICOMMON_API void CopySexprFile(const wxString &aSrcPath, const wxString &aDestPath, std::function< bool(const std::string &token, wxString &value)> aCallback, wxString &aErrors)
Definition gestfich.cpp:443
KICOMMON_API int ExecuteFile(const wxString &aEditorName, const wxString &aFileName=wxEmptyString, wxProcess *aCallback=nullptr, bool aFileForKicad=true)
Call the executable file aEditorName with the parameter aFileName.
Definition gestfich.cpp:170
KICOMMON_API std::filesystem::path ToFsPath(const wxString &aPath)
Give aPath to std::filesystem without a detour through the C locale.
Definition gestfich.cpp:977
DIR_LOOP_POLICY
Definition gestfich.h:252
KICOMMON_API bool AddDirectoryToZip(wxZipOutputStream &aZip, const wxString &aSourceDir, wxString &aErrors, const wxString &aParentDir="")
Add a directory and its contents to a zip file.
Definition gestfich.cpp:737
#define KICOMMON_API
Definition kicommon.h:27