/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qbs.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** 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-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QBS_RESCUABLEARTIFACTDATA_H
#define QBS_RESCUABLEARTIFACTDATA_H

#include "forward_decls.h"
#include "requestedartifacts.h"
#include "requesteddependencies.h"
#include "rulecommands.h"

#include <language/filetags.h>
#include <language/forward_decls.h>
#include <language/language.h>
#include <language/property.h>
#include <language/propertymapinternal.h>
#include <tools/filetime.h>
#include <tools/persistence.h>

#include <QtCore/qhash.h>

#include <vector>

namespace qbs {
namespace Internal {

class QBS_AUTOTEST_EXPORT RescuableArtifactData
{
public:
    template<PersistentPool::OpType opType> void completeSerializationOp(PersistentPool &pool)
    {
        pool.serializationOp<opType>(timeStamp, children, fileDependencies, knownOutOfDate,
                                     propertiesRequestedInPrepareScript,
                                     propertiesRequestedInCommands,
                                     propertiesRequestedFromArtifactInPrepareScript,
                                     propertiesRequestedFromArtifactInCommands,
                                     importedFilesUsedInPrepareScript, importedFilesUsedInCommands,
                                     depsRequestedInPrepareScript, depsRequestedInCommands,
                                     commands, artifactsMapRequestedInPrepareScript,
                                     artifactsMapRequestedInCommands,
                                     exportedModulesAccessedInPrepareScript,
                                     exportedModulesAccessedInCommands,
                                     lastPrepareScriptExecutionTime,
                                     lastCommandExecutionTime, fileTags, properties);
    }

    bool isValid() const { return !!properties; }

    struct ChildData
    {
        ChildData(QString n = QString(), QString m = QString(),
                  QString c = QString(), bool byScanner = false)
            : productName(std::move(n))
            , productMultiplexId(std::move(m))
            , childFilePath(std::move(c))
            , addedByScanner(byScanner)
        {}

        template<PersistentPool::OpType opType> void completeSerializationOp(PersistentPool &pool)
        {
            pool.serializationOp<opType>(productName, productMultiplexId, childFilePath,
                                         addedByScanner);
        }

        QString productName;
        QString productMultiplexId;
        QString childFilePath;
        bool addedByScanner;
    };

    FileTime timeStamp;
    std::vector<ChildData> children;
    std::vector<QString> fileDependencies;

    // Per-Transformer data
    CommandList commands;
    PropertySet propertiesRequestedInPrepareScript;
    PropertySet propertiesRequestedInCommands;
    PropertyHash propertiesRequestedFromArtifactInPrepareScript;
    PropertyHash propertiesRequestedFromArtifactInCommands;
    std::vector<QString> importedFilesUsedInPrepareScript;
    std::vector<QString> importedFilesUsedInCommands;
    RequestedDependencies depsRequestedInPrepareScript;
    RequestedDependencies depsRequestedInCommands;
    RequestedArtifacts artifactsMapRequestedInPrepareScript;
    RequestedArtifacts artifactsMapRequestedInCommands;
    FileTime lastPrepareScriptExecutionTime;
    FileTime lastCommandExecutionTime;
    std::unordered_map<QString, ExportedModule> exportedModulesAccessedInPrepareScript;
    std::unordered_map<QString, ExportedModule> exportedModulesAccessedInCommands;
    bool knownOutOfDate = false;

    // Only needed for API purposes
    FileTags fileTags;
    PropertyMapPtr properties;

};
using AllRescuableArtifactData = QHash<QString, RescuableArtifactData>;

} // namespace Internal
} // namespace qbs

#endif // Include guard.
