file_utils.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/>.
 */
 
#pragma once
 
#include <filesystem>
 
#include <wx/string.h>
 
#include <wx_filename.h>
 
 
class PROJECT;
class SETTINGS_MANAGER;
 
namespace KI_TEST
{
/*
 * A uniquely-named temporary directory removed on destruction.
 */
class SCOPED_TEMP_DIR
{
public:
    SCOPED_TEMP_DIR( const wxString& aPrefix, const wxString& aSuffix = wxEmptyString );
 
    ~SCOPED_TEMP_DIR();
 
    // Non-copyable: the destructor removes the directory, so instances must not be copied.
    SCOPED_TEMP_DIR( const SCOPED_TEMP_DIR& ) = delete;
    SCOPED_TEMP_DIR& operator=( const SCOPED_TEMP_DIR& ) = delete;

    const std::filesystem::path& Path() const { return m_path; }

    wxString PathStr() const { return wxString::FromUTF8( m_path.string() ); }

    wxString ChildPathStr( const wxString& aName ) const;

    std::filesystem::path CreateChildDir( const wxString& aName ) const;

    wxString CreateChildDirStr( const wxString& aName ) const;

    std::filesystem::path CreateChildFile( const wxString& aName ) const;

    wxString CreateChildFileStr( const wxString& aName ) const;

    void Retain();
 
    static bool AnyTempDirRetained() { return s_anyTempDirRetained; }
 
private:
    std::filesystem::path m_path;
    bool                  m_keep = false;
 
    // True if any temporary directory has been retained
    static bool s_anyTempDirRetained;
};
 
 
/*
 * A project loaded from its own temporary directory.
 *
 * The project is unloaded before the directory is removed so its lock file is released while the
 * file still exists.  Declare it ahead of any SCHEMATIC that refers to the project.
 */
class SCOPED_TEMP_PROJECT
{
public:
    SCOPED_TEMP_PROJECT( SETTINGS_MANAGER& aManager, const wxString& aPrefix, const wxString& aName );
 
    ~SCOPED_TEMP_PROJECT();
 
    SCOPED_TEMP_PROJECT( const SCOPED_TEMP_PROJECT& ) = delete;
    SCOPED_TEMP_PROJECT& operator=( const SCOPED_TEMP_PROJECT& ) = delete;
 
    PROJECT& Project() const { return *m_project; }

    wxString DirStr() const { return m_dir.PathStr(); }
 
private:
    SCOPED_TEMP_DIR   m_dir;
    SETTINGS_MANAGER& m_manager;
    PROJECT*          m_project;
};

class SCOPED_PROCESS_TEMP_DIR
{
public:
    SCOPED_PROCESS_TEMP_DIR( const wxString& aPrefix );
    ~SCOPED_PROCESS_TEMP_DIR();
 
    // No copying: the destructor removes the directory
    SCOPED_PROCESS_TEMP_DIR( const SCOPED_PROCESS_TEMP_DIR& ) = delete;
    SCOPED_PROCESS_TEMP_DIR& operator=( const SCOPED_PROCESS_TEMP_DIR& ) = delete;
 
private:
    SCOPED_TEMP_DIR m_dir;
};
 
} // namespace KI_TEST