qt-creator/src/plugins/clangtools/virtualfilesystemoverlay.h

/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
****************************************************************************/

#pragma once

#include <utils/fileutils.h>
#include <utils/temporarydirectory.h>

#include <QHash>
#include <QMap>

namespace Core { class IDocument; }

namespace ClangTools {
namespace Internal {

class VirtualFileSystemOverlay
{
public:
    VirtualFileSystemOverlay(const QString &rootPattern);

    void update();

    Utils::FilePath overlayFilePath();
    Utils::FilePath autoSavedFilePath(Core::IDocument *doc);
    Utils::FilePath originalFilePath(const Utils::FilePath &file);

private:
    Utils::TemporaryDirectory m_root;
    Utils::FilePath m_overlayFilePath;
    struct AutoSavedPath
    {
        int revision = -1;
        Utils::FilePath path;
    };

    QHash<Core::IDocument *, AutoSavedPath> m_saved;
    QMap<Utils::FilePath, Utils::FilePath> m_mapping;
};

} // namespace Internal
} // namespace ClangTools