gestfich.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2009-2014 Jerry Jacobs
 * 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/>.
 */
 
#pragma once
 
#include <map>
#include <filesystem>
#include <functional>
#include <memory>
#include <string>
#include <unordered_set>
#include <kicommon.h>
#include <wx/arrstr.h>
#include <wx/dir.h>
#include <wx/filename.h>
#include <wx/process.h>
#include <wx/zipstrm.h>
 

#define UNIX_STRING_DIR_SEP wxT( "/" )
#define WIN_STRING_DIR_SEP  wxT( "\\" )
 
/* Forward class declarations. */
class EDA_LIST_DIALOG;
class wxFFile;
class wxOutputStream;
 
 
enum class ARCHIVE_FORMAT
{
    ZIP,
    TGZ
};

KICOMMON_API std::filesystem::path ToFsPath( const wxString& aPath );
 
KICOMMON_API wxString FromFsPath( const std::filesystem::path& aPath );

class KICOMMON_API SCOPED_TEMP_PATH
{
public:
    SCOPED_TEMP_PATH() = default;
    SCOPED_TEMP_PATH( const SCOPED_TEMP_PATH& ) = delete;
    SCOPED_TEMP_PATH& operator=( const SCOPED_TEMP_PATH& ) = delete;
    ~SCOPED_TEMP_PATH();

    bool MakeFile( const wxString& aPrefix );

    bool MakeDirectory( const wxString& aPrefix );
 
    const wxString& Path() const { return m_path; }
 
private:
    wxString m_path;
};
 
using ARCHIVE_STREAM_FACTORY = std::function<std::unique_ptr<wxOutputStream>( wxFFile& )>;

KICOMMON_API bool WriteDirectoryArchive( const wxString& aSourceDir, wxOutputStream& aOut,
                                         ARCHIVE_FORMAT aFormat, const wxString& aTopDir );

KICOMMON_API bool WriteDirectoryArchive( const wxString& aSourceDir, const wxString& aArchive,
                                         ARCHIVE_FORMAT aFormat, const wxString& aTopDir,
                                         wxString* aError = nullptr,
                                         const ARCHIVE_STREAM_FACTORY& aOpen = {} );
 

KICOMMON_API bool OpenPDF( const wxString& file );

KICOMMON_API void KiCopyFile( const wxString& aSrcPath, const wxString& aDestPath,
                              wxString& aErrors );

KICOMMON_API void CopySexprFile( const wxString& aSrcPath, const wxString& aDestPath,
                                 std::function<bool( const std::string& token, wxString& value )> aCallback,
                                 wxString& aErrors );

KICOMMON_API int ExecuteFile( const wxString& aEditorName,
                              const wxString& aFileName = wxEmptyString,
                              wxProcess* aCallback = nullptr, bool aFileForKicad = true );

KICOMMON_API int ExecuteCommandThroughShell( const wxString& aCommand, wxProcess* aProcess = nullptr );

KICOMMON_API void QuoteString( wxString& string );

KICOMMON_API wxString FindKicadFile( const wxString& shortname );

KICOMMON_API extern wxString QuoteFullPath( wxFileName& fn, wxPathFormat format = wxPATH_NATIVE );
 

KICOMMON_API bool RmDirRecursive( const wxString& aDirName, wxString* aErrors = nullptr );

KICOMMON_API bool CopyDirectory( const wxString& aSourceDir, const wxString& aDestDir,
                                 const std::vector<wxString>& aOverwriteExclusions, wxString& aErrors );
 
KICOMMON_API bool CopyFilesOrDirectory( const wxString& aSourceDir, const wxString& aDestDir, bool aAllowOverwrite,
                                        wxString& aErrors, std::vector<wxString>& aPathsWritten );

KICOMMON_API bool AddDirectoryToZip( wxZipOutputStream& aZip, const wxString& aSourceDir, wxString& aErrors,
                                     const wxString& aParentDir = "" );

KICOMMON_API void CollectFilesLoopSafe( const wxString& aRoot, wxArrayString& aFiles,
                                        const wxString& aFileSpec = wxEmptyString,
                                        int aFlags = wxDIR_DEFAULT );

KICOMMON_API void CollectSubdirsLoopSafe( const wxString& aRoot, wxArrayString& aDirs,
                                          int aFlags = wxDIR_DIRS );
 
 
// how a symlink that resolves outside the scan root is treated
enum class DIR_LOOP_POLICY
{
    CONFINE_TO_ROOT,    // descend only into targets that stay inside the root subtree
    BLOCK_ROOT_ESCAPE   // descend anywhere except a link resolving to an ancestor of the root
};
 
 
// bounds a hand-rolled recursive dir walk against symlink cycles and root escapes
// query ShouldDescend before recursing real dirs keyed by name links canonicalized
class KICOMMON_API DIR_LOOP_GUARD
{
public:
    explicit DIR_LOOP_GUARD( const wxString& aRoot,
                             DIR_LOOP_POLICY aPolicy = DIR_LOOP_POLICY::CONFINE_TO_ROOT );
 
    // false when the root itself would not resolve caller must not walk
    bool IsRooted() const { return !m_root.empty(); }
 
    bool ShouldDescend( const wxString& aDir );
 
private:
    std::filesystem::path           m_root;
    DIR_LOOP_POLICY                 m_policy;
    std::unordered_set<std::string> m_visited;
};