/****************************************************************************
**
** Copyright (C) 2017 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 "directorypathid.h"
#include "filepath.h"
#include "filepathid.h"
#include "filepathview.h"

namespace ClangBackEnd {

class FilePathCachingInterface
{
public:
    FilePathCachingInterface() = default;
    FilePathCachingInterface(const FilePathCachingInterface &) = delete;
    FilePathCachingInterface &operator=(const FilePathCachingInterface &) = delete;

    virtual FilePathId filePathId(FilePathView filePath) const = 0;
    virtual FilePath filePath(FilePathId filePathId) const = 0;
    virtual DirectoryPathId directoryPathId(Utils::SmallStringView directoryPath) const = 0;
    virtual DirectoryPathId directoryPathId(FilePathId filePathId) const = 0;
    virtual Utils::PathString directoryPath(DirectoryPathId directoryPathId) const = 0;

    template<typename Container>
    FilePathIds filePathIds(Container &&filePaths) const
    {
       FilePathIds filePathIds;
       filePathIds.reserve(filePaths.size());

       std::transform(filePaths.begin(),
                      filePaths.end(),
                      std::back_inserter(filePathIds),
                      [&] (const auto &filePath) { return this->filePathId(filePath); });

       return filePathIds;
    }

    template <typename Element>
    FilePathIds filePathIds(std::initializer_list<Element> filePaths) const
    {
        return filePathIds(std::vector<Element>(filePaths));
    }

    FilePaths filePaths(const FilePathIds &filePathIds) const
    {
        FilePaths filePaths;
        filePaths.reserve(filePathIds.size());

        std::transform(filePathIds.begin(),
                       filePathIds.end(),
                       std::back_inserter(filePaths),
                       [&] (auto filePathId) { return this->filePath(filePathId); });

        return filePaths;
    }

protected:
    ~FilePathCachingInterface() = default;
};

} // namespace ClangBackEnd
